ggoffy / modulebuilder

class/Devtools.php

<?php

namespace XoopsModules\Modulebuilder;

/*
 Utility Class Definition

 You may not change or alter any portion of this comment or credits of
 supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit
 authors.

 This program is distributed in the hope that it will be useful, but
 WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */

/**
 * Module:  modulebuilder
 *
 * @package      \module\modulebuilder\class
 * @license      http://www.fsf.org/copyleft/gpl.html GNU public license
 * @copyright    https://xoops.org 2001-2017 &copy; XOOPS Project
 * @author       Goffy https://myxoops.org
 * @author       Mamba <mambax7@gmail.com>
 * @since        
 */

use XoopsModules\Modulebuilder;

/**
 * Class Devtools
 */
class Devtools
{
    /* function to add function qualifier to module */
    /**
     * @param $src_path
     * @param $dst_path
     * @param $moduleName
     */
    public static function function_qualifier($src_path, $dst_path, $moduleName) {

        $functions = [];
        $constants = [];

        //php functions
        $functions[] = [
            'array_diff',
            'array_filter',
            'array_key_exists',
            'array_keys',
            'array_search',
            'array_slice',
            'array_unshift',
            'array_values',
            'array_flip',
            'assert',
            'basename',
            'boolval',
            'call_user_func',
            'call_user_func_array',
            'chr',
            'class_exists',
            'closedir',
            'constant',
            'copy',
            'count',
            'curl_close',
            'curl_error',
            'curl_exec',
            'curl_file_create',
            'curl_getinfo',
            'curl_init',
            'curl_setopt',
            'define',
            'defined',
            'dirname',
            'doubleval',
            'explode',
            'extension_loaded',
            'file_exists',
            'finfo_open',
            'floatval',
            'floor',
            'formatTimestamp',
            'func_get_args',
            'func_num_args',
            'function_exists',
            'get_called_class',
            'get_class',
            'getimagesize',
            'gettype',
            'imagecopyresampled',
            'imagecreatefromgif',
            'imagecreatefromjpeg',
            'imagecreatefrompng',
            'imagecreatefromstring',
            'imagecreatetruecolor',
            'imagedestroy',
            'imagegif',
            'imagejpeg',
            'imagepng',
            'imagerotate',
            'imagesx',
            'imagesy',
            'implode',
            'in_array',
            'ini_get',
            'intval',
            'include',
            'is_array',
            'is_bool',
            'is_callable',
            'is_dir',
            'is_double',
            'is_float',
            'is_int',
            'is_integer',
            'is_link',
            'is_long',
            'is_null',
            'is_object',
            'is_real',
            'is_resource',
            'is_string',
            'json_decode',
            'json_encode',
            'mime_content_type',
            'mkdir',
            'mktime',
            'opendir',
            'ord',
            'pathinfo',
            'preg_match',
            'preg_match_all',
            'preg_replace',
            'readdir',
            'readlink',
            'redirect_header',
            'rename',
            'require',
            'rmdir',
            'round',
            'scandir',
            'sprintf',
            'str_replace',
            'strip_tags',
            'strlen',
            'strpos',
            'strtotime',
            'strval',
            'substr',
            'symlink',
            'time',
            'trigger_error',
            'trim',
            'ucfirst',
            'unlink',
            'version_compare',
            'mb_strtoupper',
            'mb_strtolower',
            'mb_strpos',
            'mb_strlen',
            'mb_strrpos',
        ];

        // xoops functions
        $functions[] = [
            'xoops_getHandler',
            'xoops_load',
            'xoops_loadLanguage',
        ];
        // xoops const
        $constants[] = [
            'XOBJ_DTYPE_',
            'XOOPS_URL',
            'XOOPS_ROOT_PATH',
            'XOOPS_GROUP_',
        ];

        $moduleNameUpper = \mb_strtoupper($moduleName);
        // module language defines
        $constants[] = [
            '_AM_' . $moduleNameUpper .'_',
            '_MI_' . $moduleNameUpper .'_',
            '_MB_' . $moduleNameUpper .'_',
            '_MA_' . $moduleNameUpper .'_',
        ];

        // repair known errors
        $errors = [
            'substr_\count('   => 'substr_count(',
            'micro\time('   => 'microtime(',
            'mk\time('   => 'mktime(',
            'strto\time('   => 'strtotime(',
            'mb_\strlen('   => 'mb_strlen(',
            'mb_\substr('   => 'mb_substr(',
            'x\copy'        => 'xcopy',
            'r\rmdir'       => 'rrmdir',
            'r\copy'        => 'rcopy',
            'r\trim'        => 'rtrim',
            'l\trim'        => 'ltrim',
            '\dirname()'    => 'dirname()',
            'assw\ord'      => 'assword',
            'mb_\strpos'    => 'mb_strpos',
            'image\copy('   => 'imagecopy(',
            '<{if \count('  => '<{if count(',
            'define(\_'     => 'define(_',
            '\strr\chr('    => '\strrchr(',
            'strf\time('    => 'strftime(',
            "'\_AM_" . $moduleNameUpper .'_' => "'_AM_" . $moduleNameUpper .'_',
            "'\_MI_" . $moduleNameUpper .'_' => "'_MI_" . $moduleNameUpper .'_',
            "'\_MB_" . $moduleNameUpper .'_' => "'_MB_" . $moduleNameUpper .'_',
            "'\_MA_" . $moduleNameUpper .'_' => "'_MA_" . $moduleNameUpper .'_',
        ];

        $patterns = [];
        foreach ($functions as $function) {
            //reset existing in order to avoid double \\
            foreach ($function as $item) {
                $patterns['\\' . $item . '('] = $item . '(';
            }
            //apply now for all
            foreach ($function as $item) {
                $patterns[$item . '('] = '\\' . $item . '(';
            }
        }
        foreach ($constants as $constant) {
            //reset existing in order to avoid double \\
            foreach ($constant as $item) {
                $patterns['\\' . $item ] = $item;
            }
            //apply now for all
            foreach ($constant as $item) {
                $patterns[$item] = '\\' . $item;
            }
        }

        //add errors
        foreach ($errors as $key => $value) {
            $patterns[$key] = $value;
        }

        $patKeys   = \array_keys($patterns);
        $patValues = \array_values($patterns);
        Devtools::cloneFileFolder($src_path, $dst_path, $patKeys, $patValues);

    }

    /* function to add function qualifier to module */
    /**
     * @param $src_path
     * @param $dst_path
     * @param $moduleName
     */
    public static function function_tabreplacer($src_path, $dst_path) {
        $patKeys   = [];
        $patValues = [];
        Devtools::cloneFileFolder($src_path, $dst_path, $patKeys, $patValues, true);
    }

    // recursive cloning script
    /**
     * @param $src_path
     * @param $dst_path
     * @param array $patKeys
     * @param array $patValues
     * @param bool  $replaceTabs
     */
    public static function cloneFileFolder($src_path, $dst_path, $patKeys = [], $patValues =[], $replaceTabs = false)
    {
        // open the source directory
        $dir = \opendir($src_path);
        // Make the destination directory if not exist
        @\mkdir($dst_path);

It seems like you do not handle an error condition for mkdir(). This can introduce security issues, and is generally not recommended.

        // Loop through the files in source directory
        while( $file = \readdir($dir) ) {
            if (( $file != '.' ) && ( $file != '..' )) {
                if ( \is_dir($src_path . '/' . $file) ) {
                    // Recursively calling custom copy function for sub directory
                    Devtools::cloneFileFolder($src_path . '/' . $file, $dst_path . '/' . $file, $patKeys, $patValues, $replaceTabs);
                } else {
                    Devtools::cloneFile($src_path . '/' . $file, $dst_path . '/' . $file, $patKeys, $patValues, $replaceTabs);
                }
            }
        }
        \closedir($dir);
    }

    /**
     * @param $src_file
     * @param $dst_file
     * @param array $patKeys
     * @param array $patValues
     * @param array $patValues
     * @param bool  $replaceTabs
     */
    private static function cloneFile($src_file, $dst_file, $patKeys = [], $patValues =[], $replaceTabs = false)
    {
        $replace_code = false;
        $changeExtensions = ['php'];
        if (\in_array(\mb_strtolower(\pathinfo($src_file, PATHINFO_EXTENSION)), $changeExtensions)) {

It seems like pathinfo($src_file, XoopsModules\Modulebuilder\PATHINFO_EXTENSION) can also be of type array; however, parameter $string of mb_strtolower() does only seem to accept string, maybe add an additional type check?

            $replace_code = true;
        }
        if (\strpos( $dst_file, basename(__FILE__)) > 0) {
            //skip myself
            $replace_code = false;
        }
        if ($replace_code) {
            // file, read it and replace text
            $content = \file_get_contents($src_file);
            if ($replaceTabs) {
                $content = \preg_replace("/[\t]+/", "    ", $content);
            } else {
                $content = \str_replace($patKeys, $patValues, $content);
            }
            //check file name whether it contains replace code
            $path_parts = \pathinfo($dst_file);
            $path = $path_parts['dirname'];
            $file =  $path_parts['basename'];
            $dst_file = $path . '/' . \str_replace($patKeys, $patValues, $file);
            \file_put_contents($dst_file, $content);
        } else {
            \copy($src_file, $dst_file);
        }
    }

    /**
     * get form with all existing modules
     * @param bool $action
     * @return \XoopsSimpleForm
     */
    public static function getFormModulesFq($action = false)
    {
        if (!$action) {
            $action = $_SERVER['REQUEST_URI'];
        }
        // Get Theme Form
        \xoops_load('XoopsFormLoader');
        $form = new \XoopsSimpleForm('', 'form', $action, 'post', true);
        $form->setExtra('enctype="multipart/form-data"');
        // Form Select Module
        $modulesSelect = new \XoopsFormSelect(\_AM_MODULEBUILDER_DEVTOOLS_FQ_MODULE, 'fq_module', '');
        $modulesArr   = \XoopsLists::getModulesList();
        $modulesSelect->addOption('', ' ');
        foreach ($modulesArr as $mod) {
            $modulesSelect->addOption($mod, $mod);
        }
        $form->addElement($modulesSelect, true);
        // To Save
        $form->addElement(new \XoopsFormHidden('op', 'fq'));
        $form->addElement(new \XoopsFormButtonTray('', \_SUBMIT, 'submit', '', false));

        return $form;
    }

    /**
     * get form with all existing modules
     * @param bool $action
     * @return \XoopsSimpleForm
     */
    public static function getFormModulesCl($action = false)
    {
        if (!$action) {
            $action = $_SERVER['REQUEST_URI'];
        }
        // Get Theme Form
        \xoops_load('XoopsFormLoader');
        $form = new \XoopsSimpleForm('', 'form', $action, 'post', true);
        $form->setExtra('enctype="multipart/form-data"');
        // Form Select Module
        $modulesSelect = new \XoopsFormSelect(\_AM_MODULEBUILDER_DEVTOOLS_CL_MODULE, 'cl_module', '');
        $modulesArr   = \XoopsLists::getModulesList();
        $modulesSelect->addOption('', ' ');
        foreach ($modulesArr as $mod) {
            $modulesSelect->addOption($mod, $mod);
        }
        $form->addElement($modulesSelect, true);
        // To Save
        $form->addElement(new \XoopsFormHidden('op', 'check_lang'));
        $form->addElement(new \XoopsFormButtonTray('', \_SUBMIT, 'submit', '', false));

        return $form;
    }

    /**
     * get form with all existing modules
     * @param bool $action
     * @return \XoopsSimpleForm
     */
    public static function getFormModulesTab($action = false)
    {
        if (!$action) {
            $action = $_SERVER['REQUEST_URI'];
        }
        // Get Theme Form
        \xoops_load('XoopsFormLoader');
        $form = new \XoopsSimpleForm('', 'form', $action, 'post', true);
        $form->setExtra('enctype="multipart/form-data"');
        // Form Select Module
        $modulesSelect = new \XoopsFormSelect(\_AM_MODULEBUILDER_DEVTOOLS_TAB_MODULE, 'tab_module', '');
        $modulesArr   = \XoopsLists::getModulesList();
        $modulesSelect->addOption('', ' ');
        foreach ($modulesArr as $mod) {
            $modulesSelect->addOption($mod, $mod);
        }
        $form->addElement($modulesSelect, true);
        // To Save
        $form->addElement(new \XoopsFormHidden('op', 'tab_replacer'));
        $form->addElement(new \XoopsFormButtonTray('', \_SUBMIT, 'submit', '', false));

        return $form;
    }
}