### Eclipse Workspace Patch 1.0 #P Drupal HEAD #2 Index: includes/install.inc =================================================================== RCS file: /cvs/drupal/drupal/includes/install.inc,v retrieving revision 1.26 diff -u -r1.26 install.inc --- includes/install.inc 21 Nov 2006 19:56:52 -0000 1.26 +++ includes/install.inc 21 Nov 2006 23:43:02 -0000 @@ -144,7 +144,7 @@ function drupal_detect_database_types() { $databases = array(); - foreach (array('mysql', 'mysqli', 'pgsql') as $type) { + foreach (array('mysql', 'mysqli', 'pgsql', 'mssql') as $type) { if (file_exists('./includes/install.'. $type .'.inc')) { include_once './includes/install.'. $type .'.inc'; $function = $type .'_is_available'; Index: includes/database.mssql.inc =================================================================== RCS file: includes/database.mssql.inc diff -N includes/database.mssql.inc --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ includes/database.mssql.inc 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,468 @@ + $t('MS SQL database'), + 'value' => ($phase == 'runtime') ? l($version, 'admin/logs/status/sql') : $version, + ); + + /*if (version_compare($version, DRUPAL_MINIMUM_MSSQL) < 0) { + $form['mysql']['severity'] = REQUIREMENT_ERROR; + $form['mysql']['description'] = $t('Your MS SQL Server is too old. Drupal requires at least MS SQL %version.', array('%version' => DRUPAL_MINIMUM_MSSQL)); + }*/ + + return $form; +} + +/** + * Returns the version of the database server currently in use. + * + * @return Database server version + */ +function db_version() { + list($version) = explode('-', 'version'); + return $version; +} + +/** + * Initialize a database connection. + * + * Note that you can change the mysql_connect() call to mysql_pconnect() if you + * want to use persistent connections. This is not recommended on shared hosts, + * and might require additional database/webserver tuning. It can increase + * performance, however, when the overhead to connect to your database is high + * (e.g. your database and web server live on different machines). + */ +function db_connect($url) { + // Check if MS SQL support is present in PHP + if (!function_exists('mssql_connect')) { + drupal_maintenance_theme(); + drupal_set_title('PHP MS SQL support not enabled'); + print theme('maintenance_page', '

We were unable to use the MS SQL database because the MS SQL extension for PHP is not installed. Check your PHP.ini to see how you can enable it.

+

For more help, see the Installation and upgrading handbook. If you are unsure what these terms mean you should probably contact your hosting provider.

'); + exit; + } + + $url = parse_url($url); + + // Decode url-encoded information in the db connection string + $url['user'] = urldecode($url['user']); + // Test if database url has a password. + if(isset($url['pass'])) { + $url['pass'] = urldecode($url['pass']); + } + else { + $url['pass'] = ''; + } + $url['host'] = stripslashes(urldecode($url['host'])); + $url['path'] = urldecode($url['path']); + + // Allow for non-standard MS SQL port. + if (isset($url['port'])) { + $url['host'] = $url['host'] .','. $url['port']; + } + + // Allow large texts for MS SQL. + ini_set("mssql.textlimit", 16000000); + ini_set("mssql.textsize", 16000000); + + // TODO: Put back @. + $connection = mssql_connect($url['host'], $url['user'], $url['pass']); + if (!$connection) { + // Redirect to installer if using default DB credentials + if ($url['user'] == 'username' && $url['pass'] == 'password') { + include_once 'includes/install.inc'; + install_goto('install.php'); + } + + // Show error screen otherwise + drupal_maintenance_theme(); + drupal_set_header('HTTP/1.1 503 Service Unavailable'); + drupal_set_title('Unable to connect to database server'); + print theme('maintenance_page', '

If you still have to install Drupal, proceed to the installation page.

+

If you have already finished installed Drupal, this either means that the username and password information in your settings.php file is incorrect or that we can\'t connect to the MS SQL database server. This could mean your hosting provider\'s database server is down.

+

The MS SQL error was: '. theme('placeholder', mssql_get_last_message()) .'.

+

Currently, the username is '. theme('placeholder', $url['user']) .' and the database server is '. theme('placeholder', $url['host']) .'.

+ +

For more help, see the Installation and upgrading handbook. If you are unsure what these terms mean you should probably contact your hosting provider.

'); + exit; + } + + if (!mssql_select_db(substr($url['path'], 1))) { + drupal_maintenance_theme(); + drupal_set_title('Unable to select database'); + print theme('maintenance_page', '

We were able to connect to the MS SQL database server (which means your username and password are okay) but not able to select the database.

+

The MS SQL error was: '. theme('placeholder', mssql_get_last_message()) .'.

+

Currently, the database is '. theme('placeholder', substr($url['path'], 1)) .'. The username is '. theme('placeholder', $url['user']) .' and the database server is '. theme('placeholder', $url['host']) .'.

+ +

For more help, see the Installation and upgrading handbook. If you are unsure what these terms mean you should probably contact your hosting provider.

'); + exit; + } + + // TODO: Document this. Not sure what this does. + mssql_query('SET TEXTSIZE 524287;'); + + return $connection; +} + +/** + * Helper function for db_query(). + */ +function _db_query($query, $debug = 0) { + global $active_db, $queries; + + if (variable_get('dev_query', 0)) { + list($usec, $sec) = explode(' ', microtime()); + $timer = (float)$usec + (float)$sec; + } + + // LENGTH is called DATALENGTH in MS SQL. + // TODO: Preg search instead of strpos. + if(strpos($query,"LENGTH")){ + $pattern = '/(.+)LENGTH(.+)/i'; + $query = preg_replace($pattern, '${1}DATALENGTH$2', $query); + } + // No LIMIT in MS SQL. We use SELECT TOP n ... FROM ... + // TODO: Preg search instead of strpos. + if(strpos($query,'LIMIT')){ + $pattern = '/(.+)LIMIT (\d+), (\d+)/i'; + $query_new = preg_replace($pattern, '${1}', $query); + $limit = preg_replace($pattern, '$3', $query); + $query = str_replace('SELECT', 'SELECT TOP '.$limit, $query_new); + } + // TODO: Not sure what this is. + // TODO: Preg search instead of strpos so we don't replace valid instances of 'relevance'. + if(strpos($query,'relevance')){ + $query = str_replace('relevance', '_relevance', $query_new); + } + + $result = mssql_query($query, $active_db); + + if (variable_get('dev_query', 0)) { + $bt = debug_backtrace(); + $query = $bt[2]['function'] . "\n" . $query; + list($usec, $sec) = explode(' ', microtime()); + $stop = (float)$usec + (float)$sec; + $diff = $stop - $timer; + $queries[] = array($query, $diff); + } + + if ($debug) { + print '

query: '. $query .'
error:'. mssql_get_last_message() .'

'; + } + + // TODO: if (!mssql_errno($active_db)) { + return $result; + /*} + else { + trigger_error(check_plain(mssql_get_last_message() ."\nquery: ". $query), E_USER_WARNING); + return FALSE; + }*/ +} + +/** + * Fetch one result row from the previous query as an object. + * + * @param $result + * A database query result resource, as returned from db_query(). + * @return + * An object representing the next row of the result. The attributes of this + * object are the table fields selected by the query. + */ +function db_fetch_object($result) { + if ($result) { + return mssql_fetch_object($result); + } +} + +/** + * Fetch one result row from the previous query as an array. + * + * @param $result + * A database query result resource, as returned from db_query(). + * @return + * An associative array representing the next row of the result. The keys of + * this object are the names of the table fields selected by the query, and + * the values are the field values for this result row. + */ +function db_fetch_array($result) { + if ($result) { + return mssql_fetch_array($result, MSSQL_ASSOC); + } +} + +/** + * Determine how many result rows were found by the preceding query. + * + * @param $result + * A database query result resource, as returned from db_query(). + * @return + * The number of result rows. + */ +function db_num_rows($result) { + if ($result) { + return mssql_num_rows($result); + } +} + +/** + * Return an individual result field from the previous query. + * + * Only use this function if exactly one field is being selected; otherwise, + * use db_fetch_object() or db_fetch_array(). + * + * @param $result + * A database query result resource, as returned from db_query(). + * @param $row + * The index of the row whose result is needed. + * @return + * The resulting field. + */ +function db_result($result, $row = 0) { + if ($result && mssql_num_rows($result) > $row) { + mssql_data_seek($result, $row); + $row_result = mssql_fetch_row($result); + return $row_result[0]; + } +} + +/** + * Determine whether the previous query caused an error. + */ +function db_error() { + return mssql_get_last_message(); +} + +/** + * Return a new unique ID in the given sequence. + * + * For compatibility reasons, Drupal does not use auto-numbered fields in its + * database tables. Instead, this function is used to return a new unique ID + * of the type requested. If necessary, a new sequence with the given name + * will be created. + */ +function db_next_id($name) { + $name = db_prefix_tables($name); + db_lock_table('sequences'); + $id = db_result(db_query("SELECT id FROM {sequences} WHERE name = '%s'", $name)) + 1; + if (db_num_rows(db_query("SELECT id FROM {sequences} WHERE name = '%s'", $name)) == 0) { + db_query("INSERT INTO {sequences} VALUES ('%s', %d)", $name, $id); + } + else { + db_query("UPDATE {sequences} SET id = %d WHERE name = '%s'", $id, $name); + } + db_unlock_tables(); + + return $id; +} + +/** + * Determine the number of rows changed by the preceding query. + */ +function db_affected_rows() { + global $active_db; + $result = mssql_query('SELECT @@ROWCOUNT', $active_db); + list($affected) = mssql_fetch_row($result); + return $affected; +} + +/** + * Runs a limited-range query in the active database. + * + * Use this as a substitute for db_query() when a subset of the query is to be + * returned. + * User-supplied arguments to the query should be passed in as separate parameters + * so that they can be properly escaped to avoid SQL injection attacks. + * + * Note that if you need to know how many results were returned, you should do + * a SELECT COUNT(*) on the temporary table afterwards. db_num_rows() and + * db_affected_rows() do not give consistent result across different database + * types in this case. + * + * @param $query + * A string containing an SQL query. + * @param ... + * A variable number of arguments which are substituted into the query + * using printf() syntax. The query arguments can be enclosed in one + * array instead. + * Valid %-modifiers are: %s, %d, %f, %b (binary data, do not enclose + * in '') and %%. + * + * NOTE: using this syntax will cast NULL and FALSE values to decimal 0, + * and TRUE values to decimal 1. + * + * @param $from + * The first result row to return. + * @param $count + * The maximum number of result rows to return. + * @return + * A database query result resource, or FALSE if the query was not executed + * correctly. + */ +function db_query_range($query) { + $args = func_get_args(); + $count = array_pop($args); + $from = array_pop($args); + array_shift($args); + + $query = db_prefix_tables($query); + if (isset($args[0]) and is_array($args[0])) { // 'All arguments in one array' syntax + $args = $args[0]; + } + _db_query_callback($args, TRUE); + $query = preg_replace_callback(DB_QUERY_REGEXP, '_db_query_callback', $query); + $query .= ' LIMIT '. (int)$from .', '. (int)$count; + return _db_query($query); +} + +/** + * Runs a SELECT query and stores its results in a temporary table. + * + * Use this as a substitute for db_query() when the results need to stored + * in a temporary table. Temporary tables exist for the duration of the page + * request. + * User-supplied arguments to the query should be passed in as separate parameters + * so that they can be properly escaped to avoid SQL injection attacks. + * + * Note that if you need to know how many results were returned, you should do + * a SELECT COUNT(*) on the temporary table afterwards. db_num_rows() and + * db_affected_rows() do not give consistent result across different database + * types in this case. + * + * @param $query + * A string containing a normal SELECT SQL query. + * @param ... + * A variable number of arguments which are substituted into the query + * using printf() syntax. The query arguments can be enclosed in one + * array instead. + * Valid %-modifiers are: %s, %d, %f, %b (binary data, do not enclose + * in '') and %%. + * + * NOTE: using this syntax will cast NULL and FALSE values to decimal 0, + * and TRUE values to decimal 1. + * + * @param $table + * The name of the temporary table to select into. This name will not be + * prefixed as there is no risk of collision. + * @return + * A database query result resource, or FALSE if the query was not executed + * correctly. + */ +function db_query_temporary($query) { + $args = func_get_args(); + $tablename = array_pop($args); + array_shift($args); + + $query = preg_replace('/^SELECT/i', 'CREATE TEMPORARY TABLE '. $tablename .' SELECT', db_prefix_tables($query)); + if (isset($args[0]) and is_array($args[0])) { // 'All arguments in one array' syntax + $args = $args[0]; + } + _db_query_callback($args, TRUE); + $query = preg_replace_callback(DB_QUERY_REGEXP, '_db_query_callback', $query); + return _db_query($query); +} + +/** + * Returns a properly formatted Binary Large OBject value. + * + * @param $data + * Data to encode. + * @return + * Encoded data. + */ +function db_encode_blob($data) { + global $active_db; + return "'" . base64_encode($data) . "'"; +} + +/** + * Returns text from a Binary Large Object value. + * + * @param $data + * Data to decode. + * @return + * Decoded data. + */ +function db_decode_blob($data) { + return base64_decode($data); +} + +/** + * Prepare user input for use in a database query, preventing SQL injection attacks. + */ +function db_escape_string($text) { + // TODO: Use proper function here for db escaping. + return addslashes($text); +} + +/** + * Lock a table. + */ +function db_lock_table($table) { + db_query('SET TRANSACTION ISOLATION LEVEL SERIALIZABLE'); + db_query('BEGIN TRANSACTION'); +} + +/** + * Unlock all locked tables. + */ +function db_unlock_tables() { + db_query('COMMIT'); +} + +/** + * Check if a table exists. + */ +function db_table_exists($table) { + return db_num_rows(db_query("SHOW TABLES LIKE '{" . db_escape_table($table) . "}'")); +} + +/** + * Wraps the given table.field entry with a DISTINCT(). The wrapper is added to + * the SELECT list entry of the given query and the resulting query is returned. + * This function only applies the wrapper if a DISTINCT doesn't already exist in + * the query. + * + * @param $table Table containing the field to set as DISTINCT + * @param $field Field to set as DISTINCT + * @param $query Query to apply the wrapper to + * @return SQL query with the DISTINCT wrapper surrounding the given table.field. + */ +function db_distinct_field($table, $field, $query) { + $field_to_select = 'DISTINCT('. $table .'.'. $field .')'; + // (?
  • Are you sure you have the correct username and password?
  • Are you sure that you have typed the correct database hostname?
  • Are you sure that the database server is running?
    • For more help, see the Installation and upgrading handbook. If you are unsure what these terms mean you should probably contact your hosting provider.', array('%error' => $php_errormsg)), 'error'); + return FALSE; + } + + // Test selecting the database. + if (!mssql_select_db(substr($url['path'], 1))) { + drupal_set_message(st('We were able to connect to the MS SQL database server (which means your username and password are valid) but not able to select your database. MS SQL reports the following message: %error.For more help, see the Installation and upgrading handbook. If you are unsure what these terms mean you should probably contact your hosting provider.', array('%error' => mssql_get_last_message())), 'error'); + return FALSE; + } + + $success = array('CONNECT'); + + // Test CREATE. + $query = 'CREATE TABLE drupal_install_test (id int NULL)'; + $result = mssql_query($query); + if ($result === FALSE) { + drupal_set_message(st('We were unable to create a test table on your MS SQL database server with the command %query. MS SQL reports the following message: %error.For more help, see the Installation and upgrading handbook. If you are unsure what these terms mean you should probably contact your hosting provider.', array('%query' => $query, '%error' => $php_errormsg)), 'error'); + return FALSE; + } + $err = FALSE; + $success[] = 'SELECT'; + $success[] = 'CREATE'; + + // Test INSERT. + $query = 'INSERT INTO drupal_install_test (id) VALUES (1)'; + $result = mssql_query($query); + if ($result === FALSE) { + drupal_set_message(st('We were unable to insert a value into a test table on your MS SQL database server. We tried inserting a value with the command %query and MS SQL reported the following error: %error.', array('%query' => $query, '%error' => $php_errormsg)), 'error'); + $err = TRUE; + } + else { + $success[] = 'INSERT'; + } + + // Test UPDATE. + $query = 'UPDATE drupal_install_test SET id = 2'; + $result = mssql_query($query); + if ($result === FALSE) { + drupal_set_message(st('We were unable to update a value in a test table on your MS SQL database server. We tried updating a value with the command %query and MS SQL reported the following error: %error.', array('%query' => $query, '%error' => $php_errormsg)), 'error'); + $err = TRUE; + } + else { + $success[] = 'UPDATE'; + } + + // Test LOCK. + $query = 'BEGIN TRANSACTION'; + $result = mssql_query($query); + if ($result === FALSE) { + drupal_set_message(st('We were unable to lock a test table on your MS SQL database server. We tried locking a table with the command %query and MS SQL reported the following error: %error.', array('%query' => $query, '%error' => $php_errormsg)), 'error'); + $err = TRUE; + } + else { + $success[] = 'LOCK'; + } + + // Test UNLOCK. + $query = 'COMMIT TRANSACTION'; + $result = mssql_query($query); + if ($result === FALSE) { + drupal_set_message(st('We were unable to unlock a test table on your MS SQL database server. We tried unlocking a table with the command %query and MS SQL reported the following error: %error.', array('%query' => $query, '%error' => $php_errormsg)), 'error'); + $err = TRUE; + } + else { + $success[] = 'UNLOCK'; + } + + // Test DELETE. + $query = 'DELETE FROM drupal_install_test'; + $result = mssql_query($query); + if ($result === FALSE) { + drupal_set_message(st('We were unable to delete a value from a test table on your MS SQL database server. We tried deleting a value with the command %query and MS SQL reported the following error: %error.', array('%query' => $query, '%error' => $php_errormsg)), 'error'); + $err = TRUE; + } + else { + $success[] = 'DELETE'; + } + + // Test DROP. + $query = 'DROP TABLE drupal_install_test'; + $result = mssql_query($query); + if ($result === FALSE) { + drupal_set_message(st('We were unable to drop a test table from your MS SQL database server. We tried dropping a table with the command %query and MS SQL reported the following error %error.', array('%query' => $query, '%error' => $php_errormsg)), 'error'); + $err = TRUE; + } + else { + $success[] = 'DROP'; + } + + if ($err) { + return FALSE; + } + + mssql_close($connection); + return TRUE; +}