refactor

Author: Steveorevo

README.md

@@ -1,30 +1,37 @@
-# hestiacp-maildev
-A plugin for Hestia Control Panel (via hesitacp-pluginable) that furnishes multi-tenant MailDev interface for simulated email services development, emulation for sendmail, and SMTP services for each hosted domain.
+# hestiacp-mailcatch
+A plugin for Hestia Control Panel (via hesitacp-pluginable) that furnishes multitenancy services for simulated SMTP, sendmail, and a unique web GUI for previewing all outgoing emails for each user/web domain. 
 
  
 > :warning: !!! Note: this repo is in progress; when completed, a release will appear in the release tab.
 
+## Attribution
+Based on the slick interface and work from [MailDev](https://github.com/maildev/maildev) and a simulated sendmail compatible command line utility, [catchmail-node](https://github.com/xavierpriour/catchmail-node), these projects have been included and modified with new multitenant capabilities and enhanced compatibility to work "out-of-the-box" under the HestiaCP based control panel. 
+
+## Usage
+Use MailCatch to test applications that send mail via the local built-in SMTP server and/or sendmail (like PHP's mail() function); this plugin will rename the existing `/usr/sbin/sendmail` to `/usr/sbin/sendmail.sav` and symlink to our sendmail replacement. Unique credentials for the SMTP services can be found in `/home/<username>/web/<domain>/private/smtp.json`. Default SMTP port is 2525 and the username must match the given `<domain>` name. The built-in GUI web client can be found at the URL path `http(s)://<domain>/mailcatch` and as an envelope icon in HestiaCP's web domain listing and edit pages.
+
+
 ## Installation
-HestiaCP-MailDev requires an Ubuntu based installation of [Hestia Control Panel](https://hestiacp.com) in addition to an installation of [HestiaCP-Pluginable](https://github.com/steveorevo/hestiacp-pluginable) ***and*** [HesitaCP-NodeApp](https://github.com/steveorevo/hestiacp-nodeapp) to function; please ensure that you have first installed both Pluginable and NodeApp on your Hestia Control Panel before proceeding. Switch to a root user and simply clone this project to the /usr/local/hestia/plugins folder. It should appear as a subfolder with the name `maildev`, i.e. `/usr/local/hestia/plugins/maildev`.
+HestiaCP-MailCatch requires an Ubuntu based installation of [Hestia Control Panel](https://hestiacp.com) in addition to an installation of [HestiaCP-Pluginable](https://github.com/steveorevo/hestiacp-pluginable) ***and*** [HesitaCP-NodeApp](https://github.com/steveorevo/hestiacp-nodeapp) to function; please ensure that you have first installed both Pluginable and NodeApp on your Hestia Control Panel before proceeding. Switch to a root user and simply clone this project to the /usr/local/hestia/plugins folder. It should appear as a subfolder with the name `mailcatch`, i.e. `/usr/local/hestia/plugins/mailcatch`.
 
 First, switch to root user:
 ```
 sudo -s
 ```
 
-Then simply clone the repo to your plugins folder, with the name `maildev`:
+Then simply clone the repo to your plugins folder, with the name `mailcatch`:
 
 ```
 cd /usr/local/hestia/plugins
-git clone https://github.com/steveorevo/hestiacp-maildev maildev
+git clone https://github.com/steveorevo/hestiacp-mailcatch mailcatch
 ```
 
-Note: It is important that the plugin folder name is `maildev`.
+Note: It is important that the plugin folder name is `mailcatch`.
 
-Be sure to logout and login again to your Hestia Control Panel as the admin user or, as admin, visit Server (gear icon) -> Configure -> Plugins -> Save; the plugin will immediately start installing MailDev server depedencies in the background. A notification will appear under the admin user account indicating *"MailDev plugin has finished installing"* when complete. This may take awhile before the options appear in Hestia. You can force manual installation via root level SSH:
+Be sure to logout and login again to your Hestia Control Panel as the admin user or, as admin, visit Server (gear icon) -> Configure -> Plugins -> Save; the plugin will immediately start installing MailCatch server depedencies in the background. A notification will appear under the admin user account indicating *"MailCatch plugin has finished installing"* when complete. This may take awhile before the options appear in Hestia. You can force manual installation via root level SSH:
 
 ```
 sudo -s
-cd /usr/local/hestia/plugins/maildev
+cd /usr/local/hestia/plugins/mailcatch
 ./install
 ```

install

@@ -1,19 +1,12 @@
 #!/bin/bash
 export DEBIAN_FRONTEND=noninteractive
 
-adduser maildev --gecos "First Last,RoomNumber,WorkPhone,HomePhone" --disabled-password
+adduser mailcatch --gecos "First Last,RoomNumber,WorkPhone,HomePhone" --disabled-password
 mkdir /opt
 cd /opt
-git clone https://github.com/xavierpriour/catchmail-node ./catchmail-node
-chown -R maildev:maildev /opt/catchmail-node
-git clone https://github.com/maildev/maildev ./maildev -b v2.0.5
-chown -R maildev:maildev /opt/maildev
-
-runuser -l maildev -c "cd /opt/maildev && source /opt/nvm/nvm.sh && nvm use v16 && npm install"
-runuser -l maildev -c "cd /opt/catchmail-node && source /opt/nvm/nvm.sh && nvm use v16 && npm install"
-
-cd /usr/local/hestia/plugins/maildev
-rsync -r ./nodeapp/ /opt/maildev/
-chown -R maildev:maildev /opt/maildev
-
-/usr/local/hestia/bin/v-add-user-notification admin "MailDev" "<span style=\"color:#4994CE;\"><i class=\"fas fa-envelope\"></i></span> MailDev has finished installing."
+git clone https://github.com/maildev/maildev ./mailcatch -b v2.0.5
+cd /usr/local/hestia/plugins/mailcatch
+rsync -r ./src/ /opt/mailcatch
+chown -R mailcatch:mailcatch /opt/mailcatch
+runuser -l mailcatch -c "cd /opt/mailcatch && source /opt/nvm/nvm.sh && nvm use v16 && npm install"
+/usr/local/hestia/bin/v-add-user-notification admin "MailCatch" "<span style=\"color:#4994CE;\"><i class=\"fas fa-envelope\"></i></span> MailCatch has finished installing."

maildev.php renamed to mailcatch.php

@@ -1,22 +1,22 @@
 <?php
 /**
- * Extend the HestiaCP Pluginable object with our MailDev object for
- * our system-wide MailDev service.
+ * Extend the HestiaCP Pluginable object with our MailCatch object for
+ * our system-wide MailCatch service.
  * 
  * @version 1.0.0
  * @license GPL-3.0
- * @link https://github.com/steveorevo/hestiacp-maildev
+ * @link https://github.com/steveorevo/hestiacp-mailcatch
  * 
  */
 
- if ( ! class_exists( 'MailDev') ) {
-    class MailDev {
+ if ( ! class_exists( 'MailCatch') ) {
+    class MailCatch {
         /**
          * Constructor, listen for the render events
          */
         public function __construct() {
             global $hcpp;
-            $hcpp->maildev = $this;
+            $hcpp->mailcatch = $this;
             $hcpp->add_action( 'render_page', [ $this, 'render_page' ] );
             $hcpp->add_action( 'priv_unsuspend_domain', [ $this, 'priv_unsuspend_domain' ] );
             $hcpp->add_action( 'hcpp_plugin_installed', [ $this, 'hcpp_plugin_installed' ] );
@@ -31,19 +31,19 @@ public function create_smtp_json( $user, $domain ) {
             $password = $hcpp->nodeapp->random_chars( 16 );
             $content = "{\n  \"username\": \"$domain\",\n  \"password\": \"$password\",\n  \"port\": 2525\n}";
             file_put_contents( $file, $content );
-            shell_exec( "chown $user:maildev $file && chmod 640 $file" );
+            shell_exec( "chown $user:mailcatch $file && chmod 640 $file" );
         }
 
-        // Setup the MailDev Server instance for the domain
+        // Setup the MailCatch Server instance for the domain
         public function setup( $user, $domain ) {
             global $hcpp;
-            $conf = "/home/$user/conf/web/$domain/nginx.conf_maildev";
-            $content = file_get_contents( __DIR__ . '/conf-web/nginx.conf_maildev' );
+            $conf = "/home/$user/conf/web/$domain/nginx.conf_mailcatch";
+            $content = file_get_contents( __DIR__ . '/conf-web/nginx.conf_mailcatch' );
             file_put_contents( $conf, $content );
 
-            // Create the nginx.conf_maildev file.
-            $conf = "/home/$user/conf/web/$domain/nginx.ssl.conf_maildev";
-            $content = file_get_contents( __DIR__ . '/conf-web/nginx.ssl.conf_maildev' );
+            // Create the nginx.conf_mailcatch file.
+            $conf = "/home/$user/conf/web/$domain/nginx.ssl.conf_mailcatch";
+            $content = file_get_contents( __DIR__ . '/conf-web/nginx.ssl.conf_mailcatch' );
             file_put_contents( $conf, $content );
 
             // Ensure system.ports is included
@@ -76,7 +76,7 @@ public function new_web_domain_ready( $args ) {
             return $args;
         }
 
-        // Add MailDev icon next to our web domain list and domain edit pages.
+        // Add MailCatch icon next to our web domain list and domain edit pages.
         public function render_page( $args ) {
             if ( $args['page'] == 'list_web' ) {
                 $args = $this->render_list_web( $args );
@@ -87,16 +87,16 @@ public function render_page( $args ) {
             return $args;
        }
 
-       // Add MailDev icon to our web domain edit page.
+       // Add MailCatch icon to our web domain edit page.
        public function render_edit_web( $args ) {
             global $hcpp;
             $domain = $_GET['domain'];
             $content = $args['content'];
 
             // Create white envelope icon button to appear before Quick Installer button
-            $code = '<a href="https://' . $domain . '/maildev" target="_blank" class="ui-button cancel" ';
+            $code = '<a href="https://' . $domain . '/mailcatch" target="_blank" class="ui-button cancel" ';
             $code .= 'dir="ltr"><i class="fas fa-envelope status-icon highlight">';
-            $code .= '</i> MailDev</a>';
+            $code .= '</i> MailCatch</a>';
 
             // Inject the button into the page's toolbar buttonstrip
             $quick = '"fas fa-magic status-icon blue';
@@ -109,15 +109,15 @@ public function render_edit_web( $args ) {
             return $args;
        }
 
-       // Add MailDev icon to our web domain list page.
+       // Add MailCatch icon to our web domain list page.
        public function render_list_web( $args ) {
             global $hcpp;
             $content = $args['content'];
 
             // Create white envelope icon before pencil/edit icon
             $div = '<div class="actions-panel__col actions-panel__edit shortcut-enter" key-action="href">';
             $code = '<div class="actions-panel__col actions-panel__code" key-action="href">
-            <a href="https://%domain%/maildev" rel="noopener" target="_blank" title="Open MailDev">
+            <a href="https://%domain%/mailcatch" rel="noopener" target="_blank" title="Open MailCatch">
                 <i class="fas fa-envelope status-icon highlight status-icon dim"></i>
             </a></div>&nbsp;';
             $new = '';
@@ -138,17 +138,17 @@ public function render_list_web( $args ) {
 
         // Allocate port on and start server on install
         public function hcpp_plugin_installed( $plugin_name ) {
-            if ( $plugin_name != 'maildev' ) return $plugin_name;
+            if ( $plugin_name != 'mailcatch' ) return $plugin_name;
             global $hcpp;
-            $port = $hcpp->allocate_port( 'maildev_port' );
+            $port = $hcpp->allocate_port( 'mailcatch_port' );
 
-            // Start the single system-wide MailDev Server instance
-            $cmd = "runuser -l maildev -c \"cd /opt/maildev && source /opt/nvm/nvm.sh ; pm2 start maildev.config.js\"";
+            // Start the single system-wide MailCatch Server instance
+            $cmd = "runuser -l mailcatch -c \"cd /opt/mailcatch && source /opt/nvm/nvm.sh ; pm2 start mailcatch.config.js\"";
             $hcpp->log( shell_exec( $cmd ) );
             return $plugin_name;
         }
 
-        // TODO: when domain is deleted, cleanup the domain in maildev; i.e. rm -rf /tmp/maildev/$domain_*
+        // TODO: when domain is deleted, cleanup the domain in mailcatch; i.e. rm -rf /tmp/mailcatch/$domain_*
     }
-    new MailDev();
+    new MailCatch();
 }

plugin.php

@@ -1,13 +1,13 @@
 <?php
 /**
- * Plugin Name: MailDev
- * Plugin URI: https://github.com/steveorevo/hestiacp-maildev
- * Description: MailDev furnishes a multi-tenant interface for simulated email services, sendmail emulation, and SMTP services for each hosted domain.
+ * Plugin Name: MailCatch
+ * Plugin URI: https://github.com/steveorevo/hestiacp-mailcatch
+ * Description: MailCatch furnishes a multi-tenant interface for simulated email services, sendmail emulation, and SMTP services for each hosted domain.
  */
 
 // Register the install and uninstall scripts
 global $hcpp;
-require_once( dirname(__FILE__) . '/maildev.php' );
+require_once( dirname(__FILE__) . '/mailcatch.php' );
 
 $hcpp->register_install_script( dirname(__FILE__) . '/install' );
 $hcpp->register_uninstall_script( dirname(__FILE__) . '/uninstall' );

nodeapp/.nvmrc renamed to src/.nvmrc

@@ -1,7 +1,6 @@
 #!/bin/bash
-runuser -l maildev -c "cd /opt/maildev && source /opt/nvm/nvm.sh && pm2 delete maildev ; pm2 save --force"
-rm -rf /opt/maildev
-rm -rf /opt/catchmail-node
-deluser maildev
-rm -rf /home/maildev
-php -r "include('/usr/local/hestia/web/pluginable.php');global \$hcpp;\$hcpp->delete_port('maildev_port');"
+runuser -l mailcatch -c "cd /opt/mailcatch && source /opt/nvm/nvm.sh && pm2 delete mailcatch ; pm2 save --force"
+rm -rf /opt/mailcatch
+deluser mailcatch
+rm -rf /home/mailcatch
+php -r "include('/usr/local/hestia/web/pluginable.php');global \$hcpp;\$hcpp->delete_port('mailcatch_port');"