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