webmaster@1: <?php
webmaster@1: // $Id: database.mysql.inc,v 1.89 2008/01/24 10:46:54 goba Exp $
webmaster@1: 
webmaster@1: /**
webmaster@1:  * @file
webmaster@1:  * Database interface code for MySQL database servers.
webmaster@1:  */
webmaster@1: 
webmaster@1: /**
webmaster@1:  * @ingroup database
webmaster@1:  * @{
webmaster@1:  */
webmaster@1: 
webmaster@1: // Include functions shared between mysql and mysqli.
webmaster@1: require_once './includes/database.mysql-common.inc';
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Report database status.
webmaster@1:  */
webmaster@1: function db_status_report($phase) {
webmaster@1:   $t = get_t();
webmaster@1: 
webmaster@1:   $version = db_version();
webmaster@1: 
webmaster@1:   $form['mysql'] = array(
webmaster@1:     'title' => $t('MySQL database'),
webmaster@1:     'value' => ($phase == 'runtime') ? l($version, 'admin/reports/status/sql') : $version,
webmaster@1:   );
webmaster@1: 
webmaster@1:   if (version_compare($version, DRUPAL_MINIMUM_MYSQL) < 0) {
webmaster@1:     $form['mysql']['severity'] = REQUIREMENT_ERROR;
webmaster@1:     $form['mysql']['description'] = $t('Your MySQL Server is too old. Drupal requires at least MySQL %version.', array('%version' => DRUPAL_MINIMUM_MYSQL));
webmaster@1:   }
webmaster@1: 
webmaster@1:   return $form;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Returns the version of the database server currently in use.
webmaster@1:  *
webmaster@1:  * @return Database server version
webmaster@1:  */
webmaster@1: function db_version() {
webmaster@1:   list($version) = explode('-', mysql_get_server_info());
webmaster@1:   return $version;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Initialize a database connection.
webmaster@1:  */
webmaster@1: function db_connect($url) {
webmaster@1:   $url = parse_url($url);
webmaster@1: 
webmaster@1:   // Check if MySQL support is present in PHP
webmaster@1:   if (!function_exists('mysql_connect')) {
webmaster@1:     _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.');
webmaster@1:   }
webmaster@1: 
webmaster@1:   // Decode url-encoded information in the db connection string
webmaster@1:   $url['user'] = urldecode($url['user']);
webmaster@1:   // Test if database url has a password.
webmaster@1:   $url['pass'] = isset($url['pass']) ? urldecode($url['pass']) : '';
webmaster@1:   $url['host'] = urldecode($url['host']);
webmaster@1:   $url['path'] = urldecode($url['path']);
webmaster@1: 
webmaster@1:   // Allow for non-standard MySQL port.
webmaster@1:   if (isset($url['port'])) {
webmaster@1:     $url['host'] = $url['host'] .':'. $url['port'];
webmaster@1:   }
webmaster@1: 
webmaster@1:   // - TRUE makes mysql_connect() always open a new link, even if
webmaster@1:   //   mysql_connect() was called before with the same parameters.
webmaster@1:   //   This is important if you are using two databases on the same
webmaster@1:   //   server.
webmaster@1:   // - 2 means CLIENT_FOUND_ROWS: return the number of found
webmaster@1:   //   (matched) rows, not the number of affected rows.
webmaster@1:   $connection = @mysql_connect($url['host'], $url['user'], $url['pass'], TRUE, 2);
webmaster@1:   if (!$connection || !mysql_select_db(substr($url['path'], 1))) {
webmaster@1:     // Show error screen otherwise
webmaster@1:     _db_error_page(mysql_error());
webmaster@1:   }
webmaster@1: 
webmaster@1:   // Force UTF-8.
webmaster@1:   mysql_query('SET NAMES "utf8"', $connection);
webmaster@1:   return $connection;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Helper function for db_query().
webmaster@1:  */
webmaster@1: function _db_query($query, $debug = 0) {
webmaster@1:   global $active_db, $queries, $user;
webmaster@1: 
webmaster@1:   if (variable_get('dev_query', 0)) {
webmaster@1:     list($usec, $sec) = explode(' ', microtime());
webmaster@1:     $timer = (float)$usec + (float)$sec;
webmaster@1:     // If devel.module query logging is enabled, prepend a comment with the username and calling function
webmaster@1:     // to the SQL string. This is useful when running mysql's SHOW PROCESSLIST to learn what exact
webmaster@1:     // code is issueing the slow query.
webmaster@1:     $bt = debug_backtrace();
webmaster@1:     // t() may not be available yet so we don't wrap 'Anonymous'.
webmaster@1:     $name = $user->uid ? $user->name : variable_get('anonymous', 'Anonymous');
webmaster@1:     // str_replace() to prevent SQL injection via username or anonymous name.
webmaster@1:     $name = str_replace(array('*', '/'), '', $name);
webmaster@1:     $query = '/* '. $name .' : '. $bt[2]['function'] .' */ '. $query;
webmaster@1:   }
webmaster@1: 
webmaster@1:   $result = mysql_query($query, $active_db);
webmaster@1: 
webmaster@1:   if (variable_get('dev_query', 0)) {
webmaster@1:     $query = $bt[2]['function'] ."\n". $query;
webmaster@1:     list($usec, $sec) = explode(' ', microtime());
webmaster@1:     $stop = (float)$usec + (float)$sec;
webmaster@1:     $diff = $stop - $timer;
webmaster@1:     $queries[] = array($query, $diff);
webmaster@1:   }
webmaster@1: 
webmaster@1:   if ($debug) {
webmaster@1:     print '<p>query: '. $query .'<br />error:'. mysql_error($active_db) .'</p>';
webmaster@1:   }
webmaster@1: 
webmaster@1:   if (!mysql_errno($active_db)) {
webmaster@1:     return $result;
webmaster@1:   }
webmaster@1:   else {
webmaster@1:     // Indicate to drupal_error_handler that this is a database error.
webmaster@1:     ${DB_ERROR} = TRUE;
webmaster@1:     trigger_error(check_plain(mysql_error($active_db) ."\nquery: ". $query), E_USER_WARNING);
webmaster@1:     return FALSE;
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Fetch one result row from the previous query as an object.
webmaster@1:  *
webmaster@1:  * @param $result
webmaster@1:  *   A database query result resource, as returned from db_query().
webmaster@1:  * @return
webmaster@1:  *   An object representing the next row of the result, or FALSE. The attributes
webmaster@1:  *   of this object are the table fields selected by the query.
webmaster@1:  */
webmaster@1: function db_fetch_object($result) {
webmaster@1:   if ($result) {
webmaster@1:     return mysql_fetch_object($result);
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Fetch one result row from the previous query as an array.
webmaster@1:  *
webmaster@1:  * @param $result
webmaster@1:  *   A database query result resource, as returned from db_query().
webmaster@1:  * @return
webmaster@1:  *   An associative array representing the next row of the result, or FALSE.
webmaster@1:  *   The keys of this object are the names of the table fields selected by the
webmaster@1:  *   query, and the values are the field values for this result row.
webmaster@1:  */
webmaster@1: function db_fetch_array($result) {
webmaster@1:   if ($result) {
webmaster@1:     return mysql_fetch_array($result, MYSQL_ASSOC);
webmaster@1:   }
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Return an individual result field from the previous query.
webmaster@1:  *
webmaster@1:  * Only use this function if exactly one field is being selected; otherwise,
webmaster@1:  * use db_fetch_object() or db_fetch_array().
webmaster@1:  *
webmaster@1:  * @param $result
webmaster@1:  *   A database query result resource, as returned from db_query().
webmaster@1:  * @return
webmaster@1:  *   The resulting field or FALSE.
webmaster@1:  */
webmaster@1: function db_result($result) {
webmaster@1:   if ($result && mysql_num_rows($result) > 0) {
webmaster@1:     // The mysql_fetch_row function has an optional second parameter $row
webmaster@1:     // but that can't be used for compatibility with Oracle, DB2, etc.
webmaster@1:     $array = mysql_fetch_row($result);
webmaster@1:     return $array[0];
webmaster@1:   }
webmaster@1:   return FALSE;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Determine whether the previous query caused an error.
webmaster@1:  */
webmaster@1: function db_error() {
webmaster@1:   global $active_db;
webmaster@1:   return mysql_errno($active_db);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Determine the number of rows changed by the preceding query.
webmaster@1:  */
webmaster@1: function db_affected_rows() {
webmaster@1:   global $active_db;
webmaster@1:   return mysql_affected_rows($active_db);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Runs a limited-range query in the active database.
webmaster@1:  *
webmaster@1:  * Use this as a substitute for db_query() when a subset of the query is to be
webmaster@1:  * returned.
webmaster@1:  * User-supplied arguments to the query should be passed in as separate parameters
webmaster@1:  * so that they can be properly escaped to avoid SQL injection attacks.
webmaster@1:  *
webmaster@1:  * @param $query
webmaster@1:  *   A string containing an SQL query.
webmaster@1:  * @param ...
webmaster@1:  *   A variable number of arguments which are substituted into the query
webmaster@1:  *   using printf() syntax. The query arguments can be enclosed in one
webmaster@1:  *   array instead.
webmaster@1:  *   Valid %-modifiers are: %s, %d, %f, %b (binary data, do not enclose
webmaster@1:  *   in '') and %%.
webmaster@1:  *
webmaster@1:  *   NOTE: using this syntax will cast NULL and FALSE values to decimal 0,
webmaster@1:  *   and TRUE values to decimal 1.
webmaster@1:  *
webmaster@1:  * @param $from
webmaster@1:  *   The first result row to return.
webmaster@1:  * @param $count
webmaster@1:  *   The maximum number of result rows to return.
webmaster@1:  * @return
webmaster@1:  *   A database query result resource, or FALSE if the query was not executed
webmaster@1:  *   correctly.
webmaster@1:  */
webmaster@1: function db_query_range($query) {
webmaster@1:   $args = func_get_args();
webmaster@1:   $count = array_pop($args);
webmaster@1:   $from = array_pop($args);
webmaster@1:   array_shift($args);
webmaster@1: 
webmaster@1:   $query = db_prefix_tables($query);
webmaster@1:   if (isset($args[0]) and is_array($args[0])) { // 'All arguments in one array' syntax
webmaster@1:     $args = $args[0];
webmaster@1:   }
webmaster@1:   _db_query_callback($args, TRUE);
webmaster@1:   $query = preg_replace_callback(DB_QUERY_REGEXP, '_db_query_callback', $query);
webmaster@1:   $query .= ' LIMIT '. (int)$from .', '. (int)$count;
webmaster@1:   return _db_query($query);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Runs a SELECT query and stores its results in a temporary table.
webmaster@1:  *
webmaster@1:  * Use this as a substitute for db_query() when the results need to stored
webmaster@1:  * in a temporary table. Temporary tables exist for the duration of the page
webmaster@1:  * request.
webmaster@1:  * User-supplied arguments to the query should be passed in as separate parameters
webmaster@1:  * so that they can be properly escaped to avoid SQL injection attacks.
webmaster@1:  *
webmaster@1:  * Note that if you need to know how many results were returned, you should do
webmaster@1:  * a SELECT COUNT(*) on the temporary table afterwards. db_affected_rows() does
webmaster@1:  * not give consistent result across different database types in this case.
webmaster@1:  *
webmaster@1:  * @param $query
webmaster@1:  *   A string containing a normal SELECT SQL query.
webmaster@1:  * @param ...
webmaster@1:  *   A variable number of arguments which are substituted into the query
webmaster@1:  *   using printf() syntax. The query arguments can be enclosed in one
webmaster@1:  *   array instead.
webmaster@1:  *   Valid %-modifiers are: %s, %d, %f, %b (binary data, do not enclose
webmaster@1:  *   in '') and %%.
webmaster@1:  *
webmaster@1:  *   NOTE: using this syntax will cast NULL and FALSE values to decimal 0,
webmaster@1:  *   and TRUE values to decimal 1.
webmaster@1:  *
webmaster@1:  * @param $table
webmaster@1:  *   The name of the temporary table to select into. This name will not be
webmaster@1:  *   prefixed as there is no risk of collision.
webmaster@1:  * @return
webmaster@1:  *   A database query result resource, or FALSE if the query was not executed
webmaster@1:  *   correctly.
webmaster@1:  */
webmaster@1: function db_query_temporary($query) {
webmaster@1:   $args = func_get_args();
webmaster@1:   $tablename = array_pop($args);
webmaster@1:   array_shift($args);
webmaster@1: 
webmaster@1:   $query = preg_replace('/^SELECT/i', 'CREATE TEMPORARY TABLE '. $tablename .' Engine=HEAP SELECT', db_prefix_tables($query));
webmaster@1:   if (isset($args[0]) and is_array($args[0])) { // 'All arguments in one array' syntax
webmaster@1:     $args = $args[0];
webmaster@1:   }
webmaster@1:   _db_query_callback($args, TRUE);
webmaster@1:   $query = preg_replace_callback(DB_QUERY_REGEXP, '_db_query_callback', $query);
webmaster@1:   return _db_query($query);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Returns a properly formatted Binary Large OBject value.
webmaster@1:  *
webmaster@1:  * @param $data
webmaster@1:  *   Data to encode.
webmaster@1:  * @return
webmaster@1:  *  Encoded data.
webmaster@1:  */
webmaster@1: function db_encode_blob($data) {
webmaster@1:   global $active_db;
webmaster@1:   return "'". mysql_real_escape_string($data, $active_db) ."'";
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Returns text from a Binary Large Object value.
webmaster@1:  *
webmaster@1:  * @param $data
webmaster@1:  *   Data to decode.
webmaster@1:  * @return
webmaster@1:  *  Decoded data.
webmaster@1:  */
webmaster@1: function db_decode_blob($data) {
webmaster@1:   return $data;
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Prepare user input for use in a database query, preventing SQL injection attacks.
webmaster@1:  */
webmaster@1: function db_escape_string($text) {
webmaster@1:   global $active_db;
webmaster@1:   return mysql_real_escape_string($text, $active_db);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Lock a table.
webmaster@1:  */
webmaster@1: function db_lock_table($table) {
webmaster@1:   db_query('LOCK TABLES {'. db_escape_table($table) .'} WRITE');
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Unlock all locked tables.
webmaster@1:  */
webmaster@1: function db_unlock_tables() {
webmaster@1:   db_query('UNLOCK TABLES');
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Check if a table exists.
webmaster@1:  */
webmaster@1: function db_table_exists($table) {
webmaster@1:   return (bool) db_fetch_object(db_query("SHOW TABLES LIKE '{". db_escape_table($table) ."}'"));
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Check if a column exists in the given table.
webmaster@1:  */
webmaster@1: function db_column_exists($table, $column) {
webmaster@1:   return (bool) db_fetch_object(db_query("SHOW COLUMNS FROM {". db_escape_table($table) ."} LIKE '". db_escape_table($column) ."'"));
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * Wraps the given table.field entry with a DISTINCT(). The wrapper is added to
webmaster@1:  * the SELECT list entry of the given query and the resulting query is returned.
webmaster@1:  * This function only applies the wrapper if a DISTINCT doesn't already exist in
webmaster@1:  * the query.
webmaster@1:  *
webmaster@1:  * @param $table Table containing the field to set as DISTINCT
webmaster@1:  * @param $field Field to set as DISTINCT
webmaster@1:  * @param $query Query to apply the wrapper to
webmaster@1:  * @return SQL query with the DISTINCT wrapper surrounding the given table.field.
webmaster@1:  */
webmaster@1: function db_distinct_field($table, $field, $query) {
webmaster@1:   $field_to_select = 'DISTINCT('. $table .'.'. $field .')';
webmaster@1:   // (?<!text) is a negative look-behind (no need to rewrite queries that already use DISTINCT).
webmaster@1:   return preg_replace('/(SELECT.*)(?:'. $table .'\.|\s)(?<!DISTINCT\()(?<!DISTINCT\('. $table .'\.)'. $field .'(.*FROM )/AUsi', '\1 '. $field_to_select .'\2', $query);
webmaster@1: }
webmaster@1: 
webmaster@1: /**
webmaster@1:  * @} End of "ingroup database".
webmaster@1:  */