Merge lp:~davidstrauss/pressflow/database-failover into lp:pressflow

[David Strauss]

Built-in database failover, originally developed by David Rothstein and Acquia Hosting.

[lp:~davidstrauss/pressflow/database-failover]

50. By David Strauss on 2009-09-16

Add missing file

Unmerged revisions

50. By David Strauss on 2009-09-16

Add missing file

49. By David Strauss on 2009-09-11

Add changes from David Rothstein (Acquia Hosting).

=== modified file 'includes/database.inc'
--- includes/database.inc	2009-07-01 22:36:49 +0000
+++ includes/database.inc	2009-09-11 15:02:34 +0000
@@ -130,6 +130,13 @@
     install_goto('install.php');
   }
 
+  // If an array of possible databases (e.g., for a master-master setup) was
+  // specified and this is the first time we're trying to connect to them,
+  // choose the one we will connect to during this page request.
+  if (!isset($db_conns[$name]) && isset($db_url[$name]) && is_array($db_url[$name])) {
+    $db_conns[$name] = db_choose_active($db_url[$name], $name);
+  }
+
   if (!isset($db_conns[$name])) {
     // Initiate a new connection, using the named DB URL specified.
     if (is_array($db_url)) {
@@ -163,9 +170,20 @@
       _db_error_page("The database type '". $db_type ."' is unsupported. Please use either 'mysql' or 'mysqli' for MySQL, or 'pgsql' for PostgreSQL databases.");
     }
 
-    $db_conns[$name] = db_connect($connect_url);
+    try {
+      $db_conns[$name] = db_connect($connect_url);
+    }
+    catch (Exception $e) {
+      _db_error_page($e->getMessage());
+    }
+
     if (!empty($slave_connect_url)) {
-      $db_slave_conns[$name] = db_connect($slave_connect_url); 
+      try {
+        $db_slave_conns[$name] = db_connect($slave_connect_url);
+      }
+      catch (Exception $e) {
+        _db_error_page($e->getMessage());
+      }
     }
   }
 
@@ -184,6 +202,96 @@
 }
 
 /**
+ * Choose a database server to connect to during the current page request.
+ *
+ * This function will loop through a list of provided databases and attempt to
+ * connect to them in order, stopping when a successful connection is made.
+ * However, it also checks a (pluggable) cache to see if a different database
+ * server is preferred and moves that server to the front of the list so that
+ * it can be attempted before any of the others. If the database server that
+ * is eventually connected to is different from the one stored in the cache,
+ * it writes the new, preferred sever to the cache before exiting.
+ *
+ * @param $db_urls
+ *   An ordered array of possible database servers to connect to. The keys
+ *   should be unique identifiers for each server (e.g., "db1", "db2"), and
+ *   the values should be database connection URLs. Once a database server
+ *   has been chosen, the array will be replaced with a string containing the
+ *   database connection URL that is actually being used.
+ * @param $name
+ *   The name of the database that is being connected to. Usually this will be
+ *   'default', but alternate values can be specified if a separate, external
+ *   set of database servers is being used for part of the page request (in
+ *   addition to the main Drupal database).
+ * @return
+ *   The new database connection.
+ */
+function db_choose_active(&$db_urls, $name) {
+  // Load the pluggable cache and check if it contains the name of a preferred
+  // database server. If so, move that server to the front of the list.
+  include_once variable_get('db_server_cache_inc', 'includes/db.server.cache.filesystem.inc');
+  if (function_exists('db_server_cache_get') && ($cached_db_server_id = db_server_cache_get($name))) {
+    if (isset($db_urls[$cached_db_server_id]) && $db_urls[$cached_db_server_id] != reset($db_urls)) {
+      $db_urls = array($cached_db_server_id => $db_urls[$cached_db_server_id]) + $db_urls;
+    }
+  }
+
+  // Loop through each database server and try to connect to it. Stop once a
+  // successful connection is made.
+  $error_message = '';
+  foreach ($db_urls as $id => $connect_url) {
+    $db_type = substr($connect_url, 0, strpos($connect_url, '://'));
+    $handler = "./includes/database.$db_type.inc";
+    if (is_file($handler)) {
+      include_once $handler;
+      // Try to connect to each server three times, with an increasing delay
+      // between each attempt.
+      $connection_attempt = 1;
+      $max_connection_attempts = 3;
+      while ($connection_attempt <= $max_connection_attempts) {
+        try {
+          // Quit the entire loop as soon as a successful connection is made.
+          $connection = db_connect($connect_url);
+          $preferred_db_server_id = $id;
+          break 2;
+        }
+        catch (Exception $e) {
+          if ($connection_attempt == $max_connection_attempts) {
+            $error_message .= ' Server '. $id .': '. $e->getMessage();
+          }
+          else {
+            // Wait 0.5 seconds before the second attempt, and 1 second before
+            // the third attempt.
+            usleep($connection_attempt * 500000);
+          }
+        }
+        $connection_attempt += 1;
+      }
+    }
+    else {
+      $error_message .= ' Server '. $id .": The database type '". $db_type ."' is unsupported. Please use either 'mysql' or 'mysqli' for MySQL, or 'pgsql' for PostgreSQL databases.";
+    }
+  }
+
+  // If no connection was made, show an error page and exit.
+  if (empty($connection)) {
+    _db_error_page($error_message);
+  }
+
+  // If the preferred database server changed, write this to the cache.
+  if (empty($cached_db_server_id) || $cached_db_server_id != $preferred_db_server_id) {
+    if (function_exists('db_server_cache_set')) {
+      db_server_cache_set($name, $preferred_db_server_id);
+    }
+  }
+
+  // Replace the list of database connection URLs with the one that is
+  // actually being used, and return the new database connection.
+  $db_urls = $db_urls[$preferred_db_server_id];
+  return $connection;
+}
+
+/**
  * Helper function to show fatal database errors.
  *
  * Prints a themed maintenance page with the 'Site off-line' text,

=== modified file 'includes/database.mysql.inc'
--- includes/database.mysql.inc	2009-02-26 00:40:48 +0000
+++ includes/database.mysql.inc	2009-09-11 15:02:34 +0000
@@ -53,7 +53,10 @@
 
   // Check if MySQL support is present in PHP
   if (!function_exists('mysql_connect')) {
+    throw new Exception('Unable to use the MySQL database because the MySQL extension for PHP is not installed. Check your <code>php.ini</code> to see how you can enable it.');
+    /* Original version (replaced with exception-based method above):
     _db_error_page('Unable to use the MySQL database because the MySQL extension for PHP is not installed. Check your <code>php.ini</code> to see how you can enable it.');
+    */
   }
 
   // Decode url-encoded information in the db connection string
@@ -76,8 +79,11 @@
   //   (matched) rows, not the number of affected rows.
   $connection = @mysql_connect($url['host'], $url['user'], $url['pass'], TRUE, 2);
   if (!$connection || !mysql_select_db(substr($url['path'], 1))) {
+    throw new Exception(mysql_error());
+    /* Original version (replaced with exception-based method above):
     // Show error screen otherwise
     _db_error_page(mysql_error());
+    */
   }
 
   // Force UTF-8.

=== modified file 'includes/database.mysqli.inc'
--- includes/database.mysqli.inc	2009-02-26 00:40:48 +0000
+++ includes/database.mysqli.inc	2009-09-11 15:02:34 +0000
@@ -57,7 +57,10 @@
 function db_connect($url) {
   // Check if MySQLi support is present in PHP
   if (!function_exists('mysqli_init') && !extension_loaded('mysqli')) {
+    throw new Exception('Unable to use the MySQLi database because the MySQLi extension for PHP is not installed. Check your <code>php.ini</code> to see how you can enable it.');
+    /* Original version (replaced with exception-based method above):
     _db_error_page('Unable to use the MySQLi database because the MySQLi extension for PHP is not installed. Check your <code>php.ini</code> to see how you can enable it.');
+    */
   }
 
   $url = parse_url($url);
@@ -76,7 +79,10 @@
   @mysqli_real_connect($connection, $url['host'], $url['user'], $url['pass'], substr($url['path'], 1), $url['port'], NULL, MYSQLI_CLIENT_FOUND_ROWS);
 
   if (mysqli_connect_errno() > 0) {
+    throw new Exception(mysqli_connect_error());
+    /* Original version (replaced with exception-based method above):
     _db_error_page(mysqli_connect_error());
+    */
   }
 
   // Force UTF-8.

=== modified file 'includes/database.pgsql.inc'
--- includes/database.pgsql.inc	2009-07-01 22:36:49 +0000
+++ includes/database.pgsql.inc	2009-09-11 15:02:34 +0000
@@ -47,7 +47,10 @@
 function db_connect($url) {
   // Check if PostgreSQL support is present in PHP
   if (!function_exists('pg_connect')) {
+    throw new Exception('Unable to use the PostgreSQL database because the PostgreSQL extension for PHP is not installed. Check your <code>php.ini</code> to see how you can enable it.');
+    /* Original version (replaced with exception-based method above):
     _db_error_page('Unable to use the PostgreSQL database because the PostgreSQL extension for PHP is not installed. Check your <code>php.ini</code> to see how you can enable it.');
+    */
   }
 
   $url = parse_url($url);
@@ -79,7 +82,12 @@
   $connection = @pg_connect($conn_string);
   if (!$connection) {
     require_once './includes/unicode.inc';
+    $error_message = decode_entities($php_errormsg);
+    ini_set('track_errors', $track_errors_previous);
+    throw new Exception($error_message);
+    /* Original version (replaced with exception-based method above):
     _db_error_page(decode_entities($php_errormsg));
+    */
   }
 
   // Restore error tracking setting