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

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

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

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

Dries's avatar
 
Dries committed
27
/**
Dries's avatar
 
Dries committed
28
 * Set the breadcrumb trail for the current page.
Dries's avatar
 
Dries committed
29
 *
Dries's avatar
 
Dries committed
30 31 32
 * @param $breadcrumb
 *   Array of links, starting with "home" and proceeding up to but not including
 *   the current page.
Kjartan's avatar
Kjartan committed
33
 */
Dries's avatar
 
Dries committed
34 35 36 37 38 39 40 41 42
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

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

Dries's avatar
 
Dries committed
43 44 45
/**
 * Get the breadcrumb trail for the current page.
 */
Dries's avatar
 
Dries committed
46 47 48 49 50 51 52 53 54 55
function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

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

  return $breadcrumb;
}

Dries's avatar
Dries committed
56
/**
Dries's avatar
 
Dries committed
57
 * Add output to the head tag of the HTML page.
Dries's avatar
 
Dries committed
58
 * This function can be called as long the headers aren't sent.
Dries's avatar
Dries committed
59 60
 */
function drupal_set_html_head($data = NULL) {
Dries's avatar
 
Dries committed
61
  static $stored_head = '';
Dries's avatar
Dries committed
62 63

  if (!is_null($data)) {
Dries's avatar
 
Dries committed
64
    $stored_head .= $data ."\n";
Dries's avatar
Dries committed
65 66 67 68
  }
  return $stored_head;
}

Dries's avatar
 
Dries committed
69 70 71
/**
 * Retrieve output to be displayed in the head tag of the HTML page.
 */
Dries's avatar
Dries committed
72 73 74
function drupal_get_html_head() {
  global $base_url;

Dries's avatar
 
Dries committed
75
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
76
  $output .= "<base href=\"$base_url/\" />\n";
Dries's avatar
 
Dries committed
77
  $output .= theme('stylesheet_import', 'misc/drupal.css');
Dries's avatar
Dries committed
78 79 80 81

  return $output . drupal_set_html_head();
}

Dries's avatar
 
Dries committed
82
/**
83
 * Reset the static variable which holds the aliases mapped for this request.
Dries's avatar
 
Dries committed
84
 */
85 86
function drupal_clear_path_cache() {
  drupal_lookup_path('wipe');
Dries's avatar
 
Dries committed
87
}
Kjartan's avatar
Kjartan committed
88

Dries's avatar
 
Dries committed
89
/**
Dries's avatar
 
Dries committed
90
 * Given a path alias, return the internal path it represents.
Dries's avatar
 
Dries committed
91 92
 */
function drupal_get_normal_path($path) {
93 94 95
  //drupal_get_path_alias($path);
  if ($src = drupal_lookup_path('alias', $path)) {
    return $src;
Dries's avatar
 
Dries committed
96
  }
Dries's avatar
 
Dries committed
97
  elseif (function_exists('conf_url_rewrite')) {
Dries's avatar
 
Dries committed
98 99 100 101 102 103
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
Kjartan's avatar
Kjartan committed
104

Dries's avatar
Dries committed
105
/**
Dries's avatar
 
Dries committed
106
 * Set an HTTP response header for the current page.
Dries's avatar
Dries committed
107 108
 */
function drupal_set_header($header = NULL) {
109
  // We use an array to guarantee there are no leading or trailing delimiters.
Dries's avatar
 
Dries committed
110
  // Otherwise, header('') could get called when serving the page later, which
111 112
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries's avatar
Dries committed
113

114
  if (strlen($header)) {
Dries's avatar
Dries committed
115
    header($header);
116
    $stored_headers[] = $header;
Dries's avatar
Dries committed
117
  }
118
  return implode("\n", $stored_headers);
Dries's avatar
Dries committed
119 120
}

Dries's avatar
 
Dries committed
121 122 123
/**
 * Get the HTTP response headers for the current page.
 */
Dries's avatar
Dries committed
124 125 126 127
function drupal_get_headers() {
  return drupal_set_header();
}

Dries's avatar
 
Dries committed
128 129 130
/**
 * @name HTTP handling
 * @{
Dries's avatar
 
Dries committed
131
 * Functions to properly handle HTTP responses.
Dries's avatar
 
Dries committed
132 133
 */

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

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

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

Dries's avatar
 
Dries committed
197 198
    if (strstr($url, '?') && !strstr($url, $sid)) {
      $url = $url .'&'. $sid;
Kjartan's avatar
Kjartan committed
199 200
    }
    else {
Dries's avatar
 
Dries committed
201
      $url = $url .'?'. $sid;
Kjartan's avatar
Kjartan committed
202 203 204
    }
  }

Dries's avatar
 
Dries committed
205 206 207 208
  // 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
209

Dries's avatar
 
Dries committed
210 211 212
  // 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
213 214 215 216 217 218
  exit();
}

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

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries's avatar
 
Dries committed
224
  $status = MENU_NOT_FOUND;
Dries's avatar
 
Dries committed
225 226
  if ($path) {
    menu_set_active_item($path);
227
    $return = menu_execute_active_handler();
Dries's avatar
 
Dries committed
228 229
  }

230
  if (empty($return)) {
231
    drupal_set_title(t('Page not found'));
Dries's avatar
 
Dries committed
232
  }
233
  print theme('page', $return);
Dries's avatar
 
Dries committed
234
}
Dries's avatar
 
Dries committed
235

Dries's avatar
 
Dries committed
236 237 238 239 240
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
  header('HTTP/1.0 403 Forbidden');
241
  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
242 243

  $path = drupal_get_normal_path(variable_get('site_403', ''));
Dries's avatar
 
Dries committed
244
  $status = MENU_NOT_FOUND;
Dries's avatar
 
Dries committed
245 246
  if ($path) {
    menu_set_active_item($path);
247
    $return = menu_execute_active_handler();
Dries's avatar
 
Dries committed
248 249
  }

250
  if (empty($return)) {
251
    drupal_set_title(t('Access denied'));
252
    $return = message_access();
Dries's avatar
 
Dries committed
253
  }
254
  print theme('page', $return);
Dries's avatar
 
Dries committed
255 256
}

Dries's avatar
 
Dries committed
257
/**
Dries's avatar
 
Dries committed
258
 * Perform an HTTP request.
Dries's avatar
 
Dries committed
259
 *
Dries's avatar
 
Dries committed
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
 * 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
277 278
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
 
Dries committed
279 280
  $result = new StdClass();

Dries's avatar
 
Dries committed
281
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
 
Dries committed
282 283 284 285 286 287
  $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
288 289
      // 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
290 291
      break;
    default:
Dries's avatar
 
Dries committed
292
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
 
Dries committed
293 294 295
      return $result;
  }

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

Dries's avatar
 
Dries committed
302
  // Construct the path to act on.
Dries's avatar
 
Dries committed
303 304
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
Dries's avatar
 
Dries committed
305
    $path .= '?'. $uri['query'];
Dries's avatar
 
Dries committed
306 307
  }

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

  foreach ($headers as $header => $value) {
Dries's avatar
 
Dries committed
316
    $defaults[$header] = $header .': '. $value;
Dries's avatar
 
Dries committed
317 318
  }

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

  fwrite($fp, $request);

  // Fetch response.
330
  $response = '';
331
  while (!feof($fp) && $data = fread($fp, 1024)) {
332
    $response .= $data;
Dries's avatar
 
Dries committed
333 334 335 336
  }
  fclose($fp);

  // Parse response.
337 338 339 340
  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
341 342 343
  $result->headers = array();

  // Parse headers.
344
  while ($line = trim(array_shift($headers))) {
Dries's avatar
 
Dries committed
345 346 347 348 349 350 351 352 353 354 355 356
    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
357
  // the base code in their class.
Dries's avatar
 
Dries committed
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
  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
385 386 387
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
 
Dries committed
388

Dries's avatar
 
Dries committed
389
/**
Dries's avatar
 
Dries committed
390 391 392 393
 * 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
394
 */
Dries's avatar
 
Dries committed
395
function error_handler($errno, $message, $filename, $line) {
396
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries's avatar
 
Dries committed
397 398
    $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
399

Dries's avatar
 
Dries committed
400
    if (variable_get('error_level', 1) == 1) {
Dries's avatar
 
Dries committed
401
      print '<pre>'. $entry .'</pre>';
Dries's avatar
Dries committed
402
    }
403 404

    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
405 406 407
  }
}

Dries's avatar
 
Dries committed
408
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
409
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
410 411 412
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
413
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
414 415 416
  }
}

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

Kjartan's avatar
Kjartan committed
432 433 434
/**
 * @name Conversion
 * @{
Dries's avatar
 
Dries committed
435
 * Converts data structures to different types.
Kjartan's avatar
Kjartan committed
436
 */
Dries's avatar
 
Dries committed
437 438 439 440

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

  return $object;
}

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

  return $array;
}
Dries's avatar
 
Dries committed
470 471 472 473

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

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

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

Dries's avatar
 
Dries committed
491 492 493
/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
 
Dries committed
494
function message_na() {
Dries's avatar
 
Dries committed
495
  return t('n/a');
Dries's avatar
 
Dries committed
496 497
}

Dries's avatar
 
Dries committed
498 499 500
/**
 * @} End of "Messages".
 */
Dries's avatar
 
Dries committed
501

Dries's avatar
 
Dries committed
502 503 504
/**
 * Initialize the localization system.
 */
Dries's avatar
 
Dries committed
505 506
function locale_initialize() {
  global $user;
Dries's avatar
 
Dries committed
507 508 509 510 511

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

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

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

Dries's avatar
 
Dries committed
559 560
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
561 562
  }
  else {
Dries's avatar
 
Dries committed
563 564
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
565 566
}

Dries's avatar
 
Dries committed
567
/**
568
 * Encode special characters in a plain-text string for display as HTML.
Dries's avatar
 
Dries committed
569
 */
570 571
function check_plain($text) {
  return htmlspecialchars($text, ENT_QUOTES);
Dries's avatar
 
Dries committed
572 573
}

Kjartan's avatar
Kjartan committed
574
/**
Dries's avatar
 
Dries committed
575
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
576
 * @{
Dries's avatar
 
Dries committed
577
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
578 579
 */

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

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

Dries's avatar
 
Dries committed
619 620 621 622 623 624 625 626 627 628
/**
 * 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
629 630
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
Dries's avatar
 
Dries committed
631
    // Form data can contain a number of nested arrays.
Kjartan's avatar
Kjartan committed
632
    foreach ($data as $key => $value) {
Dries's avatar
 
Dries committed
633
      if (!valid_input_data($key) || !valid_input_data($value)) {
Dries's avatar
 
Dries committed
634
        return FALSE;
Kjartan's avatar
Kjartan committed
635 636 637
      }
    }
  }
Dries's avatar
Dries committed
638
  else if (isset($data)) {
Dries's avatar
 
Dries committed
639
    // Detect dangerous input data.
Kjartan's avatar
Kjartan committed
640

641 642 643
    // Decode all normal character entities.
    $data = decode_entities($data, array('<', '&', '"'));

Dries's avatar
 
Dries committed
644 645 646 647
    // 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
648

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

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

    if ($match) {
656
      watchdog('security', t('Terminated request because of suspicious input data: %data.', array('%data' => theme('placeholder', $data))));
Dries's avatar
 
Dries committed
657
      return FALSE;
Kjartan's avatar
Kjartan committed
658 659 660
    }
  }

Dries's avatar
 
Dries committed
661
  return TRUE;
Kjartan's avatar
Kjartan committed
662
}
Dries's avatar
 
Dries committed
663 664 665
/**
 * @} End of "defgroup validation".
 */
Kjartan's avatar
Kjartan committed
666

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

694 695
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
696 697
}

Dries's avatar
 
Dries committed
698
/**
Dries's avatar
 
Dries committed
699
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
700
 * @{
Dries's avatar
 
Dries committed
701
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
702 703
 */

Dries's avatar
 
Dries committed
704 705 706 707 708 709
/**
 * 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
710 711
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
712
  $output = "<channel>\n";
713 714 715 716
  $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
717
  foreach ($args as $key => $value) {
718
    $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
 
Dries committed
719
  }
Dries's avatar
 
Dries committed
720 721 722 723 724 725
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
726 727 728 729 730
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
731
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
732
  $output = "<item>\n";
733 734 735
  $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
736
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
    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 {
753
      $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
 
Dries committed
754
    }
Dries's avatar
 
Dries committed
755
  }
Dries's avatar
 
Dries committed
756 757 758 759 760
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
761
/**
Dries's avatar
 
Dries committed
762
 * Format a string containing a count of items.
Dries's avatar
 
Dries committed
763
 *
Dries's avatar
 
Dries committed
764 765 766 767 768 769 770 771 772 773 774 775 776 777
 * 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
778
 */
Dries's avatar
 
Dries committed
779
function format_plural($count, $singular, $plural) {
780
  if ($count == 1) return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
781 782 783 784 785 786 787 788 789

  // 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":
790
        return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
791 792 793 794 795 796
      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
797 798
}

Dries's avatar
 
Dries committed
799
/**
Dries's avatar
 
Dries committed
800
 * Generate a string representation for the given byte count.
Dries's avatar
 
Dries committed
801
 *
Dries's avatar
 
Dries committed
802 803 804 805
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
806
 */
Dries's avatar
 
Dries committed
807
function format_size($size) {
Dries's avatar
 
Dries committed
808
  $suffix = t('bytes');
Dries's avatar
 
Dries committed
809 810
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
811
    $suffix = t('KB');
Dries's avatar
 
Dries committed
812 813 814
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
815
    $suffix = t('MB');
Dries's avatar
 
Dries committed
816
  }
Dries's avatar
 
Dries committed
817
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries's avatar
 
Dries committed
818 819
}

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

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
843 844
    }
  }
Dries's avatar
 
Dries committed
845
  return $output ? $output : t('0 sec');
Dries's avatar
 
Dries committed
846 847
}

Dries's avatar
 
Dries committed
848
/**
Dries's avatar
 
Dries committed
849 850
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
 
Dries committed
851 852 853 854
 * 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
855 856 857 858 859 860
 * @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
861 862 863
 *   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
864 865 866 867
 * @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
868
 */
869 870 871
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
872 873 874 875 876 877
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
878
  }
Dries's avatar
 
Dries committed
879

880
  $timestamp += $timezone;
Dries's avatar
 
Dries committed
881 882

  switch ($type) {
883 884
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
 
Dries committed
885
      break;
886 887
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
 
Dries committed
888
      break;
889
    case 'custom':
Dries's avatar
 
Dries committed
890
      // No change to format
Dries's avatar
 
Dries committed
891
      break;
892
    case 'medium':
Dries's avatar
 
Dries committed
893
    default:
894
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
 
Dries committed
895 896
  }

897
  $max = strlen($format);
Dries's avatar
 
Dries committed
898
  $date = '';
Dries's avatar
 
Dries committed
899 900
  for ($i = 0; $i < $max; $i++) {
    $c = $format{$i};
901
    if (strpos('AaDFlM', $c) !== false) {
902
      $date .= t(gmdate($c, $timestamp));
903
    }
904
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
905 906 907 908
      $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
909
    }
910 911 912 913 914
    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
915
    }
916 917 918
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries's avatar
 
Dries committed
919
    else {
920
      $date .= $c;
Dries's avatar
 
Dries committed
921
    }
Dries's avatar
 
Dries committed
922
  }
923

Dries's avatar
 
Dries committed
924 925 926
  return $date;
}

Dries's avatar
 
Dries committed
927
/**
Dries's avatar
 
Dries committed
928
 * Format a username.
Dries's avatar
 
Dries committed
929
 *
Dries's avatar
 
Dries committed
930 931 932 933 934
 * @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
935
 */
Dries's avatar
 
Dries committed
936 937 938
function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
 
Dries committed
939
    // Shorten the name when it is too long or it will break many tables.
Dries's avatar
Dries committed
940
    if (strlen($object->name) > 20) {
Dries's avatar
 
Dries committed
941
      $name = truncate_utf8($object->name, 15) .'...';
Dries's avatar
Dries committed
942 943 944 945 946
    }
    else {
      $name = $object->name;
    }

947 948 949 950 951 952
    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
953
  }
Dries's avatar
 
Dries committed
954
  else if ($object->name) {
Dries's avatar
 
Dries committed
955 956 957 958
    // 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
959
    if ($object->homepage) {
Dries's avatar
 
Dries committed
960
      $output = '<a href="'. $object->homepage .'">'. $object->name .'</a>';
Dries's avatar
 
Dries committed
961 962 963 964 965 966
    }
    else {
      $output = $object->name;
    }

    $output .= ' ('. t('not verified') .')';
Dries's avatar
 
Dries committed
967
  }
Dries's avatar
 
Dries committed
968
  else {
Dries's avatar
Dries committed
969
    $output = variable_get('anonymous', 'Anonymous');
Dries's avatar
 
Dries committed
970 971
  }

Dries's avatar
 
Dries committed
972
  return $output;
Dries's avatar
 
Dries committed
973
}
Dries's avatar
 
Dries committed
974 975 976
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
977

Kjartan's avatar
Kjartan committed
978
/**
Dries's avatar
 
Dries committed
979
 * @defgroup form Form generation
Kjartan's avatar
Kjartan committed
980
 * @{
Dries's avatar
 
Dries committed
981
 * Functions to enable output of HTML forms and form elements.
982
 *
Dries's avatar
 
Dries committed
983 984
 * 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
985
 * must be explicitly generated by modules.
Kjartan's avatar
Kjartan committed
986
 */
Dries's avatar
 
Dries committed
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002

/**
 * 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
1003
  if (!$action) {
1004
    $action = request_uri();
Dries's avatar
 
Dries committed
1005
  }
1006
  return '<form action="'. check_url($action) .'" method="'. $method .'"'. drupal_attributes($attributes) .">\n". $form ."\n</form>\n";
Dries's avatar
 
Dries committed
1007 1008
}

Dries's avatar
 
Dries committed
1009
/**
Dries's avatar
 
Dries committed
1010
 * File an error against the form element with the specified name.
Dries's avatar
 
Dries committed
1011 1012 1013 1014 1015 1016 1017
 */
function form_set_error($name, $message) {
  $GLOBALS['form'][$name] = $message;
  drupal_set_message($message, 'error');
}

/**
Dries's avatar
 
Dries committed
1018
 * Return an associative array of all errors.
Dries's avatar
 
Dries committed
1019
 */
Dries's avatar
 
Dries committed
1020
function form_get_errors() {
1021 1022 1023
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'];
  }
Dries's avatar
 
Dries committed
1024 1025 1026 1027 1028 1029
}

/**
 * Return the error message filed against the form with the specified name.
 */
function _form_get_error($name) {
Dries's avatar
 
Dries committed
1030 1031 1032
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'][$name];
  }
Dries's avatar
 
Dries committed
1033 1034 1035 1036 1037 1038
}

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

Dries's avatar
 
Dries committed
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
/**
 * 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
1057
function form_item($title, $value, $description = NULL, $id = NULL, $required = FALSE, $error = FALSE) {
Dries's avatar
 
Dries committed
1058
  return theme('form_element', $title, $value, $description, $id, $required, $error);
Dries's avatar
 
Dries committed
1059
}
Dries's avatar
 
Dries committed
1060

Dries's avatar
 
Dries committed
1061 1062 1063 1064 1065 1066 1067 1068 1069
/**
 * 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.
1070 1071
 * @param $attributes
 *   An associative array of HTML attributes to add to the fieldset tag.
Dries's avatar
 
Dries committed
1072 1073 1074
 * @return
 *   A themed HTML string representing the form item group.
 */
1075 1076
function form_group($legend, $group, $description = NULL, $attributes = NULL) {
  return '<fieldset' . drupal_attributes($attributes) .'>' . ($legend ? '<legend>'. $legend .'</legend>' : '') . $group . ($description ? '<div class="description">'. $description .'</div>' : '') . "</fieldset>\n";
Dries's avatar
 
Dries committed
1077
}
Dries's avatar
 
Dries committed
1078

Dries's avatar
 
Dries committed
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
/**
 * 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) .' />';
1101
  if (!is_null($title)) {
Dries's avatar
 
Dries committed
1102
    $element = '<label class="option">'. $element .' '. $title .'</label>';
1103
  }
Dries's avatar
 
Dries committed
1104
  return theme('form_element', NULL, $element, $description, $name, $required, _form_get_error($name));
Dries's avatar
 
Dries committed
1105 1106
}

Dries's avatar
 
Dries committed
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127
/**
 * 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.
 */
1128
function form_radios($title, $name, $value, $options, $description = NULL, $required = FALSE, $attributes = NULL) {
Dries's avatar
 
Dries committed
1129
  if (count($options) > 0) {
Dries's avatar
 
Dries committed
1130
    $choices = '';
Dries's avatar
 
Dries committed
1131
    foreach ($options as $key => $choice) {
1132
      $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
1133
    }
1134
    return theme('form_element', $title, $choices, $description, NULL, $required, _form_get_error($name));
Dries's avatar
 
Dries committed
1135
  }
Dries's avatar
 
Dries committed
1136 1137
}

Dries's avatar
 
Dries committed
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
/**
 * 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-'