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

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

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

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

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

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

  return $breadcrumb;
}

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

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

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

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

  return $output . drupal_set_html_head();
}

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

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

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

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

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

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

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

Kjartan's avatar
Kjartan committed
136
/**
Dries's avatar
   
Dries committed
137
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
138
 *
Dries's avatar
   
Dries committed
139
140
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
141
 *
142
143
144
145
146
147
148
149
150
151
 * Usually the redirected URL is constructed from this function's input
 * parameters.  However you may override that behavior by setting a
 * <em>destination</em> in either the $_REQUEST-array (i.e. by using
 * the query string of an URI) or the $_REQUEST['edit']-array (i.e. by
 * using a hidden form field).  This is used to direct the user back to
 * the proper page after completing a form.  For example, after editing
 * a post on the 'admin/node'-page or after having logged on using the
 * 'user login'-block in a sidebar.  The function drupal_get_destination()
 * can be used to help set the destination URL.
 *
Dries's avatar
   
Dries committed
152
153
154
155
156
157
158
159
160
161
162
163
164
 * It is advised to use drupal_goto() instead of PHP's header(), because
 * drupal_goto() will append the user's session ID to the URI when PHP is
 * compiled with "--enable-trans-sid".
 *
 * This function ends the request; use it rather than a print theme('page')
 * statement in your menu callback.
 *
 * @param $path
 *   A Drupal path.
 * @param $query
 *   The query string component, if any.
 * @param $fragment
 *   The destination fragment identifier (named anchor).
165
166
 *
 * @see drupal_get_destination()
Kjartan's avatar
Kjartan committed
167
 */
Dries's avatar
   
Dries committed
168
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
169
170
171
172
173
174
175
  if ($_REQUEST['destination']) {
    extract(parse_url($_REQUEST['destination']));
  }
  else if ($_REQUEST['edit']['destination']) {
    extract(parse_url($_REQUEST['edit']['destination']));
  }

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

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

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

Dries's avatar
   
Dries committed
189
190
191
192
  // Before the redirect, allow modules to react to the end of the page request.
  module_invoke_all('exit', $url);

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

Dries's avatar
   
Dries committed
194
195
196
  // The "Location" header sends a REDIRECT status code to the http
  // daemon. In some cases this can go wrong, so we make sure none
  // of the code below the drupal_goto() call gets executed when we redirect.
Kjartan's avatar
Kjartan committed
197
198
199
200
201
202
  exit();
}

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

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

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

Dries's avatar
   
Dries committed
220
221
222
223
224
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
  header('HTTP/1.0 403 Forbidden');
225
  watchdog('access denied', t('%page denied access.', array('%page' => theme('placeholder', $_GET['q']))), WATCHDOG_WARNING, l(t('view'), $_GET['q']));
Dries's avatar
   
Dries committed
226
227

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

234
  if (empty($return)) {
235
    drupal_set_title(t('Access denied'));
236
    $return = message_access();
Dries's avatar
   
Dries committed
237
  }
238
  print theme('page', $return);
Dries's avatar
   
Dries committed
239
240
}

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

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

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

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

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

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

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

  fwrite($fp, $request);

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

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

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

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

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

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

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

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

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

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

  return $object;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return $output;
}

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

  return $output;
}

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

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

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

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

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

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

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

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

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

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

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

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

931
932
933
934
935
936
    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
937
  }
Dries's avatar
   
Dries committed
938
  else if ($object->name) {
Dries's avatar
   
Dries committed
939
940
941
942
    // 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
943
    if ($object->homepage) {
Dries's avatar
   
Dries committed
944
      $output = '<a href="'. $object->homepage .'">'. $object->name .'</a>';
Dries's avatar
   
Dries committed
945
946
947
948
949
950
    }
    else {
      $output = $object->name;
    }

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

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

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

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

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

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

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

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

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

Dries's avatar
   
Dries committed
1045
1046
1047
1048
1049
1050
1051
1052
1053
/**
 * 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.
1054
1055
 * @param $attributes
 *   An associative array of HTML attributes to add to the fieldset tag.
Dries's avatar
   
Dries committed
1056
1057
1058
 * @return
 *   A themed HTML string representing the form item group.
 */
1059
1060
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
1061
}
Dries's avatar
   
Dries committed
1062

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

Dries's avatar
   
Dries committed
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
/**
 * 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.
 */
1112
function form_radios($title, $name, $value, $options, $description = NULL, $required = FALSE, $attributes = NULL) {