/*

 * This file is part of mailpot

 *

 * Copyright 2020 - Manos Pitsidianakis

 *

 * This program is free software: you can redistribute it and/or modify

 * it under the terms of the GNU Affero General Public License as

 * published by the Free Software Foundation, either version 3 of the

 * License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

 * GNU Affero General Public License for more details.

 *

 * You should have received a copy of the GNU Affero General Public License

 * along with this program. If not, see <https://www.gnu.org/licenses/>.

 */

//! Generate configuration for the postfix mail server.

//!

//! ## Transport maps (`transport_maps`)

//!

//! <http://www.postfix.org/postconf.5.html#transport_maps>

//!

//! ## Local recipient maps (`local_recipient_maps`)

//!

//! <http://www.postfix.org/postconf.5.html#local_recipient_maps>

//!

//! ## Relay domains (`relay_domains`)

//!

//! <http://www.postfix.org/postconf.5.html#relay_domains>

use std::{

    borrow::Cow,

    convert::TryInto,

    fs::OpenOptions,

    io::{BufWriter, Read, Seek, Write},

    path::{Path, PathBuf},

};

use crate::{errors::*, Configuration, Connection, DbVal, MailingList, PostPolicy};

/*

transport_maps =

    hash:/path-to-mailman/var/data/postfix_lmtp

local_recipient_maps =

    hash:/path-to-mailman/var/data/postfix_lmtp

relay_domains =

    hash:/path-to-mailman/var/data/postfix_domains

*/

/// Settings for generating postfix configuration.

///

/// See the struct methods for details.

pub struct PostfixConfiguration {

    /// The UNIX username under which the mailpot process who processed incoming

    /// mail is launched.

    /// The UNIX group under which the mailpot process who processed incoming

    /// mail is launched.

    /// The absolute path of the `mailpot` binary.

    /// The maximum number of `mailpot` processes to launch. Default is `1`.

    #[serde(default)]

    /// The directory in which the map files are saved.

    /// Default is `data_path` from [`Configuration`].

    #[serde(default)]

    /// The name of the Postfix service name to use.

    /// Default is `mailpot`.

    ///

    /// A Postfix service is a daemon managed by the postfix process.

    /// Each entry in the `master.cf` configuration file defines a single

    /// service.

    ///

    /// The `master.cf` file is documented in [`master(5)`](https://www.postfix.org/master.5.html):

    /// <https://www.postfix.org/master.5.html>.

    #[serde(default)]

}

impl Default for PostfixConfiguration {

        }

}

impl PostfixConfiguration {

    /// Generate service line entry for Postfix's [`master.cf`](https://www.postfix.org/master.5.html) file.

            "{transport_name} unix - n n - {process_limit} pipe

flags=RX user={username}{group_sep}{groupname} directory={{{data_dir}}} argv={{{binary_path}}} -c \

             {{{config_path}}} post",

        )

    /// Generate `transport_maps` and `local_recipient_maps` for Postfix.

    ///

    /// The output must be saved in a plain text file.

    /// To make Postfix be able to read them, the `postmap` application must be

    /// executed with the path to the map file as its sole argument.

    /// `postmap` is usually distributed along with the other Postfix binaries.

        &self,

        lists: &[(DbVal<MailingList>, Option<DbVal<PostPolicy>>)],

    ) -> String {

            "# Upon its creation and every time it is modified, postmap(1) must be called for the \

             changes to take effect:\n",

        );

        // [ref:TODO]: add custom addresses if PostPolicy is custom

            }

        else {

        };

            macro_rules! push_addr {

                ($addr:expr) => {{

                    let addr = &$addr;

                    ret.push_str(addr);

                    for _ in 0..(width - addr.len() + 5) {

                        ret.push(' ');

                    }

                    ret.push_str(transport_name);

                    ret.push_str(":\n");

                }};

            }

                    "Not generating postfix map entry for list {} because it has no post_policy \

                     set.",

                    list.id

                ),

                }

                Some(PostPolicy { .. }) => {

                }

            }

        }

        // pop second of the last two newlines

    /// Save service to Postfix's [`master.cf`](https://www.postfix.org/master.5.html) file.

    ///

    /// If you wish to do it manually, get the text output from

    /// [`PostfixConfiguration::generate_master_cf_entry`] and manually append it to the [`master.cf`](https://www.postfix.org/master.5.html) file.

    ///

    /// If `master_cf_path` is `None`, the location of the file is assumed to be

    /// `/etc/postfix/master.cf`.

        &self,

        config: &Configuration,

        config_path: &Path,

        master_cf_path: Option<&Path>,

    ) -> Result<()> {

        // Create backup file.

            "Could not create master.cf backup {}",

            "Created backup of {} to {}.",

            path.display(),

            path_bkp.display()

        );

            .read(true)

            .write(true)

            .create(false)

            .open(path)

                .find(end_needle)

                        .find('\n')

        } else {

        }

                    .len()

                    .try_into()

                    .expect("Could not convert usize file size to u64"),

        }

    /// Generate `transport_maps` and `local_recipient_maps` for Postfix.

    ///

    /// To succeed the user the command is running under must have write and

    /// read access to `postfix_data_directory` and the `postmap` binary

    /// must be discoverable in your `PATH` environment variable.

    ///

    /// `postmap` is usually distributed along with the other Postfix binaries.

                "Could not find postmap binary in PATH.",

            ))));

            .into_iter()

            .map_output_path

            .as_deref()

            .join("mailpot_postfix_map");

                .read(true)

                .write(true)

                .create(true)

                .truncate(true)

                .open(&path)

        );

            .arg("-c")

            .output()

                    "Could not execute `postmap` binary in path {}",

                )

            use std::os::unix::process::ExitStatusExt;

                        "{} exited with {}.\nstderr was:\n---{}---\nstdout was\n---{}---\n",

                        code,

                    ),

                ))));

                        "{} was killed with signal {}.\nstderr was:\n---{}---\nstdout \

                         was\n---{}---\n",

                        signum,

                    ),

                ))));

            } else {

                        "{} failed for unknown reason.\nstderr was:\n---{}---\nstdout \

                         was\n---{}---\n",

                    ),

                ))));

            }

        }

}

            } else {

            }

#[test]

    use tempfile::TempDir;

    use crate::*;

        use melib::smtp::*;

            port: 1025,

        }

        db_path,

    };

    {

            .write(true)

            .create(true)

    // Create three lists:

    //

    // - One without any policy, which should not show up in postfix maps.

    // - One with subscriptions disabled, which would only add the list address in

    //   postfix maps.

    // - One with subscriptions enabled, which should add all addresses (list,

    //   list+{un,}subscribe, etc).

        pk: 0,

        pk: 0,

        pk: 0,

        announce_only: false,

        subscription_only: false,

        approval_needed: false,

        open: true,

        custom: false,

        pk: 0,

        pk: 0,

        announce_only: false,

        subscription_only: false,

        approval_needed: true,

        open: false,

        custom: false,

        "mailpot unix - n n - 1 pipe

flags=RX user={} directory={{{}}} argv={{/usr/bin/mailpot}} -c {{{}}} post\n",

    );

    );

        .into_iter()

third@example.com              mailpot:

third+request@example.com      mailpot:

third+owner@example.com        mailpot:

";

        "maps has unexpected contents: has\n{:?}\nand should have ended with\n{:?}",

        maps,

        expected

    );

# Postfix master process configuration file.  For details on the format

# of the file, see the master(5) manual page (command: "man 5 master" or

# on-line: http://www.postfix.org/master.5.html).

#

# Do not forget to execute "postfix reload" after editing this file.

#

# ==========================================================================

# service type  private unpriv  chroot  wakeup  maxproc command + args

#               (yes)   (yes)   (no)    (never) (100)

# ==========================================================================

smtp      inet  n       -       y       -       -       smtpd

pickup    unix  n       -       y       60      1       pickup

cleanup   unix  n       -       y       -       0       cleanup

qmgr      unix  n       -       n       300     1       qmgr

#qmgr     unix  n       -       n       300     1       oqmgr

tlsmgr    unix  -       -       y       1000?   1       tlsmgr

rewrite   unix  -       -       y       -       -       trivial-rewrite

bounce    unix  -       -       y       -       0       bounce

defer     unix  -       -       y       -       0       bounce

trace     unix  -       -       y       -       0       bounce

verify    unix  -       -       y       -       1       verify

flush     unix  n       -       y       1000?   0       flush

proxymap  unix  -       -       n       -       -       proxymap

proxywrite unix -       -       n       -       1       proxymap

smtp      unix  -       -       y       -       -       smtp

relay     unix  -       -       y       -       -       smtp

        -o syslog_name=postfix/$service_name

showq     unix  n       -       y       -       -       showq

error     unix  -       -       y       -       -       error

retry     unix  -       -       y       -       -       error

discard   unix  -       -       y       -       -       discard

local     unix  -       n       n       -       -       local

virtual   unix  -       n       n       -       -       virtual

lmtp      unix  -       -       y       -       -       lmtp

anvil     unix  -       -       y       -       1       anvil

scache    unix  -       -       y       -       1       scache

postlog   unix-dgram n  -       n       -       1       postlogd

maildrop  unix  -       n       n       -       -       pipe

  flags=DRXhu user=vmail argv=/usr/bin/maildrop -d ${recipient}

uucp      unix  -       n       n       -       -       pipe

  flags=Fqhu user=uucp argv=uux -r -n -z -a$sender - $nexthop!rmail ($recipient)

#

# Other external delivery methods.

#

ifmail    unix  -       n       n       -       -       pipe

  flags=F user=ftn argv=/usr/lib/ifmail/ifmail -r $nexthop ($recipient)

bsmtp     unix  -       n       n       -       -       pipe

  flags=Fq. user=bsmtp argv=/usr/lib/bsmtp/bsmtp -t$nexthop -f$sender $recipient

scalemail-backend unix -       n       n       -       2       pipe

  flags=R user=scalemail argv=/usr/lib/scalemail/bin/scalemail-store ${nexthop} ${user} ${extension}

mailman   unix  -       n       n       -       -       pipe

  flags=FRX user=list argv=/usr/lib/mailman/bin/postfix-to-mailman.py ${nexthop} ${user}

"#;

    {

    {

            .write(false)

            .read(true)

            .create(false)

        "edited master.cf has unexpected contents: has\n{:?}\nand should have ended with\n{:?}",

        first,

        expected_mastercf_entry

    );

    // test that a smaller entry can be successfully replaced

    {

            .write(false)

            .read(true)

            .create(false)

        "mailpot unix - n n - 1 pipe

flags=RX user=nobody directory={{{}}} argv={{/usr/bin/mailpot}} -c {{{}}} post\n",

    );

        "doubly edited master.cf has unexpected contents: has\n{:?}\nand should have ended \

         with\n{:?}",

        second,

        expected_mastercf_entry

    );

    // test that a larger entry can be successfully replaced

    {

            .write(false)

            .read(true)

            .create(false)

        "mailpot unix - n n - 1 pipe

flags=RX user=hackerman directory={{{}}} argv={{/usr/bin/mailpot}} -c {{{}}} post\n",

    );

        "triply edited master.cf has unexpected contents: has\n{:?}\nand should have ended \

         with\n{:?}",

        third,

        expected_mastercf_entry

    );

    // test that if groupname is given it is rendered correctly.

    {

            .write(false)

            .read(true)

            .create(false)

        "mailpot unix - n n - 1 pipe

flags=RX user=hackerman:nobody directory={{{}}} argv={{/usr/bin/mailpot}} -c {{{}}} post\n",

    );

        "fourthly edited master.cf has unexpected contents: has\n{:?}\nand should have ended \

         with\n{:?}",

        fourth,

        expected_mastercf_entry

    );