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

Dries's avatar
   
Dries committed
4
/**
Kjartan's avatar
Kjartan committed
5
6
 * @defgroup common Core functions
 */
7
 
Kjartan's avatar
Kjartan committed
8
9
10
/**
 * @name Page title
 * @ingroup common
Dries's avatar
   
Dries committed
11
12
13
14
 *
 * Functions to get and set the title of the current page.
 * @{
 */
Dries's avatar
   
Dries committed
15
16
17
18
function drupal_set_title($title = NULL) {
  static $stored_title;

  if (isset($title)) {
Dries's avatar
   
Dries committed
19
    $stored_title = ucfirst($title);
Dries's avatar
   
Dries committed
20
21
22
23
24
25
26
27
28
29
30
31
32
  }
  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
33
/* @} */
Dries's avatar
   
Dries committed
34

Dries's avatar
   
Dries committed
35
/**
Kjartan's avatar
Kjartan committed
36
37
 * @name Page messages
 * @ingroup common
Dries's avatar
   
Dries committed
38
39
40
41
 *
 * Functions to get and set the message of the current page.
 * @{
 */
Dries's avatar
   
Dries committed
42
function drupal_set_message($message = NULL, $type = "status") {
43
44
45
  if (!isset($_SESSION['messages'])) {
    $_SESSION['messages'] = array();
  }
Dries's avatar
   
Dries committed
46
47

  if (isset($message)) {
48
    $_SESSION['messages'][] = array($message, $type);
Dries's avatar
   
Dries committed
49
50
  }

51
  return $_SESSION['messages'];
Dries's avatar
   
Dries committed
52
53
}

Dries's avatar
   
Dries committed
54
function drupal_get_messages() {
55
56
57
58
  $messages = drupal_set_message();
  $_SESSION['messages'] = array();

  return $messages;
Dries's avatar
   
Dries committed
59
}
Dries's avatar
   
Dries committed
60

Kjartan's avatar
Kjartan committed
61
/* @} */
Dries's avatar
   
Dries committed
62

Dries's avatar
   
Dries committed
63
/**
Kjartan's avatar
Kjartan committed
64
65
 * @name Page breadcrumbs
 * @ingroup common
Dries's avatar
   
Dries committed
66
67
68
69
 *
 * Functions to get and set the breadcrumb trail of the current page.
 * @{
 */
Kjartan's avatar
Kjartan committed
70
71
72
73
74

/**
 * @param $breadcrumb Array of links, starting with "home" and proceeding up
 *   to but not including the current page.
 */
Dries's avatar
   
Dries committed
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
93
/* @} */
Dries's avatar
   
Dries committed
94

Dries's avatar
Dries committed
95
96
97
98
99
100
101
102
103
/**
 * @name HTML head contents
 * @ingroup common
 *
 * Set and get output that should be in the \<head\> tag.
 * @{
 */

function drupal_set_html_head($data = NULL) {
Dries's avatar
   
Dries committed
104
  static $stored_head = '';
Dries's avatar
Dries committed
105
106
107
108
109
110
111
112
113
114

  if (!is_null($data)) {
    $stored_head .= "$data\n";
  }
  return $stored_head;
}

function drupal_get_html_head() {
  global $base_url;

Dries's avatar
   
Dries committed
115
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
116
  $output .= "<base href=\"$base_url/\" />\n";
Dries's avatar
   
Dries committed
117
  $output .= "<style type=\"text/css\" media=\"all\">\n";
Dries's avatar
Dries committed
118
119
120
121
122
123
124
  $output .= "@import url(misc/drupal.css);\n";
  $output .= "</style>\n";

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

Dries's avatar
   
Dries committed
125
/**
Dries's avatar
   
Dries committed
126
 * @name URL path alias
Kjartan's avatar
Kjartan committed
127
128
 * @ingroup common
 *
Dries's avatar
   
Dries committed
129
 * Functions to handle path aliases.
Dries's avatar
   
Dries committed
130
 */
Dries's avatar
   
Dries committed
131
function drupal_get_path_map($action = "") {
Dries's avatar
Dries committed
132
  static $map = NULL;
Dries's avatar
   
Dries committed
133

Dries's avatar
   
Dries committed
134
135
136
137
  if ($action == "rebuild") {
    $map = NULL;
  }

Dries's avatar
Dries committed
138
  if (is_null($map)) {
Dries's avatar
   
Dries committed
139
    $map = array();  // make $map non-null in case no aliases are defined
Dries's avatar
   
Dries committed
140
    $result = db_query("SELECT * FROM {url_alias}");
Dries's avatar
   
Dries committed
141
    while ($data = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
142
      $map[$data->dst] = $data->src;
Dries's avatar
   
Dries committed
143
144
145
146
147
148
    }
  }

  return $map;
}

Dries's avatar
   
Dries committed
149
150
151
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}
Kjartan's avatar
Kjartan committed
152
153

/**
Dries's avatar
   
Dries committed
154
 * Given an old url, return the alias.
Kjartan's avatar
Kjartan committed
155
 */
Dries's avatar
   
Dries committed
156
157
158
159
160
161
162
function drupal_get_path_alias($path) {
  if (($map = drupal_get_path_map()) && ($newpath = array_search($path, $map))) {
    return $newpath;
  }
  elseif (function_exists("conf_url_rewrite")) {
    return conf_url_rewrite($path, 'outgoing');
  }
163
164
165
166
  else {
    // No alias found. Return the normal path.
    return $path;
  }
Dries's avatar
   
Dries committed
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
}

/**
 * Given an alias, return the default url.
 */
function drupal_get_normal_path($path) {
  if (($map = drupal_get_path_map()) && isset($map[$path])) {
    return $map[$path];
  }
  elseif (function_exists("conf_url_rewrite")) {
    return conf_url_rewrite($path, 'incoming');
  }
  else {
    return $path;
  }
}
/* @} */
Kjartan's avatar
Kjartan committed
184

Dries's avatar
Dries committed
185
186
187
188
189
190
191
192
/**
 * @name HTTP headers
 * @ingroup common
 *
 * Functions to get and set the HTTP headers of the current page.
 * @{
 */
function drupal_set_header($header = NULL) {
Dries's avatar
   
Dries committed
193
  static $stored_headers = '';
Dries's avatar
Dries committed
194
195
196
197
198
199
200
201
202
203
204
205
206

  if (!is_null($header)) {
    header($header);
    $stored_headers .= "$header\n";
  }
  return $stored_headers;
}

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

Dries's avatar
   
Dries committed
207
208
209
210
211
212
213
214
/**
 * @name HTTP handling
 * @ingroup common
 *
 * Functions to properly handle HTTP responses.
 * @{
 */

Kjartan's avatar
Kjartan committed
215
216
217
218
219
220
/**
 * HTTP redirects. Makes sure the redirected url is formatted correctly and
 * includes the session ID.
 *
 * @note This function ends the request.
 *
Dries's avatar
Dries committed
221
222
223
 * @param $url A Drupal URL
 * @param $query Query string component
 * @param $fragment Fragment identifier
Kjartan's avatar
Kjartan committed
224
 */
Dries's avatar
Dries committed
225
function drupal_goto($url = NULL, $query = NULL, $fragment = NULL) {
Kjartan's avatar
Kjartan committed
226
227

  /*
Dries's avatar
Dries committed
228
  ** Translate &amp; to simply & in the absolute URL
Kjartan's avatar
Kjartan committed
229
  */
Dries's avatar
   
Dries committed
230

Dries's avatar
Dries committed
231
  $url = str_replace("&amp;", "&", url($url, $query, $fragment, TRUE));
Kjartan's avatar
Kjartan committed
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263

  /*
  ** It is advised to use "drupal_goto()" instead of PHP's "header()" as
  ** "drupal_goto()" will append the user's session ID to the URI when PHP
  ** is compiled with "--enable-trans-sid".
  */
  if (!ini_get("session.use_trans_sid") || !session_id() || strstr($url, session_id())) {
    header("Location: $url");
  }
  else {
    $sid = session_name() . "=" . session_id();

    if (strstr($url, "?") && !strstr($url, $sid)) {
      header("Location: $url&". $sid);
    }
    else {
      header("Location: $url?". $sid);
    }
  }

  /*
  ** 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/ gets executed when we redirect.
  */

  exit();
}

/**
 * Generates a 404 error if the request can not be handled.
 */
Dries's avatar
   
Dries committed
264
function drupal_not_found() {
Dries's avatar
   
Dries committed
265
266
  header('HTTP/1.0 404 Not Found');
  watchdog('httpd', '404 error: "'. check_query($_GET['q']) .'" not found');
Dries's avatar
   
Dries committed
267
268

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries's avatar
   
Dries committed
269
  $status = MENU_FALLTHROUGH;
Dries's avatar
   
Dries committed
270
271
  if ($path) {
    menu_set_active_item($path);
Dries's avatar
   
Dries committed
272
    $status = menu_execute_active_handler();
Dries's avatar
   
Dries committed
273
274
  }

Dries's avatar
   
Dries committed
275
  if ($status != MENU_FOUND) {
Dries's avatar
Dries committed
276
    print theme('page', '', t('Page not found'));
Dries's avatar
   
Dries committed
277
278
  }
}
Dries's avatar
   
Dries committed
279

Dries's avatar
   
Dries committed
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
/**
 * 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', ''));
  $status = MENU_FALLTHROUGH;
  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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
/**
 * Flexible and powerful HTTP client implementation. Allows to GET, POST, PUT
 * or any other HTTP requests. Handles redirects.
 *
 * @param $url A string containing a fully qualified URI.
 * @param $headers An array containing a 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.
 */
function drupal_http_request($url, $headers = array(), $method = 'GET', $data = NULL, $retry = 3) {
  // Parse the URL, and make sure we can handle the schema
  $uri = parse_url($url);
  switch ($uri['scheme']) {
    case 'http':
      $fp = @fsockopen($uri['host'], ($uri['port'] ? $uri['port'] : 80), $errno, $errstr, 15);
      break;
    case 'https':
      // Note: only works for PHP 4.3 compiled with openssl
      $fp = @fsockopen("ssl://$uri[host]", ($uri['port'] ? $uri['port'] : 443), $errno, $errstr, 20);
      break;
    default:
      $result->error = "invalid schema $uri[scheme]";
      return $result;
  }

  // Make sure the socket opened properly
  if (!$fp) {
    $result->error = trim("$errno $errstr");
    return $result;
  }

  // Construct the path to act on
  $path = $uri['path'] ? $uri['path'] : '/';
  if ($uri['query']) {
    $path .= "?$uri[query]";
  }

  // Create http request
  $defaults = array(
341
342
343
    'Host' => "Host: $uri[host]",
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
   
Dries committed
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
  );

  foreach ($headers as $header => $value) {
    $defaults[$header] = "$header: $value";
  }

  $request = "$method $path HTTP/1.0\r\n";
  $request .= implode("\r\n", $defaults);
  $request .= "\r\n\r\n";
  if ($data) {
    $request .= "$data\r\n";
  }
  $result->request = $request;

  fwrite($fp, $request);

  // Fetch response.
361
  $response = '';
362
  while (!feof($fp) && $data = fread($fp, 1024)) {
363
    $response .= $data;
Dries's avatar
   
Dries committed
364
365
366
367
  }
  fclose($fp);

  // Parse response.
368
  $response = preg_split("/\r\n|\n|\r/", $response);
Dries's avatar
   
Dries committed
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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
  list($protocol, $code, $text) = explode(' ', trim(array_shift($response)), 3);
  $result->headers = array();
  $result->data = '';

  // Parse headers.
  while ($line = trim(array_shift($response))) {
    if ($line == '') {
      break;
    }
    list($header, $value) = explode(':', $line, 2);
    $result->headers[$header] = trim($value);
  }

  $result->data = implode('', $response);

  $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
420
/* @} */
Dries's avatar
   
Dries committed
421

Dries's avatar
   
Dries committed
422
423
424
function error_handler($errno, $message, $filename, $line, $variables) {
  $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
425
426

  if ($errno & E_ALL ^ E_NOTICE) {
Dries's avatar
   
Dries committed
427
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
Dries's avatar
Dries committed
428
429
430
    if (error_reporting()) {
      print "<pre>$entry</pre>";
    }
Dries's avatar
   
Dries committed
431
432
433
  }
}

Dries's avatar
Dries committed
434
435
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
436
437
438
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
439
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
440
441
442
  }
}

Dries's avatar
   
Dries committed
443
444
function fix_gpc_magic() {
  static $fixed = false;
Kjartan's avatar
Kjartan committed
445
  if (!$fixed && ini_get("magic_quotes_gpc")) {
Dries's avatar
Dries committed
446
447
448
449
450
451
    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
452
453
}

Kjartan's avatar
Kjartan committed
454
455
456
457
458
459
460
/**
 * @name Conversion
 * @ingroup common
 *
 * Converts data structures to a different type.
 * @{
 */
Dries's avatar
Dries committed
461
462
463
function array2object($array) {
  if (is_array($array)) {
    foreach ($array as $key => $value) {
Dries's avatar
   
Dries committed
464
465
466
467
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
468
    $object = $array;
Dries's avatar
   
Dries committed
469
470
471
472
473
  }

  return $object;
}

Dries's avatar
Dries committed
474
475
476
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
   
Dries committed
477
478
479
480
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
481
    $array = $object;
Dries's avatar
   
Dries committed
482
483
484
485
  }

  return $array;
}
Kjartan's avatar
Kjartan committed
486
/* @} */
Dries's avatar
   
Dries committed
487

Kjartan's avatar
Kjartan committed
488
489
490
491
492
493
494
/**
 * @name Messages
 * @ingroup common
 *
 * Frequently used messages.
 * @{
 */
Dries's avatar
   
Dries committed
495
function message_access() {
Dries's avatar
   
Dries committed
496
  return t("You are not authorized to access this page.");
Dries's avatar
   
Dries committed
497
498
499
500
501
502
}

function message_na() {
  return t("n/a");
}

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

Dries's avatar
   
Dries committed
505
506
function locale_init() {
  global $languages, $user;
Dries's avatar
   
Dries committed
507
508
509
510
511
512
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
   
Dries committed
513
514
}

Kjartan's avatar
Kjartan committed
515
516
517
518
519
/**
 * @ingroup common
 *
 * Translates strings to the current locale.
 *
520
521
522
523
 * 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:
Kjartan's avatar
Kjartan committed
524
525
526
527
528
 * @code
 *   $msg = t("You must login below or \<a href=\"%url\"\>create a new
 *             account\</a\> before viewing the next page.", array("%url"
 *             => url("user/register")));
 * @endcode
529
530
531
 * 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
532
533
534
535
536
 *
 * @param $string A string containing the english string to translate.
 * @param $args Array of values to replace in the string.
 * @return Translated string.
 */
Dries's avatar
   
Dries committed
537
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
538
  global $languages;
539

540
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
541

Dries's avatar
   
Dries committed
542
543
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
544
545
  }
  else {
Dries's avatar
   
Dries committed
546
547
    return strtr($string, $args);
  }
Dries's avatar
   
Dries committed
548
549
}

Dries's avatar
   
Dries committed
550
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
   
Dries committed
551
552
553
554
555
556
557
558
559

  /*
  ** Note that we'd like to go 'htmlspecialchars($input, $quotes, "utf-8")'
  ** like the PHP manual tells us to, 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.  Change this later once we make PHP 4.3 a requirement.
  */

  return htmlspecialchars($input, $quotes);
Dries's avatar
   
Dries committed
560
561
}

Kjartan's avatar
Kjartan committed
562
563
564
565
566
/**
 * @name Validation
 * @ingroup common
 *
 * Functions to validate user input.
Dries's avatar
   
Dries committed
567
 * @{
Kjartan's avatar
Kjartan committed
568
569
 */

570
/**
Dries's avatar
   
Dries committed
571
572
 * Verify the syntax of the given e-mail address. Empty e-mail addresses are
 * allowed. See RFC 2822 for details.
573
 *
Kjartan's avatar
Kjartan committed
574
 * @param $mail A string containing an email address.
Dries's avatar
   
Dries committed
575
 * @return
576
 */
Dries's avatar
   
Dries committed
577
function valid_email_address($mail) {
578
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
579
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
580
581
582
  $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
583
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
584
585
}

Dries's avatar
   
Dries committed
586
587
588
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
   
Dries committed
589
590
591
592
593
594
 * @param $url
 *   an URL
 * @param $absolute
 *   is the URL to be verified absolute, ie. of the form \<scheme\>://\<hostname\>/...?
 * @return
 *   valid syntax: TRUE; FALSE otherwise
Dries's avatar
   
Dries committed
595
 */
Dries's avatar
   
Dries committed
596
function valid_url($url, $absolute = FALSE) {
597
  if ($absolute) {
598
    return preg_match("/^(http|https|ftp):\/\/[a-z0-9\/:_\-_\.\?,~=#&]+$/i", $url);
599
600
  }
  else {
601
    return preg_match("/^[a-z0-9\/:_\-_\.,]+$/i", $url);
602
  }
Dries's avatar
   
Dries committed
603
604
}

Kjartan's avatar
Kjartan committed
605
606
607
608
609
610
611
function valid_input_data($data) {
  if (is_array($data) || is_object($data)) {
    /*
    ** Form data can contain a number of nested arrays.
    */

    foreach ($data as $key => $value) {
Dries's avatar
   
Dries committed
612
      if (!valid_input_data($key) || !valid_input_data($value)) {
Kjartan's avatar
Kjartan committed
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
        return 0;
      }
    }
  }
  else {
    /*
    ** Detect evil input data.
    */

    // check strings:
    $match  = preg_match("/\Wjavascript\s*:/i", $data);
    $match += preg_match("/\Wexpression\s*\(/i", $data);
    $match += preg_match("/\Walert\s*\(/i", $data);

    // check attributes:
    $match += preg_match("/\W(dynsrc|datasrc|data|lowsrc|on[a-z]+)\s*=[^>]+?>/i", $data);

    // check tags:
    $match += preg_match("/<\s*(applet|script|object|style|embed|form|blink|meta|html|frame|iframe|layer|ilayer|head|frameset|xml)/i", $data);

    if ($match) {
      watchdog("warning", "terminated request because of suspicious input data: ". drupal_specialchars($data));
      return 0;
    }
  }

  return 1;
}
/* @} */

/**
 * @defgroup search Search interface
 * @{
 */
Kjartan's avatar
Kjartan committed
647
648
649
/**
 * Format a single result entry of a search query:
 *
Dries's avatar
   
Dries committed
650
 * @param $item a single search result as returned by <i>module</i>_search of
651
 *   type array("count" => ..., "link" => ..., "title" => ..., "user" => ...,
Dries's avatar
   
Dries committed
652
653
 *   "date" => ..., "keywords" => ...)
 * @param $type module type of this item
Kjartan's avatar
Kjartan committed
654
 */
Dries's avatar
   
Dries committed
655
function search_item($item, $type) {
Dries's avatar
   
Dries committed
656
657
658
659
660
661
662
663
664
665

  /*
  ** Modules may implement the "search_item" hook in order to overwrite
  ** the default function to display search results.
  */

  if (module_hook($type, "search_item")) {
    $output = module_invoke($type, "search_item", $item);
  }
  else {
666
667
    $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
668
  }
Dries's avatar
   
Dries committed
669
670
671
672

  return $output;
}

Kjartan's avatar
Kjartan committed
673
674
675
676
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
   
Dries committed
677
678
679
 * 'site.com/search', but also as a simple seach box (without "Restrict search
 * 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
680
 *
Dries's avatar
   
Dries committed
681
682
683
684
 * @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
685
 */
Dries's avatar
   
Dries committed
686
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
   
Dries committed
687
688
  $edit = $_POST['edit'];

Dries's avatar
   
Dries committed
689
  if (!$action) {
Dries's avatar
   
Dries committed
690
    $action = url("search");
Dries's avatar
   
Dries committed
691
692
  }

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

Dries's avatar
Dries committed
696
  if ($options) {
Dries's avatar
   
Dries committed
697
698
699
700
701
    $output .= "<br />";
    $output .= t("Restrict search to") .": ";

    foreach (module_list() as $name) {
      if (module_hook($name, "search")) {
Kjartan's avatar
Kjartan committed
702
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
   
Dries committed
703
704
      }
    }
705
    $output .= "</div>";
Dries's avatar
   
Dries committed
706
707
708
709
710
711
  }

  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
712
713
 * Collect the search results:
 */
Dries's avatar
   
Dries committed
714
function search_data($keys = NULL) {
Dries's avatar
   
Dries committed
715
  $edit = $_POST["edit"];
Dries's avatar
   
Dries committed
716
  $output = '';
Dries's avatar
   
Dries committed
717

Dries's avatar
   
Dries committed
718
  if (isset($keys)) {
Dries's avatar
   
Dries committed
719
    foreach (module_list() as $name) {
Dries's avatar
   
Dries committed
720
721
722
723
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name])) {
        list($title, $results) = module_invoke($name, "search", $keys);
        if ($results) {
          $output .= "<h2>$title</h2>";
724
          $output .= "<dl class=\"search-results\">";
Dries's avatar
   
Dries committed
725
726
727
          foreach ($results as $entry) {
            $output .= search_item($entry, $name);
          }
728
          $output .= "</dl>";
Dries's avatar
   
Dries committed
729
730
731
732
733
734
735
736
        }
      }
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
737
738
739
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
   
Dries committed
740
741
742
743
744
745
 * @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
746
 */
Dries's avatar
   
Dries committed
747
748
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
  $_POST["edit"]["type"][$type] = "on";
Dries's avatar
   
Dries committed
749

Dries's avatar
   
Dries committed
750
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries's avatar
   
Dries committed
751
}
Kjartan's avatar
Kjartan committed
752
/* @} */
Dries's avatar
   
Dries committed
753

Dries's avatar
   
Dries committed
754
function check_form($text) {
Dries's avatar
   
Dries committed
755
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
   
Dries committed
756
757
}

758
759
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
   
Dries committed
760
761
}

Dries's avatar
   
Dries committed
762
763
764
765
766
767
768
769
/**
 * @name Formatting
 * @ingroup common
 *
 * Functions to format numbers, strings, dates, etc.
 * @{
 */

Dries's avatar
   
Dries committed
770
771
772
function format_rss_channel($title, $link, $description, $items, $language = "en", $args = array()) {
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
773
  $output = "<channel>\n";
Dries's avatar
   
Dries committed
774
775
  $output .= " <title>". drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= " <link>". drupal_specialchars(strip_tags($link)) ."</link>\n";
776
  $output .= " <description>". drupal_specialchars(strip_tags($description)) ."</description>\n";
Dries's avatar
   
Dries committed
777
  $output .= " <language>". drupal_specialchars(strip_tags($language)) ."</language>\n";
Dries's avatar
   
Dries committed
778
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
779
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
   
Dries committed
780
  }
Dries's avatar
   
Dries committed
781
782
783
784
785
786
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries's avatar
   
Dries committed
787
788
789
function format_rss_item($title, $link, $description, $args = array()) {
  // arbitrary elements may be added using the $args associative array

Dries's avatar
Dries committed
790
  $output = "<item>\n";
Dries's avatar
   
Dries committed
791
792
793
  $output .= " <title>". drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= " <link>". drupal_specialchars(strip_tags($link)) ."</link>\n";
  $output .= " <description>". drupal_specialchars(check_output($description)) ."</description>\n";
Dries's avatar
   
Dries committed
794
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
795
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
   
Dries committed
796
  }
Dries's avatar
   
Dries committed
797
798
799
800
801
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
   
Dries committed
802
803
/**
 * Formats a string with a count of items so that the string is pluralized
Dries's avatar
   
Dries committed
804
805
 * correctly. format_plural calls t() by itself, make sure not to pass already
 * localized strings to it.
Dries's avatar
   
Dries committed
806
 *
Dries's avatar
   
Dries committed
807
808
809
810
 * @param $count The item count to display.
 * @param $singular The string for the singular case. Please make sure it's
 *   clear this is singular, to ease translation. ("1 new comment" instead of "1
 *   new").
Kjartan's avatar
Kjartan committed
811
 * @param $plural The string for the plural case. Please make sure it's clear
Dries's avatar
   
Dries committed
812
813
 *   this is plural, to ease translation. Use %count in places of the item
 *   count, as in "%count new comments".
Dries's avatar
   
Dries committed
814
 * @return Translated string
Dries's avatar
   
Dries committed
815
 */
Dries's avatar
   
Dries committed
816
function format_plural($count, $singular, $plural) {
Dries's avatar
   
Dries committed
817
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
   
Dries committed
818
819
}

Dries's avatar
   
Dries committed
820
821
822
823
824
825
/**
 * Generates a string representation for the given byte count.
 *
 * @param $size The size in bytes
 * @return Translated string representation of the size
 */
Dries's avatar
   
Dries committed
826
function format_size($size) {
Dries's avatar
   
Dries committed
827
  $suffix = t("bytes");
Dries's avatar
   
Dries committed
828
829
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
830
    $suffix = t("KB");
Dries's avatar
   
Dries committed
831
832
833
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
834
    $suffix = t("MB");
Dries's avatar
   
Dries committed
835
  }
Dries's avatar
   
Dries committed
836
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
   
Dries committed
837
838
}

Dries's avatar
   
Dries committed
839
840
841
842
843
844
845
/**
 * Formats a time interval with the requested granularity.
 *
 * @param $timestamp The length of the interval in seconds
 * @param $granularity How much units to consider when generating the string
 * @return Translated string representation of the interval
 */
Dries's avatar
   
Dries committed
846
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
   
Dries committed
847
  $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
848
  $output = '';
Dries's avatar
   
Dries committed
849
  foreach ($units as $key => $value) {
Dries's avatar
   
Dries committed
850
851
852
853
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
Dries's avatar
   
Dries committed
854
855
856
857
858
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
   
Dries committed
859
860
    }
  }
Dries's avatar
   
Dries committed
861
  return $output ? $output : t("0 sec");
Dries's avatar
   
Dries committed
862
863
}

Dries's avatar
   
Dries committed
864
865
866
867
868
869
870
871
872
873
874
875
/**
 * Formats a date with the given configured format or a custom format string.
 * 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.
 *
 * @param $timestamp The exact date to format
 * @param $type Could be 'small', 'medium' or 'large' for the preconfigured
 *              date formats. If 'custom' is specified, the next parameter
 *              should contain the format string
 * @param $format Format string (as required by the PHP date() function).
 *                Only required if 'custom' date format is requested.
876
877
 * @param $timezone Timezone offset in seconds in case the user timezone
 *   should not be used.
Dries's avatar
   
Dries committed
878
879
 * @return Translated date string in the requested format
 */
880
881
882
883
884
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL) {
  if ($timezone === NULL) {
    global $user;
    $timezone = $user->uid ? $user->timezone : variable_get('date_default_timezone', 0);
  }
Dries's avatar
   
Dries committed
885

886
  $timestamp += $timezone;
Dries's avatar
   
Dries committed
887
888

  switch ($type) {
889
890
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
   
Dries committed
891
      break;
892
893
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
   
Dries committed
894
      break;
895
    case 'custom':
Dries's avatar
   
Dries committed
896
      // No change to format
Dries's avatar
   
Dries committed
897
      break;
898
    case 'medium':
Dries's avatar
   
Dries committed
899
    default:
900
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
   
Dries committed
901
902
  }

903
  $max = strlen($format);
Dries's avatar
   
Dries committed
904
  $date = '';
905
906
  for ($i = 0; $i <= $max; $c = $format{$i++}) {
    if (strpos('AaDFlM', $c)) {
907
      $date .= t(gmdate($c, $timestamp));
908
909
910
911
912
913
    }
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c)) {
      $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
914
    }
915
916
917
918
919
    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
920
921
    }
    else {
922
      $date .= $c;
Dries's avatar
   
Dries committed
923
    }
Dries's avatar
   
Dries committed
924
  }
925

Dries's avatar
   
Dries committed
926
927
928
  return $date;
}

Dries's avatar
   
Dries committed
929
930
931
932
933
934
935
936
/**
 * Formats a username.
 *
 * @param $object User object
 * @return String containing a HTML link to the user's page if the
 *         passed object suggests that this is a site user. Otherwise
 *         only the user name is returned.
 */
Dries's avatar
   
Dries committed
937
938
939
function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
Dries committed
940
941
942
943
944
945
    /*
    ** Shorten the name when it is too long or it will break many
    ** tables.
    */

    if (strlen($object->name) > 20) {
946
      $name = truncate_utf8($object->name, 15) ."...";
Dries's avatar
Dries committed
947
948
949
950
951
    }
    else {
      $name = $object->name;
    }

Dries's avatar
   
Dries committed
952
    if (arg(0) == "admin" and user_access("administer users")) {
Dries's avatar
Dries committed
953
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
   
Dries committed
954
955
    }
    else {
Dries's avatar
Dries committed
956
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
   
Dries committed
957
    }
Dries's avatar
   
Dries committed
958
  }
Dries's avatar
   
Dries committed
959
960
961
962
963
964
965
966
  else if ($object->name) {
    /*
    ** Sometimes modules display content composed by people who are
    ** not registers members of the site (i.e. mailing list or news
    ** aggregator modules).  This clause enables modules to display
    ** the true author of the content.
    */

Dries's avatar
   
Dries committed
967
968
969
970
971
972
973
974
    if ($object->homepage) {
      $output = "<a href=\"$object->homepage\">$object->name</a>";
    }
    else {
      $output = $object->name;
    }

    $output .= ' ('. t('not verified') .')';
Dries's avatar
   
Dries committed
975
  }
Dries's avatar
   
Dries committed
976
  else {
Dries's avatar
   
Dries committed
977
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
   
Dries committed
978
979
  }

Dries's avatar
   
Dries committed
980
  return $output;
Dries's avatar
   
Dries committed
981
}
Dries's avatar
   
Dries committed
982
/* @} */
Dries's avatar
   
Dries committed
983

Kjartan's avatar
Kjartan committed
984
985
986
987
/**
 * @defgroup from Form generation
 * @{
 */
988
function form($form, $method = "post", $action = NULL, $attributes = NULL) {
Dries's avatar
   
Dries committed
989
  if (!$action) {
990
    $action = request_uri();
Dries's avatar
   
Dries committed
991
  }
992
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($attributes) .">\n$form\n</form>\n";
Dries's avatar
   
Dries committed
993
994
}

Dries's avatar
   
Dries committed
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
/**
 * File an error against the form with the specified name.
 */
function form_set_error($name, $message) {
  $GLOBALS['form'][$name] = $message;
  drupal_set_message($message, 'error');
}

/**
 * Return true when errors have been set.
 */
function form_has_errors() {
  return isset($GLOBALS['form']);
}

/**
 * Return the error message filed against the form with the specified name.
 */
function _form_get_error($name) {
  return $GLOBALS['form'][$name];
}

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

function form_item($title, $value, $description = NULL, $id = NULL, $required = FALSE, $error = FALSE) {
  return theme("form_element", $title, $value, $description, $id, $required, $error);
Dries's avatar
   
Dries committed
1023
}
Dries's avatar
   
Dries committed
1024

Dries's avatar
   
Dries committed
1025
function form_group($legend, $group, $description = NULL) {
Dries's avatar
   
Dries committed
1026
1027
  return "<fieldset>" . ($legend ? "<legend>$legend</legend>" : "") . $group . ($description ? "<div class=\"description\">$description</div>" : "") . "</fieldset>\n";
}
Dries's avatar
   
Dries committed
1028

1029
function form_radio($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
1030
  $element = "<input type=\"radio\" class=\"". _form_get_class('form-radio', $required, _form_get_error($name)) ."\" name=\"edit[$name]\" value=\"$value\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) .' />';
1031
1032
1033
  if (!is_null($title)) {
    $element = "<label class=\"option\">$element $title</label>";
  }
Dries's avatar
   
Dries committed
1034
  return theme('form_element', NULL, $element, $description, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1035
1036
}

1037
function form_radios($title, $name, $value, $options, $description = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
1038
  if (count($options) > 0) {
Dries's avatar
   
Dries committed
1039
    $choices = '';
Dries's avatar
   
Dries committed
1040
    foreach ($options as $key => $choice) {
1041
      $choices .= "<label class=\"option\"><input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"$key\"". ($key == $value ? " checked=\"checked\"" : "") ." /> $choice</label><br />";
Dries's avatar
   
Dries committed
1042
    }
Dries's avatar
   
Dries committed
1043
    return theme('form_element', $title, $choices, $description, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1044
  }
Dries's avatar
   
Dries committed
1045
1046
}

1047
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
1048
  $element = "<input type=\"checkbox\" class=\"". _form_get_class('form-checkbox', $required, _form_get_error($name)) ."\" name=\"edit[$name]\" id=\"edit-$name\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) .' />';
1049
1050
1051
  if (!is_null($title)) {
    $element = "<label class=\"option\">$element $title</label>";
  }
Dries's avatar
   
Dries committed
1052
  return form_hidden($name, 0) . theme('form_element', NULL, $element, $description, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1053
1054
}

Dries's avatar
   
Dries committed
1055
1056
1057
1058
1059
1060
1061
1062
1063
function form_checkboxes($title, $name, $values, $options, $description = NULL, $required = FALSE) {
  if (count($options) > 0) {
    if (!isset($values)) {
      $values = array();
    }
    $choices = '';
    foreach ($options as $key => $choice) {
      $choices .= "<label class=\"option\"><input type=\"checkbox\" class=\"form-checkbox\" name=\"edit[$name][]\" value=\"$key\"". (in_array($key, $values) ? " checked=\"checked\"" : "") ." /> $choice</label><br />";
    }
Dries's avatar
   
Dries committed
1064
    return theme('form_element', $title, $choices, $description, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1065
1066
1067
  }
}

1068
function form_textfield($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
1069
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
   
Dries committed
1070
  return theme("form_element", $title, "<input type=\"text\" maxlength=\"$maxlength\" class=\"". _form_get_class('form-text', $required, _form_get_error($name)) ."\" name=\"edit[$name]\" id=\"$name\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description, $name, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1071
1072
}

1073
function form_password($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
1074
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
   
Dries committed
1075
  return theme("form_element", $title, "<input type=\"password\" class=\"". _form_get_class('form-password', $required, _form_get_error($name)) ."\" maxlength=\"$maxlength\" name=\"edit[$name]\" id=\"$name\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description, $name, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1076
1077
}

1078
function form_textarea($title, $name, $value, $cols, $rows, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
1079
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries's avatar
   
Dries committed
1080
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
Dries's avatar
   
Dries committed
1081
  return theme("form_element", $title, "<textarea wrap=\"virtual\"$cols rows=\"$rows\" name=\"edit[$name]\" id=\"$name\"". drupal_attributes($attributes) .">". check_form($value) ."</textarea>", $description, $name, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1082
1083
}

1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
/**
 * Outputs a form select item.
 *
 * @param $options Array containing the options to choose from. The basic format
 *                 is "value" => "label". If you want to group options together
 *                 (with <optgroup> tags), the format becomes "group name" =>
 *                 $options, where $options is an array of "value" => "label"
 *                 pairs.
 *
 *                 Examples:
 *                 @verbatim $flavor = array(1 => "Vanilla", 2 => "Chocolate", 3 => "Strawberry"); @endverbatim
 *                 @verbatim $order = array("Food" => array(1 => "Ice cream", 2 => "Hamburger"), "Drink" => array(1 => "Cola", 2 => "Water")); @endverbatim
 */
1097
function form_select($title, $name, $value, $options, $description = NULL, $extra = 0, $multiple = 0, $required = FALSE) {
Dries's avatar
   
Dries committed
1098
  $select = '';
Dries's avatar
   
Dries committed
1099
  foreach ($options as $key => $choice) {
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
    if (is_array($choice)) {
      $select .= "<optgroup label=\"$key\">";
      foreach ($choice as $key => $choice) {
        $select .= "<option value=\"$key\"". (is_array($value) ? (in_array($key, $value) ? " selected=\"selected\"" : "") : ($value == $key ? " selected=\"selected\"" : "")) .">". check_form($choice) ."</option>";
      }
      $select .= "</optgroup>";
    }
    else {
      $select .= "<option value=\"$key\"". (is_array($value) ? (in_array($key, $value) ? " selected=\"selected\"" : "") : ($value == $key ? " selected=\"selected\"" : "")) .">". check_form($choice) ."</option>";
    }
Dries's avatar
   
Dries committed
1110
  }
Dries's avatar
   
Dries committed
1111
  return theme("form_element", $title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple=\"multiple\" " : "") . ($extra ? " $extra" : "") ." id=\"$name\">$select</select>", $description, $name, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1112
1113
}

1114
function form_file($title, $name, $size, $description = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
1115
  return theme("form_element", $title, "<input type=\"file\" class=\"". _form_get_class('form-file', $required, _form_get_error($name)) ."\" name=\"edit[$name]\" id=\"$name\" size=\"$size\" />\n", $description, $name, $required, _form_get_error($error));
Dries's avatar
   
Dries committed
1116
1117
1118
1119
1120
1121
}

function form_hidden($name, $value) {
  return "<input type=\"hidden\" name=\"edit[$name]\" value=\"". check_form($value) ."\" />\n";
}

Dries's avatar
   
Dries committed
1122
function form_button($value, $name = "op", $type = "submit", $attributes = NULL) {
Dries's avatar
   
Dries committed
1123
1124
1125
  return "<input type=\"$type\" class=\"form-$type\" name=\"$name\" value=\"". check_form($value) ."\" ". drupal_attributes($attributes) ." />\n";
}

Dries's avatar
   
Dries committed
1126
function form_submit($value, $name = "op", $attributes = NULL) {
Dries's avatar
   
Dries committed
1127
  return form_button($value, $name, "submit", $attributes);
Dries's avatar
   
Dries committed
1128
1129
}

Dries's avatar
   
Dries committed
1130
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = NULL, $extra = 0) {
Dries's avatar
   
Dries committed
1131
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
   
Dries committed
1132
1133
1134
1135
1136
    $weights[$n] = $n;
  }

  return form_select($title, $name, $value, $weights, $description, $extra);
}
Kjartan's avatar
Kjartan committed
1137
/* @} */
Dries's avatar
   
Dries committed
1138

Dries's avatar
Dries committed
1139
function url($url = NULL, $query = NULL, $fragment = NULL, $absolute = NULL) {
Dries's avatar
   
Dries committed
1140
  global $base_url;
Dries's avatar
   
Dries committed
1141

Dries's avatar
   
Dries committed
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
  static $script;

  if (empty($script)) {
    /*
    ** On some webservers such as IIS we can't omit "index.php".  As such we
    ** generate "index.php?q=foo" instead of "?q=foo" on anything that is not
    ** Apache.
    */
    $script = (strpos($_SERVER["SERVER_SOFTWARE"], "Apache") === false) ? "index.php" : "";
  }

1153
  $url = drupal_get_path_alias($url);
Dries's avatar
   
Dries committed
1154

Dries's avatar
   
Dries committed
1155
1156
1157
1158
  if (isset($fragment)) {
    $fragment = "#$fragment";
  }

Dries's avatar
Dries committed
1159
1160
  $base = ($absolute ? $base_url . '/' : '');

Dries's avatar
   
Dries committed
1161
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
   
Dries committed
1162
1163
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
Dries committed
1164
        return "$base$script?q=$url&amp;$query$fragment";
Dries's avatar
   
Dries committed
1165
1166
      }
      else {
Dries's avatar
Dries committed
1167
        return "$base$script?q=$url$fragment";
Dries's avatar
   
Dries committed
1168
      }
Dries's avatar
   
Dries committed
1169
1170
    }
    else {
Dries's avatar
   
Dries committed
1171
      if (isset($query)) {
Dries's avatar
Dries committed
1172
        return "$base$script?$query$fragment";
Dries's avatar
   
Dries committed
1173
1174
      }
      else {
Dries's avatar
Dries committed
1175
        return "$base$fragment";
Dries's avatar
   
Dries committed
1176
      }
Dries's avatar
   
Dries committed
1177
1178
1179
    }
  }
  else {
Dries's avatar
   
Dries committed
1180
1181
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
Dries committed
1182
        return "$base$url?$query$fragment";
Dries's avatar
   
Dries committed
1183
1184
      }
      else {
Dries's avatar
Dries committed
1185
        return "$base$url$fragment";
Dries's avatar
   
Dries committed
1186
      }
Dries's avatar
   
Dries committed
1187
    }
Dries's avatar
   
Dries committed
1188
    else {