XoopsModules25x / backpack

class/class.backpack.php

<?php
/*
*******************************************************
***													***
*** backpack										***
*** Cedric MONTUY pour CHG-WEB                      ***
*** Original author : Yoshi Sakai					***
***													***
*******************************************************
*/

class backpack
{
    private $debug          = 0;        // Define this to enable debugging
    public  $backup_dir;
    public  $dump_size      = 0;
    public  $dump_line      = 0;
    public  $dump_buffer;
    public  $query_res      = [];
    public  $download_count = 0;
    public  $download_fname = [];
    public  $mime_type      = '';
    public  $time_start;
    public  $xoopsModuleConfig;
    public  $err_msg;

    public function __construct()
    {
        global $xoopsModuleConfig, $xoopsModule;
        if (defined('XOOPS_VAR_PATH')) {
            $backup_dir = XOOPS_VAR_PATH . '/caches/';
        } else {
            $backup_dir = XOOPS_ROOT_PATH . '/cache/';
        }
        $this->xoopsModuleConfig = $xoopsModuleConfig;
        $this->backup_dir        = $backup_dir;
    }

    public function backpack($dirname = '', $purgeBefore = '')
    {
        global $xoopsModuleConfig, $xoopsModule;
        if (empty($dirname)) {
            $this->xoopsModuleConfig = $xoopsModuleConfig;
            $dirname                 = $xoopsModule->dirname();
        } else {
            $this->xoopsModuleConfig($dirname);
        }
        $this->set_backup_dir($dirname);
        $this->time_start  = time();
        $this->dump_buffer = null;
        if (!empty($purgeBefore)) {
            $this->purge_allfiles($purgeBefore);
        }
    }

    public function set_backup_dir($dirname)
    {
        if (defined('XOOPS_VAR_PATH')) {
            $backup_dir = XOOPS_VAR_PATH . '/caches/';
        } else {
            $backup_dir = XOOPS_ROOT_PATH . '/cache/';
        }
        $this->backup_dir = $backup_dir;
    }

    public function xoopsModuleConfig($dirname)
    {
        $moduleHandler           = xoops_getHandler('module');
        $this_module             = $moduleHandler->getByDirname($dirname);

The method getByDirname() does not exist on XoopsObjectHandler. It seems like you code against a sub-type of XoopsObjectHandler such as XoopsModuleHandler or XoopsPersistableObjectHandler.

        $mid                     = $this_module->getVar('mid');
        $configHandler           = xoops_getHandler('config');
        $this->xoopsModuleConfig = $configHandler->getConfigsByCat(0, $mid);

The method getConfigsByCat() does not exist on XoopsObjectHandler. It seems like you code against a sub-type of XoopsObjectHandler such as XoopsPersistableObjectHandler.

    }

    public function PMA_backquote($a_name, $do_it = true)
    {
        if ($do_it
            && PMA_MYSQL_INT_VERSION >= 32306
            && !empty($a_name)
            && '*' != $a_name) {
            return '`' . $a_name . '`';
        }

        return $a_name;
    } // end of the 'PMA_backquote()' function

    public function create_table_sql_string($tablename)
    {
        global $xoopsDB;
        $crlf = "\r\n";

        // Start the SQL string for this table
        $field_header = 'CREATE TABLE `' . $tablename . '` (';
        $field_string = '';

        // Get the field info and output to a string in the correct MySQL syntax
        $result = $xoopsDB->queryF('DESCRIBE ' . $tablename);
        if ($this->debug) {
            echo $tablename . " .field_info\n\n";
        }
        while (false !== ($field_info = $xoopsDB->fetchBoth($result))) {
            if ($this->debug) {
                $iMax = count($field_info);
                for ($i = 0;  $i < $iMax; ++$i) {
                    echo $i . ': ' . $field_info[$i] . "\n";
                }
            }
            $field_name     = $field_info[0];
            $field_type     = $field_info[1];
            $field_not_null = ('YES' == $field_info[2]) ? '' : ' NOT NULL';
            $field_default  = (null === $field_info[4]) ? '' : sprintf(' default \'%s\'', $field_info[4]);;
            $field_auto_increment = (null === $field_info[5]) ? '' : sprintf(' %s', $field_info[5]);
            $field_string         .= $field_string ? ',' : $field_header;
            $field_string         .= $crlf . sprintf('  `%s` %s%s%s%s', $field_name, $field_type, $field_not_null, $field_auto_increment, $field_default);
        }
        // Get the index info and output to a string in the correct MySQL syntax
        $result = $xoopsDB->queryF('SHOW KEYS FROM ' . $tablename);
        if ($this->debug) {
            echo "\nindex_info\n\n";
        }
        while (false !== ($row = $xoopsDB->fetchBoth($result))) {
            $kname = $row['Key_name'];
            $ktype = $row['Index_type'] ?? '';
            if (!$ktype && (isset($row['Comment']))) {
                $ktype = $row['Comment'];
            } // For Under MySQL v4.0.2
            $sub_part = $row['Sub_part'] ?? '';
            if ('PRIMARY' != $kname && 0 == $row['Non_unique']) {
                $kname = 'UNIQUE KEY `' . $kname . '`';
            }
            if ('FULLTEXT' == $ktype) {
                $kname = 'FULLTEXT KEY `' . $kname . '`';
            }
            if (!isset($index[$kname])) {
                $index[$kname] = [];
            }
            if ($sub_part > 1) {
                $index[$kname][] = $this->PMA_backquote($row['Column_name'], 0) . '(' . $sub_part . ')';
            } else {
                $index[$kname][] = $this->PMA_backquote($row['Column_name'], 0);
            }
        } // end while
        $xoopsDB->freeRecordSet($result);
        $index_string = '';
        foreach ($index as $x => $columns) {
            $index_string .= ',' . $crlf;
            if ('PRIMARY' == $x) {
                $index_string .= '   PRIMARY KEY (';
            } elseif (0 === strpos($x, 'UNIQUE')) {
                $index_string .= '   UNIQUE ' . substr($x, 7) . ' (';
            } elseif (0 === strpos($x, 'FULLTEXT')) {
                $index_string .= '   FULLTEXT ' . substr($x, 9) . ' (';
            } else {
                $index_string .= '   KEY `' . $x . '` (';
            }
            $index_string .= implode(', ', $columns) . ')';
        } // foreach
        $index_string .= $crlf;

        // Get the table type and output it to a string in the correct MySQL syntax
        //$result = mysqli_query("SHOW TABLE STATUS");
        $result = $xoopsDB->query('SHOW TABLE STATUS');
        if ($this->debug) {
            echo "\nstatus_info\n\n";
        }
        while (false !== ($status_info = $xoopsDB->fetchBoth($result))) {
            $iMax = count($status_info);
            for ($i = 0; $i < $iMax; ++$i) {
                if ($this->debug) {
                    echo "$i: $status_info[$i]\n";
                }
                if ($status_info[0] == $tablename) {
                    $table_type = sprintf('TYPE=%s', $status_info[1]);
                }
            }
        }

        // Append the index string to the field string
        $field_string = sprintf('%s%s', $field_string, $index_string);

        // Put the field string in parantheses
        $field_string = sprintf('%s)', $field_string);

        // Finalise the MySQL create table string
        $field_string      .= $table_type . ';';
        $field_string      = "-- \r\n-- " . $tablename . " structure.\r\n-- " . $crlf . $field_string . $crlf;
        $this->dump_buffer .= $field_string;
        preg_match_all("/\r\n/", $field_string, $c);
        $this->dump_line += count($c[0]);
        $this->dump_size += strlen(bin2hex($field_string)) / 2;
    }

    public function create_data_sql_string($tablename, $filename, $cfgZipType)
    {
        global $xoopsModuleConfig, $xoopsDB;
        // Get field names from MySQL and output to a string in the correct MySQL syntax
        $this->query_res = $xoopsDB->query("SELECT * FROM $tablename");

        // Get table data from MySQL and output to a string in the correct MySQL syntax
        $this->dump_buffer .= "-- \r\n-- " . $tablename . " dump.\r\n-- \r\n";
        $this->dump_line   += 3;
        while (false !== ($row = $xoopsDB->fetchRow($this->query_res))) {
            // Initialise the data string
            $data_string = '';
            // Loop through the records and append data to the string after escaping
            for ($i = 0; $i < $xoopsDB->getFieldsNum($this->query_res); ++$i) {
                if ('' != $data_string) {
                    $data_string .= ',';
                }
                if (!isset($row[$i]) || null === $row[$i]) {
                    $data_string .= 'NULL';
                } else {
                    //$data_string .= '"'.$GLOBALS['xoopsDB']->escape($row[$i]).'"';
                    $data_string .= '"' . $xoopsDB->escape($row[$i]) . '"';
                }
                //$data_string = str_replace("`","\'",$data_string);
            }
            //die($data_string);
            // URL change
            if (0 <> strcmp($xoopsModuleConfig['xoopsurlto'], XOOPS_URL)) {
                $data_string = preg_replace('/' . preg_quote(XOOPS_URL, '/') . '/', $xoopsModuleConfig['xoopsurlto'], $data_string);
            }
            // Encoding change
            /*
            if(extension_loaded("mbstring") && function_exists("mb_convert_encoding")){
                if ( strcmp( $xoopsModuleConfig['encodingto'], _CHARSET)<>0 )
                    $data_string = mb_convert_encoding($data_string, $xoopsModuleConfig['encodingto'],_CHARSET);
            }*/
            // Put the data string in parantheses and prepend "VALUES "
            $data_string = sprintf('VALUES (%s)', $data_string);
            // Finalise the MySQL insert into string for this record
            $field_string      = sprintf("INSERT INTO `%s` %s;\r\n", $tablename, $data_string);
            $this->dump_buffer .= $field_string;
            $this->dump_size   += strlen(bin2hex($field_string)) / 2;
            $this->dump_line++;
            $this->check_dump_buffer($filename, $cfgZipType);
        }
    }

    public function make_download($filename, $cfgZipType)
    {
        if (('bzip' == $cfgZipType) && function_exists('bzcompress')) {    // (PMA_PHP_INT_VERSION >= 40004 &&
            $filename        .= $this->download_count > 0 ? '-' . $this->download_count . '.sql' : '.sql';
            $ext             = 'bz2';
            $this->mime_type = 'application/x-bzip';
            $op_buffer       = bzcompress($this->dump_buffer);
        } elseif (('gzip' == $cfgZipType) && function_exists('gzencode')) {    // (PMA_PHP_INT_VERSION >= 40004 &&
            $filename         .= $this->download_count > 0 ? '-' . $this->download_count . '.sql' : '.sql';
            $ext              = 'gz';
            $content_encoding = 'x-gzip';
            $this->mime_type  = 'application/x-gzip';
            // without the optional parameter level because it bug
            $op_buffer = gzencode($this->dump_buffer, 9);
        } elseif (('zip' == $cfgZipType) && function_exists('gzcompress')) {    // (PMA_PHP_INT_VERSION >= 40000 &&
            $filename        .= $this->download_count > 0 ? '-' . $this->download_count : '';
            $ext             = 'zip';
            $this->mime_type = 'application/x-zip';
            $extbis          = '.sql';
            $zipfile         = new zipfile();
            $zipfile->addFile($this->dump_buffer, $filename . $extbis);
            $op_buffer = $zipfile->file();
        } else {
            $filename        .= $this->download_count > 0 ? '-' . $this->download_count : '';
            $ext             = 'sql';
            $cfgZipType      = 'none';
            $this->mime_type = 'text/plain';
            $op_buffer       = $this->dump_buffer;
        }
        $fpathname = $this->backup_dir . $filename . '.' . $ext;
        if ($this->debug) {
            echo $fpathname . '<br>';
        }
        $fp = fopen($fpathname, 'w');
        fwrite($fp, $op_buffer);
        fclose($fp);
        unset($op_buffer);
        if (!is_file($fpathname)) {
            print("Error - $filename does not exist.");
            return false;
        }
        $this->download_fname[$this->download_count]['filename'] = $filename . '.' . $ext;
        $this->download_fname[$this->download_count]['line']     = $this->dump_line;
        $this->download_fname[$this->download_count]['size']     = filesize($fpathname);
        $this->download_count++;
    }

    /*
    ** $beforeDays : You can purge before N days
    */
    public function purge_allfiles($beforeDays = null)
    {
        if ($handle = opendir($this->backup_dir)) {
            while (false !== ($file = readdir($handle))) {
                if (preg_match('/sql/', $file)) {
                    $fileDate = filemtime($this->backup_dir . $file);
                    if ($beforeDays) {
                        $beforeDate = time() - 86400 * (int)$beforeDays;
                        if ($fileDate < $beforeDate) {
                            if ($this->debug) {
                                echo "DELETE - $file $fileDate\n<BR>";
                            }
                            unlink($this->backup_dir . $file);
                        }
                    } else {
                        if ($this->debug) {
                            echo "DELETE - $file $fileDate\n<BR>";
                        }
                        unlink($this->backup_dir . $file);
                    }
                }
            }
            closedir($handle);
        }
    }

    public function check_dump_buffer($filename, $cfgZipType)
    {
        //var_dump($this->xoopsModuleConfig);
        $max_dumpsize = $this->xoopsModuleConfig['max_dumpsize'];//max_dumpsize
        if (!$max_dumpsize) {
            $max_dumpsize = MAX_DUMPSIZE;
        }
        //echo $this->dump_line . " - " .strlen( bin2hex( $this->dump_buffer)) / 2  . "byte<br>";
        if ($this->dump_line >= MAX_DUMPLINE || $this->dump_size >= $max_dumpsize) {
            $this->make_download($filename, $cfgZipType);
            //unset($GLOBALS['dump_buffer']);
            //unset($GLOBALS['$this->dump_line']);
            $this->dump_buffer = '';
            $this->dump_line   = 0;
            $this->dump_size   = 0;
        }
    }

    public function Lock_Tables($tablename_array)
    {
        global $xoopsDB;
        if (!is_array($tablename_array) || empty($tablename_array)) {
            return false;
        }
        $q = 'LOCK TABLES';
        foreach ($tablename_array as $iValue) {
            $q .= ' ' . $iValue . ' read,';
        }
        $q = substr($q, 0, strlen($q) - 1);
        $xoopsDB->queryF($q);
    }

    public function backup_data($tablename_array, $backup_structure, $backup_data, $filename, $cfgZipType)
    {
        global $xoopsDB;
        $field_string      = "-- CHG-WEB.Xoops Backup/Restore Module\r\n-- BackPack\r\n-- https://store.chg-web.com/\r\n" . "-- --------------------------------------------\r\n";
        $this->dump_buffer = $field_string;
        $this->dump_size   += strlen(bin2hex($field_string)) / 2;
        preg_match_all("/\r\n/", $this->dump_buffer, $c);
        $this->dump_line += count($c[0]);
        //mysqli_query($xoopsDB->conn,'FLUSH TABLES');
        $xoopsDB->queryF('FLUSH TABLES');
        $this->Lock_Tables($tablename_array);
        foreach ($tablename_array as $iValue) {
            if ($backup_structure) {
                $this->create_table_sql_string($iValue);
            }
            if ($backup_data) {
                $this->create_data_sql_string($iValue, $filename, $cfgZipType);
            }
            $this->check_dump_buffer($filename, $cfgZipType);
            $time_now = time();
            if ($this->time_start >= $time_now + 30) {
                $this->time_start = $time_now;
                header('X-pmaPing: Pong');
            }
        }
        $xoopsDB->queryF('UNLOCK TABLES');
        if ($this->dump_buffer) {
            $this->make_download($filename, $cfgZipType);
        }
    }

    public function restore_data($filename, $restore_structure, $restore_data, $db_selected, $replace_url = '')
    {
        global $xoopsDB;
        if (!is_file($filename)) {
            exit();

Using exit here is not recommended.

        }
        $handle = fopen($filename, 'r');

        $prefix = '';
        mysqli_set_charset('utf8');
        while (!feof($handle)) {
            $buffer = '';
            while (!feof($handle)) {
                //$cbuff = ereg_replace("\n|\r|\t","",fgets($handle));
                $cbuff = preg_replace('/\n|\r|\t/', '', fgets($handle));
                // print (ereg('--',$cbuff)?"true<br>":"false<br>");
                //if (!ereg('^--',$cbuff)) $buffer .= $cbuff;
                if (!preg_match('/^--/', $cbuff)) {
                    $buffer .= $cbuff;
                }
                if (false !== preg_match('/;/', $cbuff)) {
                    break;
                }
            }
            if (preg_match('/^CREATE TABLE|^INSERT INTO|^DELETE/i', $buffer)) {
                if (!$prefix) {
                    $match  = explode(' ', $buffer);
                    $prefix = explode('_', $match[2]);
                    $prefix = preg_replace('/^`/', '', $prefix[0]);
                }
                $buffer = preg_replace('/' . $prefix . '_/', XOOPS_DB_PREFIX . '_', $buffer);
                if ($replace_url) {
                    $pattern = 'http://' . $replace_url;
                    $buffer  = preg_replace('/' . preg_quote($pattern, '/') . '/', XOOPS_URL, $buffer);
                }
            }
            // 20100218
            $buffer = preg_replace("/on update CURRENT_TIMESTAMP default \'CURRENT_TIMESTAMP\'/i", '', $buffer);
            if ($buffer) {
                // if this line is a create table query then check if the table already exists

                //if (eregi("^CREATE TABLE",$buffer) ) {
                if (preg_match('/^CREATE TABLE/i', $buffer)) {
                    if ($restore_structure) {
                        $tablename = explode(' ', $buffer);
                        $tablename = preg_replace('/`/', '', $tablename[2]);
//                        $result    = mysqli_list_tables($db_selected);
                        $sql = "SHOW TABLES FROM $db_selected";
                        $result = $xoopsDB->query($sql);
                        for ($i = 0; $i < $GLOBALS['xoopsDB']->getRowsNum($result); ++$i) {
                            if (mysqli_tablename($result, $i) == $tablename) {
                                //$rand = substr(md5(time()), 0, 8);
                                //$random_tablename = sprintf("%s_bak_%s", $tablename, $rand);
                                //mysqli_query("DROP TABLE IF EXISTS $tablename");
                                $xoopsDB->queryF('DROP TABLE IF EXISTS ' . $tablename);
                                //mysqli_query("RENAME TABLE $tablename TO $random_tablename");
                                //echo "Backed up $tablename to $random_tablename.<br>\n";
                            }
                        }
                        //$result = mysqli_query($buffer);
                        $xoopsDB->queryF($buffer);
                        if (!$result) {
                            echo $GLOBALS['xoopsDB']->error() . "<br>\n";
                        } else {
                            echo "Table '$tablename' successfully recreated.<br>\n";
                        }
                    }
                    //echo "[".$buffer."]";die;
                } elseif ($restore_data) {
                    //$result = mysqli_query($buffer);
                    $xoopsDB->queryF($buffer);
                    if (!$result) {
                        echo $GLOBALS['xoopsDB']->error() . "<br>\n";
                    }
                }
            }
        }
        fclose($handle);
    }

    public function get_module_tables($dirname)
    {
        global $xoopsConfig, $xoopsDB;
        if (!$dirname) {
            return;
        }
        $moduleHandler = xoops_getHandler('module');
        $module        = $moduleHandler->getByDirname($dirname);
        // Get tables used by this module
        $modtables = $module->getInfo('tables');
        if (false !== $modtables && is_array($modtables)) {
            return $modtables;
        }

        // TABLES (loading mysql.sql)
        $sql_file_path = XOOPS_TRUST_PATH . '/modules/' . $dirname . '/sql/mysql.sql';
        $prefix_mod    = $dirname;
        if (is_file($sql_file_path)) {
            $sql_lines = file($sql_file_path);
            foreach ($sql_lines as $sql_line) {
                if (preg_match('/^CREATE TABLE \`?([a-zA-Z0-9_-]+)\`? /i', $sql_line, $regs)) {
                    $modtables[] = $prefix_mod . '_' . $regs[1];
                }
            }
            return $modtables;
        }

        //die( "No Table" );
        redirect_header('./index.php', 1, _AM_NO_TABLE);
    }

    public function make_module_selection($select_dirname = '', $addblank = 0)
    {
        global $xoopsDB;
        $sql = 'SELECT name,dirname FROM ' . $xoopsDB->prefix('modules');
        if (!$result = $xoopsDB->queryF($sql)) {
            return false;
        }
        $mod_selections = '<select name="dirname">';
        $mod_selections .= $addblank ? '<option value=""></option>' : '';
        while (list($name, $dirname) = $xoopsDB->fetchRow($result)) {
            if (0 == strcmp($dirname, $select_dirname)) {
                $opt = 'selected';
            } else {
                $opt = '';
            }
            $mod_selections .= '<option value="' . $dirname . '" ' . $opt . '>' . $name . '</option>';
        }
        $mod_selections .= '</select>';
        return $mod_selections;
    }

    /**
     * Maximum upload size as limited by PHP
     * Used with permission from Moodle (http://moodle.org) by Martin Dougiamas
     *
     * this section generates $max_upload_size in bytes
     * @param int $size
     * @return float|int|mixed
     */

    public function get_real_size($size = 0)
    {
        /// Converts numbers like 10M into bytes
        if (!$size) {
            return 0;
        }
        $scan['MB'] = 1048576;
        $scan['Mb'] = 1048576;
        $scan['M']  = 1048576;
        $scan['m']  = 1048576;
        $scan['KB'] = 1024;
        $scan['Kb'] = 1024;
        $scan['K']  = 1024;
        $scan['k']  = 1024;

//        while (list($key) = each($scan)) {
        foreach (array_keys($scan) as $key) {
            if ((strlen($size) > strlen($key)) && (substr($size, strlen($size) - strlen($key)) == $key)) {
                $size = substr($size, 0, strlen($size) - strlen($key)) * $scan[$key];
                break;
            }
        }
        /*foreach($scan as $key=>$value){
            if ((strlen($size)>strlen($value))&&(substr($size, strlen($size) - strlen($key))==$key)) {
                $size = substr($size, 0, strlen($size) - strlen($key)) * $value;
                break;
            }
        }*/
        return $size;
    }

    /**
     * Displays the maximum size for an upload
     *
     * @param int  the size
     *
     * @return  string   the message
     *
     * @access  public
     */
    public function PMA_displayMaximumUploadSize($max_upload_size)
    {
        [$max_size, $max_unit] = $this->PMA_formatByteDown($max_upload_size);
        return '(' . sprintf(_AM_SELECTAFILE_DESC, $max_size, $max_unit) . ')';
    }

    /**
     * Formats $value to byte view
     *
     * @param double   the value to format
     * @param int  the sensitiveness
     * @param int  the number of decimals to retain
     *
     * @return   array    the formatted value and its unit
     *
     * @access   public
     *
     * @author   staybyte
     * @version  1.2 - 18 July 2002
     */
    public function PMA_formatByteDown($value, $limes = 6, $comma = 0)
    {
        $dh                         = pow(10, $comma);
        $li                         = pow(10, $limes);
        $return_value               = $value;
        $byteunits                  = ['Byte', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB'];
        $unit                       = $byteunits[0];
        $number_thousands_separator = ',';
        $number_decimal_separator   = '.';

        for ($d = 6, $ex = 15; $d >= 1; $d--, $ex -= 3) {
            if (isset($byteunits[$d]) && $value >= $li * pow(10, $ex)) {
                $value = round($value / (pow(1024, $d) / $dh)) / $dh;
                $unit  = $byteunits[$d];
                break 1;
            } // end if
        } // end for

        if ($unit != $byteunits[0]) {
            $return_value = number_format($value, $comma, $number_decimal_separator, $number_thousands_separator);
        } else {
            $return_value = number_format($value, 0, $number_decimal_separator, $number_thousands_separator);
        }

        return [$return_value, $unit];
    } // end of the 'PMA_formatByteDown' function

    public function download_fname()
    {
        return $this->download_fname;
    }
    // end function
}