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

Dries's avatar
 
Dries committed
4
/**
Kjartan's avatar
Kjartan committed
5 6 7 8 9 10
 * @defgroup common Core functions
 */

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

95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
/**
 * @name Page tabs
 * @ingroup common
 *
 * Functions to get and set the tabs of the current page.
 * @{
 */

/**
 * @param $tab Array of links to use for tabs
 */
function drupal_set_tab($tab = NULL) {
  static $stored_tab = array();

  if (!is_null($tab)) {
    $stored_tab[] =  $tab;
  }
  return $stored_tab;
}

function drupal_get_tab() {
  return drupal_set_tab();
}
/* @} */

Dries's avatar
Dries committed
120 121 122 123 124 125 126 127 128
/**
 * @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
129
  static $stored_head = '';
Dries's avatar
Dries committed
130 131 132 133 134 135 136 137 138 139

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

function drupal_get_html_head() {
  global $base_url;

Dries's avatar
 
Dries committed
140
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
141
  $output .= "<base href=\"$base_url/\" />\n";
Dries's avatar
 
Dries committed
142
  $output .= "<style type=\"text/css\" media=\"all\">\n";
Dries's avatar
Dries committed
143 144 145 146 147 148 149
  $output .= "@import url(misc/drupal.css);\n";
  $output .= "</style>\n";

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

Dries's avatar
 
Dries committed
150
/**
Dries's avatar
 
Dries committed
151
 * @name URL path alias
Kjartan's avatar
Kjartan committed
152 153
 * @ingroup common
 *
Dries's avatar
 
Dries committed
154
 * Functions to handle path aliases.
Dries's avatar
 
Dries committed
155
 */
Dries's avatar
 
Dries committed
156
function drupal_get_path_map($action = "") {
Dries's avatar
Dries committed
157
  static $map = NULL;
Dries's avatar
 
Dries committed
158

Dries's avatar
 
Dries committed
159 160 161 162
  if ($action == "rebuild") {
    $map = NULL;
  }

Dries's avatar
Dries committed
163
  if (is_null($map)) {
Dries's avatar
 
Dries committed
164
    $map = array();  // make $map non-null in case no aliases are defined
Dries's avatar
 
Dries committed
165
    $result = db_query("SELECT * FROM {url_alias}");
Dries's avatar
 
Dries committed
166
    while ($data = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
167
      $map[$data->dst] = $data->src;
Dries's avatar
 
Dries committed
168 169 170 171 172 173
    }
  }

  return $map;
}

Dries's avatar
 
Dries committed
174 175 176
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}
Kjartan's avatar
Kjartan committed
177 178

/**
Dries's avatar
 
Dries committed
179
 * Given an old url, return the alias.
Kjartan's avatar
Kjartan committed
180
 */
Dries's avatar
 
Dries committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
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');
  }
}

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

Dries's avatar
Dries committed
206 207 208 209 210 211 212 213
/**
 * @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
214
  static $stored_headers = '';
Dries's avatar
Dries committed
215 216 217 218 219 220 221 222 223 224 225 226 227

  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
228 229 230 231 232 233 234 235
/**
 * @name HTTP handling
 * @ingroup common
 *
 * Functions to properly handle HTTP responses.
 * @{
 */

Kjartan's avatar
Kjartan committed
236 237 238 239 240 241
/**
 * 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
242 243 244
 * @param $url A Drupal URL
 * @param $query Query string component
 * @param $fragment Fragment identifier
Kjartan's avatar
Kjartan committed
245
 */
Dries's avatar
Dries committed
246
function drupal_goto($url = NULL, $query = NULL, $fragment = NULL) {
Kjartan's avatar
Kjartan committed
247 248

  /*
Dries's avatar
Dries committed
249
  ** Translate &amp; to simply & in the absolute URL
Kjartan's avatar
Kjartan committed
250
  */
Dries's avatar
 
Dries committed
251

Dries's avatar
Dries committed
252
  $url = str_replace("&amp;", "&", url($url, $query, $fragment, TRUE));
Kjartan's avatar
Kjartan committed
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284

  /*
  ** 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
285
function drupal_not_found() {
Dries's avatar
 
Dries committed
286 287
  header('HTTP/1.0 404 Not Found');
  watchdog('httpd', '404 error: "'. check_query($_GET['q']) .'" not found');
Dries's avatar
 
Dries committed
288 289

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries's avatar
 
Dries committed
290
  $status = MENU_FALLTHROUGH;
Dries's avatar
 
Dries committed
291 292
  if ($path) {
    menu_set_active_item($path);
Dries's avatar
 
Dries committed
293
    $status = menu_execute_active_handler();
Dries's avatar
 
Dries committed
294 295
  }

Dries's avatar
 
Dries committed
296
  if ($status != MENU_FOUND) {
Dries's avatar
Dries committed
297
    print theme('page', '', t('Page not found'));
Dries's avatar
 
Dries committed
298 299
  }
}
Dries's avatar
 
Dries committed
300

Dries's avatar
 
Dries committed
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
/**
 * 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
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
/**
 * 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(
362 363 364
    'Host' => "Host: $uri[host]",
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
 
Dries committed
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
  );

  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.
382
  $response = '';
383
  while (!feof($fp) && $data = fread($fp, 1024)) {
384
    $response .= $data;
Dries's avatar
 
Dries committed
385 386 387 388
  }
  fclose($fp);

  // Parse response.
389
  $response = preg_split("/\r\n|\n|\r/", $response);
Dries's avatar
 
Dries committed
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 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
  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
441
/* @} */
Dries's avatar
 
Dries committed
442

Dries's avatar
 
Dries committed
443 444 445
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
446 447

  if ($errno & E_ALL ^ E_NOTICE) {
Dries's avatar
 
Dries committed
448
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
Dries's avatar
Dries committed
449 450 451
    if (error_reporting()) {
      print "<pre>$entry</pre>";
    }
Dries's avatar
 
Dries committed
452 453 454
  }
}

Dries's avatar
Dries committed
455 456
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
457 458 459
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
460
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
461 462 463
  }
}

Dries's avatar
 
Dries committed
464 465
function fix_gpc_magic() {
  static $fixed = false;
Kjartan's avatar
Kjartan committed
466
  if (!$fixed && ini_get("magic_quotes_gpc")) {
Dries's avatar
Dries committed
467 468 469 470 471 472
    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
473 474
}

Kjartan's avatar
Kjartan committed
475 476 477 478 479 480 481
/**
 * @name Conversion
 * @ingroup common
 *
 * Converts data structures to a different type.
 * @{
 */
Dries's avatar
Dries committed
482 483 484
function array2object($array) {
  if (is_array($array)) {
    foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
485 486 487 488
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
489
    $object = $array;
Dries's avatar
 
Dries committed
490 491 492 493 494
  }

  return $object;
}

Dries's avatar
Dries committed
495 496 497
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
 
Dries committed
498 499 500 501
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
502
    $array = $object;
Dries's avatar
 
Dries committed
503 504 505 506
  }

  return $array;
}
Kjartan's avatar
Kjartan committed
507
/* @} */
Dries's avatar
 
Dries committed
508

Kjartan's avatar
Kjartan committed
509 510 511 512 513 514 515
/**
 * @name Messages
 * @ingroup common
 *
 * Frequently used messages.
 * @{
 */
Dries's avatar
 
Dries committed
516
function message_access() {
Dries's avatar
 
Dries committed
517
  return t("You are not authorized to access this page.");
Dries's avatar
 
Dries committed
518 519 520 521 522 523
}

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

Kjartan's avatar
Kjartan committed
524
/* @} */
Dries's avatar
 
Dries committed
525

Dries's avatar
 
Dries committed
526 527
function locale_init() {
  global $languages, $user;
Dries's avatar
 
Dries committed
528 529 530 531 532 533
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
534 535
}

Kjartan's avatar
Kjartan committed
536 537 538 539 540
/**
 * @ingroup common
 *
 * Translates strings to the current locale.
 *
541 542 543 544
 * 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
545 546 547 548 549
 * @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
550 551 552
 * 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
553 554 555 556 557
 *
 * @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
558
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
559
  global $languages;
560

561
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
562

Dries's avatar
 
Dries committed
563 564
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
565 566
  }
  else {
Dries's avatar
 
Dries committed
567 568
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
569 570
}

Dries's avatar
 
Dries committed
571
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
 
Dries committed
572 573 574 575 576 577 578 579 580

  /*
  ** 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
581 582
}

Kjartan's avatar
Kjartan committed
583 584 585 586 587
/**
 * @name Validation
 * @ingroup common
 *
 * Functions to validate user input.
Dries's avatar
 
Dries committed
588
 * @{
Kjartan's avatar
Kjartan committed
589 590
 */

591
/**
Dries's avatar
 
Dries committed
592 593
 * Verify the syntax of the given e-mail address. Empty e-mail addresses are
 * allowed. See RFC 2822 for details.
594
 *
Kjartan's avatar
Kjartan committed
595
 * @param $mail A string containing an email address.
Dries's avatar
 
Dries committed
596
 * @return
597
 */
Dries's avatar
 
Dries committed
598
function valid_email_address($mail) {
599
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
600
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.?)+';
601 602 603
  $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
604
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
605 606
}

Dries's avatar
 
Dries committed
607 608 609
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
 
Dries committed
610 611 612 613 614 615
 * @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
616
 */
Dries's avatar
 
Dries committed
617
function valid_url($url, $absolute = FALSE) {
618
  if ($absolute) {
619
    return preg_match("/^(http|https|ftp):\/\/[a-z0-9\/:_\-_\.\?,~=#&]+$/i", $url);
620 621
  }
  else {
622
    return preg_match("/^[a-z0-9\/:_\-_\.,]+$/i", $url);
623
  }
Dries's avatar
 
Dries committed
624 625
}

Kjartan's avatar
Kjartan committed
626 627 628 629 630 631 632
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
633
      if (!valid_input_data($key) || !valid_input_data($value)) {
Kjartan's avatar
Kjartan committed
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
        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
668 669 670
/**
 * Format a single result entry of a search query:
 *
Dries's avatar
 
Dries committed
671
 * @param $item a single search result as returned by <i>module</i>_search of
672
 *   type array("count" => ..., "link" => ..., "title" => ..., "user" => ...,
Dries's avatar
 
Dries committed
673 674
 *   "date" => ..., "keywords" => ...)
 * @param $type module type of this item
Kjartan's avatar
Kjartan committed
675
 */
Dries's avatar
 
Dries committed
676
function search_item($item, $type) {
Dries's avatar
 
Dries committed
677 678 679 680 681 682 683 684 685 686

  /*
  ** 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 {
687 688
    $output = " <dt class=\"title\"><a href=\"". $item["link"] ."\">". $item["title"] ."</a></dt>";
    $output .= " <dd class=\"small\">" . t($type) . ($item["user"] ? " - ". $item["user"] : "") ."". ($item["date"] ? " - ". format_date($item["date"], "small") : "") ."</dd>";
Dries's avatar
 
Dries committed
689
  }
Dries's avatar
 
Dries committed
690 691 692 693

  return $output;
}

Kjartan's avatar
Kjartan committed
694 695 696 697
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
 
Dries committed
698 699 700
 * '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
701
 *
Dries's avatar
 
Dries committed
702 703 704 705
 * @param $action Form action. Defaults to 'site.com/search'.
 * @param $keys string containing keywords for the search.
 * @param $options != 0: Render additional form fields/text ("Restrict search
 *   to", help text, etc).
Kjartan's avatar
Kjartan committed
706
 */
Dries's avatar
 
Dries committed
707
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
 
Dries committed
708 709
  $edit = $_POST['edit'];

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

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

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

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

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

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

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

  return $output;
}

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

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

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

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

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

Dries's avatar
 
Dries committed
791 792 793
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
794
  $output = "<channel>\n";
Dries's avatar
 
Dries committed
795 796
  $output .= " <title>". drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= " <link>". drupal_specialchars(strip_tags($link)) ."</link>\n";
797
  $output .= " <description>". drupal_specialchars(strip_tags($description)) ."</description>\n";
Dries's avatar
 
Dries committed
798
  $output .= " <language>". drupal_specialchars(strip_tags($language)) ."</language>\n";
Dries's avatar
 
Dries committed
799
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
800
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
 
Dries committed
801
  }
Dries's avatar
 
Dries committed
802 803 804 805 806 807
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
Dries committed
811
  $output = "<item>\n";
Dries's avatar
 
Dries committed
812 813 814
  $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
815
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
816
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
 
Dries committed
817
  }
Dries's avatar
 
Dries committed
818 819 820 821 822
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
823 824
/**
 * Formats a string with a count of items so that the string is pluralized
Dries's avatar
 
Dries committed
825 826
 * correctly. format_plural calls t() by itself, make sure not to pass already
 * localized strings to it.
Dries's avatar
 
Dries committed
827
 *
Dries's avatar
 
Dries committed
828 829 830 831
 * @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
832
 * @param $plural The string for the plural case. Please make sure it's clear
Dries's avatar
 
Dries committed
833 834
 *   this is plural, to ease translation. Use %count in places of the item
 *   count, as in "%count new comments".
Dries's avatar
 
Dries committed
835
 * @return Translated string
Dries's avatar
 
Dries committed
836
 */
Dries's avatar
 
Dries committed
837
function format_plural($count, $singular, $plural) {
Dries's avatar
 
Dries committed
838
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
 
Dries committed
839 840
}

Dries's avatar
 
Dries committed
841 842 843 844 845 846
/**
 * 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
847
function format_size($size) {
Dries's avatar
 
Dries committed
848
  $suffix = t("bytes");
Dries's avatar
 
Dries committed
849 850
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
851
    $suffix = t("KB");
Dries's avatar
 
Dries committed
852 853 854
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
855
    $suffix = t("MB");
Dries's avatar
 
Dries committed
856
  }
Dries's avatar
 
Dries committed
857
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
 
Dries committed
858 859
}

Dries's avatar
 
Dries committed
860 861 862 863 864 865 866
/**
 * 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
867
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
 
Dries committed
868
  $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
869
  $output = '';
Dries's avatar
 
Dries committed
870
  foreach ($units as $key => $value) {
Dries's avatar
 
Dries committed
871 872 873 874
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
Dries's avatar
 
Dries committed
875 876 877 878 879
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
880 881
    }
  }
Dries's avatar
 
Dries committed
882
  return $output ? $output : t("0 sec");
Dries's avatar
 
Dries committed
883 884
}

Dries's avatar
 
Dries committed
885 886 887 888 889 890 891 892 893 894 895 896
/**
 * 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.
897 898
 * @param $timezone Timezone offset in seconds in case the user timezone
 *   should not be used.
Dries's avatar
 
Dries committed
899 900
 * @return Translated date string in the requested format
 */
901 902 903 904 905
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
906

907
  $timestamp += $timezone;
Dries's avatar
 
Dries committed
908 909

  switch ($type) {
910 911
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
 
Dries committed
912
      break;
913 914
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
 
Dries committed
915
      break;
916
    case 'custom':
Dries's avatar
 
Dries committed
917
      // No change to format
Dries's avatar
 
Dries committed
918
      break;
919
    case 'medium':
Dries's avatar
 
Dries committed
920
    default:
921
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
 
Dries committed
922 923
  }

924
  $max = strlen($format);
Dries's avatar
 
Dries committed
925
  $date = '';
926 927
  for ($i = 0; $i <= $max; $c = $format{$i++}) {
    if (strpos('AaDFlM', $c)) {
928
      $date .= t(gmdate($c, $timestamp));
929 930 931 932 933 934
    }
    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
935
    }
936 937 938 939 940
    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
941 942
    }
    else {
943
      $date .= $c;
Dries's avatar
 
Dries committed
944
    }
Dries's avatar
 
Dries committed
945
  }
946

Dries's avatar
 
Dries committed
947 948 949
  return $date;
}

Dries's avatar
 
Dries committed
950 951 952 953 954 955 956 957
/**
 * 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
958 959 960
function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
Dries committed
961 962 963 964 965 966
    /*
    ** Shorten the name when it is too long or it will break many
    ** tables.
    */

    if (strlen($object->name) > 20) {
967
      $name = truncate_utf8($object->name, 15) ."...";
Dries's avatar
Dries committed
968 969 970 971 972
    }
    else {
      $name = $object->name;
    }

Dries's avatar
 
Dries committed
973
    if (arg(0) == "admin" and user_access("administer users")) {
Dries's avatar
Dries committed
974
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
 
Dries committed
975 976
    }
    else {
Dries's avatar
Dries committed
977
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
 
Dries committed
978
    }
Dries's avatar
 
Dries committed
979
  }
Dries's avatar
 
Dries committed
980 981 982 983 984 985 986 987
  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
988 989 990 991 992 993 994 995
    if ($object->homepage) {
      $output = "<a href=\"$object->homepage\">$object->name</a>";
    }
    else {
      $output = $object->name;
    }

    $output .= ' ('. t('not verified') .')';
Dries's avatar
 
Dries committed
996
  }
Dries's avatar
 
Dries committed
997
  else {
Dries's avatar
 
Dries committed
998
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
 
Dries committed
999 1000
  }

Dries's avatar
 
Dries committed
1001
  return $output;
Dries's avatar
 
Dries committed
1002
}
Dries's avatar
 
Dries committed
1003
/* @} */
Dries's avatar
 
Dries committed
1004

Kjartan's avatar
Kjartan committed
1005 1006 1007 1008
/**
 * @defgroup from Form generation
 * @{
 */
1009
function form($form, $method = "post", $action = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
1010
  if (!$action) {
1011
    $action = request_uri();
Dries's avatar
 
Dries committed
1012
  }
1013
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($attributes) .">\n$form\n</form>\n";
Dries's avatar
 
Dries committed
1014 1015
}

Dries's avatar
 
Dries committed
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
/**
 * 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
1044
}
Dries's avatar
 
Dries committed
1045

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

1050
function form_radio($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
 
Dries committed
1051
  $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) .' />';
1052 1053 1054
  if (!is_null($title)) {
    $element = "<label class=\"option\">$element $title</label>";
  }
Dries's avatar
 
Dries committed
1055
  return theme('form_element', NULL, $element, $description, $required, _form_get_error($name));
Dries's avatar
 
Dries committed
1056 1057
}

1058
function form_radios($title, $name, $value, $options, $description = NULL, $required = FALSE) {
Dries's avatar
 
Dries committed
1059
  if (count($options) > 0) {
Dries's avatar
 
Dries committed
1060
    $choices = '';
Dries's avatar
 
Dries committed
1061
    foreach ($options as $key => $choice) {
1062
      $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
1063
    }
Dries's avatar
 
Dries committed
1064
    return theme('form_element', $title, $choices, $description, $required, _form_get_error($name));
Dries's avatar
 
Dries committed
1065
  }
Dries's avatar
 
Dries committed
1066 1067
}

1068
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
 
Dries committed
1069
  $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) .' />';
1070 1071 1072
  if (!is_null($title)) {
    $element = "<label class=\"option\">$element $title</label>";
  }
Dries's avatar
 
Dries committed
1073
  return form_hidden($name, 0) . theme('form_element', NULL, $element, $description, $required, _form_get_error($name));
Dries's avatar
 
Dries committed
1074 1075
}

Dries's avatar
 
Dries committed
1076 1077 1078 1079 1080 1081 1082 1083 1084
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
1085
    return theme('form_element', $title, $choices, $description, $required, _form_get_error($name));
Dries's avatar
 
Dries committed
1086 1087 1088
  }
}

1089
function form_textfield($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
 
Dries committed
1090
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
1091
  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
1092 1093
}

1094
function form_password($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
 
Dries committed
1095
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
1096
  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
1097 1098
}

1099
function form_textarea($title, $name, $value, $cols, $rows, $description = NULL, $attributes = NULL, $required = FALSE) {
Dries's avatar
 
Dries committed
1100
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries's avatar
 
Dries committed
1101
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
Dries's avatar
 
Dries committed
1102
  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
1103 1104
}

1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
/**
 * 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
 */
1118
function form_select($title, $name, $value, $options, $description = NULL, $extra = 0, $multiple = 0, $required = FALSE) {
Dries's avatar
 
Dries committed
1119
  $select = '';
Dries's avatar
 
Dries committed
1120
  foreach ($options as $key => $choice) {
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
    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
1131
  }
Dries's avatar
 
Dries committed
1132
  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
1133 1134
}

1135
function form_file($title, $name, $size, $description = NULL, $required = FALSE) {
Dries's avatar
 
Dries committed
1136
  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
1137 1138 1139 1140 1141 1142
}

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

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

Dries's avatar
 
Dries committed
1147
function form_submit($value, $name = "op", $attributes = NULL) {
Dries's avatar
 
Dries committed
1148
  return form_button($value, $name, "submit", $attributes);
Dries's avatar
 
Dries committed
1149 1150
}

Dries's avatar
 
Dries committed
1151
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = NULL, $extra = 0) {
Dries's avatar
 
Dries committed
1152
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
 
Dries committed
1153 1154 1155 1156 1157
    $weights[$n] = $n;
  }

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

Dries's avatar
Dries committed
1160
function url($url = NULL, $query = NULL, $fragment = NULL, $absolute = NULL) {
Dries's avatar
 
Dries committed
1161
  global $base_url;
Dries's avatar
 
Dries committed
1162

Dries's avatar
 
Dries committed
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
  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" : "";
  }

Dries's avatar
 
Dries committed
1174
  if ($alias = drupal_get_path_alias($url)) {
Dries's avatar
 
Dries committed
1175 1176 1177
    $url = $alias;
  }

Dries's avatar
 
Dries committed
1178 1179 1180 1181
  if (isset($fragment)) {
    $fragment = "#$fragment";
  }

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

Dries's avatar
 
Dries committed
1184
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
 
Dries committed
1185 1186
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
Dries committed
1187
        return "$base$script?q=$url&amp;$query$fragment";
Dries's avatar
 
Dries committed
1188 1189
      }
      else {
Dries's avatar
Dries committed
1190
        return "$base$script?q=$url$fragment";
Dries's avatar
 
Dries committed
1191
      }
Dries's avatar
 
Dries committed
1192 1193
    }
    else {
Dries's avatar
 
Dries committed
1194
      if (isset($query)) {
Dries's avatar
Dries committed
1195
        return "$base$script?$query$fragment";
Dries's avatar
 
Dries committed
1196 1197
      }
      else {
Dries's avatar
Dries committed
1198
        return "$base$fragment";
Dries's avatar
 
Dries committed
1199
      }
Dries's avatar
 
Dries committed
1200 1201 1202
    }
  }
  else {
Dries's avatar
 
Dries committed
1203 1204
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
Dries committed
1205
        return "$base$url?$query$fragment";
Dries's avatar
 
Dries committed
1206 1207
      }
      else {
Dries's avatar
Dries committed
1208
        return "$base$url$fragment";
Dries's avatar
 
Dries committed
1209
      }
Dries's avatar
 
Dries committed
1210
    }
Dries's avatar
 
Dries committed
1211
    else {
Dries's avatar
 
Dries committed
1212
      if (isset($query)) {
Dries's avatar
Dries committed
1213
        return "$base$script?$query$fragment";
Dries's avatar
 
Dries committed
1214 1215
      }
      else {
Dries's avatar
Dries committed
1216
        return "$base$fragment";
Dries's avatar
 
Dries committed
1217
      }
Dries's avatar
 
Dries committed
1218
    }
Dries's avatar
 
Dries committed
1219
  }
Dries's avatar
 
Dries committed
1220 1221
}

1222 1223
function drupal_attributes($attributes = array()) {
  if (count($attributes)) {
1224 1225 1226 1227
    $t = array();
    foreach ($attributes as $key => $value) {
      $t[] = "$key=\"$value\"";
    }
1228

1229
    return " ". implode($t, " ");
Dries's avatar
 
Dries committed
1230
  }
1231
}
Dries's avatar
 
Dries committed
1232

Dries's avatar
Dries committed
1233
function l($text, $url, $attributes = array(), $query = NULL, $fragment = NULL, $absolute = NULL) {
1234
  if (drupal_get_normal_path($url) == $_GET['q']) {
Dries's avatar
 
Dries committed
1235 1236 1237 1238 1239 <