common.inc 39 KB
Newer Older
Dries's avatar
   
Dries committed
1
<?php
2
// $Id$
Dries's avatar
   
Dries committed
3

Dries's avatar
   
Dries committed
4
5
6
7
8
9
10
11
/**
 * @file
 * Common functions that many Drupal modules will need to reference.
 *
 * The functions that are critical and need to be available even when serving
 * a cached page are instead located in bootstrap.inc.
 */

12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/**
 * Return status for saving which involved creating a new item.
 */
define('SAVED_NEW', 1);

/**
 * Return status for saving which involved an update to an existing item.
 */
define('SAVED_UPDATED', 2);

/**
 * Return status for saving which deleted an existing item.
 */
define('SAVED_DELETED', 3);

27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/**
 * Set content for a specified region.
 *
 * @param $region
 *   Page region the content is assigned to.
 *
 * @param $data
 *   Content to be set.
 */
function drupal_set_content($region = null, $data = null) {
  static $content = array();

  if (!is_null($region) && !is_null($data)) {
    $content[$region][] = $data;
  }
  return $content;
}

/**
 * Get assigned content.
 *
 * @param $region
 *   A specified region to fetch content for.  If null, all regions will be returned.
 *
 * @param $delimiter
 *   Content to be inserted between exploded array elements.
 */
54
function drupal_get_content($region = NULL, $delimiter = ' ') {
55
  $content = drupal_set_content();
56
57
  if (isset($region)) {
    if (isset($content[$region]) && is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
58
      return implode($delimiter, $content[$region]);
59
    }
60
61
62
63
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
Steven Wittens's avatar
Steven Wittens committed
64
        $content[$region] = implode($delimiter, $content[$region]);
65
66
67
68
69
70
      }
    }
    return $content;
  }
}

Dries's avatar
   
Dries committed
71
/**
Dries's avatar
   
Dries committed
72
 * Set the breadcrumb trail for the current page.
Dries's avatar
   
Dries committed
73
 *
Dries's avatar
   
Dries committed
74
75
76
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
77
 */
Dries's avatar
   
Dries committed
78
79
80
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

81
  if (!is_null($breadcrumb)) {
Dries's avatar
   
Dries committed
82
83
84
85
86
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

Dries's avatar
   
Dries committed
87
88
89
/**
 * Get the breadcrumb trail for the current page.
 */
Dries's avatar
   
Dries committed
90
91
92
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

93
  if (is_null($breadcrumb)) {
Dries's avatar
   
Dries committed
94
95
96
97
98
99
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

Dries's avatar
Dries committed
100
/**
Dries's avatar
   
Dries committed
101
 * Add output to the head tag of the HTML page.
Dries's avatar
   
Dries committed
102
 * This function can be called as long the headers aren't sent.
Dries's avatar
Dries committed
103
104
 */
function drupal_set_html_head($data = NULL) {
Dries's avatar
   
Dries committed
105
  static $stored_head = '';
Dries's avatar
Dries committed
106
107

  if (!is_null($data)) {
Dries's avatar
   
Dries committed
108
    $stored_head .= $data ."\n";
Dries's avatar
Dries committed
109
110
111
112
  }
  return $stored_head;
}

Dries's avatar
   
Dries committed
113
114
115
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries's avatar
Dries committed
116
function drupal_get_html_head() {
117
  global $base_path;
Dries's avatar
Dries committed
118

Dries's avatar
   
Dries committed
119
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
120
  $output .= theme('stylesheet_import', $base_path .'misc/drupal.css');
Dries's avatar
Dries committed
121
122
123
124

  return $output . drupal_set_html_head();
}

Dries's avatar
   
Dries committed
125
/**
126
 * Reset the static variable which holds the aliases mapped for this request.
Dries's avatar
   
Dries committed
127
 */
128
129
function drupal_clear_path_cache() {
  drupal_lookup_path('wipe');
Dries's avatar
   
Dries committed
130
}
Kjartan's avatar
Kjartan committed
131

Dries's avatar
Dries committed
132
/**
Dries's avatar
   
Dries committed
133
 * Set an HTTP response header for the current page.
Dries's avatar
Dries committed
134
135
 */
function drupal_set_header($header = NULL) {
136
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries's avatar
   
Dries committed
137
  // Otherwise, header('') could get called when serving the page later, which
138
139
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries's avatar
Dries committed
140

141
  if (strlen($header)) {
Dries's avatar
Dries committed
142
    header($header);
143
    $stored_headers[] = $header;
Dries's avatar
Dries committed
144
  }
145
  return implode("\n", $stored_headers);
Dries's avatar
Dries committed
146
147
}

Dries's avatar
   
Dries committed
148
149
150
/**
 * Get the HTTP response headers for the current page.
 */
Dries's avatar
Dries committed
151
152
153
154
function drupal_get_headers() {
  return drupal_set_header();
}

Dries's avatar
   
Dries committed
155
156
157
/**
 * @name HTTP handling
 * @{
Dries's avatar
   
Dries committed
158
 * Functions to properly handle HTTP responses.
Dries's avatar
   
Dries committed
159
160
 */

161
162
/**
 * Prepare a destination query string for use in combination with
163
164
165
166
167
 * drupal_goto(). Used to direct the user back to the referring page
 * after completing a form. By default the current URL is returned.
 * If a destination exists in the previous request, that destination
 * is returned.  As such, a destination can persist across multiple
 * pages.
168
169
170
171
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
172
173
174
175
176
177
178
179
180
181
  if ($_REQUEST['destination']) {
    return 'destination='. urlencode($_REQUEST['destination']);
  }
  else {
    $destination[] = $_GET['q'];
    $params = array('page', 'sort', 'order');
    foreach ($params as $param) {
      if (isset($_GET[$param])) {
        $destination[] = "$param=". $_GET[$param];
      }
182
    }
183
    return 'destination='. urlencode(implode('&', $destination));
184
185
186
  }
}

Kjartan's avatar
Kjartan committed
187
/**
Dries's avatar
   
Dries committed
188
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
189
 *
Dries's avatar
   
Dries committed
190
191
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
192
 *
193
194
195
196
197
198
199
200
201
202
 * Usually the redirected URL is constructed from this function's input
 * parameters.  However you may override that behavior by setting a
 * <em>destination</em> in either the $_REQUEST-array (i.e. by using
 * the query string of an URI) or the $_REQUEST['edit']-array (i.e. by
 * using a hidden form field).  This is used to direct the user back to
 * the proper page after completing a form.  For example, after editing
 * a post on the 'admin/node'-page or after having logged on using the
 * 'user login'-block in a sidebar.  The function drupal_get_destination()
 * can be used to help set the destination URL.
 *
Dries's avatar
   
Dries committed
203
204
205
206
207
208
209
210
211
212
213
214
215
 * It is advised to use drupal_goto() instead of PHP's header(), because
 * drupal_goto() will append the user's session ID to the URI when PHP is
 * compiled with "--enable-trans-sid".
 *
 * This function ends the request; use it rather than a print theme('page')
 * statement in your menu callback.
 *
 * @param $path
 *   A Drupal path.
 * @param $query
 *   The query string component, if any.
 * @param $fragment
 *   The destination fragment identifier (named anchor).
216
217
 *
 * @see drupal_get_destination()
Kjartan's avatar
Kjartan committed
218
 */
Dries's avatar
   
Dries committed
219
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
220
221
222
223
224
225
226
  if ($_REQUEST['destination']) {
    extract(parse_url($_REQUEST['destination']));
  }
  else if ($_REQUEST['edit']['destination']) {
    extract(parse_url($_REQUEST['edit']['destination']));
  }

227
  $url = url($path, $query, $fragment, TRUE);
Kjartan's avatar
Kjartan committed
228

Dries's avatar
   
Dries committed
229
230
231
232
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

  header('Location: '. $url);
Kjartan's avatar
Kjartan committed
233

Dries's avatar
   
Dries committed
234
235
236
  // The "Location" header sends a REDIRECT status code to the http
  // daemon. In some cases this can go wrong, so we make sure none
  // of the code below the drupal_goto() call gets executed when we redirect.
Kjartan's avatar
Kjartan committed
237
238
239
  exit();
}

240
241

/**
242
 * Generates a site off-line message
243
244
 */
function drupal_site_offline() {
245
  drupal_set_header('HTTP/1.0 503 Service unavailable');
246
  drupal_set_title(t('Site off-line'));
247
  print theme('maintenance_page', variable_get('site_offline_message',
248
    t('%site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('%site' => variable_get('site_name', t('This Drupal site'))))));
249
250
}

Kjartan's avatar
Kjartan committed
251
252
253
/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
   
Dries committed
254
function drupal_not_found() {
255
  drupal_set_header('HTTP/1.0 404 Not Found');
256
  watchdog('page not found', t('%page not found.', array('%page' => theme('placeholder', $_GET['q']))), WATCHDOG_WARNING);
Dries's avatar
   
Dries committed
257
258

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries's avatar
   
Dries committed
259
  $status = MENU_NOT_FOUND;
260
  if ($path && $path != $_GET['q']) {
Dries's avatar
   
Dries committed
261
    menu_set_active_item($path);
262
    $return = menu_execute_active_handler();
Dries's avatar
   
Dries committed
263
264
  }

265
  if (empty($return)) {
266
    drupal_set_title(t('Page not found'));
Dries's avatar
   
Dries committed
267
  }
268
  print theme('page', $return);
Dries's avatar
   
Dries committed
269
}
Dries's avatar
   
Dries committed
270

Dries's avatar
   
Dries committed
271
272
273
274
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
275
  drupal_set_header('HTTP/1.0 403 Forbidden');
276
  watchdog('access denied', t('%page denied access.', array('%page' => theme('placeholder', $_GET['q']))), WATCHDOG_WARNING, l(t('view'), $_GET['q']));
Dries's avatar
   
Dries committed
277
278

  $path = drupal_get_normal_path(variable_get('site_403', ''));
Dries's avatar
   
Dries committed
279
  $status = MENU_NOT_FOUND;
280
  if ($path && $path != $_GET['q']) {
Dries's avatar
   
Dries committed
281
    menu_set_active_item($path);
282
    $return = menu_execute_active_handler();
Dries's avatar
   
Dries committed
283
284
  }

285
  if (empty($return)) {
286
    drupal_set_title(t('Access denied'));
287
    $return = t('You are not authorized to access this page.');
Dries's avatar
   
Dries committed
288
  }
289
  print theme('page', $return);
Dries's avatar
   
Dries committed
290
291
}

Dries's avatar
   
Dries committed
292
/**
Dries's avatar
   
Dries committed
293
 * Perform an HTTP request.
Dries's avatar
   
Dries committed
294
 *
Dries's avatar
   
Dries committed
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 * This is a flexible and powerful HTTP client implementation. Correctly handles
 * GET, POST, PUT or any other HTTP requests. Handles redirects.
 *
 * @param $url
 *   A string containing a fully qualified URI.
 * @param $headers
 *   An array containing an HTTP header => value pair.
 * @param $method
 *   A string defining the HTTP request to use.
 * @param $data
 *   A string containing data to include in the request.
 * @param $retry
 *   An integer representing how many times to retry the request in case of a
 *   redirect.
 * @return
 *   An object containing the HTTP request headers, response code, headers,
 *   data, and redirect status.
Dries's avatar
   
Dries committed
312
313
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
   
Dries committed
314
315
  $result = new StdClass();

Dries's avatar
   
Dries committed
316
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
   
Dries committed
317
318
319
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
Dries's avatar
Dries committed
320
      $port = isset($uri['port']) ? $uri['port'] : 80;
321
      $fp = @fsockopen($uri['host'], $port, $errno, $errstr, 15);
Dries's avatar
   
Dries committed
322
323
      break;
    case 'https':
Dries's avatar
   
Dries committed
324
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
Dries's avatar
Dries committed
325
      $port = isset($uri['port']) ? $uri['port'] : 443;
326
      $fp = @fsockopen('ssl://'. $uri['host'], $port, $errno, $errstr, 20);
Dries's avatar
   
Dries committed
327
328
      break;
    default:
Dries's avatar
   
Dries committed
329
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
   
Dries committed
330
331
332
      return $result;
  }

Dries's avatar
   
Dries committed
333
  // Make sure the socket opened properly.
Dries's avatar
   
Dries committed
334
  if (!$fp) {
Dries's avatar
   
Dries committed
335
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
   
Dries committed
336
337
338
    return $result;
  }

Dries's avatar
   
Dries committed
339
  // Construct the path to act on.
Dries's avatar
Dries committed
340
341
  $path = isset($uri['path']) ? $uri['path'] : '/';
  if (isset($uri['query'])) {
Dries's avatar
   
Dries committed
342
    $path .= '?'. $uri['query'];
Dries's avatar
   
Dries committed
343
344
  }

Dries's avatar
   
Dries committed
345
  // Create HTTP request.
Dries's avatar
   
Dries committed
346
  $defaults = array(
347
348
    // RFC 2616: "non-standard ports MUST, default ports MAY be included". We always add it.
    'Host' => "Host: $uri[host]:$port",
349
350
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
   
Dries committed
351
352
353
  );

  foreach ($headers as $header => $value) {
Dries's avatar
   
Dries committed
354
    $defaults[$header] = $header .': '. $value;
Dries's avatar
   
Dries committed
355
356
  }

Dries's avatar
   
Dries committed
357
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
   
Dries committed
358
359
360
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
   
Dries committed
361
    $request .= $data ."\r\n";
Dries's avatar
   
Dries committed
362
363
364
365
366
367
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
368
  $response = '';
369
  while (!feof($fp) && $data = fread($fp, 1024)) {
370
    $response .= $data;
Dries's avatar
   
Dries committed
371
372
373
374
  }
  fclose($fp);

  // Parse response.
375
376
377
378
  list($headers, $result->data) = explode("\r\n\r\n", $response, 2);
  $headers = preg_split("/\r\n|\n|\r/", $headers);

  list($protocol, $code, $text) = explode(' ', trim(array_shift($headers)), 3);
Dries's avatar
   
Dries committed
379
380
381
  $result->headers = array();

  // Parse headers.
382
  while ($line = trim(array_shift($headers))) {
Dries's avatar
   
Dries committed
383
    list($header, $value) = explode(':', $line, 2);
384
385
386
387
388
389
390
391
    if (isset($result->headers[$header]) && $header == 'Set-Cookie') {
      // RFC 2109: the Set-Cookie response header comprises the token Set-
      // Cookie:, followed by a comma-separated list of one or more cookies.
      $result->headers[$header] .= ','. trim($value);
    }
    else {
      $result->headers[$header] = trim($value);
    }
Dries's avatar
   
Dries committed
392
393
394
395
396
397
398
399
400
401
  }

  $responses = array(
    100 => 'Continue', 101 => 'Switching Protocols',
    200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content',
    300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect',
    400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Time-out', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Large', 415 => 'Unsupported Media Type', 416 => 'Requested range not satisfiable', 417 => 'Expectation Failed',
    500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Time-out', 505 => 'HTTP Version not supported'
  );
  // RFC 2616 states that all unknown HTTP codes must be treated the same as
Dries's avatar
   
Dries committed
402
  // the base code in their class.
Dries's avatar
   
Dries committed
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
  if (!isset($responses[$code])) {
    $code = floor($code / 100) * 100;
  }

  switch ($code) {
    case 200: // OK
    case 304: // Not modified
      break;
    case 301: // Moved permanently
    case 302: // Moved temporarily
    case 307: // Moved temporarily
      $location = $result->headers['Location'];

      if ($retry) {
        $result = drupal_http_request($result->headers['Location'], $headers, $method, $data, --$retry);
        $result->redirect_code = $result->code;
      }
      $result->redirect_url = $location;

      break;
    default:
      $result->error = $text;
  }

  $result->code = $code;
  return $result;
}
Dries's avatar
   
Dries committed
430
431
432
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
   
Dries committed
433

Dries's avatar
   
Dries committed
434
/**
Dries's avatar
   
Dries committed
435
436
 * Log errors as defined by administrator
 * Error levels:
437
438
 *  0 = Log errors to database.
 *  1 = Log errors to database and to screen.
Dries's avatar
   
Dries committed
439
 */
Dries's avatar
   
Dries committed
440
function error_handler($errno, $message, $filename, $line) {
441
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries's avatar
   
Dries committed
442
443
    $types = array(1 => 'error', 2 => 'warning', 4 => 'parse error', 8 => 'notice', 16 => 'core error', 32 => 'core warning', 64 => 'compile error', 128 => 'compile warning', 256 => 'user error', 512 => 'user warning', 1024 => 'user notice', 2048 => 'strict warning');
    $entry = $types[$errno] .': '. $message .' in '. $filename .' on line '. $line .'.';
Dries's avatar
   
Dries committed
444

Dries's avatar
   
Dries committed
445
    if (variable_get('error_level', 1) == 1) {
446
      drupal_set_message($entry, 'error');
Dries's avatar
Dries committed
447
    }
448
449

    watchdog('php', t('%message in %file on line %line.', array('%error' => $types[$errno], '%message' => $message, '%file' => $filename, '%line' => $line)), WATCHDOG_ERROR);
Dries's avatar
   
Dries committed
450
451
452
  }
}

Dries's avatar
   
Dries committed
453
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
454
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
455
456
457
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
458
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
459
460
461
  }
}

Dries's avatar
   
Dries committed
462
463
464
465
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
   
Dries committed
466
467
function fix_gpc_magic() {
  static $fixed = false;
Dries's avatar
   
Dries committed
468
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
469
470
471
472
473
474
    array_walk($_GET, '_fix_gpc_magic');
    array_walk($_POST, '_fix_gpc_magic');
    array_walk($_COOKIE, '_fix_gpc_magic');
    array_walk($_REQUEST, '_fix_gpc_magic');
    $fixed = true;
  }
Dries's avatar
   
Dries committed
475
476
}

Kjartan's avatar
Kjartan committed
477
478
479
/**
 * @name Messages
 * @{
Dries's avatar
   
Dries committed
480
 * Frequently used messages.
Kjartan's avatar
Kjartan committed
481
 */
Dries's avatar
   
Dries committed
482
483
484
485

/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
   
Dries committed
486
function message_na() {
Dries's avatar
   
Dries committed
487
  return t('n/a');
Dries's avatar
   
Dries committed
488
489
}

Dries's avatar
   
Dries committed
490
491
492
/**
 * @} End of "Messages".
 */
Dries's avatar
   
Dries committed
493

Dries's avatar
   
Dries committed
494
495
496
/**
 * Initialize the localization system.
 */
Dries's avatar
   
Dries committed
497
498
function locale_initialize() {
  global $user;
Dries's avatar
   
Dries committed
499
500
501
502
503

  if (function_exists('i18n_get_lang')) {
    return i18n_get_lang();
  }

Dries's avatar
   
Dries committed
504
505
506
507
508
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
509
510
511
    // Ensure the locale/language is correctly returned, even without locale.module.
    // Useful for e.g. XML/HTML 'lang' attributes.
    $languages = array('en' => 'English');
Dries's avatar
   
Dries committed
512
  }
513
  if ($user->uid && isset($languages[$user->language])) {
Dries's avatar
   
Dries committed
514
515
516
517
518
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
   
Dries committed
519
520
}

Kjartan's avatar
Kjartan committed
521
/**
Dries's avatar
   
Dries committed
522
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
523
 *
524
 * When using t(), try to put entire sentences and strings in one t() call.
Dries's avatar
   
Dries committed
525
526
527
528
 * This makes it easier for translators. HTML markup within translation strings
 * is acceptable, if necessary. The suggested syntax for a link embedded
 * within a translation string is:
 * @code
Dries's avatar
   
Dries committed
529
530
531
 *   $msg = t('You must log in below or <a href="%url">create a new
 *             account</a> before viewing the next page.', array('%url'
 *             => url('user/register')));
Dries's avatar
   
Dries committed
532
 * @endcode
533
534
535
 * We suggest the same syntax for links to other sites. This makes it easy to
 * change link URLs if needed (which happens often) without requiring updates
 * to translations.
Kjartan's avatar
Kjartan committed
536
 *
Dries's avatar
   
Dries committed
537
 * @param $string
Dries's avatar
   
Dries committed
538
 *   A string containing the English string to translate.
Dries's avatar
   
Dries committed
539
540
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
   
Dries committed
541
 *   of any key in this array are replaced with the corresponding value.
Dries's avatar
   
Dries committed
542
543
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
544
 */
Dries's avatar
   
Dries committed
545
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
546
547
548
549
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
550

Dries's avatar
   
Dries committed
551
552
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
553
554
  }
  else {
Dries's avatar
   
Dries committed
555
556
    return strtr($string, $args);
  }
Dries's avatar
   
Dries committed
557
558
}

Kjartan's avatar
Kjartan committed
559
/**
Dries's avatar
   
Dries committed
560
 * @defgroup validation Input validation
Dries's avatar
   
Dries committed
561
 * @{
Dries's avatar
   
Dries committed
562
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
563
564
 */

565
/**
Dries's avatar
   
Dries committed
566
567
568
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
569
 *
Dries's avatar
   
Dries committed
570
 * @param $mail
571
 *   A string containing an e-mail address.
Dries's avatar
   
Dries committed
572
 * @return
Dries's avatar
   
Dries committed
573
 *   TRUE if the address is in a valid format.
574
 */
Dries's avatar
   
Dries committed
575
function valid_email_address($mail) {
576
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
577
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
578
579
580
  $ipv4 = '[0-9]{1,3}(\.[0-9]{1,3}){3}';
  $ipv6 = '[0-9a-fA-F]{1,4}(\:[0-9a-fA-F]{1,4}){7}';

Dries's avatar
Dries committed
581
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
582
583
}

Dries's avatar
   
Dries committed
584
585
586
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
   
Dries committed
587
 * @param $url
Dries's avatar
   
Dries committed
588
 *   The URL to verify.
Dries's avatar
   
Dries committed
589
 * @param $absolute
Dries's avatar
   
Dries committed
590
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries's avatar
   
Dries committed
591
 * @return
Dries's avatar
   
Dries committed
592
 *   TRUE if the URL is in a valid format.
Dries's avatar
   
Dries committed
593
 */
Dries's avatar
   
Dries committed
594
function valid_url($url, $absolute = FALSE) {
595
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,~=#&%\+]';
596
  if ($absolute) {
597
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
598
599
  }
  else {
600
    return preg_match("/^". $allowed_characters ."+$/i", $url);
601
  }
Dries's avatar
   
Dries committed
602
603
}

Dries's avatar
   
Dries committed
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
/**
 * Register an event for the current visitor (hostname/IP) to the flood control mechanism.
 *
 * @param $name
 *   The name of the event.
 */
function flood_register_event($name) {
  db_query("INSERT INTO {flood} (event, hostname, timestamp) VALUES ('%s', '%s', %d)", $name, $_SERVER['REMOTE_ADDR'], time());
}

/**
 * Check if the current visitor (hostname/IP) is allowed to proceed with the specified event.
 * The user is allowed to proceed if he did not trigger the specified event more than
 * $threshold times per hour.
 *
 * @param $name
 *   The name of the event.
 * @param $number
 *   The maximum number of the specified event per hour (per visitor).
 * @return
 *   True if the user did not exceed the hourly threshold.  False otherwise.
 */
function flood_is_allowed($name, $threshold) {
  $number = db_num_rows(db_query("SELECT event FROM {flood} WHERE event = '%s' AND hostname = '%s' AND timestamp > %d", $name, $_SERVER['REMOTE_ADDR'], time() - 3600));
  return ($number < $threshold ? TRUE : FALSE);
}

631
632
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
   
Dries committed
633
634
}

Dries's avatar
Dries committed
635
636
637
638
639
/**
 * Prepare a URL for use in an HTML attribute. Strips harmful protocols.
 *
 */
function check_url($uri) {
640
  return filter_xss_bad_protocol($uri, FALSE);
Dries's avatar
Dries committed
641
642
}

Dries's avatar
   
Dries committed
643
/**
Dries's avatar
   
Dries committed
644
 * @defgroup format Formatting
Dries's avatar
   
Dries committed
645
 * @{
Dries's avatar
   
Dries committed
646
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
   
Dries committed
647
648
 */

Dries's avatar
   
Dries committed
649
650
651
652
653
654
/**
 * Formats an RSS channel.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
function format_rss_channel($title, $link, $description, $items, $language = 'en', $args = array()) {
Dries's avatar
   
Dries committed
655
656
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
657
  $output = "<channel>\n";
658
659
660
661
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
  $output .= ' <language>'. check_plain($language) ."</language>\n";
Dries's avatar
   
Dries committed
662
  foreach ($args as $key => $value) {
663
    $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
   
Dries committed
664
  }
Dries's avatar
   
Dries committed
665
666
667
668
669
670
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
   
Dries committed
671
672
673
674
675
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
   
Dries committed
676
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
677
  $output = "<item>\n";
678
679
680
  $output .= ' <title>'. check_plain($title) ."</title>\n";
  $output .= ' <link>'. check_url($link) ."</link>\n";
  $output .= ' <description>'. check_plain($description) ."</description>\n";
Dries's avatar
   
Dries committed
681
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
682
683
684
    if (is_array($value)) {
      if ($value['key']) {
        $output .= ' <'. $value['key'];
685
        if (isset($value['attributes']) && is_array($value['attributes'])) {
Dries's avatar
   
Dries committed
686
687
688
689
690
691
692
693
694
695
696
697
          $output .= drupal_attributes($value['attributes']);
        }

        if ($value['value']) {
          $output .= '>'. $value['value'] .'</'. $value['key'] .">\n";
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
698
      $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
   
Dries committed
699
    }
Dries's avatar
   
Dries committed
700
  }
Dries's avatar
   
Dries committed
701
702
703
704
705
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
   
Dries committed
706
/**
Dries's avatar
   
Dries committed
707
 * Format a string containing a count of items.
Dries's avatar
   
Dries committed
708
 *
Dries's avatar
   
Dries committed
709
710
711
712
713
714
715
716
717
718
719
720
721
722
 * This function ensures that the string is pluralized correctly. Since t() is
 * called by this function, make sure not to pass already-localized strings to it.
 *
 * @param $count
 *   The item count to display.
 * @param $singular
 *   The string for the singular case. Please make sure it is clear this is
 *   singular, to ease translation (e.g. use "1 new comment" instead of "1 new").
 * @param $plural
 *   The string for the plural case. Please make sure it is clear this is plural,
 *   to ease translation. Use %count in place of the item count, as in "%count
 *   new comments".
 * @return
 *   A translated string.
Dries's avatar
   
Dries committed
723
 */
Dries's avatar
   
Dries committed
724
function format_plural($count, $singular, $plural) {
725
  if ($count == 1) return t($singular, array("%count" => $count));
Dries's avatar
   
Dries committed
726
727

  // get the plural index through the gettext formula
728
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
Dries's avatar
   
Dries committed
729
730
731
732
733
734
  if ($index < 0) { // backward compatibility
    return t($plural, array("%count" => $count));
  }
  else {
    switch ($index) {
      case "0":
735
        return t($singular, array("%count" => $count));
Dries's avatar
   
Dries committed
736
737
738
739
740
741
      case "1":
        return t($plural, array("%count" => $count));
      default:
        return t(strtr($plural, array("%count" => '%count['. $index .']')), array('%count['. $index .']' => $count));
    }
  }
Dries's avatar
   
Dries committed
742
743
}

Dries's avatar
   
Dries committed
744
/**
Dries's avatar
   
Dries committed
745
 * Generate a string representation for the given byte count.
Dries's avatar
   
Dries committed
746
 *
Dries's avatar
   
Dries committed
747
748
749
750
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
   
Dries committed
751
 */
Dries's avatar
   
Dries committed
752
function format_size($size) {
Dries's avatar
   
Dries committed
753
  $suffix = t('bytes');
754
  if ($size >= 1024) {
Dries's avatar
   
Dries committed
755
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
756
    $suffix = t('KB');
Dries's avatar
   
Dries committed
757
  }
758
  if ($size >= 1024) {
Dries's avatar
   
Dries committed
759
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
760
    $suffix = t('MB');
Dries's avatar
   
Dries committed
761
  }
Dries's avatar
   
Dries committed
762
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries's avatar
   
Dries committed
763
764
}

Dries's avatar
   
Dries committed
765
/**
Dries's avatar
   
Dries committed
766
 * Format a time interval with the requested granularity.
Dries's avatar
   
Dries committed
767
 *
Dries's avatar
   
Dries committed
768
769
770
771
772
773
 * @param $timestamp
 *   The length of the interval in seconds.
 * @param $granularity
 *   How many different units to display in the string.
 * @return
 *   A translated string representation of the interval.
Dries's avatar
   
Dries committed
774
 */
Dries's avatar
   
Dries committed
775
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
   
Dries committed
776
  $units = array('1 year|%count years' => 31536000, '1 week|%count weeks' => 604800, '1 day|%count days' => 86400, '1 hour|%count hours' => 3600, '1 min|%count min' => 60, '1 sec|%count sec' => 1);
Dries's avatar
   
Dries committed
777
  $output = '';
Dries's avatar
   
Dries committed
778
  foreach ($units as $key => $value) {
Dries's avatar
   
Dries committed
779
    $key = explode('|', $key);
Dries's avatar
   
Dries committed
780
    if ($timestamp >= $value) {
Dries's avatar
   
Dries committed
781
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
   
Dries committed
782
      $timestamp %= $value;
Dries's avatar
   
Dries committed
783
784
785
786
787
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
   
Dries committed
788
789
    }
  }
Dries's avatar
   
Dries committed
790
  return $output ? $output : t('0 sec');
Dries's avatar
   
Dries committed
791
792
}

Dries's avatar
   
Dries committed
793
/**
Dries's avatar
   
Dries committed
794
795
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
   
Dries committed
796
797
798
799
 * Drupal allows administrators to select formatting strings for 'small',
 * 'medium' and 'large' date formats. This function can handle these formats,
 * as well as any custom format.
 *
Dries's avatar
   
Dries committed
800
801
802
803
804
805
 * @param $timestamp
 *   The exact date to format, as a UNIX timestamp.
 * @param $type
 *   The format to use. Can be "small", "medium" or "large" for the preconfigured
 *   date formats. If "custom" is specified, then $format is required as well.
 * @param $format
806
807
808
 *   A PHP date format string as required by date(). A backslash should be used
 *   before a character to avoid interpreting the character as part of a date
 *   format.
Dries's avatar
   
Dries committed
809
810
811
812
 * @param $timezone
 *   Time zone offset in seconds; if omitted, the user's time zone is used.
 * @return
 *   A translated date string in the requested format.
Dries's avatar
   
Dries committed
813
 */
814
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
815
  if (!isset($timezone)) {
816
    global $user;
Steven Wittens's avatar
Steven Wittens committed
817
818
819
820
821
822
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
823
  }
Dries's avatar
   
Dries committed
824

825
  $timestamp += $timezone;
Dries's avatar
   
Dries committed
826
827

  switch ($type) {
828
829
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
   
Dries committed
830
      break;
831
832
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
   
Dries committed
833
      break;
834
    case 'custom':
Dries's avatar
   
Dries committed
835
      // No change to format
Dries's avatar
   
Dries committed
836
      break;
837
    case 'medium':
Dries's avatar
   
Dries committed
838
    default:
839
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
   
Dries committed
840
841
  }

842
  $max = strlen($format);
Dries's avatar
   
Dries committed
843
  $date = '';
Dries's avatar
   
Dries committed
844
  for ($i = 0; $i < $max; $i++) {
845
    $c = $format[$i];
846
    if (strpos('AaDFlM', $c) !== false) {
847
      $date .= t(gmdate($c, $timestamp));
848
    }
849
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
850
851
852
853
      $date .= gmdate($c, $timestamp);
    }
    else if ($c == 'r') {
      $date .= format_date($timestamp - $timezone, 'custom', 'D, d M Y H:i:s O', $timezone);
Dries's avatar
   
Dries committed
854
    }
855
856
857
858
859
    else if ($c == 'O') {
      $date .= sprintf('%s%02d%02d', ($timezone < 0 ? '-' : '+'), abs($timezone / 3600), abs($timezone % 3600) / 60);
    }
    else if ($c == 'Z') {
      $date .= $timezone;
Dries's avatar
   
Dries committed
860
    }
861
862
863
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries's avatar
   
Dries committed
864
    else {
865
      $date .= $c;
Dries's avatar
   
Dries committed
866
    }
Dries's avatar
   
Dries committed
867
  }
868

Dries's avatar
   
Dries committed
869
870
871
  return $date;
}

Dries's avatar
   
Dries committed
872
873
874
/**
 * @} End of "defgroup format".
 */
Dries's avatar
   
Dries committed
875

Dries's avatar
   
Dries committed
876
/**
877
 * Generate a URL from a Drupal menu path. Will also pass-through existing URLs.
Dries's avatar
   
Dries committed
878
879
 *
 * @param $path
880
881
 *   The Drupal path being linked to, such as "admin/node", or an existing URL
 *   like "http://drupal.org/".
Dries's avatar
   
Dries committed
882
 * @param $query
883
 *   A query string to append to the link or URL.
Dries's avatar
   
Dries committed
884
 * @param $fragment
885
886
887
 *   A fragment identifier (named anchor) to append to the link. If an existing
 *   URL with a fragment identifier is used, it will be replaced. Note, do not
 *   include the '#'.
Dries's avatar
   
Dries committed
888
889
 * @param $absolute
 *   Whether to force the output to be an absolute link (beginning with http:).
890
891
 *   Useful for links that will be displayed outside the site, such as in an
 *   RSS feed.
Dries's avatar
   
Dries committed
892
893
894
895
896
897
898
 * @return
 *   an HTML string containing a link to the given path.
 *
 * When creating links in modules, consider whether l() could be a better
 * alternative than url().
 */
function url($path = NULL, $query = NULL, $fragment = NULL, $absolute = FALSE) {
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
  if (isset($fragment)) {
    $fragment = '#'. $fragment;
  }

  // Return an external link if $path contains an allowed absolute URL.
  // Only call the slow filter_xss_bad_protocol if $path contains a ':'.
  if (strpos($path, ':') !== FALSE && filter_xss_bad_protocol($path) == $path) {
    // Split off the fragment
    if (strpos($path, '#')) {
      list($path, $old_fragment) = explode('#', $path, 2);
      if (isset($old_fragment) && !isset($fragment)) {
        $fragment = '#'. $old_fragment;
      }
    }
    // Append the query
    if (isset($query)) {
      $path .= (strpos($path, '?') ? '&' : '?') . $query;
    }
    // Reassemble
    return $path . $fragment;
  }
Dries's avatar
   
Dries committed
920

921
  global $base_url, $base_path;
Dries's avatar
   
Dries committed
922
  static $script;
923
  static $clean_url;
Dries's avatar
   
Dries committed
924
925

  if (empty($script)) {
Dries's avatar
   
Dries committed
926
927
928
    // On some web servers, such as IIS, we can't omit "index.php".  So, we
    // generate "index.php?q=foo" instead of "?q=foo" on anything that is not
    // Apache.
Dries's avatar
   
Dries committed
929
    $script = (strpos($_SERVER['SERVER_SOFTWARE'], 'Apache') === false) ? 'index.php' : '';
Dries's avatar
   
Dries committed
930
  }
931

932
  // Cache the clean_url variable to improve performance.
933
934
  if (!isset($clean_url)) {
    $clean_url = (bool)variable_get('clean_url', '0');
935
  }
Dries's avatar
   
Dries committed
936

937
  $base = ($absolute ? $base_url . '/' : $base_path);
Dries's avatar
Dries committed
938

939
940
941
942
943
  // The special path '<front>' links to the default front page.
  if (isset($path) && $path != '<front>') {
    $path = drupal_get_path_alias($path);
    $path = drupal_urlencode($path);
    if (!$clean_url) {
Dries's avatar
   
Dries committed
944
      if (isset($query)) {
945
        return $base . $script .'?q='. $path .'&'. $query . $fragment;
Dries's avatar
   
Dries committed
946
947
      }
      else {
Dries's avatar
   
Dries committed
948
        return $base . $script .'?q='. $path . $fragment;
Dries's avatar
   
Dries committed
949
      }
Dries's avatar
   
Dries committed
950
951
    }
    else {
Dries's avatar
   
Dries committed
952
      if (isset($query)) {
953
        return $base . $path .'?'. $query . $fragment;
Dries's avatar
   
Dries committed
954
955
      }
      else {
956
        return $base . $path . $fragment;
Dries's avatar
   
Dries committed
957
      }
Dries's avatar
   
Dries committed
958
959
960
    }
  }
  else {
961
962
    if (isset($query)) {
      return $base . $script .'?'. $query . $fragment;
Dries's avatar
   
Dries committed
963
    }
Dries's avatar
   
Dries committed
964
    else {
965
      return $base . $fragment;
Dries's avatar
   
Dries committed
966
    }
Dries's avatar
   
Dries committed
967
  }
Dries's avatar
   
Dries committed
968
969
}

Dries's avatar
   
Dries committed
970
971
972
973
974
975
976
977
/**
 * Format an attribute string to insert in a tag.
 *
 * @param $attributes
 *   An associative array of HTML attributes.
 * @return
 *   An HTML string ready for insertion in a tag.
 */
978
function drupal_attributes($attributes = array()) {
979
  if (is_array($attributes)) {
980
981
    $t = array();
    foreach ($attributes as $key => $value) {
982
      $t[] = $key .'="'. check_plain($value) .'"';
983
    }
984
    return ' '. implode(' ', $t);
Dries's avatar
   
Dries committed
985
  }
986
}
Dries's avatar
   
Dries committed
987

Dries's avatar
   
Dries committed
988
989
990
991
992
993
994
995
996
997
/**
 * Format an internal Drupal link.
 *
 * This function correctly handles aliased paths, and allows themes to highlight
 * links to the current page correctly, so all internal links output by modules
 * should be generated by this function if possible.
 *
 * @param $text
 *   The text to be enclosed with the anchor tag.
 * @param $path
998
999
 *   The Drupal path being linked to, such as "admin/node". Note, this must be a
 *   system URL as the url() function will generate the alias.
Dries's avatar
   
Dries committed
1000
1001
1002
1003
1004
1005
1006
1007
1008
 * @param $attributes
 *   An associative array of HTML attributes to apply to the anchor tag.
 * @param $query
 *   A query string to append to the link.
 * @param $fragment
 *   A fragment identifier (named anchor) to append to the link.
 * @param $absolute
 *   Whether to force the output to be an absolute link (beginning with http:).
 *   Useful for links that will be displayed outside the site, such as in an RSS feed.
1009
1010
 * @param $html
 *   Whether the title is HTML, or just plain-text.
Dries's avatar
   
Dries committed
1011
1012
1013
 * @return
 *   an HTML string containing a link to the given path.
 */
1014
function l($text, $path, $attributes = array(), $query = NULL, $fragment = NULL, $absolute = FALSE, $html = FALSE) {
1015
  if ($path == $_GET['q']) {
Dries's avatar
   
Dries committed
1016
1017
1018
1019
1020
1021
1022
    if (isset($attributes['class'])) {
      $attributes['class'] .= ' active';
    }
    else {
      $attributes['class'] = 'active';
    }
  }
1023
  return '<a href="'. check_url(url($path, $query, $fragment, $absolute)) .'"'. drupal_attributes($attributes) .'>'. ($html ? $text : check_plain($text)) .'</a>';
Dries's avatar
   
Dries committed
1024
1025
}

Dries's avatar
   
Dries committed
1026
1027
1028
1029
1030
1031
/**
 * Perform end-of-request tasks.
 *
 * This function sets the page cache if appropriate, and allows modules to
 * react to the closing of the page by calling hook_exit().
 */
Dries's avatar
   
Dries committed
1032
function drupal_page_footer() {
Dries's avatar
   
Dries committed
1033
  if (variable_get('cache', 0)) {
Dries's avatar
   
Dries committed
1034
    page_set_cache();
Dries's avatar
   
Dries committed
1035
  }
Dries's avatar
   
Dries committed
1036

Dries's avatar
   
Dries committed
1037
  module_invoke_all('exit');
Dries's avatar
   
Dries committed
1038
1039
}

Dries's avatar
   
Dries committed
1040
/**
Dries's avatar
   
Dries committed
1041
 * Form an associative array from a linear array.
Dries's avatar
   
Dries committed
1042
 *
Dries's avatar
   
Dries committed
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
 * This function walks through the provided array and constructs an associative
 * array out of it. The keys of the resulting array will be the values of the