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

Kjartan's avatar
Kjartan committed
118
/**
Dries's avatar
   
Dries committed
119
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
120
 *
Dries's avatar
   
Dries committed
121
122
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
123
 *
Dries's avatar
   
Dries committed
124
125
126
127
128
129
130
131
132
133
134
135
136
 * 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).
Kjartan's avatar
Kjartan committed
137
 */
Dries's avatar
   
Dries committed
138
139
140
function drupal_goto($path = '', $query = NULL, $fragment = NULL) {
  // Translate &amp; to simply & in the absolute URL.
  $url = str_replace('&amp;', '&', url($path, $query, $fragment, TRUE));
Kjartan's avatar
Kjartan committed
141

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

Dries's avatar
   
Dries committed
145
146
    if (strstr($url, '?') && !strstr($url, $sid)) {
      $url = $url .'&'. $sid;
Kjartan's avatar
Kjartan committed
147
148
    }
    else {
Dries's avatar
   
Dries committed
149
      $url = $url .'?'. $sid;
Kjartan's avatar
Kjartan committed
150
151
152
    }
  }

Dries's avatar
   
Dries committed
153
154
155
156
  // 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
157

Dries's avatar
   
Dries committed
158
159
160
  // 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
161
162
163
164
165
166
  exit();
}

/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
   
Dries committed
167
function drupal_not_found() {
Dries's avatar
   
Dries committed
168
  header('HTTP/1.0 404 Not Found');
169
  watchdog('page not found', t('%page not found.', array('%page' => '<em>'. db_escape_string($_GET['q']) .'</em>')));
Dries's avatar
   
Dries committed
170
171

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries's avatar
   
Dries committed
172
  $status = MENU_NOT_FOUND;
Dries's avatar
   
Dries committed
173
174
  if ($path) {
    menu_set_active_item($path);
Dries's avatar
   
Dries committed
175
    $status = menu_execute_active_handler();
Dries's avatar
   
Dries committed
176
177
  }

Dries's avatar
   
Dries committed
178
  if ($status != MENU_FOUND) {
Dries's avatar
Dries committed
179
    print theme('page', '', t('Page not found'));
Dries's avatar
   
Dries committed
180
181
  }
}
Dries's avatar
   
Dries committed
182

Dries's avatar
   
Dries committed
183
184
185
186
187
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
  header('HTTP/1.0 403 Forbidden');
188
  watchdog('access denied', t('%page denied access.', array('%page' => '<em>'. db_escape_string($_GET['q']) .'</em>')));
Dries's avatar
   
Dries committed
189
190

  $path = drupal_get_normal_path(variable_get('site_403', ''));
Dries's avatar
   
Dries committed
191
  $status = MENU_NOT_FOUND;
Dries's avatar
   
Dries committed
192
193
194
195
196
197
198
199
200
201
  if ($path) {
    menu_set_active_item($path);
    $status = menu_execute_active_handler();
  }

  if ($status != MENU_FOUND) {
    print theme('page', message_access(), t('Access denied'));
  }
}

Dries's avatar
   
Dries committed
202
/**
Dries's avatar
   
Dries committed
203
 * Perform an HTTP request.
Dries's avatar
   
Dries committed
204
 *
Dries's avatar
   
Dries committed
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 * 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
222
223
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
   
Dries committed
224
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
   
Dries committed
225
226
227
228
229
230
  $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
231
232
      // 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
233
234
      break;
    default:
Dries's avatar
   
Dries committed
235
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
   
Dries committed
236
237
238
      return $result;
  }

Dries's avatar
   
Dries committed
239
  // Make sure the socket opened properly.
Dries's avatar
   
Dries committed
240
  if (!$fp) {
Dries's avatar
   
Dries committed
241
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
   
Dries committed
242
243
244
    return $result;
  }

Dries's avatar
   
Dries committed
245
  // Construct the path to act on.
Dries's avatar
   
Dries committed
246
247
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
Dries's avatar
   
Dries committed
248
    $path .= '?'. $uri['query'];
Dries's avatar
   
Dries committed
249
250
  }

Dries's avatar
   
Dries committed
251
  // Create HTTP request.
Dries's avatar
   
Dries committed
252
  $defaults = array(
Dries's avatar
   
Dries committed
253
    'Host' => 'Host: '. $uri['host'],
254
255
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
   
Dries committed
256
257
258
  );

  foreach ($headers as $header => $value) {
Dries's avatar
   
Dries committed
259
    $defaults[$header] = $header .': '. $value;
Dries's avatar
   
Dries committed
260
261
  }

Dries's avatar
   
Dries committed
262
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
   
Dries committed
263
264
265
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
   
Dries committed
266
    $request .= $data ."\r\n";
Dries's avatar
   
Dries committed
267
268
269
270
271
272
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
273
  $response = '';
274
  while (!feof($fp) && $data = fread($fp, 1024)) {
275
    $response .= $data;
Dries's avatar
   
Dries committed
276
277
278
279
  }
  fclose($fp);

  // Parse response.
280
281
282
283
  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
284
285
286
  $result->headers = array();

  // Parse headers.
287
  while ($line = trim(array_shift($headers))) {
Dries's avatar
   
Dries committed
288
289
290
291
292
293
294
295
296
297
298
299
    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
300
  // the base code in their class.
Dries's avatar
   
Dries committed
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
  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
328
329
330
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
   
Dries committed
331

Dries's avatar
   
Dries committed
332
/**
Dries's avatar
   
Dries committed
333
334
335
336
 * 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
337
 */
Dries's avatar
   
Dries committed
338
function error_handler($errno, $message, $filename, $line, $variables) {
Dries's avatar
   
Dries committed
339
340
341
  if ($errno & E_ALL ^ E_NOTICE) {
    $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
342

343
    watchdog('error', t('%message in %file on line %line.', array('%error' => $types[$errno], '%message' => $message, '%file' => $filename, '%line' => $line)));
Dries's avatar
   
Dries committed
344
345

    if (variable_get('error_level', 1) == 1) {
Dries's avatar
   
Dries committed
346
      print '<pre>'. $entry .'</pre>';
Dries's avatar
Dries committed
347
    }
Dries's avatar
   
Dries committed
348
349
350
  }
}

Dries's avatar
Dries committed
351
352
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
353
354
355
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
356
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
357
358
359
  }
}

Dries's avatar
   
Dries committed
360
361
362
363
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
   
Dries committed
364
365
function fix_gpc_magic() {
  static $fixed = false;
Dries's avatar
   
Dries committed
366
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
367
368
369
370
371
372
    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
373
374
}

Kjartan's avatar
Kjartan committed
375
376
377
/**
 * @name Conversion
 * @{
Dries's avatar
   
Dries committed
378
 * Converts data structures to different types.
Kjartan's avatar
Kjartan committed
379
 */
Dries's avatar
   
Dries committed
380
381
382
383

/**
 * Convert an associative array to an anonymous object.
 */
Dries's avatar
Dries committed
384
385
function array2object($array) {
  if (is_array($array)) {
386
    $object = new stdClass();
Dries's avatar
Dries committed
387
    foreach ($array as $key => $value) {
Dries's avatar
   
Dries committed
388
389
390
391
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
392
    $object = $array;
Dries's avatar
   
Dries committed
393
394
395
396
397
  }

  return $object;
}

Dries's avatar
   
Dries committed
398
399
400
/**
 * Convert an object to an associative array.
 */
Dries's avatar
Dries committed
401
402
403
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
   
Dries committed
404
405
406
407
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
408
    $array = $object;
Dries's avatar
   
Dries committed
409
410
411
412
  }

  return $array;
}
Dries's avatar
   
Dries committed
413
414
415
416

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

Kjartan's avatar
Kjartan committed
418
419
420
/**
 * @name Messages
 * @{
Dries's avatar
   
Dries committed
421
 * Frequently used messages.
Kjartan's avatar
Kjartan committed
422
 */
Dries's avatar
   
Dries committed
423
424
425
426
427
428
429

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

Dries's avatar
   
Dries committed
434
435
436
/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
   
Dries committed
437
function message_na() {
Dries's avatar
   
Dries committed
438
  return t('n/a');
Dries's avatar
   
Dries committed
439
440
}

Dries's avatar
   
Dries committed
441
442
443
/**
 * @} End of "Messages".
 */
Dries's avatar
   
Dries committed
444

Dries's avatar
   
Dries committed
445
446
447
/**
 * Initialize the localization system.
 */
Dries's avatar
   
Dries committed
448
449
function locale_initialize() {
  global $user;
Dries's avatar
   
Dries committed
450
451
452
453
454

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

Dries's avatar
   
Dries committed
455
456
457
458
459
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
460
461
462
    // 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
463
  }
Dries's avatar
   
Dries committed
464
465
466
467
468
469
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
   
Dries committed
470
471
}

Kjartan's avatar
Kjartan committed
472
/**
Dries's avatar
   
Dries committed
473
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
474
 *
475
 * When using t(), try to put entire sentences and strings in one t() call.
Dries's avatar
   
Dries committed
476
477
478
479
 * 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
480
481
482
 *   $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
483
 * @endcode
484
485
486
 * 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
487
 *
Dries's avatar
   
Dries committed
488
 * @param $string
Dries's avatar
   
Dries committed
489
 *   A string containing the English string to translate.
Dries's avatar
   
Dries committed
490
491
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
Dries's avatar
   
Dries committed
492
 *   of any key in this array are replaced with the corresponding value.
Dries's avatar
   
Dries committed
493
494
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
495
 */
Dries's avatar
   
Dries committed
496
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
497
498
499
500
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
501

Dries's avatar
   
Dries committed
502
503
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
504
505
  }
  else {
Dries's avatar
   
Dries committed
506
507
    return strtr($string, $args);
  }
Dries's avatar
   
Dries committed
508
509
}

Dries's avatar
   
Dries committed
510
511
512
513
514
515
516
517
/**
 * Encode special characters in a string for display as HTML.
 *
 * Note that we'd like to use htmlspecialchars($input, $quotes, 'utf-8')
 * as outlined in the PHP manual, but we can't because there's a bug in
 * PHP < 4.3 that makes it mess up multibyte charsets if we specify the
 * charset. This will be changed later once we make PHP 4.3 a requirement.
 */
Dries's avatar
   
Dries committed
518
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
   
Dries committed
519
  return htmlspecialchars($input, $quotes);
Dries's avatar
   
Dries committed
520
521
}

Kjartan's avatar
Kjartan committed
522
/**
Dries's avatar
   
Dries committed
523
 * @defgroup validation Input validation
Dries's avatar
   
Dries committed
524
 * @{
Dries's avatar
   
Dries committed
525
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
526
527
 */

528
/**
Dries's avatar
   
Dries committed
529
530
531
 * Verify the syntax of the given e-mail address.
 *
 * Empty e-mail addresses are allowed. See RFC 2822 for details.
532
 *
Dries's avatar
   
Dries committed
533
534
 * @param $mail
 *   A string containing an email address.
Dries's avatar
   
Dries committed
535
 * @return
Dries's avatar
   
Dries committed
536
 *   TRUE if the address is in a valid format.
537
 */
Dries's avatar
   
Dries committed
538
function valid_email_address($mail) {
539
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
540
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
541
542
543
  $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
544
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
545
546
}

Dries's avatar
   
Dries committed
547
548
549
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
   
Dries committed
550
 * @param $url
Dries's avatar
   
Dries committed
551
 *   The URL to verify.
Dries's avatar
   
Dries committed
552
 * @param $absolute
Dries's avatar
   
Dries committed
553
 *   Whether the URL is absolute (beginning with a scheme such as "http:").
Dries's avatar
   
Dries committed
554
 * @return
Dries's avatar
   
Dries committed
555
 *   TRUE if the URL is in a valid format.
Dries's avatar
   
Dries committed
556
 */
Dries's avatar
   
Dries committed
557
function valid_url($url, $absolute = FALSE) {
558
  if ($absolute) {
559
    return preg_match("/^(http|https|ftp):\/\/[a-z0-9\/:_\-_\.\?,~=#&%\+]+$/i", $url);
560
561
  }
  else {
562
    return preg_match("/^[a-z0-9\/:_\-_\.,\+]+$/i", $url);
563
  }
Dries's avatar
   
Dries committed
564
565
}

Dries's avatar
   
Dries committed
566
567
568
569
570
571
572
573
574
575
/**
 * 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
576
577
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
Dries's avatar
   
Dries committed
578
    // Form data can contain a number of nested arrays.
Kjartan's avatar
Kjartan committed
579
    foreach ($data as $key => $value) {
Dries's avatar
   
Dries committed
580
      if (!valid_input_data($key) || !valid_input_data($value)) {
Dries's avatar
   
Dries committed
581
        return FALSE;
Kjartan's avatar
Kjartan committed
582
583
584
585
      }
    }
  }
  else {
Dries's avatar
   
Dries committed
586
    // Detect dangerous input data.
Kjartan's avatar
Kjartan committed
587

Dries's avatar
   
Dries committed
588
589
590
591
    // 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
592

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

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

    if ($match) {
Dries's avatar
   
Dries committed
600
      watchdog('warning', t('Terminated request because of suspicious input data: %data.', array('%data' => '<em>'. drupal_specialchars($data) .'</em>')));
Dries's avatar
   
Dries committed
601
      return FALSE;
Kjartan's avatar
Kjartan committed
602
603
604
    }
  }

Dries's avatar
   
Dries committed
605
  return TRUE;
Kjartan's avatar
Kjartan committed
606
}
Dries's avatar
   
Dries committed
607
608
609
/**
 * @} End of "defgroup validation".
 */
Kjartan's avatar
Kjartan committed
610

Dries's avatar
   
Dries committed
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
/**
 * 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);
}

Dries's avatar
   
Dries committed
638
function check_form($text) {
Dries's avatar
   
Dries committed
639
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
   
Dries committed
640
641
}

642
643
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
   
Dries committed
644
645
}

Dries's avatar
   
Dries committed
646
/**
Dries's avatar
   
Dries committed
647
 * @defgroup format Formatting
Dries's avatar
   
Dries committed
648
 * @{
Dries's avatar
   
Dries committed
649
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
   
Dries committed
650
651
 */

Dries's avatar
   
Dries committed
652
653
654
655
656
657
/**
 * 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
658
659
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
660
  $output = "<channel>\n";
Dries's avatar
   
Dries committed
661
662
663
664
  $output .= ' <title>'. drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= ' <link>'. drupal_specialchars(strip_tags($link)) ."</link>\n";
  $output .= ' <description>'. drupal_specialchars(strip_tags($description)) ."</description>\n";
  $output .= ' <language>'. drupal_specialchars(strip_tags($language)) ."</language>\n";
Dries's avatar
   
Dries committed
665
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
666
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
   
Dries committed
667
  }
Dries's avatar
   
Dries committed
668
669
670
671
672
673
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
   
Dries committed
674
675
676
677
678
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
   
Dries committed
679
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
680
  $output = "<item>\n";
Dries's avatar
   
Dries committed
681
682
  $output .= ' <title>'. drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= ' <link>'. drupal_specialchars(strip_tags($link)) ."</link>\n";
683
  $output .= ' <description>'. drupal_specialchars($description) ."</description>\n";
Dries's avatar
   
Dries committed
684
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
685
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
   
Dries committed
686
  }
Dries's avatar
   
Dries committed
687
688
689
690
691
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
   
Dries committed
692
/**
Dries's avatar
   
Dries committed
693
 * Format a string containing a count of items.
Dries's avatar
   
Dries committed
694
 *
Dries's avatar
   
Dries committed
695
696
697
698
699
700
701
702
703
704
705
706
707
708
 * 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
709
 */
Dries's avatar
   
Dries committed
710
function format_plural($count, $singular, $plural) {
711
  if ($count == 1) return t($singular, array("%count" => $count));
Dries's avatar
   
Dries committed
712
713
714
715
716
717
718
719
720

  // 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":
721
        return t($singular, array("%count" => $count));
Dries's avatar
   
Dries committed
722
723
724
725
726
727
      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
728
729
}

Dries's avatar
   
Dries committed
730
/**
Dries's avatar
   
Dries committed
731
 * Generate a string representation for the given byte count.
Dries's avatar
   
Dries committed
732
 *
Dries's avatar
   
Dries committed
733
734
735
736
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
   
Dries committed
737
 */
Dries's avatar
   
Dries committed
738
function format_size($size) {
Dries's avatar
   
Dries committed
739
  $suffix = t('bytes');
Dries's avatar
   
Dries committed
740
741
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
742
    $suffix = t('KB');
Dries's avatar
   
Dries committed
743
744
745
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
746
    $suffix = t('MB');
Dries's avatar
   
Dries committed
747
  }
Dries's avatar
   
Dries committed
748
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries's avatar
   
Dries committed
749
750
}

Dries's avatar
   
Dries committed
751
/**
Dries's avatar
   
Dries committed
752
 * Format a time interval with the requested granularity.
Dries's avatar
   
Dries committed
753
 *
Dries's avatar
   
Dries committed
754
755
756
757
758
759
 * @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
760
 */
Dries's avatar
   
Dries committed
761
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
   
Dries committed
762
  $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
763
  $output = '';
Dries's avatar
   
Dries committed
764
  foreach ($units as $key => $value) {
Dries's avatar
   
Dries committed
765
    $key = explode('|', $key);
Dries's avatar
   
Dries committed
766
    if ($timestamp >= $value) {
Dries's avatar
   
Dries committed
767
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
   
Dries committed
768
      $timestamp %= $value;
Dries's avatar
   
Dries committed
769
770
771
772
773
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
   
Dries committed
774
775
    }
  }
Dries's avatar
   
Dries committed
776
  return $output ? $output : t('0 sec');
Dries's avatar
   
Dries committed
777
778
}

Dries's avatar
   
Dries committed
779
/**
Dries's avatar
   
Dries committed
780
781
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
   
Dries committed
782
783
784
785
 * 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
786
787
788
789
790
791
792
793
794
795
796
 * @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
 *   A PHP date format string as required by date().
 * @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
797
 */
798
799
800
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
801
802
803
804
805
806
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
807
  }
Dries's avatar
   
Dries committed
808

809
  $timestamp += $timezone;
Dries's avatar
   
Dries committed
810
811

  switch ($type) {
812
813
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
   
Dries committed
814
      break;
815
816
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
   
Dries committed
817
      break;
818
    case 'custom':
Dries's avatar
   
Dries committed
819
      // No change to format
Dries's avatar
   
Dries committed
820
      break;
821
    case 'medium':
Dries's avatar
   
Dries committed
822
    default:
823
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
   
Dries committed
824
825
  }

826
  $max = strlen($format);
Dries's avatar
   
Dries committed
827
  $date = '';
Dries's avatar
   
Dries committed
828
829
  for ($i = 0; $i < $max; $i++) {
    $c = $format{$i};
830
    if (strpos('AaDFlM', $c) !== false) {
831
      $date .= t(gmdate($c, $timestamp));
832
    }
833
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
834
835
836
837
      $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
838
    }
839
840
841
842
843
    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
844
845
    }
    else {
846
      $date .= $c;
Dries's avatar
   
Dries committed
847
    }
Dries's avatar
   
Dries committed
848
  }
849

Dries's avatar
   
Dries committed
850
851
852
  return $date;
}

Dries's avatar
   
Dries committed
853
/**
Dries's avatar
   
Dries committed
854
 * Format a username.
Dries's avatar
   
Dries committed
855
 *
Dries's avatar
   
Dries committed
856
857
858
859
860
 * @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
861
 */
Dries's avatar
   
Dries committed
862
863
864
function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
   
Dries committed
865
    // Shorten the name when it is too long or it will break many tables.
Dries's avatar
Dries committed
866
    if (strlen($object->name) > 20) {
Dries's avatar
   
Dries committed
867
      $name = truncate_utf8($object->name, 15) .'...';
Dries's avatar
Dries committed
868
869
870
871
872
    }
    else {
      $name = $object->name;
    }

Dries's avatar
   
Dries committed
873
    $output = l($name, 'user/'. $object->uid, array('title' => t('View user profile.')));
Dries's avatar
   
Dries committed
874
  }
Dries's avatar
   
Dries committed
875
  else if ($object->name) {
Dries's avatar
   
Dries committed
876
877
878
879
    // 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
880
    if ($object->homepage) {
Dries's avatar
   
Dries committed
881
      $output = '<a href="'. $object->homepage .'">'. $object->name .'</a>';
Dries's avatar
   
Dries committed
882
883
884
885
886
887
    }
    else {
      $output = $object->name;
    }

    $output .= ' ('. t('not verified') .')';
Dries's avatar
   
Dries committed
888
  }
Dries's avatar
   
Dries committed
889
  else {
Dries's avatar
   
Dries committed
890
    $output = t(variable_get('anonymous', 'Anonymous'));
Dries's avatar
   
Dries committed
891
892
  }

Dries's avatar
   
Dries committed
893
  return $output;
Dries's avatar
   
Dries committed
894
}
Dries's avatar
   
Dries committed
895
896
897
/**
 * @} End of "defgroup format".
 */
Dries's avatar
   
Dries committed
898

Kjartan's avatar
Kjartan committed
899
/**
Dries's avatar
   
Dries committed
900
 * @defgroup form Form generation
Kjartan's avatar
Kjartan committed
901
 * @{
Dries's avatar
   
Dries committed
902
 * Functions to enable output of HTML forms and form elements.
903
 *
Dries's avatar
   
Dries committed
904
905
 * 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
906
 * must be explicitly generated by modules.
Kjartan's avatar
Kjartan committed
907
 */
Dries's avatar
   
Dries committed
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923

/**
 * 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
924
  if (!$action) {
925
    $action = request_uri();
Dries's avatar
   
Dries committed
926
  }
Dries's avatar
   
Dries committed
927
  return '<form action="'. $action .'" method="'. $method .'"'. drupal_attributes($attributes) .">\n". $form ."\n</form>\n";
Dries's avatar
   
Dries committed
928
929
}

Dries's avatar
   
Dries committed
930
/**
Dries's avatar
   
Dries committed
931
 * File an error against the form element with the specified name.
Dries's avatar
   
Dries committed
932
933
934
935
936
937
938
 */
function form_set_error($name, $message) {
  $GLOBALS['form'][$name] = $message;
  drupal_set_message($message, 'error');
}

/**
Dries's avatar
   
Dries committed
939
 * Return an associative array of all errors.
Dries's avatar
   
Dries committed
940
 */
Dries's avatar
   
Dries committed
941
function form_get_errors() {
942
943
944
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'];
  }
Dries's avatar
   
Dries committed
945
946
947
948
949
950
}

/**
 * Return the error message filed against the form with the specified name.
 */
function _form_get_error($name) {
Dries's avatar
   
Dries committed
951
952
953
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'][$name];
  }
Dries's avatar
   
Dries committed
954
955
956
957
958
959
}

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

Dries's avatar
   
Dries committed
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
/**
 * 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
978
function form_item($title, $value, $description = NULL, $id = NULL, $required = FALSE, $error = FALSE) {
Dries's avatar
   
Dries committed
979
  return theme('form_element', $title, $value, $description, $id, $required, $error);
Dries's avatar
   
Dries committed
980
}
Dries's avatar
   
Dries committed
981

Dries's avatar
   
Dries committed
982
983
984
985
986
987
988
989
990
991
992
993
/**
 * Format a group of form items.
 *
 * @param $legend
 *   The label for the form item group.
 * @param $group
 *   The form items within the group, as an HTML string.
 * @param $description
 *   Explanatory text to display after the form item group.
 * @return
 *   A themed HTML string representing the form item group.
 */
Dries's avatar
   
Dries committed
994
function form_group($legend, $group, $description = NULL) {
Dries's avatar
   
Dries committed
995
  return '<fieldset>' . ($legend ? '<legend>'. $legend .'</legend>' : '') . $group . ($description ? '<div class="description">'. $description .'</div>' : '') . "</fieldset>\n";
Dries's avatar
   
Dries committed
996
}
Dries's avatar
   
Dries committed
997

Dries's avatar
   
Dries committed
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
/**
 * 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) .' />';
1020
  if (!is_null($title)) {
Dries's avatar
   
Dries committed
1021
    $element = '<label class="option">'. $element .' '. $title .'</label>';
1022
  }
Dries's avatar
   
Dries committed
1023
  return theme('form_element', NULL, $element, $description, $name, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1024
1025
}

Dries's avatar
   
Dries committed
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
/**
 * 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.
 */
1047
function form_radios($title, $name, $value, $options, $description = NULL, $required = FALSE, $attributes = NULL) {
Dries's avatar
   
Dries committed
1048
  if (count($options) > 0) {
Dries's avatar
   
Dries committed
1049
    $choices = '';
Dries's avatar
   
Dries committed
1050
    foreach ($options as $key => $choice) {
Dries's avatar
   
Dries committed
1051
      $choices .= '<label class="option"><input type="radio" class="form-radio" name="edit['. $name .']" value="'. $key .'"'. ($key == $value ? ' checked="checked"' : ''). drupal_attributes($attributes). ' /> '. $choice .'</label><br />';
Dries's avatar
   
Dries committed
1052
    }
1053
    return theme('form_element', $title, $choices, $description, NULL, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1054
  }
Dries's avatar
   
Dries committed
1055
1056
}

Dries's avatar
   
Dries committed
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
/**
 * Format a checkbox.
 *
 * @param $title
 *   The label for the checkbox.
 * @param $name
 *   The internal name used to refer to the button.
 * @param $value
 *   The value that the form element takes on when selected.
 * @param $checked
 *   Whether the button will be initially selected when the page is rendered.
 * @param $description
 *   Explanatory text to display after the form item.
 * @param $attributes
 *   An associative array of HTML attributes to add to the button.
 * @param $required
 *   Whether the user must check this box before submitting the form.
 * @return
 *   A themed HTML string representing the checkbox.
 */
function form_checkbox($title, $name, $value = 1, $checked = FALSE, $description = NULL, $attributes = NULL, $required = FALSE) {
  $element = '<input type="checkbox" class="'. _form_get_class('form-checkbox', $required, _form_get_error($name)) .'" name="edit['. $name .']" id="edit-'. $name .'" value="'. $value .'"'. ($checked ? ' checked="checked"' : '') . drupal_attributes($attributes) .' />';
1079
  if (!is_null($title)) {
Dries's avatar
   
Dries committed
1080
    $element = '<label class="option">'. $element .' '. $title .'</label>';
1081
  }
1082
1083
  // Note: because unchecked boxes are not included in the POST data, we include
  // a form_hidden() which will be overwritten for a checked box.
Dries's avatar
   
Dries committed
1084
  return form_hidden($name, 0) . theme('form_element', NULL, $element, $description, $name, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1085
1086
}

Dries's avatar
   
Dries committed
1087
1088
1089
1090
1091
1092
1093
1094
/**
 * Format a set of checkboxes.
 *
 * @param $title
 *   The label for the checkboxes as a group.
 * @param $name
 *   The internal name used to refer to the buttons.
 * @param $values
1095
 *   A linear array of keys of the initially checked boxes.
Dries's avatar
   
Dries committed
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
 * @param $options
 *   An associative array of buttons to display. The keys in this array are
 *   button values, while the values are the labels to display for each button.
 * @param $description
 *   Explanatory text to display after the form item.
 * @param $attributes
 *   An associative array of HTML attributes to add to each button.
 * @param $required
 *   Whether the user must check a box before submitting the form.
 * @return
 *   A themed HTML string representing the radio button set.
 */
Dries's avatar
   
Dries committed
1108
function form_checkboxes($title, $name, $values, $options, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
1109
  if (count($options) > 0) {
1110
    if (!isset($values) || $values == 0) {
Dries's avatar
   
Dries committed
1111
1112
1113
1114
      $values = array();
    }
    $choices = '';
    foreach ($options as $key => $choice) {
Dries's avatar
   
Dries committed
1115
      $choices .= '<label class="option"><input type="checkbox" class="form-checkbox" name="edit['. $name .'][]" value="'. $key .'"'. (in_array($key, $values) ? ' checked="checked"' : ''). drupal_attributes($attributes). ' /> '. $choice .'</label><br />';
Dries's avatar
   
Dries committed
1116
    }