Merged changes from stable branch up to 2.3.23.
[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                 );
282
283         $protected = array(
284                 'security_roles',
285                 'users'
286         );
287
288         $ignored_mysql_errors = array( //errors ignored in normal (non forced) mode
289                 '1022', // duplicate key
290                 '1050', // Table %s already exists
291                 '1060', // duplicate column name
292                 '1061', // duplicate key name
293                 '1062', // duplicate key entry
294                 '1091'  // can't drop key/column check if exists
295         );
296
297         $set_names = array();
298         $data_queries = array();
299         $drop_queries = array();
300         $table_queries = array();
301         $sql_errors = array();
302
303         $old_encoding = db_get_charset($db);
304
305         ini_set("max_execution_time", "180");
306         db_query("SET foreign_key_checks=0");
307         $check_line_len = false;
308         // uncrompress gziped backup files
309         if (strpos($filename, ".gz") || strpos($filename, ".GZ"))
310         {       $lines = db_ungzip("lines", $filename);
311                 $check_line_len = true;
312         } elseif (strpos($filename, ".zip") || strpos($filename, ".ZIP"))
313                 $lines = db_unzip("lines", $filename);
314         else
315                 $lines = file("". $filename);
316
317         // parse input file
318         $query_table = '';
319         $delimiter = ';';
320
321         foreach($lines as $line_no => $line)
322         {
323                 $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!
324
325                 $line = trim($line);
326                 if ($init)
327                         $line = str_replace("0_", $connection["tbpref"], $line);
328
329                 if ($query_table == '') 
330                 {       // check if line begins with one of allowed queries
331                         foreach($allowed_commands as $cmd => $table) 
332                         {
333                                 if (strtolower(substr($line, 0, strlen($cmd))) == $cmd) 
334                                 {
335                                         if ($cmd == 'delimiter') {
336                                                 $delimiter = trim(substr($line, 10));
337                                                 continue 2;
338                                         }
339                                         $query_table = $table;
340                                         $skip = false;
341                                         if ($protect)
342                                         {
343                                                 foreach($protected as $protbl)
344                                                         if (strpos($line, $connection["tbpref"].$protbl) !== false)
345                                                         {
346                                                                 $skip = true; break;
347                                                         }
348                                         }
349                                         if (!$skip)
350                                                 ${$query_table}[] = array('', $line_no+1);
351                                         break;
352                                 }
353                         }
354                  }
355                  if($query_table != '')  // inside allowed query
356                  {
357                         $table = $query_table;
358                         if (!$gzfile_bug && substr($line, -strlen($delimiter)) == $delimiter) // end of query found 
359                         {
360                                 $line = substr($line, 0, strlen($line) - strlen($delimiter)); // strip delimiter
361                                 $query_table = '';
362                         }
363                         if (!$skip)
364                                 ${$table}[count(${$table}) - 1][0] .= $line . "\n";
365                 }
366
367         }
368
369         //
370         // 'set names' or equivalents should be used only on post 2.3 FA versions
371         // otherwise text encoding can be broken during import
372         //
373         $encoding = null; // UI encoding for default site language is the default
374         $new_db = $init || db_fixed();
375         $new_file = count($set_names);
376         if ($new_db)
377         {
378                 if ($new_file)
379                 {
380                         if (count($set_names)) // standard db restore
381                         {
382                                 if (preg_match('/set\s*names\s*[\']?(\w*)[\']?/i', $set_names[0][0], $match))
383                                         $encoding = $match[1];
384                         }
385                         // otherwise use default site ui encoding
386                 }
387         }
388         else
389         {
390                 if ($new_file) // import on old db is forbidden: this would destroy db content unless latin1 was used before in UI
391                 {
392                         $msg = _("This is new format backup file which cannot be restored on database not migrated to utf8.");
393                         if ($return_errors)
394                                 return $msg;
395                         else
396                                 display_error($msg);
397                         return false;
398                 }
399                  else   // backup restore during upgrade failure
400                         $encoding = 'latin1'; // standard encoding on mysql client
401         }
402
403         db_set_charset($db, $encoding);
404
405 /*/     {       // for debugging purposes
406         global $path_to_root;
407         $f = fopen($path_to_root.'/tmp/dbimport.txt', 'w+');
408         fwrite($f, print_r($set_names,true) ."\n");
409         fwrite($f, print_r($drop_queries,true) ."\n");
410         fwrite($f, print_r($table_queries,true) ."\n");
411         fwrite($f, print_r($data_queries,true));
412         fclose($f);
413         }
414 /*/
415         if ($return_errors)
416         {       // prevent errors display
417                 $save_debug = $SysPrefs->go_debug;
418                 $SysPrefs->go_debug = 0;
419         }
420         // execute drop tables if exists queries
421         if (is_array($drop_queries))
422         {
423                 foreach($drop_queries as $drop_query)
424                 {
425                         if (!db_query($drop_query[0]))
426                         {
427                                 if (!in_array(db_error_no(), $ignored_mysql_errors) || !$force)
428                                         $sql_errors[] = array(db_error_msg($db), $drop_query[1]);
429                         }
430                 }
431         }
432
433         // execute create tables queries
434         if (is_array($table_queries))
435         {
436                 foreach($table_queries as $table_query)
437                 {
438                         if (!db_query($table_query[0]))
439                         {       
440                                 if (!in_array(db_error_no(), $ignored_mysql_errors) || !$force) {
441                                         $sql_errors[] = array(db_error_msg($db), $table_query[1]);
442                                 }
443                         }
444                 }
445         }
446
447         // execute insert data queries
448         if (is_array($data_queries))
449         {
450                 foreach($data_queries as $data_query)
451                 {
452                         if (!db_query($data_query[0]))
453                         {
454                                 if (!in_array(db_error_no(),$ignored_mysql_errors) || !$force)
455                                         $sql_errors[] = array(db_error_msg($db), $data_query[1]);
456                         }
457                 }
458         }
459
460         if ($return_errors)
461                 $SysPrefs->go_debug = $save_debug;
462
463         $SysPrefs->sql_trail = $trail;
464
465         db_query("SET foreign_key_checks=1");
466         if ($delimiter != ';') db_query("delimiter ;"); // just for any case
467
468         db_set_charset($db, $old_encoding); // restore connection encoding
469
470         if (count($sql_errors)) {
471                 if ($return_errors)
472                         return $sql_errors;
473
474                 // display first failure message; the rest are probably derivative 
475                 $err = $sql_errors[0];
476                 display_error(sprintf(_("SQL script execution failed in line %d: %s"),
477                         $err[1], $err[0]));
478                 return false;
479         } else
480                 return true;
481 }
482
483 // returns the content of the gziped $path backup file. use of $mode see below
484 function db_ungzip($mode, $path)
485 {
486     $file_data = gzfile($path);
487     // returns one string or an array of lines
488     if ($mode != "lines")
489         return implode("",$file_data);
490     else
491         return $file_data;
492 }
493
494 // returns the content of the ziped $path backup file. use of $mode see below
495 function db_unzip($mode, $path)
496 {
497     $all = false;
498     $all = implode("", file($path));
499
500     // convert path to name of ziped file
501     $filename = preg_replace("/.*\//", "", $path);
502     $filename = substr($filename, 0, strlen($filename) - 4);
503
504     // compare filname in zip and filename from $_GET
505     if (substr($all, 30, strlen($filename)-4) . substr($all, 30+strlen($filename)+9, 4)
506           != $filename) {
507                 return '';     // exit if names differ
508     }
509     else
510     {
511         // get the suffix of the filename in hex
512                 $crc_bugfix = substr($all, 30, strlen($filename)+13);
513         $crc_bugfix = substr(substr($crc_bugfix, 0, strlen($crc_bugfix) - 4), 
514                                 strlen($crc_bugfix) - 12 - 4);
515         $suffix = false;
516         // convert hex to ascii
517         for ($i=0; $i < 12; )
518                 $suffix .= chr($crc_bugfix[$i++] . $crc_bugfix[$i++] . $crc_bugfix[$i++]);
519
520         // remove central directory information (we have always just one ziped file)
521         $comp = substr($all, -(strlen($all) - 30 - strlen($filename)-13));
522         $comp = substr($comp, 0, (strlen($comp) - 80 - strlen($filename)-13));
523
524         // fix the crc bugfix (see function save_to_file)
525         $comp = "x\9c" . $comp . $suffix;
526         $file_data = gzuncompress($comp);
527     }
528
529     // returns one string or an array of lines
530     if ($mode != "lines")
531         return $file_data;
532     else
533         return explode("\n", $file_data);
534 }
535
536 function db_backup($conn, $ext='no', $comm='', $path='')
537 {
538         if ($conn['tbpref'] != "")
539                 $filename = $conn['dbname'] . "_" . $conn['tbpref'] . date("Ymd_Hi") . ".sql";
540         else
541                 $filename = $conn['dbname'] . "_" . date("Ymd_Hi") . ".sql";
542
543         return db_export($conn, $path . clean_file_name($filename), $ext, $comm);
544 }
545 //
546 // Generates a dump of $db database
547 //
548 function db_export($conn, $filename, $zip='no', $comment='')
549 {
550
551         global $SysPrefs, $version;
552
553     $error = false;
554     // set max string size before writing to file
555     $max_size = 1048576 * 2; // 2 MB
556     // changes max size if value can be retrieved
557     if (ini_get("memory_limit"))
558         $max_size = 900000 * ini_get("memory_limit");
559
560     // set backupfile name
561     if ($zip == "gzip")
562         $backupfile = $filename . ".gz";
563     elseif ($zip == "zip")
564         $backupfile = $filename . ".zip";
565     else
566         $backupfile = $filename;
567     $company = $conn['name']; // get_company_pref('coy_name');
568
569         if (file_exists($backupfile))   // prevent appends
570                 unlink($backupfile);
571
572     //create comment
573     $out="# MySQL dump of database '".$conn["dbname"]."' on host '".$conn["host"]."'\n";
574     $out.="# Backup Date and Time: ".date("Y-m-d H:i")."\n";
575     $out.="# Built by " . $SysPrefs->app_title . " " . $version ."\n";
576     $out.="# ".$SysPrefs->power_url."\n";
577     $out.="# Company: ". @html_entity_decode($company, ENT_QUOTES, $_SESSION['language']->encoding)."\n";
578     $out.="# User: ".$_SESSION["wa_current_user"]->name."\n\n";
579     $out.="# Compatibility: ".get_company_pref('version_id')."\n\n";
580
581         // write users comment
582         if ($comment)
583         {
584                 $out .= "# Comment:\n";
585                 $comment=preg_replace("'\n'","\n# ","# ".$comment);
586                 //$comment=str_replace("\n", "\n# ", $comment);
587                 foreach(explode("\n",$comment) as $line)
588                         $out .= $line."\n";
589                 $out.="\n";
590         }
591
592     //$out.="use ".$db.";\n"; we don't use this option.
593
594         if (db_fixed())
595         {
596                 db_set_encoding();
597                 if ($mysql_enc = get_mysql_encoding_name($_SESSION['language']->encoding))
598                         $out .= "\nSET NAMES $mysql_enc;\n";
599         }
600     // get auto_increment values and names of all tables
601     $res = db_query("show table status");
602     $all_tables = array();
603     while($row = db_fetch($res))
604     {
605                 if (($conn["tbpref"] == "" && !preg_match('/[0-9]+_/', $row['Name'])) ||
606                         ($conn["tbpref"] != "" && strpos($row['Name'], $conn["tbpref"]) === 0))
607                 $all_tables[] = $row;
608     }
609         // get table structures
610         foreach ($all_tables as $table)
611         {
612                 $res1 = db_query("SHOW CREATE TABLE `" . $table['Name'] . "`");
613                 $tmp = db_fetch($res1);
614                 $table_sql[$table['Name']] = $tmp["Create Table"];
615         }
616
617         // find foreign keys
618         $fks = array();
619         if (isset($table_sql))
620         {
621                 foreach($table_sql as $tablenme=>$table)
622                 {
623                         $tmp_table=$table;
624                         // save all tables, needed for creating this table in $fks
625                         while (($ref_pos = strpos($tmp_table, " REFERENCES ")) > 0)
626                         {
627                                 $tmp_table = substr($tmp_table, $ref_pos + 12);
628                                 $ref_pos = strpos($tmp_table, "(");
629                                 $fks[$tablenme][] = substr($tmp_table, 0, $ref_pos);
630                         }
631                 }
632         }
633         // order $all_tables
634         $all_tables = order_sql_tables($all_tables, $fks);
635
636         // as long as no error occurred
637         if (!$error)
638         {
639                 foreach ($all_tables as $row)
640                 {
641                         $tablename = $row['Name'];
642                         $auto_incr[$tablename] = $row['Auto_increment'];
643
644                         $out.="\n\n";
645                         // export tables
646                         $out.="### Structure of table `".$tablename."` ###\n\n";
647
648                         $out.="DROP TABLE IF EXISTS `".$tablename."`;\n\n";
649                         $out.=$table_sql[$tablename];
650
651                         // add auto_increment value
652 //                      if ($auto_incr[$tablename])
653 //                              $out.=" AUTO_INCREMENT=".$auto_incr[$tablename];
654                         $out.=" ;";
655                         $out.="\n\n";
656
657                         // export data
658                         if (!$error)
659                         {
660                                 $out.="### Data of table `".$tablename."` ###\n";
661
662                                 // check if field types are NULL or NOT NULL
663                                 $res3 = db_query("SHOW COLUMNS FROM `" . $tablename . "`");
664
665                                 $field_null = array();
666                                 for ($j = 0; $j < db_num_rows($res3); $j++)
667                                 {
668                                         $row3 = db_fetch($res3);
669                                         $field_null[] = $row3[2]=='YES' && $row3[4]===null;
670                                 }
671
672                                 $res2 = db_query("SELECT * FROM `" . $tablename . "`");
673                                 $maxinsert = 0;
674                                 $insert = '';
675                                 for ($j = 0; $j < db_num_rows($res2); $j++)
676                                 {
677                                         $row2 = db_fetch_row($res2);
678                                         $values = '(';
679                                         for ($k = 0; $k < $nf = db_num_fields($res2); $k++)
680                                         {
681                                                 $values .= db_escape($row2[$k], $field_null[$k]);
682                                                 if ($k < ($nf - 1))
683                                                         $values .= ', ';
684                                         }
685                                         $values .= ')';
686                                         $len = strlen($values);
687                                         if ($maxinsert < $len+1)
688                                         {
689                                                 $maxinsert = EXPORT_MAX_INSERT;
690                                                 if ($insert)
691                                                 {
692                                                         $out .= $insert .';'; // flush insert query
693                                                         $insert = '';
694                                                 }
695                                         }
696
697                                         if ($insert == '')
698                                         {
699                                                 $insert = "\nINSERT INTO `" . $tablename . "` VALUES\n";
700                                                 $maxinsert -= strlen($insert);
701                                         } else {
702                                                 $insert .= ",\n";
703                                         }
704
705                                         $maxinsert -= $len;
706                                         $insert .= $values;
707
708                                         // if saving is successful, then empty $out, else set error flag
709                                         if (strlen($out) > $max_size && $zip != "zip")
710                                         {
711                                                 if (save_to_file($backupfile, $zip, $out))
712                                                         $out = "";
713                                                 else
714                                                         $error = true;
715                                         }
716                                 }
717                                 if ($insert)
718                                         $out .= $insert. ';';
719                         // an error occurred! Try to delete file and return error status
720                         }
721                         elseif ($error)
722                         {
723                                 @unlink($backupfile);
724                                 return false;
725                         }
726
727                         // if saving is successful, then empty $out, else set error flag
728                         if (strlen($out) > $max_size && $zip != "zip")
729                         {
730                                 if (save_to_file($backupfile, $zip, $out))
731                                         $out= "";
732                                 else
733                                         $error = true;
734                         }
735                 }
736
737         // an error occurred! Try to delete file and return error status
738         }
739         else
740         {
741                 @unlink($backupfile);
742                 return false;
743         }
744
745         //if ($zip == "zip")
746         //      $zip = $time;
747         if (save_to_file($backupfile, $zip, $out))
748         {
749                 $out = "";
750         }
751         else
752         {
753                 @unlink($backupfile);
754                 return false;
755         }
756     return $backupfile;
757 }
758
759 // orders the tables in $tables according to the constraints in $fks
760 // $fks musst be filled like this: $fks[tablename][0]=needed_table1; $fks[tablename][1]=needed_table2; ...
761 function order_sql_tables($tables, $fks)
762 {
763         // do not order if no contraints exist
764         if (!count($fks))
765                 return $tables;
766
767         // order
768         $new_tables = array();
769         $existing = array();
770         $modified = true;
771         while (count($tables) && $modified == true)
772         {
773                 $modified = false;
774             foreach ($tables as $key=>$row)
775             {
776                 // delete from $tables and add to $new_tables
777                 if (isset($fks[$row['Name']]))
778                 {
779                         foreach($fks[$row['Name']] as $needed)
780                         {
781                         // go to next table if not all needed tables exist in $existing
782                         if (!in_array($needed,$existing))
783                                 continue 2;
784                     }
785                 }
786             // delete from $tables and add to $new_tables
787                 $existing[] = $row['Name'];
788                         $new_tables[] = $row;
789             prev($tables);
790             unset($tables[$key]);
791             $modified = true;
792
793             }
794         }
795
796         if (count($tables))
797         {
798             // probably there are 'circles' in the constraints, bacause of that no proper backups can be created yet
799             // TODO: this will be fixed sometime later through using 'alter table' commands to add the constraints after generating the tables
800             // until now, just add the lasting tables to $new_tables, return them and print a warning
801             foreach($tables as $row)
802                 $new_tables[] = $row;
803             echo "<div class=\"red_left\">THIS DATABASE SEEMS TO CONTAIN 'RING CONSTRAINTS'. WA DOES NOT SUPPORT THEM. PROBABLY THE FOLOWING BACKUP IS DEFECT!</div>";
804         }
805         return $new_tables;
806 }
807
808 // saves the string in $fileData to the file $backupfile as gz file or not ($zip)
809 // returns backup file name if name has changed (zip), else TRUE. If saving failed, return value is FALSE
810 function save_to_file($path, $zip, $fileData)
811 {
812
813         $backupfile = basename($path);
814
815     if ($zip == "gzip")
816     {
817         if ($zp = @gzopen($path, "a9"))
818         {
819                         @gzwrite($zp, $fileData);
820                         @gzclose($zp);
821                         return true;
822         }
823         else
824         {
825                 return false;
826         }
827
828     // $zip contains the timestamp
829     }
830     elseif ($zip == "zip")
831     {
832         // based on zip.lib.php 2.2 from phpMyBackupAdmin
833         // offical zip format: http://www.pkware.com/appnote.txt
834
835         // End of central directory record
836         $eof_ctrl_dir = "\x50\x4b\x05\x06\x00\x00\x00\x00";
837
838         // "local file header" segment
839         $unc_len = strlen($fileData);
840         $crc = crc32($fileData);
841         $zdata = gzcompress($fileData);
842
843                 // extend stored file name with suffix
844         // needed for decoding (because of crc bug)
845         $name_suffix = substr($zdata, -4, 4);
846         $name_suffix2 = "_";
847         for ($i = 0; $i < 4; $i++)
848                 $name_suffix2 .= sprintf("%03d", ord($name_suffix[$i]));
849
850         $name = substr($backupfile, 0, strlen($backupfile) - 8) . $name_suffix2 . ".sql";
851
852         // fix crc bug
853         $zdata = substr(substr($zdata, 0, strlen($zdata) - 4), 2);
854         $c_len = strlen($zdata);
855
856         // dos time
857         $timearray = getdate();
858         $dostime = (($timearray['year'] - 1980) << 25) | ($timearray['mon'] << 21) | ($timearray['mday'] << 16) |
859             ($timearray['hours'] << 11) | ($timearray['minutes'] << 5) | ($timearray['seconds'] >> 1);
860         $dtime = dechex($dostime);
861         $hexdtime = "\x" . $dtime[6] . $dtime[7] . "\x" . $dtime[4].$dtime[5] . "\x" . $dtime[2] . $dtime[3] . "\x" . $dtime[0] . $dtime[1];
862         eval('$hexdtime="' . $hexdtime . '";');
863
864         // ver needed to extract, gen purpose bit flag, compression method, last mod time and date
865         $sub1 = "\x14\x00" . "\x00\x00" . "\x08\x00" . $hexdtime;
866
867         // crc32, compressed filesize, uncompressed filesize
868         $sub2 = pack('V', $crc) . pack('V', $c_len) . pack('V', $unc_len);
869
870         $fr = "\x50\x4b\x03\x04" . $sub1. $sub2;
871
872         // length of filename, extra field length
873         $fr .= pack('v', strlen($name)) . pack('v', 0);
874         $fr .= $name;
875
876         // "file data" segment and "data descriptor" segment (optional but necessary if archive is not served as file)
877         $fr .= $zdata . $sub2;
878
879         // now add to central directory record
880         $cdrec = "\x50\x4b\x01\x02";
881         $cdrec .= "\x00\x00";                // version made by
882         $cdrec .= $sub1 . $sub2;
883
884          // length of filename, extra field length, file comment length, disk number start, internal file attributes, external file attributes - 'archive' bit set, offset
885         $cdrec .= pack('v', strlen($name)) . pack('v', 0) . pack('v', 0) . pack('v', 0) . pack('v', 0) . pack('V', 32) . pack('V',0);
886         $cdrec .= $name;
887
888         // combine data
889         $fileData = $fr . $cdrec . $eof_ctrl_dir;
890
891         // total # of entries "on this disk", total # of entries overall, size of central dir, offset to start of central dir, .zip file comment length
892         $fileData .= pack('v', 1) . pack('v', 1) . pack('V', strlen($cdrec)) . pack('V', strlen($fr)) . "\x00\x00";
893
894         if ($zp = @fopen($path, "w"))
895         {
896                         @fwrite($zp, $fileData);
897                         @fclose($zp);
898                         return true;
899         }
900         else
901         {
902                 return false;
903         }
904
905         // uncompressed
906     }
907     else
908     {
909         if ($zp = @fopen($path, "a"))
910         {
911                         @fwrite($zp, $fileData);
912                         @fclose($zp);
913                         return true;
914         }
915         else
916         {
917                 return false;
918         }
919     }
920 }
921
922 function create_comp_dirs($comp_path, $comp_subdirs)
923 {
924                 $index = "<?php\nheader(\"Location: ../index.php\");\n";
925             $cdir = $comp_path;
926             @mkdir($cdir);
927                 $f = @fopen("$cdir/index.php", "wb");
928                 @fwrite($f, $index);
929                 @fclose($f);
930
931             foreach($comp_subdirs as $dir)
932             {
933                         @mkdir($cdir.'/'.$dir);
934                         $f = @fopen("$cdir/$dir/index.php", "wb");
935                         @fwrite($f, $index);
936                         @fclose($f);
937             }
938 }
939
940 //
941 //      Checks $field existence in $table with given field $properties
942 //      $table - table name without prefix
943 //  $field -  optional field name
944 //  $properties - optional properties of field defined by MySQL:
945 //              'Type', 'Null', 'Key', 'Default', 'Extra'
946 //
947 function check_table($pref, $table, $field=null, $properties=null)
948 {
949         $tables = @db_query("SHOW TABLES LIKE '".$pref.$table."'");
950         if (!db_num_rows($tables))
951                 return 1;               // no such table or error
952
953         $fields = @db_query("SHOW COLUMNS FROM ".$pref.$table);
954         if (!isset($field)) 
955                 return 0;               // table exists
956
957         while( $row = db_fetch_assoc($fields)) 
958         {
959                 if ($row['Field'] == $field) 
960                 {
961                         if (!isset($properties)) 
962                                 return 0;
963                         foreach($properties as $property => $value) 
964                         {
965                                 if ($row[$property] != $value) 
966                                         return 3;       // failed type/length check
967                         }
968                         return 0; // property check ok.
969                 }
970         }
971         return 2; // field not found
972 }
973
974 /*
975         Update or create setting in simple php config file.
976 */
977 function update_config_var($file, $variable, $value, $comment='')
978 {
979         if (!is_file($file) || !is_writeable($file))
980                 return false;
981         $content = file_get_contents($file);
982         $strvalue = '$'."$variable = ".var_export($value, true).';';
983         $pattern = '/'.preg_quote('$'.$variable).'\s*=\s*[^;]*;/m';
984         $content = preg_replace($pattern, $strvalue, $content, -1, $result);
985         if (!$result)
986         {
987                 $strvalue = ($comment ? "// $comment" : '') ."\n$strvalue\n";
988                 $content = preg_replace('/\?>\s*/m', $strvalue, $content, -1, $result);
989                 if (!$result)
990                         $content .= $strvalue;
991         }
992
993         return file_put_contents($file, $content)!=false;
994 }
995
996