Submission Received!We want to notify you that we received your submission.
'],
40 | default=None,
41 | )
42 | body_plain: Optional[str] = Field(
43 | title='Email Plain Text Body',
44 | description='The plain text body of the email.',
45 | examples=['Submission Received!\n\nWe want to notify you that we received your submission.'],
46 | default=None,
47 | )
48 |
49 |
50 | class MailServiceSendResponse(BaseModel):
51 | """Represents an API response for sending an email via the mail service router."""
52 |
53 | id: Optional[uuid.UUID] = Field(
54 | title='Mail Request ID',
55 | description='The UUID associated with the mail request task.',
56 | examples=[str(uuid.uuid4())],
57 | default=None,
58 | )
59 |
60 | status: str = Field(
61 | title='Mail Request Status',
62 | description='The status of the mail request.',
63 | examples=['queued', 'sending', 'sent', 'retry', 'failed', 'not-found'],
64 | default='queued',
65 | )
66 |
67 | message: str = Field(
68 | title='Mail Request Response Message',
69 | description='Message related to the mail request response.',
70 | examples=['The mail request could not be queued for sending.'],
71 | default=None,
72 | )
73 |
74 | responses: list[EmailSendRecipientResponse] = Field(
75 | title='Mail Request Response Objects',
76 | description='A list of response objects of send action for each recipient.',
77 | examples=[
78 | EmailSendRecipientResponse(recipient='Recipient #1 ', success=True, code=250),
79 | EmailSendRecipientResponse(recipient='Recipient #2 ', success=False, code=450,
80 | message='This mailbox is unavailable.'),
81 | EmailSendRecipientResponse(recipient='recipient3@domain.com', success=True, code=250),
82 | ],
83 | default=None,
84 | )
85 |
--------------------------------------------------------------------------------
/docker-compose.yml:
--------------------------------------------------------------------------------
1 | services:
2 |
3 | redis:
4 | image: redis:8.0.1
5 | container_name: pda_redis
6 | hostname: redis
7 | restart: unless-stopped
8 | env_file: .env
9 | volumes:
10 | - redis:/data
11 | networks:
12 | - pda
13 | healthcheck:
14 | test: [ 'CMD', 'redis-cli', '--raw', 'incr', 'ping' ]
15 | interval: 30s
16 | timeout: 10s
17 | retries: 3
18 | start_period: 15s
19 | start_interval: 5s
20 |
21 | mysql:
22 | image: mysql:8
23 | restart: unless-stopped
24 | container_name: pda_mysql
25 | volumes:
26 | - mysql:/var/lib/mysql
27 | ports:
28 | - "${PDA_SERVICE_IP}:3306:3306"
29 | networks:
30 | - pda
31 | environment:
32 | - MYSQL_ROOT_PASSWORD=${PDA_MYSQL_ROOT_PASSWORD}
33 | - MYSQL_DATABASE=${PDA_MYSQL_DATABASE}
34 |
35 | proxy:
36 | image: nginx:1.27
37 | container_name: pda_proxy
38 | hostname: pda_proxy
39 | restart: unless-stopped
40 | env_file: .env
41 | volumes:
42 | - ./deploy/docker/nginx/certs:/etc/nginx/certs
43 | - ./deploy/docker/nginx/conf/proxy.conf.template:/etc/nginx/templates/default.conf.template
44 | - ./var/log/nginx:/var/log/nginx
45 | ports:
46 | - "${PDA_SERVICE_IP}:80:80"
47 | - "${PDA_SERVICE_IP}:443:443"
48 | networks:
49 | - pda
50 | healthcheck:
51 | test: [ 'CMD', 'curl', '-f', 'http://pda_proxy:80' ]
52 | interval: 30s
53 | timeout: 10s
54 | retries: 3
55 | start_period: 15s
56 | start_interval: 5s
57 |
58 | api:
59 | image: powerdnsadmin/pda-api:latest
60 | container_name: pda_api
61 | hostname: pda_api
62 | restart: unless-stopped
63 | command: python3 -m uvicorn --host 0.0.0.0 --port 8000 --root-path / --log-level debug --access-log --proxy-headers --reload api:app
64 | build:
65 | context: .
66 | dockerfile: ./deploy/docker/api/Dockerfile
67 | depends_on:
68 | - redis
69 | env_file: .env
70 | volumes:
71 | - ./src-api:/srv/app/src
72 | - ./config:/srv/app/config
73 | networks:
74 | - pda
75 | healthcheck:
76 | test: [ 'CMD', 'curl', '-f', 'http://pda_api:8000/status' ]
77 | interval: 30s
78 | timeout: 10s
79 | retries: 3
80 | start_period: 15s
81 | start_interval: 5s
82 |
83 | worker:
84 | image: powerdnsadmin/pda-api:latest
85 | container_name: pda_worker
86 | hostname: pda_worker
87 | restart: unless-stopped
88 | command: python3 -m celery -A worker.app worker --beat --loglevel debug
89 | build:
90 | context: .
91 | dockerfile: ./deploy/docker/api/Dockerfile
92 | depends_on:
93 | - redis
94 | env_file: .env
95 | volumes:
96 | - ./src-api:/srv/app/src
97 | - ./config:/srv/app/config
98 | networks:
99 | - pda
100 | healthcheck:
101 | test: [ 'CMD-SHELL', 'celery', '-A', 'worker.app', 'inspect', 'ping', '--destination', 'celery@$$HOSTNAME' ]
102 | interval: 30s
103 | timeout: 10s
104 | retries: 3
105 | start_period: 15s
106 | start_interval: 5s
107 | stop_signal: SIGTERM
108 | stop_grace_period: 900s
109 |
110 | web:
111 | image: powerdnsadmin/pda-web:latest
112 | restart: unless-stopped
113 | container_name: pda_web
114 | hostname: pda_web
115 | build:
116 | context: ./
117 | dockerfile: ./deploy/docker/web/Dockerfile
118 | env_file: .env
119 | volumes:
120 | - ./src-ui:/srv/app
121 | - ./deploy/docker/nginx/conf/web.conf:/etc/nginx/sites-enabled/default.conf
122 | - ./var/log/nginx:/var/log/nginx
123 | networks:
124 | - pda
125 | healthcheck:
126 | test: [ 'CMD', 'curl', '-f', 'http://pda_web:8000' ]
127 | interval: 30s
128 | timeout: 10s
129 | retries: 3
130 | start_period: 15s
131 | start_interval: 5s
132 |
133 | volumes:
134 | redis:
135 | mysql:
136 |
137 | networks:
138 | pda:
139 | external: false
140 | name: pda
--------------------------------------------------------------------------------
/docs/announcements/2023-03-11-release-v0.4.0.md:
--------------------------------------------------------------------------------
1 | First off, thank you all for sticking with the project this long through it's rough patches! As the project has went through a change of ownership last year, there have been many areas that have suffered but it is my goal to turn those problems around and get the project back on a healthy and productive path into the future.
2 |
3 | With that being said, there is many areas that still need improvement including the quality of contributions and information tracking. For this reason, this release will not provide the most accurate documentation to all of the changes included in the release, but I will do my best to highlight the most notable that I'm aware of.
4 |
5 | ### Enhancements
6 | - The user interface has been updated to the latest AdminLTE release of 3.2.0.
7 | - The Font Awesome library has been upgraded to the latest 6.3.0 release which overrides the 5.15.4 dependency built in to AdminLTE 3.2.0.
8 | - The user interface has been updated to better support multiple screen sizes included smartphones and tablets. While this is still a work in progress, you will find that **most** views now work quite well in various screen formats.
9 | - The nomenclature for DNS zones have been updated to utilize the appropriate terminology of "zone" instead of "domain" where the latter is slang. This is a work in progress so there may still be some places that use the old "domain" terminology.
10 | - The nomenclature for history / action auditing has been updated to use "activity" instead of "history." This is a work in progress so not all references may have been updated yet.
11 | - The authentication settings management views have been updated to be more uniform with some amount of field documentation included. This is also still a work in progress as some views still lack useful documentation.
12 | - Performance improvements have been made to the zone record list view so that large data sets don't suffer as much from use of poor coding techniques.
13 | - The statistics and recent activity blocks have been removed from the dashboard to provide greater performance enhancements. It was determined that these features weren't truly useful in practice which was the ultimate driver for their removal.
14 | - API activity auditing has been updated to provide per-record change log entries.
15 | - The user interface has been updated to use the SITE_NAME setting in more appropriate places as opposed to the static text of "PowerDNS Admin."
16 | - Various user interface features were updated to correct minor formatting issues such as a lack of proper text wrapping for the activity details modal.
17 | - Various areas of documentation were updated to be more reliable as well as including some missing information. This is still a work in progress.
18 | - The project WIKI was moved into standard markdown documentation files under `docs/wiki` as opposed to using the GitHub WIKI feature which will make it easier for contributors to provide updates via PRs.
19 |
20 | ### Features
21 | - A CAPTCHA feature has been added to the registration form which can be controlled through the use of environment variables and application settings. This feature is now enabled by default.
22 | - A session storage setting has been added through the use of environment variables and supports multiple mediums such as database and file system. The default is configured to use the database which **will result in the "sessions" table being automatically created!**
23 | - A configuration setting has been added for controlling the OIDC OAuth Metadata URL for authentication.
24 | - A search function was added for IDN searches.
25 |
26 | ### Bug Fixes
27 | - The auto-PTR record logic has been updated to remove, then add records in order to address scenarios that would create undesirable record changes that didn't fit logical expectations.
28 | - Fixed issue where OTP_FORCE setting was being applied to OAuth flows which was not appropriate.
29 | - Many other minor bug fixes were made but there is currently a lot of lacking documentation available to make documenting these fixes here a bit easier.
30 |
31 | ### Security Fixes
32 | - Most dependencies have been updated to their latest or near-latest versions.
33 |
34 | As the project gets back on track, so will it's organization which should result in more frequent minor and patch releases with greater detail in release notes. Thank you again for being a PDA user!
35 |
36 |
This discussion was created from the release v0.4.0.
--------------------------------------------------------------------------------
/docs/announcements/2024-01-31-release-0.4.2.md:
--------------------------------------------------------------------------------
1 | This release focused on tying up what loose ends could be within reason in preparation for the freeze release. Following this release, only dependency updates within reason will be managed. There may be additional feature releases on this edition, but nothing is promised.
2 |
3 | **POTENTIALLY BREAKING CHANGE** - This release upgrades to SQLAlchemy `1.4.x` which removes support for the use of `postgres://` on database connection URI strings. You must switch to the supported format of `postgresql://` to avoid a failure of the connection.
4 |
5 | ## What's Changed
6 | * Updated the OAuth service providers to properly respect the new OAuth auto-configuration settings for each provider. by @AzorianMatt in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1527
7 | * Corrected issue with `SERVER_EXTERNAL_SSL` setting not being extracted from the app's environment. by @AzorianMatt in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1529
8 | * Fixed issue with all unassigned zones being selected after a new account's name fails to validate by @AzorianMatt in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1530
9 | * Allow all application settings to be configured by environment variables by @AzorianMatt in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1535
10 | * Fix record comment removal by @corubba in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1537
11 | * Automatically focus username field in login view by @roelschroeven in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1549
12 | * Indicate Unsaved Changes by @AgentTNT in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1595
13 | * Remove Misc Code by @AgentTNT in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1597
14 | * Fix non rr_set events in Zone Changelog display by @AgentTNT in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1598
15 | * Update static fonts to use relative paths instead of static by @AzorianMatt in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1703
16 | * Fixes local user setup to perform case-insensitive verification of existing usernames / emails in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1658
17 | * Update index router to replace the use of the deprecated `before_app_first_request` event with `record_once` by @AzorianMatt in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1705
18 | * Updated zone type comparison logic in domain router to be case-insensitive by @AzorianMatt in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1706
19 | * Fix zone name encoding for UI XHR requests as well as requests to the PDNS API by @AzorianMatt in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1707
20 | * Added LDAP search filter cleansing mechanism to properly escape special characters by @AzorianMatt in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1726
21 | * Merge zone editor record action controls into single column by @feldsam in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1642
22 | * Fixing new LDAP search filter cleansing mechanism to only target user DN value returned on AD connections by @AzorianMatt in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1727
23 | * Added support for application to run in sub-paths while not breaking the Docker health check by @AzorianMatt in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1728
24 | * Bump mysqlclient from 2.0.1 to 2.2.1 by @dependabot in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1729
25 | * Bump bcrypt from 4.0.1 to 4.1.2 by @dependabot in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1730
26 | * Bump pytest from 7.2.1 to 7.4.4 by @dependabot in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1733
27 | * Bump sqlalchemy from 1.3.24 to 1.4.51 by @dependabot in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1734
28 | * Bump jinja2 from 3.1.2 to 3.1.3 by @dependabot in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1735
29 | * Updated Pip Dependencies (Jinaj2, certifi, cryptography, requests, werkzeug) by @AzorianMatt in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1740
30 | * Bump crypto-js from 4.1.1 to 4.2.0 by @dependabot in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1738
31 | * Updated NPM dependencies (cryto-js) by @AzorianMatt in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1742
32 |
33 | ## New Contributors
34 | * @roelschroeven made their first contribution in https://github.com/PowerDNS-Admin/PowerDNS-Admin/pull/1549
35 |
36 | **Full Changelog**: https://github.com/PowerDNS-Admin/PowerDNS-Admin/compare/v0.4.1...v0.4.2
--------------------------------------------------------------------------------
/src-api/models/db/crypto.py:
--------------------------------------------------------------------------------
1 | """
2 | DNS Crypto Database Models
3 |
4 | This file defines the database models associated with DNSSEC crypto functionality.
5 | """
6 | import uuid
7 | from datetime import datetime
8 | from enum import Enum
9 | from sqlalchemy import Boolean, DateTime, Integer, String, TEXT, Uuid, text, ForeignKey
10 | from sqlalchemy.orm import Mapped, mapped_column, relationship
11 | from models.base import BaseSqlModel
12 |
13 |
14 | class CryptoKeyTypeEnum(str, Enum):
15 | """Defines the different types of DNSSEC cryptographic keys there can be."""
16 |
17 | KSK = "KSK"
18 | """DNSSEC Key Signing Key (KSK) type."""
19 |
20 | ZSK = "ZSK"
21 | """DNSSEC Zone Signing Key (ZSK) type."""
22 |
23 | CSK = "CSK"
24 | """DNSSEC Combined Signing Key (CSK) type."""
25 |
26 |
27 | class CryptoKey(BaseSqlModel):
28 | """Represents a DNSSEC cryptographic key."""
29 |
30 | __tablename__ = 'pda_crypto_keys'
31 | """Defines the database table name."""
32 |
33 | id: Mapped[str] = mapped_column(Uuid, primary_key=True, default=uuid.uuid4)
34 | """The unique identifier of the record."""
35 |
36 | tenant_id: Mapped[str] = mapped_column(Uuid, ForeignKey('pda_tenants.id'), nullable=False)
37 | """The unique identifier of the tenant that owns the record."""
38 |
39 | internal_id: Mapped[int] = mapped_column(Integer, nullable=True)
40 | """The internal identifier, read only."""
41 |
42 | type_: Mapped[CryptoKeyTypeEnum] = mapped_column(String(20), nullable=False)
43 | """The type of the key."""
44 |
45 | active: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
46 | """Whether the key is in active use."""
47 |
48 | published: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
49 | """Whether the DNSKEY record is published in the zone."""
50 |
51 | dns_key: Mapped[str] = mapped_column(TEXT, nullable=True)
52 | """The DNSKEY record for this key."""
53 |
54 | ds: Mapped[list[str]] = mapped_column(TEXT, nullable=True)
55 | """A list of DS records for this key."""
56 |
57 | cds: Mapped[list[str]] = mapped_column(TEXT, nullable=True)
58 | """A list of DS records for this key, filtered by CDS publication settings."""
59 |
60 | private_key: Mapped[str] = mapped_column(TEXT, nullable=True)
61 | """The private key in ISC format."""
62 |
63 | algorithm: Mapped[str] = mapped_column(String(20), nullable=True)
64 | """The name of the algorithm of the key, should be a mnemonic."""
65 |
66 | bits: Mapped[int] = mapped_column(Integer, nullable=False)
67 | """The size of the key."""
68 |
69 | created_at: Mapped[datetime] = mapped_column(
70 | DateTime, nullable=False, default=datetime.now, server_default=text('CURRENT_TIMESTAMP')
71 | )
72 | """The timestamp representing when the record was created."""
73 |
74 | updated_at: Mapped[datetime] = mapped_column(
75 | DateTime, nullable=False, default=datetime.now, onupdate=datetime.now,
76 | server_default=text('CURRENT_TIMESTAMP'), server_onupdate=text('CURRENT_TIMESTAMP')
77 | )
78 | """The timestamp representing when the record was last updated."""
79 |
80 | tenant = relationship('Tenant', back_populates='crypto_keys')
81 | """The tenant associated with the cryptographic key."""
82 |
83 |
84 | class TsigKey(BaseSqlModel):
85 | """Represents a TSIG key."""
86 |
87 | __tablename__ = 'pda_tsig_keys'
88 | """Defines the database table name."""
89 |
90 | id: Mapped[str] = mapped_column(Uuid, primary_key=True, default=uuid.uuid4)
91 | """The unique identifier of the record."""
92 |
93 | tenant_id: Mapped[str] = mapped_column(Uuid, ForeignKey('pda_tenants.id'), nullable=False)
94 | """The unique identifier of the tenant that owns the record."""
95 |
96 | internal_id: Mapped[str] = mapped_column(String(100), nullable=True)
97 | """The internal identifier, read only."""
98 |
99 | algorithm: Mapped[str] = mapped_column(String(20), nullable=True)
100 | """The algorithm of the TSIG key."""
101 |
102 | key: Mapped[str] = mapped_column(TEXT, nullable=True)
103 | """The base64 encoded secret key."""
104 |
105 | created_at: Mapped[datetime] = mapped_column(
106 | DateTime, nullable=False, default=datetime.now, server_default=text('CURRENT_TIMESTAMP')
107 | )
108 | """The timestamp representing when the record was created."""
109 |
110 | updated_at: Mapped[datetime] = mapped_column(
111 | DateTime, nullable=False, default=datetime.now, onupdate=datetime.now,
112 | server_default=text('CURRENT_TIMESTAMP'), server_onupdate=text('CURRENT_TIMESTAMP')
113 | )
114 | """The timestamp representing when the record was last updated."""
115 |
116 | tenant = relationship('Tenant', back_populates='tsig_keys')
117 | """The tenant associated with the TSIG key."""
118 |
--------------------------------------------------------------------------------
/src-api/lib/services/zabbix.py:
--------------------------------------------------------------------------------
1 | from loguru import logger
2 | from queue import Queue
3 | from threading import Event, Thread
4 | from typing import Any
5 | from lib.config.services import ServicesConfig
6 |
7 |
8 | class ZabbixMetric:
9 | host: str = None
10 | key: str
11 | value: Any
12 | clock: int
13 | ns: int
14 |
15 | def __init__(self, key: str, value: Any, host: str = None):
16 | self.host = host
17 | self.key = key
18 | self.value = value
19 | self.set_timestamp()
20 |
21 | def __str__(self):
22 | return f'{self.host}:{self.key}:{self.value}'
23 |
24 | def set_timestamp(self, timestamp: int = None):
25 | import time
26 |
27 | if timestamp is None:
28 | timestamp = time.time_ns()
29 |
30 | self.clock = timestamp // 1_000_000_000
31 | self.ns = timestamp % 1_000_000_000
32 |
33 | def to_json(self):
34 | return {
35 | 'host': self.host,
36 | 'key': self.key,
37 | 'value': self.value,
38 | 'clock': self.clock,
39 | 'ns': self.ns,
40 | }
41 |
42 |
43 | class ZabbixSender:
44 | _config: ServicesConfig.ZabbixConfig
45 |
46 | def __init__(self, config: ServicesConfig.ZabbixConfig):
47 | self._config = config
48 |
49 | def send(self, metrics: list[ZabbixMetric]) -> str:
50 | """Send the given list of metrics to the Zabbix server."""
51 | import json, socket, struct
52 |
53 | if not self._config.reporter_enabled:
54 | return 'Reporter disabled by configuration.'
55 |
56 | if not self._config.sender_enabled:
57 | return 'Sender disabled by configuration.'
58 |
59 | payload = {
60 | 'request': 'sender data',
61 | 'data': [m.to_json() for m in metrics],
62 | }
63 | data = json.dumps(payload).encode('utf-8')
64 | header = b'ZBXD\x01' + struct.pack('This discussion was created from the release v0.4.1.
--------------------------------------------------------------------------------
/.github/workflows/mega-linter.yml:
--------------------------------------------------------------------------------
1 | ---
2 | # MegaLinter GitHub Action configuration file
3 | # More info at https://megalinter.io
4 | name: MegaLinter
5 |
6 | on:
7 | workflow_dispatch:
8 | push:
9 | branches:
10 | - '-dev'
11 | - '-main'
12 | - '-dependabot/**'
13 | - '-feature/**'
14 | - '-issue/**'
15 | - '-release/**'
16 | tags:
17 | - '-v*.*.*'
18 | paths:
19 | - .github/**
20 | - deployment/**
21 | - docs/**
22 | - src/**
23 | - tests/**
24 | - setup.py
25 | - '*.md'
26 | pull_request:
27 | branches:
28 | - '-dev'
29 | - '-main'
30 | - '-dependabot/**'
31 | - '-feature/**'
32 | - '-issue/**'
33 | - '-release/**'
34 | tags:
35 | - '-v*.*.*'
36 | paths:
37 | - .github/**
38 | - deployment/**
39 | - docs/**
40 | - src/**
41 | - tests/**
42 | - setup.py
43 | - '*.md'
44 |
45 | env: # Comment env block if you do not want to apply fixes
46 | # Apply linter fixes configuration
47 | APPLY_FIXES: all # When active, APPLY_FIXES must also be defined as environment variable (in github/workflows/mega-linter.yml or other CI tool)
48 | APPLY_FIXES_EVENT: all # Decide which event triggers application of fixes in a commit or a PR (pull_request, push, all)
49 | APPLY_FIXES_MODE: pull_request # If APPLY_FIXES is used, defines if the fixes are directly committed (commit) or posted in a PR (pull_request)
50 |
51 | concurrency:
52 | group: ${{ github.ref }}-${{ github.workflow }}
53 | cancel-in-progress: true
54 |
55 | jobs:
56 | build:
57 | name: MegaLinter
58 | runs-on: ubuntu-latest
59 | steps:
60 | # Git Checkout
61 | - name: Checkout Code
62 | uses: actions/checkout@v3
63 | with:
64 | token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
65 |
66 | # MegaLinter
67 | - name: MegaLinter
68 | id: ml
69 | # You can override MegaLinter flavor used to have faster performances
70 | # More info at https://megalinter.io/flavors/
71 | uses: oxsecurity/megalinter@v6
72 | env:
73 | # All available variables are described in documentation
74 | # https://megalinter.io/configuration/
75 | VALIDATE_ALL_CODEBASE: true # Validates all source when push on main, else just the git diff with main. Override with true if you always want to lint all sources
76 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
77 | PAT: ${{ secrets.PAT }}
78 | # ADD YOUR CUSTOM ENV VARIABLES HERE OR DEFINE THEM IN A FILE .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
79 | # DISABLE: COPYPASTE,SPELL # Uncomment to disable copy-paste and spell checks
80 |
81 | # Upload MegaLinter artifacts
82 | - name: Archive production artifacts
83 | if: ${{ success() }} || ${{ failure() }}
84 | uses: actions/upload-artifact@v3
85 | with:
86 | name: MegaLinter reports
87 | path: |
88 | megalinter-reports
89 | mega-linter.log
90 |
91 | # Create pull request if applicable (for now works only on PR from same repository, not from forks)
92 | - name: Create PR with applied fixes
93 | id: cpr
94 | if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository)
95 | uses: peter-evans/create-pull-request@v4
96 | with:
97 | token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
98 | commit-message: "[MegaLinter] Apply linters automatic fixes"
99 | title: "[MegaLinter] Apply linters automatic fixes"
100 | labels: bot
101 |
102 | - name: Create PR output
103 | if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository)
104 | run: |
105 | echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
106 | echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
107 |
108 | # Push new commit if applicable (for now works only on PR from same repository, not from forks)
109 | - name: Prepare commit
110 | if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository)
111 | run: sudo chown -Rc $UID .git/
112 | - name: Commit and push applied linter fixes
113 | if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository)
114 | uses: stefanzweifel/git-auto-commit-action@v4
115 | with:
116 | branch: ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}
117 | commit_message: "[MegaLinter] Apply linters fixes"
118 |
119 |
--------------------------------------------------------------------------------
/src-api/models/db/tasks.py:
--------------------------------------------------------------------------------
1 | """
2 | PDA Task Database Models
3 |
4 | This file defines the database models associated with task functionality.
5 | """
6 | import uuid
7 | from datetime import datetime
8 | from enum import Enum
9 | from sqlalchemy import DateTime, DECIMAL, Integer, String, TEXT, Uuid, text, ForeignKey
10 | from sqlalchemy.orm import Mapped, mapped_column, relationship
11 | from typing import Optional
12 | from models.base import BaseSqlModel
13 |
14 |
15 | class TaskJobStatusEnum(str, Enum):
16 | """Defines the different task job statuses."""
17 | received = "received"
18 | """When a task job has been received but not yet started."""
19 |
20 | revoked = "revoked"
21 | """When a task job has been revoked before completion."""
22 |
23 | running = "running"
24 | """When a task job is actively running."""
25 |
26 | retry = "retry"
27 | """When a task job has failed to complete successfully and is awaiting another attempt."""
28 |
29 | success = "success"
30 | """When a task job has completed successfully."""
31 |
32 | failed = "failed"
33 | """When a task job has failed permanently having exhausted any available retry attempts."""
34 |
35 | internal_error = "internal_error"
36 | """When a task job has failed permanently from having an internal error."""
37 |
38 |
39 | class TaskJob(BaseSqlModel):
40 | """Represents a PDA task job."""
41 |
42 | __tablename__ = 'pda_task_jobs'
43 | """Defines the database table name."""
44 |
45 | id: Mapped[str] = mapped_column(Uuid, primary_key=True)
46 | """The unique identifier of the record."""
47 |
48 | root_id: Mapped[str] = mapped_column(Uuid)
49 | """The unique identifier of the Celery root task associated with this task."""
50 |
51 | parent_id: Mapped[Optional[str]] = mapped_column(Uuid)
52 | """The unique identifier of the Celery parent task associated with this task."""
53 |
54 | task_id: Mapped[Optional[str]] = mapped_column(Uuid)
55 | """The unique identifier of the Celery task associated with this task."""
56 |
57 | name: Mapped[str] = mapped_column(String(255), nullable=False)
58 | """The name of the Celery task."""
59 |
60 | args: Mapped[Optional[str]] = mapped_column(TEXT)
61 | """The JSON-encoded arguments of the Celery task."""
62 |
63 | kwargs: Mapped[Optional[str]] = mapped_column(TEXT)
64 | """The JSON-encoded keyword arguments of the Celery task."""
65 |
66 | options: Mapped[Optional[str]] = mapped_column(TEXT)
67 | """The JSON-encoded options of the Celery task."""
68 |
69 | retries: Mapped[Optional[int]] = mapped_column(Integer, nullable=False, default=0)
70 | """The total number of execution retries performed."""
71 |
72 | runtime: Mapped[Optional[float]] = mapped_column(DECIMAL(14, 6))
73 | """The total runtime of the task job in seconds."""
74 |
75 | output: Mapped[Optional[str]] = mapped_column(TEXT)
76 | """The captured STDOUT and STDERR of the task job."""
77 |
78 | errors: Mapped[Optional[str]] = mapped_column(TEXT)
79 | """The captured exception stacktraces of the task job."""
80 |
81 | status: Mapped[TaskJobStatusEnum] = mapped_column(String(20), nullable=False)
82 | """The current status of the task job."""
83 |
84 | created_at: Mapped[datetime] = mapped_column(
85 | DateTime, nullable=False, default=datetime.now, server_default=text('CURRENT_TIMESTAMP')
86 | )
87 | """The timestamp representing when the record was created."""
88 |
89 | updated_at: Mapped[datetime] = mapped_column(
90 | DateTime, nullable=False, default=datetime.now, onupdate=datetime.now,
91 | server_default=text('CURRENT_TIMESTAMP'), server_onupdate=text('CURRENT_TIMESTAMP')
92 | )
93 | """The timestamp representing when the record was last updated."""
94 |
95 | started_at: Mapped[Optional[DateTime]] = mapped_column(DateTime)
96 | """The timestamp representing when the task job was started."""
97 |
98 | ended_at: Mapped[Optional[DateTime]] = mapped_column(DateTime)
99 | """The timestamp representing when the task job was completed."""
100 |
101 | activities = relationship('TaskJobActivity', back_populates='task_job')
102 | """A list of activities associated with the task job."""
103 |
104 |
105 | class TaskJobActivity(BaseSqlModel):
106 | """Represents a PDA task job activity update."""
107 |
108 | __tablename__ = 'pda_task_job_activities'
109 | """Defines the database table name."""
110 |
111 | id: Mapped[str] = mapped_column(Uuid, primary_key=True, default=uuid.uuid4)
112 | """The unique identifier of the record."""
113 |
114 | task_job_id: Mapped[str] = mapped_column(Uuid, ForeignKey('pda_task_jobs.id'), nullable=False)
115 | """The unique identifier of the task job associated with this activity update."""
116 |
117 | error: Mapped[Optional[str]] = mapped_column(TEXT)
118 | """The captured exception stacktrace of a failed task job execution."""
119 |
120 | status: Mapped[TaskJobStatusEnum] = mapped_column(String(20), nullable=False)
121 | """The status of the task job for the activity update."""
122 |
123 | created_at: Mapped[datetime] = mapped_column(
124 | DateTime, nullable=False, default=datetime.now, server_default=text('CURRENT_TIMESTAMP')
125 | )
126 | """The timestamp representing when the record was created."""
127 |
128 | task_job = relationship('TaskJob', back_populates='activities')
129 | """The task job associated with the activity update."""
130 |
--------------------------------------------------------------------------------
/src-api/lib/services/microsoft/teams.py:
--------------------------------------------------------------------------------
1 | from enum import Enum
2 | from pydantic import Field
3 | from typing import Optional, Union
4 | from lib.services.microsoft.adaptivecards import ElementTypes, ContainerStyleEnum
5 | from models.base import BaseModel
6 |
7 |
8 | class MessageActionType(str, Enum):
9 | """Represents an Adaptive Card Message Action type."""
10 | OpenUrl = "Action.OpenUrl"
11 |
12 |
13 | class MessageAction(BaseModel):
14 | """Represents a Microsoft Teams Message action."""
15 |
16 | type: MessageActionType = Field(description="The type of the action")
17 | """The type of the action."""
18 |
19 |
20 | class MessageActionOpenUrl(MessageAction):
21 | """Represents a Microsoft Teams Message URL open action."""
22 |
23 | type: MessageActionType = Field(
24 | description="The type of the action",
25 | default=MessageActionType.OpenUrl,
26 | )
27 | """The type of the action."""
28 |
29 | title: str = Field(
30 | description="The title of the action",
31 | default="View in Browser",
32 | )
33 | """The title of the action."""
34 |
35 | url: str = Field(description="The URL of the action")
36 | """The URL of the action."""
37 |
38 |
39 | ActionTypes = Union[MessageAction, MessageActionOpenUrl]
40 |
41 |
42 | class MessageAttachment(BaseModel):
43 | """Represents a Microsoft Teams message attachment."""
44 |
45 | content_type: str = Field(
46 | description="The content type of the message attachment",
47 | alias="contentType",
48 | )
49 | """The content type of the message attachment."""
50 |
51 |
52 | class AdaptiveCardMessageAttachment(MessageAttachment):
53 | """Represents a Microsoft Teams Adaptive Card message attachment."""
54 |
55 | class Content(BaseModel):
56 | """Represents a Microsoft Teams Adaptive Card message attachment content object."""
57 |
58 | schema_: str = Field(
59 | description="The schema of the content object.",
60 | alias="$schema",
61 | default="http://adaptivecards.io/schemas/adaptive-card.json",
62 | )
63 | """The schema of the content object."""
64 |
65 | type: str = Field(
66 | description="The type of the content object.",
67 | default="AdaptiveCard",
68 | )
69 | """The type of the content object."""
70 |
71 | version: str = Field(
72 | description="The version of the content object.",
73 | default="1.2",
74 | )
75 | """The version of the content object."""
76 |
77 | body: list[ElementTypes] = Field(
78 | description="The body of the content object.",
79 | default_factory=list,
80 | min_length=1,
81 | )
82 | """The body of the content object."""
83 |
84 | actions: list[ActionTypes] = Field(
85 | description="The actions attached to the content object.",
86 | default_factory=list,
87 | )
88 |
89 | content_type: str = Field(
90 | description="The content type of the message attachment",
91 | alias="contentType",
92 | default="application/vnd.microsoft.card.adaptive",
93 | )
94 | """The content type of the message attachment."""
95 |
96 | content: Content = Field(
97 | description="The content object of the message attachment",
98 | default_factory=Content,
99 | )
100 | """The content object of the message attachment."""
101 |
102 |
103 | class Message(BaseModel):
104 | """Represents a Microsoft Teams message."""
105 |
106 | type: str = Field(
107 | description="The type of the message",
108 | default="message",
109 | )
110 | """The type of the message."""
111 |
112 | attachments: list[AdaptiveCardMessageAttachment] = Field(
113 | description="A list of attachments attached to the message",
114 | default_factory=list,
115 | min_length=1,
116 | )
117 | """The list of attachments attached to the message."""
118 |
119 |
120 | class MessageFactory:
121 | """Represents a Microsoft Teams Message factory."""
122 |
123 | @staticmethod
124 | def create_simple_message(
125 | segments: list[str], title: Optional[str] = None, style: Optional[ContainerStyleEnum] = None,
126 | action_url: Optional[str] = None, action_title: Optional[str] = None,
127 | ) -> Message:
128 | """This method is used to create a simple Microsoft Teams message."""
129 | from lib.services.microsoft.adaptivecards import (
130 | Container, TextBlock, FontSizeEnum, FontWeightEnum
131 | )
132 |
133 | attachment = AdaptiveCardMessageAttachment()
134 |
135 | if isinstance(title, str) and len(stripped_title := title.strip()):
136 | container = Container()
137 |
138 | if isinstance(style, ContainerStyleEnum):
139 | container.style = style
140 |
141 | container.items.append(TextBlock(
142 | text=stripped_title,
143 | size=FontSizeEnum.medium,
144 | weight=FontWeightEnum.bolder,
145 | wrap=True,
146 | ))
147 |
148 | attachment.content.body.append(container)
149 |
150 | for segment in segments:
151 | attachment.content.body.append(TextBlock(
152 | text=segment,
153 | wrap=True,
154 | size=FontSizeEnum.medium,
155 | ))
156 |
157 | if isinstance(action_url, str) and len(stripped_action_url := action_url.strip()):
158 | action = MessageActionOpenUrl(url=stripped_action_url)
159 | if isinstance(action_title, str) and len(stripped_action_title := action_title.strip()):
160 | action.title = stripped_action_title
161 |
162 | attachment.content.actions.append(action)
163 |
164 | return Message(attachments=[attachment])
165 |
--------------------------------------------------------------------------------
/src-api/routers/v1/services/mail.py:
--------------------------------------------------------------------------------
1 | import uuid
2 | from celery.result import AsyncResult
3 | from fastapi import APIRouter
4 | from fastapi.responses import JSONResponse
5 | from lib.pda.api.services.mail import MailServiceSendRequest, MailServiceSendResponse
6 | from routers.root import router_responses
7 |
8 | router = APIRouter(
9 | prefix='/mail',
10 | tags=['services'],
11 | responses=router_responses,
12 | )
13 |
14 | responses = {
15 | 200: {
16 | 'description': 'Mail request sent.',
17 | 'content': {
18 | 'application/json': {
19 | 'example': {
20 | 'id': uuid.uuid4(),
21 | 'status': 'sent',
22 | 'message': 'Mail request completed.',
23 | 'responses': [
24 | {'recipient': 'Recipient #1 ', 'success': True, 'code': 250},
25 | {'recipient': 'Recipient #2 ', 'success': False, 'code': 450,
26 | 'message': 'This mailbox is unavailable.'},
27 | {'recipient': 'recipient3@domain.com', 'success': True, 'code': 250},
28 | ],
29 | },
30 | },
31 | },
32 | },
33 | 202: {
34 | 'description': 'Mail request queued.',
35 | 'content': {
36 | 'application/json': {
37 | 'example': {
38 | 'id': uuid.uuid4(),
39 | 'status': 'queued',
40 | 'message': 'Mail request queued.',
41 | },
42 | },
43 | },
44 | },
45 | 500: {
46 | 'description': 'Mail request failed.',
47 | 'content': {
48 | 'application/json': {
49 | 'example': {
50 | 'id': uuid.uuid4(),
51 | 'status': 'failed',
52 | 'message': 'Mail request failed.',
53 | },
54 | },
55 | },
56 | },
57 | }
58 |
59 |
60 | def update_response_from_task(response: MailServiceSendResponse, task: AsyncResult) -> tuple[
61 | MailServiceSendResponse, int]:
62 | """Updates the given response object with appropriate information based on the state of the given task."""
63 |
64 | response.status = 'queued'
65 | response.message = 'Mail request queued.'
66 | status_code = 202
67 | state = task.state
68 |
69 | if state == 'STARTED':
70 | response.status = 'sending'
71 | response.message = 'Mail request sending.'
72 |
73 | if state == 'RETRY':
74 | response.status = 'retry'
75 | response.message = 'Mail request pending retry.'
76 |
77 | if state == 'SUCCESS':
78 | response.status = 'sent'
79 | response.message = 'Mail request completed.'
80 | response.responses = task.result.responses
81 | status_code = 200
82 |
83 | if state == 'FAILURE':
84 | response.status = 'failed'
85 | response.message = 'Mail request failed.'
86 | status_code = 500
87 |
88 | return response, status_code
89 |
90 |
91 | @router.post('/send', response_model=MailServiceSendResponse, responses=responses)
92 | async def send(request: MailServiceSendRequest, wait_for_finish: bool = False, timeout: float = 60) -> JSONResponse:
93 | import time
94 | from loguru import logger
95 | from lib.enums import TaskEnum
96 | from worker import app as celery_app
97 |
98 | response = MailServiceSendResponse()
99 |
100 | try:
101 | logger.debug(f'Queueing mail request: {request}')
102 |
103 | task: AsyncResult = celery_app.send_task(TaskEnum.PDA_MAIL.value, kwargs={
104 | 'mail_from': request.from_address,
105 | 'mail_to': request.to_addresses,
106 | 'mail_cc': request.cc_addresses,
107 | 'subject': request.subject,
108 | 'body_html': request.body_html,
109 | 'body_text': request.body_plain,
110 | })
111 |
112 | response.id = uuid.UUID(task.id)
113 |
114 | if wait_for_finish:
115 | start = time.time()
116 | while time.time() - start < timeout:
117 | time.sleep(1)
118 | if task.ready():
119 | break
120 |
121 | response, status_code = update_response_from_task(response, task)
122 |
123 | return JSONResponse(response.model_dump(mode='json'), status_code=status_code)
124 |
125 | except Exception as e:
126 | logger.error(f'Mail request failed:\n{e}')
127 |
128 | response.status = 'failed'
129 | response.message = 'Mail request failed.'
130 |
131 | return JSONResponse(response.model_dump(mode='json'), status_code=500)
132 |
133 |
134 | @router.get('/status/:id', response_model=MailServiceSendResponse, responses=responses)
135 | async def status(id: uuid.UUID) -> JSONResponse:
136 | from worker import app as celery_app
137 |
138 | response = MailServiceSendResponse(id=id)
139 |
140 | task = AsyncResult(id=str(id), app=celery_app)
141 |
142 | response.status = 'queued'
143 | response.message = 'Mail request queued.'
144 | status_code = 202
145 | state = task.state
146 |
147 | if state == 'STARTED':
148 | response.status = 'sending'
149 | response.message = 'Mail request sending.'
150 |
151 | if state == 'RETRY':
152 | response.status = 'retry'
153 | response.message = 'Mail request pending retry.'
154 |
155 | if state == 'SUCCESS':
156 | response.status = 'sent'
157 | response.message = 'Mail request completed.'
158 | response.responses = task.result.responses
159 | status_code = 200
160 |
161 | if state == 'FAILURE':
162 | response.status = 'failed'
163 | response.message = 'Mail request failed.'
164 | status_code = 500
165 |
166 | return JSONResponse(response.model_dump(mode='json'), status_code=status_code)
167 |
--------------------------------------------------------------------------------
/docs/wiki/contributing/labeling-standards.md:
--------------------------------------------------------------------------------
1 | # PDA Next
2 |
3 | ## Contribution Guide
4 |
5 | ### Labeling Standards
6 |
7 | It's important to recognize the value of proper labeling for issues and discussions when a project operates at scale.
8 | Without this organization, it makes for extra workload on the project maintainers as it requires a detailed review of
9 | each unlabeled issue to set in motion any further workflows, both automated and manual.
10 |
11 | Please consider the following document when creating new issues or discussions. If an issue or discussion isn't
12 | properly labeled per the following standards, it may result in notable delays before a project maintainer addresses
13 | the issue or discussion.
14 |
15 | ### Labeling Categories
16 |
17 | ##### Bug Issues
18 |
19 | This category should be used to report any mis-behaving / broken feature, changes that break functionality or usability,
20 | and most importantly, security vulnerabilities.
21 |
22 | | Property | Value |
23 | |----------|---------|
24 | | Color | #d73a4a |
25 | | Pattern | bug / * |
26 |
27 | ##### Documentation Issues
28 |
29 | This category should be used to hold any discussions of existing project documentation as well as making new
30 | documentation requests.
31 |
32 | | Property | Value |
33 | |----------|----------|
34 | | Color | #0075ca |
35 | | Pattern | docs / * |
36 |
37 | ##### Feature Issues
38 |
39 | This category should be used to hold any discussions of existing features as well as making new feature or enhancement
40 | requests.
41 |
42 | | Property | Value |
43 | |----------|-------------|
44 | | Color | #008672 |
45 | | Pattern | feature / * |
46 |
47 |
48 | ##### Help Issues
49 |
50 | This category should be used to request help with the various aspects of using the application.
51 |
52 | | Property | Value |
53 | |----------|----------|
54 | | Color | #d876e3 |
55 | | Pattern | help / * |
56 |
57 | ##### Moderation Flags
58 |
59 | This category should only be used by project maintainers for use in management workflows.
60 |
61 | | Property | Value |
62 | |----------|---------|
63 | | Color | #e5ef23 |
64 | | Pattern | mod / * |
65 |
66 | ##### Skills Flags
67 |
68 | This category should only be used by project maintainers to categorize the skills required for addressing a topic.
69 |
70 | | Property | Value |
71 | |----------|-----------|
72 | | Color | #5319e7 |
73 | | Pattern | skill / * |
74 |
75 | ### Labels
76 |
77 | Below is a list of all labels currently used on the project for organizing issues, discussions, and pull-requests.
78 |
79 | | Label | When to use it |
80 | |------------------------------|----------------------------------------------------------------------|
81 | | bug / broken-feature | Existing feature malfunctioning or broken |
82 | | bug / security-vulnerability | Security vulnerability identified with the application |
83 | | docs / discussion | Documentation change proposals |
84 | | docs / request | Documentation change request |
85 | | feature / dependency | Existing feature dependency |
86 | | feature / discussion | New or existing feature discussion |
87 | | feature / request | New feature or enhancement request |
88 | | help / deployment | Questions regarding application deployment |
89 | | help / features | Questions regarding the use of application features |
90 | | help / other | General questions not specific to application deployment or features |
91 | | mod / accepted | This request has been accepted |
92 | | mod / announcement | This is an admin announcement |
93 | | mod / change-request | Used by internal developers to indicate a change-request. |
94 | | mod / changes-requested | Changes have been requested before proceeding |
95 | | mod / duplicate | This issue or pull request already exists |
96 | | mod / good-first-issue | Good for newcomers |
97 | | mod / help-wanted | Extra attention is needed |
98 | | mod / invalid | This doesn't seem right |
99 | | mod / rejected | This request has been rejected |
100 | | mod / reviewed | This request has been reviewed |
101 | | mod / reviewing | This request is being reviewed |
102 | | mod / stale | This request has gone stale |
103 | | mod / tested | This has been tested |
104 | | mod / testing | This is being tested |
105 | | mod / wont-fix | This will not be worked on |
106 | | skill / database | Requires a database skill-set |
107 | | skill / docker | Requires a Docker skill-set |
108 | | skill / documentation | Requires a documentation skill-set |
109 | | skill / html | Requires a HTML skill-set |
110 | | skill / javascript | Requires a JavaScript skill-set |
111 | | skill / python | Requires a Python skill-set |
112 |
--------------------------------------------------------------------------------
/src-api/tasks/pda.py:
--------------------------------------------------------------------------------
1 | from celery import current_app
2 | from typing import Any
3 | from lib.enums import TaskEnum
4 | from lib.mail import EmailSendResult
5 |
6 |
7 | @current_app.task(name=TaskEnum.PDA_MAIL.value, label='PDA Mail',
8 | autoretry_for=(Exception,), retry_kwargs={'max_retries': 1, 'countdown': 300})
9 | def mail(individual_tasks: bool = True, **kwargs) -> EmailSendResult:
10 | """This task builds an email based on the given arguments and sends it to the defined recipient(s)."""
11 | import jsonpickle
12 | import time
13 | from loguru import logger
14 | from worker import app as celery_app
15 | from lib.mail import Email
16 |
17 | if 'mail_to' not in kwargs:
18 | raise Exception('Mail recipient(s) not provided!')
19 |
20 | if not isinstance(kwargs['mail_to'], list) and not isinstance(kwargs['mail_to'], str):
21 | raise Exception(f'Mail recipient(s) not valid: Type: {type(kwargs["mail_to"])}, Value: {kwargs["mail_to"]}')
22 |
23 | if isinstance(kwargs['mail_to'], str):
24 | kwargs['mail_to'] = [kwargs['mail_to']]
25 |
26 | log_msg = 'Sending mail:\n'
27 |
28 | if 'mail_from' in kwargs:
29 | log_msg += f'From: {kwargs["mail_from"]}\n'
30 |
31 | log_msg += f'To: {kwargs["mail_to"]}\n'
32 |
33 | if 'subject' in kwargs:
34 | log_msg += f'Subject: {kwargs["subject"]}\n'
35 |
36 | if 'template' in kwargs:
37 | log_msg += f'Template: {kwargs["template"]}\n'
38 | if 'data' in kwargs:
39 | if isinstance(kwargs['data'], str):
40 | log_msg += f'Data: {jsonpickle.loads(kwargs["data"])}\n\n'
41 | elif kwargs['data'] is not None:
42 | log_msg += f'Data: {kwargs["data"]}\n\n'
43 |
44 | if 'body_html' in kwargs:
45 | log_msg += f'Body [HTML]:\n{kwargs["body_html"]}\n\n'
46 |
47 | if 'body_text' in kwargs:
48 | log_msg += f'Body [PLAIN]:\n{kwargs["body_text"]}\n\n'
49 |
50 | logger.debug(log_msg)
51 |
52 | if not individual_tasks:
53 | send_result = Email(**kwargs).send()
54 | else:
55 | tasks = []
56 |
57 | for to in kwargs['mail_to']:
58 | send_kwargs = {**kwargs, 'mail_to': to}
59 | tasks.append(celery_app.send_task(TaskEnum.PDA_MAIL_SEND.value, kwargs=send_kwargs))
60 |
61 | logger.debug(f'Waiting for {len(tasks)} mail sub-tasks to complete...')
62 |
63 | while not all(task.ready() for task in tasks):
64 | time.sleep(1)
65 |
66 | send_result = EmailSendResult()
67 |
68 | for task in tasks:
69 | send_result.responses += task.result.responses
70 |
71 | logger.debug(f'All {len(tasks)} mail sub-tasks completed.')
72 |
73 | logger.debug(f'Finished sending mail.')
74 |
75 | for response in send_result.responses:
76 | logger.debug(f'Mail Send Response: Recipient: {response.recipient}, Status: {response.success}. '
77 | + f'Code: {response.code}, Message: {response.message}')
78 |
79 | return send_result
80 |
81 |
82 | @current_app.task(name=TaskEnum.PDA_MAIL_SEND.value, label='PDA Mail Send',
83 | autoretry_for=(Exception,), retry_kwargs={'max_retries': 5, 'countdown': 300})
84 | def mail_send(**kwargs) -> EmailSendResult:
85 | """This task builds an email based on the given arguments and sends it to the defined recipient(s)."""
86 | from loguru import logger
87 | from lib.mail import Email
88 |
89 | logger.debug(f'Sending mail: {kwargs}')
90 |
91 | send_result = Email(**kwargs).send()
92 |
93 | logger.debug(f'Finished sending mail.')
94 |
95 | return send_result
96 |
97 |
98 | @current_app.task(name=TaskEnum.PDA_ALERT.value, label='PDA Alert')
99 | def alert(msg: str, info: Any = None, title: str = None):
100 | """Sends an alert to the configured administrators about runtime issues."""
101 | from app import notifications
102 | from lib.notifications import NotificationManager
103 | from lib.notifications.events import AlertEvent
104 |
105 | message = msg.strip()
106 |
107 | if isinstance(info, str):
108 | message += f'\n\nInfo:\n{info}'
109 |
110 | event = AlertEvent(
111 | title=title,
112 | message=message,
113 | exception=info,
114 | )
115 |
116 | NotificationManager(configs=notifications).handle_event(event)
117 |
118 |
119 | @current_app.task(name=TaskEnum.PDA_TEST.value, label='PDA Test Task')
120 | def test():
121 | """Sends a log message to indicate task execution."""
122 | import time
123 | from loguru import logger
124 | logger.warning(f'Starting test task.')
125 | time.sleep(1)
126 | logger.warning(f'Finished test task.')
127 |
128 |
129 | @current_app.task(name=TaskEnum.PDA_TEST_MAIL.value, label='PDA Test Mail')
130 | def test_mail():
131 | """Sends an alert message to test the mailing system."""
132 | from loguru import logger
133 | from worker import app as celery_app
134 | logger.warning(f'Starting mail test task.')
135 | celery_app.send_task(TaskEnum.PDA_ALERT.value, kwargs={
136 | 'msg': 'PDA Mail Test',
137 | 'info': 'This is an PDA mailing system test.'
138 | })
139 | logger.warning(f'Finished mail test task.')
140 |
141 |
142 | @current_app.task(name=TaskEnum.PDA_TEST_EXCEPTION.value, label='PDA Test Exception')
143 | def test_exception():
144 | """Throws an exception immediately to test global exception handling."""
145 | raise Exception('Test Exception')
146 |
147 |
148 | @current_app.task(name=TaskEnum.PDA_TEST_EXCEPTION_RETRY.value, label='PDA Test Exception Retry',
149 | autoretry_for=(Exception,), retry_kwargs={'max_retries': 2, 'countdown': 20})
150 | def test_exception_retry():
151 | """Throws an exception immediately to test auto-retry handling."""
152 | raise Exception('Test Exception')
153 |
154 |
155 | @current_app.task(name=TaskEnum.PDA_TEST_DELAY.value, label='PDA Test Delay')
156 | def test_delay():
157 | """Executes a pause to simulate a long-running task."""
158 | import time
159 | from loguru import logger
160 | logger.warning(f'Starting test delay task.')
161 | time.sleep(60)
162 | logger.warning(f'Finished test delay task.')
163 |
--------------------------------------------------------------------------------