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

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

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

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

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

27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
/**
 * Set content for a specified region.
 *
 * @param $region
 *   Page region the content is assigned to.
 *
 * @param $data
 *   Content to be set.
 */
function drupal_set_content($region = null, $data = null) {
  static $content = array();

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

/**
 * Get assigned content.
 *
 * @param $region
 *   A specified region to fetch content for.  If null, all regions will be returned.
 *
 * @param $delimiter
 *   Content to be inserted between exploded array elements.
 */
function drupal_get_content($region = null, $delimiter = ' ') {
  $content = drupal_set_content();
  if (isset($region)) {
    if (is_array($content[$region])) {
      return implode ($delimiter, $content[$region]);
    }
  }
  else {
    foreach (array_keys($content) as $region) {
      if (is_array($content[$region])) {
        $content[$region] = implode ($delimiter, $content[$region]);
      }
    }
    return $content;
  }
}

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

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

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

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

  return $breadcrumb;
}

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

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

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

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

  return $output . drupal_set_html_head();
}

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

Dries's avatar
 
Dries committed
133
/**
Dries's avatar
 
Dries committed
134
 * Given a path alias, return the internal path it represents.
Dries's avatar
 
Dries committed
135 136
 */
function drupal_get_normal_path($path) {
137 138 139
  //drupal_get_path_alias($path);
  if ($src = drupal_lookup_path('alias', $path)) {
    return $src;
Dries's avatar
 
Dries committed
140
  }
Dries's avatar
 
Dries committed
141
  elseif (function_exists('conf_url_rewrite')) {
Dries's avatar
 
Dries committed
142 143 144 145 146 147
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
Kjartan's avatar
Kjartan committed
148

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

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

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

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

178 179
/**
 * Prepare a destination query string for use in combination with
180 181 182 183 184
 * drupal_goto(). Used to direct the user back to the referring page
 * after completing a form. By default the current URL is returned.
 * If a destination exists in the previous request, that destination
 * is returned.  As such, a destination can persist across multiple
 * pages.
185 186 187 188
 *
 * @see drupal_goto()
 */
function drupal_get_destination() {
189 190 191 192 193 194 195 196 197 198
  if ($_REQUEST['destination']) {
    return 'destination='. urlencode($_REQUEST['destination']);
  }
  else {
    $destination[] = $_GET['q'];
    $params = array('page', 'sort', 'order');
    foreach ($params as $param) {
      if (isset($_GET[$param])) {
        $destination[] = "$param=". $_GET[$param];
      }
199
    }
200
    return 'destination='. urlencode(implode('&', $destination));
201 202 203
  }
}

Kjartan's avatar
Kjartan committed
204
/**
Dries's avatar
 
Dries committed
205
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
206
 *
Dries's avatar
 
Dries committed
207 208
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
209
 *
210 211 212 213 214 215 216 217 218 219
 * 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
220 221 222 223 224 225 226 227 228 229 230 231 232
 * 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).
233 234
 *
 * @see drupal_get_destination()
Kjartan's avatar
Kjartan committed
235
 */
Dries's avatar
 
Dries committed
236
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
237 238 239 240 241 242 243
  if ($_REQUEST['destination']) {
    extract(parse_url($_REQUEST['destination']));
  }
  else if ($_REQUEST['edit']['destination']) {
    extract(parse_url($_REQUEST['edit']['destination']));
  }

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

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

Dries's avatar
 
Dries committed
249 250
    if (strstr($url, '?') && !strstr($url, $sid)) {
      $url = $url .'&'. $sid;
Kjartan's avatar
Kjartan committed
251 252
    }
    else {
Dries's avatar
 
Dries committed
253
      $url = $url .'?'. $sid;
Kjartan's avatar
Kjartan committed
254 255 256
    }
  }

Dries's avatar
 
Dries committed
257 258 259 260
  // 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
261

Dries's avatar
 
Dries committed
262 263 264
  // 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
265 266 267 268 269 270
  exit();
}

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

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries's avatar
 
Dries committed
276
  $status = MENU_NOT_FOUND;
Dries's avatar
 
Dries committed
277 278
  if ($path) {
    menu_set_active_item($path);
279
    $return = menu_execute_active_handler();
Dries's avatar
 
Dries committed
280 281
  }

282
  if (empty($return)) {
283
    drupal_set_title(t('Page not found'));
Dries's avatar
 
Dries committed
284
  }
285
  print theme('page', $return);
Dries's avatar
 
Dries committed
286
}
Dries's avatar
 
Dries committed
287

Dries's avatar
 
Dries committed
288 289 290 291 292
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
  header('HTTP/1.0 403 Forbidden');
293
  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
294 295

  $path = drupal_get_normal_path(variable_get('site_403', ''));
Dries's avatar
 
Dries committed
296
  $status = MENU_NOT_FOUND;
Dries's avatar
 
Dries committed
297 298
  if ($path) {
    menu_set_active_item($path);
299
    $return = menu_execute_active_handler();
Dries's avatar
 
Dries committed
300 301
  }

302
  if (empty($return)) {
303
    drupal_set_title(t('Access denied'));
304
    $return = t('You are not authorized to access this page.');
Dries's avatar
 
Dries committed
305
  }
306
  print theme('page', $return);
Dries's avatar
 
Dries committed
307 308
}

Dries's avatar
 
Dries committed
309
/**
Dries's avatar
 
Dries committed
310
 * Perform an HTTP request.
Dries's avatar
 
Dries committed
311
 *
Dries's avatar
 
Dries committed
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
 * 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
329 330
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
 
Dries committed
331 332
  $result = new StdClass();

Dries's avatar
 
Dries committed
333
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
 
Dries committed
334 335 336 337 338 339
  $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
340 341
      // 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
342 343
      break;
    default:
Dries's avatar
 
Dries committed
344
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
 
Dries committed
345 346 347
      return $result;
  }

Dries's avatar
 
Dries committed
348
  // Make sure the socket opened properly.
Dries's avatar
 
Dries committed
349
  if (!$fp) {
Dries's avatar
 
Dries committed
350
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
 
Dries committed
351 352 353
    return $result;
  }

Dries's avatar
 
Dries committed
354
  // Construct the path to act on.
Dries's avatar
 
Dries committed
355 356
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
Dries's avatar
 
Dries committed
357
    $path .= '?'. $uri['query'];
Dries's avatar
 
Dries committed
358 359
  }

Dries's avatar
 
Dries committed
360
  // Create HTTP request.
Dries's avatar
 
Dries committed
361
  $defaults = array(
Dries's avatar
 
Dries committed
362
    'Host' => 'Host: '. $uri['host'],
363 364
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
 
Dries committed
365 366 367
  );

  foreach ($headers as $header => $value) {
Dries's avatar
 
Dries committed
368
    $defaults[$header] = $header .': '. $value;
Dries's avatar
 
Dries committed
369 370
  }

Dries's avatar
 
Dries committed
371
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
 
Dries committed
372 373 374
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
 
Dries committed
375
    $request .= $data ."\r\n";
Dries's avatar
 
Dries committed
376 377 378 379 380 381
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
382
  $response = '';
383
  while (!feof($fp) && $data = fread($fp, 1024)) {
384
    $response .= $data;
Dries's avatar
 
Dries committed
385 386 387 388
  }
  fclose($fp);

  // Parse response.
389 390 391 392
  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
393 394 395
  $result->headers = array();

  // Parse headers.
396
  while ($line = trim(array_shift($headers))) {
Dries's avatar
 
Dries committed
397
    list($header, $value) = explode(':', $line, 2);
398 399 400 401 402 403 404 405
    if (isset($result->headers[$header]) && $header == 'Set-Cookie') {
      // RFC 2109: the Set-Cookie response header comprises the token Set-
      // Cookie:, followed by a comma-separated list of one or more cookies.
      $result->headers[$header] .= ','. trim($value);
    }
    else {
      $result->headers[$header] = trim($value);
    }
Dries's avatar
 
Dries committed
406 407 408 409 410 411 412 413 414 415
  }

  $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
416
  // the base code in their class.
Dries's avatar
 
Dries committed
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
  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
444 445 446
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
 
Dries committed
447

Dries's avatar
 
Dries committed
448
/**
Dries's avatar
 
Dries committed
449 450 451 452
 * 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
453
 */
Dries's avatar
 
Dries committed
454
function error_handler($errno, $message, $filename, $line) {
455
  if ($errno & (E_ALL ^ E_NOTICE)) {
Dries's avatar
 
Dries committed
456 457
    $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
458

Dries's avatar
 
Dries committed
459
    if (variable_get('error_level', 1) == 1) {
Dries's avatar
 
Dries committed
460
      print '<pre>'. $entry .'</pre>';
Dries's avatar
Dries committed
461
    }
462 463

    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
464 465 466
  }
}

Dries's avatar
 
Dries committed
467
function _fix_gpc_magic(&$item) {
Dries's avatar
Dries committed
468
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
469 470 471
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
472
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
473 474 475
  }
}

Dries's avatar
 
Dries committed
476 477 478 479
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
 
Dries committed
480 481
function fix_gpc_magic() {
  static $fixed = false;
Dries's avatar
 
Dries committed
482
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
483 484 485 486 487 488
    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
489 490
}

491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
/**
 * An unchecked checkbox is not present in $_POST so we fix it here by
 * proving a default value of 0.  Also, with form_checkboxes() we expect
 * an array, but HTML does not send the empty array.  This is also taken
 * care off.
 */
function fix_checkboxes() {
  if (isset($_POST['form_array'])) {
    $_POST['edit'] = _fix_checkboxes($_POST['edit'], $_POST['form_array'], array());
  }
  if (isset($_POST['form_zero'])) {
    $_POST['edit'] = _fix_checkboxes($_POST['edit'], $_POST['form_zero'], 0);
  }
}

function _fix_checkboxes($array1, $array2, $value) {
  if (is_array($array2) && count($array2)) {
    foreach ($array2 as $k => $v) {
      if (is_array($v) && count($v)) {
        $array1[$k] = _fix_checkboxes($array1[$k], $v, $value);
      }
      else if (!isset($array1[$k])) {
        $array1[$k] = $value;
      }
    }
  }
  else {
    $array1 = $value;
  }
  return $array1;
}

Kjartan's avatar
Kjartan committed
523 524 525
/**
 * @name Conversion
 * @{
Dries's avatar
 
Dries committed
526
 * Converts data structures to different types.
Kjartan's avatar
Kjartan committed
527
 */
Dries's avatar
 
Dries committed
528 529 530 531

/**
 * Convert an associative array to an anonymous object.
 */
Dries's avatar
Dries committed
532 533
function array2object($array) {
  if (is_array($array)) {
Dries's avatar
 
Dries committed
534
    $object = new StdClass();
Dries's avatar
Dries committed
535
    foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
536 537 538 539
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
540
    $object = $array;
Dries's avatar
 
Dries committed
541 542 543 544 545
  }

  return $object;
}

Dries's avatar
 
Dries committed
546 547 548
/**
 * Convert an object to an associative array.
 */
Dries's avatar
Dries committed
549 550 551
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
 
Dries committed
552 553 554 555
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
556
    $array = $object;
Dries's avatar
 
Dries committed
557 558 559 560
  }

  return $array;
}
Dries's avatar
 
Dries committed
561 562 563 564

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

Kjartan's avatar
Kjartan committed
566 567 568
/**
 * @name Messages
 * @{
Dries's avatar
 
Dries committed
569
 * Frequently used messages.
Kjartan's avatar
Kjartan committed
570
 */
Dries's avatar
 
Dries committed
571 572 573 574

/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
 
Dries committed
575
function message_na() {
Dries's avatar
 
Dries committed
576
  return t('n/a');
Dries's avatar
 
Dries committed
577 578
}

Dries's avatar
 
Dries committed
579 580 581
/**
 * @} End of "Messages".
 */
Dries's avatar
 
Dries committed
582

Dries's avatar
 
Dries committed
583 584 585
/**
 * Initialize the localization system.
 */
Dries's avatar
 
Dries committed
586 587
function locale_initialize() {
  global $user;
Dries's avatar
 
Dries committed
588 589 590 591 592

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

Dries's avatar
 
Dries committed
593 594 595 596 597
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
598 599 600
    // 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
601
  }
Dries's avatar
 
Dries committed
602 603 604 605 606 607
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
608 609
}

Kjartan's avatar
Kjartan committed
610
/**
Dries's avatar
 
Dries committed
611
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
612
 *
613
 * When using t(), try to put entire sentences and strings in one t() call.
Dries's avatar
 
Dries committed
614 615 616 617
 * 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
618 619 620
 *   $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
621
 * @endcode
622 623 624
 * 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
625
 *
Dries's avatar
 
Dries committed
626
 * @param $string
Dries's avatar
 
Dries committed
627
 *   A string containing the English string to translate.
Dries's avatar
 
Dries committed
628 629
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
 
Dries committed
630
 *   of any key in this array are replaced with the corresponding value.
Dries's avatar
 
Dries committed
631 632
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
633
 */
Dries's avatar
 
Dries committed
634
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
635 636 637 638
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
639

Dries's avatar
 
Dries committed
640 641
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
642 643
  }
  else {
Dries's avatar
 
Dries committed
644 645
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
646 647
}

Dries's avatar
 
Dries committed
648
/**
649
 * Encode special characters in a plain-text string for display as HTML.
Dries's avatar
 
Dries committed
650
 */
651
function check_plain($text) {
652
  return htmlspecialchars($text);
Dries's avatar
 
Dries committed
653 654
}

Kjartan's avatar
Kjartan committed
655
/**
Dries's avatar
 
Dries committed
656
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
657
 * @{
Dries's avatar
 
Dries committed
658
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
659 660
 */

661
/**
Dries's avatar
 
Dries committed
662 663 664
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
665
 *
Dries's avatar
 
Dries committed
666 667
 * @param $mail
 *   A string containing an email address.
Dries's avatar
 
Dries committed
668
 * @return
Dries's avatar
 
Dries committed
669
 *   TRUE if the address is in a valid format.
670
 */
Dries's avatar
 
Dries committed
671
function valid_email_address($mail) {
672
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
673
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
674 675 676
  $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
677
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
678 679
}

Dries's avatar
 
Dries committed
680 681 682
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
 
Dries committed
683
 * @param $url
Dries's avatar
 
Dries committed
684
 *   The URL to verify.
Dries's avatar
 
Dries committed
685
 * @param $absolute
Dries's avatar
 
Dries committed
686
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries's avatar
 
Dries committed
687
 * @return
Dries's avatar
 
Dries committed
688
 *   TRUE if the URL is in a valid format.
Dries's avatar
 
Dries committed
689
 */
Dries's avatar
 
Dries committed
690
function valid_url($url, $absolute = FALSE) {
691
  $allowed_characters = '[a-z0-9\/:_\-_\.\?\$,~=#&%\+]';
692
  if ($absolute) {
693
    return preg_match("/^(http|https|ftp):\/\/". $allowed_characters ."+$/i", $url);
694 695
  }
  else {
696
    return preg_match("/^". $allowed_characters ."+$/i", $url);
697
  }
Dries's avatar
 
Dries committed
698 699
}

Dries's avatar
 
Dries committed
700 701 702 703 704 705 706 707 708 709
/**
 * 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
710 711
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
Dries's avatar
 
Dries committed
712
    // Form data can contain a number of nested arrays.
Kjartan's avatar
Kjartan committed
713
    foreach ($data as $key => $value) {
Dries's avatar
 
Dries committed
714
      if (!valid_input_data($key) || !valid_input_data($value)) {
Dries's avatar
 
Dries committed
715
        return FALSE;
Kjartan's avatar
Kjartan committed
716 717 718
      }
    }
  }
Dries's avatar
Dries committed
719
  else if (isset($data)) {
Dries's avatar
 
Dries committed
720
    // Detect dangerous input data.
Kjartan's avatar
Kjartan committed
721

722 723 724
    // Decode all normal character entities.
    $data = decode_entities($data, array('<', '&', '"'));

Dries's avatar
 
Dries committed
725 726 727 728
    // 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
729

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

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

    if ($match) {
737
      watchdog('security', t('Terminated request because of suspicious input data: %data.', array('%data' => theme('placeholder', $data))));
Dries's avatar
 
Dries committed
738
      return FALSE;
Kjartan's avatar
Kjartan committed
739 740 741
    }
  }

Dries's avatar
 
Dries committed
742
  return TRUE;
Kjartan's avatar
Kjartan committed
743
}
Dries's avatar
 
Dries committed
744 745 746
/**
 * @} End of "defgroup validation".
 */
Kjartan's avatar
Kjartan committed
747

Dries's avatar
 
Dries committed
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
/**
 * 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);
}

775 776
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
777 778
}

Dries's avatar
 
Dries committed
779
/**
Dries's avatar
 
Dries committed
780
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
781
 * @{
Dries's avatar
 
Dries committed
782
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
783 784
 */

Dries's avatar
 
Dries committed
785 786 787 788 789 790
/**
 * 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
791 792
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
793
  $output = "<channel>\n";
794 795 796 797
  $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
798
  foreach ($args as $key => $value) {
799
    $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
 
Dries committed
800
  }
Dries's avatar
 
Dries committed
801 802 803 804 805 806
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
 
Dries committed
807 808 809 810 811
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
 
Dries committed
812
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
813
  $output = "<item>\n";
814 815 816
  $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
817
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
    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 {
834
      $output .= ' <'. $key .'>'. check_plain($value) ."</$key>\n";
Dries's avatar
 
Dries committed
835
    }
Dries's avatar
 
Dries committed
836
  }
Dries's avatar
 
Dries committed
837 838 839 840 841
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
842
/**
Dries's avatar
 
Dries committed
843
 * Format a string containing a count of items.
Dries's avatar
 
Dries committed
844
 *
Dries's avatar
 
Dries committed
845 846 847 848 849 850 851 852 853 854 855 856 857 858
 * 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
859
 */
Dries's avatar
 
Dries committed
860
function format_plural($count, $singular, $plural) {
861
  if ($count == 1) return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
862 863

  // get the plural index through the gettext formula
864
  $index = (function_exists('locale_get_plural')) ? locale_get_plural($count) : -1;
Dries's avatar
 
Dries committed
865 866 867 868 869 870
  if ($index < 0) { // backward compatibility
    return t($plural, array("%count" => $count));
  }
  else {
    switch ($index) {
      case "0":
871
        return t($singular, array("%count" => $count));
Dries's avatar
 
Dries committed
872 873 874 875 876 877
      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
878 879
}

Dries's avatar
 
Dries committed
880
/**
Dries's avatar
 
Dries committed
881
 * Generate a string representation for the given byte count.
Dries's avatar
 
Dries committed
882
 *
Dries's avatar
 
Dries committed
883 884 885 886
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
887
 */
Dries's avatar
 
Dries committed
888
function format_size($size) {
Dries's avatar
 
Dries committed
889
  $suffix = t('bytes');
890
  if ($size >= 1024) {
Dries's avatar
 
Dries committed
891
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
892
    $suffix = t('KB');
Dries's avatar
 
Dries committed
893
  }
894
  if ($size >= 1024) {
Dries's avatar
 
Dries committed
895
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
896
    $suffix = t('MB');
Dries's avatar
 
Dries committed
897
  }
Dries's avatar
 
Dries committed
898
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries's avatar
 
Dries committed
899 900
}

Dries's avatar
 
Dries committed
901
/**
Dries's avatar
 
Dries committed
902
 * Format a time interval with the requested granularity.
Dries's avatar
 
Dries committed
903
 *
Dries's avatar
 
Dries committed
904 905 906 907 908 909
 * @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
910
 */
Dries's avatar
 
Dries committed
911
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
 
Dries committed
912
  $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
913
  $output = '';
Dries's avatar
 
Dries committed
914
  foreach ($units as $key => $value) {
Dries's avatar
 
Dries committed
915
    $key = explode('|', $key);
Dries's avatar
 
Dries committed
916
    if ($timestamp >= $value) {
Dries's avatar
 
Dries committed
917
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
 
Dries committed
918
      $timestamp %= $value;
Dries's avatar
 
Dries committed
919 920 921 922 923
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
924 925
    }
  }
Dries's avatar
 
Dries committed
926
  return $output ? $output : t('0 sec');
Dries's avatar
 
Dries committed
927 928
}

Dries's avatar
 
Dries committed
929
/**
Dries's avatar
 
Dries committed
930 931
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
 
Dries committed
932 933 934 935
 * 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
936 937 938 939 940 941
 * @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
942 943 944
 *   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
945 946 947 948
 * @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
949
 */
950 951 952
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
953 954 955 956 957 958
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
959
  }
Dries's avatar
 
Dries committed
960

961
  $timestamp += $timezone;
Dries's avatar
 
Dries committed
962 963

  switch ($type) {
964 965
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
 
Dries committed
966
      break;
967 968
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
 
Dries committed
969
      break;
970
    case 'custom':
Dries's avatar
 
Dries committed
971
      // No change to format
Dries's avatar
 
Dries committed
972
      break;
973
    case 'medium':
Dries's avatar
 
Dries committed
974
    default:
975
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
 
Dries committed
976 977
  }

978
  $max = strlen($format);
Dries's avatar
 
Dries committed
979
  $date = '';
Dries's avatar
 
Dries committed
980 981
  for ($i = 0; $i < $max; $i++) {
    $c = $format{$i};
982
    if (strpos('AaDFlM', $c) !== false) {
983
      $date .= t(gmdate($c, $timestamp));
984
    }
985
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
986 987 988 989
      $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
990
    }
991 992 993 994 995
    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
996
    }
997 998 999
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries's avatar
 
Dries committed
1000
    else {
1001
      $date .= $c;
Dries's avatar
 
Dries committed
1002
    }
Dries's avatar
 
Dries committed
1003
  }
1004

Dries's avatar
 
Dries committed
1005 1006 1007
  return $date;
}

Dries's avatar
 
Dries committed
1008 1009 1010
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
1011

Kjartan's avatar
Kjartan committed
1012
/**
Dries's avatar
 
Dries committed
1013
 * @defgroup form Form generation
Kjartan's avatar
Kjartan committed
1014
 * @{
Dries's avatar
 
Dries committed
1015
 * Functions to enable output of HTML forms and form elements.
1016
 *
Dries's avatar
 
Dries committed
1017 1018
 * 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
1019
 * must be explicitly generated by modules.
Kjartan's avatar
Kjartan committed
1020
 */
Dries's avatar
 
Dries committed
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036

/**
 * 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
1037
  if (!$action) {
1038
    $action = request_uri();
Dries's avatar
 
Dries committed
1039
  }
1040
  // Anonymous div to satisfy XHTML compliancy.
1041
  return '<form action="'. check_url($action) .'" method="'. $method .'"'. drupal_attributes($attributes) .">\n<div>". $form ."\n</div></form>\n";
Dries's avatar
 
Dries committed
1042 1043
}

Dries's avatar
 
Dries committed
1044
/**
Dries's avatar
 
Dries committed
1045
 * File an error against the form element with the specified name.
Dries's avatar
 
Dries committed
1046 1047 1048 1049 1050 1051 1052
 */
function form_set_error($name, $message) {
  $GLOBALS['form'][$name] = $message;
  drupal_set_message($message, 'error');
}

/**
Dries's avatar
 
Dries committed
1053
 * Return an associative array of all errors.
Dries's avatar
 
Dries committed
1054
 */
Dries's avatar
 
Dries committed
1055
function form_get_errors() {
1056 1057 1058
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'];
  }
Dries's avatar
 
Dries committed
1059 1060 1061 1062 1063 1064
}

/**
 * Return the error message filed against the form with the specified name.
 */
function _form_get_error($name) {
Dries's avatar
 
Dries committed
1065 1066 1067
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'][$name];
  }
Dries's avatar
 
Dries committed
1068 1069 1070 1071 1072 1073
}

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

Dries's avatar
 
Dries committed
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
/**
 * 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
1092
function form_item($title, $value, $description = NULL, $id = NULL, $required = FALSE, $error = FALSE) {
Dries's avatar
 
Dries committed
1093
  return theme('form_element', $title, $value, $description, $id, $required, $error);
Dries's avatar
 
Dries committed
1094
}
Dries's avatar
 
Dries committed
1095

Dries's avatar
 
Dries committed
1096 1097 1098 1099 1100 1101 1102 1103 1104
/**
 * 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.
1105 1106
 * @param $attributes
 *   An associative array of HTML attributes to add to the fieldset tag.
Dries's avatar
 
Dries committed
1107 1108 1109
 * @return
 *   A themed HTML string representing the form item group.
 */
1110 1111
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
1112
}
Dries's avatar
 
Dries committed
1113

1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
/**
 * 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 $collapsed
 *   A boolean value decided whether the group starts collapsed.
 * @param $description
 *   Explanatory text to display after the form item group.
 * @param $attributes
 *   An associative array of HTML attributes to add to the fieldset tag.
 * @return
 *   A themed HTML string representing the form item group.
 */
function form_group_collapsible($legend, $group, $collapsed = FALSE, $description = NULL, $attributes = NULL) {
  drupal_add_js('misc/collapse.js');

  $attributes['class'] .= ' collapsible';
  if ($collapsed) {
    $attributes['class'] .= ' collapsed';
  }

  return '<fieldset' . drupal_attributes($attributes) .'>' . ($legend ? '<legend>'. $legend .'</legend>' : '') . $group . ($description ? '<div class="description">'. $description .'</div>' : '') . "</fieldset>\n";
}

Dries's avatar
 
Dries committed
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
/**
 * 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) .' />';
1163
  if (!is_null($title)) {
Dries's avatar
 
Dries committed
1164
    $element = '<label class="option">'. $element .' '. $title .'</label>';
1165
  }
Dries's avatar
 
Dries committed
1166
  return theme('form_element', NULL, $element, $description, $name, $required, _form_get_error($name));
Dries's avatar
 
Dries committed
1167 1168
}

Dries's avatar
 
Dries committed
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
/**
 * 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.
 */
1190
function form_radios($title, $name, $value, $options, $description = NULL, $required = FALSE, $attributes = NULL) {
Dries's avatar
 
Dries committed
1191
  if (count($options) > 0) {
Dries's avatar
 
Dries committed
1192
    $choices = '';
Dries's avatar
 
Dries committed
1193
    foreach ($options as $key => $choice) {
1194
      $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
1195
    }
1196
    return theme('form_element', $title, $choices, $description, NULL, $required, _form_get_error($name));
Dries's avatar