common.inc 57 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 .= theme('stylesheet_import', 'misc/drupal.css');
Dries's avatar
Dries committed
91
92
93
94
95

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

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

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

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

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

  return $map;
}

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

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

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

Dries's avatar
Dries committed
156
157
158
159
160
161
162
/**
 * @name HTTP headers
 *
 * Functions to get and set the HTTP headers of the current page.
 * @{
 */
function drupal_set_header($header = NULL) {
163
164
165
166
  // 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
167

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  fwrite($fp, $request);

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

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

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

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

405
  if ($errno & (E_ALL ^ E_NOTICE)) {
406
    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
407
    if (error_reporting()) {
Dries's avatar
   
Dries committed
408
      print '<pre>'. $entry .'</pre>';
Dries's avatar
Dries committed
409
    }
Dries's avatar
   
Dries committed
410
411
412
  }
}

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

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

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

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

  return $object;
}

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

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

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

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

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

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

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

Kjartan's avatar
Kjartan committed
524
/**
Dries's avatar
   
Dries committed
525
 * Translate strings to the current locale.
Kjartan's avatar
Kjartan committed
526
 *
527
528
529
530
 * 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
531
532
533
534
535
 * @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
536
537
538
 * 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
539
 *
Dries's avatar
   
Dries committed
540
541
542
543
544
545
546
 * @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
547
 */
Dries's avatar
   
Dries committed
548
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
549
550
551
552
  global $locale;
  if (function_exists('locale') && $locale != 'en') {
    $string = locale($string);
  }
553

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Dries's avatar
   
Dries committed
682
683
  if (module_hook($type, 'search_item')) {
    $output = module_invoke($type, 'search_item', $item);
Dries's avatar
   
Dries committed
684
685
  }
  else {
Dries's avatar
   
Dries committed
686
687
    $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
688
  }
Dries's avatar
   
Dries committed
689
690
691
692

  return $output;
}

Kjartan's avatar
Kjartan committed
693
694
695
696
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
697
 * 'site.com/search', but also as a simple search box (without "Restrict search
Dries's avatar
   
Dries committed
698
699
 * 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
700
 *
Dries's avatar
   
Dries committed
701
702
703
704
 * @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
705
 */
Dries's avatar
   
Dries committed
706
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
   
Dries committed
707
708
  $edit = $_POST['edit'];

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

Dries's avatar
   
Dries committed
713
714
  $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
715

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

    foreach (module_list() as $name) {
Dries's avatar
   
Dries committed
721
722
      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
723
724
725
      }
    }
  }
726
  $output .= '</div>';
Dries's avatar
   
Dries committed
727

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

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

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

  return $output;
}

Kjartan's avatar
Kjartan committed
757
758
759
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
   
Dries committed
760
761
762
763
764
765
 * @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
766
 */
Dries's avatar
   
Dries committed
767
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
   
Dries committed
768
  $_POST['edit']['type'][$type] = 'on';
Dries's avatar
   
Dries committed
769

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

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

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

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

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

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

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

  return $output;
}

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

  return $output;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/**
 * Return the error message filed against the form with the specified name.
 */
function _form_get_error($name) {
Dries's avatar
   
Dries committed
1086
1087
1088
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'][$name];
  }
Dries's avatar
   
Dries committed
1089
1090
1091
1092
1093
1094
}

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

Dries's avatar
   
Dries committed
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
/**
 * 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
1113
function form_item($title, $value, $description = NULL, $id = NULL, $required = FALSE, $error = FALSE) {
Dries's avatar
   
Dries committed
1114
  return theme('form_element', $title, $value, $description, $id, $required, $error);
Dries's avatar
   
Dries committed
1115
}
Dries's avatar
   
Dries committed
1116

Dries's avatar
   
Dries committed
1117
1118
1119
1120
1121
1122
1123
1124
1125