Rewritten extensions system to enable per company module/plugin
[fa-stable.git] / admin / db / maintenance_db.inc
index 4907366693dd5ec65069b4bc1eb09245be0e4c1b..18bcf3aad4aec88c7dcd71e6a3649d4379e1b672 100644 (file)
@@ -1,4 +1,58 @@
 <?php
+/**********************************************************************
+    Copyright (C) FrontAccounting, LLC.
+       Released under the terms of the GNU General Public License,
+       GPL, as published by the Free Software Foundation, either version 
+       3 of the License, or (at your option) any later version.
+    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.  
+    See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
+***********************************************************************/
+
+/**
+ * @return Returns the array sorted as required
+ * @param $aryData Array containing data to sort
+ * @param $strIndex name of column to use as an index
+ * @param $strSortBy Column to sort the array by
+ * @param $strSortType String containing either asc or desc [default to asc]
+ * @desc Naturally sorts an array using by the column $strSortBy
+ */
+function array_natsort($aryData, $strIndex, $strSortBy, $strSortType=false)
+{
+   //    if the parameters are invalid
+   if (!is_array($aryData) || !$strIndex || !$strSortBy)
+       //    return the array
+       return $aryData;
+
+   //    create our temporary arrays
+   $arySort = $aryResult = array();
+
+   //    loop through the array
+   foreach ($aryData as $aryRow)
+       //    set up the value in the array
+       $arySort[$aryRow[$strIndex]] = $aryRow[$strSortBy];
+
+   //    apply the natural sort
+   natsort($arySort);
+
+   //    if the sort type is descending
+   if ($strSortType=="desc")
+       //    reverse the array
+       arsort($arySort);
+
+   //    loop through the sorted and original data
+   foreach ($arySort as $arySortKey => $arySorted)
+       foreach ($aryData as $aryOriginal)
+           //    if the key matches
+           if ($aryOriginal[$strIndex]==$arySortKey)
+               //    add it to the output array
+               array_push($aryResult, $aryOriginal);
+
+   //    return the return
+   return $aryResult;
+}
+
 
 function write_config_db($new = false)
 {
@@ -66,6 +120,85 @@ function write_config_db($new = false)
        return 0;
 }
 
+function write_extensions($extensions=null, $company = null)
+{
+       global $path_to_root, $installed_extensions;
+
+       if (!isset($extensions)) {
+               $extensions = $installed_extensions;
+       }
+       
+       $exts = array_natsort($extensions, 'name', 'name');
+       $extensions = $exts;
+
+       $n = count($exts);
+
+       $msg = "<?php\n\n";
+       if ($company != -1)
+               $msg .=
+"/* List of installed additional modules and plugins. If adding extensions at the beginning 
+       of the list, make sure it's index is set to 0 (it has ' 0 => ');
+       
+       'name' - name for identification purposes;
+       'type' - type of extension: 'module' or 'plugin'
+       'path' - FA root based installation path
+       'filename' - name of module menu file, or plugin filename; related to path.
+       'tab' - index of the module tab (new for module, or one of standard module names for plugin);
+       'title' - is the menu text (for plugin) or new tab name
+       'active' - current status of extension
+       'acc_file' - (optional) file name with \$security_areas/\$security_sections extensions; 
+               related to 'path'.
+*/\n\n";
+       else 
+               $msg .=
+"/*
+       Do not edit this file manually. This copy of global file is overwritten
+       by extensions editor.
+*/\n\n";
+
+       $msg .= "\$installed_extensions = array (\n";
+       if ($n > 0)
+           $msg .= "\t0 => ";
+       for ($i = 0; $i < $n; $i++)
+       {
+               if ($i > 0)
+                       $msg .= "\t\t";
+               $msg .= "array ( ";
+               $t = '';
+               foreach($extensions[$i] as $key => $val) {
+                       $msg .= $t."'$key' => '$val',\n";
+                       $t = "\t\t\t";
+               }
+               $msg .= "\t\t),\n";
+       }
+       $msg .= "\t);\n?>";
+
+       $filename = $path_to_root . (isset($company) ? '/company/'.$company : '')
+               .'/installed_extensions.php';
+
+       // Check if the file is writable first.
+       if (!$zp = @fopen($filename, 'w'))
+       {
+               display_error(sprintf(_("Cannot open the extension setup file '%s' for writing."),
+                        $filename));
+               return false;
+       }
+       else
+       {
+               if (!fwrite($zp, $msg))
+               {
+                       display_error(sprintf(_("Cannot write to the extensions setup file '%s'."),
+                               $filename));
+                       fclose($zp);
+                       return false;
+               }
+               // Close file
+               fclose($zp);
+       }
+       return true;
+}
+
+
 function db_create_db($connection)
 {
        $db = mysql_connect($connection["host"] ,
@@ -82,6 +215,7 @@ function db_create_db($connection)
 
 function db_drop_db($connection)
 {
+
        if ($connection["tbpref"] == "")
        {
                $sql = "DROP DATABASE " . $connection["dbname"] . "";
@@ -104,88 +238,91 @@ function db_drop_db($connection)
        }
 }
 
-function db_import($filename, $connection)
+function db_import($filename, $connection, $force=true)
 {
+       global $db, $go_debug;
+       
+       $allowed_commands = array(
+               "create"  => 'table_queries', 
+               "alter table" => 'table_queries', 
+               "insert" => 'data_queries', 
+               "update" => 'data_queries', 
+               "drop table if exists" => 'drop_queries');
+       $ignored_mysql_errors = array( //errors ignored in normal (non forced) mode
+               '1022', // duplicate key
+               '1050', // Table %s already exists
+               '1060', // duplicate column name
+               '1061', // duplicate key name
+               '1062', // duplicate key entry
+               '1091'  // can't drop key/column check if exists
+       );
        $data_queries = array();
        $drop_queries = array();
        $table_queries = array();
+       $sql_errors = array();
+
+       ini_set("max_execution_time", "180");
+       db_query("SET foreign_key_checks=0");
 
        // uncrompress gziped backup files
-       if (strpos($filename, ".gzip") || strpos($filename, ".GZIP"))
+       if (strpos($filename, ".gz") || strpos($filename, ".GZ"))
                $lines = db_ungzip("lines", $filename);
        elseif (strpos($filename, ".zip") || strpos($filename, ".ZIP"))
                $lines = db_unzip("lines", $filename);
        else
                $lines = file("". $filename);
 
-       // divide insert and create sql queries
-       // $table is set to TRUE if the next line belongs to a create sql query
-       $table = false;
-       foreach($lines as $line)
+       // parse input file
+       $query_table = '';
+       foreach($lines as $line_no => $line)
        {
                $line = trim($line);
-
+               
                $line = str_replace("0_", $connection["tbpref"], $line);
-               // $line = str_replace("Y_", "0_", $line);
-               // the last line did not belong to a 'create' sql query
-               if (!$table)
-               {
 
-                       // this line does not, too
-                       if (strtolower(substr($line,0,6)) == "insert")
+               if ($query_table == '') 
+               {       // check if line begins with one of allowed queries
+                       foreach($allowed_commands as $cmd => $table) 
                        {
-                               $data_queries[] = substr($line, 0, strlen($line) - 1);
-
-                       // this line does not, too
-                       }
-                       elseif (strtolower(substr($line,0,6)) == "update")
-                       {
-                               $data_queries[] = substr($line, 0, strlen($line) - 1);
-
-                       // this line does not, too
-                       }
-                       elseif (strtolower(substr($line, 0, 20)) == "drop table if exists")
-                       {
-                               $drop_queries[] = substr($line, 0, strlen($line) - 1);
-
-                       // this line does!
-                       }
-                       elseif (strtolower(substr($line, 0, 6)) == "create")
-                       {
-                               $table = true;
-                               $table_queries[] = $line . "\n";
-                       }
-                       elseif (strtolower(substr($line, 0, 11)) == "alter table")
+                               if (strtolower(substr($line, 0, strlen($cmd))) == $cmd) 
+                               {
+                                       $query_table = $table;
+                                       ${$query_table}[] = array('', $line_no+1);
+                                       break;
+                               }
+                       }
+                }
+                if($query_table != '')  // inside allowed query
+                {
+                       $table = $query_table;
+                       if (substr($line, -1) == ';') // end of query found
                        {
-                               $data_queries[] = substr($line, 0, strlen($line) - 1);
+                               $line = substr($line, 0, strlen($line) - 1); // strip ';'
+                               $query_table = '';
                        }
-
-               // the current line belongs to a create sql query
-               }
-               else
-               {
-
-                       // create sql query ending in this line
-                       if (strtolower(substr($line, 0, 1)) == ")") {
-                               $table = false;
-                               $line = substr($line,0,strlen($line)-1);
-                 }
-                       $table_queries[count($table_queries) - 1] .= $line . "\n";
+                       ${$table}[count(${$table}) - 1][0] .= $line . "\n";
                }
+               
        }
-
-       $sql_error = false;
-
+/*
+       {       // for debugging purposes
+       global $path_to_root;
+       $f = fopen($path_to_root.'/tmp/dbimport.txt', 'w+');
+       fwrite($f, print_r($drop_queries,true) ."\n");
+       fwrite($f, print_r($table_queries,true) ."\n");
+       fwrite($f, print_r($data_queries,true));
+       fclose($f);
+       }
+*/
        // execute drop tables if exists queries
        if (is_array($drop_queries))
        {
                foreach($drop_queries as $drop_query)
                {
-                       $sql_error = false;
-                       if (!db_query($drop_query))
+                       if (!db_query($drop_query[0]))
                        {
-                               $sql_error = true;
-                               //if ($CONF['import_error']) echo nl2br($drop_query)."\n<div class=\"bold_left\">".mysql_error()."</div><br>\n";
+                               if (!in_array(db_error_no(), $ignored_mysql_errors) || !$force)
+                                       $sql_errors[] = array(db_error_msg($db), $drop_query[1]);
                        }
                }
        }
@@ -195,11 +332,11 @@ function db_import($filename, $connection)
        {
                foreach($table_queries as $table_query)
                {
-                       $sql_error = false;
-                       if (!db_query($table_query))
-                       {
-                               $sql_error = true;
-                               //if ($CONF['import_error']) echo nl2br($table_query)."\n<div class=\"bold_left\">".mysql_error()."</div><br>\n";
+                       if (!db_query($table_query[0]))
+                       {       
+                               if (!in_array(db_error_no(), $ignored_mysql_errors) || !$force) {
+                                       $sql_errors[] = array(db_error_msg($db), $table_query[1]);
+                               }
                        }
                }
        }
@@ -209,23 +346,24 @@ function db_import($filename, $connection)
        {
                foreach($data_queries as $data_query)
                {
-                       $sql_error = false;
-                       if (!db_query($data_query))
+                       if (!db_query($data_query[0]))
                        {
-                               //if ($CONF['import_error']) echo $data_query."\n<div class=\"bold_left\">".mysql_error()."</div><br>\n";
-                               $sql_error = true;
-                               return false;
+                               if (!in_array(db_error_no(),$ignored_mysql_errors) || !$force)
+                                       $sql_errors[] = array(db_error_msg($db), $data_query[1]);
                        }
                }
        }
-
-       // show number successful executed querys or if an error did occur
-       if ($sql_error == 1)
+       
+       db_query("SET foreign_key_checks=1");
+
+       if (count($sql_errors)) {
+               // display first failure message; the rest are probably derivative 
+               $err = $sql_errors[0];
+               display_error(sprintf(_("SQL script execution failed in line %d: %s"),
+                       $err[1], $err[0]));
                return false;
-               //echo "<div class=\"red\">".IM_ERROR.".</div>\n";
-       else
+       } else
                return true;
-               //echo "<div class=\"green\">".IM_SUCCESS." ".count($table_queries)." ".IM_TABLES." ".count($data_queries)." ".IM_ROWS." (".$import_file.")</div>\n";
        //$shell_command = C_MYSQL_PATH . " -h $host -u $user -p{$password} $dbname < $filename";
        //shell_exec($shell_command);
 }
@@ -252,26 +390,24 @@ function db_unzip($mode, $path)
     $filename = substr($filename, 0, strlen($filename) - 4);
 
     // compare filname in zip and filename from $_GET
-    if (substr($all, 30, strlen($filename)) != $filename)
-    {
-               return '';
-        // exit if names differ
-        //echo F_WRONG_FILE.".";
-        //exit;
+    if (substr($all, 30, strlen($filename)-4) . substr($all, 30+strlen($filename)+9, 4)
+         != $filename) {
+               return '';     // exit if names differ
     }
     else
     {
        // get the suffix of the filename in hex
-        $crc_bugfix = substr(substr($filename, 0, strlen($filename) - 4), strlen($filename) - 12 - 4);
+               $crc_bugfix = substr($all, 30, strlen($filename)+13);
+        $crc_bugfix = substr(substr($crc_bugfix, 0, strlen($crc_bugfix) - 4), 
+                               strlen($crc_bugfix) - 12 - 4);
         $suffix = false;
-
         // convert hex to ascii
         for ($i=0; $i < 12; )
                $suffix .= chr($crc_bugfix[$i++] . $crc_bugfix[$i++] . $crc_bugfix[$i++]);
 
         // remove central directory information (we have always just one ziped file)
-        $comp = substr($all, -(strlen($all) - 30 - strlen($filename)));
-        $comp = substr($comp, 0, (strlen($comp) - 80 - strlen($filename)));
+        $comp = substr($all, -(strlen($all) - 30 - strlen($filename)-13));
+        $comp = substr($comp, 0, (strlen($comp) - 80 - strlen($filename)-13));
 
         // fix the crc bugfix (see function save_to_file)
         $comp = "x\9c" . $comp . $suffix;
@@ -285,15 +421,24 @@ function db_unzip($mode, $path)
        return explode("\n", $file_data);
 }
 
+function db_backup($conn, $ext='no', $comm='', $tbpref = TB_PREF)
+{
+       if ($conn['tbpref'] != "")
+               $filename = $conn['dbname'] . "_" . $conn['tbpref'] . date("Ymd_Hi") . ".sql";
+       else
+               $filename = $conn['dbname'] . "_" . date("Ymd_Hi") . ".sql";
+
+       return db_export($conn, $filename, $ext, $comm, $tbpref);
+}
+
 // generates a dump of $db database
 // $drop and $zip tell if to include the drop table statement or dry to pack
-function db_export($conn, $filename, $zip='no', $comment='')
+function db_export($conn, $filename, $zip='no', $comment='', $tbpref = TB_PREF)
 {
 
        global $app_title, $version, $power_url, $path_to_root;
 
     $error = false;
-
     // set max string size before writing to file
     $max_size = 1048576 * 2; // 2 MB
     // changes max size if value can be retrieved
@@ -307,13 +452,14 @@ function db_export($conn, $filename, $zip='no', $comment='')
        $backupfile = $filename . ".zip";
     else
        $backupfile = $filename;
-    $company = get_company_pref('coy_name');
+    $company = get_company_pref('coy_name', $tbpref);
+
     //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.="# Company: ".$company."\n";
+    $out.="# Company: ". @html_entity_decode($company, ENT_COMPAT, $_SESSION['language']->encoding)."\n";
     $out.="# User: ".$_SESSION["wa_current_user"]->name."\n\n";
 
        // write users comment
@@ -411,11 +557,7 @@ function db_export($conn, $filename, $zip='no', $comment='')
                                        // run through each field
                                        for ($k = 0; $k < $nf = db_num_fields($res2); $k++)
                                        {
-                                               // identify null values and save them as null instead of ''
-                                               if ($field_type[$k] != "" && $field_type[$k] != "NO" && $row2[$k] == "")
-                                                       $out .= "NULL";
-                                               else
-                                                       $out .= "'" . db_escape($row2[$k]) . "'";
+                                               $out .= db_escape(@html_entity_decode($row2[$k], ENT_COMPAT, $_SESSION['language']->encoding));
                                                if ($k < ($nf - 1))
                                                        $out .= ", ";
                                        }
@@ -557,13 +699,14 @@ function save_to_file($backupfile, $zip, $fileData)
         $crc = crc32($fileData);
         $zdata = gzcompress($fileData);
 
-        // string needed for decoding (because of crc bug)
-        //$name_suffix = substr($zdata, -4, 4);
-        //$name_suffix2 = "_";
-        //for ($i = 0; $i < 4; $i++)
-        //     $name_suffix2 .= sprintf("%03d", ord($name_suffix[$i]));
-        //$backupfile = substr($backupfile, 0, strlen($backupfile) - 8) . $name_suffix2 . ".sql.zip";
-        $name = substr($backupfile, 0, strlen($backupfile) -4);
+               // extend stored file name with suffix
+        // needed for decoding (because of crc bug)
+        $name_suffix = substr($zdata, -4, 4);
+        $name_suffix2 = "_";
+        for ($i = 0; $i < 4; $i++)
+               $name_suffix2 .= sprintf("%03d", ord($name_suffix[$i]));
+
+       $name = substr($backupfile, 0, strlen($backupfile) - 8) . $name_suffix2 . ".sql";
 
         // fix crc bug
         $zdata = substr(substr($zdata, 0, strlen($zdata) - 4), 2);
@@ -635,5 +778,21 @@ function save_to_file($backupfile, $zip, $fileData)
     }
 }
 
-
+function create_comp_dirs($comp_path, $comp_subdirs)
+{
+               $index = "<?php\nheader(\"Location: ../index.php\");\n?>";
+           $cdir = $comp_path;
+           @mkdir($cdir);
+               $f = @fopen("$cdir/index.php", "wb");
+               @fwrite($f, $index);
+               @fclose($f);
+
+           foreach($comp_subdirs as $dir)
+           {
+                       @mkdir($cdir.'/'.$dir);
+                       $f = @fopen("$cdir/$dir/index.php", "wb");
+                       @fwrite($f, $index);
+                       @fclose($f);
+           }
+}
 ?>
\ No newline at end of file