docker-mailserver/target/bin
Brennan Kinney 57aeb6db2a
refactor: CLI commands for database management (#2654)
See the associated PR for more detailed commentary on specific changes.

### Commands refactored:
- User (**All:** add / list / update / del + _dovecot-master variants_)
- Quota (**All:** set / del)
- Virtual Alias (**All:** add / list /del)
- Relay (**All:** add-relayhost / add-sasl / exclude-domain)

### Overall changes involve:
- **Fairly common structure:**
  - `_main` method at the top provides an overview of logical steps:
    - After all methods are declared beneath it (_and imported from the new `helpers/database/db.sh`_), the `_main` is called at the bottom of the file.
    - `delmailuser` additionally processes option support for `-y` prior to calling `_main`.
  - `__usage` is now consistent with each of these commands, along with the `help` command.
  - Most logic delegated to new helper scripts. Some duplicate content remains on the basis that it's low-risk to maintenance and avoids less hassle to jump between files to check a single line, usually this is arg validation.
  - Error handling should be more consistent, along with var names (_no more `USER`/`EMAIL`/`FULL_EMAIL` to refer to the same expected value_).
- **Three new management scripts** (in `helpers/database/manage/`) using a common structure for managing changes to their respective "Database" config file.
  - `postfix-accounts.sh` unified not only add and update commands, but also all the dovecot-master versions, a single password call for all 4 of them, with a 5th consumer of the password prompt from the relay command `addsaslpassword`.
  - These scripts delegate actual writes to `helpers/database/db.sh` which provides a common API to support the changes made.
     - This is more verbose/complex vs the current inline operations each command currently has, as it provides generic support instead of slightly different variations being maintained, along with handling some edge cases that existed and would lead to bugs (notably substring matches).
     - Centralizing changes here seems wiser than scattered about. I've tried to make it easy to grok, hopefully it's not worse than the current situation.
     - List operations were kept in their respective commands, `db.sh` is only really managing writes. I didn't see a nice way for removing the code duplication for list commands as the duplication was fairly minimal, especially for `listalias` and `listdovecotmasteruser` which were quite simple in their differences in the loop body.
     - `listmailuser` and `delmailuser` also retain methods exclusive to respective commands, I wasn't sure if there was any benefit to move those, but they were refactored.
2022-07-29 12:10:23 +12:00
..
acme_extract.py acme_extract -> acme_extract.py + F_BIN to avoid .py 2022-03-06 22:17:29 -05:00
addalias refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
adddovecotmasteruser refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
addmailuser refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
addrelayhost refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
addsaslpassword refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
debug-fetchmail scripts: refactored daemon-stack.sh (#2496) 2022-03-27 09:43:39 +02:00
delalias refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
deldovecotmasteruser refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
delmailuser refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
delquota refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
excluderelaydomain refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
fail2ban Check if fail2ban is running (#2626) 2022-06-07 11:42:06 +00:00
listalias refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
listdovecotmasteruser refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
listmailuser refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
open-dkim refactor: Share a common helper (vhost builder) for sourcing domains (#2620) 2022-06-10 10:57:10 +12:00
postfix-summary scripts: refactored scripts located under target/bin/ (#2500) 2022-03-26 09:30:09 +01:00
print-environment scripts: new log (#2493) 2022-03-21 07:07:52 +01:00
quota-warning refactoring: split helper functions into smaller scripts (#2420) 2022-02-21 11:56:57 +01:00
report-pflogsumm-yesterday scripts: refactored scripts located under target/bin/ (#2500) 2022-03-26 09:30:09 +01:00
restrict-access scripts: refactored scripts located under target/bin/ (#2500) 2022-03-26 09:30:09 +01:00
sedfile Run sedfile tests in container (#2569) 2022-05-05 12:58:00 +02:00
setquota refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
setup Use color variables instead of escape codes (#2565) 2022-05-10 17:50:33 +02:00
updatedovecotmasteruser refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
updatemailuser refactor: CLI commands for database management (#2654) 2022-07-29 12:10:23 +12:00
virus-wiper refactoring: split helper functions into smaller scripts (#2420) 2022-02-21 11:56:57 +01:00