common.inc 37.3 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") {
Dries's avatar
 
Dries committed
43
  static $stored_message = array();
Dries's avatar
 
Dries committed
44 45

  if (isset($message)) {
Dries's avatar
 
Dries committed
46
    $stored_message[] = array($message, $type);
Dries's avatar
 
Dries committed
47 48 49 50 51
  }

  return $stored_message;
}

Dries's avatar
 
Dries committed
52
function drupal_get_messages() {
Dries's avatar
 
Dries committed
53 54
  return drupal_set_message();
}
Kjartan's avatar
Kjartan committed
55
/* @} */
Dries's avatar
 
Dries committed
56

Dries's avatar
 
Dries committed
57
/**
Kjartan's avatar
Kjartan committed
58 59
 * @name Page breadcrumbs
 * @ingroup common
Dries's avatar
 
Dries committed
60 61 62 63
 *
 * Functions to get and set the breadcrumb trail of the current page.
 * @{
 */
Kjartan's avatar
Kjartan committed
64 65 66 67 68

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

Dries's avatar
Dries committed
89 90 91 92 93 94 95 96 97
/**
 * @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
98
  static $stored_head = '';
Dries's avatar
Dries committed
99 100 101 102 103 104 105 106 107 108

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

function drupal_get_html_head() {
  global $base_url;

Dries's avatar
 
Dries committed
109
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
110
  $output .= "<base href=\"$base_url/\" />\n";
Dries's avatar
 
Dries committed
111
  $output .= "<style type=\"text/css\" media=\"all\">\n";
Dries's avatar
Dries committed
112 113 114 115 116 117 118
  $output .= "@import url(misc/drupal.css);\n";
  $output .= "</style>\n";

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

Dries's avatar
 
Dries committed
119
/**
Dries's avatar
 
Dries committed
120
 * @name URL path alias
Kjartan's avatar
Kjartan committed
121 122
 * @ingroup common
 *
Dries's avatar
 
Dries committed
123
 * Functions to handle path aliases.
Dries's avatar
 
Dries committed
124
 */
Dries's avatar
 
Dries committed
125
function drupal_get_path_map($action = "") {
Dries's avatar
Dries committed
126
  static $map = NULL;
Dries's avatar
 
Dries committed
127

Dries's avatar
 
Dries committed
128 129 130 131
  if ($action == "rebuild") {
    $map = NULL;
  }

Dries's avatar
Dries committed
132
  if (is_null($map)) {
Dries's avatar
 
Dries committed
133
    $map = array();  // make $map non-null in case no aliases are defined
Dries's avatar
 
Dries committed
134
    $result = db_query("SELECT * FROM {url_alias}");
Dries's avatar
 
Dries committed
135
    while ($data = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
136
      $map[$data->dst] = $data->src;
Dries's avatar
 
Dries committed
137 138 139 140 141 142
    }
  }

  return $map;
}

Dries's avatar
 
Dries committed
143 144 145
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}
Kjartan's avatar
Kjartan committed
146 147

/**
Dries's avatar
 
Dries committed
148
 * Given an old url, return the alias.
Kjartan's avatar
Kjartan committed
149
 */
Dries's avatar
 
Dries committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
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
174

Dries's avatar
Dries committed
175 176 177 178 179 180 181 182
/**
 * @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
183
  static $stored_headers = '';
Dries's avatar
Dries committed
184 185 186 187 188 189 190 191 192 193 194 195 196

  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
197 198 199 200 201 202 203 204
/**
 * @name HTTP handling
 * @ingroup common
 *
 * Functions to properly handle HTTP responses.
 * @{
 */

Kjartan's avatar
Kjartan committed
205 206 207 208 209 210
/**
 * 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
211 212 213
 * @param $url A Drupal URL
 * @param $query Query string component
 * @param $fragment Fragment identifier
Kjartan's avatar
Kjartan committed
214
 */
Dries's avatar
Dries committed
215
function drupal_goto($url = NULL, $query = NULL, $fragment = NULL) {
Kjartan's avatar
Kjartan committed
216 217

  /*
Dries's avatar
Dries committed
218
  ** Translate &amp; to simply & in the absolute URL
Kjartan's avatar
Kjartan committed
219
  */
Dries's avatar
 
Dries committed
220

Dries's avatar
Dries committed
221
  $url = str_replace("&amp;", "&", url($url, $query, $fragment, TRUE));
Kjartan's avatar
Kjartan committed
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253

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

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries's avatar
 
Dries committed
259
  $status = MENU_FALLTHROUGH;
Dries's avatar
 
Dries committed
260 261
  if ($path) {
    menu_set_active_item($path);
Dries's avatar
 
Dries committed
262
    $status = menu_execute_active_handler();
Dries's avatar
 
Dries committed
263 264
  }

Dries's avatar
 
Dries committed
265
  if ($status != MENU_FOUND) {
Dries's avatar
Dries committed
266
    print theme('page', '', t('Page not found'));
Dries's avatar
 
Dries committed
267 268
  }
}
Dries's avatar
 
Dries committed
269

Dries's avatar
 
Dries committed
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
/**
 * 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
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
/**
 * 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(
331 332 333
    'Host' => "Host: $uri[host]",
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
 
Dries committed
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
  );

  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.
351
  while (!feof($fp) && $data = fgets($fp, 1024)) {
Dries's avatar
 
Dries committed
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 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
    $response[] = $data;
  }
  fclose($fp);

  // Parse response.
  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
408
/* @} */
Dries's avatar
 
Dries committed
409

Dries's avatar
 
Dries committed
410 411 412
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
413 414

  if ($errno & E_ALL ^ E_NOTICE) {
Dries's avatar
 
Dries committed
415
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
Dries's avatar
Dries committed
416 417 418
    if (error_reporting()) {
      print "<pre>$entry</pre>";
    }
Dries's avatar
 
Dries committed
419 420 421
  }
}

Dries's avatar
Dries committed
422 423
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
424 425 426
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
427
    $item = stripslashes($item);
Dries's avatar
 
Dries committed
428 429 430
  }
}

Dries's avatar
 
Dries committed
431 432
function fix_gpc_magic() {
  static $fixed = false;
Kjartan's avatar
Kjartan committed
433
  if (!$fixed && ini_get("magic_quotes_gpc")) {
Dries's avatar
Dries committed
434 435 436 437 438 439
    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
440 441
}

Kjartan's avatar
Kjartan committed
442 443 444 445 446 447 448
/**
 * @name Conversion
 * @ingroup common
 *
 * Converts data structures to a different type.
 * @{
 */
Dries's avatar
Dries committed
449 450 451
function array2object($array) {
  if (is_array($array)) {
    foreach ($array as $key => $value) {
Dries's avatar
 
Dries committed
452 453 454 455
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
456
    $object = $array;
Dries's avatar
 
Dries committed
457 458 459 460 461
  }

  return $object;
}

Dries's avatar
Dries committed
462 463 464
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
 
Dries committed
465 466 467 468
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
469
    $array = $object;
Dries's avatar
 
Dries committed
470 471 472 473
  }

  return $array;
}
Kjartan's avatar
Kjartan committed
474
/* @} */
Dries's avatar
 
Dries committed
475

Kjartan's avatar
Kjartan committed
476 477 478 479 480 481 482
/**
 * @name Messages
 * @ingroup common
 *
 * Frequently used messages.
 * @{
 */
Dries's avatar
 
Dries committed
483
function message_access() {
Dries's avatar
 
Dries committed
484
  return t("You are not authorized to access this page.");
Dries's avatar
 
Dries committed
485 486 487 488 489 490
}

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

Kjartan's avatar
Kjartan committed
491
/* @} */
Dries's avatar
 
Dries committed
492

Dries's avatar
 
Dries committed
493 494
function locale_init() {
  global $languages, $user;
Dries's avatar
 
Dries committed
495 496 497 498 499 500
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
 
Dries committed
501 502
}

Kjartan's avatar
Kjartan committed
503 504 505 506 507
/**
 * @ingroup common
 *
 * Translates strings to the current locale.
 *
508 509 510 511
 * 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
512 513 514 515 516
 * @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
517 518 519
 * 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
520 521 522 523 524
 *
 * @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
525
function t($string, $args = 0) {
Dries's avatar
 
Dries committed
526
  global $languages;
527

528
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
529

Dries's avatar
 
Dries committed
530 531
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
532 533
  }
  else {
Dries's avatar
 
Dries committed
534 535
    return strtr($string, $args);
  }
Dries's avatar
 
Dries committed
536 537
}

Dries's avatar
 
Dries committed
538
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
 
Dries committed
539 540 541 542 543 544 545 546 547

  /*
  ** 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
548 549
}

Kjartan's avatar
Kjartan committed
550 551 552 553 554
/**
 * @name Validation
 * @ingroup common
 *
 * Functions to validate user input.
Dries's avatar
 
Dries committed
555
 * @{
Kjartan's avatar
Kjartan committed
556 557
 */

558
/**
Dries's avatar
 
Dries committed
559 560
 * Verify the syntax of the given e-mail address. Empty e-mail addresses are
 * allowed. See RFC 2822 for details.
561
 *
Kjartan's avatar
Kjartan committed
562
 * @param $mail A string containing an email address.
Dries's avatar
 
Dries committed
563
 * @return
564
 */
Dries's avatar
 
Dries committed
565
function valid_email_address($mail) {
566 567 568 569 570
  $user = '[a-zA-Z0-9_\-\.\+\^!#\$%&*+\/\=\?\`\|\{\}~\']+';
  $domain = '(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]\.?)+';
  $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
571
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
572 573
}

Dries's avatar
 
Dries committed
574 575 576
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
 
Dries committed
577 578 579 580 581 582
 * @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
583
 */
Dries's avatar
 
Dries committed
584
function valid_url($url, $absolute = FALSE) {
585
  if ($absolute) {
586
    return preg_match("/^(http|https|ftp):\/\/[a-z0-9\/:_\-_\.\?,~=#&]+$/i", $url);
587 588
  }
  else {
589
    return preg_match("/^[a-z0-9\/:_\-_\.,]+$/i", $url);
590
  }
Dries's avatar
 
Dries committed
591 592
}

Kjartan's avatar
Kjartan committed
593 594 595 596 597 598 599
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
600
      if (!valid_input_data($key) || !valid_input_data($value)) {
Kjartan's avatar
Kjartan committed
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
        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
635 636 637
/**
 * Format a single result entry of a search query:
 *
Dries's avatar
 
Dries committed
638
 * @param $item a single search result as returned by <i>module</i>_search of
639
 *   type array("count" => ..., "link" => ..., "title" => ..., "user" => ...,
Dries's avatar
 
Dries committed
640 641
 *   "date" => ..., "keywords" => ...)
 * @param $type module type of this item
Kjartan's avatar
Kjartan committed
642
 */
Dries's avatar
 
Dries committed
643
function search_item($item, $type) {
Dries's avatar
 
Dries committed
644 645 646 647 648 649 650 651 652 653

  /*
  ** 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 {
654 655
    $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
656
  }
Dries's avatar
 
Dries committed
657 658 659 660

  return $output;
}

Kjartan's avatar
Kjartan committed
661 662 663 664
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
 
Dries committed
665 666 667
 * '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
668
 *
Dries's avatar
 
Dries committed
669 670 671 672
 * @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
673
 */
Dries's avatar
 
Dries committed
674
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
 
Dries committed
675 676
  $edit = $_POST['edit'];

Dries's avatar
 
Dries committed
677
  if (!$action) {
Dries's avatar
 
Dries committed
678
    $action = url("search");
Dries's avatar
 
Dries committed
679 680
  }

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

Dries's avatar
Dries committed
684
  if ($options) {
Dries's avatar
 
Dries committed
685 686 687 688 689
    $output .= "<br />";
    $output .= t("Restrict search to") .": ";

    foreach (module_list() as $name) {
      if (module_hook($name, "search")) {
Kjartan's avatar
Kjartan committed
690
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
 
Dries committed
691 692
      }
    }
693
    $output .= "</div>";
Dries's avatar
 
Dries committed
694 695 696 697 698 699
  }

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

/*
Kjartan's avatar
Kjartan committed
700 701
 * Collect the search results:
 */
Dries's avatar
 
Dries committed
702
function search_data($keys = NULL) {
Dries's avatar
 
Dries committed
703
  $edit = $_POST["edit"];
Dries's avatar
 
Dries committed
704
  $output = '';
Dries's avatar
 
Dries committed
705

Dries's avatar
 
Dries committed
706
  if (isset($keys)) {
Dries's avatar
 
Dries committed
707
    foreach (module_list() as $name) {
Dries's avatar
 
Dries committed
708 709 710 711
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name])) {
        list($title, $results) = module_invoke($name, "search", $keys);
        if ($results) {
          $output .= "<h2>$title</h2>";
712
          $output .= "<dl class=\"search-results\">";
Dries's avatar
 
Dries committed
713 714 715
          foreach ($results as $entry) {
            $output .= search_item($entry, $name);
          }
716
          $output .= "</dl>";
Dries's avatar
 
Dries committed
717 718 719 720 721 722 723 724
        }
      }
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
725 726 727
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
 
Dries committed
728 729 730 731 732 733
 * @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
734
 */
Dries's avatar
 
Dries committed
735 736
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
  $_POST["edit"]["type"][$type] = "on";
Dries's avatar
 
Dries committed
737

Dries's avatar
 
Dries committed
738
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries's avatar
 
Dries committed
739
}
Kjartan's avatar
Kjartan committed
740
/* @} */
Dries's avatar
 
Dries committed
741

Dries's avatar
 
Dries committed
742
function check_form($text) {
Dries's avatar
 
Dries committed
743
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
 
Dries committed
744 745
}

746 747
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
 
Dries committed
748 749
}

Dries's avatar
 
Dries committed
750 751 752 753 754 755 756 757
/**
 * @name Formatting
 * @ingroup common
 *
 * Functions to format numbers, strings, dates, etc.
 * @{
 */

Dries's avatar
 
Dries committed
758 759 760
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
761
  $output = "<channel>\n";
Dries's avatar
 
Dries committed
762 763 764 765
  $output .= " <title>". drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= " <link>". drupal_specialchars(strip_tags($link)) ."</link>\n";
  $output .= " <description>". drupal_specialchars($description) ."</description>\n";
  $output .= " <language>". drupal_specialchars(strip_tags($language)) ."</language>\n";
Dries's avatar
 
Dries committed
766
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
767
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
 
Dries committed
768
  }
Dries's avatar
 
Dries committed
769 770 771 772 773 774
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
Dries committed
778
  $output = "<item>\n";
Dries's avatar
 
Dries committed
779 780 781
  $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
782
  foreach ($args as $key => $value) {
Dries's avatar
 
Dries committed
783
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
 
Dries committed
784
  }
Dries's avatar
 
Dries committed
785 786 787 788 789
  $output .= "</item>\n";

  return $output;
}

Dries's avatar
 
Dries committed
790 791
/**
 * Formats a string with a count of items so that the string is pluralized
Dries's avatar
 
Dries committed
792 793
 * correctly. format_plural calls t() by itself, make sure not to pass already
 * localized strings to it.
Dries's avatar
 
Dries committed
794
 *
Dries's avatar
 
Dries committed
795 796 797 798
 * @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
799
 * @param $plural The string for the plural case. Please make sure it's clear
Dries's avatar
 
Dries committed
800 801
 *   this is plural, to ease translation. Use %count in places of the item
 *   count, as in "%count new comments".
Dries's avatar
 
Dries committed
802
 * @return Translated string
Dries's avatar
 
Dries committed
803
 */
Dries's avatar
 
Dries committed
804
function format_plural($count, $singular, $plural) {
Dries's avatar
 
Dries committed
805
  return t($count == 1 ? $singular : $plural, array("%count" => $count));
Dries's avatar
 
Dries committed
806 807
}

Dries's avatar
 
Dries committed
808 809 810 811 812 813
/**
 * 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
814
function format_size($size) {
Dries's avatar
 
Dries committed
815
  $suffix = t("bytes");
Dries's avatar
 
Dries committed
816 817
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
818
    $suffix = t("KB");
Dries's avatar
 
Dries committed
819 820 821
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
 
Dries committed
822
    $suffix = t("MB");
Dries's avatar
 
Dries committed
823
  }
Dries's avatar
 
Dries committed
824
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
 
Dries committed
825 826
}

Dries's avatar
 
Dries committed
827 828 829 830 831 832 833
/**
 * 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
834
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
 
Dries committed
835
  $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
836
  $output = '';
Dries's avatar
 
Dries committed
837
  foreach ($units as $key => $value) {
Dries's avatar
 
Dries committed
838 839 840 841
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
Dries's avatar
 
Dries committed
842 843 844 845 846
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
 
Dries committed
847 848
    }
  }
Dries's avatar
 
Dries committed
849
  return $output ? $output : t("0 sec");
Dries's avatar
 
Dries committed
850 851
}

Dries's avatar
 
Dries committed
852 853 854 855 856 857 858 859 860 861 862 863
/**
 * 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.
864 865
 * @param $timezone Timezone offset in seconds in case the user timezone
 *   should not be used.
Dries's avatar
 
Dries committed
866 867
 * @return Translated date string in the requested format
 */
868 869 870 871 872
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
873

874
  $timestamp += $timezone;
Dries's avatar
 
Dries committed
875 876

  switch ($type) {
877 878
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
 
Dries committed
879
      break;
880 881
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
 
Dries committed
882
      break;
883
    case 'custom':
Dries's avatar
 
Dries committed
884
      // No change to format
Dries's avatar
 
Dries committed
885
      break;
886
    case 'medium':
Dries's avatar
 
Dries committed
887
    default:
888
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
 
Dries committed
889 890
  }

891
  $max = strlen($format);
Dries's avatar
 
Dries committed
892
  $date = '';
893 894
  for ($i = 0; $i <= $max; $c = $format{$i++}) {
    if (strpos('AaDFlM', $c)) {
895
      $date .= t(gmdate($c, $timestamp));
896 897 898 899 900 901
    }
    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
902
    }
903 904 905 906 907
    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
908 909
    }
    else {
910
      $date .= $c;
Dries's avatar
 
Dries committed
911
    }
Dries's avatar
 
Dries committed
912
  }
913

Dries's avatar
 
Dries committed
914 915 916
  return $date;
}

Dries's avatar
 
Dries committed
917 918 919 920 921 922 923 924
/**
 * 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
925 926 927
function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
Dries committed
928 929 930 931 932 933
    /*
    ** Shorten the name when it is too long or it will break many
    ** tables.
    */

    if (strlen($object->name) > 20) {
934
      $name = truncate_utf8($object->name, 15) ."...";
Dries's avatar
Dries committed
935 936 937 938 939
    }
    else {
      $name = $object->name;
    }

Dries's avatar
 
Dries committed
940
    if (arg(0) == "admin" and user_access("administer users")) {
Dries's avatar
Dries committed
941
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
 
Dries committed
942 943
    }
    else {
Dries's avatar
Dries committed
944
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
 
Dries committed
945
    }
Dries's avatar
 
Dries committed
946
  }
Dries's avatar
 
Dries committed
947 948 949 950 951 952 953 954 955 956
  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.
    */

    $output = $object->name;
  }
Dries's avatar
 
Dries committed
957
  else {
Dries's avatar
 
Dries committed
958
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
 
Dries committed
959 960
  }

Dries's avatar
 
Dries committed
961
  return $output;
Dries's avatar
 
Dries committed
962
}
Dries's avatar
 
Dries committed
963
/* @} */
Dries's avatar
 
Dries committed
964

Kjartan's avatar
Kjartan committed
965 966 967 968
/**
 * @defgroup from Form generation
 * @{
 */
969
function form($form, $method = "post", $action = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
970
  if (!$action) {
971
    $action = request_uri();
Dries's avatar
 
Dries committed
972
  }
973
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($attributes) .">\n$form\n</form>\n";
Dries's avatar
 
Dries committed
974 975
}

Dries's avatar
 
Dries committed
976 977
function form_item($title, $value, $description = NULL, $id = NULL) {
  return theme("form_element", $title, $value, $description, $id);
Dries's avatar
 
Dries committed
978
}
Dries's avatar
 
Dries committed
979

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

Dries's avatar
 
Dries committed
984
function form_radio($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
985 986 987 988 989
  $element = "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"$value\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) .' />';
  if (!is_null($title)) {
    $element = "<label class=\"option\">$element $title</label>";
  }
  return theme('form_element', NULL, $element, $description);
Dries's avatar
 
Dries committed
990 991 992 993
}

function form_radios($title, $name, $value, $options, $description = NULL) {
  if (count($options) > 0) {
Dries's avatar
 
Dries committed
994
    $choices = '';
Dries's avatar
 
Dries committed
995
    foreach ($options as $key => $choice) {
996
      $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
997
    }
998
    return theme('form_element', $title, $choices, $description);
Dries's avatar
 
Dries committed
999
  }
Dries's avatar
 
Dries committed
1000 1001
}

Dries's avatar
 
Dries committed
1002
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
1003 1004 1005 1006 1007
  $element = "<input type=\"checkbox\" class=\"form-checkbox\" name=\"edit[$name]\" id=\"edit-$name\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) .' />';
  if (!is_null($title)) {
    $element = "<label class=\"option\">$element $title</label>";
  }
  return form_hidden($name, 0) . theme('form_element', NULL, $element, $description);
Dries's avatar
 
Dries committed
1008 1009
}

Dries's avatar
 
Dries committed
1010
function form_textfield($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
1011
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
1012
  return theme("form_element", $title, "<input type=\"text\" maxlength=\"$maxlength\" class=\"form-text\" name=\"edit[$name]\" id=\"$name\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description, $name);
Dries's avatar
 
Dries committed
1013 1014
}

Dries's avatar
 
Dries committed
1015
function form_password($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
1016
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
 
Dries committed
1017
  return theme("form_element", $title, "<input type=\"password\" class=\"form-password\" maxlength=\"$maxlength\" name=\"edit[$name]\" id=\"$name\"$size value=\"". check_form($value) ."\"". drupal_attributes($attributes) ." />", $description, $name);
Dries's avatar
 
Dries committed
1018 1019
}

Dries's avatar
 
Dries committed
1020
function form_textarea($title, $name, $value, $cols, $rows, $description = NULL, $attributes = NULL) {
Dries's avatar
 
Dries committed
1021
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries's avatar
 
Dries committed
1022
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
Dries's avatar
 
Dries committed
1023
  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);
Dries's avatar
 
Dries committed
1024 1025
}

Dries's avatar
 
Dries committed
1026
function form_select($title, $name, $value, $options, $description = NULL, $extra = 0, $multiple = 0) {
Dries's avatar
 
Dries committed
1027
  $select = '';
Dries's avatar
 
Dries committed
1028 1029
  foreach ($options as $key => $choice) {
    $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
1030
  }
1031
  return theme("form_element", $title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple=\"multiple\" " : "") . ($extra ? " $extra" : "") ." id=\"$name\">$select</select>", $description, $name);
Dries's avatar
 
Dries committed
1032 1033
}

Dries's avatar
 
Dries committed
1034 1035
function form_file($title, $name, $size, $description = NULL) {
  return theme("form_element", $title, "<input type=\"file\" class=\"form-file\" name=\"edit[$name]\" id=\"$name\" size=\"$size\" />\n", $description, $name);
Dries's avatar
 
Dries committed
1036 1037 1038 1039 1040 1041
}

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

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

Dries's avatar
 
Dries committed
1046
function form_submit($value, $name = "op", $attributes = NULL) {
Dries's avatar
 
Dries committed
1047
  return form_button($value, $name, "submit", $attributes);
Dries's avatar
 
Dries committed
1048 1049
}

Dries's avatar
 
Dries committed
1050
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = NULL, $extra = 0) {
Dries's avatar
 
Dries committed
1051
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
 
Dries committed
1052 1053 1054 1055 1056
    $weights[$n] = $n;
  }

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

Dries's avatar
Dries committed
1059
function url($url = NULL, $query = NULL, $fragment = NULL, $absolute = NULL) {
Dries's avatar
 
Dries committed
1060
  global $base_url;
Dries's avatar
 
Dries committed
1061

Dries's avatar
 
Dries committed
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
  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
1073
  if ($alias = drupal_get_path_alias($url)) {
Dries's avatar
 
Dries committed
1074 1075 1076
    $url = $alias;
  }

Dries's avatar
 
Dries committed
1077 1078 1079 1080
  if (isset($fragment)) {
    $fragment = "#$fragment";
  }

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

Dries's avatar
 
Dries committed
1083
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
 
Dries committed
1084 1085
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
Dries committed
1086
        return "$base$script?q=$url&amp;$query$fragment";
Dries's avatar
 
Dries committed
1087 1088
      }
      else {
Dries's avatar
Dries committed
1089
        return "$base$script?q=$url$fragment";
Dries's avatar
 
Dries committed
1090
      }
Dries's avatar
 
Dries committed
1091 1092
    }
    else {
Dries's avatar
 
Dries committed
1093
      if (isset($query)) {
Dries's avatar
Dries committed
1094
        return "$base$script?$query$fragment";
Dries's avatar
 
Dries committed
1095 1096
      }
      else {
Dries's avatar
Dries committed
1097
        return "$base$fragment";
Dries's avatar
 
Dries committed
1098
      }
Dries's avatar
 
Dries committed
1099 1100 1101
    }
  }
  else {
Dries's avatar
 
Dries committed
1102 1103
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
Dries committed
1104
        return "$base$url?$query$fragment";
Dries's avatar
 
Dries committed
1105 1106
      }
      else {
Dries's avatar
Dries committed
1107
        return "$base$url$fragment";
Dries's avatar
 
Dries committed
1108
      }
Dries's avatar
 
Dries committed
1109
    }
Dries's avatar
 
Dries committed
1110
    else {
Dries's avatar
 
Dries committed
1111
      if (isset($query)) {
Dries's avatar
Dries committed
1112
        return "$base$script?$query$fragment";
Dries's avatar
 
Dries committed
1113 1114
      }
      else {
Dries's avatar
Dries committed
1115
        return "$base$fragment";
Dries's avatar
 
Dries committed
1116
      }
Dries's avatar
 
Dries committed
1117
    }
Dries's avatar
 
Dries committed
1118
  }
Dries's avatar
 
Dries committed
1119 1120
}

1121 1122
function drupal_attributes($attributes = array()) {
  if (count($attributes)) {
1123 1124 1125 1126
    $t = array();
    foreach ($attributes as $key => $value) {
      $t[] = "$key=\"$value\"";
    }
1127

1128
    return " ". implode($t, " ");
Dries's avatar
 
Dries committed
1129
  }
1130
}
Dries's avatar
 
Dries committed
1131

Dries's avatar
Dries committed
1132
function l($text, $url, $attributes = array(), $query = NULL, $fragment = NULL, $absolute = NULL) {
Dries's avatar
 
Dries committed
1133 1134 1135 1136 1137 1138 1139 1140
  if ($url == $_GET['q']) {
    if (isset($attributes['class'])) {
      $attributes['class'] .= ' active';
    }
    else {
      $attributes['class'] = 'active';
    }
  }
Dries's avatar
Dries committed
1141
  return "<a href=\"". url($url, $query, $fragment, $absolute) ."\"". drupal_attributes($attributes) .">$text</a>";
Dries's avatar
 
Dries committed
1142 1143
}

Dries's avatar
 
Dries committed
1144
function field_get($string, $name) {
Dries's avatar
 
Dries committed
1145
  ereg(",$name=([^,]+)", ",$string", $regs);
Dries's avatar
 
Dries committed
1146 1147 1148 1149 1150
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Dries's avatar
 
Dries committed
1151
  if (isset($value)) {
Kjartan's avatar
Kjartan committed
1152 1153
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
 
Dries committed
1154 1155 1156 1157
  return substr($rval, 1);
}

function link_page() {
1158
  global $custom_links;
Dries's avatar
 
Dries committed
1159

1160
  if (is_array($custom_links)) {
1161 1162 1163
    return $custom_links;
  }
  else {
Dries's avatar
 
Dries committed
1164
    $links = module_invoke_all("link", "page");
1165
    array_unshift($links, l(t("home"), "", array("title" => t("Return to the main page."))));
1166
    return $links;
Dries's avatar
 
Dries committed
1167
  }
Dries's avatar
 
Dries committed
1168
}
Dries's avatar
 
Dries committed
1169 1170

function link_node($node, $main = 0) {
Dries's avatar
 
Dries committed
1171
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
 
Dries committed
1172 1173
}

Dries's avatar
 
Dries committed
1174
function drupal_page_footer() {
Dries's avatar
 
Dries committed
1175
  if (variable_get("cache", 0)) {
Dries's avatar
 
Dries committed
1176
    page_set_cache();
Dries's avatar
 
Dries committed
1177
  }
Dries's avatar
 
Dries committed
1178

Dries's avatar
 
Dries committed
1179 1180 1181 1182 1183
  /*
  ** A hook for modules where modules may take action at the end of a
  ** request good uses include setting a cache, page logging, etc.
  */

Dries's avatar
 
Dries committed
1184
  module_invoke_all("exit");
Dries's avatar
 
Dries committed
1185 1186
}

Dries's avatar
 
Dries committed
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
/**
 * Walks through the provided array and constructs an associative
 * array out of it. The keys of the resulting array will be the
 * values of the passed array. The values will either be the same
 * (if no function was specified), or the results of the function
 * given the value.
 *
 * @param $array An array
 * @param $function A name of a function to apply to all values
 */
function drupal_map_assoc($array, $function = NULL) {
  if (!isset($function)) {
    $result = array();
    foreach ($array as $value) {
      $result[$value] = $value;
    }
    return $result;
  }
  elseif (function_exists($function)) {
    $result = array();
    foreach($array as $value) {
      $result[$value] = $function($value);
    }
    return $result;
  }
}

1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
/**
 * Wrapper around xml_parser_create() which extracts the encoding from the XML
 * data first and sets the output encoding to UTF-8. This function should be
 * used instead of xml_parser_create(), because PHP's XML parser doesn't check
 * the input encoding itself.
 *
 * This is also where unsupported encodings should be converted.
 * Callers should take this into account: $data might have been changed after
 * the call.
 *
 * @param $data The XML data which will be parsed later.
 */
function drupal_xml_parser_create(&$data) {
  $encoding = 'utf-8';
  if (ereg('^<\?xml[^>]+encoding="([^"]+)"', $data, $match)) {
    $encoding = $match[1];
  }

  /*
1233 1234
   * Unsupported encodings are converted here into UTF-8.
   * Requires iconv, see http://www.php.net/iconv
1235
   */
1236 1237 1238 1239 1240 1241 1242 1243 1244 <