common.inc 57.8 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
Dries's avatar
Dries committed
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.
 */

Kjartan's avatar
Kjartan committed
12
/**
Dries's avatar
 
Dries committed
13
 * Set the title of the current page, for display on the page and in the title bar.
Dries's avatar
 
Dries committed
14
 */
Dries's avatar
 
Dries committed
15 16 17 18
function drupal_set_title($title = NULL) {
  static $stored_title;

  if (isset($title)) {
Dries's avatar
 
Dries committed
19
    $stored_title = $title;
Dries's avatar
 
Dries committed
20 21 22 23
  }
  return $stored_title;
}

Dries's avatar
 
Dries committed
24 25 26
/**
 * Get the title of the current page, for display on the page and in the title bar.
 */
Dries's avatar
 
Dries committed
27 28 29 30 31 32 33 34 35 36 37
function drupal_get_title() {
  $title = drupal_set_title();

  if (!isset($title)) {
    $title = menu_get_active_title();
  }

  return $title;
}

/**
Dries's avatar
 
Dries committed
38
 * Set the breadcrumb trail for the current page.
Dries's avatar
 
Dries committed
39
 *
Dries's avatar
 
Dries committed
40 41 42
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
43
 */
Dries's avatar
 
Dries committed
44 45 46 47 48 49 50 51 52
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

  if (isset($breadcrumb)) {
    $stored_breadcrumb = $breadcrumb;
  }
  return $stored_breadcrumb;
}

Dries's avatar
 
Dries committed
53 54 55
/**
 * Get the breadcrumb trail for the current page.
 */
Dries's avatar
 
Dries committed
56 57 58 59 60 61 62 63 64 65
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

  if (!isset($breadcrumb)) {
    $breadcrumb = menu_get_active_breadcrumb();
  }

  return $breadcrumb;
}

Dries's avatar
Dries committed
66
/**
Dries's avatar
 
Dries committed
67
 * Add output to the head tag of the HTML page.
Dries's avatar
 
Dries committed
68
 * This function can be called as long the headers aren't sent.
Dries's avatar
Dries committed
69 70
 */
function drupal_set_html_head($data = NULL) {
Dries's avatar
 
Dries committed
71
  static $stored_head = '';
Dries's avatar
Dries committed
72 73

  if (!is_null($data)) {
Dries's avatar
 
Dries committed
74
    $stored_head .= $data ."\n";
Dries's avatar
Dries committed
75 76 77 78
  }
  return $stored_head;
}

Dries's avatar
 
Dries committed
79 80 81
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries's avatar
Dries committed
82 83 84
function drupal_get_html_head() {
  global $base_url;

Dries's avatar
 
Dries committed
85
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
86
  $output .= "<base href=\"$base_url/\" />\n";
Dries's avatar
 
Dries committed
87
  $output .= theme('stylesheet_import', 'misc/drupal.css');
Dries's avatar
Dries committed
88 89 90 91

  return $output . drupal_set_html_head();
}

Dries's avatar
 
Dries committed
92
/**
Dries's avatar
 
Dries committed
93
 * Return an array mapping path aliases to their internal Drupal paths.
Dries's avatar
 
Dries committed
94
 */
Dries's avatar
 
Dries committed
95
function drupal_get_path_map($action = '') {
Dries's avatar
Dries committed
96
  static $map = NULL;
Dries's avatar
 
Dries committed
97

Dries's avatar
 
Dries committed
98
  if ($action == 'rebuild') {
Dries's avatar
 
Dries committed
99 100 101
    $map = NULL;
  }

Dries's avatar
Dries committed
102
  if (is_null($map)) {
Dries's avatar
 
Dries committed
103
    $map = array();  // Make $map non-null in case no aliases are defined.
Dries's avatar
 
Dries committed
104
    $result = db_query('SELECT * FROM {url_alias}');
Dries's avatar
 
Dries committed
105
    while ($data = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
106
      $map[$data->dst] = $data->src;
Dries's avatar
 
Dries committed
107 108 109 110 111 112
    }
  }

  return $map;
}

Dries's avatar
 
Dries committed
113 114 115
/**
 * Regenerate the path map from the information in the database.
 */
Dries's avatar
 
Dries committed
116
function drupal_rebuild_path_map() {
Dries's avatar
 
Dries committed
117
  drupal_get_path_map('rebuild');
Dries's avatar
 
Dries committed
118
}
Kjartan's avatar
Kjartan committed
119 120

/**
Dries's avatar
 
Dries committed
121
 * Given an internal Drupal path, return the alias set by the administrator.
Kjartan's avatar
Kjartan committed
122
 */
Dries's avatar
 
Dries committed
123 124 125 126
function drupal_get_path_alias($path) {
  if (($map = drupal_get_path_map()) && ($newpath = array_search($path, $map))) {
    return $newpath;
  }
Dries's avatar
 
Dries committed
127
  elseif (function_exists('conf_url_rewrite')) {
Dries's avatar
 
Dries committed
128 129
    return conf_url_rewrite($path, 'outgoing');
  }
130 131 132 133
  else {
    // No alias found. Return the normal path.
    return $path;
  }
Dries's avatar
 
Dries committed
134 135 136
}

/**
Dries's avatar
 
Dries committed
137
 * Given a path alias, return the internal path it represents.
Dries's avatar
 
Dries committed
138 139 140 141 142
 */
function drupal_get_normal_path($path) {
  if (($map = drupal_get_path_map()) && isset($map[$path])) {
    return $map[$path];
  }
Dries's avatar
 
Dries committed
143
  elseif (function_exists('conf_url_rewrite')) {
Dries's avatar
 
Dries committed
144 145 146 147 148 149
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
Kjartan's avatar
Kjartan committed
150

Dries's avatar
Dries committed
151
/**
Dries's avatar
 
Dries committed
152
 * Set an HTTP response header for the current page.
Dries's avatar
Dries committed
153 154
 */
function drupal_set_header($header = NULL) {
155
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries's avatar
 
Dries committed
156
  // Otherwise, header('') could get called when serving the page later, which
157 158
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries's avatar
Dries committed
159

160
  if (strlen($header)) {
Dries's avatar
Dries committed
161
    header($header);
162
    $stored_headers[] = $header;
Dries's avatar
Dries committed
163
  }
164
  return implode("\n", $stored_headers);
Dries's avatar
Dries committed
165 166
}

Dries's avatar
 
Dries committed
167 168 169
/**
 * Get the HTTP response headers for the current page.
 */
Dries's avatar
Dries committed
170 171 172 173
function drupal_get_headers() {
  return drupal_set_header();
}

Dries's avatar
 
Dries committed
174 175 176
/**
 * @name HTTP handling
 * @{
Dries's avatar
 
Dries committed
177
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
178 179
 */

Kjartan's avatar
Kjartan committed
180
/**
Dries's avatar
 
Dries committed
181
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
182
 *
Dries's avatar
 
Dries committed
183 184
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
185
 *
Dries's avatar
 
Dries committed
186 187 188 189 190 191 192 193 194 195 196 197 198
 * 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).
Kjartan's avatar
Kjartan committed
199
 */
Dries's avatar
 
Dries committed
200 201 202
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
  // Translate &amp; to simply & in the absolute URL.
  $url = str_replace('&amp;', '&', url($path, $query, $fragment, TRUE));
Kjartan's avatar
Kjartan committed
203

Dries's avatar
 
Dries committed
204 205
  if (ini_get('session.use_trans_sid') && session_id() && !strstr($url, session_id())) {
    $sid = session_name() . '=' . session_id();
Dries's avatar
 
Dries committed
206

Dries's avatar
 
Dries committed
207 208
    if (strstr($url, '?') && !strstr($url, $sid)) {
      $url = $url .'&'. $sid;
Kjartan's avatar
Kjartan committed
209 210
    }
    else {
Dries's avatar
 
Dries committed
211
      $url = $url .'?'. $sid;
Kjartan's avatar
Kjartan committed
212 213 214
    }
  }

Dries's avatar
 
Dries committed
215 216 217 218
  // 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
219

Dries's avatar
 
Dries committed
220 221 222
  // 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
223 224 225 226 227 228
  exit();
}

/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
 
Dries committed
229
function drupal_not_found() {
Dries's avatar
 
Dries committed
230
  header('HTTP/1.0 404 Not Found');
Dries's avatar
 
Dries committed
231
  watchdog('httpd', t('404 error: %page not found.', array('%page' => '<em>'. check_query($_GET['q']) .'</em>')));
Dries's avatar
 
Dries committed
232 233

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries's avatar
 
Dries committed
234
  $status = MENU_NOT_FOUND;
Dries's avatar
 
Dries committed
235 236
  if ($path) {
    menu_set_active_item($path);
Dries's avatar
 
Dries committed
237
    $status = menu_execute_active_handler();
Dries's avatar
 
Dries committed
238 239
  }

Dries's avatar
 
Dries committed
240
  if ($status != MENU_FOUND) {
Dries's avatar
Dries committed
241
    print theme('page', '', t('Page not found'));
Dries's avatar
 
Dries committed
242 243
  }
}
Dries's avatar
 
Dries committed
244

Dries's avatar
 
Dries committed
245 246 247 248 249 250 251
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
  header('HTTP/1.0 403 Forbidden');

  $path = drupal_get_normal_path(variable_get('site_403', ''));
Dries's avatar
 
Dries committed
252
  $status = MENU_NOT_FOUND;
Dries's avatar
 
Dries committed
253 254 255 256 257 258 259 260 261 262
  if ($path) {
    menu_set_active_item($path);
    $status = menu_execute_active_handler();
  }

  if ($status != MENU_FOUND) {
    print theme('page', message_access(), t('Access denied'));
  }
}

Dries's avatar
 
Dries committed
263
/**
Dries's avatar
 
Dries committed
264
 * Perform an HTTP request.
Dries's avatar
 
Dries committed
265
 *
Dries's avatar
 
Dries committed
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
 * 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
283 284
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
 
Dries committed
285
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
 
Dries committed
286 287 288 289 290 291
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
      $fp = @fsockopen($uri['host'], ($uri['port'] ? $uri['port'] : 80), $errno, $errstr, 15);
      break;
    case 'https':
Dries's avatar
 
Dries committed
292 293
      // Note: Only works for PHP 4.3 compiled with OpenSSL.
      $fp = @fsockopen('ssl://'. $uri['host'], ($uri['port'] ? $uri['port'] : 443), $errno, $errstr, 20);
Dries's avatar
 
Dries committed
294 295
      break;
    default:
Dries's avatar
 
Dries committed
296
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
 
Dries committed
297 298 299
      return $result;
  }

Dries's avatar
 
Dries committed
300
  // Make sure the socket opened properly.
Dries's avatar
 
Dries committed
301
  if (!$fp) {
Dries's avatar
 
Dries committed
302
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
 
Dries committed
303 304 305
    return $result;
  }

Dries's avatar
 
Dries committed
306
  // Construct the path to act on.
Dries's avatar
 
Dries committed
307 308
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
Dries's avatar
 
Dries committed
309
    $path .= '?'. $uri['query'];
Dries's avatar
 
Dries committed
310 311
  }

Dries's avatar
 
Dries committed
312
  // Create HTTP request.
Dries's avatar
 
Dries committed
313
  $defaults = array(
Dries's avatar
 
Dries committed
314
    'Host' => 'Host: '. $uri['host'],
315 316
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
 
Dries committed
317 318 319
  );

  foreach ($headers as $header => $value) {
Dries's avatar
 
Dries committed
320
    $defaults[$header] = $header .': '. $value;
Dries's avatar
 
Dries committed
321 322
  }

Dries's avatar
 
Dries committed
323
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
 
Dries committed
324 325 326
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
 
Dries committed
327
    $request .= $data ."\r\n";
Dries's avatar
 
Dries committed
328 329 330 331 332 333
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
334
  $response = '';
335
  while (!feof($fp) && $data = fread($fp, 1024)) {
336
    $response .= $data;
Dries's avatar
 
Dries committed
337 338 339 340
  }
  fclose($fp);

  // Parse response.
341 342 343 344
  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
345 346 347
  $result->headers = array();

  // Parse headers.
348
  while ($line = trim(array_shift($headers))) {
Dries's avatar
 
Dries committed
349 350 351 352 353 354 355 356 357 358 359 360
    list($header, $value) = explode(':', $line, 2);
    $result->headers[$header] = trim($value);
  }

  $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
361
  // the base code in their class.
Dries's avatar
 
Dries committed
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
  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
389 390 391
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
 
Dries committed
392

Dries's avatar
 
Dries committed
393
/**
Dries's avatar
 
Dries committed
394 395 396 397
 * Log errors as defined by administrator
 * Error levels:
 *  1 = Log errors to database.
 *  2 = Log errors to database and to screen.
Dries's avatar
 
Dries committed
398
 */
Dries's avatar
 
Dries committed
399
function error_handler($errno, $message, $filename, $line, $variables) {
Dries's avatar
 
Dries committed
400 401 402
  if ($errno & E_ALL ^ E_NOTICE) {
    $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
403

404
    watchdog('error', t('%error: %message in %file on line %line.', array('%error' => $types[$errno], '%message' => $message, '%file' => $filename, '%line' => $line)));
Dries's avatar
 
Dries committed
405 406

    if (variable_get('error_level', 1) == 1) {
Dries's avatar
 
Dries committed
407
      print '<pre>'. $entry .'</pre>';
Dries's avatar
Dries committed
408
    }
Dries's avatar
 
Dries committed
409 410 411
  }
}

Dries's avatar
Dries committed
412 413
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
414 415 416
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
417
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
418 419 420
  }
}

Dries's avatar
 
Dries committed
421 422 423 424
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
 
Dries committed
425 426
function fix_gpc_magic() {
  static $fixed = false;
Dries's avatar
 
Dries committed
427
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
428 429 430 431 432 433
    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
434 435
}

Kjartan's avatar
Kjartan committed
436 437 438
/**
 * @name Conversion
 * @{
Dries's avatar
 
Dries committed
439
 * Converts data structures to different types.
Kjartan's avatar
Kjartan committed
440
 */
Dries's avatar
 
Dries committed
441 442 443 444

/**
 * Convert an associative array to an anonymous object.
 */
Dries's avatar
Dries committed
445 446
function array2object($array) {
  if (is_array($array)) {
447
    $object = new stdClass();
Dries's avatar
Dries committed
448
    foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
449 450 451 452
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
453
    $object = $array;
Dries's avatar
 
Dries committed
454 455 456 457 458
  }

  return $object;
}

Dries's avatar
 
Dries committed
459 460 461
/**
 * Convert an object to an associative array.
 */
Dries's avatar
Dries committed
462 463 464
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
 
Dries committed
465 466 467 468
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
469
    $array = $object;
Dries's avatar
 
Dries committed
470 471 472 473
  }

  return $array;
}
Dries's avatar
 
Dries committed
474 475 476 477

/**
 * @} End of "Conversion".
 */
Dries's avatar
 
Dries committed
478

Kjartan's avatar
Kjartan committed
479 480 481
/**
 * @name Messages
 * @{
Dries's avatar
 
Dries committed
482
 * Frequently used messages.
Kjartan's avatar
Kjartan committed
483
 */
Dries's avatar
 
Dries committed
484 485 486 487 488 489 490

/**
 * Return a string with an "access denied" message.
 *
 * Always consider whether to use drupal_access_denied() instead to return a
 * proper (and customizable) 403 error.
 */
Dries's avatar
 
Dries committed
491
function message_access() {
Dries's avatar
 
Dries committed
492
  return t('You are not authorized to access this page.');
Dries's avatar
 
Dries committed
493 494
}

Dries's avatar
 
Dries committed
495 496 497
/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
 
Dries committed
498
function message_na() {
Dries's avatar
 
Dries committed
499
  return t('n/a');
Dries's avatar
 
Dries committed
500 501
}

Dries's avatar
 
Dries committed
502 503 504
/**
 * @} End of "Messages".
 */
Dries's avatar
 
Dries committed
505

Dries's avatar
 
Dries committed
506 507 508
/**
 * Initialize the localization system.
 */
Dries's avatar
 
Dries committed
509 510
function locale_initialize() {
  global $user;
Dries's avatar
 
Dries committed
511 512 513 514 515

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

Dries's avatar
 
Dries committed
516 517 518 519 520
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
521 522 523
    // 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
524
  }
Dries's avatar
 
Dries committed
525 526 527 528 529 530
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
531 532
}

Kjartan's avatar
Kjartan committed
533
/**
Dries's avatar
 
Dries committed
534
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
535
 *
536
 * When using t(), try to put entire sentences and strings in one t() call.
Dries's avatar
 
Dries committed
537 538 539 540
 * 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
541 542 543
 *   $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
544
 * @endcode
545 546 547
 * 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
548
 *
Dries's avatar
 
Dries committed
549
 * @param $string
Dries's avatar
 
Dries committed
550
 *   A string containing the English string to translate.
Dries's avatar
 
Dries committed
551 552
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
 
Dries committed
553
 *   of any key in this array are replaced with the corresponding value.
Dries's avatar
 
Dries committed
554 555
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
556
 */
Dries's avatar
 
Dries committed
557
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
558 559 560 561
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
562

Dries's avatar
 
Dries committed
563 564
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
565 566
  }
  else {
Dries's avatar
 
Dries committed
567 568
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
569 570
}

Dries's avatar
 
Dries committed
571 572 573 574 575 576 577 578
/**
 * Encode special characters in a string for display as HTML.
 *
 * Note that we'd like to use htmlspecialchars($input, $quotes, 'utf-8')
 * as outlined in the PHP manual, but we can't because there's a bug in
 * PHP < 4.3 that makes it mess up multibyte charsets if we specify the
 * charset. This will be changed later once we make PHP 4.3 a requirement.
 */
Dries's avatar
 
Dries committed
579
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
 
Dries committed
580
  return htmlspecialchars($input, $quotes);
Dries's avatar
 
Dries committed
581 582
}

Kjartan's avatar
Kjartan committed
583
/**
Dries's avatar
 
Dries committed
584
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
585
 * @{
Dries's avatar
 
Dries committed
586
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
587 588
 */

589
/**
Dries's avatar
 
Dries committed
590 591 592
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
593
 *
Dries's avatar
 
Dries committed
594 595
 * @param $mail
 *   A string containing an email address.
Dries's avatar
 
Dries committed
596
 * @return
Dries's avatar
 
Dries committed
597
 *   TRUE if the address is in a valid format.
598
 */
Dries's avatar
 
Dries committed
599
function valid_email_address($mail) {
600
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
601
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
602 603 604
  $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
605
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
606 607
}

Dries's avatar
 
Dries committed
608 609 610
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
 
Dries committed
611
 * @param $url
Dries's avatar
 
Dries committed
612
 *   The URL to verify.
Dries's avatar
 
Dries committed
613
 * @param $absolute
Dries's avatar
 
Dries committed
614
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries's avatar
 
Dries committed
615
 * @return
Dries's avatar
 
Dries committed
616
 *   TRUE if the URL is in a valid format.
Dries's avatar
 
Dries committed
617
 */
Dries's avatar
 
Dries committed
618
function valid_url($url, $absolute = FALSE) {
619
  if ($absolute) {
Dries's avatar
 
Dries committed
620
    return preg_match("/^(http|https|ftp):\/\/[a-z0-9\/:_\-_\.\?,~=#&%]+$/i", $url);
621 622
  }
  else {
623
    return preg_match("/^[a-z0-9\/:_\-_\.,]+$/i", $url);
624
  }
Dries's avatar
 
Dries committed
625 626
}

Dries's avatar
 
Dries committed
627 628 629 630 631 632 633 634 635 636
/**
 * Validate data input by a user.
 *
 * Ensures that user data cannot be used to perform attacks on the site.
 *
 * @param $data
 *   The input to check.
 * @return
 *   TRUE if the input data is acceptable.
 */
Kjartan's avatar
Kjartan committed
637 638
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
Dries's avatar
 
Dries committed
639
    // Form data can contain a number of nested arrays.
Kjartan's avatar
Kjartan committed
640
    foreach ($data as $key => $value) {
Dries's avatar
 
Dries committed
641
      if (!valid_input_data($key) || !valid_input_data($value)) {
Dries's avatar
 
Dries committed
642
        return FALSE;
Kjartan's avatar
Kjartan committed
643 644 645 646
      }
    }
  }
  else {
Dries's avatar
 
Dries committed
647
    // Detect dangerous input data.
Kjartan's avatar
Kjartan committed
648

Dries's avatar
 
Dries committed
649 650 651 652
    // Check strings:
    $match  = preg_match('/\Wjavascript\s*:/i', $data);
    $match += preg_match('/\Wexpression\s*\(/i', $data);
    $match += preg_match('/\Walert\s*\(/i', $data);
Kjartan's avatar
Kjartan committed
653

Dries's avatar
 
Dries committed
654
    // Check attributes:
Kjartan's avatar
Kjartan committed
655 656
    $match += preg_match("/\W(dynsrc|datasrc|data|lowsrc|on[a-z]+)\s*=[^>]+?>/i", $data);

Dries's avatar
 
Dries committed
657
    // Check tags:
Kjartan's avatar
Kjartan committed
658 659 660
    $match += preg_match("/<\s*(applet|script|object|style|embed|form|blink|meta|html|frame|iframe|layer|ilayer|head|frameset|xml)/i", $data);

    if ($match) {
Dries's avatar
 
Dries committed
661
      watchdog('warning', t('Terminated request because of suspicious input data: %data.', array('%data' => '<em>'. drupal_specialchars($data) .'</em>')));
Dries's avatar
 
Dries committed
662
      return FALSE;
Kjartan's avatar
Kjartan committed
663 664 665
    }
  }

Dries's avatar
 
Dries committed
666
  return TRUE;
Kjartan's avatar
Kjartan committed
667
}
Dries's avatar
 
Dries committed
668 669 670
/**
 * @} End of "defgroup validation".
 */
Kjartan's avatar
Kjartan committed
671

Dries's avatar
 
Dries committed
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
/**
 * 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);
}

Dries's avatar
 
Dries committed
699
function check_form($text) {
Dries's avatar
 
Dries committed
700
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
 
Dries committed
701 702
}

703 704
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
705 706
}

Dries's avatar
 
Dries committed
707
/**
Dries's avatar
 
Dries committed
708
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
709
 * @{
Dries's avatar
 
Dries committed
710
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
711 712
 */

Dries's avatar
 
Dries committed
713 714 715 716 717 718
/**
 * 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
719 720
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
721
  $output = "<channel>\n";
Dries's avatar
 
Dries committed
722 723 724 725
  $output .= ' <title>'. drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= ' <link>'. drupal_specialchars(strip_tags($link)) ."</link>\n";
  $output .= ' <description>'. drupal_specialchars(strip_tags($description)) ."</description>\n";
  $output .= ' <language>'. drupal_specialchars(strip_tags($language)) ."</language>\n";
Dries's avatar
 
Dries committed
726
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
727
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
 
Dries committed
728
  }
Dries's avatar
 
Dries committed
729 730 731 732 733 734
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
735 736 737 738 739
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
740
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
741
  $output = "<item>\n";
Dries's avatar
 
Dries committed
742 743
  $output .= ' <title>'. drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= ' <link>'. drupal_specialchars(strip_tags($link)) ."</link>\n";
744
  $output .= ' <description>'. drupal_specialchars($description) ."</description>\n";
Dries's avatar
 
Dries committed
745
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
746
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
 
Dries committed
747
  }
Dries's avatar
 
Dries committed
748 749 750 751 752
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
753
/**
Dries's avatar
 
Dries committed
754
 * Format a string containing a count of items.
Dries's avatar
 
Dries committed
755
 *
Dries's avatar
 
Dries committed
756 757 758 759 760 761 762 763 764 765 766 767 768 769
 * 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
770
 */
Dries's avatar
 
Dries committed
771
function format_plural($count, $singular, $plural) {
772
  if ($count == 1) return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
773 774 775 776 777 778 779 780 781

  // get the plural index through the gettext formula
  $index = (function_exists('locale')) ? locale_get_plural($count) : -1;
  if ($index < 0) { // backward compatibility
    return t($plural, array("%count" => $count));
  }
  else {
    switch ($index) {
      case "0":
782
        return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
783 784 785 786 787 788
      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
789 790
}

Dries's avatar
 
Dries committed
791
/**
Dries's avatar
 
Dries committed
792
 * Generate a string representation for the given byte count.
Dries's avatar
 
Dries committed
793
 *
Dries's avatar
 
Dries committed
794 795 796 797
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
798
 */
Dries's avatar
 
Dries committed
799
function format_size($size) {
Dries's avatar
 
Dries committed
800
  $suffix = t('bytes');
Dries's avatar
 
Dries committed
801 802
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
803
    $suffix = t('KB');
Dries's avatar
 
Dries committed
804 805 806
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
807
    $suffix = t('MB');
Dries's avatar
 
Dries committed
808
  }
Dries's avatar
 
Dries committed
809
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries's avatar
 
Dries committed
810 811
}

Dries's avatar
 
Dries committed
812
/**
Dries's avatar
 
Dries committed
813
 * Format a time interval with the requested granularity.
Dries's avatar
 
Dries committed
814
 *
Dries's avatar
 
Dries committed
815 816 817 818 819 820
 * @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
821
 */
Dries's avatar
 
Dries committed
822
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
 
Dries committed
823
  $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
824
  $output = '';
Dries's avatar
 
Dries committed
825
  foreach ($units as $key => $value) {
Dries's avatar
 
Dries committed
826
    $key = explode('|', $key);
Dries's avatar
 
Dries committed
827
    if ($timestamp >= $value) {
Dries's avatar
 
Dries committed
828
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
 
Dries committed
829
      $timestamp %= $value;
Dries's avatar
 
Dries committed
830 831 832 833 834
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
835 836
    }
  }
Dries's avatar
 
Dries committed
837
  return $output ? $output : t('0 sec');
Dries's avatar
 
Dries committed
838 839
}

Dries's avatar
 
Dries committed
840
/**
Dries's avatar
 
Dries committed
841 842
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
 
Dries committed
843 844 845 846
 * 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
847 848 849 850 851 852 853 854 855 856 857
 * @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
 *   A PHP date format string as required by date().
 * @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
858
 */
859 860 861
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
862 863 864 865 866 867
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
868
  }
Dries's avatar
 
Dries committed
869

870
  $timestamp += $timezone;
Dries's avatar
 
Dries committed
871 872

  switch ($type) {
873 874
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
 
Dries committed
875
      break;
876 877
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
 
Dries committed
878
      break;
879
    case 'custom':
Dries's avatar
 
Dries committed
880
      // No change to format
Dries's avatar
 
Dries committed
881
      break;
882
    case 'medium':
Dries's avatar
 
Dries committed
883
    default:
884
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
 
Dries committed
885 886
  }

887
  $max = strlen($format);
Dries's avatar
 
Dries committed
888
  $date = '';
Dries's avatar
 
Dries committed
889 890
  for ($i = 0; $i < $max; $i++) {
    $c = $format{$i};
891
    if (strpos('AaDFlM', $c) !== false) {
892
      $date .= t(gmdate($c, $timestamp));
893
    }
894
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
895 896 897 898
      $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
899
    }
900 901 902 903 904
    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
905 906
    }
    else {
907
      $date .= $c;
Dries's avatar
 
Dries committed
908
    }
Dries's avatar
 
Dries committed
909
  }
910

Dries's avatar
 
Dries committed
911 912 913
  return $date;
}

Dries's avatar
 
Dries committed
914
/**
Dries's avatar
 
Dries committed
915
 * Format a username.
Dries's avatar
 
Dries committed
916
 *
Dries's avatar
 
Dries committed
917 918 919 920 921
 * @param $object
 *   The user object to format, usually returned from user_load().
 * @return
 *   A string containing an HTML link to the user's page if the passed object
 *   suggests that this is a site user. Otherwise, only the username is returned.
Dries's avatar
 
Dries committed
922
 */
Dries's avatar
 
Dries committed
923 924 925
function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
 
Dries committed
926
    // Shorten the name when it is too long or it will break many tables.
Dries's avatar
Dries committed
927
    if (strlen($object->name) > 20) {
Dries's avatar
 
Dries committed
928
      $name = truncate_utf8($object->name, 15) .'...';
Dries's avatar
Dries committed
929 930 931 932 933
    }
    else {
      $name = $object->name;
    }

Dries's avatar
 
Dries committed
934
    $output = l($name, 'user/'. $object->uid, array('title' => t('View user profile.')));
Dries's avatar
 
Dries committed
935
  }
Dries's avatar
 
Dries committed
936
  else if ($object->name) {
Dries's avatar
 
Dries committed
937 938 939 940
    // Sometimes modules display content composed by people who are
    // not registered members of the site (e.g. mailing list or news
    // aggregator modules). This clause enables modules to display
    // the true author of the content.
Dries's avatar
 
Dries committed
941
    if ($object->homepage) {
Dries's avatar
 
Dries committed
942
      $output = '<a href="'. $object->homepage .'">'. $object->name .'</a>';
Dries's avatar
 
Dries committed
943 944 945 946 947 948
    }
    else {
      $output = $object->name;
    }

    $output .= ' ('. t('not verified') .')';
Dries's avatar
 
Dries committed
949
  }
Dries's avatar
 
Dries committed
950
  else {
Dries's avatar
 
Dries committed
951
    $output = t(variable_get('anonymous', 'Anonymous'));
Dries's avatar
 
Dries committed
952 953
  }

Dries's avatar
 
Dries committed
954
  return $output;
Dries's avatar
 
Dries committed
955
}
Dries's avatar
 
Dries committed
956 957 958
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
959

Kjartan's avatar
Kjartan committed
960
/**
Dries's avatar
 
Dries committed
961
 * @defgroup form Form generation
Kjartan's avatar
Kjartan committed
962
 * @{
Dries's avatar
 
Dries committed
963
 * Functions to enable output of HTML forms and form elements.
964
 *
Dries's avatar
 
Dries committed
965 966
 * Drupal uses these functions to achieve consistency in its form presentation,
 * while at the same time simplifying code and reducing the amount of HTML that
967
 * must be explicitly generated by modules.
Kjartan's avatar
Kjartan committed
968
 */
Dries's avatar
 
Dries committed
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984

/**
 * Generate a form from a set of form elements.
 *
 * @param $form
 *   An HTML string containing one or more form elements.
 * @param $method
 *   The query method to use ("post" or "get").
 * @param $action
 *   The URL to send the form contents to, if not the current page.
 * @param $attributes
 *   An associative array of attributes to add to the form tag.
 * @result
 *   An HTML string with the contents of $form wrapped in a form tag.
 */
function form($form, $method = 'post', $action = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
985
  if (!$action) {
986
    $action = request_uri();
Dries's avatar
 
Dries committed
987
  }
Dries's avatar
 
Dries committed
988
  return '<form action="'. $action .'" method="'. $method .'"'. drupal_attributes($attributes) .">\n". $form ."\n</form>\n";
Dries's avatar
 
Dries committed
989 990
}

Dries's avatar
 
Dries committed
991
/**
Dries's avatar
 
Dries committed
992
 * File an error against the form element with the specified name.
Dries's avatar
 
Dries committed
993 994 995 996 997 998 999
 */
function form_set_error($name, $message) {
  $GLOBALS['form'][$name] = $message;
  drupal_set_message($message, 'error');
}

/**
Dries's avatar
 
Dries committed
1000
 * Return an associative array of all errors.
Dries's avatar
 
Dries committed
1001
 */
Dries's avatar
 
Dries committed
1002
function form_get_errors() {
1003 1004 1005
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'];
  }
Dries's avatar
 
Dries committed
1006 1007 1008 1009 1010 1011
}

/**
 * Return the error message filed against the form with the specified name.
 */
function _form_get_error($name) {
Dries's avatar
 
Dries committed
1012 1013 1014
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'][$name];
  }
Dries's avatar
 
Dries committed
1015 1016 1017 1018 1019 1020
}

function _form_get_class($name, $required, $error) {
  return $name. ($required ? ' required' : '') . ($error ? ' error' : '');
}

Dries's avatar
 
Dries committed
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
/**
 * Format a general form item.
 *
 * @param $title
 *   The label for the form item.
 * @param $value
 *   The contents of the form item.
 * @param $description
 *   Explanatory text to display after the form item.
 * @param $id
 *   A unique identifier for the form item.
 * @param $required
 *   Whether the user must fill in this form element before submitting the form.
 * @param $error
 *   An error message to display alongside the form element.
 * @return
 *   A themed HTML string representing the form item.
 */
Dries's avatar
 
Dries committed
1039
function form_item($title, $value, $description = NULL, $id = NULL, $required = FALSE, $error = FALSE) {
Dries's avatar
 
Dries committed
1040
  return theme('form_element', $title, $value, $description, $id, $required, $error);
Dries's avatar
 
Dries committed
1041
}
Dries's avatar
 
Dries committed
1042

Dries's avatar
 
Dries committed
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
/**
 * Format a group of form items.
 *
 * @param $legend
 *   The label for the form item group.
 * @param $group
 *   The form items within the group, as an HTML string.
 * @param $description
 *   Explanatory text to display after the form item group.
 * @return
 *   A themed HTML string representing the form item group.
 */
Dries's avatar
 
Dries committed
1055
function form_group($legend, $group, $description = NULL) {
Dries's avatar
 
Dries committed
1056
  return '<fieldset>' . ($legend ? '<legend>'. $legend .'</legend>' : '') . $group . ($description ? '<div class="description">'. $description .'</div>' : '') . "</fieldset>\n";
Dries's avatar
 
Dries committed
1057
}
Dries's avatar
 
Dries committed
1058

Dries's avatar
 
Dries committed
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
/**
 * Format a radio button.
 *
 * @param $title
 *   The label for the radio button.
 * @param $name
 *   The internal name used to refer to the button.
 * @param $value
 *   The value that the form element takes on when selected.
 * @param $checked
 *   Whether the button will be initially selected when the page is rendered.
 * @param $description
 *   Explanatory text to display after the form item.
 * @param $attributes
 *   An associative array of HTML attributes to add to the button.
 * @param $required
 *   Whether the user must select this radio button before submitting the form.
 * @return
 *   A themed HTML string representing the radio button.
 */
function form_radio($title, $name, $value = 1, $checked = FALSE, $description = NULL, $attributes = NULL, $required = FALSE) {
  $element = '<input type="radio" class="'. _form_get_class('form-radio', $required, _form_get_error($name)) .'" name="edit['. $name .']" value="'. $value .'"'. ($checked ? ' checked="checked"' : '') . drupal_attributes($attributes) .' />';
1081
  if (!is_null($title)) {
Dries's avatar
 
Dries committed
1082
    $element = '<label class="option">'. $element .' '. $title .'</label>';
1083
  }
Dries's avatar
 
Dries committed
1084
  return theme('form_element', NULL, $element, $description, $name, $required, _form_get_error($name));
Dries's avatar
 
Dries committed
1085 1086
}

Dries's avatar
 
Dries committed
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
/**
 * Format a set of radio buttons.
 *
 * @param $title
 *   The label for the radio buttons as a group.
 * @param $name
 *   The internal name used to refer to the buttons.
 * @param $value
 *   The currently selected radio button's key.
 * @param $options
 *   An associative array of buttons to display. The keys in this array are
 *   button values, while the values are the labels to display for each button.
 * @param $description
 *   Explanatory text to display after the form item.
 * @param $required
 *   Whether the user must select a radio button before submitting the form.
 * @param $attributes
 *   An associative array of HTML attributes to add to each button.
 * @return
 *   A themed HTML string representing the radio button set.
 */
1108
function form_radios($title, $name, $value, $options, $description = NULL, $required = FALSE, $attributes = NULL) {
Dries's avatar
 
Dries committed
1109
  if (count($options) > 0) {
Dries's avatar
 
Dries committed
1110
    $choices = '';
Dries's avatar
 
Dries committed
1111
    foreach ($options as $key => $choice) {
Dries's avatar
 
Dries committed
1112
      $choices .= '<label class="option"><input type="radio" class="form-radio" name="edit['. $name .']" value="'. $key .'"'. ($key == $value ? ' checked="checked"' : ''). drupal_attributes($attributes). ' /> '. $choice .'</label><br />';
Dries's avatar
 
Dries committed
1113
    }
1114
    return theme('form_element', $title, $choices, $description, NULL, $required, _form_get_error($name));
Dries's avatar
 
Dries committed
1115
  }
Dries's avatar
 
Dries committed
1116 1117
}

Dries's avatar
 
Dries committed
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
/**
 * Format a checkbox.
 *
 * @param $title
 *   The label for the checkbox.
 * @param $name
 *   The internal name used to refer to the button.
 * @param $value
 *   The value that the form element takes on when selected.
 * @param $checked
 *   Whether the button will be initially selected when the page is rendered.
 * @param $description
 *   Explanatory text to display after the form item.
 * @param $attributes
 *   An associative array of HTML attributes to add to the button.
 * @param $required
 *   Whether the user must check this box before submitting the form.
 * @return
 *   A themed HTML string representing the checkbox.
 */
function form_checkbox($title, $name, $value = 1, $checked = FALSE, $description = NULL, $attributes = NULL, $required = FALSE) {
  $element = '<input type="checkbox" class="'. _form_get_class('form-checkbox', $required, _form_get_error($name)) .'" name="edit['. $name .']" id="edit-'. $name .'" value="'. $value .'"'. ($checked ? ' checked="checked"' : '') . drupal_attributes($attributes) .' />';
1140
  if (!is_null($title)) {
Dries's avatar
 
Dries committed
1141
    $element = '<label class="option">'. $element .' '. $title .'</label>';
1142
  }
1143 1144
  // Note: because unchecked boxes are not included in the POST data, we include
  // a form_hidden() which will be overwritten for a checked box.
Dries's avatar
 
Dries committed
1145
  return form_hidden($name, 0) . theme('form_element', NULL, $element, $description, $name, $required, _form_get_error($name));
Dries's avatar
 
Dries committed
1146 1147
}

Dries's avatar
 
Dries committed
1148 1149 1150 1151 1152 1153 1154 1155
/**
 * Format a set of checkboxes.
 *
 * @param $title
 *   The label for the checkboxes as a group.
 * @param $name
 *   The internal name used to refer to the buttons.
 * @param $values
1156
 *   A linear array of keys of the initially checked boxes.
Dries's avatar