refactoring

app/neato.php

@@ -106,7 +106,7 @@ function Save_sha($shasum): void
 function Do_Harm_checker(): void
 {
     include 'neato_danger_checker.php';
-    if (is_file_dangerious($GLOBALS['cwd'] . '/deploy_files/deploy_' . $GLOBALS['file'].'.php') ) {
+    if (isFileDangerious($GLOBALS['cwd'] . '/deploy_files/deploy_' . $GLOBALS['file'].'.php') ) {
         if (! $GLOBALS['auto']) {
             $answer = readline("Do you wish to execute this Script, anyways!! ?  ");
             if (strtolower(trim($answer)) === "yes" ) {

app/neato_common.php

@@ -1,4 +1,15 @@
 <?php
+/**
+ * File Logger
+ * 
+ * PHP version 8.3
+ * 
+ * @category Util
+ * @package  Neato
+ * @author   Robert S. <tips@technowizardbob.com>
+ * @license  https://mit-license.org/ MIT License
+ * @link     https://git.mysnippetsofcode.com/tts/neatoDeploy
+ */
 
 set_time_limit(0);
 
@@ -11,7 +22,7 @@ require 'neato_logger.php';
 require 'neato_fns.php';
 require 'neato_enc.php';
 
-configure::set('logger_time_zone', 'America/Detroit');
+Configure::set('logger_time_zone', 'America/Detroit');
 
 Neato_Registry::set('loader', new \Neato_Auto_Loader);
 Neato_Registry::get('loader')->register();

app/neato_configure.php

@@ -1,21 +1,56 @@
 <?php
+/**
+ * Setup Config data
+ * 
+ * PHP version 8.3
+ * 
+ * @category Util
+ * @package  Neato
+ * @author   Robert S. <tips@technowizardbob.com>
+ * @license  https://mit-license.org/ MIT License
+ * @link     https://git.mysnippetsofcode.com/tts/neatoDeploy
+ */
+
+/**
+ * Configure your app
+ *
+ * @category Util
+ * @package  Neato
+ * @author   Robert S. <tips@technowizardbob.com>
+ * @license  https://mit-license.org/ MIT License
+ * @link     https://git.mysnippetsofcode.com/tts/neatoDeploy
+ */
+final class Configure
+{
     
-final class configure {
-  private static $config = array();
-  protected function __construct() { }
+    /**
+     * This private static var holds all configuration data.
+     * 
+     * @staticvar static array $config holds all system config data.
+     */  
+    private static array $_config = [];
+  
+    /**
+     * Deny creating instance as all methods are static here.
+     */
+    protected function __construct()
+    { 
+    }
 
-  /*
+    /**
      * Fetches a setting set from using Configure::set() or add or update
      *
-   * $name The name of the setting to get
-   * $key [optional] The Array Key to fetch
-   * The setting specified by $name, or null if $name was not set
+     * @param string       $name The name of the setting to get
+     * @param string|false $key  [optional] The Array Key to fetch
+     *                           The setting specified by $name,
+     *                           or null if $name was not set          
      * 
-   * return type: ?array
+     * @return mixed Fetch Config data
      */
-  public static function get(string $name, $key = false) {
-    if (isset(self::$config[strtolower($name)])) {
-      $a = self::$config[strtolower($name)];
+    public static function get(string $name, string|false $key = false): mixed
+    {
+        if (isset(static::$_config[strtolower($name)])) {
+            $a = static::$_config[strtolower($name)];
             if ($key === false) {
                 return $a;
             }
@@ -26,69 +61,89 @@ final class configure {
         return null;
     }
 
-  /*
+    /**
      * Checks if the setting exists
      *
-   * $name The name of the setting to check existance
-   * return boolean true if $name was set, false otherwise
+     * @param $name The name of the setting to check existance
+     * 
+     * @return boolean true if $name was set, false otherwise
      */
-  public static function exists(string $name): bool {
-    if (array_key_exists(strtolower($name), self::$config)) {
+    public static function exists(string $name): bool
+    {
+        if (array_key_exists(strtolower($name), static::$_config)) {
             return true;
         }
         return false;
     }
 
-  /*
+    /**
      * Overwrite/Update/Add to $config
-   * $name the main key to update
-   * $key the sub key
-   * type $value the data to update
+     * 
+     * @param string $name  the main key to update.
+     * @param string $key   the sub key.
+     * @param mixed  $value the data to update
+     * 
+     * @return void not ah
      */
-  public static function update(string $name, string $key, $value): void {
-    self::$config[strtolower($name)][strtolower($key)] = $value;
+    public static function update(string $name, string $key, mixed $value): void
+    {
+        static::$_config[strtolower($name)][strtolower($key)] = $value;
     }
 
-  /*
+    /**
      * Add to existing data without loss... to $config
-   * $name the main key
-   * $key the sub key
-   * $value new data to add
+     * 
+     * @param string $name  the main key
+     * @param string $key   the sub key
+     * @param mixed  $value new data to add
+     * 
+     * @return void not ah
      */
-  public static function add(string $name, string $key, $value): void {
-    self::$config[strtolower($name)][strtolower($key)][] = $value;
+    public static function add(string $name, string $key, mixed $value): void
+    {
+        static::$_config[strtolower($name)][strtolower($key)][] = $value;
     }
 
-  /*
+    /**
      * Frees the setting given by $name, if it exists. All settings no longer in
-   * use should be freed using this method whenever possible
+     * use should be freed using this method whenever possible.
      * 
-   * $name The name of the setting to free
+     * @param string $name The name of the setting to free
+     * 
+     * @return void not ah
      */
-  public static function free(string $name): void {
-    if (self::exists($name))
-      unset(self::$config[strtolower($name)]);
+    public static function free(string $name): void
+    {
+        if (static::exists($name)) {
+            unset(static::$_config[strtolower($name)]);
+        }
     }
 
-  /*
+    /**
      * Adds the given $value to the configuration using the $name given
      *
-   * $name The name to give this setting. Use Configure::exists()
-   * to check for pre-existing settings with the same name
-   * $value The value to set
+     * @param string $name  The name to give this setting. Use Configure::exists()
+     *                      to check for pre-existing settings with the same name.     
+     * @param mixed  $value The value to set
+     * 
+     * @return void not ah
      */
-  public static function set(string $name, $value): void {
-    self::$config[strtolower($name)] = $value;
+    public static function set(string $name, mixed $value): void
+    {
+        static::$_config[strtolower($name)] = $value;
     }
 
-  /*
+    /**
      * Sets $config data from an Array
-   * array $a ($name => $value)
-   * retutns a void
+     * 
+     * @param array $a ($name => $value)
+     * 
+     * @return void not ah
      */
-  public static function load_array(array $a): void {
+    public static function loadArray(array $a): void
+    {
         foreach ($a as $name => $value) {
-      self::$config[strtolower($name)] = $value;
+            static::$_config[strtolower($name)] = $value;
         }
         unset($a);
     }

app/neato_danger_checker.php

@@ -1,7 +1,25 @@
 <?php
+/**
+ * File Logger
+ * 
+ * PHP version 8.3
+ * 
+ * @category Util
+ * @package  Neato
+ * @author   Robert S. <tips@technowizardbob.com>
+ * @license  https://mit-license.org/ MIT License
+ * @link     https://git.mysnippetsofcode.com/tts/neatoDeploy
+ */
 
 if (! function_exists('readline') ) {
-    function readline($question)
+    /**
+     * If built in readline does not exists for my PHP, use this one.
+     * 
+     * @param string $question Prompt for this Question
+     * 
+     * @return string Grab users text entered in at prompt.
+     */
+    function readline(string $question): string
     {
         $fh = fopen('php://stdin', 'r');
         echo $question;
@@ -12,7 +30,15 @@ if (! function_exists('readline') ) {
     }
 }
 
-function is_file_dangerious($file_name) : bool {
+/**
+ * Check is PHP Script look dangerious or maybe harmful?
+ * 
+ * @param string $file_name the script to check
+ * 
+ * @return bool Safe?
+ */
+function isFileDangerious(string $file_name) : bool
+{
     $match_on = [ 'reflectionfunction', '`' ];
     $dangerious = [
         'exec',

app/neato_enc.php

@@ -1,8 +1,38 @@
 <?php
+/**
+ * Crypto - Encryption
+ * 
+ * PHP version 8.3
+ * 
+ * @category Util
+ * @package  Neato
+ * @author   Robert S. <tips@technowizardbob.com>
+ * @license  https://mit-license.org/ MIT License
+ * @link     https://git.mysnippetsofcode.com/tts/neatoDeploy
+ */
 
-class enc {
+/**
+ * Encode and Decode secrets
+ * 
+ * @category Util
+ * @package  Neato
+ * @author   Robert S. <tips@technowizardbob.com>
+ * @license  https://mit-license.org/ MIT License
+ * @link     https://git.mysnippetsofcode.com/tts/neatoDeploy
+ */
+class Enc
+{
 
-    public static function safe_encrypt(string $message, string $my_key = "") {
+    /**
+     * SafeEncrypt make communications private
+     * 
+     * @param string $message to encode
+     * @param string $my_key  encode with a secret key
+     * 
+     * @return string cipher text data
+     */
+    public static function safeEncrypt(string $message, string $my_key = "")
+    {
         $nonce = "";
         $cipher = "";
 
@@ -25,7 +55,18 @@ class enc {
         return $cipher;
     }
 
-    public static function safe_decrypt(string $encrypted, string $my_key = "") {
+    /**
+     * Decode secret message into plan text
+     * 
+     * @param string $encrypted your cypher text
+     * @param string $my_key    secret key used by enc...
+     * 
+     * @return string of plan text message
+     * 
+     * @throws \Exception
+     */
+    public static function safeDecrypt(string $encrypted, string $my_key = ""): string
+    {
         $decoded = "";
         $nonce = "";
         $ciphertext = "";
@@ -34,6 +75,8 @@ class enc {
         $my_key = hex2bin($my_key);
         
         /**
+         * Use decoded and check if valid.
+         * 
          * @param false|string $decoded did it base64_code?
          * base64_decode may return a false!!!
          * Ignore the error in phpstan!! It is all correct here:
@@ -62,9 +105,17 @@ class enc {
         return $plain;
     }
 
-    public static function make_key_file(string $file_name): string {
+    /**
+     * Create and Save a good key for secrets later on...
+     * 
+     * @param string $file_name save to this file
+     * 
+     * @return string
+     */
+    public static function makeKeyFile(string $file_name): string
+    {
         if (!file_exists($file_name)) {
-            $key = self::generate_key();
+            $key = self::generateKey();
             write_file($file_name, $key);
             chmod_file_or_dir($file_name, getPerms("secret"));
             change_owner($file_name, "root", "root");
@@ -74,22 +125,54 @@ class enc {
         return $key;
     }
 
-    public static function generate_key() {
+    /**
+     * Gereate a Good strong Key
+     * 
+     * @return string New Random Key for secure crypto
+     */
+    public static function generateKey(): string
+    {
         return bin2hex(random_bytes(SODIUM_CRYPTO_SECRETBOX_KEYBYTES));
     }
 
-    public static function decode_file(string $file_name, string $key) {
+    /**
+     * Lets recover the secret stuff from a file.
+     * 
+     * @param string $file_name Read crypto junk
+     * @param string $key       your secret Key
+     * 
+     * @return mixed decrypted data
+     */
+    public static function decodeFile(string $file_name, string $key)
+    {
         $ciphertext = file_get_contents($file_name);
-        $ret = json_decode(base64_decode(self::safe_decrypt(self::bin_to_hex_to_string($ciphertext), $key)), false);
+        $ret = json_decode(base64_decode(self::safeDecrypt(self::_binToHexToString($ciphertext), $key)), false);
         sodium_memzero($ciphertext);
         return $ret;
     }
 
-    public static function encode_file(string $file_name, $data, string $key) {
-        file_put_contents($file_name, self::string_to_hex_to_bin(self::safe_encrypt(base64_encode(json_encode((object) $data)), $key)));
+    /**
+     * EncodeFile writes to file and srambles the data
+     * 
+     * @param string $file_name Write to this file
+     * @param mixed  $data      My message to encode
+     * @param string $key       your secret Key
+     * 
+     * @return void not ah
+     */
+    public static function encodeFile(string $file_name, mixed $data, string $key): void
+    {
+        file_put_contents($file_name, self::_stringToHexToBin(self::safeEncrypt(base64_encode(json_encode((object) $data)), $key)));
     }
-
-    private static function string_to_hex_to_bin(string $str): string {
+    /**
+     * Convert a string into hex then into Binary...
+     * 
+     * @param string $str plan text
+     * 
+     * @return string Binary data
+     */
+    private static function _stringToHexToBin(string $str): string
+    {
         $ooh = 0;
         $hex = "";
         for ($c = 0; $c < strlen($str); $c++) {
@@ -104,7 +187,15 @@ class enc {
         return $hex;
     }
 
-    private static function bin_to_hex_to_string(string $hex): string {
+    /**
+     * Convert Binary into Hex into a string again.
+     * 
+     * @param string $hex semi scamble stuff
+     * 
+     * @return string cleaned up stuff again
+     */
+    private static function _binToHexToString(string $hex): string
+    {
         $decoded = "";
         $my_hex = "";
         $my_dec = "";

app/neato_fns.php

@@ -39,16 +39,16 @@ function display(array|string $data): bool
     if (empty($str)) {
         return false;
     }
-    if (configure::get('display')) {
+    if (Configure::get('display')) {
         echo $str . PHP_EOL;
     }
 
-    if (configure::get('syslog')) {
+    if (Configure::get('syslog')) {
         $access = date("Y/m/d H:i:s");
         syslog(LOG_INFO, $access . " " . $str);
     }
 
-    if (configure::get('logfile')) {
+    if (Configure::get('logfile')) {
         $config_file = (defined('CONFIG_FILE')) ? '_' . CONFIG_FILE : '';
         $logger = new Logger('neatoInstaller' . $config_file);
         $logger->write($str);
@@ -178,12 +178,15 @@ function doCommand()
 /**
  * File Loop, Run File Utils
  * 
- * @param array $data command and option
+ * @param mixed $data Array of commands and options
  * 
- * @return boolean Success?
+ * @return mixed Success?
  */
-function fileLoop(array $data)
+function fileLoop(mixed $data): mixed
 {
+    if (! is_array($data)) {
+        throw new Exception("fileLoop requires an Array!");
+    }
     $retval = true;
     foreach ($data as $command => $v) {
         switch (strtolower($command)) {

app/neato_logger.php

@@ -20,9 +20,6 @@ define('PROJECT_LOGS_DIR', $cwd. '/log');
 
 /**
  * Logs display data
-
- * @param mixed $input   text to display
- * @param mixed $options colors to use
  *
  * @category Util
  * @package  Neato
@@ -30,7 +27,6 @@ define('PROJECT_LOGS_DIR', $cwd. '/log');
  * @license  https://mit-license.org/ MIT License
  * @link     https://git.mysnippetsofcode.com/tts/neatoDeploy
  * 
- * @return string ANSI text
  */
 
 class Logger
@@ -125,7 +121,7 @@ class Logger
         if ($this->_handle === false || ! is_resource($this->_handle) ) {
             return false; 
         }
-        $tz = configure::get('logger_time_zone');
+        $tz = Configure::get('logger_time_zone');
         if ($tz !== false && !empty($tz)) {
             $tz_obj = new \DateTimeZone($tz);
             $dt = new \DateTime();

deploy_files/deploy_code_sniffer.php

@@ -0,0 +1,7 @@
+<?php
+
+$ok = useMe('wget');
+if ($ok !== false) {
+    doCommand('wget::download', 'phpcs', 'https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar');
+    doCommand('wget::download', 'phpcbf', 'https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar');
+}

deploy_files/deploy_example.php

@@ -1,13 +1,13 @@
 <?php
-configure::set('display', true); // Show Output
-configure::set('logfile', true); // Save to log folder
-configure::set('syslog', false);
-configure::set('passwords', ['length' => rand(16, 26)]);
+Configure::set('display', true); // Show Output
+Configure::set('logfile', true); // Save to log folder
+Configure::set('syslog', false);
+Configure::set('passwords', ['length' => rand(16, 26)]);
 
 /** @phpstan-ignore-next-line Variable $cwd $os might not be defined */
 $templates_dir = $cwd . '/templates/' . $os['name'] . '/';
 
-configure::set('preinstall', [
+Configure::set('preinstall', [
 	'cp' => [ 'neato.php' => 'cool.junk', 'cool.junk' => 'more.junk', '/home/bob/Documents/Servers/ha.conf' => 'test.ini' ],
 	'mv' => [ 'more.junk' => 'mmm.junk' ],
 	'rm' => [ 'cool.junk' ],
@@ -18,7 +18,7 @@ force_normal();
 
 //run_once(); // only allow, this script, to run once!
 
-$root_password = make_password(configure::get('passwords', 'length'));
+$root_password = make_password(Configure::get('passwords', 'length'));
 
 //do_command('service', 'mysql', 'stop');
 

deploy_files/deploy_mysql_ex1.php

@@ -1,10 +1,10 @@
 <?php
-configure::set('display', true); // Show Output
-configure::set('logfile', false); // Save to log folder
-configure::set('syslog', false);
-configure::set('passwords', ['length' => rand(16, 26)]);
+Configure::set('display', true); // Show Output
+Configure::set('logfile', false); // Save to log folder
+Configure::set('syslog', false);
+Configure::set('passwords', ['length' => rand(16, 26)]);
 
-configure::set('pre_actions', [
+Configure::set('pre_actions', [
   /** @phpstan-ignore-next-line Variable $cwd might not be defined */
         'make_dir' => [$cwd . '/my_vaults'=>'', '/etc/neato_secrets'=>''],
         'chmod_file_or_dir' => 
@@ -16,23 +16,23 @@ force_root();
 
 //doCommand('service', 'mysql', 'stop');
 
-fileLoop(configure::get('pre_actions'));
+fileLoop(Configure::get('pre_actions'));
 
-$my_key = enc::make_key_file("/etc/neato_secrets/mysql_key");
+$my_key = Enc::makeKeyFile("/etc/neato_secrets/mysql_key");
 
 /** @phpstan-ignore-next-line Variable $cwd might not be defined */
 if (!file_exists($cwd . "/my_vaults/mysql_secrets")) {
-    $root_password = make_password(configure::get('passwords', 'length'));
+    $root_password = make_password(Configure::get('passwords', 'length'));
     $obj = new stdClass();
     $obj->root = $root_password;
     
     /** @phpstan-ignore-next-line Variable $cwd might not be defined */
-    enc::encode_file($cwd . "/my_vaults/mysql_secrets", $obj, $my_key);
+    Enc::encodeFile($cwd . "/my_vaults/mysql_secrets", $obj, $my_key);
 }
 
 
 //$my_key = read_file("/etc/neato_secrets/mysql_data");
-//$o = Enc::decode_file($cwd . "/my_vaults/my_secrets", $my_key);
+//$o = Enc::decodeFile($cwd . "/my_vaults/my_secrets", $my_key);
 //echo $o->root;
 
 //doCommand('service', 'mysql', 'start');

deploy_files/deploy_mysql_ex2.php

@@ -1,7 +1,7 @@
 <?php
-configure::set('display', true); // Show Output
-configure::set('logfile', true); // Save to log folder
-configure::set('syslog', false);
+Configure::set('display', true); // Show Output
+Configure::set('logfile', true); // Save to log folder
+Configure::set('syslog', false);
 
 //doCommand('service', 'mysql', 'stop');
 
@@ -10,7 +10,7 @@ force_root();
 $my_key = read_file("/etc/neato_secrets/mysql_key");
 
 /** @phpstan-ignore-next-line Variable $cwd might not be defined */
-$o = enc::decode_file($cwd . "/my_vaults/mysql_secrets", $my_key);
+$o = Enc::decodeFile($cwd . "/my_vaults/mysql_secrets", $my_key);
 echo $o->root;
 
 //doCommand('service', 'mysql', 'start');

deploy_files/deploy_podman.php

@@ -1,9 +1,9 @@
 <?php
-configure::set('display', true); // Show Output
-configure::set('logfile', false); // Save to log folder
-configure::set('syslog', false);
+Configure::set('display', true); // Show Output
+Configure::set('logfile', false); // Save to log folder
+Configure::set('syslog', false);
 
-configure::set('pre_actions', [
+Configure::set('pre_actions', [
         'make_dir' => ['/etc/containers'=>''],
         'chmod_file_or_dir' => 
             ['/etc/containers' => 'dir'],
@@ -11,7 +11,7 @@ configure::set('pre_actions', [
 
 force_root();
 
-fileLoop(configure::get('pre_actions'));
+fileLoop(Configure::get('pre_actions'));
 
 $is_podman_installed = doCommand('is_installed', "podman");
 if ($is_podman_installed['installed'] === false) {

deploy_files/deploy_security_audit.php

@@ -1,12 +1,12 @@
 <?php
 
-configure::set('display', true);
-configure::set('logfile', true);
+Configure::set('display', true);
+Configure::set('logfile', true);
 
 $options = cGetOpt(["updates"]);
 $updates = $options['updates'] ?? "no";
 
-configure::set('remove_users', [
+Configure::set('remove_users', [
     'shutdown', 'halt', 'games', 'operator',
     'ftp', 'news', 'gopher',
 ]); 
@@ -14,11 +14,12 @@ configure::set('remove_users', [
 force_root();
 
 display(getTermColors("Deleteing unused user accounts", ['color'=>'blue']));
-$remove_users = configure::get('remove_users');
+$remove_users = Configure::get('remove_users');
+if (is_array($remove_users)) {
     foreach($remove_users as $del_user) {
         doCommand('userdel', $del_user);
     }
-
+}
 display(getTermColors("Removing old un-needed programs", ['color'=>'blue']));
 doCommand('purge', "xinetd nis yp-tools tftpd atftpd tftpd-hpa telnetd rsh-server rsh-redone-server");
 

deploy_files/deploy_test1.php

@@ -1,7 +1,7 @@
 <?php
-configure::set('display', true); // Show Output
-configure::set('logfile', false); // Save to log folder
-configure::set('syslog', false);
+Configure::set('display', true); // Show Output
+Configure::set('logfile', false); // Save to log folder
+Configure::set('syslog', false);
 
 force_root();