Source for file upgradedatabase.php

Documentation is available at upgradedatabase.php

  1. <?php
  2. /**
  3. * Upgrade the database to the latest version used by Bumblebee
  4. *
  5. * @author     Stuart Prescott
  6. * @copyright  Copyright Stuart Prescott
  7. * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  8. * @version    $Id$
  9. * @package    Bumblebee
  10. * @subpackage Installer
  11. */
  12.  
  13. require_once 'loadconfig.php';
  14. loadInstalledConfig();
  15.  
  16. // we will need auth rights to alter the structure of the table to actually perform these operations
  17. // as per the installer, we give the option of making an SQL file for the user to make use of using
  18. // either command line tools or phpMyAdmin, or we execute the statements for the user.
  19.  
  20. function getCurrentDBVersion() {
  21.   // there is no defined way of working out what version of the database the installation
  22.   // is using (at least not for anything in the 1.x series). We'll have to guess.
  23.   $structure = db_get_single('SHOW CREATE TABLE users');
  24.   #print "Apparent structure is ".$structure[1]."<br />";
  25.   if (strpos($structure[1], 'utf8') === false) {
  26.     return "1.0";
  27.   }
  28.   if (strpos($structure[1], '`passwd` varchar(50) NOT NULL') === false) {
  29.     return "1.1.3";
  30.   }
  31.   if (strpos($structure[1], 'permissions') === false) {
  32.     return "1.1.4";
  33.   }
  34.   return "1.1.9";
  35. }
  36.  
  37. function makeUpgradeSQL($initial) {
  38.   $u = array();
  39.   $u['1.1']   = "DB_upgrade_BB_1_1";
  40.   $u['1.1.4'] = "DB_upgrade_BB_1_1_passwd";
  41.   $u['1.1.5'] = "DB_upgrade_BB_1_1_permissions";
  42.   #$u['1.2'] = "DB_upgrade_BB_1_2";
  43.   #$u['1.3'] = "DB_upgrade_BB_1_3";
  44.   $sql = '';
  45.   $releasenotes = array();
  46.   foreach ($u as $version => $function) {
  47.     // print "Considering $version and $initial\n";
  48.     if (version_compare($initial, $version) < 0) {
  49.       // initial version is older than the current version so run the upgrade
  50.       $upgrade = $function();
  51.       $sql .= $upgrade[0];
  52.       $releasenotes[] = $upgrade[1];
  53.     }
  54.   }
  55.   $settingComment = "-- Bumblebee SQL load file for ".$_SERVER['SERVER_NAME']."\n"
  56.                    ."-- date: ".date('r', time())."\n"
  57.                    ."--\n"
  58.                    ."-- Load this file using phpMyAdmin or on the MySQL command line tools:\n"
  59.                    ."--     mysql -p --user someuser < upgrade.sql\n"
  60.                    ."--\n";
  61.  
  62.   return array($settingComment.$sql, join($releasenotes,'<br />'));
  63. }
  64.  
  65. function DB_upgrade_BB_1_1() {
  66.   $conf = ConfigReader::getInstance();
  67.   global $TABLEPREFIX;
  68.   $s = "ALTER DATABASE ".$conf->value('database', 'database')." DEFAULT CHARACTER SET utf8;\n";
  69.   $s .= "USE ".$conf->value('database', 'database').";\n";
  70.   $list = array(
  71.           'users'           => array('username', 'name', 'passwd', 'email', 'phone'),
  72.           'projects'        => array('name', 'longname'),
  73.           'groups'          => array('name', 'longname', 'addr1', 'addr2', 'suburb',
  74.                                      'state', 'code', 'country', 'email', 'fax', 'account'),
  75.           'instruments'     => array('name', 'longname', 'location', 'timeslotpicture', 'supervisors'),
  76.           'instrumentclass' => array('name'),
  77.           'userclass'       => array('name'),
  78.           'bookings'        => array('ip', 'comment', 'log'),
  79.           'consumables'     => array('name', 'longname'),
  80.           'consumables_use' => array('ip', 'comment', 'log'),
  81.           'costs'           => '',
  82.           'permissions'     => '',
  83.           'projectgroups'   => '',
  84.           'projectrates'    => '',
  85.           'userprojects'    => '',
  86.           );
  87.   foreach($list as $table => $columns) {
  88.     $s .= "ALTER TABLE $TABLEPREFIX$table DEFAULT CHARACTER SET utf8;\n";
  89.     $s .= "ALTER TABLE $TABLEPREFIX$table CONVERT TO CHARACTER SET utf8;\n";
  90. /*    foreach ($columns as $column) {
  91.       // go via blob to prevent mysql doing a charset conversion
  92.       // http://dev.mysql.com/doc/refman/5.0/en/alter-table.html
  93.       // note that this conversion loses all the column lengths that were defined
  94.       // in the original table but it at least gets users UTF-8 compliant.
  95.       $s .= "ALTER TABLE $TABLEPREFIX$table CHANGE $column $column BLOB;\n"
  96.       $s .= "ALTER TABLE $TABLEPREFIX$table CHANGE $column $column TEXT;\n" */
  97.   }
  98.   $notes = "Note: if you have (somehow) managed to insert non-ASCII data (i.e. characters other than those found on a standard US keyboard) into your database this operation will probably corrupt it. Since previous versions of Bumblebee couldn't do this for you, you would have had to work pretty hard to achieve this.";
  99.   return array($s, $notes);
  100. }
  101.  
  102. function DB_upgrade_BB_1_1_passwd() {
  103.   $conf = ConfigReader::getInstance();
  104.   global $TABLEPREFIX;
  105.   $s = "USE ".$conf->value('database', 'database').";\n";
  106.   $s .= "ALTER TABLE {$TABLEPREFIX}users CHANGE passwd passwd VARCHAR(50) NOT NULL;\n";
  107.   $notes = "The password field is made larger to accommodate more secure methods for storing encode passwods.";
  108.   return array($s, $notes);
  109. }
  110.  
  111. function DB_upgrade_BB_1_1_permissions() {
  112.   $conf = ConfigReader::getInstance();
  113.   global $TABLEPREFIX;
  114.   require 'inc/permissions.php';
  115.   $default = BBPERM_USER_BASIC | BBPERM_USER_PASSWD;
  116.   $admin = BBPERM_ADMIN_ALL;
  117.   $s = "USE {$conf->value('database', 'database')};\n";
  118.   $s .= "ALTER TABLE {$TABLEPREFIX}users ADD permissions INTEGER UNSIGNED NOT NULL DEFAULT '{$default}';\n";
  119.   $s .= "UPDATE {$TABLEPREFIX}users SET permissions = permissions | {$admin} where isadmin=1;\n";
  120.   $default = BBPERM_INSTR_BASIC;
  121.   $admin = BBPERM_INSTR_ALL;
  122.   $s .= "ALTER TABLE {$TABLEPREFIX}permissions ADD `permissions` INTEGER UNSIGNED NOT NULL DEFAULT '{$default}';\n";
  123.   $s .= "UPDATE {$TABLEPREFIX}permissions SET permissions = permissions | {$admin} where isadmin=1;\n";
  124.   $notes = "The fine-grained permissions system (required for anonymous viewing of the calendars) requires additional database storage.";
  125.  
  126.   $s .= "CREATE TABLE {$TABLEPREFIX}settings ("
  127.           ."section VARCHAR(64) CHARACTER SET utf8 NOT NULL, "
  128.           ."parameter VARCHAR(64) CHARACTER SET utf8 NOT NULL, "
  129.           ."value TEXT"
  130.        .") DEFAULT CHARACTER SET utf8;\n";
  131.   $s .= "INSERT INTO {$TABLEPREFIX}settings VALUES ('meta', 'dbversion', '1.1.5');\n";
  132.   $s .= "INSERT INTO {$TABLEPREFIX}settings VALUES ('meta', 'configured', '1.1.5');\n";
  133.   $notes .= " The new configuration system stores all your settings in the database to make configuration easier.";
  134.  
  135.   return array($s, $notes);
  136. }
  137.  
  138. ?>

Documentation generated on Tue, 06 Mar 2007 10:02:07 +0000 by phpDocumentor 1.3.0