common.inc 59.3 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.
 */

Dries's avatar
 
Dries committed
12
/**
Dries's avatar
 
Dries committed
13
 * Set the breadcrumb trail for the current page.
Dries's avatar
 
Dries committed
14
 *
Dries's avatar
 
Dries committed
15 16 17
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
18
 */
Dries's avatar
 
Dries committed
19 20 21 22 23 24 25 26 27
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

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

Dries's avatar
 
Dries committed
28 29 30
/**
 * Get the breadcrumb trail for the current page.
 */
Dries's avatar
 
Dries committed
31 32 33 34 35 36 37 38 39 40
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

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

  return $breadcrumb;
}

Dries's avatar
Dries committed
41
/**
Dries's avatar
 
Dries committed
42
 * Add output to the head tag of the HTML page.
Dries's avatar
 
Dries committed
43
 * This function can be called as long the headers aren't sent.
Dries's avatar
Dries committed
44 45
 */
function drupal_set_html_head($data = NULL) {
Dries's avatar
 
Dries committed
46
  static $stored_head = '';
Dries's avatar
Dries committed
47 48

  if (!is_null($data)) {
Dries's avatar
 
Dries committed
49
    $stored_head .= $data ."\n";
Dries's avatar
Dries committed
50 51 52 53
  }
  return $stored_head;
}

Dries's avatar
 
Dries committed
54 55 56
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries's avatar
Dries committed
57 58 59
function drupal_get_html_head() {
  global $base_url;

Dries's avatar
 
Dries committed
60
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
61
  $output .= "<base href=\"$base_url/\" />\n";
Dries's avatar
 
Dries committed
62
  $output .= theme('stylesheet_import', 'misc/drupal.css');
Dries's avatar
Dries committed
63 64 65 66

  return $output . drupal_set_html_head();
}

Dries's avatar
 
Dries committed
67 68 69
/**
 * Regenerate the path map from the information in the database.
 */
Dries's avatar
 
Dries committed
70
function drupal_rebuild_path_map() {
Dries's avatar
 
Dries committed
71
  drupal_get_path_map('rebuild');
Dries's avatar
 
Dries committed
72
}
Kjartan's avatar
Kjartan committed
73

Dries's avatar
 
Dries committed
74
/**
Dries's avatar
 
Dries committed
75
 * Given a path alias, return the internal path it represents.
Dries's avatar
 
Dries committed
76 77 78 79 80
 */
function drupal_get_normal_path($path) {
  if (($map = drupal_get_path_map()) && isset($map[$path])) {
    return $map[$path];
  }
Dries's avatar
 
Dries committed
81
  elseif (function_exists('conf_url_rewrite')) {
Dries's avatar
 
Dries committed
82 83 84 85 86 87
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
Kjartan's avatar
Kjartan committed
88

Dries's avatar
Dries committed
89
/**
Dries's avatar
 
Dries committed
90
 * Set an HTTP response header for the current page.
Dries's avatar
Dries committed
91 92
 */
function drupal_set_header($header = NULL) {
93
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries's avatar
 
Dries committed
94
  // Otherwise, header('') could get called when serving the page later, which
95 96
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries's avatar
Dries committed
97

98
  if (strlen($header)) {
Dries's avatar
Dries committed
99
    header($header);
100
    $stored_headers[] = $header;
Dries's avatar
Dries committed
101
  }
102
  return implode("\n", $stored_headers);
Dries's avatar
Dries committed
103 104
}

Dries's avatar
 
Dries committed
105 106 107
/**
 * Get the HTTP response headers for the current page.
 */
Dries's avatar
Dries committed
108 109 110 111
function drupal_get_headers() {
  return drupal_set_header();
}

Dries's avatar
 
Dries committed
112 113 114
/**
 * @name HTTP handling
 * @{
Dries's avatar
 
Dries committed
115
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
116 117
 */

118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
/**
 * Prepare a destination query string for use in combination with
 * drupal_goto().  Used to direct the user back to the referring page
 * after completing a form.
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
  $destination[] = $_GET['q'];
  $params = array('from', 'sort', 'order');
  foreach ($params as $param) {
    if (isset($_GET[$param])) {
      $destination[] = "$param=". $_GET[$param];
    }
  }
  return 'destination='. urlencode(implode('&', $destination));
}

Kjartan's avatar
Kjartan committed
136
/**
Dries's avatar
 
Dries committed
137
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
138
 *
Dries's avatar
 
Dries committed
139 140
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
141
 *
142 143 144 145 146 147 148 149 150 151
 * 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
152 153 154 155 156 157 158 159 160 161 162 163 164
 * 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).
165 166
 *
 * @see drupal_get_destination()
Kjartan's avatar
Kjartan committed
167
 */
Dries's avatar
 
Dries committed
168
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
169 170 171 172 173 174 175
  if ($_REQUEST['destination']) {
    extract(parse_url($_REQUEST['destination']));
  }
  else if ($_REQUEST['edit']['destination']) {
    extract(parse_url($_REQUEST['edit']['destination']));
  }

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

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

Dries's avatar
 
Dries committed
181 182
    if (strstr($url, '?') && !strstr($url, $sid)) {
      $url = $url .'&'. $sid;
Kjartan's avatar
Kjartan committed
183 184
    }
    else {
Dries's avatar
 
Dries committed
185
      $url = $url .'?'. $sid;
Kjartan's avatar
Kjartan committed
186 187 188
    }
  }

Dries's avatar
 
Dries committed
189 190 191 192
  // 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
193

Dries's avatar
 
Dries committed
194 195 196
  // 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
197 198 199 200 201 202
  exit();
}

/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
 
Dries committed
203
function drupal_not_found() {
Dries's avatar
 
Dries committed
204
  header('HTTP/1.0 404 Not Found');
205
  watchdog('page not found', t('%page not found.', array('%page' => theme('placeholder', $_GET['q']))), WATCHDOG_WARNING);
Dries's avatar
 
Dries committed
206 207

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries's avatar
 
Dries committed
208
  $status = MENU_NOT_FOUND;
Dries's avatar
 
Dries committed
209 210
  if ($path) {
    menu_set_active_item($path);
Dries's avatar
 
Dries committed
211
    $status = menu_execute_active_handler();
Dries's avatar
 
Dries committed
212 213
  }

Dries's avatar
 
Dries committed
214
  if ($status != MENU_FOUND) {
215 216
    drupal_set_title(t('Page not found'));
    print theme('page', '');
Dries's avatar
 
Dries committed
217 218
  }
}
Dries's avatar
 
Dries committed
219

Dries's avatar
 
Dries committed
220 221 222 223 224
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
  header('HTTP/1.0 403 Forbidden');
225
  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
226 227

  $path = drupal_get_normal_path(variable_get('site_403', ''));
Dries's avatar
 
Dries committed
228
  $status = MENU_NOT_FOUND;
Dries's avatar
 
Dries committed
229 230 231 232 233 234
  if ($path) {
    menu_set_active_item($path);
    $status = menu_execute_active_handler();
  }

  if ($status != MENU_FOUND) {
235 236
    drupal_set_title(t('Access denied'));
    print theme('page', message_access());
Dries's avatar
 
Dries committed
237 238 239
  }
}

Dries's avatar
 
Dries committed
240
/**
Dries's avatar
 
Dries committed
241
 * Perform an HTTP request.
Dries's avatar
 
Dries committed
242
 *
Dries's avatar
 
Dries committed
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
 * 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
260 261
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
 
Dries committed
262 263
  $result = new StdClass();

Dries's avatar
 
Dries committed
264
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
 
Dries committed
265 266 267 268 269 270
  $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
271 272
      // 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
273 274
      break;
    default:
Dries's avatar
 
Dries committed
275
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
 
Dries committed
276 277 278
      return $result;
  }

Dries's avatar
 
Dries committed
279
  // Make sure the socket opened properly.
Dries's avatar
 
Dries committed
280
  if (!$fp) {
Dries's avatar
 
Dries committed
281
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
 
Dries committed
282 283 284
    return $result;
  }

Dries's avatar
 
Dries committed
285
  // Construct the path to act on.
Dries's avatar
 
Dries committed
286 287
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
Dries's avatar
 
Dries committed
288
    $path .= '?'. $uri['query'];
Dries's avatar
 
Dries committed
289 290
  }

Dries's avatar
 
Dries committed
291
  // Create HTTP request.
Dries's avatar
 
Dries committed
292
  $defaults = array(
Dries's avatar
 
Dries committed
293
    'Host' => 'Host: '. $uri['host'],
294 295
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
 
Dries committed
296 297 298
  );

  foreach ($headers as $header => $value) {
Dries's avatar
 
Dries committed
299
    $defaults[$header] = $header .': '. $value;
Dries's avatar
 
Dries committed
300 301
  }

Dries's avatar
 
Dries committed
302
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
 
Dries committed
303 304 305
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
 
Dries committed
306
    $request .= $data ."\r\n";
Dries's avatar
 
Dries committed
307 308 309 310 311 312
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
313
  $response = '';
314
  while (!feof($fp) && $data = fread($fp, 1024)) {
315
    $response .= $data;
Dries's avatar
 
Dries committed
316 317 318 319
  }
  fclose($fp);

  // Parse response.
320 321 322 323
  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
324 325 326
  $result->headers = array();

  // Parse headers.
327
  while ($line = trim(array_shift($headers))) {
Dries's avatar
 
Dries committed
328 329 330 331 332 333 334 335 336 337 338 339
    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
340
  // the base code in their class.
Dries's avatar
 
Dries committed
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
  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
368 369 370
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
 
Dries committed
371

Dries's avatar
 
Dries committed
372
/**
Dries's avatar
 
Dries committed
373 374 375 376
 * 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
377
 */
Dries's avatar
 
Dries committed
378
function error_handler($errno, $message, $filename, $line) {
379
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries's avatar
 
Dries committed
380 381
    $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
382

Dries's avatar
 
Dries committed
383
    if (variable_get('error_level', 1) == 1) {
Dries's avatar
 
Dries committed
384
      print '<pre>'. $entry .'</pre>';
Dries's avatar
Dries committed
385
    }
386 387

    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
388 389 390
  }
}

Dries's avatar
 
Dries committed
391
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
392
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
393 394 395
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
396
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
397 398 399
  }
}

Dries's avatar
 
Dries committed
400 401 402 403
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
 
Dries committed
404 405
function fix_gpc_magic() {
  static $fixed = false;
Dries's avatar
 
Dries committed
406
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
407 408 409 410 411 412
    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
413 414
}

Kjartan's avatar
Kjartan committed
415 416 417
/**
 * @name Conversion
 * @{
Dries's avatar
 
Dries committed
418
 * Converts data structures to different types.
Kjartan's avatar
Kjartan committed
419
 */
Dries's avatar
 
Dries committed
420 421 422 423

/**
 * Convert an associative array to an anonymous object.
 */
Dries's avatar
Dries committed
424 425
function array2object($array) {
  if (is_array($array)) {
Dries's avatar
 
Dries committed
426
    $object = new StdClass();
Dries's avatar
Dries committed
427
    foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
428 429 430 431
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
432
    $object = $array;
Dries's avatar
 
Dries committed
433 434 435 436 437
  }

  return $object;
}

Dries's avatar
 
Dries committed
438 439 440
/**
 * Convert an object to an associative array.
 */
Dries's avatar
Dries committed
441 442 443
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
 
Dries committed
444 445 446 447
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
448
    $array = $object;
Dries's avatar
 
Dries committed
449 450 451 452
  }

  return $array;
}
Dries's avatar
 
Dries committed
453 454 455 456

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

Kjartan's avatar
Kjartan committed
458 459 460
/**
 * @name Messages
 * @{
Dries's avatar
 
Dries committed
461
 * Frequently used messages.
Kjartan's avatar
Kjartan committed
462
 */
Dries's avatar
 
Dries committed
463 464 465 466 467 468 469

/**
 * 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
470
function message_access() {
Dries's avatar
 
Dries committed
471
  return t('You are not authorized to access this page.');
Dries's avatar
 
Dries committed
472 473
}

Dries's avatar
 
Dries committed
474 475 476
/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
 
Dries committed
477
function message_na() {
Dries's avatar
 
Dries committed
478
  return t('n/a');
Dries's avatar
 
Dries committed
479 480
}

Dries's avatar
 
Dries committed
481 482 483
/**
 * @} End of "Messages".
 */
Dries's avatar
 
Dries committed
484

Dries's avatar
 
Dries committed
485 486 487
/**
 * Initialize the localization system.
 */
Dries's avatar
 
Dries committed
488 489
function locale_initialize() {
  global $user;
Dries's avatar
 
Dries committed
490 491 492 493 494

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

Dries's avatar
 
Dries committed
495 496 497 498 499
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
500 501 502
    // 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
503
  }
Dries's avatar
 
Dries committed
504 505 506 507 508 509
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
510 511
}

Kjartan's avatar
Kjartan committed
512
/**
Dries's avatar
 
Dries committed
513
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
514
 *
515
 * When using t(), try to put entire sentences and strings in one t() call.
Dries's avatar
 
Dries committed
516 517 518 519
 * 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
520 521 522
 *   $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
523
 * @endcode
524 525 526
 * 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
527
 *
Dries's avatar
 
Dries committed
528
 * @param $string
Dries's avatar
 
Dries committed
529
 *   A string containing the English string to translate.
Dries's avatar
 
Dries committed
530 531
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
 
Dries committed
532
 *   of any key in this array are replaced with the corresponding value.
Dries's avatar
 
Dries committed
533 534
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
535
 */
Dries's avatar
 
Dries committed
536
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
537 538 539 540
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
541

Dries's avatar
 
Dries committed
542 543
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
544 545
  }
  else {
Dries's avatar
 
Dries committed
546 547
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
548 549
}

Dries's avatar
 
Dries committed
550
/**
551
 * Encode special characters in a plain-text string for display as HTML.
Dries's avatar
 
Dries committed
552
 */
553 554
function check_plain($text) {
  return htmlspecialchars($text, ENT_QUOTES);
Dries's avatar
 
Dries committed
555 556
}

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

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

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

Dries's avatar
 
Dries committed
602 603 604 605 606 607 608 609 610 611
/**
 * 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
612 613
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
Dries's avatar
 
Dries committed
614
    // Form data can contain a number of nested arrays.
Kjartan's avatar
Kjartan committed
615
    foreach ($data as $key => $value) {
Dries's avatar
 
Dries committed
616
      if (!valid_input_data($key) || !valid_input_data($value)) {
Dries's avatar
 
Dries committed
617
        return FALSE;
Kjartan's avatar
Kjartan committed
618 619 620
      }
    }
  }
Dries's avatar
Dries committed
621
  else if (isset($data)) {
Dries's avatar
 
Dries committed
622
    // Detect dangerous input data.
Kjartan's avatar
Kjartan committed
623

624 625 626
    // Decode all normal character entities.
    $data = decode_entities($data, array('<', '&', '"'));

Dries's avatar
 
Dries committed
627 628 629 630
    // 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
631

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

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

    if ($match) {
639
      watchdog('security', t('Terminated request because of suspicious input data: %data.', array('%data' => theme('placeholder', $data))));
Dries's avatar
 
Dries committed
640
      return FALSE;
Kjartan's avatar
Kjartan committed
641 642 643
    }
  }

Dries's avatar
 
Dries committed
644
  return TRUE;
Kjartan's avatar
Kjartan committed
645
}
Dries's avatar
 
Dries committed
646 647 648
/**
 * @} End of "defgroup validation".
 */
Kjartan's avatar
Kjartan committed
649

Dries's avatar
 
Dries committed
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
/**
 * 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);
}

677 678
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
679 680
}

Dries's avatar
 
Dries committed
681
/**
Dries's avatar
 
Dries committed
682
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
683
 * @{
Dries's avatar
 
Dries committed
684
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
685 686
 */

Dries's avatar
 
Dries committed
687 688 689 690 691 692
/**
 * 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
693 694
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
695
  $output = "<channel>\n";
696 697 698 699
  $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
700
  foreach ($args as $key => $value) {
701
    $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
 
Dries committed
702
  }
Dries's avatar
 
Dries committed
703 704 705 706 707 708
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
709 710 711 712 713
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
714
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
715
  $output = "<item>\n";
716 717 718
  $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
719
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
    if (is_array($value)) {
      if ($value['key']) {
        $output .= ' <'. $value['key'];
        if (is_array($value['attributes'])) {
          $output .= drupal_attributes($value['attributes']);
        }

        if ($value['value']) {
          $output .= '>'. $value['value'] .'</'. $value['key'] .">\n";
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
736
      $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
 
Dries committed
737
    }
Dries's avatar
 
Dries committed
738
  }
Dries's avatar
 
Dries committed
739 740 741 742 743
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
744
/**
Dries's avatar
 
Dries committed
745
 * Format a string containing a count of items.
Dries's avatar
 
Dries committed
746
 *
Dries's avatar
 
Dries committed
747 748 749 750 751 752 753 754 755 756 757 758 759 760
 * 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
761
 */
Dries's avatar
 
Dries committed
762
function format_plural($count, $singular, $plural) {
763
  if ($count == 1) return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
764 765 766 767 768 769 770 771 772

  // 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":
773
        return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
774 775 776 777 778 779
      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
780 781
}

Dries's avatar
 
Dries committed
782
/**
Dries's avatar
 
Dries committed
783
 * Generate a string representation for the given byte count.
Dries's avatar
 
Dries committed
784
 *
Dries's avatar
 
Dries committed
785 786 787 788
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
789
 */
Dries's avatar
 
Dries committed
790
function format_size($size) {
Dries's avatar
 
Dries committed
791
  $suffix = t('bytes');
Dries's avatar
 
Dries committed
792 793
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
794
    $suffix = t('KB');
Dries's avatar
 
Dries committed
795 796 797
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
798
    $suffix = t('MB');
Dries's avatar
 
Dries committed
799
  }
Dries's avatar
 
Dries committed
800
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries's avatar
 
Dries committed
801 802
}

Dries's avatar
 
Dries committed
803
/**
Dries's avatar
 
Dries committed
804
 * Format a time interval with the requested granularity.
Dries's avatar
 
Dries committed
805
 *
Dries's avatar
 
Dries committed
806 807 808 809 810 811
 * @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
812
 */
Dries's avatar
 
Dries committed
813
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
 
Dries committed
814
  $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
815
  $output = '';
Dries's avatar
 
Dries committed
816
  foreach ($units as $key => $value) {
Dries's avatar
 
Dries committed
817
    $key = explode('|', $key);
Dries's avatar
 
Dries committed
818
    if ($timestamp >= $value) {
Dries's avatar
 
Dries committed
819
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
 
Dries committed
820
      $timestamp %= $value;
Dries's avatar
 
Dries committed
821 822 823 824 825
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
826 827
    }
  }
Dries's avatar
 
Dries committed
828
  return $output ? $output : t('0 sec');
Dries's avatar
 
Dries committed
829 830
}

Dries's avatar
 
Dries committed
831
/**
Dries's avatar
 
Dries committed
832 833
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
 
Dries committed
834 835 836 837
 * 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
838 839 840 841 842 843
 * @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
844 845 846
 *   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
847 848 849 850
 * @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
851
 */
852 853 854
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
855 856 857 858 859 860
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
861
  }
Dries's avatar
 
Dries committed
862

863
  $timestamp += $timezone;
Dries's avatar
 
Dries committed
864 865

  switch ($type) {
866 867
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
 
Dries committed
868
      break;
869 870
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
 
Dries committed
871
      break;
872
    case 'custom':
Dries's avatar
 
Dries committed
873
      // No change to format
Dries's avatar
 
Dries committed
874
      break;
875
    case 'medium':
Dries's avatar
 
Dries committed
876
    default:
877
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
 
Dries committed
878 879
  }

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

Dries's avatar
 
Dries committed
907 908 909
  return $date;
}

Dries's avatar
 
Dries committed
910
/**
Dries's avatar
 
Dries committed
911
 * Format a username.
Dries's avatar
 
Dries committed
912
 *
Dries's avatar
 
Dries committed
913 914 915 916 917
 * @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
918
 */
Dries's avatar
 
Dries committed
919 920 921
function format_name($object) {

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

930 931 932 933 934 935
    if (user_access('access user profiles')) {
      $output = l($name, 'user/'. $object->uid, array('title' => t('View user profile.')));
    }
    else {
      $output = $name;
    }
Dries's avatar
 
Dries committed
936
  }
Dries's avatar
 
Dries committed
937
  else if ($object->name) {
Dries's avatar
 
Dries committed
938 939 940 941
    // 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
942
    if ($object->homepage) {
Dries's avatar
 
Dries committed
943
      $output = '<a href="'. $object->homepage .'">'. $object->name .'</a>';
Dries's avatar
 
Dries committed
944 945 946 947 948 949
    }
    else {
      $output = $object->name;
    }

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

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

Kjartan's avatar
Kjartan committed
961
/**
Dries's avatar
 
Dries committed
962
 * @defgroup form Form generation
Kjartan's avatar
Kjartan committed
963
 * @{
Dries's avatar
 
Dries committed
964
 * Functions to enable output of HTML forms and form elements.
965
 *
Dries's avatar
 
Dries committed
966 967
 * 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
968
 * must be explicitly generated by modules.
Kjartan's avatar
Kjartan committed
969
 */
Dries's avatar
 
Dries committed
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985

/**
 * 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
986
  if (!$action) {
987
    $action = request_uri();
Dries's avatar
 
Dries committed
988
  }
989
  return '<form action="'. check_url($action) .'" method="'. $method .'"'. drupal_attributes($attributes) .">\n". $form ."\n</form>\n";
Dries's avatar
 
Dries committed
990 991
}

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

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

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

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

Dries's avatar
 
Dries committed
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
/**
 * 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
1040
function form_item($title, $value, $description = NULL, $id = NULL, $required = FALSE, $error = FALSE) {
Dries's avatar
 
Dries committed
1041
  return theme('form_element', $title, $value, $description, $id, $required, $error);
Dries's avatar
 
Dries committed
1042
}
Dries's avatar
 
Dries committed
1043

Dries's avatar
 
Dries committed
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
/**
 * 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
1056
function form_group($legend, $group, $description = NULL) {
Dries's avatar
 
Dries committed
1057
  return '<fieldset>' . ($legend ? '<legend>'. $legend .'</legend>' : '') . $group . ($description ? '<div class="description">'. $description .'</div>' : '') . "</fieldset>\n";
Dries's avatar
 
Dries committed
1058
}
Dries's avatar
 
Dries committed
1059

Dries's avatar
 
Dries committed
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
/**
 * 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) .' />';
1082
  if (!is_null($title)) {
Dries's avatar
 
Dries committed
1083
    $element = '<label class="option">'. $element .' '. $title .'</label>';
1084
  }
Dries's avatar
 
Dries committed
1085
  return theme('form_element', NULL, $element, $description, $name, $required, _form_get_error($name));
Dries's avatar
 
Dries committed
1086 1087
}

Dries's avatar
 
Dries committed
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
/**
 * 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.
 */
1109
function form_radios($title, $name, $value, $options, $description = NULL, $required = FALSE, $attributes = NULL) {
Dries's avatar
 
Dries committed
1110
  if (count($options) > 0) {
Dries's avatar
 
Dries committed
1111
    $choices = '';
Dries's avatar
 
Dries committed
1112
    foreach ($options as $key => $choice) {
1113
      $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
1114
    }
1115
    return theme('form_element', $title, $choices, $description, NULL, $required, _form_get_error($name));
Dries's avatar
 
Dries committed
1116
  }
Dries's avatar
 
Dries committed
1117 1118
}

Dries's avatar
 
Dries committed
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
/**
 * 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) .' />';
1141
  if (!is_null($title)) {
Dries's avatar
 
Dries committed
1142
    $element = '<label class="option">'. $element .' '. $title .'</label>';
1143
  }
1144 1145
  // 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
1146
  return form_hidden($name, 0) . theme('form_element', NULL, $element, $description, $name, $required, _form_get_error($name));
Dries's avatar
 
Dries committed
1147 1148
}

Dries's avatar
 
Dries committed
1149 1150 1151 1152 1153 1154 1155 1156
/**
 * 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
1157
 *   A linear array of keys of the initially checked boxes.
Dries's avatar
 
Dries committed
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
 * @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 $attributes
 *   An associative array of HTML attributes to add to each button.
 * @param $required
 *   Whether the user must check a box before submitting the form.
 * @return
 *   A themed HTML string representing the radio button set.
 */
Dries's avatar
 
Dries committed
1170
function form_checkboxes($title, $name, $values, $options, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar