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