Backup and Restore: Added support for views (@oakstreet1)
[fa-stable.git] / admin / db / maintenance_db.inc
index d2a726075076fff7f0196e2f1f081f048ade47fa..ba4d089225e79ccdd2ae1ad6204c5f8ff89eed0d 100644 (file)
@@ -71,22 +71,23 @@ function write_config_db($new = false)
 
        if ($new)
                $tb_pref_counter++;
-       $n = count($db_connections);
        $msg = "<?php\n\n";
        $msg .= "/*Connection Information for the database\n";
        $msg .= "\$def_coy - the default company that is pre-selected on login\n\n";
        $msg .= "'host' - the computer ip address or name where the database is. The default is 'localhost' assuming that the web server is also the sql server.\n\n";
+       $msg .= "'port' - the computer port where the database is. The default is '3306'. Set empty for default.\n\n";
        $msg .= "'dbuser' - the user name under which the company database should be accessed.\n";
        $msg .= "  NB it is not secure to use root as the dbuser with no password - a user with appropriate privileges must be set up.\n\n";
        $msg .= "'dbpassword' - the password required for the dbuser to authorise the above database user.\n\n";
        $msg .= "'dbname' - the name of the database as defined in the RDMS being used. Typically RDMS allow many databases to be maintained under the same server.\n";
+       $msg .= "'collation' - the character set used for the database.\n";
        $msg .= "'tbpref' - prefix on table names, or '' if not used. Always use non-empty prefixes if multiply company use the same database.\n";
        $msg .= "*/\n\n\n";
 
        $msg .= "\$def_coy = " . $def_coy . ";\n\n";
        $msg .= "\$tb_pref_counter = " . $tb_pref_counter . ";\n\n";
        $msg .= "\$db_connections = " .var_export($db_connections, true);
-       $msg .= ";\n?>";
+       $msg .= ";\n";
 
        $filename = $path_to_root . "/config_db.php";
        // Check if the file exists and is writable first.
@@ -105,6 +106,7 @@ function write_config_db($new = false)
                        }
                        // Close file
                        fclose($zp);
+                       cache_invalidate($filename);
                }
        }
        else
@@ -142,7 +144,7 @@ function write_extensions($extensions=null, $company = -1)
 */\n\n";
 
        $msg .= "\$installed_extensions = ". var_export($extensions, true);
-       $msg .= ";\n?>";
+       $msg .= ";\n";
        $filename = $path_to_root . ($company==-1 ? '' : '/company/'.$company)
                .'/installed_extensions.php';
 
@@ -164,6 +166,7 @@ function write_extensions($extensions=null, $company = -1)
                }
                // Close file
                fclose($zp);
+               cache_invalidate($filename);
        }
        return true;
 }
@@ -180,7 +183,7 @@ function update_extensions($extensions) {
        }
 
        // update per company files
-       $cnt = max(1, count($db_connections));
+       $cnt = max(1, count_array($db_connections));
        for($i = 0; $i < $cnt; $i++) 
        {
                $newexts = $extensions;
@@ -207,7 +210,6 @@ function write_lang()
        global $path_to_root, $installed_languages, $dflt_lang;
 
        $installed_languages = array_natsort($installed_languages, 'code', 'code');
-       $n = count($installed_languages);
        $msg = "<?php\n\n";
 
        $msg .= "/* How to make new entries here for non-packaged languages:\n\n";
@@ -221,7 +223,7 @@ function write_lang()
 
        $msg .= "\$installed_languages = " . var_export($installed_languages, true);
        $msg .= ";\n";
-       $msg .= "\n\$dflt_lang = '$dflt_lang';\n?>\n";
+       $msg .= "\n\$dflt_lang = '$dflt_lang';\n";
 
        $path = $path_to_root . "/lang";
        $filename = $path.'/installed_languages.inc';
@@ -243,6 +245,7 @@ function write_lang()
                        }
                        // Close file
                        fclose($zp);
+                       cache_invalidate($filename);
                }
        }
        else
@@ -263,9 +266,10 @@ function write_lang()
 */
 function db_import($filename, $connection, $force=true, $init=true, $protect=false, $return_errors=false)
 {
-       global $db, $go_debug, $sql_trail;
+       global $db, $SysPrefs;
 
-       $sql_trail = false;
+       $trail = $SysPrefs->sql_trail;
+       $SysPrefs->sql_trail = false;
 
        $allowed_commands = array(
                "create"  => 'table_queries', 
@@ -277,6 +281,10 @@ function db_import($filename, $connection, $force=true, $init=true, $protect=fal
                "drop table if exists" => 'drop_queries',
                "drop function if exists" => 'drop_queries',
                "drop trigger if exists" => 'drop_queries',
+               "select" => 'data_queries', 
+               "delete" => 'data_queries',
+               "drop view if exists" => 'drop_queries',
+               "create view as" => 'data_queries'              //we should be able to create views after all tables have been created 
                );
 
        $protected = array(
@@ -299,14 +307,22 @@ function db_import($filename, $connection, $force=true, $init=true, $protect=fal
        $table_queries = array();
        $sql_errors = array();
 
-       $old_encoding = mysql_client_encoding();
+       $old_encoding = db_get_charset($db);
 
-       ini_set("max_execution_time", "180");
+       ini_set("max_execution_time", max("180", ini_get("max_execution_time")));
        db_query("SET foreign_key_checks=0");
-       // uncrompress gziped backup files
+       db_query("SET sql_mode=''");
+
+       if (isset($connection['collation']))
+               db_set_collation($db, $connection['collation']);
+
+       $check_line_len = false;
+
+       // uncompress gziped backup files
        if (strpos($filename, ".gz") || strpos($filename, ".GZ"))
-               $lines = db_ungzip("lines", $filename);
-       elseif (strpos($filename, ".zip") || strpos($filename, ".ZIP"))
+       {       $lines = db_ungzip("lines", $filename);
+               $check_line_len = true;
+       } elseif (strpos($filename, ".zip") || strpos($filename, ".ZIP"))
                $lines = db_unzip("lines", $filename);
        else
                $lines = file("". $filename);
@@ -317,8 +333,9 @@ function db_import($filename, $connection, $force=true, $init=true, $protect=fal
 
        foreach($lines as $line_no => $line)
        {
+               $gzfile_bug = $check_line_len && (strlen($line) == 8190); // there is a bug in php (at least 4.1.1-5.5.9) gzfile which limits line length to 8190 bytes!
+
                $line = trim($line);
-               
                if ($init)
                        $line = str_replace("0_", $connection["tbpref"], $line);
 
@@ -351,8 +368,7 @@ function db_import($filename, $connection, $force=true, $init=true, $protect=fal
                 if($query_table != '')  // inside allowed query
                 {
                        $table = $query_table;
-
-                       if (substr($line, -strlen($delimiter)) == $delimiter) // end of query found
+                       if (!$gzfile_bug && substr($line, -strlen($delimiter)) == $delimiter) // end of query found 
                        {
                                $line = substr($line, 0, strlen($line) - strlen($delimiter)); // strip delimiter
                                $query_table = '';
@@ -397,7 +413,7 @@ function db_import($filename, $connection, $force=true, $init=true, $protect=fal
                        $encoding = 'latin1'; // standard encoding on mysql client
        }
 
-       mysql_set_charset($encoding);
+       db_set_charset($db, $encoding);
 
 /*/    {       // for debugging purposes
        global $path_to_root;
@@ -411,8 +427,8 @@ function db_import($filename, $connection, $force=true, $init=true, $protect=fal
 /*/
        if ($return_errors)
        {       // prevent errors display
-               $save_debug = $go_debug;
-               $go_debug = 0;
+               $save_debug = $SysPrefs->go_debug;
+               $SysPrefs->go_debug = 0;
        }
        // execute drop tables if exists queries
        if (is_array($drop_queries))
@@ -455,12 +471,14 @@ function db_import($filename, $connection, $force=true, $init=true, $protect=fal
        }
 
        if ($return_errors)
-               $go_debug = $save_debug;
+               $SysPrefs->go_debug = $save_debug;
+
+       $SysPrefs->sql_trail = $trail;
 
        db_query("SET foreign_key_checks=1");
        if ($delimiter != ';') db_query("delimiter ;"); // just for any case
 
-       mysql_set_charset($old_encoding); // restore connection encoding
+       db_set_charset($db, $old_encoding); // restore connection encoding
 
        if (count($sql_errors)) {
                if ($return_errors)
@@ -528,33 +546,28 @@ function db_unzip($mode, $path)
        return explode("\n", $file_data);
 }
 
-function db_backup($conn, $ext='no', $comm='', $path=null)
+function db_backup($conn, $ext='no', $comm='', $path='')
 {
        if ($conn['tbpref'] != "")
                $filename = $conn['dbname'] . "_" . $conn['tbpref'] . date("Ymd_Hi") . ".sql";
        else
                $filename = $conn['dbname'] . "_" . date("Ymd_Hi") . ".sql";
 
-       if (!isset($path))
-               $path = BACKUP_PATH;
-
        return db_export($conn, $path . clean_file_name($filename), $ext, $comm);
 }
-//
 // Generates a dump of $db database
 //
 function db_export($conn, $filename, $zip='no', $comment='')
 {
 
-       global $app_title, $version, $power_url, $path_to_root;
+       global $SysPrefs, $version;
 
     $error = false;
     // set max string size before writing to file
     $max_size = 1048576 * 2; // 2 MB
     // changes max size if value can be retrieved
     if (ini_get("memory_limit"))
-       $max_size = 900000 * ini_get("memory_limit");
-
+       $max_size = 1048576 * (int)ini_get("memory_limit");
     // set backupfile name
     if ($zip == "gzip")
        $backupfile = $filename . ".gz";
@@ -570,8 +583,8 @@ function db_export($conn, $filename, $zip='no', $comment='')
     //create comment
     $out="# MySQL dump of database '".$conn["dbname"]."' on host '".$conn["host"]."'\n";
     $out.="# Backup Date and Time: ".date("Y-m-d H:i")."\n";
-    $out.="# Built by " . $app_title . " " . $version ."\n";
-    $out.="# ".$power_url."\n";
+    $out.="# Built by " . $SysPrefs->app_title . " " . $version ."\n";
+    $out.="# ".$SysPrefs->power_url."\n";
     $out.="# Company: ". @html_entity_decode($company, ENT_QUOTES, $_SESSION['language']->encoding)."\n";
     $out.="# User: ".$_SESSION["wa_current_user"]->name."\n\n";
     $out.="# Compatibility: ".get_company_pref('version_id')."\n\n";
@@ -587,8 +600,6 @@ function db_export($conn, $filename, $zip='no', $comment='')
                $out.="\n";
        }
 
-    //$out.="use ".$db.";\n"; we don't use this option.
-
        if (db_fixed())
        {
                db_set_encoding();
@@ -636,99 +647,119 @@ function db_export($conn, $filename, $zip='no', $comment='')
        {
                foreach ($all_tables as $row)
                {
-                       $tablename = $row['Name'];
-                       $auto_incr[$tablename] = $row['Auto_increment'];
-
-                       $out.="\n\n";
-                       // export tables
-                       $out.="### Structure of table `".$tablename."` ###\n\n";
-
-                       $out.="DROP TABLE IF EXISTS `".$tablename."`;\n\n";
-                       $out.=$table_sql[$tablename];
-
-                       // add auto_increment value
-//                     if ($auto_incr[$tablename])
-//                             $out.=" AUTO_INCREMENT=".$auto_incr[$tablename];
-                       $out.=" ;";
-                       $out.="\n\n";
-
-                       // export data
-                       if (!$error)
-                       {
-                               $out.="### Data of table `".$tablename."` ###\n";
-
-                               // check if field types are NULL or NOT NULL
-                               $res3 = db_query("SHOW COLUMNS FROM `" . $tablename . "`");
-
-                               $field_null = array();
-                               for ($j = 0; $j < db_num_rows($res3); $j++)
-                               {
-                                       $row3 = db_fetch($res3);
-                                       $field_null[] = $row3[2]=='YES' && $row3[4]===null;
-                               }
-
-                               $res2 = db_query("SELECT * FROM `" . $tablename . "`");
-                               $maxinsert = 0;
-                               $insert = '';
-                               for ($j = 0; $j < db_num_rows($res2); $j++)
+                       if (!empty($row['Engine'])) {   //don't export views like tables
+                               $tablename = $row['Name'];
+                               $auto_incr[$tablename] = $row['Auto_increment'];
+       
+                               $out.="\n\n";
+                               // export tables
+                               $out.="### Structure of table `".$tablename."` ###\n\n";
+       
+                               $out.="DROP TABLE IF EXISTS `".$tablename."`;\n\n";
+                               $out.=$table_sql[$tablename];
+       
+                               $out.=" ;";
+                               $out.="\n\n";
+       
+                               // export data
+                               if (!$error)
                                {
-                                       $row2 = db_fetch_row($res2);
-                                       $values = '(';
-                                       for ($k = 0; $k < $nf = db_num_fields($res2); $k++)
+                                       $out.="### Data of table `".$tablename."` ###\n";
+       
+                                       // check if field types are NULL or NOT NULL
+                                       $res3 = db_query("SHOW COLUMNS FROM `" . $tablename . "`");
+       
+                                       $field_null = array();
+                                       for ($j = 0; $j < db_num_rows($res3); $j++)
                                        {
-                                               $values .= db_escape($row2[$k], $field_null[$k]);
-                                               if ($k < ($nf - 1))
-                                                       $values .= ', ';
+                                               $row3 = db_fetch($res3);
+                                               $field_null[] = $row3[2]=='YES' && $row3[4]===null;
                                        }
-                                       $values .= ')';
-                                       $len = strlen($values);
-                                       if ($maxinsert < $len+1)
+       
+                                       $res2 = db_query("SELECT * FROM `" . $tablename . "`");
+                                       $maxinsert = 0;
+                                       $insert = '';
+                                       for ($j = 0; $j < db_num_rows($res2); $j++)
                                        {
-                                               $maxinsert = EXPORT_MAX_INSERT;
-                                               if ($insert)
+                                               $row2 = db_fetch_row($res2);
+                                               $values = '(';
+                                               for ($k = 0; $k < $nf = db_num_fields($res2); $k++)
                                                {
-                                                       $out .= $insert .';'; // flush insert query
-                                                       $insert = '';
+                                                       $values .= db_escape($row2[$k], $field_null[$k]);
+                                                       if ($k < ($nf - 1))
+                                                               $values .= ', ';
+                                               }
+                                               $values .= ')';
+                                               $len = strlen($values);
+                                               if ($maxinsert < $len+1)
+                                               {
+                                                       $maxinsert = EXPORT_MAX_INSERT;
+                                                       if ($insert)
+                                                       {
+                                                               $out .= $insert .';'; // flush insert query
+                                                               $insert = '';
+                                                       }
+                                               }
+       
+                                               if ($insert == '')
+                                               {
+                                                       $insert = "\nINSERT INTO `" . $tablename . "` VALUES\n";
+                                                       $maxinsert -= strlen($insert);
+                                               } else {
+                                                       $insert .= ",\n";
+                                               }
+       
+                                               $maxinsert -= $len;
+                                               $insert .= $values;
+       
+                                               // if saving is successful, then empty $out, else set error flag
+                                               if (strlen($out) > $max_size && $zip != "zip")
+                                               {
+                                                       if (save_to_file($backupfile, $zip, $out))
+                                                               $out = "";
+                                                       else
+                                                               $error = true;
                                                }
                                        }
-
-                                       if ($insert == '')
-                                       {
-                                               $insert = "\nINSERT INTO `" . $tablename . "` VALUES\n";
-                                               $maxinsert -= strlen($insert);
-                                       } else {
-                                               $insert .= ",\n";
-                                       }
-
-                                       $maxinsert -= $len;
-                                       $insert .= $values;
-
-                                       // if saving is successful, then empty $out, else set error flag
-                                       if (strlen($out) > $max_size && $zip != "zip")
-                                       {
-                                               if (save_to_file($backupfile, $zip, $out))
-                                                       $out = "";
-                                               else
-                                                       $error = true;
-                                       }
+                                       if ($insert)
+                                               $out .= $insert. ';';
+                               // an error occurred! Try to delete file and return error status
+                               }
+                               elseif ($error)
+                               {
+                                       @unlink($backupfile);
+                                       return false;
+                               }
+       
+                               // if saving is successful, then empty $out, else set error flag
+                               if (strlen($out) > $max_size && $zip != "zip")
+                               {
+                                       if (save_to_file($backupfile, $zip, $out))
+                                               $out= "";
+                                       else
+                                               $error = true;
+                               }
+                       }       //end if Engine set (not a view)
+               }
+               //process views last so all tables have been created before views are created
+               foreach ($all_tables as $row)
+               {
+                       if (empty($row['Engine'])) {
+                               $viewname = $row['Name'];
+                               $out .= "\n\nDROP VIEW IF EXISTS `".$viewname."`;\n";
+                               //db_get_view_schema() is in /includes/db/connect_db_mysqli.inc because it is mysql specific
+                               if (NULL !== ($schema = db_get_view_schema($viewname)))
+                               {
+                                       $out .= "CREATE VIEW `".$viewname."` AS ".$schema.";\n\n";
+                                       if (!save_to_file($backupfile, $zip, $out)) $error = true;
+                                       else $out = "";
+                               }
+                               else $error = true;
+                               
+                               if ($error) {
+                                       @unlink($backupfile);
+                                       return false;
                                }
-                               if ($insert)
-                                       $out .= $insert. ';';
-                       // an error occurred! Try to delete file and return error status
-                       }
-                       elseif ($error)
-                       {
-                               @unlink($backupfile);
-                               return false;
-                       }
-
-                       // if saving is successful, then empty $out, else set error flag
-                       if (strlen($out) > $max_size && $zip != "zip")
-                       {
-                               if (save_to_file($backupfile, $zip, $out))
-                                       $out= "";
-                               else
-                                       $error = true;
                        }
                }
 
@@ -740,8 +771,6 @@ function db_export($conn, $filename, $zip='no', $comment='')
                return false;
        }
 
-       //if ($zip == "zip")
-       //      $zip = $time;
        if (save_to_file($backupfile, $zip, $out))
        {
                $out = "";
@@ -807,7 +836,6 @@ function order_sql_tables($tables, $fks)
 // returns backup file name if name has changed (zip), else TRUE. If saving failed, return value is FALSE
 function save_to_file($path, $zip, $fileData)
 {
-       global $path_to_root;
 
        $backupfile = basename($path);
 
@@ -920,7 +948,7 @@ function save_to_file($path, $zip, $fileData)
 
 function create_comp_dirs($comp_path, $comp_subdirs)
 {
-               $index = "<?php\nheader(\"Location: ../index.php\");\n?>";
+               $index = "<?php\nheader(\"Location: ../index.php\");\n";
            $cdir = $comp_path;
            @mkdir($cdir);
                $f = @fopen("$cdir/index.php", "wb");
@@ -993,4 +1021,3 @@ function update_config_var($file, $variable, $value, $comment='')
 }
 
 
-?>
\ No newline at end of file