Merging version 2.1 RC to main trunk.
[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 function write_config_db($new = false)
14 {
15         global $path_to_root, $def_coy, $db_connections, $tb_pref_counter;
16         include_once($path_to_root . "/config_db.php");
17
18         if ($new)
19                 $tb_pref_counter++;
20         $n = count($db_connections);
21         $msg = "<?php\n\n";
22         $msg .= "/*Connection Information for the database\n";
23         $msg .= "- \$def_coy is the default company that is pre-selected on login\n\n";
24         $msg .= "- host is 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";
25         $msg .= "- user is the user name under which the database should be accessed - need to change to the mysql (or other DB) user set up for purpose\n";
26         $msg .= "  NB it is not secure to use root as the user with no password - a user with appropriate privileges must be set up\n\n";
27         $msg .= "- password is the password the user of the database requires to be sent to authorise the above database user\n\n";
28         $msg .= "- DatabaseName is 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";
29         $msg .= "  The scripts for MySQL provided use the name logicworks */\n\n\n";
30
31         $msg .= "\$def_coy = " . $def_coy . ";\n\n";
32         $msg .= "\$tb_pref_counter = " . $tb_pref_counter . ";\n\n";
33         $msg .= "\$db_connections = array (\n";
34         $msg .= "\t0 => ";
35         for ($i = 0; $i < $n; $i++)
36         {
37                 if ($i > 0)
38                         $msg .= "\tarray ";
39                 else
40                         $msg .= "array ";
41                 $msg .= "('name' => '" . $db_connections[$i]['name'] . "',\n";
42                 $msg .= "\t\t'host' => '" . $db_connections[$i]['host'] . "',\n";
43                 $msg .= "\t\t'dbuser' => '" . $db_connections[$i]['dbuser'] . "',\n";
44                 $msg .= "\t\t'dbpassword' => '" . $db_connections[$i]['dbpassword'] . "',\n";
45                 $msg .= "\t\t'dbname' => '" . $db_connections[$i]['dbname'] . "',\n";
46                 $msg .= "\t\t'tbpref' => '" . $db_connections[$i]['tbpref'] . "')";
47                 if ($i != $n - 1)
48                         $msg .= ",";
49                 $msg .= "\n\n";
50         }
51         $msg .= "\t);\n?>";
52
53         $filename = $path_to_root . "/config_db.php";
54         // Check if the file exists and is writable first.
55         if (file_exists($filename) && is_writable($filename))
56         {
57                 if (!$zp = fopen($filename, 'w'))
58                 {
59                         return -1;
60                 }
61                 else
62                 {
63                         if (!fwrite($zp, $msg))
64                         {
65                                 fclose($zp);
66                                 return -2;
67                         }
68                         // Close file
69                         fclose($zp);
70                 }
71         }
72         else
73         {
74                 return -3;
75         }
76         return 0;
77 }
78
79 function db_create_db($connection)
80 {
81         $db = mysql_connect($connection["host"] ,
82                 $connection["dbuser"], $connection["dbpassword"]);
83         if (!mysql_select_db($connection["dbname"], $db))
84         {
85                 $sql = "CREATE DATABASE " . $connection["dbname"] . "";
86                 if (!mysql_query($sql))
87                         return 0;
88                 mysql_select_db($connection["dbname"], $db);
89         }
90         return $db;
91 }
92
93 function db_drop_db($connection)
94 {
95
96         if ($connection["tbpref"] == "")
97         {
98                 $sql = "DROP DATABASE " . $connection["dbname"] . "";
99                 return mysql_query($sql);
100         }
101         else
102         {
103         $res = db_query("show table status");
104         $all_tables = array();
105         while($row = db_fetch($res))
106                 $all_tables[] = $row;
107         // get table structures
108                 foreach ($all_tables as $table)
109                 {
110                         if (strpos($table['Name'], $connection["tbpref"]) === 0)
111                                 db_query("DROP TABLE `".$table['Name'] . "`");
112                 }
113                 //deleting the tables, how??
114                 return true;
115         }
116 }
117
118 function db_import($filename, $connection, $force=true)
119 {
120         global $db;
121         $allowed_commands = array(
122                 "create"  => 'table_queries', 
123                 "alter table" => 'table_queries', 
124                 "insert" => 'data_queries', 
125                 "update" => 'data_queries', 
126                 "drop table if exists" => 'drop_queries');
127         $ignored_mysql_errors = array( //errors ignored in normal (non forced) mode
128                 '1022', // duplicate key
129                 '1050', // Table %s already exists
130                 '1060', // duplicate column name
131                 '1061', // duplicate key name
132                 '1062', // duplicate key entry
133                 '1091'  // can't drop key/column check if exists
134         );
135         $data_queries = array();
136         $drop_queries = array();
137         $table_queries = array();
138         $sql_errors = array();
139
140         ini_set("max_execution_time", "180");
141         db_query("SET foreign_key_checks=0");
142
143         // uncrompress gziped backup files
144         if (strpos($filename, ".gzip") || strpos($filename, ".GZIP"))
145                 $lines = db_ungzip("lines", $filename);
146         elseif (strpos($filename, ".zip") || strpos($filename, ".ZIP"))
147                 $lines = db_unzip("lines", $filename);
148         else
149                 $lines = file("". $filename);
150
151         // parse input file
152         $query_table = '';
153         foreach($lines as $line_no => $line)
154         {
155                 $line = trim($line);
156                 
157                 $line = str_replace("0_", $connection["tbpref"], $line);
158
159                 if ($query_table == '') 
160                 {       // check if line begins with one of allowed queries
161                         foreach($allowed_commands as $cmd => $table) 
162                         {
163                                 if (strtolower(substr($line, 0, strlen($cmd))) == $cmd) 
164                                 {
165                                         $query_table = $table;
166                                         ${$query_table}[] = array('', $line_no+1);
167                                         break;
168                                 }
169                         }
170                  }
171                  if($query_table != '')  // inside allowed query
172                  {
173                         $table = $query_table;
174                         if (substr($line, -1) == ';') // end of query found
175                         {
176                                 $line = substr($line, 0, strlen($line) - 1); // strip ';'
177                                 $query_table = '';
178                         }
179                         ${$table}[count(${$table}) - 1][0] .= $line . "\n";
180                 }
181                 
182         }
183 /*
184         {       // for debugging purposes
185         global $path_to_root;
186         $f = fopen($path_to_root.'/tmp/dbimport.txt', 'w+');
187         fwrite($f, print_r($drop_queries,true) ."\n");
188         fwrite($f, print_r($table_queries,true) ."\n");
189         fwrite($f, print_r($data_queries,true));
190         fclose($f);
191         }
192 */
193         // execute drop tables if exists queries
194         if ($force && is_array($drop_queries))
195         {
196                 foreach($drop_queries as $drop_query)
197                 {
198                         if (!db_query($drop_query[0]))
199                         {
200                                 if (!in_array(db_error_no(), $ignored_mysql_errors))
201                                         $sql_errors[] = array(db_error_msg($db), $drop_query[1]);
202                         }
203                 }
204         }
205
206         // execute create tables queries
207         if (is_array($table_queries))
208         {
209                 foreach($table_queries as $table_query)
210                 {
211                         if (!db_query($table_query[0]))
212                         {       
213                                 if (!in_array(db_error_no(), $ignored_mysql_errors) || !$force) {
214                                         $sql_errors[] = array(db_error_msg($db), $table_query[1]);
215                                 }
216                         }
217                 }
218         }
219
220         // execute insert data queries
221         if (is_array($data_queries))
222         {
223                 foreach($data_queries as $data_query)
224                 {
225                         if (!db_query($data_query[0]))
226                         {
227                                 if (!in_array(db_error_no(),$ignored_mysql_errors) || !$force)
228                                         $sql_errors[] = array(db_error_msg($db), $data_query[1]);
229                         }
230                 }
231         }
232         
233         db_query("SET foreign_key_checks=1");
234
235         if (count($sql_errors)) {
236                 // display first failure message; the rest are probably derivative 
237                 $err = $sql_errors[0];
238                 display_error(sprintf(_("SQL script execution failed in line %d: %s"),
239                         $err[1], $err[0]));
240                 return false;
241         } else
242                 return true;
243         //$shell_command = C_MYSQL_PATH . " -h $host -u $user -p{$password} $dbname < $filename";
244         //shell_exec($shell_command);
245 }
246
247 // returns the content of the gziped $path backup file. use of $mode see below
248 function db_ungzip($mode, $path)
249 {
250     $file_data = gzfile($path);
251     // returns one string or an array of lines
252     if ($mode != "lines")
253         return implode("",$file_data);
254     else
255         return $file_data;
256 }
257
258 // returns the content of the ziped $path backup file. use of $mode see below
259 function db_unzip($mode, $path)
260 {
261     $all = false;
262     $all = implode("", file($path));
263
264     // convert path to name of ziped file
265     $filename = ereg_replace(".*/", "", $path);
266     $filename = substr($filename, 0, strlen($filename) - 4);
267
268     // compare filname in zip and filename from $_GET
269     if (substr($all, 30, strlen($filename)) != $filename)
270     {
271                 return '';
272         // exit if names differ
273         //echo F_WRONG_FILE.".";
274         //exit;
275     }
276     else
277     {
278         // get the suffix of the filename in hex
279         $crc_bugfix = substr(substr($filename, 0, strlen($filename) - 4), strlen($filename) - 12 - 4);
280         $suffix = false;
281
282         // convert hex to ascii
283         for ($i=0; $i < 12; )
284                 $suffix .= chr($crc_bugfix[$i++] . $crc_bugfix[$i++] . $crc_bugfix[$i++]);
285
286         // remove central directory information (we have always just one ziped file)
287         $comp = substr($all, -(strlen($all) - 30 - strlen($filename)));
288         $comp = substr($comp, 0, (strlen($comp) - 80 - strlen($filename)));
289
290         // fix the crc bugfix (see function save_to_file)
291         $comp = "x\9c" . $comp . $suffix;
292         $file_data = gzuncompress($comp);
293     }
294
295     // returns one string or an array of lines
296     if ($mode != "lines")
297         return $file_data;
298     else
299         return explode("\n", $file_data);
300 }
301
302 // generates a dump of $db database
303 // $drop and $zip tell if to include the drop table statement or dry to pack
304 function db_export($conn, $filename, $zip='no', $comment='', $tbpref = TB_PREF)
305 {
306
307         global $app_title, $version, $power_url, $path_to_root;
308
309     $error = false;
310     // set max string size before writing to file
311     $max_size = 1048576 * 2; // 2 MB
312     // changes max size if value can be retrieved
313     if (ini_get("memory_limit"))
314         $max_size = 900000 * ini_get("memory_limit");
315
316     // set backupfile name
317     if ($zip == "gzip")
318         $backupfile = $filename . ".gz";
319     elseif ($zip == "zip")
320         $backupfile = $filename . ".zip";
321     else
322         $backupfile = $filename;
323     $company = get_company_pref('coy_name', $tbpref);
324
325     //create comment
326     $out="# MySQL dump of database '".$conn["dbname"]."' on host '".$conn["host"]."'\n";
327     $out.="# Backup Date and Time: ".date("Y-m-d H:i")."\n";
328     $out.="# Built by " . $app_title . " " . $version ."\n";
329     $out.="# ".$power_url."\n";
330     $out.="# Company: ". @html_entity_decode($company, ENT_COMPAT, $_SESSION['language']->encoding)."\n";
331     $out.="# User: ".$_SESSION["wa_current_user"]->name."\n\n";
332
333         // write users comment
334         if ($comment)
335         {
336                 $out .= "# Comment:\n";
337                 $comment=preg_replace("'\n'","\n# ","# ".$comment);
338                 //$comment=str_replace("\n", "\n# ", $comment);
339                 foreach(explode("\n",$comment) as $line)
340                         $out .= $line."\n";
341                 $out.="\n";
342         }
343
344     //$out.="use ".$db.";\n"; we don't use this option.
345
346     // get auto_increment values and names of all tables
347     $res = db_query("show table status");
348     $all_tables = array();
349     while($row = db_fetch($res))
350     {
351                 //if ($conn["tbpref"] == "" || strpos($row['Name'], $conn["tbpref"]) !== false) replaced
352                 if (($conn["tbpref"] == "" && !preg_match('/[0-9]+_/', $row['Name'])) ||
353                         ($conn["tbpref"] != "" && strpos($row['Name'], $conn["tbpref"]) !== false))
354                 $all_tables[] = $row;
355     }
356         // get table structures
357         foreach ($all_tables as $table)
358         {
359                 $res1 = db_query("SHOW CREATE TABLE `" . $table['Name'] . "`");
360                 $tmp = db_fetch($res1);
361                 $table_sql[$table['Name']] = $tmp["Create Table"];
362         }
363
364         // find foreign keys
365         $fks = array();
366         if (isset($table_sql))
367         {
368                 foreach($table_sql as $tablenme=>$table)
369                 {
370                         $tmp_table=$table;
371                         // save all tables, needed for creating this table in $fks
372                         while (($ref_pos = strpos($tmp_table, " REFERENCES ")) > 0)
373                         {
374                                 $tmp_table = substr($tmp_table, $ref_pos + 12);
375                                 $ref_pos = strpos($tmp_table, "(");
376                                 $fks[$tablenme][] = substr($tmp_table, 0, $ref_pos);
377                         }
378                 }
379         }
380         // order $all_tables
381         $all_tables = order_sql_tables($all_tables, $fks);
382
383         // as long as no error occurred
384         if (!$error)
385         {
386                 //while($row=@mysql_fetch_array($res))
387                 foreach ($all_tables as $row)
388                 {
389                         $tablename = $row['Name'];
390                         $auto_incr[$tablename] = $row['Auto_increment'];
391
392                         $out.="\n\n";
393                         // export tables
394                         $out.="### Structure of table `".$tablename."` ###\n\n";
395
396                         $out.="DROP TABLE IF EXISTS `".$tablename."`;\n\n";
397                         $out.=$table_sql[$tablename];
398
399                         // add auto_increment value
400                         if ($auto_incr[$tablename])
401                                 $out.=" AUTO_INCREMENT=".$auto_incr[$tablename];
402                         $out.=" ;";
403                         $out.="\n\n\n";
404
405                         // export data
406                         if (!$error)
407                         {
408                                 $out.="### Data of table `".$tablename."` ###\n\n";
409
410                                 // check if field types are NULL or NOT NULL
411                                 $res3 = db_query("SHOW COLUMNS FROM `" . $tablename . "`");
412
413                                 $field_type = array();
414                                 for ($j = 0; $j < db_num_rows($res3); $j++)
415                                 {
416                                         $row3 = db_fetch($res3);
417                                         $field_type[] = $row3[2];
418                                 }
419
420                                 $res2 = db_query("SELECT * FROM `" . $tablename . "`");
421                                 for ($j = 0; $j < db_num_rows($res2); $j++)
422                                 {
423                                         $out .= "INSERT INTO `" . $tablename . "` VALUES (";
424                                         $row2 = db_fetch_row($res2);
425                                         // run through each field
426                                         for ($k = 0; $k < $nf = db_num_fields($res2); $k++)
427                                         {
428                                                 $out .= db_escape(@html_entity_decode($row2[$k], ENT_COMPAT, $_SESSION['language']->encoding));
429                                                 if ($k < ($nf - 1))
430                                                         $out .= ", ";
431                                         }
432                                         $out .= ");\n";
433
434                                         // if saving is successful, then empty $out, else set error flag
435                                         if (strlen($out) > $max_size && $zip != "zip")
436                                         {
437                                                 if (save_to_file($backupfile, $zip, $out))
438                                                         $out = "";
439                                                 else
440                                                         $error = true;
441                                         }
442                                 }
443
444                         // an error occurred! Try to delete file and return error status
445                         }
446                         elseif ($error)
447                         {
448                                 @unlink(BACKUP_PATH . $backupfile);
449                                 return false;
450                         }
451
452                         // if saving is successful, then empty $out, else set error flag
453                         if (strlen($out) > $max_size && $zip != "zip")
454                         {
455                                 if (save_to_file($backupfile, $zip, $out))
456                                         $out= "";
457                                 else
458                                         $error = true;
459                         }
460                 }
461
462         // an error occurred! Try to delete file and return error status
463         }
464         else
465         {
466                 @unlink(BACKUP_PATH . $backupfile);
467                 return false;
468         }
469
470         // if (mysql_error()) return "DB_ERROR";
471         //@mysql_close($con);
472
473         //if ($zip == "zip")
474         //      $zip = $time;
475         if (save_to_file($backupfile, $zip, $out))
476         {
477                 $out = "";
478         }
479         else
480         {
481                 @unlink(BACKUP_PATH . $backupfile);
482                 return false;
483         }
484     return $backupfile;
485 }
486
487 // orders the tables in $tables according to the constraints in $fks
488 // $fks musst be filled like this: $fks[tablename][0]=needed_table1; $fks[tablename][1]=needed_table2; ...
489 function order_sql_tables($tables, $fks)
490 {
491         // do not order if no contraints exist
492         if (!count($fks))
493                 return $tables;
494
495         // order
496         $new_tables = array();
497         $existing = array();
498         $modified = true;
499         while (count($tables) && $modified == true)
500         {
501                 $modified = false;
502             foreach ($tables as $key=>$row)
503             {
504                 // delete from $tables and add to $new_tables
505                 if (isset($fks[$row['Name']]))
506                 {
507                         foreach($fks[$row['Name']] as $needed)
508                         {
509                         // go to next table if not all needed tables exist in $existing
510                         if (!in_array($needed,$existing))
511                                 continue 2;
512                     }
513                 }
514             // delete from $tables and add to $new_tables
515                 $existing[] = $row['Name'];
516                         $new_tables[] = $row;
517             prev($tables);
518             unset($tables[$key]);
519             $modified = true;
520
521             }
522         }
523
524         if (count($tables))
525         {
526             // probably there are 'circles' in the constraints, bacause of that no proper backups can be created yet
527             // TODO: this will be fixed sometime later through using 'alter table' commands to add the constraints after generating the tables
528             // until now, just add the lasting tables to $new_tables, return them and print a warning
529             foreach($tables as $row)
530                 $new_tables[] = $row;
531             echo "<div class=\"red_left\">THIS DATABASE SEEMS TO CONTAIN 'RING CONSTRAINTS'. WA DOES NOT SUPPORT THEM. PROBABLY THE FOLOWING BACKUP IS DEFECT!</div>";
532         }
533         return $new_tables;
534 }
535
536 // saves the string in $fileData to the file $backupfile as gz file or not ($zip)
537 // returns backup file name if name has changed (zip), else TRUE. If saving failed, return value is FALSE
538 function save_to_file($backupfile, $zip, $fileData)
539 {
540         global $path_to_root;
541
542     if ($zip == "gzip")
543     {
544         if ($zp = @gzopen(BACKUP_PATH . $backupfile, "a9"))
545         {
546                         @gzwrite($zp, $fileData);
547                         @gzclose($zp);
548                         return true;
549         }
550         else
551         {
552                 return false;
553         }
554
555     // $zip contains the timestamp
556     }
557     elseif ($zip == "zip")
558     {
559         // based on zip.lib.php 2.2 from phpMyBackupAdmin
560         // offical zip format: http://www.pkware.com/appnote.txt
561
562         // End of central directory record
563         $eof_ctrl_dir = "\x50\x4b\x05\x06\x00\x00\x00\x00";
564
565         // "local file header" segment
566         $unc_len = strlen($fileData);
567         $crc = crc32($fileData);
568         $zdata = gzcompress($fileData);
569
570         // string needed for decoding (because of crc bug)
571         //$name_suffix = substr($zdata, -4, 4);
572         //$name_suffix2 = "_";
573         //for ($i = 0; $i < 4; $i++)
574         //      $name_suffix2 .= sprintf("%03d", ord($name_suffix[$i]));
575         //$backupfile = substr($backupfile, 0, strlen($backupfile) - 8) . $name_suffix2 . ".sql.zip";
576         $name = substr($backupfile, 0, strlen($backupfile) -4);
577
578         // fix crc bug
579         $zdata = substr(substr($zdata, 0, strlen($zdata) - 4), 2);
580         $c_len = strlen($zdata);
581
582         // dos time
583         $timearray = getdate($zip);
584         $dostime = (($timearray['year'] - 1980) << 25) | ($timearray['mon'] << 21) | ($timearray['mday'] << 16) |
585             ($timearray['hours'] << 11) | ($timearray['minutes'] << 5) | ($timearray['seconds'] >> 1);
586         $dtime = dechex($dostime);
587         $hexdtime = "\x" . $dtime[6] . $dtime[7] . "\x" . $dtime[4].$dtime[5] . "\x" . $dtime[2] . $dtime[3] . "\x" . $dtime[0] . $dtime[1];
588         eval('$hexdtime="' . $hexdtime . '";');
589
590         // ver needed to extract, gen purpose bit flag, compression method, last mod time and date
591         $sub1 = "\x14\x00" . "\x00\x00" . "\x08\x00" . $hexdtime;
592
593         // crc32, compressed filesize, uncompressed filesize
594         $sub2 = pack('V', $crc) . pack('V', $c_len) . pack('V', $unc_len);
595
596         $fr = "\x50\x4b\x03\x04" . $sub1. $sub2;
597
598         // length of filename, extra field length
599         $fr .= pack('v', strlen($name)) . pack('v', 0);
600         $fr .= $name;
601
602         // "file data" segment and "data descriptor" segment (optional but necessary if archive is not served as file)
603         $fr .= $zdata . $sub2;
604
605         // now add to central directory record
606         $cdrec = "\x50\x4b\x01\x02";
607         $cdrec .= "\x00\x00";                // version made by
608         $cdrec .= $sub1 . $sub2;
609
610          // length of filename, extra field length, file comment length, disk number start, internal file attributes, external file attributes - 'archive' bit set, offset
611         $cdrec .= pack('v', strlen($name)) . pack('v', 0) . pack('v', 0) . pack('v', 0) . pack('v', 0) . pack('V', 32) . pack('V',0);
612         $cdrec .= $name;
613
614         // combine data
615         $fileData = $fr . $cdrec . $eof_ctrl_dir;
616
617         // total # of entries "on this disk", total # of entries overall, size of central dir, offset to start of central dir, .zip file comment length
618         $fileData .= pack('v', 1) . pack('v', 1) . pack('V', strlen($cdrec)) . pack('V', strlen($fr)) . "\x00\x00";
619
620         if ($zp = @fopen(BACKUP_PATH . $backupfile, "a"))
621         {
622                         @fwrite($zp, $fileData);
623                         @fclose($zp);
624                         return true;
625         }
626         else
627         {
628                 return false;
629         }
630
631         // uncompressed
632     }
633     else
634     {
635         if ($zp = @fopen(BACKUP_PATH . $backupfile, "a"))
636         {
637                         @fwrite($zp, $fileData);
638                         @fclose($zp);
639                         return true;
640         }
641         else
642         {
643                 return false;
644         }
645     }
646 }
647
648 function create_comp_dirs($comp_path, $comp_subdirs)
649 {
650                 $index = "<?php\nheader(\"Location: ../index.php\");\n?>";
651             $cdir = $comp_path;
652             @mkdir($cdir);
653                 $f = @fopen("$cdir/index.php", "wb");
654                 @fwrite($f, $index);
655                 @fclose($f);
656
657             foreach($comp_subdirs as $dir)
658             {
659                         @mkdir($cdir.'/'.$dir);
660                         $f = @fopen("$cdir/$dir/index.php", "wb");
661                         @fwrite($f, $index);
662                         @fclose($f);
663             }
664 }
665 ?>