common.inc 57.2 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>')), WATCHDOG_WARNING);
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) {
179
180
    drupal_set_title(t('Page not found'));
    print theme('page', '');
Dries's avatar
   
Dries committed
181
182
  }
}
Dries's avatar
   
Dries committed
183

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

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

  if ($status != MENU_FOUND) {
199
200
    drupal_set_title(t('Access denied'));
    print theme('page', message_access());
Dries's avatar
   
Dries committed
201
202
203
  }
}

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

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

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

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

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

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

  fwrite($fp, $request);

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

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

  // Parse headers.
289
  while ($line = trim(array_shift($headers))) {
Dries's avatar
   
Dries committed
290
291
292
293
294
295
296
297
298
299
300
301
    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
302
  // the base code in their class.
Dries's avatar
   
Dries committed
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
328
329
  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
330
331
332
/**
 * @} End of "HTTP handling".
 */
Dries's avatar
   
Dries committed
333

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

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

    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
350
351
352
  }
}

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

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

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

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

  return $object;
}

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

  return $array;
}
Dries's avatar
   
Dries committed
415
416
417
418

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

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

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

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

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

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

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

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

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

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

Dries's avatar
   
Dries committed
512
513
514
515
516
517
518
519
/**
 * 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
520
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
   
Dries committed
521
  return htmlspecialchars($input, $quotes);
Dries's avatar
   
Dries committed
522
523
}

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

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

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

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

590
591
592
    // Decode all normal character entities.
    $data = decode_entities($data, array('<', '&', '"'));

Dries's avatar
   
Dries committed
593
594
595
596
    // 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
597

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

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

    if ($match) {
605
      watchdog('security', t('Terminated request because of suspicious input data: %data.', array('%data' => '<em>'. drupal_specialchars($data) .'</em>')));
Dries's avatar
   
Dries committed
606
      return FALSE;
Kjartan's avatar
Kjartan committed
607
608
609
    }
  }

Dries's avatar
   
Dries committed
610
  return TRUE;
Kjartan's avatar
Kjartan committed
611
}
Dries's avatar
   
Dries committed
612
613
614
/**
 * @} End of "defgroup validation".
 */
Kjartan's avatar
Kjartan committed
615

Dries's avatar
   
Dries committed
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
/**
 * 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
643
function check_form($text) {
Dries's avatar
   
Dries committed
644
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
   
Dries committed
645
646
}

647
648
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
   
Dries committed
649
650
}

Dries's avatar
   
Dries committed
651
/**
Dries's avatar
   
Dries committed
652
 * @defgroup format Formatting
Dries's avatar
   
Dries committed
653
 * @{
Dries's avatar
   
Dries committed
654
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
   
Dries committed
655
656
 */

Dries's avatar
   
Dries committed
657
658
659
660
661
662
/**
 * 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
663
664
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
665
  $output = "<channel>\n";
Dries's avatar
   
Dries committed
666
667
668
669
  $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
670
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
671
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
   
Dries committed
672
  }
Dries's avatar
   
Dries committed
673
674
675
676
677
678
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

  return $output;
}

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

  // 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":
726
        return t($singular, array("%count" => $count));
Dries's avatar
   
Dries committed
727
728
729
730
731
732
      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
733
734
}

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

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

    if ($granularity == 0) {
      break;
Dries's avatar
   
Dries committed
779
780
    }
  }
Dries's avatar
   
Dries committed
781
  return $output ? $output : t('0 sec');
Dries's avatar
   
Dries committed
782
783
}

Dries's avatar
   
Dries committed
784
/**
Dries's avatar
   
Dries committed
785
786
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
   
Dries committed
787
788
789
790
 * 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
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
797
798
799
 *   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
800
801
802
803
 * @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
804
 */
805
806
807
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
808
809
810
811
812
813
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
814
  }
Dries's avatar
   
Dries committed
815

816
  $timestamp += $timezone;
Dries's avatar
   
Dries committed
817
818

  switch ($type) {
819
820
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
   
Dries committed
821
      break;
822
823
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
   
Dries committed
824
      break;
825
    case 'custom':
Dries's avatar
   
Dries committed
826
      // No change to format
Dries's avatar
   
Dries committed
827
      break;
828
    case 'medium':
Dries's avatar
   
Dries committed
829
    default:
830
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
   
Dries committed
831
832
  }

833
  $max = strlen($format);
Dries's avatar
   
Dries committed
834
  $date = '';
Dries's avatar
   
Dries committed
835
836
  for ($i = 0; $i < $max; $i++) {
    $c = $format{$i};
837
    if (strpos('AaDFlM', $c) !== false) {
838
      $date .= t(gmdate($c, $timestamp));
839
    }
840
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
841
842
843
844
      $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
845
    }
846
847
848
849
850
    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
851
    }
852
853
854
    else if ($c == '\\') {
      $date .= $format[++$i];
    }
Dries's avatar
   
Dries committed
855
    else {
856
      $date .= $c;
Dries's avatar
   
Dries committed
857
    }
Dries's avatar
   
Dries committed
858
  }
859

Dries's avatar
   
Dries committed
860
861
862
  return $date;
}

Dries's avatar
   
Dries committed
863
/**
Dries's avatar
   
Dries committed
864
 * Format a username.
Dries's avatar
   
Dries committed
865
 *
Dries's avatar
   
Dries committed
866
867
868
869
870
 * @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
871
 */
Dries's avatar
   
Dries committed
872
873
874
function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
   
Dries committed
875
    // Shorten the name when it is too long or it will break many tables.
Dries's avatar
Dries committed
876
    if (strlen($object->name) > 20) {
Dries's avatar
   
Dries committed
877
      $name = truncate_utf8($object->name, 15) .'...';
Dries's avatar
Dries committed
878
879
880
881
882
    }
    else {
      $name = $object->name;
    }

Dries's avatar
   
Dries committed
883
    $output = l($name, 'user/'. $object->uid, array('title' => t('View user profile.')));
Dries's avatar
   
Dries committed
884
  }
Dries's avatar
   
Dries committed
885
  else if ($object->name) {
Dries's avatar
   
Dries committed
886
887
888
889
    // 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
890
    if ($object->homepage) {
Dries's avatar
   
Dries committed
891
      $output = '<a href="'. $object->homepage .'">'. $object->name .'</a>';
Dries's avatar
   
Dries committed
892
893
894
895
896
897
    }
    else {
      $output = $object->name;
    }

    $output .= ' ('. t('not verified') .')';
Dries's avatar
   
Dries committed
898
  }
Dries's avatar
   
Dries committed
899
  else {
Dries's avatar
Dries committed
900
    $output = variable_get('anonymous', 'Anonymous');
Dries's avatar
   
Dries committed
901
902
  }

Dries's avatar
   
Dries committed
903
  return $output;
Dries's avatar
   
Dries committed
904
}
Dries's avatar
   
Dries committed
905
906
907
/**
 * @} End of "defgroup format".
 */
Dries's avatar
   
Dries committed
908

Kjartan's avatar
Kjartan committed
909
/**
Dries's avatar
   
Dries committed
910
 * @defgroup form Form generation
Kjartan's avatar
Kjartan committed
911
 * @{
Dries's avatar
   
Dries committed
912
 * Functions to enable output of HTML forms and form elements.
913
 *
Dries's avatar
   
Dries committed
914
915
 * 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
916
 * must be explicitly generated by modules.
Kjartan's avatar
Kjartan committed
917
 */
Dries's avatar
   
Dries committed
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933

/**
 * 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
934
  if (!$action) {
935
    $action = request_uri();
Dries's avatar
   
Dries committed
936
  }
Dries's avatar
   
Dries committed
937
  return '<form action="'. $action .'" method="'. $method .'"'. drupal_attributes($attributes) .">\n". $form ."\n</form>\n";
Dries's avatar
   
Dries committed
938
939
}

Dries's avatar
   
Dries committed
940
/**
Dries's avatar
   
Dries committed
941
 * File an error against the form element with the specified name.
Dries's avatar
   
Dries committed
942
943
944
945
946
947
948
 */
function form_set_error($name, $message) {
  $GLOBALS['form'][$name] = $message;
  drupal_set_message($message, 'error');
}

/**
Dries's avatar
   
Dries committed
949
 * Return an associative array of all errors.
Dries's avatar
   
Dries committed
950
 */
Dries's avatar
   
Dries committed
951
function form_get_errors() {
952
953
954
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'];
  }
Dries's avatar
   
Dries committed
955
956
957
958
959
960
}

/**
 * Return the error message filed against the form with the specified name.
 */
function _form_get_error($name) {
Dries's avatar
   
Dries committed
961
962
963
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'][$name];
  }
Dries's avatar
   
Dries committed
964
965
966
967
968
969
}

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

Dries's avatar
   
Dries committed
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
/**
 * 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
988
function form_item($title, $value, $description = NULL, $id = NULL, $required = FALSE, $error = FALSE) {
Dries's avatar
   
Dries committed
989
  return theme('form_element', $title, $value, $description, $id, $required, $error);
Dries's avatar
   
Dries committed
990
}
Dries's avatar
   
Dries committed
991

Dries's avatar
   
Dries committed
992
993
994
995
996
997
998
999
1000
1001
1002
1003
/**
 * 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
1004
function form_group($legend, $group, $description = NULL) {
Dries's avatar
   
Dries committed
1005
  return '<fieldset>' . ($legend ? '<legend>'. $legend .'</legend>' : '') . $group . ($description ? '<div class="description">'. $description .'</div>' : '') . "</fieldset>\n";
Dries's avatar
   
Dries committed
1006
}
Dries's avatar
   
Dries committed
1007

Dries's avatar
   
Dries committed
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
/**
 * 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) .' />';
1030
  if (!is_null($title)) {
Dries's avatar
   
Dries committed
1031
    $element = '<label class="option">'. $element .' '. $title .'</label>';
1032
  }
Dries's avatar
   
Dries committed
1033
  return theme('form_element', NULL, $element, $description, $name, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1034
1035
}

Dries's avatar
   
Dries committed
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
/**
 * 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.
 */
1057
function form_radios($title, $name, $value, $options, $description = NULL, $required = FALSE, $attributes = NULL) {
Dries's avatar
   
Dries committed
1058
  if (count($options) > 0) {
Dries's avatar
   
Dries committed
1059
    $choices = '';
Dries's avatar
   
Dries committed
1060
    foreach ($options as $key => $choice) {
Dries's avatar
   
Dries committed
1061
      $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
1062
    }
1063
    return theme('form_element', $title, $choices, $description, NULL, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1064
  }
Dries's avatar
   
Dries committed
1065
1066
}

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

Dries's avatar
   
Dries committed
1097
1098
1099
1100
1101
1102
1103
1104
/**
 * 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
1105
 *   A linear array of keys of the initially checked boxes.
Dries's avatar
   
Dries committed
1106
1107
1108
1109
1110
1111
1112
1113
1114