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