Hi!
I've removed some unused params. But if they where needed for e.g. interface type I've simply `_` them. Also I have to instances to fix tests params, whereby they were passed but not initialized at all, they are in`internal/target/remote/remote_test.go` and `internal/modify/dkim/dkim_test.go`. All test are still passing so it seems like I didn't break anything.
I might've refactored some code away that actually is used but wasn't implemented correctly, but as far as I see their is nothing wrong or erroring going on.
The intention is to keep to repo root clean while the list of packages
is slowly growing.
Additionally, a bunch of small (~30 LoC) files in the repo root is
merged into a single maddy.go file, for the same reason.
Most of the internal code is moved into the internal/ directory. Go
toolchain will make it impossible to import these packages from external
applications.
Some packages are renamed and moved into the pkg/ directory in the root.
According to https://github.com/golang-standards/project-layout this is
the de-facto standard to place "library code that's ok to use by
external applications" in.
To clearly define the purpose of top-level directories, README.md files
are added to each.
Now they are represented by implementations of the log.Output interface
instead of just callbacks. This allows to add additional methods to it.
Mainly, it was done for purpose of Close method for flushing and closing
log files. This is important to make runtime logger reinitialization
(e.g. log rotation) possible.
Additionally, documentation now explains goroutine-safety of logger
objects.
In most cases, the stderr will be recorded by system log daemon and
this will result in duplicate timestamps.
'log stderr_ts' option is added for cases where timestamps are needed.
Root package now contains only initialization code and 'dummy' module.
Each module now got its own package. Module packages are grouped by
their main purpose (storage/, target/, auth/, etc). Shared code is
placed in these "group" packages.
Parser for module references in config is moved into config/module.
Code shared by tests (mock modules, etc) is placed in testutils.
In general, the checks interface with added scoring and quarantining
support was not convenient to use enough. Also it was problematic
to add support for Authentication-Results header field generation.
Per-sender and per-recipient checks were not applied to body.
This is fixed now.
Checks inspecting the message header was able to see header
modifications done by other checks. This could lead to unwanted
side-effects and so now checks can't modify the header directly
and instead can only prepend fields to it by returning them.
Additionally, it allows checks to return values for
Authentication-Results field. Each server handling the message should
add only one field, so it is not possible to implement it using header
prepending.
MsgMetadata.CheckScore is removed, now it is managed internally by
dispatcher code and not exposed where it is not needed.
MsgMetadata.Quarantine is no longer set directly by checks code. Future
refactoring may be remove it altogether as it is discouraged to have
mutable flags in MsgMetadata.
On top of that, tests are added for all new code.
Consider anything with more than 1 argument to be inline definitions.
Combined with previous change it allows writing stuff like
'deliver_to proxy smtp://blah:25'. This looks natural despite
actually using kinda strange (for non-programmers) abstractions
of maddy module framework.
This allows more readable configuration files without additional
explanations in cases where a single module is used for multiple
purposes.
Also cleans up certain problems with modules that rely on block
names having certain semantics (e.g. endpoint modules).
It was quickly hacked in, built on the pile of broken abstractions
and was source of several bugs.
This commit is almost full rewrite of most functions in config.go.
* Drop most of the implicit defaults in favor of explicit configuration
We no longer follow caddy's "zero-configuration" approach. Mail is much
more complex than HTTP and we want to be explicit about things, always.
* Remove commented out directives from maddy.conf
