.travis.yml

@@ -2,19 +2,15 @@
 language: php
 
 php:
-    - 5.5
-    - 5.6
-    - 7.1
+    - 7.0
+    - 7.4
 
 before_script:
     - composer install -no
 
 script:
     - php ./vendor/bin/phpunit -c phpunit.xml
 
-after_success:
-    - curl -s https://codecov.io/bash | bash
-
 notifications:
     email:
         on_success: never

CONTRIBUTING.md

@@ -44,19 +44,22 @@ Find a bug? Help us fix it.
 5.  Make sure coding convention is met as much as possible. For
     automated check, use [code sniffer](https://github.com/squizlabs/PHP_CodeSniffer)
     and [mess detector](https://github.com/phpmd/phpmd) rulesets
-    that come with [`zapcore`](https://github.com/bfitech/zapcore)
-    repository:
+    that come with this repository:
 
     ```txt
     $ export PATH=~/.composer/vendor/bin:$PATH
     $
     $ # coding convention compliance with phpcs
-    $ wget https://raw.githubusercontent.com/bfitech/zapcore/master/phpcs.xml
     $ composer global require squizlabs/php_codesniffer
-    $ phpcs
+    $ phpcs \
+    >     --standard=./phpcs.xml \
+    >     --extensions=php \
+    >     --runtime-set ignore_warnings_on_exit 1 \
+    >     --report-width=72 \
+    >     --no-cache \
+    >     src
     $
     $ # static analysis with phpmd
-    $ wget https://raw.githubusercontent.com/bfitech/zapcore/master/phpmd.xml
     $ composer global require phpmd/phpmd
     $ phpmd ./src text ./phpmd.xml
     ```

Doxyfile

@@ -5,7 +5,7 @@
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = "Zapmin SMTP"
-PROJECT_NUMBER         = "1.4"
+PROJECT_NUMBER         = "2.3"
 PROJECT_BRIEF          = "SMTP extension for zapmin."
 PROJECT_LOGO           =
 OUTPUT_DIRECTORY       = ./docs
@@ -28,6 +28,7 @@ INHERIT_DOCS           = YES
 SEPARATE_MEMBER_PAGES  = NO
 TAB_SIZE               = 4
 ALIASES                = codeCoverageIgnore="" \
+                         SuppressWarnings="" \
                          fixme="@todo"
 TCL_SUBST              =
 OPTIMIZE_OUTPUT_FOR_C  = NO
@@ -102,8 +103,7 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # Configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = src \
-                         vendor/bfitech
+INPUT                  = src dev README.md
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.php
 RECURSIVE              = YES
@@ -119,7 +119,7 @@ INPUT_FILTER           =
 FILTER_PATTERNS        =
 FILTER_SOURCE_FILES    = NO
 FILTER_SOURCE_PATTERNS =
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = README.md
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
 #---------------------------------------------------------------------------
@@ -200,7 +200,6 @@ EXTRA_SEARCH_MAPPINGS  =
 # Configuration options related to the dot tool
 #---------------------------------------------------------------------------
 CLASS_DIAGRAMS         = YES
-MSCGEN_PATH            =
 DIA_PATH               =
 HIDE_UNDOC_RELATIONS   = YES
 HAVE_DOT               = YES

Jenkinsfile

@@ -0,0 +1,34 @@
+pipeline {
+    agent any
+    environment {
+        PROJECT = 'bfin--zapmin-smtp'
+    }
+    stages {
+        stage('branch: master') {
+            when {
+                branch 'master'
+            }
+            steps {
+                sh 'docker-phpunit 7.0 7.4'
+            }
+            post {
+                success {
+                    sh 'jenkins-postproc'
+                }
+            }
+        }
+        stage('release') {
+            when {
+                tag '*'
+            }
+            steps {
+                sh 'docker-phpunit 7.0 7.4'
+            }
+            post {
+                success {
+                    sh 'jenkins-postproc'
+                }
+            }
+        }
+    }
+}

composer.json

@@ -10,15 +10,18 @@
     }
   ],
   "require": {
-    "bfitech/zapmin": "~1.4.1",
-    "phpmailer/phpmailer": "~5.2.0"
+    "php": ">=7.0 <7.5",
+    "bfitech/zapmin": "2.3.*",
+    "phpmailer/phpmailer": "6.1.*"
   },
   "require-dev": {
-    "phpunit/phpunit": "4.8.*"
+    "phpunit/phpunit": "6.*"
   },
   "suggest": {
     "bfitech/zapstore-mysql": "Use MySQL as database backend.",
-    "bfitech/zapstore-pgsql": "Use PostgreSQL as database backend."
+    "bfitech/zapstore-pgsql": "Use PostgreSQL as database backend.",
+    "bfitech/zapstore-redis": "Use Redis as additional backend.",
+    "bfitech/zapstore-predis": "Use Predis as additional backend."
   },
   "autoload": {
     "psr-4": {
@@ -27,12 +30,13 @@
   },
   "autoload-dev": {
     "psr-4": {
+      "BFITech\\ZapAdminDev\\": "dev",
       "BFITech\\ZapCoreDev\\": "vendor/bfitech/zapcore/dev"
     }
   },
   "extra": {
     "branch-alias": {
-      "dev-master": "1.4.x-dev"
+      "dev-master": "2.3.x-dev"
     }
   }
 }

dev/SMTPRouteDev.php

@@ -0,0 +1,150 @@
+<?php
+
+
+namespace BFITech\ZapAdminDev;
+
+
+use BFITech\ZapAdmin\SMTPRouteDefault;
+use BFITech\ZapAdmin\Error;
+use BFITech\ZapAdmin\SMTPError;
+use BFITech\ZapCore\Common;
+
+
+/**
+ * SMTP router for development.
+ */
+class SMTPRouteDev extends SMTPRouteDefault {
+
+	/**
+	 * Fake authentication.
+	 *
+	 * Username is anything as long as it ends with @$host. Password
+	 * is simply MD5 of the username. `ZAPMIN_SMTP_DEV` must be
+	 * defined.
+	 *
+	 * @see apidoc
+	 *
+	 * @if TRUE
+	 * @api {post} /smtp/fake-auth SMTPAuthFake
+	 * @apiDescription
+	 *     Authenticate a fake user. For development only.
+	 * @apiName SMTPAuthFake
+	 * @apiGroup SMTP
+	 * @apiParam (POST) {String} host SMTP host.
+	 * @apiParam (POST) {Int} port SMTP port.
+	 * @apiParam (POST) {String} username Username.
+	 * @apiParam (POST) {String} password Password.
+	 * @apiSuccess {Int=0} errno Success.
+	 * @apiSuccess {Object} data User data.
+	 * @apiSuccess {Int} data.uid User ID.
+	 * @apiSuccess {String} data.uname Zapmin user identifier.
+	 * @apiSuccess {String} data.token Session token.
+	 * @apiError (401) {Int=
+	 *     Error::USER_ALREADY_LOGGED_IN
+	 * } errno User already signed in.
+	 * @apiError (403) {Int=SMTPError::*} errno Specific error number.
+	 *     See code documentation.
+	 * @endif
+	 */
+	public function route_smtp_auth(array $args) {
+		$core = self::$core;
+		$manage = self::$manage;
+		$log = $manage::$logger;
+
+		if (!defined('ZAPMIN_SMTP_DEV'))
+			return $core::pj([1], 401);
+
+		if ($manage->is_logged_in()) {
+			# already signed in
+			$log->info(sprintf(
+				"SMTP: Auth already signed in: '%s'.",
+				$manage->get_user_data()['token']
+			));
+			return $core::pj([Error::USER_ALREADY_LOGGED_IN], 401);
+		}
+
+		$post = $args['post'];
+		$host = $port = $username = $password = null;
+		if (!Common::check_idict($post, [
+			'host', 'port', 'username', 'password'
+		]))
+			return $core::pj([SMTPError::AUTH_INCOMPLETE_DATA], 403);
+		extract($post);
+
+		$srv = array_filter(
+			$manage->list_services(),
+			function($ele) use($host, $port){
+				return $ele[0] == $host && $ele[1] == $port;
+			}
+		);
+		if (!$srv)
+			return $core::pj([SMTPError::SRV_NOT_FOUND]);
+
+		$shost = '@' . preg_replace('!^.+://(.+)$!', '$1', $host);
+		if (
+			substr_compare($username, $shost, -strlen($shost)) !== 0 ||
+			$password != md5($username)
+		)
+			return $core::pj([SMTPError::AUTH_FAILED]);
+
+		$username = rawurlencode($username);
+		$uservice = sprintf('smtp[%s:%s]', $host, $port);
+		$ret = $manage->self_add_passwordless([
+			'uname' => $username,
+			'uservice' => $uservice,
+		]);
+
+		$token_name = $this->token_name;
+		$token_value = $ret[1]['token'];
+
+		# alway autologin on success
+		$admin = $manage::$admin;
+		$expires = $admin::$store->time() + $admin->get_expiration();
+		$core::send_cookie_with_opts($token_name, $token_value, [
+			'path' => '/',
+			'expires' => $expires,
+			'httponly' => true,
+			'samesite' => 'Lax',
+		]);
+		$log->debug(sprintf(
+			"SMTP: Set cookie: [%s -> %s].",
+			$token_name, $token_value));
+
+		return $core::pj($ret);
+	}
+
+	/**
+	 * Fake status.
+	 *
+	 * This is identical to non-fake
+	 * BFITech\\ZapAdmin\\RouteDefault::route_status. Included for
+	 * completeness sake.
+	 *
+	 * @see apidoc
+	 *
+	 * @if TRUE
+	 * @api {get} /smtp/fake-status SMTPStatusFake
+	 * @apiDescription
+	 *     Get user status. For development only.
+	 * @apiName SMTPStatusFake
+	 * @apiGroup SMTP
+	 * @apiSuccess {Int=0} errno Success.
+	 * @apiSuccess {Object} data User data.
+	 * @apiSuccess {Int} data.uid User ID.
+	 * @apiSuccess {String} data.uname Zapmin user identifier.
+	 * @apiSuccess {String} data.email=null Email address.
+	 * @apiSuccess {Int} data.email_verified=0 Whether email
+	 *     address is verified.
+	 * @apiSuccess {String} data.fname=null Full name.
+	 * @apiSuccess {String} data.site=null User website.
+	 * @apiSuccess {Date} data.since Registration date.
+	 * @apiError (401) {Int=
+	 *     Error::USER_NOT_LOGGED_IN
+	 * } errno User not signed in.
+	 * @endif
+	 */
+	public function route_fake_status() {
+		return self::$core->pj(self::$ctrl->get_safe_user_data());
+	}
+
+}