diff --git a/include/class-Mailbox.php b/include/class-Mailbox.php index fea2c7d..4c6ae7d 100644 --- a/include/class-Mailbox.php +++ b/include/class-Mailbox.php @@ -1,237 +1,267 @@ . // load dependent traits class_exists( 'Domain' ); trait MailboxTrait { use DomainTrait; /** * Get the Mailbox ID * * @return int */ public function getMailboxID() { return $this->get( 'mailbox_ID' ); } /** * Get the mailbox username * * @return string */ public function getMailboxUsername() { return $this->get( 'mailbox_username' ); } /** * Get the mailbox address * * @return string E-mail */ public function getMailboxAddress() { - return sprintf( "%s@%s", + return Mailbox::address( $this->get( 'mailbox_username' ), $this->get( 'domain_name' ) ); } /** * Get the mailbox description (if any) * * @return string */ public function getMailboxDescription() { return $this->get( 'mailbox_description' ); } /** * Get the mailbox permalink * * @return string */ public function getMailboxPermalink( $absolute = false ) { return Mailbox::permalink( - $this->get( 'domain_name' ), + $this->get( 'domain_name' ), $this->get( 'mailbox_username' ) ); } + /** + * Get a printable Mailbox firm + * + * @return string + */ public function getMailboxFirm() { - return HTML::a( - $this->getMailboxPermalink(), - esc_html( $this->getMailboxAddress() ) + return Mailbox::firm( + $this->get( 'domain_name' ), + $this->get( 'mailbox_username' ) ); } /** * Update this mailbox password * * @param string $password * @return string */ public function updateMailboxPassword( $password = null ) { if( ! $password ) { $password = generate_password(); } $enc_password = Mailbox::encryptPassword( $password ); query( 'START TRANSACTION' ); // update ( new MailboxAPI() ) ->whereMailbox( $this ) ->update( [ new DBCol( 'mailbox_password', $enc_password, 's' ), ] ); // register this event in the registry APILog::insert( [ 'family' => 'mailbox', 'action' => 'newpassword', 'mailbox' => $this, ] ); query( 'COMMIT' ); return $password; } /** * Get the last size in bytes * * @return int */ public function getMailboxLastSizeBytes() { return $this->get( 'mailbox_lastsizebytes' ); } /** * Normalize a Mailbox after being fetched from database */ protected function normalizeMailbox() { $this->normalizeDomain(); $this->integers( 'mailbox_ID', 'mailbox_lastsizebytes' ); $this->booleans( 'mailbox_receive' ); } /** * Get the mailbox filesystem pathname in the MTA host * * TODO: actually all the mailbox are on the same host. * Then, we should support multiple hosts. * * @return string */ public function getMailboxPath() { // require a valid filename or throw $mailbox_user = $this->getMailboxUsername(); require_safe_dirname( $mailbox_user ); // mailboxes are stored under a $BASE/domain/username filesystem structure return $this->getDomainMailboxesPath() . __ . $mailbox_user; } } /** * A mailbox */ class Mailbox extends Queried { use MailboxTrait; /** * Database table */ const T = 'mailbox'; /** * Constructor */ public function __construct() { $this->normalizeMailbox(); } /** * Get the mailbox permalink * * @param $domain string * @param $mailbox string * @param $absolute boolean * @return string */ public static function permalink( $domain, $mailbox = null, $absolute = false ) { $part = site_page( 'mailbox.php', $absolute ) . _ . $domain; if( $mailbox ) { $part .= _ . $mailbox; } return $part; } /** * Encrypt a password * * @param string $password Clear text password * @return string One-way encrypted password */ public static function encryptPassword( $password ) { global $HOSTING_CONFIG; // the Mailbox password encryption mechanism can be customized if( isset( $HOSTING_CONFIG->MAILBOX_ENCRYPT_PWD ) ) { return call_user_func( $HOSTING_CONFIG->MAILBOX_ENCRYPT_PWD, $password ); } // or then just a default behaviour /** * The default behaviour is to adopt the crypt() encryption mechanism * with SHA512 and some random salt. It's strong enough nowadays. * * Read your MTA/MDA documentation, whatever you are using. * We don't know how your infrastructure works, so we don't know * how you want your password encrypted in the database and what kind * of password encryption mechanisms your MTA/MDA supports. * * In short if you are using Postfix this default configuration may work * because you may have Postfix configured as follow: * * Anyway you can use whatever MTA/MDA that talks with a MySQL database * and so you should adopt the most stronger encryption mechanism available. * * https://doc.dovecot.org/configuration_manual/authentication/password_schemes/ */ $salt = bin2hex( openssl_random_pseudo_bytes( 3 ) ); return '{SHA512-CRYPT}' . crypt( $password, "$6$$salt" ); } /** * Force to get a Mailbox ID, whatever is passed * * @param mixed $mailbox Mailbox object or Mailbox ID * @return int */ public static function getID( $mailbox ) { return is_object( $mailbox ) ? $mailbox->getMailboxID() : (int)$mailbox; } + + /** + * Get the Mailbox address + * + * @param string $domain_name Domain name + * @param string $mailbox_username Mailbox username without domain name + * @return string + */ + public static function address( $domain_name, $mailbox_username ) { + return $domain_name . '@' . $mailbox_username; + } + + /** + * Get a printable Mailbox firm + * + * @param string $domain_name Domain name + * @param string $mailbox_username Mailbox username without domain name + * @return string + */ + public static function firm( $domain_name, $mailbox_username ) { + return HTML::a( + self::permalink( $domain_name, $mailbox_username ), + esc_html( self::address( $domain_name, $mailbox_username ) ) + ); + } }