Fixed db_import to allow select/delete queries in upgrade files.
[fa-stable.git] / admin / db / maintenance_db.inc
1 <?php
2 /**********************************************************************
3     Copyright (C) FrontAccounting, LLC.
4         Released under the terms of the GNU General Public License,
5         GPL, as published by the Free Software Foundation, either version 
6         3 of the License, or (at your option) any later version.
7     This program is distributed in the hope that it will be useful,
8     but WITHOUT ANY WARRANTY; without even the implied warranty of
9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
10     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
11 ***********************************************************************/
12
13 /**
14  * @return Returns the array sorted as required
15  * @param $aryData Array containing data to sort
16  * @param $strIndex name of column to use as an index
17  * @param $strSortBy Column to sort the array by
18  * @param $strSortType String containing either asc or desc [default to asc]
19  * @desc Naturally sorts an array using by the column $strSortBy
20  */
21 define('EXPORT_MAX_INSERT', 50000);
22
23 function array_natsort($aryData, $strIndex, $strSortBy, $strSortType=false)
24 {
25    //    if the parameters are invalid
26    if (!is_array($aryData) || !$strSortBy)
27        //    return the array
28        return $aryData;
29
30    //    create our temporary arrays
31    $arySort = $aryResult = array();
32
33    //    loop through the array
34    foreach ($aryData as $key => $aryRow)
35        //    set up the value in the array
36        $arySort[$strIndex ? $aryRow[$strIndex] : $key] = $aryRow[$strSortBy];
37
38    //    apply the natural sort
39    natsort($arySort);
40
41    //    if the sort type is descending
42    if ($strSortType=="desc")
43        //    reverse the array
44        arsort($arySort);
45
46    //    loop through the sorted and original data
47                 foreach ($arySort as $arySortKey => $arySorted)
48                         if($strIndex) 
49                         {
50                                 foreach ($aryData as $aryOriginal)
51                                 // if the key matches
52                                         if ($aryOriginal[$strIndex]==$arySortKey)
53                                                 // add it to the output array
54                                                 array_push($aryResult, $aryOriginal);
55                         } else
56                                 $aryResult[$arySortKey] = $aryData[$arySortKey];
57    //    return the return
58    return $aryResult;
59 }
60
61 function update_admin_password($conn, $password)
62 {
63         $sql = "UPDATE ".$conn['tbpref']."users SET password=".db_escape($password) . "
64                 WHERE user_id='admin'";
65         db_query($sql, "could not update user password for 'admin'");
66 }
67
68 function write_config_db($new = false)
69 {
70         global $path_to_root, $def_coy, $db_connections, $tb_pref_counter;
71
72         if ($new)
73                 $tb_pref_counter++;
74         $n = count($db_connections);
75         $msg = "<?php\n\n";
76         $msg .= "/*Connection Information for the database\n";
77         $msg .= "\$def_coy - the default company that is pre-selected on login\n\n";
78         $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";
79         $msg .= "'dbuser' - the user name under which the company database should be accessed.\n";
80         $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";
81         $msg .= "'dbpassword' - the password required for the dbuser to authorise the above database user.\n\n";
82         $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";
83         $msg .= "'tbpref' - prefix on table names, or '' if not used. Always use non-empty prefixes if multiply company use the same database.\n";
84         $msg .= "*/\n\n\n";
85
86         $msg .= "\$def_coy = " . $def_coy . ";\n\n";
87         $msg .= "\$tb_pref_counter = " . $tb_pref_counter . ";\n\n";
88         $msg .= "\$db_connections = " .var_export($db_connections, true);
89         $msg .= ";\n";
90
91         $filename = $path_to_root . "/config_db.php";
92         // Check if the file exists and is writable first.
93         if ((!file_exists($filename) && is_writable($path_to_root)) || is_writable($filename))
94         {
95                 if (!$zp = fopen($filename, 'w'))
96                 {
97                         return -1;
98                 }
99                 else
100                 {
101                         if (!fwrite($zp, $msg))
102                         {
103                                 fclose($zp);
104                                 return -2;
105                         }
106                         // Close file
107                         fclose($zp);
108                 }
109         }
110         else
111         {
112                 return -3;
113         }
114         return 0;
115 }
116
117 function write_extensions($extensions=null, $company = -1)
118 {
119         global $path_to_root, $installed_extensions, $next_extension_id;
120
121         if (!isset($extensions)) {
122                 $extensions = $installed_extensions;
123         }
124         if (!isset($next_extension_id)) {
125                 $next_extension_id = 1;
126         }
127
128         $msg = "<?php\n\n";
129         if ($company == -1)
130                 $msg .=
131 "/* List of installed additional extensions. If extensions are added to the list manually
132         make sure they have unique and so far never used extension_ids as a keys,
133         and \$next_extension_id is also updated. More about format of this file yo will find in 
134         FA extension system documentation.
135 */
136 \n\$next_extension_id = $next_extension_id; // unique id for next installed extension\n\n";
137         else 
138                 $msg .=
139 "/*
140         Do not edit this file manually. This copy of global file is overwritten
141         by extensions editor.
142 */\n\n";
143
144         $msg .= "\$installed_extensions = ". var_export($extensions, true);
145         $msg .= ";\n";
146         $filename = $path_to_root . ($company==-1 ? '' : '/company/'.$company)
147                 .'/installed_extensions.php';
148
149         // Check if the file is writable first.
150         if (!$zp = @fopen($filename, 'w'))
151         {
152                 display_error(sprintf(_("Cannot open the extension setup file '%s' for writing."),
153                          $filename));
154                 return false;
155         }
156         else
157         {
158                 if (!fwrite($zp, $msg))
159                 {
160                         display_error(sprintf(_("Cannot write to the extensions setup file '%s'."),
161                                 $filename));
162                         fclose($zp);
163                         return false;
164                 }
165                 // Close file
166                 fclose($zp);
167         }
168         return true;
169 }
170 //---------------------------------------------------------------------------------------------
171 //
172 // Update per-company list of installed extensions
173 //
174 function update_extensions($extensions) {
175         global $db_connections;
176         
177         if (!write_extensions($extensions)) {
178                 display_notification(_("Cannot update system extensions list."));
179                 return false;
180         }
181
182         // update per company files
183         $cnt = max(1, count($db_connections));
184         for($i = 0; $i < $cnt; $i++) 
185         {
186                 $newexts = $extensions;
187                 // update 'active' status 
188                 $exts = get_company_extensions($i);
189                 foreach ($exts as $key => $ext) 
190                 {
191                         if (isset($newexts[$key]))
192                                 $newexts[$key]['active'] = $exts[$key]['active'];
193                 }
194                 if(!write_extensions($newexts, $i)) 
195                 {
196                         display_notification(sprintf(_("Cannot update extensions list for company '%s'."),
197                                 $db_connections[$i]['name']));
198                  return false;
199                 }
200         }
201         return true;
202 }
203
204
205 function write_lang()
206 {
207         global $path_to_root, $installed_languages, $dflt_lang;
208
209         $installed_languages = array_natsort($installed_languages, 'code', 'code');
210         $n = count($installed_languages);
211         $msg = "<?php\n\n";
212
213         $msg .= "/* How to make new entries here for non-packaged languages:\n\n";
214         $msg .= "-- 'code' should match the name of the directory for the language under \\lang\n.";
215         $msg .= "-- 'name' is the name that will be displayed in the language selection list (in Users and Display Setup)\n";
216         $msg .= "-- 'rtl' only needs to be set for right-to-left languages like Arabic and Hebrew\n";
217         $msg .= "-- 'encoding' used in translation file\n";
218         $msg .= "-- 'version' always set to '' for manually installed languages.\n";
219         $msg .= "-- 'path' installation path related to FA root (e.g. 'lang/en_US').\n";
220         $msg .= "*/\n\n\n";
221
222         $msg .= "\$installed_languages = " . var_export($installed_languages, true);
223         $msg .= ";\n";
224         $msg .= "\n\$dflt_lang = '$dflt_lang';\n";
225
226         $path = $path_to_root . "/lang";
227         $filename = $path.'/installed_languages.inc';
228         // Check if directory exists and is writable first.
229         if (file_exists($path) && is_writable($path))
230         {
231                 if (!$zp = fopen($filename, 'w'))
232                 {
233                         display_error(_("Cannot open the languages file - ") . $filename);
234                         return false;
235                 }
236                 else
237                 {
238                         if (!fwrite($zp, $msg))
239                         {
240                                 display_error(_("Cannot write to the language file - ") . $filename);
241                                 fclose($zp);
242                                 return false;
243                         }
244                         // Close file
245                         fclose($zp);
246                 }
247         }
248         else
249         {
250                 display_error(_("The language files folder ") . $path . _(" is not writable. Change its permissions so it is, then re-run the operation."));
251                 return false;
252         }
253         return true;
254 }
255 /*
256         Database import:
257                 $filename - sql file name
258                 $connection - database connection
259                 $force - ignore duplicate errors
260                 $init - presume $filename is initialization file with '0_' prefix
261                 $protect - protect users/roles 
262                 $return_errors - return errors instead of display them
263 */
264 function db_import($filename, $connection, $force=true, $init=true, $protect=false, $return_errors=false)
265 {
266         global $db, $SysPrefs;
267
268         $trail = $SysPrefs->sql_trail;
269         $SysPrefs->sql_trail = false;
270
271         $allowed_commands = array(
272                 "create"  => 'table_queries', 
273                 "delimiter" => 'table_queries',
274                 "alter table" => 'table_queries', 
275                 "insert" => 'data_queries', 
276                 "update" => 'data_queries', 
277                 "set names" => 'set_names',
278                 "drop table if exists" => 'drop_queries',
279                 "drop function if exists" => 'drop_queries',
280                 "drop trigger if exists" => 'drop_queries',
281                 "select" => 'data_queries', 
282                 "delete" => 'data_queries', 
283                 );
284
285         $protected = array(
286                 'security_roles',
287                 'users'
288         );
289
290         $ignored_mysql_errors = array( //errors ignored in normal (non forced) mode
291                 '1022', // duplicate key
292                 '1050', // Table %s already exists
293                 '1060', // duplicate column name
294                 '1061', // duplicate key name
295                 '1062', // duplicate key entry
296                 '1091'  // can't drop key/column check if exists
297         );
298
299         $set_names = array();
300         $data_queries = array();
301         $drop_queries = array();
302         $table_queries = array();
303         $sql_errors = array();
304
305         $old_encoding = db_get_charset($db);
306
307         ini_set("max_execution_time", "180");
308         db_query("SET foreign_key_checks=0");
309         $check_line_len = false;
310
311         // uncompress gziped backup files
312         if (strpos($filename, ".gz") || strpos($filename, ".GZ"))
313         {       $lines = db_ungzip("lines", $filename);
314                 $check_line_len = true;
315         } elseif (strpos($filename, ".zip") || strpos($filename, ".ZIP"))
316                 $lines = db_unzip("lines", $filename);
317         else
318                 $lines = file("". $filename);
319
320         // parse input file
321         $query_table = '';
322         $delimiter = ';';
323
324         foreach($lines as $line_no => $line)
325         {
326                 $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!
327
328                 $line = trim($line);
329                 if ($init)
330                         $line = str_replace("0_", $connection["tbpref"], $line);
331
332                 if ($query_table == '') 
333                 {       // check if line begins with one of allowed queries
334                         foreach($allowed_commands as $cmd => $table) 
335                         {
336                                 if (strtolower(substr($line, 0, strlen($cmd))) == $cmd) 
337                                 {
338                                         if ($cmd == 'delimiter') {
339                                                 $delimiter = trim(substr($line, 10));
340                                                 continue 2;
341                                         }
342                                         $query_table = $table;
343                                         $skip = false;
344                                         if ($protect)
345                                         {
346                                                 foreach($protected as $protbl)
347                                                         if (strpos($line, $connection["tbpref"].$protbl) !== false)
348                                                         {
349                                                                 $skip = true; break;
350                                                         }
351                                         }
352                                         if (!$skip)
353                                                 ${$query_table}[] = array('', $line_no+1);
354                                         break;
355                                 }
356                         }
357                  }
358                  if($query_table != '')  // inside allowed query
359                  {
360                         $table = $query_table;
361                         if (!$gzfile_bug && substr($line, -strlen($delimiter)) == $delimiter) // end of query found 
362                         {
363                                 $line = substr($line, 0, strlen($line) - strlen($delimiter)); // strip delimiter
364                                 $query_table = '';
365                         }
366                         if (!$skip)
367                                 ${$table}[count(${$table}) - 1][0] .= $line . "\n";
368                 }
369
370         }
371
372         //
373         // 'set names' or equivalents should be used only on post 2.3 FA versions
374         // otherwise text encoding can be broken during import
375         //
376         $encoding = null; // UI encoding for default site language is the default
377         $new_db = $init || db_fixed();
378         $new_file = count($set_names);
379         if ($new_db)
380         {
381                 if ($new_file)
382                 {
383                         if (count($set_names)) // standard db restore
384                         {
385                                 if (preg_match('/set\s*names\s*[\']?(\w*)[\']?/i', $set_names[0][0], $match))
386                                         $encoding = $match[1];
387                         }
388                         // otherwise use default site ui encoding
389                 }
390         }
391         else
392         {
393                 if ($new_file) // import on old db is forbidden: this would destroy db content unless latin1 was used before in UI
394                 {
395                         $msg = _("This is new format backup file which cannot be restored on database not migrated to utf8.");
396                         if ($return_errors)
397                                 return $msg;
398                         else
399                                 display_error($msg);
400                         return false;
401                 }
402                  else   // backup restore during upgrade failure
403                         $encoding = 'latin1'; // standard encoding on mysql client
404         }
405
406         db_set_charset($db, $encoding);
407
408 /*/     {       // for debugging purposes
409         global $path_to_root;
410         $f = fopen($path_to_root.'/tmp/dbimport.txt', 'w+');
411         fwrite($f, print_r($set_names,true) ."\n");
412         fwrite($f, print_r($drop_queries,true) ."\n");
413         fwrite($f, print_r($table_queries,true) ."\n");
414         fwrite($f, print_r($data_queries,true));
415         fclose($f);
416         }
417 /*/
418         if ($return_errors)
419         {       // prevent errors display
420                 $save_debug = $SysPrefs->go_debug;
421                 $SysPrefs->go_debug = 0;
422         }
423         // execute drop tables if exists queries
424         if (is_array($drop_queries))
425         {
426                 foreach($drop_queries as $drop_query)
427                 {
428                         if (!db_query($drop_query[0]))
429                         {
430                                 if (!in_array(db_error_no(), $ignored_mysql_errors) || !$force)
431                                         $sql_errors[] = array(db_error_msg($db), $drop_query[1]);
432                         }
433                 }
434         }
435
436         // execute create tables queries
437         if (is_array($table_queries))
438         {
439                 foreach($table_queries as $table_query)
440                 {
441                         if (!db_query($table_query[0]))
442                         {       
443                                 if (!in_array(db_error_no(), $ignored_mysql_errors) || !$force) {
444                                         $sql_errors[] = array(db_error_msg($db), $table_query[1]);
445                                 }
446                         }
447                 }
448         }
449
450         // execute insert data queries
451         if (is_array($data_queries))
452         {
453                 foreach($data_queries as $data_query)
454                 {
455                         if (!db_query($data_query[0]))
456                         {
457                                 if (!in_array(db_error_no(),$ignored_mysql_errors) || !$force)
458                                         $sql_errors[] = array(db_error_msg($db), $data_query[1]);
459                         }
460                 }
461         }
462
463         if ($return_errors)
464                 $SysPrefs->go_debug = $save_debug;
465
466         $SysPrefs->sql_trail = $trail;
467
468         db_query("SET foreign_key_checks=1");
469         if ($delimiter != ';') db_query("delimiter ;"); // just for any case
470
471         db_set_charset($db, $old_encoding); // restore connection encoding
472
473         if (count($sql_errors)) {
474                 if ($return_errors)
475                         return $sql_errors;
476
477                 // display first failure message; the rest are probably derivative 
478                 $err = $sql_errors[0];
479                 display_error(sprintf(_("SQL script execution failed in line %d: %s"),
480                         $err[1], $err[0]));
481                 return false;
482         } else
483                 return true;
484 }
485
486 // returns the content of the gziped $path backup file. use of $mode see below
487 function db_ungzip($mode, $path)
488 {
489     $file_data = gzfile($path);
490     // returns one string or an array of lines
491     if ($mode != "lines")
492         return implode("",$file_data);
493     else
494         return $file_data;
495 }
496
497 // returns the content of the ziped $path backup file. use of $mode see below
498 function db_unzip($mode, $path)
499 {
500     $all = false;
501     $all = implode("", file($path));
502
503     // convert path to name of ziped file
504     $filename = preg_replace("/.*\//", "", $path);
505     $filename = substr($filename, 0, strlen($filename) - 4);
506
507     // compare filname in zip and filename from $_GET
508     if (substr($all, 30, strlen($filename)-4) . substr($all, 30+strlen($filename)+9, 4)
509           != $filename) {
510                 return '';     // exit if names differ
511     }
512     else
513     {
514         // get the suffix of the filename in hex
515                 $crc_bugfix = substr($all, 30, strlen($filename)+13);
516         $crc_bugfix = substr(substr($crc_bugfix, 0, strlen($crc_bugfix) - 4), 
517                                 strlen($crc_bugfix) - 12 - 4);
518         $suffix = false;
519         // convert hex to ascii
520         for ($i=0; $i < 12; )
521                 $suffix .= chr($crc_bugfix[$i++] . $crc_bugfix[$i++] . $crc_bugfix[$i++]);
522
523         // remove central directory information (we have always just one ziped file)
524         $comp = substr($all, -(strlen($all) - 30 - strlen($filename)-13));
525         $comp = substr($comp, 0, (strlen($comp) - 80 - strlen($filename)-13));
526
527         // fix the crc bugfix (see function save_to_file)
528         $comp = "x\9c" . $comp . $suffix;
529         $file_data = gzuncompress($comp);
530     }
531
532     // returns one string or an array of lines
533     if ($mode != "lines")
534         return $file_data;
535     else
536         return explode("\n", $file_data);
537 }
538
539 function db_backup($conn, $ext='no', $comm='', $path='')
540 {
541         if ($conn['tbpref'] != "")
542                 $filename = $conn['dbname'] . "_" . $conn['tbpref'] . date("Ymd_Hi") . ".sql";
543         else
544                 $filename = $conn['dbname'] . "_" . date("Ymd_Hi") . ".sql";
545
546         return db_export($conn, $path . clean_file_name($filename), $ext, $comm);
547 }
548 //
549 // Generates a dump of $db database
550 //
551 function db_export($conn, $filename, $zip='no', $comment='')
552 {
553
554         global $SysPrefs, $version;
555
556     $error = false;
557     // set max string size before writing to file
558     $max_size = 1048576 * 2; // 2 MB
559     // changes max size if value can be retrieved
560     if (ini_get("memory_limit"))
561         $max_size = 900000 * ini_get("memory_limit");
562
563     // set backupfile name
564     if ($zip == "gzip")
565         $backupfile = $filename . ".gz";
566     elseif ($zip == "zip")
567         $backupfile = $filename . ".zip";
568     else
569         $backupfile = $filename;
570     $company = $conn['name']; // get_company_pref('coy_name');
571
572         if (file_exists($backupfile))   // prevent appends
573                 unlink($backupfile);
574
575     //create comment
576     $out="# MySQL dump of database '".$conn["dbname"]."' on host '".$conn["host"]."'\n";
577     $out.="# Backup Date and Time: ".date("Y-m-d H:i")."\n";
578     $out.="# Built by " . $SysPrefs->app_title . " " . $version ."\n";
579     $out.="# ".$SysPrefs->power_url."\n";
580     $out.="# Company: ". @html_entity_decode($company, ENT_QUOTES, $_SESSION['language']->encoding)."\n";
581     $out.="# User: ".$_SESSION["wa_current_user"]->name."\n\n";
582     $out.="# Compatibility: ".get_company_pref('version_id')."\n\n";
583
584         // write users comment
585         if ($comment)
586         {
587                 $out .= "# Comment:\n";
588                 $comment=preg_replace("'\n'","\n# ","# ".$comment);
589                 //$comment=str_replace("\n", "\n# ", $comment);
590                 foreach(explode("\n",$comment) as $line)
591                         $out .= $line."\n";
592                 $out.="\n";
593         }
594
595     //$out.="use ".$db.";\n"; we don't use this option.
596
597         if (db_fixed())
598         {
599                 db_set_encoding();
600                 if ($mysql_enc = get_mysql_encoding_name($_SESSION['language']->encoding))
601                         $out .= "\nSET NAMES $mysql_enc;\n";
602         }
603     // get auto_increment values and names of all tables
604     $res = db_query("show table status");
605     $all_tables = array();
606     while($row = db_fetch($res))
607     {
608                 if (($conn["tbpref"] == "" && !preg_match('/[0-9]+_/', $row['Name'])) ||
609                         ($conn["tbpref"] != "" && strpos($row['Name'], $conn["tbpref"]) === 0))
610                 $all_tables[] = $row;
611     }
612         // get table structures
613         foreach ($all_tables as $table)
614         {
615                 $res1 = db_query("SHOW CREATE TABLE `" . $table['Name'] . "`");
616                 $tmp = db_fetch($res1);
617                 $table_sql[$table['Name']] = $tmp["Create Table"];
618         }
619
620         // find foreign keys
621         $fks = array();
622         if (isset($table_sql))
623         {
624                 foreach($table_sql as $tablenme=>$table)
625                 {
626                         $tmp_table=$table;
627                         // save all tables, needed for creating this table in $fks
628                         while (($ref_pos = strpos($tmp_table, " REFERENCES ")) > 0)
629                         {
630                                 $tmp_table = substr($tmp_table, $ref_pos + 12);
631                                 $ref_pos = strpos($tmp_table, "(");
632                                 $fks[$tablenme][] = substr($tmp_table, 0, $ref_pos);
633                         }
634                 }
635         }
636         // order $all_tables
637         $all_tables = order_sql_tables($all_tables, $fks);
638
639         // as long as no error occurred
640         if (!$error)
641         {
642                 foreach ($all_tables as $row)
643                 {
644                         $tablename = $row['Name'];
645                         $auto_incr[$tablename] = $row['Auto_increment'];
646
647                         $out.="\n\n";
648                         // export tables
649                         $out.="### Structure of table `".$tablename."` ###\n\n";
650
651                         $out.="DROP TABLE IF EXISTS `".$tablename."`;\n\n";
652                         $out.=$table_sql[$tablename];
653
654                         // add auto_increment value
655 //                      if ($auto_incr[$tablename])
656 //                              $out.=" AUTO_INCREMENT=".$auto_incr[$tablename];
657                         $out.=" ;";
658                         $out.="\n\n";
659
660                         // export data
661                         if (!$error)
662                         {
663                                 $out.="### Data of table `".$tablename."` ###\n";
664
665                                 // check if field types are NULL or NOT NULL
666                                 $res3 = db_query("SHOW COLUMNS FROM `" . $tablename . "`");
667
668                                 $field_null = array();
669                                 for ($j = 0; $j < db_num_rows($res3); $j++)
670                                 {
671                                         $row3 = db_fetch($res3);
672                                         $field_null[] = $row3[2]=='YES' && $row3[4]===null;
673                                 }
674
675                                 $res2 = db_query("SELECT * FROM `" . $tablename . "`");
676                                 $maxinsert = 0;
677                                 $insert = '';
678                                 for ($j = 0; $j < db_num_rows($res2); $j++)
679                                 {
680                                         $row2 = db_fetch_row($res2);
681                                         $values = '(';
682                                         for ($k = 0; $k < $nf = db_num_fields($res2); $k++)
683                                         {
684                                                 $values .= db_escape($row2[$k], $field_null[$k]);
685                                                 if ($k < ($nf - 1))
686                                                         $values .= ', ';
687                                         }
688                                         $values .= ')';
689                                         $len = strlen($values);
690                                         if ($maxinsert < $len+1)
691                                         {
692                                                 $maxinsert = EXPORT_MAX_INSERT;
693                                                 if ($insert)
694                                                 {
695                                                         $out .= $insert .';'; // flush insert query
696                                                         $insert = '';
697                                                 }
698                                         }
699
700                                         if ($insert == '')
701                                         {
702                                                 $insert = "\nINSERT INTO `" . $tablename . "` VALUES\n";
703                                                 $maxinsert -= strlen($insert);
704                                         } else {
705                                                 $insert .= ",\n";
706                                         }
707
708                                         $maxinsert -= $len;
709                                         $insert .= $values;
710
711                                         // if saving is successful, then empty $out, else set error flag
712                                         if (strlen($out) > $max_size && $zip != "zip")
713                                         {
714                                                 if (save_to_file($backupfile, $zip, $out))
715                                                         $out = "";
716                                                 else
717                                                         $error = true;
718                                         }
719                                 }
720                                 if ($insert)
721                                         $out .= $insert. ';';
722                         // an error occurred! Try to delete file and return error status
723                         }
724                         elseif ($error)
725                         {
726                                 @unlink($backupfile);
727                                 return false;
728                         }
729
730                         // if saving is successful, then empty $out, else set error flag
731                         if (strlen($out) > $max_size && $zip != "zip")
732                         {
733                                 if (save_to_file($backupfile, $zip, $out))
734                                         $out= "";
735                                 else
736                                         $error = true;
737                         }
738                 }
739
740         // an error occurred! Try to delete file and return error status
741         }
742         else
743         {
744                 @unlink($backupfile);
745                 return false;
746         }
747
748         //if ($zip == "zip")
749         //      $zip = $time;
750         if (save_to_file($backupfile, $zip, $out))
751         {
752                 $out = "";
753         }
754         else
755         {
756                 @unlink($backupfile);
757                 return false;
758         }
759     return $backupfile;
760 }
761
762 // orders the tables in $tables according to the constraints in $fks
763 // $fks musst be filled like this: $fks[tablename][0]=needed_table1; $fks[tablename][1]=needed_table2; ...
764 function order_sql_tables($tables, $fks)
765 {
766         // do not order if no contraints exist
767         if (!count($fks))
768                 return $tables;
769
770         // order
771         $new_tables = array();
772         $existing = array();
773         $modified = true;
774         while (count($tables) && $modified == true)
775         {
776                 $modified = false;
777             foreach ($tables as $key=>$row)
778             {
779                 // delete from $tables and add to $new_tables
780                 if (isset($fks[$row['Name']]))
781                 {
782                         foreach($fks[$row['Name']] as $needed)
783                         {
784                         // go to next table if not all needed tables exist in $existing
785                         if (!in_array($needed,$existing))
786                                 continue 2;
787                     }
788                 }
789             // delete from $tables and add to $new_tables
790                 $existing[] = $row['Name'];
791                         $new_tables[] = $row;
792             prev($tables);
793             unset($tables[$key]);
794             $modified = true;
795
796             }
797         }
798
799         if (count($tables))
800         {
801             // probably there are 'circles' in the constraints, bacause of that no proper backups can be created yet
802             // TODO: this will be fixed sometime later through using 'alter table' commands to add the constraints after generating the tables
803             // until now, just add the lasting tables to $new_tables, return them and print a warning
804             foreach($tables as $row)
805                 $new_tables[] = $row;
806             echo "<div class=\"red_left\">THIS DATABASE SEEMS TO CONTAIN 'RING CONSTRAINTS'. WA DOES NOT SUPPORT THEM. PROBABLY THE FOLOWING BACKUP IS DEFECT!</div>";
807         }
808         return $new_tables;
809 }
810
811 // saves the string in $fileData to the file $backupfile as gz file or not ($zip)
812 // returns backup file name if name has changed (zip), else TRUE. If saving failed, return value is FALSE
813 function save_to_file($path, $zip, $fileData)
814 {
815
816         $backupfile = basename($path);
817
818     if ($zip == "gzip")
819     {
820         if ($zp = @gzopen($path, "a9"))
821         {
822                         @gzwrite($zp, $fileData);
823                         @gzclose($zp);
824                         return true;
825         }
826         else
827         {
828                 return false;
829         }
830
831     // $zip contains the timestamp
832     }
833     elseif ($zip == "zip")
834     {
835         // based on zip.lib.php 2.2 from phpMyBackupAdmin
836         // offical zip format: http://www.pkware.com/appnote.txt
837
838         // End of central directory record
839         $eof_ctrl_dir = "\x50\x4b\x05\x06\x00\x00\x00\x00";
840
841         // "local file header" segment
842         $unc_len = strlen($fileData);
843         $crc = crc32($fileData);
844         $zdata = gzcompress($fileData);
845
846                 // extend stored file name with suffix
847         // needed for decoding (because of crc bug)
848         $name_suffix = substr($zdata, -4, 4);
849         $name_suffix2 = "_";
850         for ($i = 0; $i < 4; $i++)
851                 $name_suffix2 .= sprintf("%03d", ord($name_suffix[$i]));
852
853         $name = substr($backupfile, 0, strlen($backupfile) - 8) . $name_suffix2 . ".sql";
854
855         // fix crc bug
856         $zdata = substr(substr($zdata, 0, strlen($zdata) - 4), 2);
857         $c_len = strlen($zdata);
858
859         // dos time
860         $timearray = getdate();
861         $dostime = (($timearray['year'] - 1980) << 25) | ($timearray['mon'] << 21) | ($timearray['mday'] << 16) |
862             ($timearray['hours'] << 11) | ($timearray['minutes'] << 5) | ($timearray['seconds'] >> 1);
863         $dtime = dechex($dostime);
864         $hexdtime = "\x" . $dtime[6] . $dtime[7] . "\x" . $dtime[4].$dtime[5] . "\x" . $dtime[2] . $dtime[3] . "\x" . $dtime[0] . $dtime[1];
865         eval('$hexdtime="' . $hexdtime . '";');
866
867         // ver needed to extract, gen purpose bit flag, compression method, last mod time and date
868         $sub1 = "\x14\x00" . "\x00\x00" . "\x08\x00" . $hexdtime;
869
870         // crc32, compressed filesize, uncompressed filesize
871         $sub2 = pack('V', $crc) . pack('V', $c_len) . pack('V', $unc_len);
872
873         $fr = "\x50\x4b\x03\x04" . $sub1. $sub2;
874
875         // length of filename, extra field length
876         $fr .= pack('v', strlen($name)) . pack('v', 0);
877         $fr .= $name;
878
879         // "file data" segment and "data descriptor" segment (optional but necessary if archive is not served as file)
880         $fr .= $zdata . $sub2;
881
882         // now add to central directory record
883         $cdrec = "\x50\x4b\x01\x02";
884         $cdrec .= "\x00\x00";                // version made by
885         $cdrec .= $sub1 . $sub2;
886
887          // length of filename, extra field length, file comment length, disk number start, internal file attributes, external file attributes - 'archive' bit set, offset
888         $cdrec .= pack('v', strlen($name)) . pack('v', 0) . pack('v', 0) . pack('v', 0) . pack('v', 0) . pack('V', 32) . pack('V',0);
889         $cdrec .= $name;
890
891         // combine data
892         $fileData = $fr . $cdrec . $eof_ctrl_dir;
893
894         // total # of entries "on this disk", total # of entries overall, size of central dir, offset to start of central dir, .zip file comment length
895         $fileData .= pack('v', 1) . pack('v', 1) . pack('V', strlen($cdrec)) . pack('V', strlen($fr)) . "\x00\x00";
896
897         if ($zp = @fopen($path, "w"))
898         {
899                         @fwrite($zp, $fileData);
900                         @fclose($zp);
901                         return true;
902         }
903         else
904         {
905                 return false;
906         }
907
908         // uncompressed
909     }
910     else
911     {
912         if ($zp = @fopen($path, "a"))
913         {
914                         @fwrite($zp, $fileData);
915                         @fclose($zp);
916                         return true;
917         }
918         else
919         {
920                 return false;
921         }
922     }
923 }
924
925 function create_comp_dirs($comp_path, $comp_subdirs)
926 {
927                 $index = "<?php\nheader(\"Location: ../index.php\");\n";
928             $cdir = $comp_path;
929             @mkdir($cdir);
930                 $f = @fopen("$cdir/index.php", "wb");
931                 @fwrite($f, $index);
932                 @fclose($f);
933
934             foreach($comp_subdirs as $dir)
935             {
936                         @mkdir($cdir.'/'.$dir);
937                         $f = @fopen("$cdir/$dir/index.php", "wb");
938                         @fwrite($f, $index);
939                         @fclose($f);
940             }
941 }
942
943 //
944 //      Checks $field existence in $table with given field $properties
945 //      $table - table name without prefix
946 //  $field -  optional field name
947 //  $properties - optional properties of field defined by MySQL:
948 //              'Type', 'Null', 'Key', 'Default', 'Extra'
949 //
950 function check_table($pref, $table, $field=null, $properties=null)
951 {
952         $tables = @db_query("SHOW TABLES LIKE '".$pref.$table."'");
953         if (!db_num_rows($tables))
954                 return 1;               // no such table or error
955
956         $fields = @db_query("SHOW COLUMNS FROM ".$pref.$table);
957         if (!isset($field)) 
958                 return 0;               // table exists
959
960         while( $row = db_fetch_assoc($fields)) 
961         {
962                 if ($row['Field'] == $field) 
963                 {
964                         if (!isset($properties)) 
965                                 return 0;
966                         foreach($properties as $property => $value) 
967                         {
968                                 if ($row[$property] != $value) 
969                                         return 3;       // failed type/length check
970                         }
971                         return 0; // property check ok.
972                 }
973         }
974         return 2; // field not found
975 }
976
977 /*
978         Update or create setting in simple php config file.
979 */
980 function update_config_var($file, $variable, $value, $comment='')
981 {
982         if (!is_file($file) || !is_writeable($file))
983                 return false;
984         $content = file_get_contents($file);
985         $strvalue = '$'."$variable = ".var_export($value, true).';';
986         $pattern = '/'.preg_quote('$'.$variable).'\s*=\s*[^;]*;/m';
987         $content = preg_replace($pattern, $strvalue, $content, -1, $result);
988         if (!$result)
989         {
990                 $strvalue = ($comment ? "// $comment" : '') ."\n$strvalue\n";
991                 $content = preg_replace('/\?>\s*/m', $strvalue, $content, -1, $result);
992                 if (!$result)
993                         $content .= $strvalue;
994         }
995
996         return file_put_contents($file, $content)!=false;
997 }
998
999