Enabled drop table queries during non-forced upgrade.
[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, $go_debug;
121         
122         $allowed_commands = array(
123                 "create"  => 'table_queries', 
124                 "alter table" => 'table_queries', 
125                 "insert" => 'data_queries', 
126                 "update" => 'data_queries', 
127                 "drop table if exists" => 'drop_queries');
128         $ignored_mysql_errors = array( //errors ignored in normal (non forced) mode
129                 '1022', // duplicate key
130                 '1050', // Table %s already exists
131                 '1060', // duplicate column name
132                 '1061', // duplicate key name
133                 '1062', // duplicate key entry
134                 '1091'  // can't drop key/column check if exists
135         );
136         $data_queries = array();
137         $drop_queries = array();
138         $table_queries = array();
139         $sql_errors = array();
140
141         ini_set("max_execution_time", "180");
142         db_query("SET foreign_key_checks=0");
143
144         // uncrompress gziped backup files
145         if (strpos($filename, ".gz") || strpos($filename, ".GZ"))
146                 $lines = db_ungzip("lines", $filename);
147         elseif (strpos($filename, ".zip") || strpos($filename, ".ZIP"))
148                 $lines = db_unzip("lines", $filename);
149         else
150                 $lines = file("". $filename);
151
152         // parse input file
153         $query_table = '';
154         foreach($lines as $line_no => $line)
155         {
156                 $line = trim($line);
157                 
158                 $line = str_replace("0_", $connection["tbpref"], $line);
159
160                 if ($query_table == '') 
161                 {       // check if line begins with one of allowed queries
162                         foreach($allowed_commands as $cmd => $table) 
163                         {
164                                 if (strtolower(substr($line, 0, strlen($cmd))) == $cmd) 
165                                 {
166                                         $query_table = $table;
167                                         ${$query_table}[] = array('', $line_no+1);
168                                         break;
169                                 }
170                         }
171                  }
172                  if($query_table != '')  // inside allowed query
173                  {
174                         $table = $query_table;
175                         if (substr($line, -1) == ';') // end of query found
176                         {
177                                 $line = substr($line, 0, strlen($line) - 1); // strip ';'
178                                 $query_table = '';
179                         }
180                         ${$table}[count(${$table}) - 1][0] .= $line . "\n";
181                 }
182                 
183         }
184 /*
185         {       // for debugging purposes
186         global $path_to_root;
187         $f = fopen($path_to_root.'/tmp/dbimport.txt', 'w+');
188         fwrite($f, print_r($drop_queries,true) ."\n");
189         fwrite($f, print_r($table_queries,true) ."\n");
190         fwrite($f, print_r($data_queries,true));
191         fclose($f);
192         }
193 */
194         // execute drop tables if exists queries
195         if (is_array($drop_queries))
196         {
197                 foreach($drop_queries as $drop_query)
198                 {
199                         if (!db_query($drop_query[0]))
200                         {
201                                 if (!in_array(db_error_no(), $ignored_mysql_errors) || !$force)
202                                         $sql_errors[] = array(db_error_msg($db), $drop_query[1]);
203                         }
204                 }
205         }
206
207         // execute create tables queries
208         if (is_array($table_queries))
209         {
210                 foreach($table_queries as $table_query)
211                 {
212                         if (!db_query($table_query[0]))
213                         {       
214                                 if (!in_array(db_error_no(), $ignored_mysql_errors) || !$force) {
215                                         $sql_errors[] = array(db_error_msg($db), $table_query[1]);
216                                 }
217                         }
218                 }
219         }
220
221         // execute insert data queries
222         if (is_array($data_queries))
223         {
224                 foreach($data_queries as $data_query)
225                 {
226                         if (!db_query($data_query[0]))
227                         {
228                                 if (!in_array(db_error_no(),$ignored_mysql_errors) || !$force)
229                                         $sql_errors[] = array(db_error_msg($db), $data_query[1]);
230                         }
231                 }
232         }
233         
234         db_query("SET foreign_key_checks=1");
235
236         if (count($sql_errors)) {
237                 // display first failure message; the rest are probably derivative 
238                 $err = $sql_errors[0];
239                 display_error(sprintf(_("SQL script execution failed in line %d: %s"),
240                         $err[1], $err[0]));
241                 return false;
242         } else
243                 return true;
244         //$shell_command = C_MYSQL_PATH . " -h $host -u $user -p{$password} $dbname < $filename";
245         //shell_exec($shell_command);
246 }
247
248 // returns the content of the gziped $path backup file. use of $mode see below
249 function db_ungzip($mode, $path)
250 {
251     $file_data = gzfile($path);
252     // returns one string or an array of lines
253     if ($mode != "lines")
254         return implode("",$file_data);
255     else
256         return $file_data;
257 }
258
259 // returns the content of the ziped $path backup file. use of $mode see below
260 function db_unzip($mode, $path)
261 {
262     $all = false;
263     $all = implode("", file($path));
264
265     // convert path to name of ziped file
266     $filename = ereg_replace(".*/", "", $path);
267     $filename = substr($filename, 0, strlen($filename) - 4);
268
269     // compare filname in zip and filename from $_GET
270     if (substr($all, 30, strlen($filename)-4) . substr($all, 30+strlen($filename)+9, 4)
271           != $filename) {
272                 return '';     // exit if names differ
273     }
274     else
275     {
276         // get the suffix of the filename in hex
277                 $crc_bugfix = substr($all, 30, strlen($filename)+13);
278         $crc_bugfix = substr(substr($crc_bugfix, 0, strlen($crc_bugfix) - 4), 
279                                 strlen($crc_bugfix) - 12 - 4);
280         $suffix = false;
281         // convert hex to ascii
282         for ($i=0; $i < 12; )
283                 $suffix .= chr($crc_bugfix[$i++] . $crc_bugfix[$i++] . $crc_bugfix[$i++]);
284
285         // remove central directory information (we have always just one ziped file)
286         $comp = substr($all, -(strlen($all) - 30 - strlen($filename)-13));
287         $comp = substr($comp, 0, (strlen($comp) - 80 - strlen($filename)-13));
288
289         // fix the crc bugfix (see function save_to_file)
290         $comp = "x\9c" . $comp . $suffix;
291         $file_data = gzuncompress($comp);
292     }
293
294     // returns one string or an array of lines
295     if ($mode != "lines")
296         return $file_data;
297     else
298         return explode("\n", $file_data);
299 }
300
301 // generates a dump of $db database
302 // $drop and $zip tell if to include the drop table statement or dry to pack
303 function db_export($conn, $filename, $zip='no', $comment='', $tbpref = TB_PREF)
304 {
305
306         global $app_title, $version, $power_url, $path_to_root;
307
308     $error = false;
309     // set max string size before writing to file
310     $max_size = 1048576 * 2; // 2 MB
311     // changes max size if value can be retrieved
312     if (ini_get("memory_limit"))
313         $max_size = 900000 * ini_get("memory_limit");
314
315     // set backupfile name
316     if ($zip == "gzip")
317         $backupfile = $filename . ".gz";
318     elseif ($zip == "zip")
319         $backupfile = $filename . ".zip";
320     else
321         $backupfile = $filename;
322     $company = get_company_pref('coy_name', $tbpref);
323
324     //create comment
325     $out="# MySQL dump of database '".$conn["dbname"]."' on host '".$conn["host"]."'\n";
326     $out.="# Backup Date and Time: ".date("Y-m-d H:i")."\n";
327     $out.="# Built by " . $app_title . " " . $version ."\n";
328     $out.="# ".$power_url."\n";
329     $out.="# Company: ". @html_entity_decode($company, ENT_COMPAT, $_SESSION['language']->encoding)."\n";
330     $out.="# User: ".$_SESSION["wa_current_user"]->name."\n\n";
331
332         // write users comment
333         if ($comment)
334         {
335                 $out .= "# Comment:\n";
336                 $comment=preg_replace("'\n'","\n# ","# ".$comment);
337                 //$comment=str_replace("\n", "\n# ", $comment);
338                 foreach(explode("\n",$comment) as $line)
339                         $out .= $line."\n";
340                 $out.="\n";
341         }
342
343     //$out.="use ".$db.";\n"; we don't use this option.
344
345     // get auto_increment values and names of all tables
346     $res = db_query("show table status");
347     $all_tables = array();
348     while($row = db_fetch($res))
349     {
350                 //if ($conn["tbpref"] == "" || strpos($row['Name'], $conn["tbpref"]) !== false) replaced
351                 if (($conn["tbpref"] == "" && !preg_match('/[0-9]+_/', $row['Name'])) ||
352                         ($conn["tbpref"] != "" && strpos($row['Name'], $conn["tbpref"]) !== false))
353                 $all_tables[] = $row;
354     }
355         // get table structures
356         foreach ($all_tables as $table)
357         {
358                 $res1 = db_query("SHOW CREATE TABLE `" . $table['Name'] . "`");
359                 $tmp = db_fetch($res1);
360                 $table_sql[$table['Name']] = $tmp["Create Table"];
361         }
362
363         // find foreign keys
364         $fks = array();
365         if (isset($table_sql))
366         {
367                 foreach($table_sql as $tablenme=>$table)
368                 {
369                         $tmp_table=$table;
370                         // save all tables, needed for creating this table in $fks
371                         while (($ref_pos = strpos($tmp_table, " REFERENCES ")) > 0)
372                         {
373                                 $tmp_table = substr($tmp_table, $ref_pos + 12);
374                                 $ref_pos = strpos($tmp_table, "(");
375                                 $fks[$tablenme][] = substr($tmp_table, 0, $ref_pos);
376                         }
377                 }
378         }
379         // order $all_tables
380         $all_tables = order_sql_tables($all_tables, $fks);
381
382         // as long as no error occurred
383         if (!$error)
384         {
385                 //while($row=@mysql_fetch_array($res))
386                 foreach ($all_tables as $row)
387                 {
388                         $tablename = $row['Name'];
389                         $auto_incr[$tablename] = $row['Auto_increment'];
390
391                         $out.="\n\n";
392                         // export tables
393                         $out.="### Structure of table `".$tablename."` ###\n\n";
394
395                         $out.="DROP TABLE IF EXISTS `".$tablename."`;\n\n";
396                         $out.=$table_sql[$tablename];
397
398                         // add auto_increment value
399                         if ($auto_incr[$tablename])
400                                 $out.=" AUTO_INCREMENT=".$auto_incr[$tablename];
401                         $out.=" ;";
402                         $out.="\n\n\n";
403
404                         // export data
405                         if (!$error)
406                         {
407                                 $out.="### Data of table `".$tablename."` ###\n\n";
408
409                                 // check if field types are NULL or NOT NULL
410                                 $res3 = db_query("SHOW COLUMNS FROM `" . $tablename . "`");
411
412                                 $field_type = array();
413                                 for ($j = 0; $j < db_num_rows($res3); $j++)
414                                 {
415                                         $row3 = db_fetch($res3);
416                                         $field_type[] = $row3[2];
417                                 }
418
419                                 $res2 = db_query("SELECT * FROM `" . $tablename . "`");
420                                 for ($j = 0; $j < db_num_rows($res2); $j++)
421                                 {
422                                         $out .= "INSERT INTO `" . $tablename . "` VALUES (";
423                                         $row2 = db_fetch_row($res2);
424                                         // run through each field
425                                         for ($k = 0; $k < $nf = db_num_fields($res2); $k++)
426                                         {
427                                                 $out .= db_escape(@html_entity_decode($row2[$k], ENT_COMPAT, $_SESSION['language']->encoding));
428                                                 if ($k < ($nf - 1))
429                                                         $out .= ", ";
430                                         }
431                                         $out .= ");\n";
432
433                                         // if saving is successful, then empty $out, else set error flag
434                                         if (strlen($out) > $max_size && $zip != "zip")
435                                         {
436                                                 if (save_to_file($backupfile, $zip, $out))
437                                                         $out = "";
438                                                 else
439                                                         $error = true;
440                                         }
441                                 }
442
443                         // an error occurred! Try to delete file and return error status
444                         }
445                         elseif ($error)
446                         {
447                                 @unlink(BACKUP_PATH . $backupfile);
448                                 return false;
449                         }
450
451                         // if saving is successful, then empty $out, else set error flag
452                         if (strlen($out) > $max_size && $zip != "zip")
453                         {
454                                 if (save_to_file($backupfile, $zip, $out))
455                                         $out= "";
456                                 else
457                                         $error = true;
458                         }
459                 }
460
461         // an error occurred! Try to delete file and return error status
462         }
463         else
464         {
465                 @unlink(BACKUP_PATH . $backupfile);
466                 return false;
467         }
468
469         // if (mysql_error()) return "DB_ERROR";
470         //@mysql_close($con);
471
472         //if ($zip == "zip")
473         //      $zip = $time;
474         if (save_to_file($backupfile, $zip, $out))
475         {
476                 $out = "";
477         }
478         else
479         {
480                 @unlink(BACKUP_PATH . $backupfile);
481                 return false;
482         }
483     return $backupfile;
484 }
485
486 // orders the tables in $tables according to the constraints in $fks
487 // $fks musst be filled like this: $fks[tablename][0]=needed_table1; $fks[tablename][1]=needed_table2; ...
488 function order_sql_tables($tables, $fks)
489 {
490         // do not order if no contraints exist
491         if (!count($fks))
492                 return $tables;
493
494         // order
495         $new_tables = array();
496         $existing = array();
497         $modified = true;
498         while (count($tables) && $modified == true)
499         {
500                 $modified = false;
501             foreach ($tables as $key=>$row)
502             {
503                 // delete from $tables and add to $new_tables
504                 if (isset($fks[$row['Name']]))
505                 {
506                         foreach($fks[$row['Name']] as $needed)
507                         {
508                         // go to next table if not all needed tables exist in $existing
509                         if (!in_array($needed,$existing))
510                                 continue 2;
511                     }
512                 }
513             // delete from $tables and add to $new_tables
514                 $existing[] = $row['Name'];
515                         $new_tables[] = $row;
516             prev($tables);
517             unset($tables[$key]);
518             $modified = true;
519
520             }
521         }
522
523         if (count($tables))
524         {
525             // probably there are 'circles' in the constraints, bacause of that no proper backups can be created yet
526             // TODO: this will be fixed sometime later through using 'alter table' commands to add the constraints after generating the tables
527             // until now, just add the lasting tables to $new_tables, return them and print a warning
528             foreach($tables as $row)
529                 $new_tables[] = $row;
530             echo "<div class=\"red_left\">THIS DATABASE SEEMS TO CONTAIN 'RING CONSTRAINTS'. WA DOES NOT SUPPORT THEM. PROBABLY THE FOLOWING BACKUP IS DEFECT!</div>";
531         }
532         return $new_tables;
533 }
534
535 // saves the string in $fileData to the file $backupfile as gz file or not ($zip)
536 // returns backup file name if name has changed (zip), else TRUE. If saving failed, return value is FALSE
537 function save_to_file($backupfile, $zip, $fileData)
538 {
539         global $path_to_root;
540
541     if ($zip == "gzip")
542     {
543         if ($zp = @gzopen(BACKUP_PATH . $backupfile, "a9"))
544         {
545                         @gzwrite($zp, $fileData);
546                         @gzclose($zp);
547                         return true;
548         }
549         else
550         {
551                 return false;
552         }
553
554     // $zip contains the timestamp
555     }
556     elseif ($zip == "zip")
557     {
558         // based on zip.lib.php 2.2 from phpMyBackupAdmin
559         // offical zip format: http://www.pkware.com/appnote.txt
560
561         // End of central directory record
562         $eof_ctrl_dir = "\x50\x4b\x05\x06\x00\x00\x00\x00";
563
564         // "local file header" segment
565         $unc_len = strlen($fileData);
566         $crc = crc32($fileData);
567         $zdata = gzcompress($fileData);
568
569                 // extend stored file name with suffix
570         // 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
576         $name = substr($backupfile, 0, strlen($backupfile) - 8) . $name_suffix2 . ".sql";
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 ?>