admin/db/maintenance_db.inc

   1 <?php
   2 /**********************************************************************
   3     Copyright (C) FrontAccounting, LLC.
   4         Released under the terms of the GNU General Public License,
   5         GPL, as published by the Free Software Foundation, either version
   6         3 of the License, or (at your option) any later version.
   7     This program is distributed in the hope that it will be useful,
   8     but WITHOUT ANY WARRANTY; without even the implied warranty of
   9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
  11 ***********************************************************************/
  12
  13 /**
  14  * @return Returns the array sorted as required
  15  * @param $aryData Array containing data to sort
  16  * @param $strIndex name of column to use as an index
  17  * @param $strSortBy Column to sort the array by
  18  * @param $strSortType String containing either asc or desc [default to asc]
  19  * @desc Naturally sorts an array using by the column $strSortBy
  20  */
  21 define('EXPORT_MAX_INSERT', 50000);
  22
  23 function array_natsort($aryData, $strIndex, $strSortBy, $strSortType=false)
  24 {
  25    //    if the parameters are invalid
  26    if (!is_array($aryData) || !$strSortBy)
  27        //    return the array
  28        return $aryData;
  29
  30    //    create our temporary arrays
  31    $arySort = $aryResult = array();
  32
  33    //    loop through the array
  34    foreach ($aryData as $key => $aryRow)
  35        //    set up the value in the array
  36        $arySort[$strIndex ? $aryRow[$strIndex] : $key] = $aryRow[$strSortBy];
  37
  38    //    apply the natural sort
  39    natsort($arySort);
  40
  41    //    if the sort type is descending
  42    if ($strSortType=="desc")
  43        //    reverse the array
  44        arsort($arySort);
  45
  46    //    loop through the sorted and original data
  47                 foreach ($arySort as $arySortKey => $arySorted)
  48                         if($strIndex)
  49                         {
  50                                 foreach ($aryData as $aryOriginal)
  51                                 // if the key matches
  52                                         if ($aryOriginal[$strIndex]==$arySortKey)
  53                                                 // add it to the output array
  54                                                 array_push($aryResult, $aryOriginal);
  55                         } else
  56                                 $aryResult[$arySortKey] = $aryData[$arySortKey];
  57    //    return the return
  58    return $aryResult;
  59 }
  60
  61 function update_admin_password($conn, $password)
  62 {
  63         $sql = "UPDATE ".$conn['tbpref']."users SET password=".db_escape($password) . "
  64                 WHERE user_id='admin'";
  65         db_query($sql, "could not update user password for 'admin'");
  66 }
  67
  68 function write_config_db($new = false)
  69 {
  70         global $path_to_root, $def_coy, $db_connections, $tb_pref_counter;
  71
  72         if ($new)
  73                 $tb_pref_counter++;
  74         $msg = "<?php\n\n";
  75         $msg .= "/*Connection Information for the database\n";
  76         $msg .= "\$def_coy - the default company that is pre-selected on login\n\n";
  77         $msg .= "'host' - the computer ip address or name where the database is. The default is 'localhost' assuming that the web server is also the sql server.\n\n";
  78         $msg .= "'port' - the computer port where the database is. The default is '3306'. Set empty for default.\n\n";
  79         $msg .= "'dbuser' - the user name under which the company database should be accessed.\n";
  80         $msg .= "  NB it is not secure to use root as the dbuser with no password - a user with appropriate privileges must be set up.\n\n";
  81         $msg .= "'dbpassword' - the password required for the dbuser to authorise the above database user.\n\n";
  82         $msg .= "'dbname' - the name of the database as defined in the RDMS being used. Typically RDMS allow many databases to be maintained under the same server.\n";
  83         $msg .= "'collation' - the character set used for the database.\n";
  84         $msg .= "'tbpref' - prefix on table names, or '' if not used. Always use non-empty prefixes if multiply company use the same database.\n";
  85         $msg .= "*/\n\n\n";
  86
  87         $msg .= "\$def_coy = " . $def_coy . ";\n\n";
  88         $msg .= "\$tb_pref_counter = " . $tb_pref_counter . ";\n\n";
  89         $msg .= "\$db_connections = " .var_export($db_connections, true);
  90         $msg .= ";\n";
  91
  92         $filename = $path_to_root . "/config_db.php";
  93         // Check if the file exists and is writable first.
  94         if ((!file_exists($filename) && is_writable($path_to_root)) || is_writable($filename))
  95         {
  96                 if (!$zp = fopen($filename, 'w'))
  97                 {
  98                         return -1;
  99                 }
 100                 else
 101                 {
 102                         if (!fwrite($zp, $msg))
 103                         {
 104                                 fclose($zp);
 105                                 return -2;
 106                         }
 107                         // Close file
 108                         fclose($zp);
 109                         cache_invalidate($filename);
 110                 }
 111         }
 112         else
 113         {
 114                 return -3;
 115         }
 116         return 0;
 117 }
 118
 119 function write_extensions($extensions=null, $company = -1)
 120 {
 121         global $path_to_root, $installed_extensions, $next_extension_id;
 122
 123         if (!isset($extensions)) {
 124                 $extensions = $installed_extensions;
 125         }
 126         if (!isset($next_extension_id)) {
 127                 $next_extension_id = 1;
 128         }
 129
 130         $msg = "<?php\n\n";
 131         if ($company == -1)
 132                 $msg .=
 133 "/* List of installed additional extensions. If extensions are added to the list manually
 134         make sure they have unique and so far never used extension_ids as a keys,
 135         and \$next_extension_id is also updated. More about format of this file yo will find in
 136         FA extension system documentation.
 137 */
 138 \n\$next_extension_id = $next_extension_id; // unique id for next installed extension\n\n";
 139         else
 140                 $msg .=
 141 "/*
 142         Do not edit this file manually. This copy of global file is overwritten
 143         by extensions editor.
 144 */\n\n";
 145
 146         $msg .= "\$installed_extensions = ". var_export($extensions, true);
 147         $msg .= ";\n";
 148         $filename = $path_to_root . ($company==-1 ? '' : '/company/'.$company)
 149                 .'/installed_extensions.php';
 150
 151         // Check if the file is writable first.
 152         if (!$zp = @fopen($filename, 'w'))
 153         {
 154                 display_error(sprintf(_("Cannot open the extension setup file '%s' for writing."),
 155                          $filename));
 156                 return false;
 157         }
 158         else
 159         {
 160                 if (!fwrite($zp, $msg))
 161                 {
 162                         display_error(sprintf(_("Cannot write to the extensions setup file '%s'."),
 163                                 $filename));
 164                         fclose($zp);
 165                         return false;
 166                 }
 167                 // Close file
 168                 fclose($zp);
 169                 cache_invalidate($filename);
 170         }
 171         return true;
 172 }
 173 //---------------------------------------------------------------------------------------------
 174 //
 175 // Update per-company list of installed extensions
 176 //
 177 function update_extensions($extensions) {
 178         global $db_connections;
 179
 180         if (!write_extensions($extensions)) {
 181                 display_notification(_("Cannot update system extensions list."));
 182                 return false;
 183         }
 184
 185         // update per company files
 186         $cnt = max(1, count_array($db_connections));
 187         for($i = 0; $i < $cnt; $i++)
 188         {
 189                 $newexts = $extensions;
 190                 // update 'active' status
 191                 $exts = get_company_extensions($i);
 192                 foreach ($exts as $key => $ext)
 193                 {
 194                         if (isset($newexts[$key]))
 195                                 $newexts[$key]['active'] = $exts[$key]['active'];
 196                 }
 197                 if(!write_extensions($newexts, $i))
 198                 {
 199                         display_notification(sprintf(_("Cannot update extensions list for company '%s'."),
 200                                 $db_connections[$i]['name']));
 201                  return false;
 202                 }
 203         }
 204         return true;
 205 }
 206
 207
 208 function write_lang()
 209 {
 210         global $path_to_root, $installed_languages, $dflt_lang;
 211
 212         $installed_languages = array_natsort($installed_languages, 'code', 'code');
 213         $msg = "<?php\n\n";
 214
 215         $msg .= "/* How to make new entries here for non-packaged languages:\n\n";
 216         $msg .= "-- 'code' should match the name of the directory for the language under \\lang\n.";
 217         $msg .= "-- 'name' is the name that will be displayed in the language selection list (in Users and Display Setup)\n";
 218         $msg .= "-- 'rtl' only needs to be set for right-to-left languages like Arabic and Hebrew\n";
 219         $msg .= "-- 'encoding' used in translation file\n";
 220         $msg .= "-- 'version' always set to '' for manually installed languages.\n";
 221         $msg .= "-- 'path' installation path related to FA root (e.g. 'lang/en_US').\n";
 222         $msg .= "*/\n\n\n";
 223
 224         $msg .= "\$installed_languages = " . var_export($installed_languages, true);
 225         $msg .= ";\n";
 226         $msg .= "\n\$dflt_lang = '$dflt_lang';\n";
 227
 228         $path = $path_to_root . "/lang";
 229         $filename = $path.'/installed_languages.inc';
 230         // Check if directory exists and is writable first.
 231         if (file_exists($path) && is_writable($path))
 232         {
 233                 if (!$zp = fopen($filename, 'w'))
 234                 {
 235                         display_error(_("Cannot open the languages file - ") . $filename);
 236                         return false;
 237                 }
 238                 else
 239                 {
 240                         if (!fwrite($zp, $msg))
 241                         {
 242                                 display_error(_("Cannot write to the language file - ") . $filename);
 243                                 fclose($zp);
 244                                 return false;
 245                         }
 246                         // Close file
 247                         fclose($zp);
 248                         cache_invalidate($filename);
 249                 }
 250         }
 251         else
 252         {
 253                 display_error(_("The language files folder ") . $path . _(" is not writable. Change its permissions so it is, then re-run the operation."));
 254                 return false;
 255         }
 256         return true;
 257 }
 258 /*
 259         Database import:
 260                 $filename - sql file name
 261                 $connection - database connection
 262                 $force - ignore duplicate errors
 263                 $init - presume $filename is initialization file with '0_' prefix
 264                 $protect - protect users/roles
 265                 $system - system upgrade; no constrains on queries, does not rearrange sql queries, returns collected errors
 266 */
 267 function db_import($filename, $connection, $force=true, $init=true, $protect=false, $system=false)
 268 {
 269         global $db, $SysPrefs;
 270
 271         $trail = $SysPrefs->sql_trail;
 272         $SysPrefs->sql_trail = false;
 273
 274         $allowed_commands = array(
 275                 "create"  => 'table_queries',
 276                 "delimiter" => 'table_queries',
 277                 "alter table" => 'table_queries',
 278                 "insert" => 'data_queries',
 279                 "update" => 'data_queries',
 280                 "set names" => 'set_names',
 281                 "drop table if exists" => 'drop_queries',
 282                 "drop function if exists" => 'drop_queries',
 283                 "drop trigger if exists" => 'drop_queries',
 284                 "select" => 'data_queries',
 285                 "delete" => 'data_queries',
 286                 );
 287
 288         $protected = array(
 289                 'security_roles',
 290                 'users'
 291         );
 292
 293         $ignored_mysql_errors = array( //errors ignored in normal (non forced) mode
 294                 '1022', // duplicate key
 295                 '1050', // Table %s already exists
 296                 '1060', // duplicate column name
 297                 '1061', // duplicate key name
 298                 '1062', // duplicate key entry
 299                 '1091'  // can't drop key/column check if exists
 300         );
 301
 302         $set_names = array();
 303         $data_queries = array();
 304         $drop_queries = array();
 305         $table_queries = array();
 306         $sql_errors = array();
 307
 308         $old_encoding = db_get_charset($db);
 309
 310         ini_set("max_execution_time", max("180", ini_get("max_execution_time")));
 311         db_query("SET foreign_key_checks=0");
 312         db_query("SET sql_mode=''");
 313
 314         if (isset($connection['collation']))
 315                 db_set_collation($db, $connection['collation']);
 316
 317         $check_line_len = false;
 318
 319         // uncompress gziped backup files
 320         if (strpos($filename, ".gz") || strpos($filename, ".GZ"))
 321         {       $lines = db_ungzip("lines", $filename);
 322                 $check_line_len = true;
 323         } elseif (strpos($filename, ".zip") || strpos($filename, ".ZIP"))
 324                 $lines = db_unzip("lines", $filename);
 325         else
 326                 $lines = file("". $filename);
 327
 328         // parse input file
 329         $query_table = '';
 330         $delimiter = ';';
 331
 332         foreach($lines as $line_no => $line)
 333         {
 334                 $gzfile_bug = $check_line_len && (strlen($line) == 8190); // there is a bug in php (at least 4.1.1-5.5.9) gzfile which limits line length to 8190 bytes!
 335
 336                 $line = trim($line);
 337                 if ($init)
 338                         $line = str_replace("0_", $connection["tbpref"], $line);
 339
 340                 if ($query_table == '')
 341                 {       // check if line begins with one of allowed queries
 342                         if ($system) {
 343                                 $query_table = 'data_queries';  // dont reorder queries, only standard delimiter allowed
 344                                 ${$query_table}[] = array('', $line_no+1);
 345                                 $skip = false;
 346                         } else
 347                                 foreach($allowed_commands as $cmd => $table)
 348                                 {
 349                                         if (strtolower(substr($line, 0, strlen($cmd))) == $cmd)
 350                                         {
 351                                                 if ($cmd == 'delimiter') {
 352                                                         $delimiter = trim(substr($line, 10));
 353                                                         continue 2;
 354                                                 }
 355                                                 $query_table = $table;
 356                                                 $skip = false;
 357                                                 if ($protect)
 358                                                 {
 359                                                         foreach($protected as $protbl)
 360                                                                 if (strpos($line, $connection["tbpref"].$protbl) !== false)
 361                                                                 {
 362                                                                         $skip = true; break;
 363                                                                 }
 364                                                 }
 365                                                 if (!$skip)
 366                                                         ${$query_table}[] = array('', $line_no+1);
 367                                                 break;
 368                                         }
 369                                 }
 370                  }
 371                  if($query_table != '')  // inside allowed query
 372                  {
 373                         $table = $query_table;
 374                         if (!$gzfile_bug && substr($line, -strlen($delimiter)) == $delimiter) // end of query found
 375                         {
 376                                 $line = substr($line, 0, strlen($line) - strlen($delimiter)); // strip delimiter
 377                                 $query_table = '';
 378                         }
 379                         if (!$skip)
 380                                 ${$table}[count(${$table}) - 1][0] .= $line . "\n";
 381                 }
 382
 383         }
 384
 385         //
 386         // 'set names' or equivalents should be used only on post 2.3 FA versions
 387         // otherwise text encoding can be broken during import
 388         //
 389         $encoding = null; // UI encoding for default site language is the default
 390         $new_db = $init || db_fixed();
 391         $new_file = count($set_names);
 392         if ($new_db)
 393         {
 394                 if ($new_file)
 395                 {
 396                         if (count($set_names)) // standard db restore
 397                         {
 398                                 if (preg_match('/set\s*names\s*[\']?(\w*)[\']?/i', $set_names[0][0], $match))
 399                                         $encoding = $match[1];
 400                         }
 401                         // otherwise use default site ui encoding
 402                 }
 403         }
 404         else
 405         {
 406                 if ($new_file) // import on old db is forbidden: this would destroy db content unless latin1 was used before in UI
 407                 {
 408                         $msg = _("This is new format backup file which cannot be restored on database not migrated to utf8.");
 409                         if ($system)
 410                                 return $msg;
 411                         else
 412                                 display_error($msg);
 413                         return false;
 414                 }
 415                  else   // backup restore during upgrade failure
 416                         $encoding = 'latin1'; // standard encoding on mysql client
 417         }
 418
 419         db_set_charset($db, $encoding);
 420
 421 /*/     {       // for debugging purposes
 422         global $path_to_root;
 423         $f = fopen($path_to_root.'/tmp/dbimport.txt', 'w+');
 424         fwrite($f, print_r($set_names,true) ."\n");
 425         fwrite($f, print_r($drop_queries,true) ."\n");
 426         fwrite($f, print_r($table_queries,true) ."\n");
 427         fwrite($f, print_r($data_queries,true));
 428         fclose($f);
 429         }
 430 /*/
 431         if ($system)
 432         {       // prevent errors display
 433                 $save_debug = $SysPrefs->go_debug;
 434                 $SysPrefs->go_debug = 0;
 435         }
 436         // execute drop tables if exists queries
 437         if (is_array($drop_queries))
 438         {
 439                 foreach($drop_queries as $drop_query)
 440                 {
 441                         if (!db_query($drop_query[0]))
 442                         {
 443                                 if (!in_array(db_error_no(), $ignored_mysql_errors) || !$force)
 444                                         $sql_errors[] = array(db_error_msg($db), $drop_query[1]);
 445                         }
 446                 }
 447         }
 448
 449         // execute create tables queries
 450         if (is_array($table_queries))
 451         {
 452                 foreach($table_queries as $table_query)
 453                 {
 454                         if (!db_query($table_query[0]))
 455                         {
 456                                 if (!in_array(db_error_no(), $ignored_mysql_errors) || !$force) {
 457                                         $sql_errors[] = array(db_error_msg($db), $table_query[1]);
 458                                 }
 459                         }
 460                 }
 461         }
 462
 463         // execute insert data queries
 464         if (is_array($data_queries))
 465         {
 466                 foreach($data_queries as $data_query)
 467                 {
 468                         if (!db_query($data_query[0]))
 469                         {
 470                                 if (!in_array(db_error_no(),$ignored_mysql_errors) || !$force)
 471                                         $sql_errors[] = array(db_error_msg($db), $data_query[1]);
 472                         }
 473                 }
 474         }
 475
 476         if ($system)
 477                 $SysPrefs->go_debug = $save_debug;
 478
 479         $SysPrefs->sql_trail = $trail;
 480
 481         db_query("SET foreign_key_checks=1");
 482         if ($delimiter != ';') db_query("delimiter ;"); // just for any case
 483
 484         db_set_charset($db, $old_encoding); // restore connection encoding
 485
 486         if (count($sql_errors)) {
 487                 if ($system)
 488                         return $sql_errors;
 489
 490                 // display first failure message; the rest are probably derivative
 491                 $err = $sql_errors[0];
 492                 display_error(sprintf(_("SQL script execution failed in line %d: %s"),
 493                         $err[1], $err[0]));
 494                 return false;
 495         } else
 496                 return true;
 497 }
 498
 499 // returns the content of the gziped $path backup file. use of $mode see below
 500 function db_ungzip($mode, $path)
 501 {
 502     $file_data = gzfile($path);
 503     // returns one string or an array of lines
 504     if ($mode != "lines")
 505         return implode("",$file_data);
 506     else
 507         return $file_data;
 508 }
 509
 510 // returns the content of the ziped $path backup file. use of $mode see below
 511 function db_unzip($mode, $path)
 512 {
 513     $all = false;
 514     $all = implode("", file($path));
 515
 516     // convert path to name of ziped file
 517     $filename = preg_replace("/.*\//", "", $path);
 518     $filename = substr($filename, 0, strlen($filename) - 4);
 519
 520     // compare filname in zip and filename from $_GET
 521     if (substr($all, 30, strlen($filename)-4) . substr($all, 30+strlen($filename)+9, 4)
 522           != $filename) {
 523                 return '';     // exit if names differ
 524     }
 525     else
 526     {
 527         // get the suffix of the filename in hex
 528                 $crc_bugfix = substr($all, 30, strlen($filename)+13);
 529         $crc_bugfix = substr(substr($crc_bugfix, 0, strlen($crc_bugfix) - 4),
 530                                 strlen($crc_bugfix) - 12 - 4);
 531         $suffix = false;
 532         // convert hex to ascii
 533         for ($i=0; $i < 12; )
 534                 $suffix .= chr($crc_bugfix[$i++] . $crc_bugfix[$i++] . $crc_bugfix[$i++]);
 535
 536         // remove central directory information (we have always just one ziped file)
 537         $comp = substr($all, -(strlen($all) - 30 - strlen($filename)-13));
 538         $comp = substr($comp, 0, (strlen($comp) - 80 - strlen($filename)-13));
 539
 540         // fix the crc bugfix (see function save_to_file)
 541         $comp = "x\9c" . $comp . $suffix;
 542         $file_data = gzuncompress($comp);
 543     }
 544
 545     // returns one string or an array of lines
 546     if ($mode != "lines")
 547         return $file_data;
 548     else
 549         return explode("\n", $file_data);
 550 }
 551
 552 function db_backup($conn, $ext='no', $comm='', $path='')
 553 {
 554         if ($conn['tbpref'] != "")
 555                 $filename = $conn['dbname'] . "_" . $conn['tbpref'] . date("Ymd_Hi") . ".sql";
 556         else
 557                 $filename = $conn['dbname'] . "_" . date("Ymd_Hi") . ".sql";
 558
 559         return db_export($conn, $path . clean_file_name($filename), $ext, $comm);
 560 }
 561 // Generates a dump of $db database
 562 //
 563 function db_export($conn, $filename, $zip='no', $comment='')
 564 {
 565
 566         global $SysPrefs, $version;
 567
 568     $error = false;
 569     // set max string size before writing to file
 570     $max_size = 1048576 * 2; // 2 MB
 571     // changes max size if value can be retrieved
 572     if (ini_get("memory_limit"))
 573         $max_size = 1048576 * (int)ini_get("memory_limit");
 574     // set backupfile name
 575     if ($zip == "gzip")
 576         $backupfile = $filename . ".gz";
 577     elseif ($zip == "zip")
 578         $backupfile = $filename . ".zip";
 579     else
 580         $backupfile = $filename;
 581     $company = $conn['name']; // get_company_pref('coy_name');
 582
 583         if (file_exists($backupfile))   // prevent appends
 584                 unlink($backupfile);
 585
 586     //create comment
 587     $out="# MySQL dump of database '".$conn["dbname"]."' on host '".$conn["host"]."'\n";
 588     $out.="# Backup Date and Time: ".date("Y-m-d H:i")."\n";
 589     $out.="# Built by " . $SysPrefs->app_title . " " . $version ."\n";
 590     $out.="# ".$SysPrefs->power_url."\n";
 591     $out.="# Company: ". @html_entity_decode($company, ENT_QUOTES, $_SESSION['language']->encoding)."\n";
 592     $out.="# User: ".$_SESSION["wa_current_user"]->name."\n\n";
 593     $out.="# Compatibility: ".get_company_pref('version_id')."\n\n";
 594
 595         // write users comment
 596         if ($comment)
 597         {
 598                 $out .= "# Comment:\n";
 599                 $comment=preg_replace("'\n'","\n# ","# ".$comment);
 600                 //$comment=str_replace("\n", "\n# ", $comment);
 601                 foreach(explode("\n",$comment) as $line)
 602                         $out .= $line."\n";
 603                 $out.="\n";
 604         }
 605
 606         if (db_fixed())
 607         {
 608                 db_set_encoding();
 609                 if ($mysql_enc = get_mysql_encoding_name($_SESSION['language']->encoding))
 610                         $out .= "\nSET NAMES $mysql_enc;\n";
 611         }
 612     // get auto_increment values and names of all tables
 613     $res = db_query("show table status");
 614     $all_tables = array();
 615     while($row = db_fetch($res))
 616     {
 617                 if (($conn["tbpref"] == "" && !preg_match('/[0-9]+_/', $row['Name'])) ||
 618                         ($conn["tbpref"] != "" && strpos($row['Name'], $conn["tbpref"]) === 0))
 619                 $all_tables[] = $row;
 620     }
 621         // get table structures
 622         foreach ($all_tables as $table)
 623         {
 624                 $res1 = db_query("SHOW CREATE TABLE `" . $table['Name'] . "`");
 625                 $tmp = db_fetch($res1);
 626                 $table_sql[$table['Name']] = $tmp["Create Table"];
 627         }
 628
 629         // find foreign keys
 630         $fks = array();
 631         if (isset($table_sql))
 632         {
 633                 foreach($table_sql as $tablenme=>$table)
 634                 {
 635                         $tmp_table=$table;
 636                         // save all tables, needed for creating this table in $fks
 637                         while (($ref_pos = strpos($tmp_table, " REFERENCES ")) > 0)
 638                         {
 639                                 $tmp_table = substr($tmp_table, $ref_pos + 12);
 640                                 $ref_pos = strpos($tmp_table, "(");
 641                                 $fks[$tablenme][] = substr($tmp_table, 0, $ref_pos);
 642                         }
 643                 }
 644         }
 645         // order $all_tables
 646         $all_tables = order_sql_tables($all_tables, $fks);
 647
 648         // as long as no error occurred
 649         if (!$error)
 650         {
 651                 foreach ($all_tables as $row)
 652                 {
 653                         $tablename = $row['Name'];
 654                         $auto_incr[$tablename] = $row['Auto_increment'];
 655
 656                         $out.="\n\n";
 657                         // export tables
 658                         $out.="### Structure of table `".$tablename."` ###\n\n";
 659
 660                         $out.="DROP TABLE IF EXISTS `".$tablename."`;\n\n";
 661                         $out.=$table_sql[$tablename];
 662
 663                         $out.=" ;";
 664                         $out.="\n\n";
 665
 666                         // export data
 667                         if (!$error)
 668                         {
 669                                 $out.="### Data of table `".$tablename."` ###\n";
 670
 671                                 // check if field types are NULL or NOT NULL
 672                                 $res3 = db_query("SHOW COLUMNS FROM `" . $tablename . "`");
 673
 674                                 $field_null = array();
 675                                 for ($j = 0; $j < db_num_rows($res3); $j++)
 676                                 {
 677                                         $row3 = db_fetch($res3);
 678                                         $field_null[] = $row3[2]=='YES' && $row3[4]===null;
 679                                 }
 680
 681                                 $res2 = db_query("SELECT * FROM `" . $tablename . "`");
 682                                 $maxinsert = 0;
 683                                 $insert = '';
 684                                 for ($j = 0; $j < db_num_rows($res2); $j++)
 685                                 {
 686                                         $row2 = db_fetch_row($res2);
 687                                         $values = '(';
 688                                         for ($k = 0; $k < $nf = db_num_fields($res2); $k++)
 689                                         {
 690                                                 $values .= db_escape($row2[$k], $field_null[$k]);
 691                                                 if ($k < ($nf - 1))
 692                                                         $values .= ', ';
 693                                         }
 694                                         $values .= ')';
 695                                         $len = strlen($values);
 696                                         if ($maxinsert < $len+1)
 697                                         {
 698                                                 $maxinsert = EXPORT_MAX_INSERT;
 699                                                 if ($insert)
 700                                                 {
 701                                                         $out .= $insert .';'; // flush insert query
 702                                                         $insert = '';
 703                                                 }
 704                                         }
 705
 706                                         if ($insert == '')
 707                                         {
 708                                                 $insert = "\nINSERT INTO `" . $tablename . "` VALUES\n";
 709                                                 $maxinsert -= strlen($insert);
 710                                         } else {
 711                                                 $insert .= ",\n";
 712                                         }
 713
 714                                         $maxinsert -= $len;
 715                                         $insert .= $values;
 716
 717                                         // if saving is successful, then empty $out, else set error flag
 718                                         if (strlen($out) > $max_size && $zip != "zip")
 719                                         {
 720                                                 if (save_to_file($backupfile, $zip, $out))
 721                                                         $out = "";
 722                                                 else
 723                                                         $error = true;
 724                                         }
 725                                 }
 726                                 if ($insert)
 727                                         $out .= $insert. ';';
 728                         // an error occurred! Try to delete file and return error status
 729                         }
 730                         elseif ($error)
 731                         {
 732                                 @unlink($backupfile);
 733                                 return false;
 734                         }
 735
 736                         // if saving is successful, then empty $out, else set error flag
 737                         if (strlen($out) > $max_size && $zip != "zip")
 738                         {
 739                                 if (save_to_file($backupfile, $zip, $out))
 740                                         $out= "";
 741                                 else
 742                                         $error = true;
 743                         }
 744                 }
 745
 746         // an error occurred! Try to delete file and return error status
 747         }
 748         else
 749         {
 750                 @unlink($backupfile);
 751                 return false;
 752         }
 753
 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