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

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

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

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

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

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

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

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

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

  return $breadcrumb;
}

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

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

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

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

  return $output . drupal_set_html_head();
}

Dries's avatar
   
Dries committed
82
83
84
/**
 * Regenerate the path map from the information in the database.
 */
Dries's avatar
   
Dries committed
85
function drupal_rebuild_path_map() {
Dries's avatar
   
Dries committed
86
  drupal_get_path_map('rebuild');
Dries's avatar
   
Dries committed
87
}
Kjartan's avatar
Kjartan committed
88

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  fwrite($fp, $request);

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

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

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

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

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

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

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

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

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

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

  return $object;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return $output;
}

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

  return $output;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Dries's avatar
   
Dries committed
1060
1061
1062
1063
1064
1065
1066
1067
1068
/**
 * 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.
1069
1070
 * @param $attributes
 *   An associative array of HTML attributes to add to the fieldset tag.
Dries's avatar
   
Dries committed
1071
1072
1073
 * @return
 *   A themed HTML string representing the form item group.
 */
1074
1075
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
1076
}
Dries's avatar
   
Dries committed
1077

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

Dries's avatar
   
Dries committed
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121