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

Kjartan's avatar
Kjartan committed
12
13
/**
 * @name Page title
Dries's avatar
   
Dries committed
14
15
16
17
 *
 * Functions to get and set the title of the current page.
 * @{
 */
Dries's avatar
   
Dries committed
18
19
20
21
function drupal_set_title($title = NULL) {
  static $stored_title;

  if (isset($title)) {
Dries's avatar
   
Dries committed
22
    $stored_title = $title;
Dries's avatar
   
Dries committed
23
24
25
26
27
28
29
30
31
32
33
34
35
  }
  return $stored_title;
}

function drupal_get_title() {
  $title = drupal_set_title();

  if (!isset($title)) {
    $title = menu_get_active_title();
  }

  return $title;
}
Kjartan's avatar
Kjartan committed
36
/* @} */
Dries's avatar
   
Dries committed
37
38

/**
Kjartan's avatar
Kjartan committed
39
 * @name Page breadcrumbs
Dries's avatar
   
Dries committed
40
41
42
43
 *
 * Functions to get and set the breadcrumb trail of the current page.
 * @{
 */
Kjartan's avatar
Kjartan committed
44
45
46
47
48

/**
 * @param $breadcrumb Array of links, starting with "home" and proceeding up
 *   to but not including the current page.
 */
Dries's avatar
   
Dries committed
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
function drupal_set_breadcrumb($breadcrumb = NULL) {
  static $stored_breadcrumb;

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

function drupal_get_breadcrumb() {
  $breadcrumb = drupal_set_breadcrumb();

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

  return $breadcrumb;
}
Kjartan's avatar
Kjartan committed
67
/* @} */
Dries's avatar
   
Dries committed
68

Dries's avatar
Dries committed
69
70
71
72
73
74
75
76
/**
 * @name HTML head contents
 *
 * Set and get output that should be in the \<head\> tag.
 * @{
 */

function drupal_set_html_head($data = NULL) {
Dries's avatar
   
Dries committed
77
  static $stored_head = '';
Dries's avatar
Dries committed
78
79

  if (!is_null($data)) {
Dries's avatar
   
Dries committed
80
    $stored_head .= $data ."\n";
Dries's avatar
Dries committed
81
82
83
84
85
86
87
  }
  return $stored_head;
}

function drupal_get_html_head() {
  global $base_url;

Dries's avatar
   
Dries committed
88
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
89
  $output .= "<base href=\"$base_url/\" />\n";
Dries's avatar
   
Dries committed
90
  $output .= "<style type=\"text/css\" media=\"all\">\n";
Dries's avatar
Dries committed
91
92
93
94
95
96
97
  $output .= "@import url(misc/drupal.css);\n";
  $output .= "</style>\n";

  return $output . drupal_set_html_head();
}
/* @} */

Dries's avatar
   
Dries committed
98
/**
Dries's avatar
   
Dries committed
99
 * @name URL path alias
Kjartan's avatar
Kjartan committed
100
 *
Dries's avatar
   
Dries committed
101
 * Functions to handle path aliases.
Dries's avatar
   
Dries committed
102
 */
Dries's avatar
   
Dries committed
103
104

function drupal_get_path_map($action = '') {
Dries's avatar
Dries committed
105
  static $map = NULL;
Dries's avatar
   
Dries committed
106

Dries's avatar
   
Dries committed
107
  if ($action == 'rebuild') {
Dries's avatar
   
Dries committed
108
109
110
    $map = NULL;
  }

Dries's avatar
Dries committed
111
  if (is_null($map)) {
Dries's avatar
   
Dries committed
112
    $map = array();  // make $map non-null in case no aliases are defined
Dries's avatar
   
Dries committed
113
    $result = db_query('SELECT * FROM {url_alias}');
Dries's avatar
   
Dries committed
114
    while ($data = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
115
      $map[$data->dst] = $data->src;
Dries's avatar
   
Dries committed
116
117
118
119
120
121
    }
  }

  return $map;
}

Dries's avatar
   
Dries committed
122
function drupal_rebuild_path_map() {
Dries's avatar
   
Dries committed
123
  drupal_get_path_map('rebuild');
Dries's avatar
   
Dries committed
124
}
Kjartan's avatar
Kjartan committed
125
126

/**
Dries's avatar
   
Dries committed
127
 * Given an internal Drupal path, return the alias set by the administrator.
Kjartan's avatar
Kjartan committed
128
 */
Dries's avatar
   
Dries committed
129
130
131
132
function drupal_get_path_alias($path) {
  if (($map = drupal_get_path_map()) && ($newpath = array_search($path, $map))) {
    return $newpath;
  }
Dries's avatar
   
Dries committed
133
  elseif (function_exists('conf_url_rewrite')) {
Dries's avatar
   
Dries committed
134
135
    return conf_url_rewrite($path, 'outgoing');
  }
136
137
138
139
  else {
    // No alias found. Return the normal path.
    return $path;
  }
Dries's avatar
   
Dries committed
140
141
142
}

/**
Dries's avatar
   
Dries committed
143
 * Given a path alias, return the internal path it represents.
Dries's avatar
   
Dries committed
144
145
146
147
148
 */
function drupal_get_normal_path($path) {
  if (($map = drupal_get_path_map()) && isset($map[$path])) {
    return $map[$path];
  }
Dries's avatar
   
Dries committed
149
  elseif (function_exists('conf_url_rewrite')) {
Dries's avatar
   
Dries committed
150
151
152
153
154
155
156
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
/* @} */
Kjartan's avatar
Kjartan committed
157

Dries's avatar
Dries committed
158
159
160
161
162
163
164
/**
 * @name HTTP headers
 *
 * Functions to get and set the HTTP headers of the current page.
 * @{
 */
function drupal_set_header($header = NULL) {
165
166
167
168
  // We use an array to guarantee there are no leading or trailing delimiters.
  // This can cause header("") to get called when serving the page later, which
  // ends HTTP headers prematurely on some PHP versions.
  static $stored_headers = array();
Dries's avatar
Dries committed
169

170
  if (strlen($header)) {
Dries's avatar
Dries committed
171
    header($header);
172
    $stored_headers[] = $header;
Dries's avatar
Dries committed
173
  }
174
  return implode("\n", $stored_headers);
Dries's avatar
Dries committed
175
176
177
178
179
180
181
}

function drupal_get_headers() {
  return drupal_set_header();
}
/* @} */

Dries's avatar
   
Dries committed
182
183
184
185
186
187
188
/**
 * @name HTTP handling
 *
 * Functions to properly handle HTTP responses.
 * @{
 */

Kjartan's avatar
Kjartan committed
189
/**
Dries's avatar
   
Dries committed
190
 * Send the user to a different Drupal page.
Kjartan's avatar
Kjartan committed
191
 *
Dries's avatar
   
Dries committed
192
193
 * This issues an on-site HTTP redirect. The function makes sure the redirected
 * URL is formatted correctly.
Kjartan's avatar
Kjartan committed
194
 *
Dries's avatar
   
Dries committed
195
196
197
198
199
200
201
202
203
204
205
206
207
 * 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
208
 */
Dries's avatar
   
Dries committed
209
210
211
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
212

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

Dries's avatar
   
Dries committed
216
217
    if (strstr($url, '?') && !strstr($url, $sid)) {
      $url = $url .'&'. $sid;
Kjartan's avatar
Kjartan committed
218
219
    }
    else {
Dries's avatar
   
Dries committed
220
      $url = $url .'?'. $sid;
Kjartan's avatar
Kjartan committed
221
222
223
    }
  }

Dries's avatar
   
Dries committed
224
225
226
227
  // 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
228

Dries's avatar
   
Dries committed
229
230
231
  // 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
232
233
234
235
236
237
  exit();
}

/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
   
Dries committed
238
function drupal_not_found() {
Dries's avatar
   
Dries committed
239
  header('HTTP/1.0 404 Not Found');
Dries's avatar
   
Dries committed
240
  watchdog('httpd', t('404 error: "%page" not found', array('%page' => check_query($_GET['q']))));
Dries's avatar
   
Dries committed
241
242

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

Dries's avatar
   
Dries committed
249
  if ($status != MENU_FOUND) {
Dries's avatar
Dries committed
250
    print theme('page', '', t('Page not found'));
Dries's avatar
   
Dries committed
251
252
  }
}
Dries's avatar
   
Dries committed
253

Dries's avatar
   
Dries committed
254
255
256
257
258
259
260
/**
 * Generates a 403 error if the request is not allowed.
 */
function drupal_access_denied() {
  header('HTTP/1.0 403 Forbidden');

  $path = drupal_get_normal_path(variable_get('site_403', ''));
Dries's avatar
   
Dries committed
261
  $status = MENU_NOT_FOUND;
Dries's avatar
   
Dries committed
262
263
264
265
266
267
268
269
270
271
  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
272
/**
Dries's avatar
   
Dries committed
273
 * Perform an HTTP request.
Dries's avatar
   
Dries committed
274
 *
Dries's avatar
   
Dries committed
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 * 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
292
293
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
Dries's avatar
   
Dries committed
294
  // Parse the URL, and make sure we can handle the schema.
Dries's avatar
   
Dries committed
295
296
297
298
299
300
  $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
301
302
      // 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
303
304
      break;
    default:
Dries's avatar
   
Dries committed
305
      $result->error = 'invalid schema '. $uri['scheme'];
Dries's avatar
   
Dries committed
306
307
308
      return $result;
  }

Dries's avatar
   
Dries committed
309
  // Make sure the socket opened properly.
Dries's avatar
   
Dries committed
310
  if (!$fp) {
Dries's avatar
   
Dries committed
311
    $result->error = trim($errno .' '. $errstr);
Dries's avatar
   
Dries committed
312
313
314
    return $result;
  }

Dries's avatar
   
Dries committed
315
  // Construct the path to act on.
Dries's avatar
   
Dries committed
316
317
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
Dries's avatar
   
Dries committed
318
    $path .= '?'. $uri['query'];
Dries's avatar
   
Dries committed
319
320
  }

Dries's avatar
   
Dries committed
321
  // Create http request.
Dries's avatar
   
Dries committed
322
  $defaults = array(
Dries's avatar
   
Dries committed
323
    'Host' => 'Host: '. $uri['host'],
324
325
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
   
Dries committed
326
327
328
  );

  foreach ($headers as $header => $value) {
Dries's avatar
   
Dries committed
329
    $defaults[$header] = $header .': '. $value;
Dries's avatar
   
Dries committed
330
331
  }

Dries's avatar
   
Dries committed
332
  $request = $method .' '. $path ." HTTP/1.0\r\n";
Dries's avatar
   
Dries committed
333
334
335
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
Dries's avatar
   
Dries committed
336
    $request .= $data ."\r\n";
Dries's avatar
   
Dries committed
337
338
339
340
341
342
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
343
  $response = '';
344
  while (!feof($fp) && $data = fread($fp, 1024)) {
345
    $response .= $data;
Dries's avatar
   
Dries committed
346
347
348
349
  }
  fclose($fp);

  // Parse response.
350
351
352
353
  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
354
355
356
  $result->headers = array();

  // Parse headers.
357
  while ($line = trim(array_shift($headers))) {
Dries's avatar
   
Dries committed
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
    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
  // the base code in their class:
  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;
}
Kjartan's avatar
Kjartan committed
398
/* @} */
Dries's avatar
   
Dries committed
399

Dries's avatar
   
Dries committed
400
401
402
/**
 * Log errors in the database rather than displaying them to the user.
 */
Dries's avatar
   
Dries committed
403
function error_handler($errno, $message, $filename, $line, $variables) {
Dries's avatar
   
Dries committed
404
405
  $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');
  $entry = $types[$errno] .': '. $message .' in '. $filename .' on line '. $line .'.';
Dries's avatar
   
Dries committed
406
407

  if ($errno & E_ALL ^ E_NOTICE) {
408
    watchdog('error', t('%error: %message in %file on line %line.', array('%error' => $types[$errno], '%message' => $message, '%file' => $filename, '%line' => $line)));
Dries's avatar
Dries committed
409
    if (error_reporting()) {
Dries's avatar
   
Dries committed
410
      print '<pre>'. $entry .'</pre>';
Dries's avatar
Dries committed
411
    }
Dries's avatar
   
Dries committed
412
413
414
  }
}

Dries's avatar
Dries committed
415
416
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
417
418
419
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
420
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
421
422
423
  }
}

Dries's avatar
   
Dries committed
424
425
426
427
/**
 * Correct double-escaping problems caused by "magic quotes" in some PHP
 * installations.
 */
Dries's avatar
   
Dries committed
428
429
function fix_gpc_magic() {
  static $fixed = false;
Dries's avatar
   
Dries committed
430
  if (!$fixed && ini_get('magic_quotes_gpc')) {
Dries's avatar
Dries committed
431
432
433
434
435
436
    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
437
438
}

Kjartan's avatar
Kjartan committed
439
440
441
442
443
444
/**
 * @name Conversion
 *
 * Converts data structures to a different type.
 * @{
 */
Dries's avatar
   
Dries committed
445
446
447
448

/**
 * Convert an associative array to an anonymous object.
 */
Dries's avatar
Dries committed
449
450
451
function array2object($array) {
  if (is_array($array)) {
    foreach ($array as $key => $value) {
Dries's avatar
   
Dries committed
452
453
454
455
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
456
    $object = $array;
Dries's avatar
   
Dries committed
457
458
459
460
461
  }

  return $object;
}

Dries's avatar
   
Dries committed
462
463
464
/**
 * Convert an object to an associative array.
 */
Dries's avatar
Dries committed
465
466
467
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
   
Dries committed
468
469
470
471
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
472
    $array = $object;
Dries's avatar
   
Dries committed
473
474
475
476
  }

  return $array;
}
Kjartan's avatar
Kjartan committed
477
/* @} */
Dries's avatar
   
Dries committed
478

Kjartan's avatar
Kjartan committed
479
480
481
482
483
484
/**
 * @name Messages
 *
 * Frequently used messages.
 * @{
 */
Dries's avatar
   
Dries committed
485
486
487
488
489
490
491

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

Dries's avatar
   
Dries committed
496
497
498
/**
 * Return a string with a "not applicable" message.
 */
Dries's avatar
   
Dries committed
499
function message_na() {
Dries's avatar
   
Dries committed
500
  return t('n/a');
Dries's avatar
   
Dries committed
501
502
}

Kjartan's avatar
Kjartan committed
503
/* @} */
Dries's avatar
   
Dries committed
504

Dries's avatar
   
Dries committed
505
506
507
/**
 * Initialize the localization system.
 */
Dries's avatar
   
Dries committed
508
509
510
511
512
513
514
515
516
function locale_initialize() {
  global $user;
  if (function_exists('locale')) {
    $languages = locale_supported_languages();
    $languages = $languages['name'];
  }
  else {
    $languages = array();
  }
Dries's avatar
   
Dries committed
517
518
519
520
521
522
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
   
Dries committed
523
524
}

Kjartan's avatar
Kjartan committed
525
/**
Dries's avatar
   
Dries committed
526
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
527
 *
528
529
530
531
 * When using t(), try to put entire sentences and strings in one t() call.
 * This makes it easier for translators. We are unafraid of HTML markup within
 * translation strings if necessary. The suggested syntax for a link embedded
 * within a translation string is for example:
Dries's avatar
   
Dries committed
532
533
534
535
536
 * @verbatim
 *   $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')));
 * @endverbatim
537
538
539
 * 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
540
 *
Dries's avatar
   
Dries committed
541
542
543
544
545
546
547
 * @param $string
 *   A string containing the english string to translate.
 * @param $args
 *   An associative array of replacements to make after translation. Incidences
 *   of any key in this array are replaces with the corresponding value.
 * @return
 *   The translated string.
Kjartan's avatar
Kjartan committed
548
 */
Dries's avatar
   
Dries committed
549
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
550
551
552
553
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
554

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

Dries's avatar
   
Dries committed
563
564
565
566
567
568
569
570
/**
 * 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
571
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
   
Dries committed
572
  return htmlspecialchars($input, $quotes);
Dries's avatar
   
Dries committed
573
574
}

Kjartan's avatar
Kjartan committed
575
576
577
578
/**
 * @name Validation
 *
 * Functions to validate user input.
Dries's avatar
   
Dries committed
579
 * @{
Kjartan's avatar
Kjartan committed
580
581
 */

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

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

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

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

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

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

    if ($match) {
654
      watchdog('warning', t('terminated request because of suspicious input data: %data', array('%data' => drupal_specialchars($data))));
Dries's avatar
   
Dries committed
655
      return FALSE;
Kjartan's avatar
Kjartan committed
656
657
658
    }
  }

Dries's avatar
   
Dries committed
659
  return TRUE;
Kjartan's avatar
Kjartan committed
660
661
662
663
664
665
666
}
/* @} */

/**
 * @defgroup search Search interface
 * @{
 */
Dries's avatar
   
Dries committed
667

Kjartan's avatar
Kjartan committed
668
669
670
/**
 * Format a single result entry of a search query:
 *
Dries's avatar
   
Dries committed
671
 * @param $item a single search result as returned by <i>module</i>_search of
Dries's avatar
   
Dries committed
672
673
 *   type array('count' => ..., 'link' => ..., 'title' => ..., 'user' => ...,
 *   'date' => ..., 'keywords' => ...)
Dries's avatar
   
Dries committed
674
 * @param $type module type of this item
Kjartan's avatar
Kjartan committed
675
 */
Dries's avatar
   
Dries committed
676
function search_item($item, $type) {
Dries's avatar
   
Dries committed
677
678

  /*
Dries's avatar
   
Dries committed
679
  ** Modules may implement hook_search_item() hook in order to overwrite
Dries's avatar
   
Dries committed
680
681
682
  ** the default function to display search results.
  */

Dries's avatar
   
Dries committed
683
684
  if (module_hook($type, 'search_item')) {
    $output = module_invoke($type, 'search_item', $item);
Dries's avatar
   
Dries committed
685
686
  }
  else {
Dries's avatar
   
Dries committed
687
688
    $output = ' <dt class="title"><a href="'. $item['link'] .'">'. $item['title'] .'</a></dt>';
    $output .= ' <dd class="small">' . t($type) . ($item['user'] ? ' - '. $item['user'] : '') .''. ($item['date'] ? ' - '. format_date($item['date'], 'small') : '') .'</dd>';
Dries's avatar
   
Dries committed
689
  }
Dries's avatar
   
Dries committed
690
691
692
693

  return $output;
}

Kjartan's avatar
Kjartan committed
694
695
696
697
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
698
 * 'site.com/search', but also as a simple search box (without "Restrict search
Dries's avatar
   
Dries committed
699
700
 * to", help text, etc) from theme's header etc. This means: provide options to
 * only conditionally render certain parts of this form.
Kjartan's avatar
Kjartan committed
701
 *
Dries's avatar
   
Dries committed
702
703
704
705
 * @param $action Form action. Defaults to 'site.com/search'.
 * @param $keys string containing keywords for the search.
 * @param $options != 0: Render additional form fields/text ("Restrict search
 *   to", help text, etc).
Kjartan's avatar
Kjartan committed
706
 */
Dries's avatar
   
Dries committed
707
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
   
Dries committed
708
709
  $edit = $_POST['edit'];

Dries's avatar
   
Dries committed
710
  if (!$action) {
Dries's avatar
   
Dries committed
711
    $action = url('search');
Dries's avatar
   
Dries committed
712
713
  }

Dries's avatar
   
Dries committed
714
715
  $output = ' <div class="search-form"><br /><input type="text" class="form-text" size="50" value="'. check_form($keys) .'" name="keys" />';
  $output .= ' <input type="submit" class="form-submit" value="'. t('Search') ."\" />\n";
Dries's avatar
   
Dries committed
716

Dries's avatar
Dries committed
717
  if ($options) {
Dries's avatar
   
Dries committed
718
719
    $output .= '<br />';
    $output .= t('Restrict search to') .': ';
Dries's avatar
   
Dries committed
720
721

    foreach (module_list() as $name) {
Dries's avatar
   
Dries committed
722
723
      if (module_hook($name, 'search')) {
        $output .= ' <input type="checkbox" name="edit[type]['. $name .']" '. ($edit['type'][$name] ? ' checked="checked"' : '') .' /> '. t($name);
Dries's avatar
   
Dries committed
724
725
726
      }
    }
  }
727
  $output .= '</div>';
Dries's avatar
   
Dries committed
728

Dries's avatar
   
Dries committed
729
  return form($output, 'post', $action);
Dries's avatar
   
Dries committed
730
731
732
}

/*
Kjartan's avatar
Kjartan committed
733
734
 * Collect the search results:
 */
Dries's avatar
   
Dries committed
735
function search_data($keys = NULL) {
Dries's avatar
   
Dries committed
736
  $edit = $_POST['edit'];
Dries's avatar
   
Dries committed
737
  $output = '';
Dries's avatar
   
Dries committed
738

Dries's avatar
   
Dries committed
739
  if (isset($keys)) {
Dries's avatar
   
Dries committed
740
    foreach (module_list() as $name) {
Dries's avatar
   
Dries committed
741
742
      if (module_hook($name, 'search') && (!$edit['type'] || $edit['type'][$name])) {
        list($title, $results) = module_invoke($name, 'search', $keys);
Dries's avatar
   
Dries committed
743
        if ($results) {
Dries's avatar
   
Dries committed
744
745
          $output .= '<h2>'. $title .'</h2>';
          $output .= '<dl class="search-results">';
Dries's avatar
   
Dries committed
746
747
748
          foreach ($results as $entry) {
            $output .= search_item($entry, $name);
          }
Dries's avatar
   
Dries committed
749
          $output .= '</dl>';
Dries's avatar
   
Dries committed
750
751
752
753
754
755
756
757
        }
      }
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
758
759
760
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
   
Dries committed
761
762
763
764
765
766
 * @param $type If set, search only nodes of this type. Otherwise, search all
 *   types.
 * @param $action Form action. Defaults to 'site.com/search'.
 * @param $keys Query string. Defaults to global $keys.
 * @param $options != 0: Render additional form fields/text ("Restrict search
 *   to", help text, etc).
Kjartan's avatar
Kjartan committed
767
 */
Dries's avatar
   
Dries committed
768
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
   
Dries committed
769
  $_POST['edit']['type'][$type] = 'on';
Dries's avatar
   
Dries committed
770

Dries's avatar
   
Dries committed
771
  return search_form($action, $keys, $options) . '<br />'. search_data($keys);
Dries's avatar
   
Dries committed
772
}
773
774
775
776

/**
 * @} end of defgroup search
 */
Dries's avatar
   
Dries committed
777

Dries's avatar
   
Dries committed
778
function check_form($text) {
Dries's avatar
   
Dries committed
779
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
   
Dries committed
780
781
}

782
783
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
   
Dries committed
784
785
}

Dries's avatar
   
Dries committed
786
787
788
789
790
791
792
/**
 * @name Formatting
 *
 * Functions to format numbers, strings, dates, etc.
 * @{
 */

Dries's avatar
   
Dries committed
793
794
795
796
797
798
/**
 * 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
799
800
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
801
  $output = "<channel>\n";
Dries's avatar
   
Dries committed
802
803
804
805
  $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
806
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
807
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
   
Dries committed
808
  }
Dries's avatar
   
Dries committed
809
810
811
812
813
814
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
   
Dries committed
815
816
817
818
819
/**
 * Format a single RSS item.
 *
 * Arbitrary elements may be added using the $args associative array.
 */
Dries's avatar
   
Dries committed
820
function format_rss_item($title, $link, $description, $args = array()) {
Dries's avatar
Dries committed
821
  $output = "<item>\n";
Dries's avatar
   
Dries committed
822
823
  $output .= ' <title>'. drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= ' <link>'. drupal_specialchars(strip_tags($link)) ."</link>\n";
824
  $output .= ' <description>'. drupal_specialchars($description) ."</description>\n";
Dries's avatar
   
Dries committed
825
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
826
    $output .= ' <'. $key .'>'. drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
   
Dries committed
827
  }
Dries's avatar
   
Dries committed
828
829
830
831
832
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
   
Dries committed
833
/**
Dries's avatar
   
Dries committed
834
 * Format a string containing a count of items.
Dries's avatar
   
Dries committed
835
 *
Dries's avatar
   
Dries committed
836
837
838
839
840
841
842
843
844
845
846
847
848
849
 * 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
850
 */
Dries's avatar
   
Dries committed
851
function format_plural($count, $singular, $plural) {
Dries's avatar
   
Dries committed
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
  if ($count == 1) return t($singular);

  // 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":
        return t($singular);
      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
869
870
}

Dries's avatar
   
Dries committed
871
/**
Dries's avatar
   
Dries committed
872
 * Generate a string representation for the given byte count.
Dries's avatar
   
Dries committed
873
 *
Dries's avatar
   
Dries committed
874
875
876
877
 * @param $size
 *   The size in bytes.
 * @return
 *   A translated string representation of the size.
Dries's avatar
   
Dries committed
878
 */
Dries's avatar
   
Dries committed
879
function format_size($size) {
Dries's avatar
   
Dries committed
880
  $suffix = t('bytes');
Dries's avatar
   
Dries committed
881
882
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
883
    $suffix = t('KB');
Dries's avatar
   
Dries committed
884
885
886
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
887
    $suffix = t('MB');
Dries's avatar
   
Dries committed
888
  }
Dries's avatar
   
Dries committed
889
  return t('%size %suffix', array('%size' => $size, '%suffix' => $suffix));
Dries's avatar
   
Dries committed
890
891
}

Dries's avatar
   
Dries committed
892
/**
Dries's avatar
   
Dries committed
893
 * Format a time interval with the requested granularity.
Dries's avatar
   
Dries committed
894
 *
Dries's avatar
   
Dries committed
895
896
897
898
899
900
 * @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
901
 */
Dries's avatar
   
Dries committed
902
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
   
Dries committed
903
  $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
904
  $output = '';
Dries's avatar
   
Dries committed
905
  foreach ($units as $key => $value) {
Dries's avatar
   
Dries committed
906
    $key = explode('|', $key);
Dries's avatar
   
Dries committed
907
    if ($timestamp >= $value) {
Dries's avatar
   
Dries committed
908
      $output .= ($output ? ' ' : '') . format_plural(floor($timestamp / $value), $key[0], $key[1]);
Dries's avatar
   
Dries committed
909
      $timestamp %= $value;
Dries's avatar
   
Dries committed
910
911
912
913
914
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
   
Dries committed
915
916
    }
  }
Dries's avatar
   
Dries committed
917
  return $output ? $output : t('0 sec');
Dries's avatar
   
Dries committed
918
919
}

Dries's avatar
   
Dries committed
920
/**
Dries's avatar
   
Dries committed
921
922
 * Format a date with the given configured format or a custom format string.
 *
Dries's avatar
   
Dries committed
923
924
925
926
 * 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
927
928
929
930
931
932
933
934
935
936
937
 * @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
938
 */
939
940
941
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
Steven Wittens's avatar
Steven Wittens committed
942
943
944
945
946
947
    if (variable_get('configurable_timezones', 1) && $user->uid && strlen($user->timezone)) {
      $timezone = $user->timezone;
    }
    else {
      $timezone = variable_get('date_default_timezone', 0);
    }
948
  }
Dries's avatar
   
Dries committed
949

950
  $timestamp += $timezone;
Dries's avatar
   
Dries committed
951
952

  switch ($type) {
953
954
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
   
Dries committed
955
      break;
956
957
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
   
Dries committed
958
      break;
959
    case 'custom':
Dries's avatar
   
Dries committed
960
      // No change to format
Dries's avatar
   
Dries committed
961
      break;
962
    case 'medium':
Dries's avatar
   
Dries committed
963
    default:
964
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
   
Dries committed
965
966
  }

967
  $max = strlen($format);
Dries's avatar
   
Dries committed
968
  $date = '';
Dries's avatar
   
Dries committed
969
970
  for ($i = 0; $i < $max; $i++) {
    $c = $format{$i};
971
    if (strpos('AaDFlM', $c) !== false) {
972
      $date .= t(gmdate($c, $timestamp));
973
    }
974
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c) !== false) {
975
976
977
978
      $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
979
    }
980
981
982
983
984
    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
985
986
    }
    else {
987
      $date .= $c;
Dries's avatar
   
Dries committed
988
    }
Dries's avatar
   
Dries committed
989
  }
990

Dries's avatar
   
Dries committed
991
992
993
  return $date;
}

Dries's avatar
   
Dries committed
994
/**
Dries's avatar
   
Dries committed
995
 * Format a username.
Dries's avatar
   
Dries committed
996
 *
Dries's avatar
   
Dries committed
997
998
999
1000
1001
 * @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
1002
 */
Dries's avatar
   
Dries committed
1003
1004
1005
function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
   
Dries committed
1006
    // Shorten the name when it is too long or it will break many tables.
Dries's avatar
Dries committed
1007
    if (strlen($object->name) > 20) {
Dries's avatar
   
Dries committed
1008
      $name = truncate_utf8($object->name, 15) .'...';
Dries's avatar
Dries committed
1009
1010
1011
1012
1013
    }
    else {
      $name = $object->name;
    }

Dries's avatar
   
Dries committed
1014
    $output = l($name, 'user/'. $object->uid, array('title' => t('View user profile.')));
Dries's avatar
   
Dries committed
1015
  }
Dries's avatar
   
Dries committed
1016
  else if ($object->name) {
Dries's avatar
   
Dries committed
1017
1018
1019
1020
    // 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
1021
    if ($object->homepage) {
Dries's avatar
   
Dries committed
1022
      $output = '<a href="'. $object->homepage .'">'. $object->name .'</a>';
Dries's avatar
   
Dries committed
1023
1024
1025
1026
1027
1028
    }
    else {
      $output = $object->name;
    }

    $output .= ' ('. t('not verified') .')';
Dries's avatar
   
Dries committed
1029
  }
Dries's avatar
   
Dries committed
1030
  else {
Dries's avatar
   
Dries committed
1031
    $output = t(variable_get('anonymous', 'Anonymous'));
Dries's avatar
   
Dries committed
1032
1033
  }

Dries's avatar
   
Dries committed
1034
  return $output;
Dries's avatar
   
Dries committed
1035
}
Dries's avatar
   
Dries committed
1036
/* @} */
Dries's avatar
   
Dries committed
1037

Kjartan's avatar
Kjartan committed
1038
/**
Dries's avatar
   
Dries committed
1039
 * @defgroup form Form generation
Kjartan's avatar
Kjartan committed
1040
 * @{
1041
1042
 *
 *
Kjartan's avatar
Kjartan committed
1043
 */
Dries's avatar
   
Dries committed
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059

/**
 * 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
1060
  if (!$action) {
1061
    $action = request_uri();
Dries's avatar
   
Dries committed
1062
  }
Dries's avatar
   
Dries committed
1063
  return '<form action="'. $action .'" method="'. $method .'"'. drupal_attributes($attributes) .">\n". $form ."\n</form>\n";
Dries's avatar
   
Dries committed
1064
1065
}

Dries's avatar
   
Dries committed
1066
/**
Dries's avatar
   
Dries committed
1067
 * File an error against the form element with the specified name.
Dries's avatar
   
Dries committed
1068
1069
1070
1071
1072
1073
1074
 */
function form_set_error($name, $message) {
  $GLOBALS['form'][$name] = $message;
  drupal_set_message($message, 'error');
}

/**
Dries's avatar
   
Dries committed
1075
 * Return an associative array of all errors.
Dries's avatar
   
Dries committed
1076
 */
Dries's avatar
   
Dries committed
1077
function form_get_errors() {
1078
1079
1080
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'];
  }