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

Dries's avatar
   
Dries committed
4
/**
Kjartan's avatar
Kjartan committed
5
6
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
87
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();
    array_pop($breadcrumb);
  }

  return $breadcrumb;
}
Kjartan's avatar
Kjartan committed
88
/* @} */
Dries's avatar
   
Dries committed
89

Dries's avatar
Dries committed
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/**
 * @name HTML head contents
 * @ingroup common
 *
 * Set and get output that should be in the \<head\> tag.
 * @{
 */

function drupal_set_html_head($data = NULL) {
  static $stored_head;

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

function drupal_get_html_head() {
  global $base_url;

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

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

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

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

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

  return $map;
}

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

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

Dries's avatar
Dries committed
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/**
 * @name HTTP headers
 * @ingroup common
 *
 * Functions to get and set the HTTP headers of the current page.
 * @{
 */
function drupal_set_header($header = NULL) {
  static $stored_headers;

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

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

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

Dries's avatar
Dries committed
222
  $url = str_replace("&amp;", "&", url($url, $query, $fragment, TRUE));
Kjartan's avatar
Kjartan committed
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
254

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

  $path = drupal_get_normal_path(variable_get('site_404', ''));

  if ($path) {
    menu_set_active_item($path);
  }

  if ($path && menu_active_handler_exists()) {
    menu_execute_active_handler();
  }
  else {
Dries's avatar
Dries committed
269
    print theme('page', '', t('Page not found'));
Dries's avatar
   
Dries committed
270
271
  }
}
Dries's avatar
   
Dries committed
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315

/**
 * 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(
316
317
318
    'Host' => "Host: $uri[host]",
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries's avatar
   
Dries committed
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
  );

  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.
336
  while (!feof($fp) && $data = fgets($fp, 1024)) {
Dries's avatar
   
Dries committed
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
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
    $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
393
/* @} */
Dries's avatar
   
Dries committed
394

Dries's avatar
   
Dries committed
395
396
397
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
398
399

  if ($errno & E_ALL ^ E_NOTICE) {
Dries's avatar
   
Dries committed
400
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
Dries's avatar
Dries committed
401
402
403
    if (error_reporting()) {
      print "<pre>$entry</pre>";
    }
Dries's avatar
   
Dries committed
404
405
406
  }
}

Dries's avatar
Dries committed
407
408
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
409
410
411
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
412
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
413
414
415
  }
}

Dries's avatar
   
Dries committed
416
417
function fix_gpc_magic() {
  static $fixed = false;
Kjartan's avatar
Kjartan committed
418
  if (!$fixed && ini_get("magic_quotes_gpc")) {
Dries's avatar
Dries committed
419
420
421
422
423
424
    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
425
426
}

Kjartan's avatar
Kjartan committed
427
428
429
430
431
432
433
/**
 * @name Conversion
 * @ingroup common
 *
 * Converts data structures to a different type.
 * @{
 */
Dries's avatar
Dries committed
434
435
436
function array2object($array) {
  if (is_array($array)) {
    foreach ($array as $key => $value) {
Dries's avatar
   
Dries committed
437
438
439
440
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
441
    $object = $array;
Dries's avatar
   
Dries committed
442
443
444
445
446
  }

  return $object;
}

Dries's avatar
Dries committed
447
448
449
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
   
Dries committed
450
451
452
453
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
454
    $array = $object;
Dries's avatar
   
Dries committed
455
456
457
458
  }

  return $array;
}
Kjartan's avatar
Kjartan committed
459
/* @} */
Dries's avatar
   
Dries committed
460

Kjartan's avatar
Kjartan committed
461
462
463
464
465
466
467
/**
 * @name Messages
 * @ingroup common
 *
 * Frequently used messages.
 * @{
 */
Dries's avatar
   
Dries committed
468
function message_access() {
Dries's avatar
   
Dries committed
469
  return t("You are not authorized to access this page.");
Dries's avatar
   
Dries committed
470
471
472
473
474
475
}

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

Kjartan's avatar
Kjartan committed
476
/* @} */
Dries's avatar
   
Dries committed
477

Dries's avatar
   
Dries committed
478
479
function locale_init() {
  global $languages, $user;
Dries's avatar
   
Dries committed
480
481
482
483
484
485
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
   
Dries committed
486
487
}

Kjartan's avatar
Kjartan committed
488
489
490
491
492
/**
 * @ingroup common
 *
 * Translates strings to the current locale.
 *
493
494
495
496
 * 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
497
498
499
500
501
 * @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
502
503
504
 * 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
505
506
507
508
509
 *
 * @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
510
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
511
  global $languages;
512

513
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
514

Dries's avatar
   
Dries committed
515
516
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
517
518
  }
  else {
Dries's avatar
   
Dries committed
519
520
    return strtr($string, $args);
  }
Dries's avatar
   
Dries committed
521
522
}

Dries's avatar
   
Dries committed
523
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
   
Dries committed
524
525
526
527
528
529
530
531
532

  /*
  ** 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
533
534
}

Kjartan's avatar
Kjartan committed
535
536
537
538
539
/**
 * @name Validation
 * @ingroup common
 *
 * Functions to validate user input.
Dries's avatar
   
Dries committed
540
 * @{
Kjartan's avatar
Kjartan committed
541
542
 */

543
/**
Dries's avatar
   
Dries committed
544
545
 * Verify the syntax of the given e-mail address. Empty e-mail addresses are
 * allowed. See RFC 2822 for details.
546
 *
Kjartan's avatar
Kjartan committed
547
 * @param $mail A string containing an email address.
Dries's avatar
   
Dries committed
548
 * @return
549
 */
Dries's avatar
   
Dries committed
550
function valid_email_address($mail) {
551
552
553
554
555
  $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
556
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
557
558
}

Dries's avatar
   
Dries committed
559
560
561
/**
 * Verify the syntax of the given URL.
 *
Dries's avatar
   
Dries committed
562
 * @param $url an URL
Dries's avatar
   
Dries committed
563
 */
564
565
566
567
568
569
570
function valid_url($url, $absolute = false) {
  if ($absolute) {
    return preg_match("/^http:\/\/[a-zA-z0-9\/:_\-_\.,]+$/", $url);
  }
  else {
    return preg_match("/^[a-zA-z0-9\/:_\-_\.,]+$/", $url);
  }
Dries's avatar
   
Dries committed
571
572
}

Kjartan's avatar
Kjartan committed
573
574
575
576
577
578
579
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
580
      if (!valid_input_data($key) || !valid_input_data($value)) {
Kjartan's avatar
Kjartan committed
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
        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
615
616
617
/**
 * Format a single result entry of a search query:
 *
Dries's avatar
   
Dries committed
618
 * @param $item a single search result as returned by <i>module</i>_search of
619
 *   type array("count" => ..., "link" => ..., "title" => ..., "user" => ...,
Dries's avatar
   
Dries committed
620
621
 *   "date" => ..., "keywords" => ...)
 * @param $type module type of this item
Kjartan's avatar
Kjartan committed
622
 */
Dries's avatar
   
Dries committed
623
function search_item($item, $type) {
Dries's avatar
   
Dries committed
624
625
626
627
628
629
630
631
632
633

  /*
  ** 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 {
634
    $output = " <strong><u><a href=\"". $item["link"] ."\">". $item["title"] ."</a></u></strong><br />";
Dries's avatar
   
Dries committed
635
    $output .= " <small>" . t($type) . ($item["user"] ? " - ". $item["user"] : "") ."". ($item["date"] ? " - ". format_date($item["date"], "small") : "") ."</small>";
Dries's avatar
   
Dries committed
636
637
    $output .= "<br /><br />";
  }
Dries's avatar
   
Dries committed
638
639
640
641

  return $output;
}

Kjartan's avatar
Kjartan committed
642
643
644
645
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
   
Dries committed
646
647
648
 * '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
649
 *
Dries's avatar
   
Dries committed
650
651
652
653
 * @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
654
 */
Dries's avatar
   
Dries committed
655
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
   
Dries committed
656
657
  $edit = $_POST['edit'];

Dries's avatar
   
Dries committed
658
  if (!$action) {
Dries's avatar
   
Dries committed
659
    $action = url("search");
Dries's avatar
   
Dries committed
660
661
  }

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

Dries's avatar
Dries committed
665
  if ($options) {
Dries's avatar
   
Dries committed
666
667
668
669
670
    $output .= "<br />";
    $output .= t("Restrict search to") .": ";

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

Kjartan's avatar
Kjartan committed
676
677
  $form .= "<br />";

Dries's avatar
   
Dries committed
678
679
680
681
  return form($output, "post", $action);
}

/*
Kjartan's avatar
Kjartan committed
682
683
 * Collect the search results:
 */
Dries's avatar
   
Dries committed
684
function search_data($keys = NULL) {
Dries's avatar
   
Dries committed
685
  $edit = $_POST["edit"];
Dries's avatar
   
Dries committed
686

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

  return $output;
}

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

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

Dries's avatar
   
Dries committed
721
function check_form($text) {
Dries's avatar
   
Dries committed
722
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
   
Dries committed
723
724
}

725
726
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
   
Dries committed
727
728
}

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

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

  return $output;
}

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

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

  return $output;
}

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

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

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

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

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

852
  $timestamp += $timezone;
Dries's avatar
   
Dries committed
853
854

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

869
870
871
  $max = strlen($format);
  for ($i = 0; $i <= $max; $c = $format{$i++}) {
    if (strpos('AaDFlM', $c)) {
872
      $date .= t(gmdate($c, $timestamp));
873
874
875
876
877
878
    }
    else if (strpos('BdgGhHiIjLmnsStTUwWYyz', $c)) {
      $date .= gmdate($c, $timestamp);
    }
    else if ($c == 'r') {
      $date .= format_date($timestamp - $timezone, 'custom', 'D, d M Y H:i:s O', $timezone);
Dries's avatar
   
Dries committed
879
    }
880
881
882
883
884
    else if ($c == 'O') {
      $date .= sprintf('%s%02d%02d', ($timezone < 0 ? '-' : '+'), abs($timezone / 3600), abs($timezone % 3600) / 60);
    }
    else if ($c == 'Z') {
      $date .= $timezone;
Dries's avatar
   
Dries committed
885
886
    }
    else {
887
      $date .= $c;
Dries's avatar
   
Dries committed
888
    }
Dries's avatar
   
Dries committed
889
  }
890

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

Dries's avatar
   
Dries committed
894
895
896
897
898
899
900
901
/**
 * Formats a username.
 *
 * @param $object User object
 * @return String containing a HTML link to the user's page if the
 *         passed object suggests that this is a site user. Otherwise
 *         only the user name is returned.
 */
Dries's avatar
   
Dries committed
902
903
904
function format_name($object) {

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

    if (strlen($object->name) > 20) {
      $name = substr($object->name, 0, 15) ."...";
    }
    else {
      $name = $object->name;
    }

Dries's avatar
   
Dries committed
917
    if (arg(0) == "admin" and user_access("administer users")) {
Dries's avatar
Dries committed
918
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
   
Dries committed
919
920
    }
    else {
Dries's avatar
Dries committed
921
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
   
Dries committed
922
    }
Dries's avatar
   
Dries committed
923
  }
Dries's avatar
   
Dries committed
924
925
926
927
928
929
930
931
932
933
  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
934
  else {
Dries's avatar
   
Dries committed
935
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
   
Dries committed
936
937
  }

Dries's avatar
   
Dries committed
938
  return $output;
Dries's avatar
   
Dries committed
939
}
Dries's avatar
   
Dries committed
940
/* @} */
Dries's avatar
   
Dries committed
941

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

Dries's avatar
   
Dries committed
953
954
function form_item($title, $value, $description = NULL, $id = NULL) {
  return theme("form_element", $title, $value, $description, $id);
Dries's avatar
   
Dries committed
955
}
Dries's avatar
   
Dries committed
956

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

Dries's avatar
   
Dries committed
961
function form_radio($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
962
963
964
965
966
  $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
967
968
969
970
971
}

function form_radios($title, $name, $value, $options, $description = NULL) {
  if (count($options) > 0) {
    foreach ($options as $key => $choice) {
972
      $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
973
    }
974
    return theme('form_element', $title, $choices, $description);
Dries's avatar
   
Dries committed
975
  }
Dries's avatar
   
Dries committed
976
977
}

Dries's avatar
   
Dries committed
978
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
979
980
981
982
983
  $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
984
985
}

Dries's avatar
   
Dries committed
986
function form_textfield($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
Dries's avatar
   
Dries committed
987
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
   
Dries committed
988
  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
989
990
}

Dries's avatar
   
Dries committed
991
function form_password($title, $name, $value, $size, $maxlength, $description = NULL, $attributes = NULL) {
Dries's avatar
   
Dries committed
992
  $size = $size ? " size=\"$size\"" : "";
Dries's avatar
   
Dries committed
993
  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
994
995
}

Dries's avatar
   
Dries committed
996
function form_textarea($title, $name, $value, $cols, $rows, $description = NULL, $attributes = NULL) {
Dries's avatar
   
Dries committed
997
  $cols = $cols ? " cols=\"$cols\"" : "";
Dries's avatar
   
Dries committed
998
  module_invoke_all("textarea", $name);  // eg. optionally plug in a WYSIWYG editor
Dries's avatar
   
Dries committed
999
  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
1000
1001
}

Dries's avatar
   
Dries committed
1002
function form_select($title, $name, $value, $options, $description = NULL, $extra = 0, $multiple = 0) {
Dries's avatar
   
Dries committed
1003
1004
  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
1005
  }
1006
  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
1007
1008
}

Dries's avatar
   
Dries committed
1009
1010
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
1011
1012
1013
1014
1015
1016
}

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

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

Dries's avatar
   
Dries committed
1021
function form_submit($value, $name = "op", $attributes = NULL) {
Dries's avatar
   
Dries committed
1022
  return form_button($value, $name, "submit", $attributes);
Dries's avatar
   
Dries committed
1023
1024
}

Dries's avatar
   
Dries committed
1025
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = NULL, $extra = 0) {
Dries's avatar
   
Dries committed
1026
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
   
Dries committed
1027
1028
1029
1030
1031
    $weights[$n] = $n;
  }

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

Dries's avatar
Dries committed
1034
function url($url = NULL, $query = NULL, $fragment = NULL, $absolute = NULL) {
Dries's avatar
   
Dries committed
1035
  global $base_url;
Dries's avatar
   
Dries committed
1036

Dries's avatar
   
Dries committed
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
  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
1048
  if ($alias = drupal_get_path_alias($url)) {
Dries's avatar
   
Dries committed
1049
1050
1051
    $url = $alias;
  }

Dries's avatar
   
Dries committed
1052
1053
1054
1055
  if (isset($fragment)) {
    $fragment = "#$fragment";
  }

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

Dries's avatar
   
Dries committed
1058
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
   
Dries committed
1059
1060
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
Dries committed
1061
        return "$base$script?q=$url&amp;$query$fragment";
Dries's avatar
   
Dries committed
1062
1063
      }
      else {
Dries's avatar
Dries committed
1064
        return "$base$script?q=$url$fragment";
Dries's avatar
   
Dries committed
1065
      }
Dries's avatar
   
Dries committed
1066
1067
    }
    else {
Dries's avatar
   
Dries committed
1068
      if (isset($query)) {
Dries's avatar
Dries committed
1069
        return "$base$script?$query$fragment";
Dries's avatar
   
Dries committed
1070
1071
      }
      else {
Dries's avatar
Dries committed
1072
        return "$base$fragment";
Dries's avatar
   
Dries committed
1073
      }
Dries's avatar
   
Dries committed
1074
1075
1076
    }
  }
  else {
Dries's avatar
   
Dries committed
1077
1078
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
Dries committed
1079
        return "$base$url?$query$fragment";
Dries's avatar
   
Dries committed
1080
1081
      }
      else {
Dries's avatar
Dries committed
1082
        return "$base$url$fragment";
Dries's avatar
   
Dries committed
1083
      }
Dries's avatar
   
Dries committed
1084
    }
Dries's avatar
   
Dries committed
1085
    else {
Dries's avatar
   
Dries committed
1086
      if (isset($query)) {
Dries's avatar
Dries committed
1087
        return "$base$script?$query$fragment";
Dries's avatar
   
Dries committed
1088
1089
      }
      else {
Dries's avatar
Dries committed
1090
        return "$base$fragment";
Dries's avatar
   
Dries committed
1091
      }
Dries's avatar
   
Dries committed
1092
    }
Dries's avatar
   
Dries committed
1093
  }
Dries's avatar
   
Dries committed
1094
1095
}

1096
1097
function drupal_attributes($attributes = array()) {
  if (count($attributes)) {
1098
1099
1100
1101
    $t = array();
    foreach ($attributes as $key => $value) {
      $t[] = "$key=\"$value\"";
    }
1102

1103
    return " ". implode($t, " ");
Dries's avatar
   
Dries committed
1104
  }
1105
}
Dries's avatar
   
Dries committed
1106

Dries's avatar
Dries committed
1107
function l($text, $url, $attributes = array(), $query = NULL, $fragment = NULL, $absolute = NULL) {
Dries's avatar
   
Dries committed
1108
1109
1110
1111
1112
1113
1114
1115
  if ($url == $_GET['q']) {
    if (isset($attributes['class'])) {
      $attributes['class'] .= ' active';
    }
    else {
      $attributes['class'] = 'active';
    }
  }
Dries's avatar
Dries committed
1116
  return "<a href=\"". url($url, $query, $fragment, $absolute) ."\"". drupal_attributes($attributes) .">$text</a>";
Dries's avatar
   
Dries committed
1117
1118
}

Dries's avatar
   
Dries committed
1119
function field_get($string, $name) {
Dries's avatar
   
Dries committed
1120
  ereg(",$name=([^,]+)", ",$string", $regs);
Dries's avatar
   
Dries committed
1121
1122
1123
1124
1125
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Dries's avatar
   
Dries committed
1126
  if (isset($value)) {
Kjartan's avatar
Kjartan committed
1127
1128
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
   
Dries committed
1129
1130
1131
1132
  return substr($rval, 1);
}

function link_page() {
1133
  global $custom_links;
Dries's avatar
   
Dries committed
1134

1135
  if (is_array($custom_links)) {
1136
1137
1138
    return $custom_links;
  }
  else {
Dries's avatar
   
Dries committed
1139
    $links = module_invoke_all("link", "page");
1140
    array_unshift($links, l(t("home"), "", array("title" => t("Return to the main page."))));
1141
    return $links;
Dries's avatar
   
Dries committed
1142
  }
Dries's avatar
   
Dries committed
1143
}
Dries's avatar
   
Dries committed
1144
1145

function link_node($node, $main = 0) {
Dries's avatar
   
Dries committed
1146
  return module_invoke_all("link", "node", $node, $main);
Dries's avatar
   
Dries committed
1147
1148
}

Dries's avatar
   
Dries committed
1149
function drupal_page_footer() {
Dries's avatar
   
Dries committed
1150
  if (variable_get("cache", 0)) {
Dries's avatar
   
Dries committed
1151
    page_set_cache();
Dries's avatar
   
Dries committed
1152
  }
Dries's avatar
   
Dries committed
1153

Dries's avatar
   
Dries committed
1154
1155
1156
1157
1158
  /*
  ** 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
1159
  module_invoke_all("exit");
Dries's avatar
   
Dries committed
1160
1161
}

Dries's avatar
   
Dries committed
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
/**
 * 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;
  }
}

1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
/**
 * 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];
  }

  /*
1208
1209
   * Unsupported encodings are converted here into UTF-8.
   * Requires iconv, see http://www.php.net/iconv
1210
   */
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
  $php_supported = array('utf-8', 'iso-8859-1', 'us-ascii');
  if (!in_array(strtolower($encoding), $php_supported)) {
    if (function_exists('iconv')) {
      $out = iconv($encoding, 'utf-8', $data);
      if ($out !== false) {
        $data = $out;
        $encoding = 'utf-8';
      }
    }
  }
1221
1222
1223
1224
1225
1226

  $xml_parser = xml_parser_create($encoding);
  xml_parser_set_option($xml_parser, XML_OPTION_TARGET_ENCODING, 'utf-8');
  return $xml_parser;
}

Dries's avatar
   
Dries committed
1227
include_once "includes/theme.inc";
Dries's avatar
   
Dries committed
1228
include_once "includes/pager.inc";
Dries's avatar
   
Dries committed
1229