nodered.php

<?php
/**
 * Extend the HestiaCP Pluginable object with our Node-RED object for
 * allocating NodeRED instances.
 * 
 * @author Virtuosoft/Stephen J. Carnam
 * @license AGPL-3.0, for other licensing options contact support@virtuosoft.com
 * @link https://github.com/virtuosoft-dev/hcpp-nodered
 * 
 */

if ( ! class_exists( 'NodeRED' ) ) {
    class NodeRED extends HCPP_Hooks {
        public $supported = ['18','19','20','21','22'];

        /**
         * Customize Node-RED install screen.
         */ 
        public function hcpp_add_webapp_xpath( $xpath ) {
            if ( ! (isset( $_GET['app'] ) && $_GET['app'] == 'NodeRED' ) ) return $xpath;
            global $hcpp;

            // Check for bash shell user
            $user = $_SESSION["user"];
            if ($_SESSION["look"] != "") {
                $user = $_SESSION["look"];
            }
            $domain = $_GET['domain'];
            $domain = preg_replace('/[^a-zA-Z0-9\.\-]/', '', $domain);
            $shell = $hcpp->run( "v-list-user $user json")[$user]['SHELL'];
            if ( $shell != 'bash' ) {
                $style = '<style>div.u-mb10{display:none;}</style>';
                $html = '<span class="u-mb10">Cannot continue. User "' . $user . '" must have bash login ability.</span>';
            }else{
                $style = '<style>#webapp_php_version, label[for="webapp_php_version"]{display:none;}</style>';
                $html =  '<div class="u-mb10">
                              The Node-RED instance lives inside the "nodeapp" folder (next to "public_html"). It can be a
                              standalone instance in the domain root, or in a subfolder using the <b>Install Directory</b> 
                              field above.
                          </div>';
            }
            $xpath = $hcpp->insert_html( $xpath, '//div[contains(@class, "form-container")]', $html );
            $xpath = $hcpp->insert_html( $xpath, '/html/head', $style );

            // Remove existing public_html related alert if present
            $alert_div = $xpath->query('//div[@role="alert"][1]');
            if ( $alert_div->length > 0 ) {
                $alert_div = $alert_div[0];
                $alert_div->parentNode->removeChild( $alert_div );
            }

            // Insert our own alert about non-empty nodeapp folder
            $folder = "/home/$user/web/$domain/nodeapp";
            if ( file_exists( $folder ) && iterator_count(new \FilesystemIterator( $folder, \FilesystemIterator::SKIP_DOTS)) > 0 ) {
                $html = '<div class="alert alert-info u-mb10" role="alert">
                        <i class="fas fa-info"></i>
                        <div>
                            <p class="u-mb10">Data Loss Warning!</p>
                            <p class="u-mb10">Your nodeapp folder already has files uploaded to it. The installer will overwrite your files and/or the installation might fail.</p>
                            <p>Please make sure ~/web/' . $domain . '/nodeapp is empty or an empty subdirectory is specified!</p>
                        </div>
                    </div>';
                $xpath = $hcpp->insert_html( $xpath, '//div[contains(@class, "form-container")]', $html, true );
            }
            return $xpath;
        }

        /**
         * Install, uninstall, or setup Node-RED with the given options
         * This can be invoked from the command line v-invoke-plugin and
         * is used by the webapp installer.
         */
        public function hcpp_invoke_plugin( $args ) {
            if ( count( $args ) < 0 ) return $args;
            global $hcpp;
            
            // Install Node-RED on supported NodeJS versions
            if ( $args[0] == 'nodered_install' ) {

                // Get list of installed and supported NodeJS versions
                $versions = $hcpp->nodeapp->get_versions();
                $majors = [];

                foreach( $versions as $ver ) {
                    $major = $hcpp->getLeftMost( $ver['installed'], '.' );

                    // Check for supported version
                    if ( in_array( $major, $this->supported ) ) {
                        $cmd = 'nvm use ' . $major . ' && echo "~" && npm show node-red version --no-color && ';
                        $cmd .= 'npm list -g node-red --depth=0 --no-color';
                        $parse  = $hcpp->runuser('', $cmd );
                        $latest_pkg = trim( $hcpp->delLeftMost( $parse, '~' ) );
                        $latest_pkg = $hcpp->getLeftMost( $latest_pkg, "\n" );
                        $current_pkg = trim( $hcpp->delLeftMost( $parse . '@', '@' ) );
                        $current_pkg = $hcpp->getLeftMost( $current_pkg, "\n" );
                        $hcpp->log( "Node-RED on v$major: $current_pkg -> $latest_pkg" );

                        // Check if node-red is missing or outdated
                        if ( $current_pkg !== $latest_pkg ) {
                            $majors[] = $major;
                        }
                    }
                }

                // Install Node-RED on supported NodeJS versions
                if ( count( $majors ) > 0 ) {
                    $hcpp->nodeapp->do_maintenance( function( $stopped ) use( $hcpp, $majors ) {
                        foreach( $majors as $major ) {
                            $cmd = "nvm use $major && ";
                            $cmd .= '(npm list -g node-red || npm install -g --unsafe-perm node-red --no-interactive) ';
                            $cmd .= '&& npm update -g node-red --no-interactive < /dev/null';
                            $hcpp->runuser( '', $cmd );
                        }
                    }, $majors);
                }
            }
            
            // Uninstall Node-RED on supported NodeJS versions
            if ( $args[0] == 'nodered_uninstall' ) {

                // Get list of installed and supported NodeJS versions
                $versions = $hcpp->nodeapp->get_versions();
                $majors = [];
                foreach( $versions as $ver ) {
                    $major = $hcpp->getLeftMost( $ver['installed'], '.' );
                    if ( in_array( $major, $this->supported ) ) {
                        $majors[] = $major;
                    }
                }

                // Uninstall Node-RED on supported NodeJS versions
                $hcpp->nodeapp->do_maintenance( function( $stopped ) use( $hcpp, $majors ) {
                    foreach( $majors as $major ) {
                        $cmd = "nvm use $major && npm uninstall -g node-red --no-interactive";
                        $hcpp->runuser( '', $cmd );
                    }
                }, $this->supported);
            }

            // Setup Node-RED with the supported NodeJS on the given domain 
            if ( $args[0] == 'nodered_setup' ) {
                $options = json_decode( $args[1], true );
                $hcpp->log( $options );
                $user = $options['user'];
                $domain = $options['domain'];
                $nodejs_version = trim( $hcpp->getLeftMost( $options['nodeJS_version'], ':' ), "v \t\n\r\0\x0B" );
                $nodered_folder = $options['nodered_folder'];
                if ( $nodered_folder == '' || $nodered_folder[0] != '/' ) $nodered_folder = '/' . $nodered_folder;
                $nodeapp_folder = "/home/$user/web/$domain/nodeapp";
                
                // Create parent nodeapp folder first this way to avoid CLI permissions issues
                mkdir( $nodeapp_folder, 0755, true );
                chown( $nodeapp_folder, $user );
                chgrp( $nodeapp_folder, $user );
                $nodered_folder = $nodeapp_folder . $nodered_folder;
                $nodered_root = $hcpp->delLeftMost( $nodered_folder, $nodeapp_folder ); 
                $hcpp->runuser( $user, "mkdir -p $nodered_folder" );

                // Copy over nodeapp files
                $hcpp->copy_folder( __DIR__ . '/nodeapp', $nodered_folder, $user );
                chmod( $nodeapp_folder, 0755 );

                // Update the .nvmrc file
                file_put_contents( $nodered_folder . '/.nvmrc', "v$nodejs_version" );

                // Create Node-RED compatible bcrypt hash for password
                $password = $options['nodeRED_password'];
                $hash = password_hash( $password, PASSWORD_BCRYPT, ["code" => 8] );
                $prefix = $hcpp->getLeftMost( $hash, '$2y$' ) . '$2y$';
                $prefix = str_replace( '$2y$', '$2a$', $prefix );
                $hash = $prefix . $hcpp->delLeftMost( $hash, '$2y$' );

                // Generate a random secret key
                $secret_key = $hcpp->random_chars( 32 );            
           
                // Update settings.js with our user options
                $settings = file_get_contents( $nodered_folder . '/settings.js' );
                $settings = str_replace( '%nodeRED_username%', $options['nodeRED_username'], $settings );
                $settings = str_replace( '%nodeRED_password%', $hash, $settings );
                $settings = str_replace( '%secret_key%', $secret_key, $settings );
                $settings = str_replace( '%nodered_root%', $nodered_root, $settings );
                if ( isset( $options['projects'] ) ) {
                    $settings = str_replace( '%projects%', $options['projects'], $settings );
                }else{
                    $settings = str_replace( '%projects%', 'false', $settings );
                }
                file_put_contents( $nodered_folder . '/settings.js', $settings );

                // Cleanup, allocate ports, prepare nginx and start services
                $hcpp->nodeapp->shutdown_apps( $nodeapp_folder );
                $hcpp->nodeapp->allocate_ports( $nodeapp_folder );

                // Update proxy and restart nginx
                if ( $nodeapp_folder . '/' == $nodered_folder ) {
                    $ext = $hcpp->run( "v-list-web-domain '$user' '$domain' json" )[$domain]['PROXY_EXT'];
                    $ext = str_replace( ' ', ',', $ext );
                    $hcpp->run( "v-change-web-domain-proxy-tpl '$user' '$domain' 'NodeApp' '$ext' 'no'" );
                }else{
                    $hcpp->nodeapp->generate_nginx_files( $nodeapp_folder );
                    $hcpp->nodeapp->startup_apps( $nodeapp_folder );
                }
                $hcpp->run( "v-restart-proxy" );
            }
            return $args;
        }

        /**
         * Check daily for Node-RED updates and install them.
         */
        public function nodeapp_autoupdate() {
            global $hcpp;
            $hcpp->run( 'v-invoke-plugin nodered_install' );
        }

    }
    global $hcpp;
    $hcpp->register_plugin( NodeRED::class );
}