aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcrupest <crupest@outlook.com>2024-11-11 01:12:29 +0800
committerYuqian Yang <crupest@crupest.life>2025-01-09 18:01:15 +0800
commit47ebda69daa34ea7992b6bbadf46de98dd17a390 (patch)
tree8d169d75c9bd9a48f47383f245e371e57ea2eb8f
parent43892b892cfdc4e15f7ab191c42ccb32279fd7f6 (diff)
downloadcrupest-47ebda69daa34ea7992b6bbadf46de98dd17a390.tar.gz
crupest-47ebda69daa34ea7992b6bbadf46de98dd17a390.tar.bz2
crupest-47ebda69daa34ea7992b6bbadf46de98dd17a390.zip
HALF WORK: 2024.1.9
-rw-r--r--crupest-words.txt1
-rw-r--r--templates/mailserver.env.template661
-rw-r--r--tools/cru-py/cru/_error.py6
-rw-r--r--tools/cru-py/cru/service/__main__.py49
-rw-r--r--tools/cru-py/cru/service/_app.py24
-rw-r--r--tools/cru-py/cru/service/_base.py153
-rw-r--r--tools/cru-py/cru/service/_config.py3
-rw-r--r--tools/cru-py/cru/service/_data.py8
-rw-r--r--tools/cru-py/cru/template.py11
-rw-r--r--tools/manage.cmd15
10 files changed, 175 insertions, 756 deletions
diff --git a/crupest-words.txt b/crupest-words.txt
index 6b9961b..80992d1 100644
--- a/crupest-words.txt
+++ b/crupest-words.txt
@@ -18,6 +18,7 @@ indep
kmod
nocheck
nproc
+PYTHONPATH
quiltrc
rspamd
sbuild
diff --git a/templates/mailserver.env.template b/templates/mailserver.env.template
deleted file mode 100644
index 031c196..0000000
--- a/templates/mailserver.env.template
+++ /dev/null
@@ -1,661 +0,0 @@
-# -----------------------------------------------
-# --- Mailserver Environment Variables ----------
-# -----------------------------------------------
-
-# DOCUMENTATION FOR THESE VARIABLES IS FOUND UNDER
-# https://docker-mailserver.github.io/docker-mailserver/latest/config/environment/
-
-# -----------------------------------------------
-# --- General Section ---------------------------
-# -----------------------------------------------
-
-# empty => uses the `hostname` command to get the mail server's canonical hostname
-# => Specify a fully-qualified domainname to serve mail for. This is used for many of the config features so if you can't set your hostname (e.g. you're in a container platform that doesn't let you) specify it in this environment variable.
-OVERRIDE_HOSTNAME=
-
-# REMOVED in version v11.0.0! Use LOG_LEVEL instead.
-DMS_DEBUG=0
-
-# Set the log level for DMS.
-# This is mostly relevant for container startup scripts and change detection event feedback.
-#
-# Valid values (in order of increasing verbosity) are: `error`, `warn`, `info`, `debug` and `trace`.
-# The default log level is `info`.
-LOG_LEVEL=info
-
-# critical => Only show critical messages
-# error => Only show erroneous output
-# **warn** => Show warnings
-# info => Normal informational output
-# debug => Also show debug messages
-SUPERVISOR_LOGLEVEL=
-
-# Support for deployment where these defaults are not compatible (eg: some NAS appliances):
-# /var/mail vmail User ID (default: 5000)
-DMS_VMAIL_UID=
-# /var/mail vmail Group ID (default: 5000)
-DMS_VMAIL_GID=
-
-# **empty** => use FILE
-# LDAP => use LDAP authentication
-# OIDC => use OIDC authentication (not yet implemented)
-# FILE => use local files (this is used as the default)
-ACCOUNT_PROVISIONER=
-
-# empty => postmaster@domain.com
-# => Specify the postmaster address
-POSTMASTER_ADDRESS=
-
-# Check for updates on container start and then once a day
-# If an update is available, a mail is sent to POSTMASTER_ADDRESS
-# 0 => Update check disabled
-# 1 => Update check enabled
-ENABLE_UPDATE_CHECK=1
-
-# Customize the update check interval.
-# Number + Suffix. Suffix must be 's' for seconds, 'm' for minutes, 'h' for hours or 'd' for days.
-UPDATE_CHECK_INTERVAL=1d
-
-# Set different options for mynetworks option (can be overwrite in postfix-main.cf)
-# **WARNING**: Adding the docker network's gateway to the list of trusted hosts, e.g. using the `network` or
-# `connected-networks` option, can create an open relay
-# https://github.com/docker-mailserver/docker-mailserver/issues/1405#issuecomment-590106498
-# The same can happen for rootless podman. To prevent this, set the value to "none" or configure slirp4netns
-# https://github.com/docker-mailserver/docker-mailserver/issues/2377
-#
-# none => Explicitly force authentication
-# container => Container IP address only
-# host => Add docker container network (ipv4 only)
-# network => Add all docker container networks (ipv4 only)
-# connected-networks => Add all connected docker networks (ipv4 only)
-PERMIT_DOCKER=none
-
-# Set the timezone. If this variable is unset, the container runtime will try to detect the time using
-# `/etc/localtime`, which you can alternatively mount into the container. The value of this variable
-# must follow the pattern `AREA/ZONE`, i.e. of you want to use Germany's time zone, use `Europe/Berlin`.
-# You can lookup all available timezones here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
-TZ=
-
-# In case you network interface differs from 'eth0', e.g. when you are using HostNetworking in Kubernetes,
-# you can set NETWORK_INTERFACE to whatever interface you want. This interface will then be used.
-# - **empty** => eth0
-NETWORK_INTERFACE=
-
-# empty => modern
-# modern => Enables TLSv1.2 and modern ciphers only. (default)
-# intermediate => Enables TLSv1, TLSv1.1 and TLSv1.2 and broad compatibility ciphers.
-TLS_LEVEL=
-
-# Configures the handling of creating mails with forged sender addresses.
-#
-# **0** => (not recommended) Mail address spoofing allowed. Any logged in user may create email messages with a forged sender address (see also https://en.wikipedia.org/wiki/Email_spoofing).
-# 1 => Mail spoofing denied. Each user may only send with his own or his alias addresses. Addresses with extension delimiters(http://www.postfix.org/postconf.5.html#recipient_delimiter) are not able to send messages.
-SPOOF_PROTECTION=
-
-# Enables the Sender Rewriting Scheme. SRS is needed if your mail server acts as forwarder. See [postsrsd](https://github.com/roehling/postsrsd/blob/master/README.md#sender-rewriting-scheme-crash-course) for further explanation.
-# - **0** => Disabled
-# - 1 => Enabled
-ENABLE_SRS=0
-
-# Enables the OpenDKIM service.
-# **1** => Enabled
-# 0 => Disabled
-ENABLE_OPENDKIM=0
-
-# Enables the OpenDMARC service.
-# **1** => Enabled
-# 0 => Disabled
-ENABLE_OPENDMARC=0
-
-
-# Enabled `policyd-spf` in Postfix's configuration. You will likely want to set this
-# to `0` in case you're using Rspamd (`ENABLE_RSPAMD=1`).
-#
-# - 0 => Disabled
-# - **1** => Enabled
-ENABLE_POLICYD_SPF=0
-
-# Enables POP3 service
-# - **0** => Disabled
-# - 1 => Enabled
-ENABLE_POP3=
-
-# Enables IMAP service
-# - 0 => Disabled
-# - **1** => Enabled
-ENABLE_IMAP=1
-
-# Enables ClamAV, and anti-virus scanner.
-# 1 => Enabled
-# **0** => Disabled
-ENABLE_CLAMAV=0
-
-# Add the value of this ENV as a prefix to the mail subject when spam is detected.
-# NOTE: This subject prefix may be redundant (by default spam is delivered to a junk folder).
-# It provides value when your junk mail is stored alongside legitimate mail instead of a separate location (like with `SPAMASSASSIN_SPAM_TO_INBOX=1` or `MOVE_SPAM_TO_JUNK=0` or a POP3 only setup, without IMAP).
-# NOTE: When not using Docker Compose, other CRI may not support quote-wrapping the value here to preserve any trailing white-space.
-SPAM_SUBJECT=
-
-# Enables Rspamd
-# **0** => Disabled
-# 1 => Enabled
-ENABLE_RSPAMD=1
-
-# When `ENABLE_RSPAMD=1`, an internal Redis instance is enabled implicitly.
-# This setting provides an opt-out to allow using an external instance instead.
-# 0 => Disabled
-# 1 => Enabled
-ENABLE_RSPAMD_REDIS=
-
-# When enabled,
-#
-# 1. the "[autolearning][rspamd-autolearn]" feature is turned on;
-# 2. the Bayes classifier will be trained when moving mails from or to the Junk folder (with the help of Sieve scripts).
-#
-# **0** => disabled
-# 1 => enabled
-RSPAMD_LEARN=0
-
-# This settings controls whether checks should be performed on emails coming
-# from authenticated users (i.e. most likely outgoing emails). The default value
-# is `0` in order to align better with SpamAssassin. We recommend reading
-# through https://rspamd.com/doc/tutorials/scanning_outbound.html though to
-# decide for yourself whether you need and want this feature.
-#
-# Note that DKIM signing of e-mails will still happen.
-RSPAMD_CHECK_AUTHENTICATED=0
-
-# Controls whether the Rspamd Greylisting module is enabled.
-# This module can further assist in avoiding spam emails by greylisting
-# e-mails with a certain spam score.
-#
-# **0** => disabled
-# 1 => enabled
-RSPAMD_GREYLISTING=1
-
-# Can be used to enable or disable the Hfilter group module.
-#
-# - 0 => Disabled
-# - **1** => Enabled
-RSPAMD_HFILTER=1
-
-# Can be used to control the score when the HFILTER_HOSTNAME_UNKNOWN symbol applies. A higher score is more punishing. Setting it to 15 is equivalent to rejecting the email when the check fails.
-#
-# Default: 6
-RSPAMD_HFILTER_HOSTNAME_UNKNOWN_SCORE=6
-
-# Can be used to enable or disable the (still experimental) neural module.
-#
-# - **0** => Disabled
-# - 1 => Enabled
-RSPAMD_NEURAL=0
-
-# Amavis content filter (used for ClamAV & SpamAssassin)
-# 0 => Disabled
-# 1 => Enabled
-ENABLE_AMAVIS=0
-
-# -1/-2/-3 => Only show errors
-# **0** => Show warnings
-# 1/2 => Show default informational output
-# 3/4/5 => log debug information (very verbose)
-AMAVIS_LOGLEVEL=0
-
-# This enables DNS block lists in Postscreen.
-# Note: Emails will be rejected, if they don't pass the block list checks!
-# **0** => DNS block lists are disabled
-# 1 => DNS block lists are enabled
-ENABLE_DNSBL=0
-
-# If you enable Fail2Ban, don't forget to add the following lines to your `compose.yaml`:
-# cap_add:
-# - NET_ADMIN
-# Otherwise, `nftables` won't be able to ban IPs.
-ENABLE_FAIL2BAN=0
-
-# Fail2Ban blocktype
-# drop => drop packet (send NO reply)
-# reject => reject packet (send ICMP unreachable)
-FAIL2BAN_BLOCKTYPE=drop
-
-# 1 => Enables Managesieve on port 4190
-# empty => disables Managesieve
-ENABLE_MANAGESIEVE=
-
-# **enforce** => Allow other tests to complete. Reject attempts to deliver mail with a 550 SMTP reply, and log the helo/sender/recipient information. Repeat this test the next time the client connects.
-# drop => Drop the connection immediately with a 521 SMTP reply. Repeat this test the next time the client connects.
-# ignore => Ignore the failure of this test. Allow other tests to complete. Repeat this test the next time the client connects. This option is useful for testing and collecting statistics without blocking mail.
-POSTSCREEN_ACTION=enforce
-
-# empty => all daemons start
-# 1 => only launch postfix smtp
-SMTP_ONLY=
-
-# Please read [the SSL page in the documentation](https://docker-mailserver.github.io/docker-mailserver/latest/config/security/ssl) for more information.
-#
-# empty => SSL disabled
-# letsencrypt => Enables Let's Encrypt certificates
-# custom => Enables custom certificates
-# manual => Let's you manually specify locations of your SSL certificates for non-standard cases
-# self-signed => Enables self-signed certificates
-SSL_TYPE=letsencrypt
-
-# These are only supported with `SSL_TYPE=manual`.
-# Provide the path to your cert and key files that you've mounted access to within the container.
-SSL_CERT_PATH=
-SSL_KEY_PATH=
-# Optional: A 2nd certificate can be supported as fallback (dual cert support), eg ECDSA with an RSA fallback.
-# Useful for additional compatibility with older MTA and MUA (eg pre-2015).
-SSL_ALT_CERT_PATH=
-SSL_ALT_KEY_PATH=
-
-# Set how many days a virusmail will stay on the server before being deleted
-# empty => 7 days
-VIRUSMAILS_DELETE_DELAY=
-
-# Configure Postfix `virtual_transport` to deliver mail to a different LMTP client (default is a dovecot socket).
-# Provide any valid URI. Examples:
-#
-# empty => `lmtp:unix:/var/run/dovecot/lmtp` (default, configured in Postfix main.cf)
-# `lmtp:unix:private/dovecot-lmtp` (use socket)
-# `lmtps:inet:<host>:<port>` (secure lmtp with starttls)
-# `lmtp:<kopano-host>:2003` (use kopano as mailstore)
-POSTFIX_DAGENT=
-
-# Set the mailbox size limit for all users. If set to zero, the size will be unlimited (default). Size is in bytes.
-#
-# empty => 0
-POSTFIX_MAILBOX_SIZE_LIMIT=
-
-# See https://docker-mailserver.github.io/docker-mailserver/latest/config/account-management/overview/#quotas
-# 0 => Dovecot quota is disabled
-# 1 => Dovecot quota is enabled
-ENABLE_QUOTAS=1
-
-# Set the message size limit for all users. If set to zero, the size will be unlimited (not recommended!). Size is in bytes.
-#
-# empty => 10240000 (~10 MB)
-POSTFIX_MESSAGE_SIZE_LIMIT=
-
-# Mails larger than this limit won't be scanned.
-# ClamAV must be enabled (ENABLE_CLAMAV=1) for this.
-#
-# empty => 25M (25 MB)
-CLAMAV_MESSAGE_SIZE_LIMIT=
-
-# Enables regular pflogsumm mail reports.
-# This is a new option. The old REPORT options are still supported for backwards compatibility. If this is not set and reports are enabled with the old options, logrotate will be used.
-#
-# not set => No report
-# daily_cron => Daily report for the previous day
-# logrotate => Full report based on the mail log when it is rotated
-PFLOGSUMM_TRIGGER=
-
-# Recipient address for pflogsumm reports.
-#
-# not set => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS
-# => Specify the recipient address(es)
-PFLOGSUMM_RECIPIENT=
-
-# Sender address (`FROM`) for pflogsumm reports if pflogsumm reports are enabled.
-#
-# not set => Use REPORT_SENDER
-# => Specify the sender address
-PFLOGSUMM_SENDER=
-
-# Interval for logwatch report.
-#
-# none => No report is generated
-# daily => Send a daily report
-# weekly => Send a report every week
-LOGWATCH_INTERVAL=
-
-# Recipient address for logwatch reports if they are enabled.
-#
-# not set => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS
-# => Specify the recipient address(es)
-LOGWATCH_RECIPIENT=
-
-# Sender address (`FROM`) for logwatch reports if logwatch reports are enabled.
-#
-# not set => Use REPORT_SENDER
-# => Specify the sender address
-LOGWATCH_SENDER=
-
-# Defines who receives reports if they are enabled.
-# **empty** => ${POSTMASTER_ADDRESS}
-# => Specify the recipient address
-REPORT_RECIPIENT=
-
-# Defines who sends reports if they are enabled.
-# **empty** => mailserver-report@${DOMAINNAME}
-# => Specify the sender address
-REPORT_SENDER=
-
-# Changes the interval in which log files are rotated
-# **weekly** => Rotate log files weekly
-# daily => Rotate log files daily
-# monthly => Rotate log files monthly
-#
-# Note: This Variable actually controls logrotate inside the container
-# and rotates the log files depending on this setting. The main log output is
-# still available in its entirety via `docker logs mail` (Or your
-# respective container name). If you want to control logrotation for
-# the Docker-generated logfile see:
-# https://docs.docker.com/config/containers/logging/configure/
-#
-# Note: This variable can also determine the interval for Postfix's log summary reports, see [`PFLOGSUMM_TRIGGER`](#pflogsumm_trigger).
-LOGROTATE_INTERVAL=weekly
-
-# Defines how many log files are kept by logrorate
-LOGROTATE_COUNT=4
-
-
-# If enabled, employs `reject_unknown_client_hostname` to sender restrictions in Postfix's configuration.
-#
-# - **0** => Disabled
-# - 1 => Enabled
-POSTFIX_REJECT_UNKNOWN_CLIENT_HOSTNAME=0
-
-# Choose TCP/IP protocols for postfix to use
-# **all** => All possible protocols.
-# ipv4 => Use only IPv4 traffic. Most likely you want this behind Docker.
-# ipv6 => Use only IPv6 traffic.
-#
-# Note: More details at http://www.postfix.org/postconf.5.html#inet_protocols
-POSTFIX_INET_PROTOCOLS=all
-
-# Enables MTA-STS support for outbound mail.
-# More details: https://docker-mailserver.github.io/docker-mailserver/v13.3/config/best-practices/mta-sts/
-# - **0** ==> MTA-STS disabled
-# - 1 => MTA-STS enabled
-ENABLE_MTA_STS=0
-
-# Choose TCP/IP protocols for dovecot to use
-# **all** => Listen on all interfaces
-# ipv4 => Listen only on IPv4 interfaces. Most likely you want this behind Docker.
-# ipv6 => Listen only on IPv6 interfaces.
-#
-# Note: More information at https://dovecot.org/doc/dovecot-example.conf
-DOVECOT_INET_PROTOCOLS=all
-
-# -----------------------------------------------
-# --- SpamAssassin Section ----------------------
-# -----------------------------------------------
-
-ENABLE_SPAMASSASSIN=0
-
-# KAM is a 3rd party SpamAssassin ruleset, provided by the McGrail Foundation.
-# If SpamAssassin is enabled, KAM can be used in addition to the default ruleset.
-# - **0** => KAM disabled
-# - 1 => KAM enabled
-#
-# Note: only has an effect if `ENABLE_SPAMASSASSIN=1`
-ENABLE_SPAMASSASSIN_KAM=0
-
-# deliver spam messages to the inbox (tagged using SPAM_SUBJECT)
-SPAMASSASSIN_SPAM_TO_INBOX=1
-
-# spam messages will be moved in the Junk folder (SPAMASSASSIN_SPAM_TO_INBOX=1 required)
-MOVE_SPAM_TO_JUNK=1
-
-# spam messages will be marked as read
-MARK_SPAM_AS_READ=0
-
-# add 'spam info' headers at, or above this level
-SA_TAG=2.0
-
-# add 'spam detected' headers at, or above this level
-SA_TAG2=6.31
-
-# triggers spam evasive actions
-SA_KILL=10.0
-
-# -----------------------------------------------
-# --- Fetchmail Section -------------------------
-# -----------------------------------------------
-
-ENABLE_FETCHMAIL=0
-
-# The interval to fetch mail in seconds
-FETCHMAIL_POLL=300
-# Use multiple fetchmail instances (1 per poll entry in fetchmail.cf)
-# Supports multiple IMAP IDLE connections when a server is used across multiple poll entries
-# https://otremba.net/wiki/Fetchmail_(Debian)#Immediate_Download_via_IMAP_IDLE
-FETCHMAIL_PARALLEL=0
-
-# Enable or disable `getmail`.
-#
-# - **0** => Disabled
-# - 1 => Enabled
-ENABLE_GETMAIL=0
-
-# The number of minutes for the interval. Min: 1; Default: 5.
-GETMAIL_POLL=5
-
-# -----------------------------------------------
-# --- OAUTH2 Section ----------------------------
-# -----------------------------------------------
-
-# empty => OAUTH2 authentication is disabled
-# 1 => OAUTH2 authentication is enabled
-ENABLE_OAUTH2=
-
-# Specify the user info endpoint URL of the oauth2 provider
-# Example: https://oauth2.example.com/userinfo/
-OAUTH2_INTROSPECTION_URL=
-
-# -----------------------------------------------
-# --- LDAP Section ------------------------------
-# -----------------------------------------------
-
-# A second container for the ldap service is necessary (i.e. https://hub.docker.com/r/bitnami/openldap/)
-
-# empty => no
-# yes => LDAP over TLS enabled for Postfix
-LDAP_START_TLS=
-
-# empty => mail.example.com
-# Specify the `<dns-name>` / `<ip-address>` where the LDAP server is reachable via a URI like: `ldaps://mail.example.com`.
-# Note: You must include the desired URI scheme (`ldap://`, `ldaps://`, `ldapi://`).
-LDAP_SERVER_HOST=
-
-# empty => ou=people,dc=domain,dc=com
-# => e.g. LDAP_SEARCH_BASE=dc=mydomain,dc=local
-LDAP_SEARCH_BASE=
-
-# empty => cn=admin,dc=domain,dc=com
-# => take a look at examples of SASL_LDAP_BIND_DN
-LDAP_BIND_DN=
-
-# empty** => admin
-# => Specify the password to bind against ldap
-LDAP_BIND_PW=
-
-# e.g. `"(&(mail=%s)(mailEnabled=TRUE))"`
-# => Specify how ldap should be asked for users
-LDAP_QUERY_FILTER_USER=
-
-# e.g. `"(&(mailGroupMember=%s)(mailEnabled=TRUE))"`
-# => Specify how ldap should be asked for groups
-LDAP_QUERY_FILTER_GROUP=
-
-# e.g. `"(&(mailAlias=%s)(mailEnabled=TRUE))"`
-# => Specify how ldap should be asked for aliases
-LDAP_QUERY_FILTER_ALIAS=
-
-# e.g. `"(&(|(mail=*@%s)(mailalias=*@%s)(mailGroupMember=*@%s))(mailEnabled=TRUE))"`
-# => Specify how ldap should be asked for domains
-LDAP_QUERY_FILTER_DOMAIN=
-
-# -----------------------------------------------
-# --- Dovecot Section ---------------------------
-# -----------------------------------------------
-
-# empty => no
-# yes => LDAP over TLS enabled for Dovecot
-DOVECOT_TLS=
-
-# e.g. `"(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n))"`
-DOVECOT_USER_FILTER=
-
-# e.g. `"(&(objectClass=PostfixBookMailAccount)(uniqueIdentifier=%n))"`
-DOVECOT_PASS_FILTER=
-
-# Define the mailbox format to be used
-# default is maildir, supported values are: sdbox, mdbox, maildir
-DOVECOT_MAILBOX_FORMAT=maildir
-
-# empty => no
-# yes => Allow bind authentication for LDAP
-# https://wiki.dovecot.org/AuthDatabase/LDAP/AuthBinds
-DOVECOT_AUTH_BIND=
-
-# -----------------------------------------------
-# --- Postgrey Section --------------------------
-# -----------------------------------------------
-
-ENABLE_POSTGREY=0
-# greylist for N seconds
-POSTGREY_DELAY=300
-# delete entries older than N days since the last time that they have been seen
-POSTGREY_MAX_AGE=35
-# response when a mail is greylisted
-POSTGREY_TEXT="Delayed by Postgrey"
-# whitelist host after N successful deliveries (N=0 to disable whitelisting)
-POSTGREY_AUTO_WHITELIST_CLIENTS=5
-
-# -----------------------------------------------
-# --- SASL Section ------------------------------
-# -----------------------------------------------
-
-ENABLE_SASLAUTHD=0
-
-# empty => pam
-# `ldap` => authenticate against ldap server
-# `shadow` => authenticate against local user db
-# `mysql` => authenticate against mysql db
-# `rimap` => authenticate against imap server
-# Note: can be a list of mechanisms like pam ldap shadow
-SASLAUTHD_MECHANISMS=
-
-# empty => None
-# e.g. with SASLAUTHD_MECHANISMS rimap you need to specify the ip-address/servername of the imap server ==> xxx.xxx.xxx.xxx
-SASLAUTHD_MECH_OPTIONS=
-
-# empty => Use value of LDAP_SERVER_HOST
-# Note: You must include the desired URI scheme (`ldap://`, `ldaps://`, `ldapi://`).
-SASLAUTHD_LDAP_SERVER=
-
-# empty => Use value of LDAP_BIND_DN
-# specify an object with privileges to search the directory tree
-# e.g. active directory: SASLAUTHD_LDAP_BIND_DN=cn=Administrator,cn=Users,dc=mydomain,dc=net
-# e.g. openldap: SASLAUTHD_LDAP_BIND_DN=cn=admin,dc=mydomain,dc=net
-SASLAUTHD_LDAP_BIND_DN=
-
-# empty => Use value of LDAP_BIND_PW
-SASLAUTHD_LDAP_PASSWORD=
-
-# empty => Use value of LDAP_SEARCH_BASE
-# specify the search base
-SASLAUTHD_LDAP_SEARCH_BASE=
-
-# empty => default filter `(&(uniqueIdentifier=%u)(mailEnabled=TRUE))`
-# e.g. for active directory: `(&(sAMAccountName=%U)(objectClass=person))`
-# e.g. for openldap: `(&(uid=%U)(objectClass=person))`
-SASLAUTHD_LDAP_FILTER=
-
-# empty => no
-# yes => LDAP over TLS enabled for SASL
-# If set to yes, the protocol in SASLAUTHD_LDAP_SERVER must be ldap:// or missing.
-SASLAUTHD_LDAP_START_TLS=
-
-# empty => no
-# yes => Require and verify server certificate
-# If yes you must/could specify SASLAUTHD_LDAP_TLS_CACERT_FILE or SASLAUTHD_LDAP_TLS_CACERT_DIR.
-SASLAUTHD_LDAP_TLS_CHECK_PEER=
-
-# File containing CA (Certificate Authority) certificate(s).
-# empty => Nothing is added to the configuration
-# Any value => Fills the `ldap_tls_cacert_file` option
-SASLAUTHD_LDAP_TLS_CACERT_FILE=
-
-# Path to directory with CA (Certificate Authority) certificates.
-# empty => Nothing is added to the configuration
-# Any value => Fills the `ldap_tls_cacert_dir` option
-SASLAUTHD_LDAP_TLS_CACERT_DIR=
-
-# Specify what password attribute to use for password verification.
-# empty => Nothing is added to the configuration but the documentation says it is `userPassword` by default.
-# Any value => Fills the `ldap_password_attr` option
-SASLAUTHD_LDAP_PASSWORD_ATTR=
-
-# empty => `bind` will be used as a default value
-# `fastbind` => The fastbind method is used
-# `custom` => The custom method uses userPassword attribute to verify the password
-SASLAUTHD_LDAP_AUTH_METHOD=
-
-# Specify the authentication mechanism for SASL bind
-# empty => Nothing is added to the configuration
-# Any value => Fills the `ldap_mech` option
-SASLAUTHD_LDAP_MECH=
-
-# -----------------------------------------------
-# --- SRS Section -------------------------------
-# -----------------------------------------------
-
-# envelope_sender => Rewrite only envelope sender address (default)
-# header_sender => Rewrite only header sender (not recommended)
-# envelope_sender,header_sender => Rewrite both senders
-# An email has an "envelope" sender (indicating the sending server) and a
-# "header" sender (indicating who sent it). More strict SPF policies may require
-# you to replace both instead of just the envelope sender.
-SRS_SENDER_CLASSES=envelope_sender
-
-# empty => Envelope sender will be rewritten for all domains
-# provide comma separated list of domains to exclude from rewriting
-SRS_EXCLUDE_DOMAINS=
-
-# empty => generated when the image is built
-# provide a secret to use in base64
-# you may specify multiple keys, comma separated. the first one is used for
-# signing and the remaining will be used for verification. this is how you
-# rotate and expire keys
-SRS_SECRET=
-
-# -----------------------------------------------
-# --- Default Relay Host Section ----------------
-# -----------------------------------------------
-
-# Setup relaying all mail through a default relay host
-#
-# Set a default host to relay all mail through (optionally include a port)
-# Example: [mail.example.com]:587
-DEFAULT_RELAY_HOST=
-
-# -----------------------------------------------
-# --- Multi-Domain Relay Section ----------------
-# -----------------------------------------------
-
-# Setup relaying for multiple domains based on the domain name of the sender
-# optionally uses usernames and passwords in postfix-sasl-password.cf and relay host mappings in postfix-relaymap.cf
-#
-# Set a default host to relay mail through
-# Example: mail.example.com
-RELAY_HOST=
-
-# empty => 25
-# default port to relay mail
-RELAY_PORT=25
-
-# -----------------------------------------------
-# --- Relay Host Credentials Section ------------
-# -----------------------------------------------
-
-# Configure a relay user and password to use with RELAY_HOST / DEFAULT_RELAY_HOST
-
-# empty => no default
-RELAY_USER=
-
-# empty => no default
-RELAY_PASSWORD=
diff --git a/tools/cru-py/cru/_error.py b/tools/cru-py/cru/_error.py
index 0d2bf79..e4bf3d6 100644
--- a/tools/cru-py/cru/_error.py
+++ b/tools/cru-py/cru/_error.py
@@ -18,9 +18,11 @@ class CruInternalError(CruException):
class CruUserFriendlyException(CruException):
- def __init__(self, message: str, user_message: str, *args, **kwargs) -> None:
+ def __init__(
+ self, message: str, user_message: str | None = None, *args, **kwargs
+ ) -> None:
super().__init__(message, *args, **kwargs)
- self._user_message = user_message
+ self._user_message = user_message or message
@property
def user_message(self) -> str:
diff --git a/tools/cru-py/cru/service/__main__.py b/tools/cru-py/cru/service/__main__.py
index 923c25b..c218bc6 100644
--- a/tools/cru-py/cru/service/__main__.py
+++ b/tools/cru-py/cru/service/__main__.py
@@ -1,45 +1,6 @@
-from pathlib import Path
+from cru import CruUserFriendlyException
-from cru import CruException
-
-from ._base import AppBase, DATA_DIR_NAME, CommandDispatcher
-from ._config import ConfigManager
-from ._data import DataManager
-from ._template import TemplateManager
-
-
-class App(AppBase):
- def __init__(self, root: str):
- super().__init__("crupest-service", root)
- self.add_feature(DataManager())
- self.add_feature(ConfigManager())
- self.add_feature(TemplateManager())
- self.add_feature(CommandDispatcher())
-
- def setup(self):
- for feature in self.features:
- feature.setup()
-
- def run_command(self):
- command_dispatcher = self.get_feature(CommandDispatcher)
- command_dispatcher.run_command()
-
-
-def _find_root() -> Path:
- cwd = Path.cwd()
- data_dir = cwd / DATA_DIR_NAME
- if data_dir.is_dir():
- return data_dir
- raise CruException(
- "No valid data directory found. Please run 'init' to create one."
- )
-
-
-def create_app() -> App:
- root = _find_root()
- app = App(str(root))
- app.setup()
- return app
+from ._app import create_app
def main():
@@ -48,4 +9,8 @@ def main():
if __name__ == "__main__":
- main()
+ try:
+ main()
+ except CruUserFriendlyException as e:
+ print(f"Error: {e.user_message}")
+ exit(1)
diff --git a/tools/cru-py/cru/service/_app.py b/tools/cru-py/cru/service/_app.py
new file mode 100644
index 0000000..a656e3b
--- /dev/null
+++ b/tools/cru-py/cru/service/_app.py
@@ -0,0 +1,24 @@
+from ._base import AppBase, CommandDispatcher, AppInitializer, OWNER_NAME
+from ._config import ConfigManager
+from ._data import DataManager
+from ._template import TemplateManager
+
+
+class App(AppBase):
+ def __init__(self):
+ super().__init__(f"{OWNER_NAME}-service")
+ self.add_feature(AppInitializer())
+ self.add_feature(DataManager())
+ self.add_feature(ConfigManager())
+ self.add_feature(TemplateManager())
+ self.add_feature(CommandDispatcher())
+
+ def run_command(self):
+ command_dispatcher = self.get_feature(CommandDispatcher)
+ command_dispatcher.run_command()
+
+
+def create_app() -> App:
+ app = App()
+ app.setup()
+ return app
diff --git a/tools/cru-py/cru/service/_base.py b/tools/cru-py/cru/service/_base.py
index 3b511a1..124acd5 100644
--- a/tools/cru-py/cru/service/_base.py
+++ b/tools/cru-py/cru/service/_base.py
@@ -3,14 +3,13 @@ from __future__ import annotations
from argparse import ArgumentParser, Namespace
from abc import ABC, abstractmethod
import argparse
-from collections.abc import Sequence
import os
from pathlib import Path
from typing import TypeVar, overload
-from cru import CruException, CruInternalError, CruPath
+from cru import CruException, CruInternalError, CruPath, CruUserFriendlyException
-_F = TypeVar("_F")
+_Feature = TypeVar("_Feature", bound="AppFeatureProvider")
OWNER_NAME = "crupest"
@@ -30,17 +29,9 @@ class AppPathError(CruException):
class AppPath(ABC):
- def __init__(
- self,
- name: str,
- is_dir: bool,
- /,
- id: str | None = None,
- description: str = "",
- ) -> None:
- self._name = name
+ def __init__(self, id: str, is_dir: bool, description: str) -> None:
self._is_dir = is_dir
- self._id = id or name
+ self._id = id
self._description = description
@property
@@ -48,10 +39,6 @@ class AppPath(ABC):
def parent(self) -> AppPath | None: ...
@property
- def name(self) -> str:
- return self._name
-
- @property
@abstractmethod
def app(self) -> AppBase: ...
@@ -68,11 +55,8 @@ class AppPath(ABC):
return self._is_dir
@property
- def full_path(self) -> CruPath:
- if self.parent is None:
- return CruPath(self.name)
- else:
- return CruPath(self.parent.full_path, self.name)
+ @abstractmethod
+ def full_path(self) -> CruPath: ...
@property
def full_path_str(self) -> str:
@@ -92,12 +76,12 @@ class AppPath(ABC):
if not self.full_path.is_dir():
raise AppPathError("Should be a directory, but not.", self.full_path)
else:
- return False
+ return True
else:
if not self.full_path.is_file():
raise AppPathError("Should be a file, but not.", self.full_path)
else:
- return False
+ return True
def ensure(self, create_file: bool = False) -> None:
e = self.check_self(False)
@@ -130,10 +114,15 @@ class AppFeaturePath(AppPath):
id: str | None = None,
description: str = "",
) -> None:
- super().__init__(name, is_dir, id, description)
+ super().__init__(id or name, is_dir, description)
+ self._name = name
self._parent = parent
@property
+ def name(self) -> str:
+ return self._name
+
+ @property
def parent(self) -> AppPath:
return self._parent
@@ -141,11 +130,16 @@ class AppFeaturePath(AppPath):
def app(self) -> AppBase:
return self.parent.app
+ @property
+ def full_path(self) -> CruPath:
+ return CruPath(self.parent.full_path, self.name)
+
class AppRootPath(AppPath):
- def __init__(self, app: AppBase, path: str):
- super().__init__(path, True, "root", "Application root path.")
+ def __init__(self, app: AppBase):
+ super().__init__("root", True, "Application root path.")
self._app = app
+ self._full_path: CruPath | None = None
@property
def parent(self) -> None:
@@ -155,13 +149,23 @@ class AppRootPath(AppPath):
def app(self) -> AppBase:
return self._app
+ @property
+ def full_path(self) -> CruPath:
+ if self._full_path is None:
+ raise CruInternalError("App root path is not set yet.")
+ return self._full_path
+
+ def setup(self, path: os.PathLike) -> None:
+ if self._full_path is not None:
+ raise CruInternalError("App root path is already set.")
+ self._full_path = CruPath(path)
+
class AppFeatureProvider(ABC):
def __init__(self, name: str, /, app: AppBase | None = None):
super().__init__()
self._name = name
self._app = app if app else AppBase.get_instance()
- self.app.add_feature(self)
@property
def app(self) -> AppBase:
@@ -192,10 +196,17 @@ DATA_DIR_NAME = "data"
class CommandDispatcher(AppFeatureProvider):
def __init__(self) -> None:
super().__init__("command-dispatcher")
+ self._parsed_args: argparse.Namespace | None = None
- def _setup_arg_parser(self) -> None:
+ def setup_arg_parser(self) -> None:
self._map: dict[str, AppCommandFeatureProvider] = {}
arg_parser = argparse.ArgumentParser(description="Service management")
+ arg_parser.add_argument(
+ "--project-dir",
+ help="The path of the project directory.",
+ required=True,
+ type=str,
+ )
subparsers = arg_parser.add_subparsers(dest="command")
for feature in self.app.features:
if isinstance(feature, AppCommandFeatureProvider):
@@ -206,7 +217,7 @@ class CommandDispatcher(AppFeatureProvider):
self._arg_parser = arg_parser
def setup(self):
- self._setup_arg_parser()
+ pass
@property
def arg_parser(self) -> argparse.ArgumentParser:
@@ -216,9 +227,41 @@ class CommandDispatcher(AppFeatureProvider):
def map(self) -> dict[str, AppCommandFeatureProvider]:
return self._map
- def run_command(self, _args: Sequence[str] | None = None) -> None:
- args = self.arg_parser.parse_args(_args)
- self.map[args.command].run_command(args)
+ def get_program_parsed_args(self) -> argparse.Namespace:
+ if self._parsed_args is None:
+ self._parsed_args = self.arg_parser.parse_args()
+ return self._parsed_args
+
+ def run_command(self, args: argparse.Namespace | None = None) -> None:
+ real_args = args or self.get_program_parsed_args()
+ self.map[real_args.command].run_command(real_args)
+
+
+class AppInitializer(AppCommandFeatureProvider):
+ def __init__(self) -> None:
+ super().__init__("app-initializer")
+
+ def _init_app(self) -> bool:
+ if self.app.app_initialized:
+ return False
+ self.app.data_dir.ensure()
+ return True
+
+ def setup(self):
+ pass
+
+ def get_command_info(self):
+ return ("init", "Initialize the app.")
+
+ def setup_arg_parser(self, arg_parser):
+ pass
+
+ def run_command(self, args):
+ init = self._init_app()
+ if init:
+ print("App initialized successfully.")
+ else:
+ print("App is already initialized. Do nothing.")
class AppBase:
@@ -230,13 +273,24 @@ class AppBase:
raise CruInternalError("App instance not initialized")
return AppBase._instance
- def __init__(self, name: str, root: str):
+ def __init__(self, name: str):
AppBase._instance = self
self._name = name
- self._root = AppRootPath(self, root)
+ self._root = AppRootPath(self)
self._paths: list[AppFeaturePath] = []
self._features: list[AppFeatureProvider] = []
+ def setup(self) -> None:
+ command_dispatcher = self.get_feature(CommandDispatcher)
+ command_dispatcher.setup_arg_parser()
+ program_args = command_dispatcher.get_program_parsed_args()
+ self.setup_root(program_args.project_dir)
+ self._data_dir = self.add_path(DATA_DIR_NAME, True, id="data")
+ for feature in self.features:
+ feature.setup()
+ for path in self.paths:
+ path.check_self()
+
@property
def name(self) -> str:
return self._name
@@ -245,6 +299,24 @@ class AppBase:
def root(self) -> AppRootPath:
return self._root
+ def setup_root(self, path: os.PathLike) -> None:
+ self._root.setup(path)
+
+ @property
+ def data_dir(self) -> AppFeaturePath:
+ return self._data_dir
+
+ @property
+ def app_initialized(self) -> bool:
+ return self.data_dir.check_self()
+
+ def ensure_app_initialized(self) -> AppRootPath:
+ if not self.app_initialized:
+ raise CruUserFriendlyException(
+ "Root directory does not exist. Please run 'init' to create one."
+ )
+ return self.root
+
@property
def features(self) -> list[AppFeatureProvider]:
return self._features
@@ -253,7 +325,10 @@ class AppBase:
def paths(self) -> list[AppFeaturePath]:
return self._paths
- def add_feature(self, feature: AppFeatureProvider) -> AppFeatureProvider:
+ def add_feature(self, feature: _Feature) -> _Feature:
+ for f in self.features:
+ if f.name == feature.name:
+ raise CruInternalError(f"Duplicate feature name: {feature.name}.")
self._features.append(feature)
return feature
@@ -276,9 +351,11 @@ class AppBase:
def get_feature(self, feature: str) -> AppFeatureProvider: ...
@overload
- def get_feature(self, feature: type[_F]) -> _F: ...
+ def get_feature(self, feature: type[_Feature]) -> _Feature: ...
- def get_feature(self, feature: str | type[_F]) -> AppFeatureProvider | _F:
+ def get_feature(
+ self, feature: str | type[_Feature]
+ ) -> AppFeatureProvider | _Feature:
if isinstance(feature, str):
for f in self._features:
if f.name == feature:
diff --git a/tools/cru-py/cru/service/_config.py b/tools/cru-py/cru/service/_config.py
index 1c3a571..3bfb6c9 100644
--- a/tools/cru-py/cru/service/_config.py
+++ b/tools/cru-py/cru/service/_config.py
@@ -1,5 +1,4 @@
from ._base import AppFeaturePath, AppFeatureProvider
-from ._data import DataManager
class ConfigManager(AppFeatureProvider):
@@ -7,7 +6,7 @@ class ConfigManager(AppFeatureProvider):
super().__init__("config-manager")
def setup(self) -> None:
- self._config_path = self.app.get_feature(DataManager).data_dir.add_subpath(
+ self._config_path = self.app.data_dir.add_subpath(
"config", False, description="Configuration file path."
)
diff --git a/tools/cru-py/cru/service/_data.py b/tools/cru-py/cru/service/_data.py
index 79a1f64..885c8e8 100644
--- a/tools/cru-py/cru/service/_data.py
+++ b/tools/cru-py/cru/service/_data.py
@@ -1,4 +1,4 @@
-from ._base import AppFeaturePath, AppFeatureProvider
+from ._base import AppFeatureProvider
class DataManager(AppFeatureProvider):
@@ -6,8 +6,4 @@ class DataManager(AppFeatureProvider):
super().__init__("data-manager")
def setup(self) -> None:
- self._dir = self.app.add_path("data", True)
-
- @property
- def data_dir(self) -> AppFeaturePath:
- return self._dir
+ pass
diff --git a/tools/cru-py/cru/template.py b/tools/cru-py/cru/template.py
index a02ea0e..a07ca23 100644
--- a/tools/cru-py/cru/template.py
+++ b/tools/cru-py/cru/template.py
@@ -1,6 +1,7 @@
from collections.abc import Mapping
import os
import os.path
+from pathlib import Path
from string import Template
from ._iter import CruIterator
@@ -99,13 +100,13 @@ class TemplateTree:
@staticmethod
def _scan_files(root_path: str) -> list[str]:
- files: list[str] = []
+ result: list[str] = []
for root, _dirs, files in os.walk(root_path):
for file in files:
- path = os.path.join(root, file)
- path = os.path.relpath(path, root_path)
- files.append(path)
- return files
+ path = Path(root, file)
+ path = path.relative_to(root_path)
+ result.append(str(path.as_posix()))
+ return result
def _load(self) -> None:
files = self._scan_files(self.source)
diff --git a/tools/manage.cmd b/tools/manage.cmd
new file mode 100644
index 0000000..fce913d
--- /dev/null
+++ b/tools/manage.cmd
@@ -0,0 +1,15 @@
+@echo off
+
+set PYTHON=py -3
+%PYTHON% --version >NUL 2>&1 || (
+ echo Error: failed to run Python with py -3 --version.
+ exit 1
+)
+
+set TOOLS_DIR=%~dp0
+set PROJECT_DIR=%TOOLS_DIR%..
+
+cd /d "%PROJECT_DIR%"
+
+set PYTHONPATH=%PROJECT_DIR%\tools\cru-py;%PYTHONPATH%
+%PYTHON% -m cru.service --project-dir "%PROJECT_DIR%" %*