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

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

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

/**
Kjartan's avatar
Kjartan committed
32
33
 * @name Page breadcrumbs
 * @ingroup common
Dries's avatar
   
Dries committed
34
35
36
37
 *
 * Functions to get and set the breadcrumb trail of the current page.
 * @{
 */
Kjartan's avatar
Kjartan committed
38
39
40
41
42

/**
 * @param $breadcrumb Array of links, starting with "home" and proceeding up
 *   to but not including the current page.
 */
Dries's avatar
   
Dries committed
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
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
61
/* @} */
Dries's avatar
   
Dries committed
62

Dries's avatar
Dries committed
63
64
65
66
67
68
69
70
71
/**
 * @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
72
  static $stored_head = '';
Dries's avatar
Dries committed
73
74
75
76
77
78
79
80
81
82

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

function drupal_get_html_head() {
  global $base_url;

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

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

Dries's avatar
   
Dries committed
93
/**
Dries's avatar
   
Dries committed
94
 * @name URL path alias
Kjartan's avatar
Kjartan committed
95
96
 * @ingroup common
 *
Dries's avatar
   
Dries committed
97
 * Functions to handle path aliases.
Dries's avatar
   
Dries committed
98
 */
Dries's avatar
   
Dries committed
99
function drupal_get_path_map($action = "") {
Dries's avatar
Dries committed
100
  static $map = NULL;
Dries's avatar
   
Dries committed
101

Dries's avatar
   
Dries committed
102
103
104
105
  if ($action == "rebuild") {
    $map = NULL;
  }

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

  return $map;
}

Dries's avatar
   
Dries committed
117
118
119
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}
Kjartan's avatar
Kjartan committed
120
121

/**
Dries's avatar
   
Dries committed
122
 * Given an old url, return the alias.
Kjartan's avatar
Kjartan committed
123
 */
Dries's avatar
   
Dries committed
124
125
126
127
128
129
130
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');
  }
131
132
133
134
  else {
    // No alias found. Return the normal path.
    return $path;
  }
Dries's avatar
   
Dries committed
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
}

/**
 * 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
152

Dries's avatar
Dries committed
153
154
155
156
157
158
159
160
/**
 * @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
161
  static $stored_headers = '';
Dries's avatar
Dries committed
162
163
164
165
166
167
168
169
170
171
172
173
174

  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
175
176
177
178
179
180
181
182
/**
 * @name HTTP handling
 * @ingroup common
 *
 * Functions to properly handle HTTP responses.
 * @{
 */

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

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

Dries's avatar
   
Dries committed
210
211
    if (strstr($url, '?') && !strstr($url, $sid)) {
      $url = $url .'&'. $sid;
Kjartan's avatar
Kjartan committed
212
213
    }
    else {
Dries's avatar
   
Dries committed
214
      $url = $url .'?'. $sid;
Kjartan's avatar
Kjartan committed
215
216
217
    }
  }

Dries's avatar
   
Dries committed
218
219
220
221
  // 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
222

Dries's avatar
   
Dries committed
223
224
225
  // 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
226
227
228
229
230
231
  exit();
}

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

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries's avatar
   
Dries committed
237
  $status = MENU_NOT_FOUND;
Dries's avatar
   
Dries committed
238
239
  if ($path) {
    menu_set_active_item($path);
Dries's avatar
   
Dries committed
240
    $status = menu_execute_active_handler();
Dries's avatar
   
Dries committed
241
242
  }

Dries's avatar
   
Dries committed
243
  if ($status != MENU_FOUND) {
Dries's avatar
Dries committed
244
    print theme('page', '', t('Page not found'));
Dries's avatar
   
Dries committed
245
246
  }
}
Dries's avatar
   
Dries committed
247

Dries's avatar
   
Dries committed
248
249
250
251
252
253
254
/**
 * 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
255
  $status = MENU_NOT_FOUND;
Dries's avatar
   
Dries committed
256
257
258
259
260
261
262
263
264
265
  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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
/**
 * 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(
309
310
311
    'Host' => "Host: $uri[host]",
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
   
Dries committed
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
  );

  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.
329
  $response = '';
330
  while (!feof($fp) && $data = fread($fp, 1024)) {
331
    $response .= $data;
Dries's avatar
   
Dries committed
332
333
334
335
  }
  fclose($fp);

  // Parse response.
336
337
338
339
  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
340
341
342
  $result->headers = array();

  // Parse headers.
343
  while ($line = trim(array_shift($headers))) {
Dries's avatar
   
Dries committed
344
345
346
347
348
349
350
351
352
353
354
355
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
    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
384
/* @} */
Dries's avatar
   
Dries committed
385

Dries's avatar
   
Dries committed
386
387
388
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
389
390

  if ($errno & E_ALL ^ E_NOTICE) {
391
    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
392
393
394
    if (error_reporting()) {
      print "<pre>$entry</pre>";
    }
Dries's avatar
   
Dries committed
395
396
397
  }
}

Dries's avatar
Dries committed
398
399
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
400
401
402
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
403
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
404
405
406
  }
}

Dries's avatar
   
Dries committed
407
408
function fix_gpc_magic() {
  static $fixed = false;
Kjartan's avatar
Kjartan committed
409
  if (!$fixed && ini_get("magic_quotes_gpc")) {
Dries's avatar
Dries committed
410
411
412
413
414
415
    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
416
417
}

Kjartan's avatar
Kjartan committed
418
419
420
421
422
423
424
/**
 * @name Conversion
 * @ingroup common
 *
 * Converts data structures to a different type.
 * @{
 */
Dries's avatar
Dries committed
425
426
427
function array2object($array) {
  if (is_array($array)) {
    foreach ($array as $key => $value) {
Dries's avatar
   
Dries committed
428
429
430
431
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
432
    $object = $array;
Dries's avatar
   
Dries committed
433
434
435
436
437
  }

  return $object;
}

Dries's avatar
Dries committed
438
439
440
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
   
Dries committed
441
442
443
444
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
445
    $array = $object;
Dries's avatar
   
Dries committed
446
447
448
449
  }

  return $array;
}
Kjartan's avatar
Kjartan committed
450
/* @} */
Dries's avatar
   
Dries committed
451

Kjartan's avatar
Kjartan committed
452
453
454
455
456
457
458
/**
 * @name Messages
 * @ingroup common
 *
 * Frequently used messages.
 * @{
 */
Dries's avatar
   
Dries committed
459
function message_access() {
Dries's avatar
   
Dries committed
460
  return t("You are not authorized to access this page.");
Dries's avatar
   
Dries committed
461
462
463
464
465
466
}

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

Kjartan's avatar
Kjartan committed
467
/* @} */
Dries's avatar
   
Dries committed
468

Dries's avatar
   
Dries committed
469
470
function locale_init() {
  global $languages, $user;
Dries's avatar
   
Dries committed
471
472
473
474
475
476
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
   
Dries committed
477
478
}

Kjartan's avatar
Kjartan committed
479
480
481
482
483
/**
 * @ingroup common
 *
 * Translates strings to the current locale.
 *
484
485
486
487
 * 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
488
489
490
491
492
 * @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
493
494
495
 * 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
496
497
498
499
500
 *
 * @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
501
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
502
  global $languages;
503

504
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
505

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

Dries's avatar
   
Dries committed
514
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
   
Dries committed
515
516
517
518
519
520
521
522
523

  /*
  ** 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
524
525
}

Kjartan's avatar
Kjartan committed
526
527
528
529
530
/**
 * @name Validation
 * @ingroup common
 *
 * Functions to validate user input.
Dries's avatar
   
Dries committed
531
 * @{
Kjartan's avatar
Kjartan committed
532
533
 */

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

Dries's avatar
   
Dries committed
550
551
552
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
   
Dries committed
553
554
555
556
557
558
 * @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
559
 */
Dries's avatar
   
Dries committed
560
function valid_url($url, $absolute = FALSE) {
561
  if ($absolute) {
562
    return preg_match("/^(http|https|ftp):\/\/[a-z0-9\/:_\-_\.\?,~=#&]+$/i", $url);
563
564
  }
  else {
565
    return preg_match("/^[a-z0-9\/:_\-_\.,]+$/i", $url);
566
  }
Dries's avatar
   
Dries committed
567
568
}

Kjartan's avatar
Kjartan committed
569
570
571
572
573
574
575
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
576
      if (!valid_input_data($key) || !valid_input_data($value)) {
Kjartan's avatar
Kjartan committed
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
        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) {
598
      watchdog('warning', t('terminated request because of suspicious input data: %data', array('%data' => drupal_specialchars($data))));
Kjartan's avatar
Kjartan committed
599
600
601
602
603
604
605
606
607
608
609
610
      return 0;
    }
  }

  return 1;
}
/* @} */

/**
 * @defgroup search Search interface
 * @{
 */
Kjartan's avatar
Kjartan committed
611
612
613
/**
 * Format a single result entry of a search query:
 *
Dries's avatar
   
Dries committed
614
 * @param $item a single search result as returned by <i>module</i>_search of
615
 *   type array("count" => ..., "link" => ..., "title" => ..., "user" => ...,
Dries's avatar
   
Dries committed
616
617
 *   "date" => ..., "keywords" => ...)
 * @param $type module type of this item
Kjartan's avatar
Kjartan committed
618
 */
Dries's avatar
   
Dries committed
619
function search_item($item, $type) {
Dries's avatar
   
Dries committed
620
621
622
623
624
625
626
627
628
629

  /*
  ** 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 {
630
631
    $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
632
  }
Dries's avatar
   
Dries committed
633
634
635
636

  return $output;
}

Kjartan's avatar
Kjartan committed
637
638
639
640
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
641
 * 'site.com/search', but also as a simple search box (without "Restrict search
Dries's avatar
   
Dries committed
642
643
 * 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
644
 *
Dries's avatar
   
Dries committed
645
646
647
648
 * @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
649
 */
Dries's avatar
   
Dries committed
650
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
   
Dries committed
651
652
  $edit = $_POST['edit'];

Dries's avatar
   
Dries committed
653
  if (!$action) {
Dries's avatar
   
Dries committed
654
    $action = url("search");
Dries's avatar
   
Dries committed
655
656
  }

657
  $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
658
  $output .= " <input type=\"submit\" class=\"form-submit\" value=\"". t("Search") ."\" />\n";
Dries's avatar
   
Dries committed
659

Dries's avatar
Dries committed
660
  if ($options) {
Dries's avatar
   
Dries committed
661
662
663
664
665
    $output .= "<br />";
    $output .= t("Restrict search to") .": ";

    foreach (module_list() as $name) {
      if (module_hook($name, "search")) {
Kjartan's avatar
Kjartan committed
666
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
   
Dries committed
667
668
      }
    }
669
    $output .= "</div>";
Dries's avatar
   
Dries committed
670
671
672
673
674
675
  }

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

/*
Kjartan's avatar
Kjartan committed
676
677
 * Collect the search results:
 */
Dries's avatar
   
Dries committed
678
function search_data($keys = NULL) {
Dries's avatar
   
Dries committed
679
  $edit = $_POST["edit"];
Dries's avatar
   
Dries committed
680
  $output = '';
Dries's avatar
   
Dries committed
681

Dries's avatar
   
Dries committed
682
  if (isset($keys)) {
Dries's avatar
   
Dries committed
683
    foreach (module_list() as $name) {
Dries's avatar
   
Dries committed
684
685
686
687
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name])) {
        list($title, $results) = module_invoke($name, "search", $keys);
        if ($results) {
          $output .= "<h2>$title</h2>";
688
          $output .= "<dl class=\"search-results\">";
Dries's avatar
   
Dries committed
689
690
691
          foreach ($results as $entry) {
            $output .= search_item($entry, $name);
          }
692
          $output .= "</dl>";
Dries's avatar
   
Dries committed
693
694
695
696
697
698
699
700
        }
      }
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
701
702
703
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
   
Dries committed
704
705
706
707
708
709
 * @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
710
 */
Dries's avatar
   
Dries committed
711
712
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
  $_POST["edit"]["type"][$type] = "on";
Dries's avatar
   
Dries committed
713

Dries's avatar
   
Dries committed
714
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries's avatar
   
Dries committed
715
}
Kjartan's avatar
Kjartan committed
716
/* @} */
Dries's avatar
   
Dries committed
717

Dries's avatar
   
Dries committed
718
function check_form($text) {
Dries's avatar
   
Dries committed
719
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
   
Dries committed
720
721
}

722
723
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
   
Dries committed
724
725
}

Dries's avatar
   
Dries committed
726
727
728
729
730
731
732
733
/**
 * @name Formatting
 * @ingroup common
 *
 * Functions to format numbers, strings, dates, etc.
 * @{
 */

Dries's avatar
   
Dries committed
734
735
736
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
737
  $output = "<channel>\n";
Dries's avatar
   
Dries committed
738
739
  $output .= " <title>". drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= " <link>". drupal_specialchars(strip_tags($link)) ."</link>\n";
740
  $output .= " <description>". drupal_specialchars(strip_tags($description)) ."</description>\n";
Dries's avatar
   
Dries committed
741
  $output .= " <language>". drupal_specialchars(strip_tags($language)) ."</language>\n";
Dries's avatar
   
Dries committed
742
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
743
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
   
Dries committed
744
  }
Dries's avatar
   
Dries committed
745
746
747
748
749
750
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
Dries committed
754
  $output = "<item>\n";
Dries's avatar
   
Dries committed
755
756
757
  $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
758
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
759
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
   
Dries committed
760
  }
Dries's avatar
   
Dries committed
761
762
763
764
765
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
   
Dries committed
766
767
/**
 * Formats a string with a count of items so that the string is pluralized
Dries's avatar
   
Dries committed
768
769
 * correctly. format_plural calls t() by itself, make sure not to pass already
 * localized strings to it.
Dries's avatar
   
Dries committed
770
 *
Dries's avatar
   
Dries committed
771
772
773
774
 * @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
775
 * @param $plural The string for the plural case. Please make sure it's clear
Dries's avatar
   
Dries committed
776
777
 *   this is plural, to ease translation. Use %count in places of the item
 *   count, as in "%count new comments".
Dries's avatar
   
Dries committed
778
 * @return Translated string
Dries's avatar
   
Dries committed
779
 */
Dries's avatar
   
Dries committed
780
function format_plural($count, $singular, $plural) {
Dries's avatar
   
Dries committed
781
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
   
Dries committed
782
783
}

Dries's avatar
   
Dries committed
784
785
786
787
788
789
/**
 * 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
790
function format_size($size) {
Dries's avatar
   
Dries committed
791
  $suffix = t("bytes");
Dries's avatar
   
Dries committed
792
793
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
794
    $suffix = t("KB");
Dries's avatar
   
Dries committed
795
796
797
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
798
    $suffix = t("MB");
Dries's avatar
   
Dries committed
799
  }
Dries's avatar
   
Dries committed
800
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
   
Dries committed
801
802
}

Dries's avatar
   
Dries committed
803
804
805
806
807
808
809
/**
 * 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
810
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
   
Dries committed
811
  $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
812
  $output = '';
Dries's avatar
   
Dries committed
813
  foreach ($units as $key => $value) {
Dries's avatar
   
Dries committed
814
815
816
817
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
Dries's avatar
   
Dries committed
818
819
820
821
822
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
   
Dries committed
823
824
    }
  }
Dries's avatar
   
Dries committed
825
  return $output ? $output : t("0 sec");
Dries's avatar
   
Dries committed
826
827
}

Dries's avatar
   
Dries committed
828
829
830
831
832
833
834
835
836
837
838
839
/**
 * 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.
840
841
 * @param $timezone Timezone offset in seconds in case the user timezone
 *   should not be used.
Dries's avatar
   
Dries committed
842
843
 * @return Translated date string in the requested format
 */
844
845
846
847
848
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
849

850
  $timestamp += $timezone;
Dries's avatar
   
Dries committed
851
852

  switch ($type) {
853
854
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
   
Dries committed
855
      break;
856
857
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
   
Dries committed
858
      break;
859
    case 'custom':
Dries's avatar
   
Dries committed
860
      // No change to format
Dries's avatar
   
Dries committed
861
      break;
862
    case 'medium':
Dries's avatar
   
Dries committed
863
    default:
864
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
   
Dries committed
865
866
  }

867
  $max = strlen($format);
Dries's avatar
   
Dries committed
868
  $date = '';
Dries's avatar
   
Dries committed
869
870
  for ($i = 0; $i < $max; $i++) {
    $c = $format{$i};
871
    if (strpos('AaDFlM', $c)) {
872
      $date .= t(gmdate($c, $timestamp));
873
874
875
876
877
878
    }
    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
879
    }
880
881
882
883
884
    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
885
886
    }
    else {
887
      $date .= $c;
Dries's avatar
   
Dries committed
888
    }
Dries's avatar
   
Dries committed
889
  }
890

Dries's avatar
   
Dries committed
891
892
893
  return $date;
}

Dries's avatar
   
Dries committed
894
895
896
897
898
899
900
901
/**
 * 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
902
903
904
function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
Dries committed
905
906
907
908
909
910
    /*
    ** Shorten the name when it is too long or it will break many
    ** tables.
    */

    if (strlen($object->name) > 20) {
911
      $name = truncate_utf8($object->name, 15) ."...";
Dries's avatar
Dries committed
912
913
914
915
916
    }
    else {
      $name = $object->name;
    }

Dries's avatar
   
Dries committed
917
    $output = l($name, "user/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
   
Dries committed
918
  }
Dries's avatar
   
Dries committed
919
920
921
922
923
924
925
926
  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
927
928
929
930
931
932
933
934
    if ($object->homepage) {
      $output = "<a href=\"$object->homepage\">$object->name</a>";
    }
    else {
      $output = $object->name;
    }

    $output .= ' ('. t('not verified') .')';
Dries's avatar
   
Dries committed
935
  }
Dries's avatar
   
Dries committed
936
  else {
Dries's avatar
   
Dries committed
937
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
   
Dries committed
938
939
  }

Dries's avatar
   
Dries committed
940
  return $output;
Dries's avatar
   
Dries committed
941
}
Dries's avatar
   
Dries committed
942
/* @} */
Dries's avatar
   
Dries committed
943

Kjartan's avatar
Kjartan committed
944
945
946
947
/**
 * @defgroup from Form generation
 * @{
 */
948
function form($form, $method = "post", $action = NULL, $attributes = NULL) {
Dries's avatar
   
Dries committed
949
  if (!$action) {
950
    $action = request_uri();
Dries's avatar
   
Dries committed
951
  }
952
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($attributes) .">\n$form\n</form>\n";
Dries's avatar
   
Dries committed
953
954
}

Dries's avatar
   
Dries committed
955
956
957
958
959
960
961
962
963
/**
 * 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');
}

/**
Dries's avatar
   
Dries committed
964
 * Return an associative array of all errors.
Dries's avatar
   
Dries committed
965
 */
Dries's avatar
   
Dries committed
966
function form_get_errors() {
967
968
969
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'];
  }
Dries's avatar
   
Dries committed
970
971
972
973
974
975
}

/**
 * Return the error message filed against the form with the specified name.
 */
function _form_get_error($name) {
Dries's avatar
   
Dries committed
976
977
978
  if (array_key_exists('form', $GLOBALS)) {
    return $GLOBALS['form'][$name];
  }
Dries's avatar
   
Dries committed
979
980
981
982
983
984
985
}

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) {
Dries's avatar
   
Dries committed
986
  return theme('form_element', $title, $value, $description, $id, $required, $error);
Dries's avatar
   
Dries committed
987
}
Dries's avatar
   
Dries committed
988

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

993
function form_radio($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
994
  $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) .' />';
995
996
997
  if (!is_null($title)) {
    $element = "<label class=\"option\">$element $title</label>";
  }
Dries's avatar
   
Dries committed
998
  return theme('form_element', NULL, $element, $description, $name, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
999
1000
}

1001
function form_radios($title, $name, $value, $options, $description = NULL, $required = FALSE, $attributes = NULL) {
Dries's avatar
   
Dries committed
1002
  if (count($options) > 0) {
Dries's avatar
   
Dries committed
1003
    $choices = '';
Dries's avatar
   
Dries committed
1004
    foreach ($options as $key => $choice) {
1005
      $choices .= "<label class=\"option\"><input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"$key\"". ($key == $value ? " checked=\"checked\"" : ""). drupal_attributes($attributes). " /> $choice</label><br />";
Dries's avatar
   
Dries committed
1006
    }
Dries's avatar
   
Dries committed
1007
    return theme('form_element', $title, $choices, $description, $name, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1008
  }
Dries's avatar
   
Dries committed
1009
1010
}

1011
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
1012
  $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) .' />';
1013
1014
1015
  if (!is_null($title)) {
    $element = "<label class=\"option\">$element $title</label>";
  }
Dries's avatar
   
Dries committed
1016
  return form_hidden($name, 0) . theme('form_element', NULL, $element, $description, $name, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1017
1018
}

Dries's avatar
   
Dries committed
1019
function form_checkboxes($title, $name, $values, $options, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
1020
1021
1022
1023
1024
1025
  if (count($options) > 0) {
    if (!isset($values)) {
      $values = array();
    }
    $choices = '';
    foreach ($options as $key => $choice) {
1026
      $choices .= "<label class=\"option\"><input type=\"checkbox\" class=\"form-checkbox\" name=\"edit[$name][]\" value=\"$key\"". (in_array($key, $values) ? " checked=\"checked\"" : ""). drupal_attributes($attributes). " /> $choice</label><br />";
Dries's avatar
   
Dries committed
1027
    }
Dries's avatar
   
Dries committed
1028
    return theme('form_element', $title, $choices, $description, $name, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1029
1030
1031
  }
}

1032
function form_textfield($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
1033
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
   
Dries committed
1034
  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
1035
1036
}

1037
function form_password($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
1038
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
   
Dries committed
1039
  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
1040
1041
}

1042
function form_textarea($title, $name, $value, $cols, $rows, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
1043
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries's avatar
   
Dries committed
1044
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
Dries's avatar
   
Dries committed
1045
  return theme('form_element', $title, "<textarea wrap=\"virtual\"$cols rows=\"$rows\" name=\"edit[$name]\" id=\"$name\" class=\"". _form_get_class('textarea', $required, _form_get_error($name)) ."\"". drupal_attributes($attributes) .">". check_form($value) ."</textarea>", $description, $name, $required, _form_get_error($name));
Dries's avatar
   
Dries committed
1046
1047
}

1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
/**
 * 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
 */
1061
function form_select($title, $name, $value, $options, $description = NULL, $extra = 0, $multiple = 0, $required = FALSE) {
Dries's avatar
   
Dries committed
1062
  $select = '';
Dries's avatar
   
Dries committed
1063
  foreach ($options as $key => $choice) {
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
    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
1074
  }
Dries's avatar
   
Dries committed
1075
  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
1076
1077
}

1078
function form_file($title, $name, $size, $description = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
1079
  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
1080
1081
1082
1083
1084
1085
}

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

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

Dries's avatar
   
Dries committed
1090
function form_submit($value, $name = "op", $attributes = NULL) {
Dries's avatar
   
Dries committed
1091
  return form_button($value, $name, "submit", $attributes);
Dries's avatar
   
Dries committed
1092
1093
}

Dries's avatar
   
Dries committed
1094
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = NULL, $extra = 0) {
Dries's avatar
   
Dries committed
1095
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
   
Dries committed
1096
1097
1098
1099
1100
    $weights[$n] = $n;
  }

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

Dries's avatar
Dries committed
1103
function url($url = NULL, $query = NULL, $fragment = NULL, $absolute = NULL) {
Dries's avatar
   
Dries committed
1104
  global $base_url;
Dries's avatar
   
Dries committed
1105

Dries's avatar
   
Dries committed
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
  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" : "";
  }

1117
  $url = drupal_get_path_alias($url);
Dries's avatar
   
Dries committed
1118

Dries's avatar
   
Dries committed
1119
1120
1121
1122
  if (isset($fragment)) {
    $fragment = "#$fragment";
  }

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

Dries's avatar
   
Dries committed
1125
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
   
Dries committed
1126
1127
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
Dries committed
1128
        return "$base$script?q=$url&amp;$query$fragment";
Dries's avatar
   
Dries committed
1129
1130
      }
      else {
Dries's avatar
Dries committed
1131
        return "$base$script?q=$url$fragment";
Dries's avatar
   
Dries committed
1132
      }
Dries's avatar
   
Dries committed
1133
1134
    }
    else {
Dries's avatar
   
Dries committed
1135
      if (isset($query)) {
Dries's avatar
Dries committed
1136
        return "$base$script?$query$fragment";
Dries's avatar
   
Dries committed
1137
1138
      }
      else {
Dries's avatar
Dries committed
1139
        return "$base$fragment";
Dries's avatar
   
Dries committed
1140
      }
Dries's avatar
   
Dries committed
1141
1142
1143
    }
  }
  else {
Dries's avatar
   
Dries committed
1144
1145
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
Dries committed
1146
        return "$base$url?$query$fragment";
Dries's avatar
   
Dries committed
1147
1148
      }
      else {
Dries's avatar
Dries committed
1149
        return "$base$url$fragment";
Dries's avatar
   
Dries committed
1150
      }
Dries's avatar
   
Dries committed
1151
    }
Dries's avatar
   
Dries committed
1152
    else {
Dries's avatar