database.mysql.inc 14.6 KB
Newer Older
Dries's avatar
   
Dries committed
1
<?php
Kjartan's avatar
Kjartan committed
2
// $Id$
Dries's avatar
   
Dries committed
3

Dries's avatar
   
Dries committed
4
5
6
7
8
9
/**
 * @file
 * Database interface code for MySQL database servers.
 */

/**
Dries's avatar
   
Dries committed
10
 * @ingroup database
Dries's avatar
   
Dries committed
11
12
13
 * @{
 */

14
15
16
17
18
19
20

/**
 * Report database status.
 */
function db_status_report($phase) {
  $t = get_t();

21
22
  $version = db_version();

23
24
  $form['mysql'] = array(
    'title' => $t('MySQL database'),
25
    'value' => ($phase == 'runtime') ? l($version, 'admin/logs/status/sql') : $version,
26
27
28
29
30
31
  );

  if (version_compare($version, DRUPAL_MINIMUM_MYSQL) < 0) {
    $form['mysql']['severity'] = REQUIREMENT_ERROR;
    $form['mysql']['description'] = $t('Your MySQL Server is too old. Drupal requires at least MySQL %version.', array('%version' => DRUPAL_MINIMUM_MYSQL));
  }
32

33
34
35
  return $form;
}

36
37
38
39
40
41
42
43
44
45
/**
 * Returns the version of the database server currently in use.
 *
 * @return Database server version
 */
function db_version() {
  list($version) = explode('-', mysql_get_server_info());
  return $version;
}

Dries's avatar
   
Dries committed
46
47
48
49
50
51
52
53
54
/**
 * 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).
 */
Dries's avatar
   
Dries committed
55
function db_connect($url) {
56
57
  $url = parse_url($url);

58
59
  // Check if MySQL support is present in PHP
  if (!function_exists('mysql_connect')) {
60
61
62
63
64
    // Redirect to installer if using default DB credentials
    if ($url['user'] == 'username' && $url['pass'] == 'password') {
      include_once 'includes/install.inc';
      install_goto('install.php');
    }
65
66
67
68
69
70
71
    drupal_maintenance_theme();
    drupal_set_title('PHP MySQL support not enabled');
    print theme('maintenance_page', '<p>We were 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.</p>
<p>For more help, see the <a href="http://drupal.org/node/258">Installation and upgrading handbook</a>. If you are unsure what these terms mean you should probably contact your hosting provider.</p>');
    exit;
  }

72
73
  // Decode url-encoded information in the db connection string
  $url['user'] = urldecode($url['user']);
74
  // Test if database url has a password.
75
  if (isset($url['pass'])) {
76
77
78
79
80
    $url['pass'] = urldecode($url['pass']);
  }
  else {
    $url['pass'] = '';
  }
81
82
83
  $url['host'] = urldecode($url['host']);
  $url['path'] = urldecode($url['path']);

84
  // Allow for non-standard MySQL port.
Dries's avatar
   
Dries committed
85
86
  if (isset($url['port'])) {
     $url['host'] = $url['host'] .':'. $url['port'];
87
  }
Dries's avatar
   
Dries committed
88

89
90
91
92
93
94
  // - TRUE makes mysql_connect() always open a new link, even if
  //   mysql_connect() was called before with the same parameters.
  //   This is important if you are using two databases on the same
  //   server.
  // - 2 means CLIENT_FOUND_ROWS: return the number of found
  //   (matched) rows, not the number of affected rows.
95
96
  $connection = @mysql_connect($url['host'], $url['user'], $url['pass'], TRUE, 2);
  if (!$connection) {
97
98
99
100
101
102
103
    // 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
104
    drupal_maintenance_theme();
105
    drupal_set_header('HTTP/1.1 503 Service Unavailable');
106
    drupal_set_title('Unable to connect to database server');
107
108
    print theme('maintenance_page', '<p>If you still have to install Drupal, proceed to the <a href="'. base_path() .'install.php">installation page</a>.</p>
<p>If you have already finished installed Drupal, this either means that the username and password information in your <code>settings.php</code> file is incorrect or that we can\'t connect to the MySQL database server. This could mean your hosting provider\'s database server is down.</p>
109
110
111
112
113
114
115
116
117
118
<p>The MySQL error was: '. theme('placeholder', mysql_error()) .'.</p>
<p>Currently, the username is '. theme('placeholder', $url['user']) .' and the database server is '. theme('placeholder', $url['host']) .'.</p>
<ul>
  <li>Are you sure you have the correct username and password?</li>
  <li>Are you sure that you have typed the correct hostname?</li>
  <li>Are you sure that the database server is running?</li>
</ul>
<p>For more help, see the <a href="http://drupal.org/node/258">Installation and upgrading handbook</a>. If you are unsure what these terms mean you should probably contact your hosting provider.</p>');
    exit;
  }
119

120
121
122
  if (!mysql_select_db(substr($url['path'], 1))) {
    drupal_maintenance_theme();
    drupal_set_title('Unable to select database');
123
    print theme('maintenance_page', '<p>We were able to connect to the MySQL database server (which means your username and password are okay) but not able to select the database.</p>
124
<p>The MySQL error was: '. theme('placeholder', mysql_error($connection)) .'.</p>
125
126
127
128
129
130
131
132
133
<p>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']) .'.</p>
<ul>
  <li>Are you sure you have the correct database name?</li>
  <li>Are you sure the database exists?</li>
  <li>Are you sure the username has permission to access the database?</li>
</ul>
<p>For more help, see the <a href="http://drupal.org/node/258">Installation and upgrading handbook</a>. If you are unsure what these terms mean you should probably contact your hosting provider.</p>');
    exit;
  }
Dries's avatar
   
Dries committed
134

135
136
137
138
  /* On MySQL 4.1 and later, force UTF-8 */
  if (version_compare(mysql_get_server_info(), '4.1.0', '>=')) {
    mysql_query('SET NAMES "utf8"', $connection);
  }
Dries's avatar
   
Dries committed
139
  return $connection;
Dries's avatar
   
Dries committed
140
141
}

Dries's avatar
   
Dries committed
142
143
144
/**
 * Helper function for db_query().
 */
Dries's avatar
   
Dries committed
145
function _db_query($query, $debug = 0) {
146
  global $active_db, $queries;
Dries's avatar
   
Dries committed
147

148
  if (variable_get('dev_query', 0)) {
Dries's avatar
   
Dries committed
149
    list($usec, $sec) = explode(' ', microtime());
Dries's avatar
   
Dries committed
150
    $timer = (float)$usec + (float)$sec;
Dries's avatar
   
Dries committed
151
  }
Dries's avatar
   
Dries committed
152

Dries's avatar
   
Dries committed
153
  $result = mysql_query($query, $active_db);
Dries's avatar
   
Dries committed
154

155
  if (variable_get('dev_query', 0)) {
156
    $bt = debug_backtrace();
157
    $query = $bt[2]['function'] ."\n". $query;
Dries's avatar
   
Dries committed
158
    list($usec, $sec) = explode(' ', microtime());
Dries's avatar
   
Dries committed
159
160
161
162
163
    $stop = (float)$usec + (float)$sec;
    $diff = $stop - $timer;
    $queries[] = array($query, $diff);
  }

Dries's avatar
   
Dries committed
164
  if ($debug) {
165
    print '<p>query: '. $query .'<br />error:'. mysql_error($active_db) .'</p>';
Dries's avatar
   
Dries committed
166
167
  }

168
  if (!mysql_errno($active_db)) {
Dries's avatar
   
Dries committed
169
    return $result;
Kjartan's avatar
Kjartan committed
170
171
  }
  else {
172
    trigger_error(check_plain(mysql_error($active_db) ."\nquery: ". $query), E_USER_WARNING);
173
    return FALSE;
Dries's avatar
   
Dries committed
174
175
176
  }
}

Dries's avatar
   
Dries committed
177
178
179
180
181
182
183
184
185
/**
 * 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.
 */
Dries's avatar
   
Dries committed
186
187
188
189
190
191
function db_fetch_object($result) {
  if ($result) {
    return mysql_fetch_object($result);
  }
}

Dries's avatar
   
Dries committed
192
193
194
195
196
197
198
199
200
201
/**
 * 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.
 */
Dries's avatar
   
Dries committed
202
203
204
205
206
207
function db_fetch_array($result) {
  if ($result) {
    return mysql_fetch_array($result, MYSQL_ASSOC);
  }
}

Dries's avatar
   
Dries committed
208
209
210
211
212
213
214
215
/**
 * 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.
 */
Dries's avatar
   
Dries committed
216
217
218
219
220
221
function db_num_rows($result) {
  if ($result) {
    return mysql_num_rows($result);
  }
}

Dries's avatar
   
Dries committed
222
223
224
225
226
227
228
229
230
231
232
/**
 * 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
233
 *   The resulting field or FALSE.
Dries's avatar
   
Dries committed
234
 */
Dries's avatar
   
Dries committed
235
236
237
238
function db_result($result, $row = 0) {
  if ($result && mysql_num_rows($result) > $row) {
    return mysql_result($result, $row);
  }
239
  return FALSE;
Dries's avatar
   
Dries committed
240
241
}

Dries's avatar
   
Dries committed
242
243
244
/**
 * Determine whether the previous query caused an error.
 */
Dries's avatar
   
Dries committed
245
function db_error() {
246
247
  global $active_db;
  return mysql_errno($active_db);
Dries's avatar
   
Dries committed
248
249
}

Dries's avatar
   
Dries committed
250
251
252
253
254
255
256
/**
 * 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.
257
258
259
 *
 * Note that the table name should be in curly brackets to preserve compatibility
 * with table prefixes. For example, db_next_id('{node}_nid');
Dries's avatar
   
Dries committed
260
 */
Dries's avatar
   
Dries committed
261
function db_next_id($name) {
Dries's avatar
   
Dries committed
262
  $name = db_prefix_tables($name);
Dries's avatar
   
Dries committed
263
  db_query('LOCK TABLES {sequences} WRITE');
Dries's avatar
   
Dries committed
264
265
  $id = db_result(db_query("SELECT id FROM {sequences} WHERE name = '%s'", $name)) + 1;
  db_query("REPLACE INTO {sequences} VALUES ('%s', %d)", $name, $id);
Dries's avatar
   
Dries committed
266
  db_query('UNLOCK TABLES');
Dries's avatar
   
Dries committed
267
268
269
270

  return $id;
}

Dries's avatar
   
Dries committed
271
272
273
/**
 * Determine the number of rows changed by the preceding query.
 */
Dries's avatar
   
Dries committed
274
function db_affected_rows() {
275
276
  global $active_db;
  return mysql_affected_rows($active_db);
Dries's avatar
   
Dries committed
277
278
}

Dries's avatar
   
Dries committed
279
/**
Dries's avatar
   
Dries committed
280
281
282
283
284
285
 * 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.
Dries's avatar
   
Dries committed
286
 *
Dries's avatar
   
Dries committed
287
288
289
 * @param $query
 *   A string containing an SQL query.
 * @param ...
290
291
292
293
294
295
296
297
298
 *   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.
 *
Dries's avatar
   
Dries committed
299
300
301
302
303
304
305
 * @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.
Dries's avatar
   
Dries committed
306
 */
Dries's avatar
Dries committed
307
308
309
310
function db_query_range($query) {
  $args = func_get_args();
  $count = array_pop($args);
  $from = array_pop($args);
311
  array_shift($args);
312
313

  $query = db_prefix_tables($query);
314
315
  if (isset($args[0]) and is_array($args[0])) { // 'All arguments in one array' syntax
    $args = $args[0];
Dries's avatar
Dries committed
316
  }
317
318
  _db_query_callback($args, TRUE);
  $query = preg_replace_callback(DB_QUERY_REGEXP, '_db_query_callback', $query);
319
  $query .= ' LIMIT '. (int)$from .', '. (int)$count;
Dries's avatar
Dries committed
320
  return _db_query($query);
Dries's avatar
   
Dries committed
321
322
}

323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
/**
 * 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 ...
340
341
342
343
344
345
346
347
348
 *   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.
 *
349
 * @param $table
350
351
 *   The name of the temporary table to select into. This name will not be
 *   prefixed as there is no risk of collision.
352
353
354
355
356
357
358
 * @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);
359
  array_shift($args);
360

361
  $query = preg_replace('/^SELECT/i', 'CREATE TEMPORARY TABLE '. $tablename .' Engine=HEAP SELECT', db_prefix_tables($query));
362
363
  if (isset($args[0]) and is_array($args[0])) { // 'All arguments in one array' syntax
    $args = $args[0];
364
  }
365
366
  _db_query_callback($args, TRUE);
  $query = preg_replace_callback(DB_QUERY_REGEXP, '_db_query_callback', $query);
367
368
369
  return _db_query($query);
}

Dries's avatar
   
Dries committed
370
371
372
373
374
375
376
377
378
/**
 * Returns a properly formatted Binary Large OBject value.
 *
 * @param $data
 *   Data to encode.
 * @return
 *  Encoded data.
 */
function db_encode_blob($data) {
379
  global $active_db;
380
  return "'". mysql_real_escape_string($data, $active_db) ."'";
Dries's avatar
   
Dries committed
381
382
383
}

/**
384
 * Returns text from a Binary Large Object value.
Dries's avatar
   
Dries committed
385
386
387
388
389
390
391
392
393
394
 *
 * @param $data
 *   Data to decode.
 * @return
 *  Decoded data.
 */
function db_decode_blob($data) {
  return $data;
}

Dries's avatar
   
Dries committed
395
396
397
398
/**
 * Prepare user input for use in a database query, preventing SQL injection attacks.
 */
function db_escape_string($text) {
399
400
  global $active_db;
  return mysql_real_escape_string($text, $active_db);
Dries's avatar
   
Dries committed
401
402
}

403
404
405
406
/**
 * Lock a table.
 */
function db_lock_table($table) {
407
  db_query('LOCK TABLES {'. db_escape_table($table) .'} WRITE');
408
409
410
411
412
413
414
415
416
}

/**
 * Unlock all locked tables.
 */
function db_unlock_tables() {
  db_query('UNLOCK TABLES');
}

drumm's avatar
drumm committed
417
418
419
420
/**
 * Check if a table exists.
 */
function db_table_exists($table) {
421
  return db_num_rows(db_query("SHOW TABLES LIKE '{". db_escape_table($table) ."}'"));
drumm's avatar
drumm committed
422
423
}

424
425
426
427
428
429
430
/**
 * Check if a column exists in the given table.
 */
function db_column_exists($table, $column) {
  return db_num_rows(db_query("SHOW COLUMNS FROM {%s} LIKE '%s'", $table, $column));
}

431
432
433
434
435
436
437
438
439
440
441
442
443
444
/**
 * 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 .')';
  // (?<!text) is a negative look-behind (no need to rewrite queries that already use DISTINCT).
445
  return preg_replace('/(SELECT.*)(?:'. $table .'\.|\s)(?<!DISTINCT\()(?<!DISTINCT\('. $table .'\.)'. $field .'(.*FROM )/AUsi', '\1 '. $field_to_select .'\2', $query);
446
447
}

Dries's avatar
   
Dries committed
448
/**
Dries's avatar
   
Dries committed
449
 * @} End of "ingroup database".
Dries's avatar
   
Dries committed
450
451
 */

452