drupal/update.php

<?php
// $Id$
/*
** USAGE:
**
** - Point your browser to "http://www.site.com/update.php" and follow
**   the instructions.
**
** - If you are not logged in as administrator, you will need to modify the
**   statement below. Change the 1 into a 0 to disable the access check.
**   After finishing the upgrade, open this file and change the 0 back into
**   a 1!
*/

// Disable access checking?
$access_check = 1;

if (!ini_get("safe_mode")) {
  set_time_limit(180);
}

include_once "database/updates.inc";

function update_data($start) {
  global $sql_updates;
  $sql_updates = array_slice($sql_updates, ($start-- ? $start : 0));
  foreach ($sql_updates as $date => $func) {
    print "<strong>$date</strong><br />\n<pre>\n";
    $ret = $func();
    foreach ($ret as $return) {
      print $return[1];
      print $return[2];
    }
    variable_set("update_start", $date);
    print "</pre>\n";
  }
}

function update_page_header($title) {
  $output = "<html><head><title>$title</title>";
  $output .= <<<EOF
      <link rel="stylesheet" type="text/css" media="print" href="misc/print.css" />
      <style type="text/css" title="layout" media="Screen">
        @import url("misc/drupal.css");
      </style>
EOF;
  $output .= "</head><body>";
  $output .= "<div id=\"logo\"><a href=\"http://drupal.org/\"><img src=\"misc/druplicon-small.gif\" alt=\"Druplicon - Drupal logo\" title=\"Druplicon - Drupal logo\" /></a></div>";
  $output .= "<div id=\"update\"><h1>$title</h1>";
  return $output;
}

function update_page_footer() {
  return "</div></body></html>";
}

function update_page() {
  global $user, $sql_updates;

  $edit = $_POST["edit"];

  switch ($_POST["op"]) {
    case "Update":
      // make sure we have updates to run.
      print update_page_header("Drupal database update");
      $links[] = "<a href=\"index.php\">main page</a>";
      $links[] = "<a href=\"index.php?q=admin\">administration pages</a>";
      print theme("item_list", $links);
        // NOTE: we can't use l() here because the URL would point to 'update.php?q=admin'.
      if ($edit["start"] == -1) {
        print "No updates to perform.";
      }
      else {
        update_data($edit["start"]);
      }
      print "<br />Updates were attempted. If you see no failures above, you may proceed happily to the <a href=\"index.php?q=admin\">administration pages</a>.";
      print " Otherwise, you may need to update your database manually.";
      print update_page_footer();
      break;
    default:
      $start = variable_get("update_start", 0);
      $dates[] = "All";
      $i = 1;
      foreach ($sql_updates as $date => $sql) {
        $dates[$i++] = $date;
        if ($date == $start) {
          $selected = $i;
        }
      }
      $dates[$i] = "No updates available";

      // make update form and output it.
      $form .= form_select("Perform updates from", "start", (isset($selected) ? $selected : -1), $dates, "This defaults to the first available update since the last update you peformed.");
      $form .= form_submit("Update");
      print update_page_header("Drupal database update");
      print form($form);
      print update_page_footer();
      break;
  }
}

function update_info() {
  print update_page_header("Drupal database update");
  print "<ol>\n";
  print "<li>Use this script to <strong>upgrade an existing Drupal installation</strong>.  You don't need this script when installing Drupal from scratch.</li>";
  print "<li>Before doing anything, backup your database. This process will change your database and its values, and some things might get lost.</li>\n";
  print "<li>Update your Drupal sources, check the notes below and <a href=\"update.php?op=update\">run the database upgrade script</a>.  Don't upgrade your database twice as it may cause problems.</p></li>\n";
  print "<li>Go through the various administration pages to change the existing and new settings to your liking.</li>\n";
  print "</ol>";
  print "Notes:";
  print "<ol>";
  print " <li>If you <strong>upgrade from Drupal 4.4.x</strong>, you will need to create the <code>users_roles</code> table manually before upgrading. To create the <code>users_roles</code> table, issue the following SQL commands:

  <p>MySQL specific example:
  <pre>
  CREATE TABLE users_roles (
    uid int(10) unsigned NOT NULL default '0',
    rid int(10) unsigned NOT NULL default '0',
    PRIMARY KEY (uid, rid)
  );
  </pre>
  </p>

  <p>PostgreSQL specific example:
  <pre>
  CREATE TABLE users_roles (
    uid integer NOT NULL default '0',
    rid integer NOT NULL default '0',
    PRIMARY KEY (uid, rid)
  );
  </pre>
  </p>
  </li>";
  print " <li>If you <strong>upgrade from Drupal 4.3.x</strong>, you will need to add the <code>bootstrap</code> and <code>throttle</code> fields to the <code>system</code> table manually before upgrading. To add the required fields, issue the following SQL commands:

  <p>MySQL specific example:
  <pre>
  ALTER TABLE system ADD throttle tinyint(1) NOT NULL DEFAULT '0';
  ALTER TABLE system ADD bootstrap int(2);
  </pre>
  </p>

  <p>PostgreSQL specific example:
  <pre>
  ALTER TABLE system ADD throttle smallint;
  ALTER TABLE system ALTER COLUMN throttle SET DEFAULT '0';
  UPDATE system SET throttle = 0;
  ALTER TABLE system ALTER COLUMN throttle SET NOT NULL;
  ALTER TABLE system ADD bootstrap integer;
  </pre>
  </p>
  </li>";
  print " <li>If you <strong>upgrade from Drupal 4.2.0</strong>, you will need to create the <code>sessions</code> table manually before upgrading.  After creating the table, you will want to log in and immediately continue the upgrade.  To create the <code>sessions</code> table, issue the following SQL command:

  <p>MySQL specific example:
  <pre>
  CREATE TABLE sessions (
  uid int(10) unsigned NOT NULL,
  sid varchar(32) NOT NULL default '',
  hostname varchar(128) NOT NULL default '',
  timestamp int(11) NOT NULL default '0',
  session text,
  KEY uid (uid),
  KEY sid (sid(4)),
  KEY timestamp (timestamp));
  </pre>
  </p>
  </li>";
  print "</ol>";
  print update_page_footer();
}

if (isset($_GET["op"])) {
  include_once "includes/bootstrap.inc";
  include_once "includes/common.inc";

  // Access check:
  if (($access_check == 0) || ($user->uid == 1)) {
    update_page();
  }
  else {
    print update_page_header("Access denied");
    print "Access denied.  You are not authorized to access to this page.  Please log in as the user with user ID #1. If you cannot log-in, you will have to edit <code>update.php</code> to by-pass this access check; in that case, open <code>update.php</code> in a text editor and follow the instructions at the top.";
    print update_page_footer();
  }
}
else {
  update_info();
}
?>
- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00			`<?php`
- Added $Id$ tags. Patch by Chris. 2003-09-25 07:27:22 +00:00			`// $Id$`
- Added some explanation to the top of the file and fixed a braino. 2001-12-16 14:42:51 +00:00			`/*`
			`** USAGE:`
			`**`
			`** - Point your browser to "http://www.site.com/update.php" and follow`
			`** the instructions.`
			`**`
- Made it easier to by-pass the access check. Modified patch from Steven. 2003-10-03 06:22:12 +00:00			`** - If you are not logged in as administrator, you will need to modify the`
			`** statement below. Change the 1 into a 0 to disable the access check.`
			`** After finishing the upgrade, open this file and change the 0 back into`
			`** a 1!`
- Added some explanation to the top of the file and fixed a braino. 2001-12-16 14:42:51 +00:00			`*/`

- Made it easier to by-pass the access check. Modified patch from Steven. 2003-10-03 06:22:12 +00:00			`// Disable access checking?`
			`$access_check = 1;`

- Fixed bug #4842: get_cfg_var() -> ini_get() 2003-12-29 11:25:02 +00:00			`if (!ini_get("safe_mode")) {`
- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00			`set_time_limit(180);`
			`}`

- Patch by Gerhard: move the updates to database/updates.inc so packaging systems can by-pass update.php. 2004-02-25 22:20:09 +00:00			`include_once "database/updates.inc";`
- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00
			`function update_data($start) {`
- Patch by Gerhard: move the updates to database/updates.inc so packaging systems can by-pass update.php. 2004-02-25 22:20:09 +00:00			`global $sql_updates;`
			`$sql_updates = array_slice($sql_updates, ($start-- ? $start : 0));`
			`foreach ($sql_updates as $date => $func) {`
- XHTML improvements: <b> -> <strong>. Patch by Stefan. 2003-12-29 17:14:27 +00:00			`print "<strong>$date</strong><br />\n<pre>\n";`
- Patch by Gerhard: move the updates to database/updates.inc so packaging systems can by-pass update.php. 2004-02-25 22:20:09 +00:00			`$ret = $func();`
			`foreach ($ret as $return) {`
			`print $return[1];`
			`print $return[2];`
			`}`
- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00			`variable_set("update_start", $date);`
			`print "</pre>\n";`
			`}`
			`}`

- update.php improvements and a grammatical fix from Al. Thanks. 2003-05-20 04:52:06 +00:00			`function update_page_header($title) {`
			`$output = "<html><head><title>$title</title>";`
			`$output .= <<<EOF`
			`<link rel="stylesheet" type="text/css" media="print" href="misc/print.css" />`
			`<style type="text/css" title="layout" media="Screen">`
- Added a note about having to create the session table manually when upgrading from Drupal 4.2.0. 2003-10-01 21:55:19 +00:00			`@import url("misc/drupal.css");`
- update.php improvements and a grammatical fix from Al. Thanks. 2003-05-20 04:52:06 +00:00			`</style>`
			`EOF;`
- Bugfix: fixed a duplicate and broken link to drupal.org. Patch by Matt. 2003-10-20 19:21:17 +00:00			`$output .= "</head><body>";`
- Improvements: XHTML-ifications. Patch by GmbH. 2003-06-15 19:06:25 +00:00			`$output .= "<div id=\"logo\"><a href=\"http://drupal.org/\"><img src=\"misc/druplicon-small.gif\" alt=\"Druplicon - Drupal logo\" title=\"Druplicon - Drupal logo\" /></a></div>";`
- update.php improvements and a grammatical fix from Al. Thanks. 2003-05-20 04:52:06 +00:00			`$output .= "<div id=\"update\"><h1>$title</h1>";`
			`return $output;`
			`}`

			`function update_page_footer() {`
			`return "</div></body></html>";`
			`}`

- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00			`function update_page() {`
- Patch by Gerhard: move the updates to database/updates.inc so packaging systems can by-pass update.php. 2004-02-25 22:20:09 +00:00			`global $user, $sql_updates;`
- Fixed a typo in the PostgreSQL database scheme. Patch by Michael Frankowski. - Fixed a typo in the MSSQL database scheme. Patch by Michael Frankowski. - Removed dependency on "register_globals = on"! Patches by Michael Frankowski. Notes: + Updated the patches to use $foo["bar"] instead of $foo['bar']. + Updated the INSTALL and CHANGELOG files as well. - Tiny improvement to the "./scripts/code-clean.sh" script. 2003-05-13 18:36:38 +00:00
			`$edit = $_POST["edit"];`
- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00
- Fixing to work with register_globals off. 2003-05-19 15:30:12 +00:00			`switch ($_POST["op"]) {`
- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00			`case "Update":`
			`// make sure we have updates to run.`
- update.php improvements and a grammatical fix from Al. Thanks. 2003-05-20 04:52:06 +00:00			`print update_page_header("Drupal database update");`
- Improved module loading when serving cached pages. Moshe's bootstrap patch. - Used legend and fieldset tags for the configuration page. 2003-11-18 19:44:36 +00:00			`$links[] = "<a href=\"index.php\">main page</a>";`
			`$links[] = "<a href=\"index.php?q=admin\">administration pages</a>";`
			`print theme("item_list", $links);`
- Some fixes and improvements as suggested by Gary. 2003-02-23 21:11:03 +00:00			`// NOTE: we can't use l() here because the URL would point to 'update.php?q=admin'.`
- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00			`if ($edit["start"] == -1) {`
			`print "No updates to perform.";`
			`}`
			`else {`
			`update_data($edit["start"]);`
			`}`
- Some fixes and improvements as suggested by Gary. 2003-02-23 21:11:03 +00:00			`print "<br />Updates were attempted. If you see no failures above, you may proceed happily to the <a href=\"index.php?q=admin\">administration pages</a>.";`
- Fixed links to admin page. Added help text. 2003-01-07 05:56:47 +00:00			`print " Otherwise, you may need to update your database manually.";`
- update.php improvements and a grammatical fix from Al. Thanks. 2003-05-20 04:52:06 +00:00			`print update_page_footer();`
- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00			`break;`
			`default:`
			`$start = variable_get("update_start", 0);`
			`$dates[] = "All";`
			`$i = 1;`
- Patch by Gerhard: move the updates to database/updates.inc so packaging systems can by-pass update.php. 2004-02-25 22:20:09 +00:00			`foreach ($sql_updates as $date => $sql) {`
- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00			`$dates[$i++] = $date;`
			`if ($date == $start) {`
			`$selected = $i;`
			`}`
			`}`
- Added missing query to change the session field from VARCHAR(32) to TEXT. Reported by Bert Garcia. 2002-11-24 13:04:28 +00:00			`$dates[$i] = "No updates available";`
- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00
			`// make update form and output it.`
- update.php improvements and a grammatical fix from Al. Thanks. 2003-05-20 04:52:06 +00:00			`$form .= form_select("Perform updates from", "start", (isset($selected) ? $selected : -1), $dates, "This defaults to the first available update since the last update you peformed.");`
- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00			`$form .= form_submit("Update");`
- update.php improvements and a grammatical fix from Al. Thanks. 2003-05-20 04:52:06 +00:00			`print update_page_header("Drupal database update");`
- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00			`print form($form);`
- update.php improvements and a grammatical fix from Al. Thanks. 2003-05-20 04:52:06 +00:00			`print update_page_footer();`
- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00			`break;`
			`}`
			`}`

- added notes to update.php which you will see before you can perform updates. This should give clearer notice to people which update they have to run manually. 2002-05-11 17:23:45 +00:00			`function update_info() {`
- update.php improvements and a grammatical fix from Al. Thanks. 2003-05-20 04:52:06 +00:00			`print update_page_header("Drupal database update");`
- convert meta tags to taxonomy. - added upgrade option which will enable modules and set some defaults. - additional links for added usability. - better instructions. 2002-05-15 22:36:30 +00:00			`print "<ol>\n";`
- XHTML improvements: <b> -> <strong>. Patch by Stefan. 2003-12-29 17:14:27 +00:00			`print "<li>Use this script to <strong>upgrade an existing Drupal installation</strong>. You don't need this script when installing Drupal from scratch.</li>";`
- Fixed links to admin page. Added help text. 2003-01-07 05:56:47 +00:00			`print "<li>Before doing anything, backup your database. This process will change your database and its values, and some things might get lost.</li>\n";`
- Some clarifications to the upgrade script's guidelines/documentation based on observing upgrade questions. 2003-10-21 07:59:04 +00:00			`print "<li>Update your Drupal sources, check the notes below and <a href=\"update.php?op=update\">run the database upgrade script</a>. Don't upgrade your database twice as it may cause problems.</p></li>\n";`
- Some changes to the update.php script: revised the instructions a bit, added some logic and a link to "upgrade 4.0.x to 4.1.x", etc. 2002-12-07 11:24:16 +00:00			`print "<li>Go through the various administration pages to change the existing and new settings to your liking.</li>\n";`
- convert meta tags to taxonomy. - added upgrade option which will enable modules and set some defaults. - additional links for added usability. - better instructions. 2002-05-15 22:36:30 +00:00			`print "</ol>";`
- Added a note about having to create the session table manually when upgrading from Drupal 4.2.0. 2003-10-01 21:55:19 +00:00			`print "Notes:";`
			`print "<ol>";`
- Added support for multiple user roles. Patch by Jim Hriggs. 2004-05-10 20:34:25 +00:00			`print " <li>If you <strong>upgrade from Drupal 4.4.x</strong>, you will need to create the <code>users_roles</code> table manually before upgrading. To create the <code>users_roles</code> table, issue the following SQL commands:`

			`<p>MySQL specific example:`
			`<pre>`
			`CREATE TABLE users_roles (`
			`uid int(10) unsigned NOT NULL default '0',`
			`rid int(10) unsigned NOT NULL default '0',`
			`PRIMARY KEY (uid, rid)`
			`);`
			`</pre>`
			`</p>`

			`<p>PostgreSQL specific example:`
			`<pre>`
			`CREATE TABLE users_roles (`
			`uid integer NOT NULL default '0',`
			`rid integer NOT NULL default '0',`
			`PRIMARY KEY (uid, rid)`
			`);`
			`</pre>`
			`</p>`
			`</li>";`
			`print " <li>If you <strong>upgrade from Drupal 4.3.x</strong>, you will need to add the <code>bootstrap</code> and <code>throttle</code> fields to the <code>system</code> table manually before upgrading. To add the required fields, issue the following SQL commands:`
- Patch 6012 by Adrian: syncs the PostgreSQL port with the current state of HEAD, and adds a user notice to add the throttle and bootstrap columns to the system table manually, else update.php will not run. The message includes the SQL statements required for both MySQL and PostgreSQL. 2004-02-23 17:45:03 +00:00
			`<p>MySQL specific example:`
			`<pre>`
			`ALTER TABLE system ADD throttle tinyint(1) NOT NULL DEFAULT '0';`
			`ALTER TABLE system ADD bootstrap int(2);`
			`</pre>`
			`</p>`

			`<p>PostgreSQL specific example:`
			`<pre>`
			`ALTER TABLE system ADD throttle smallint;`
			`ALTER TABLE system ALTER COLUMN throttle SET DEFAULT '0';`
			`UPDATE system SET throttle = 0;`
			`ALTER TABLE system ALTER COLUMN throttle SET NOT NULL;`
			`ALTER TABLE system ADD bootstrap integer;`
			`</pre>`
			`</p>`
			`</li>";`
- Added support for multiple user roles. Patch by Jim Hriggs. 2004-05-10 20:34:25 +00:00			`print " <li>If you <strong>upgrade from Drupal 4.2.0</strong>, you will need to create the <code>sessions</code> table manually before upgrading. After creating the table, you will want to log in and immediately continue the upgrade. To create the <code>sessions</code> table, issue the following SQL command:`

			`<p>MySQL specific example:`
			`<pre>`
			`CREATE TABLE sessions (`
- Added a note about having to create the session table manually when upgrading from Drupal 4.2.0. 2003-10-01 21:55:19 +00:00			`uid int(10) unsigned NOT NULL,`
			`sid varchar(32) NOT NULL default '',`
			`hostname varchar(128) NOT NULL default '',`
			`timestamp int(11) NOT NULL default '0',`
			`session text,`
			`KEY uid (uid),`
			`KEY sid (sid(4)),`
- Added support for multiple user roles. Patch by Jim Hriggs. 2004-05-10 20:34:25 +00:00			`KEY timestamp (timestamp));`
			`</pre>`
			`</p>`
			`</li>";`
- Added a note about having to create the session table manually when upgrading from Drupal 4.2.0. 2003-10-01 21:55:19 +00:00			`print "</ol>";`
- update.php improvements and a grammatical fix from Al. Thanks. 2003-05-20 04:52:06 +00:00			`print update_page_footer();`
- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00			`}`
- added notes to update.php which you will see before you can perform updates. This should give clearer notice to people which update they have to run manually. 2002-05-11 17:23:45 +00:00
- Fixing to work with register_globals off. 2003-05-19 15:30:12 +00:00			`if (isset($_GET["op"])) {`
- Improved module loading when serving cached pages. Moshe's bootstrap patch. - Used legend and fieldset tags for the configuration page. 2003-11-18 19:44:36 +00:00			`include_once "includes/bootstrap.inc";`
- convert meta tags to taxonomy. - added upgrade option which will enable modules and set some defaults. - additional links for added usability. - better instructions. 2002-05-15 22:36:30 +00:00			`include_once "includes/common.inc";`
- Fixed links to admin page. Added help text. 2003-01-07 05:56:47 +00:00
- Some changes to the update.php script: revised the instructions a bit, added some logic and a link to "upgrade 4.0.x to 4.1.x", etc. 2002-12-07 11:24:16 +00:00			`// Access check:`
- Made it easier to by-pass the access check. Modified patch from Steven. 2003-10-03 06:22:12 +00:00			`if (($access_check == 0) \|\| ($user->uid == 1)) {`
- convert meta tags to taxonomy. - added upgrade option which will enable modules and set some defaults. - additional links for added usability. - better instructions. 2002-05-15 22:36:30 +00:00			`update_page();`
			`}`
			`else {`
- update.php improvements and a grammatical fix from Al. Thanks. 2003-05-20 04:52:06 +00:00			`print update_page_header("Access denied");`
- Made it easier to by-pass the access check. Modified patch from Steven. 2003-10-03 06:22:12 +00:00			`print "Access denied. You are not authorized to access to this page. Please log in as the user with user ID #1. If you cannot log-in, you will have to edit <code>update.php</code> to by-pass this access check; in that case, open <code>update.php</code> in a text editor and follow the instructions at the top.";`
- update.php improvements and a grammatical fix from Al. Thanks. 2003-05-20 04:52:06 +00:00			`print update_page_footer();`
- convert meta tags to taxonomy. - added upgrade option which will enable modules and set some defaults. - additional links for added usability. - better instructions. 2002-05-15 22:36:30 +00:00			`}`
			`}`
			`else {`
			`update_info();`
- added update.php to replace the updates/* files to make future upgrades easier. Can be found by going to http://yoursite/update.php. Only the "super" user can access it (uid == 1) for security reasons. 2001-11-15 22:53:06 +00:00			`}`
- Small improvement to the admin menu based on feedback from Michael. 2003-01-14 20:33:42 +00:00			`?>`