common.inc 38 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

89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/**
 * @name Page tabs
 * @ingroup common
 *
 * Functions to get and set the tabs of the current page.
 * @{
 */

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

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

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

Dries's avatar
Dries committed
114
115
116
117
118
119
120
121
122
/**
 * @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
123
  static $stored_head = '';
Dries's avatar
Dries committed
124
125
126
127
128
129
130
131
132
133

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

function drupal_get_html_head() {
  global $base_url;

Dries's avatar
   
Dries committed
134
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries's avatar
Dries committed
135
  $output .= "<base href=\"$base_url/\" />\n";
Dries's avatar
   
Dries committed
136
  $output .= "<style type=\"text/css\" media=\"all\">\n";
Dries's avatar
Dries committed
137
138
139
140
141
142
143
  $output .= "@import url(misc/drupal.css);\n";
  $output .= "</style>\n";

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

Dries's avatar
   
Dries committed
144
/**
Dries's avatar
   
Dries committed
145
 * @name URL path alias
Kjartan's avatar
Kjartan committed
146
147
 * @ingroup common
 *
Dries's avatar
   
Dries committed
148
 * Functions to handle path aliases.
Dries's avatar
   
Dries committed
149
 */
Dries's avatar
   
Dries committed
150
function drupal_get_path_map($action = "") {
Dries's avatar
Dries committed
151
  static $map = NULL;
Dries's avatar
   
Dries committed
152

Dries's avatar
   
Dries committed
153
154
155
156
  if ($action == "rebuild") {
    $map = NULL;
  }

Dries's avatar
Dries committed
157
  if (is_null($map)) {
Dries's avatar
   
Dries committed
158
    $map = array();  // make $map non-null in case no aliases are defined
Dries's avatar
   
Dries committed
159
    $result = db_query("SELECT * FROM {url_alias}");
Dries's avatar
   
Dries committed
160
    while ($data = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
161
      $map[$data->dst] = $data->src;
Dries's avatar
   
Dries committed
162
163
164
165
166
167
    }
  }

  return $map;
}

Dries's avatar
   
Dries committed
168
169
170
function drupal_rebuild_path_map() {
  drupal_get_path_map("rebuild");
}
Kjartan's avatar
Kjartan committed
171
172

/**
Dries's avatar
   
Dries committed
173
 * Given an old url, return the alias.
Kjartan's avatar
Kjartan committed
174
 */
Dries's avatar
   
Dries committed
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
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
199

Dries's avatar
Dries committed
200
201
202
203
204
205
206
207
/**
 * @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
208
  static $stored_headers = '';
Dries's avatar
Dries committed
209
210
211
212
213
214
215
216
217
218
219
220
221

  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
222
223
224
225
226
227
228
229
/**
 * @name HTTP handling
 * @ingroup common
 *
 * Functions to properly handle HTTP responses.
 * @{
 */

Kjartan's avatar
Kjartan committed
230
231
232
233
234
235
/**
 * 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
236
237
238
 * @param $url A Drupal URL
 * @param $query Query string component
 * @param $fragment Fragment identifier
Kjartan's avatar
Kjartan committed
239
 */
Dries's avatar
Dries committed
240
function drupal_goto($url = NULL, $query = NULL, $fragment = NULL) {
Kjartan's avatar
Kjartan committed
241
242

  /*
Dries's avatar
Dries committed
243
  ** Translate &amp; to simply & in the absolute URL
Kjartan's avatar
Kjartan committed
244
  */
Dries's avatar
   
Dries committed
245

Dries's avatar
Dries committed
246
  $url = str_replace("&amp;", "&", url($url, $query, $fragment, TRUE));
Kjartan's avatar
Kjartan committed
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

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

  $path = drupal_get_normal_path(variable_get('site_404', ''));
Dries's avatar
   
Dries committed
284
  $status = MENU_FALLTHROUGH;
Dries's avatar
   
Dries committed
285
286
  if ($path) {
    menu_set_active_item($path);
Dries's avatar
   
Dries committed
287
    $status = menu_execute_active_handler();
Dries's avatar
   
Dries committed
288
289
  }

Dries's avatar
   
Dries committed
290
  if ($status != MENU_FOUND) {
Dries's avatar
Dries committed
291
    print theme('page', '', t('Page not found'));
Dries's avatar
   
Dries committed
292
293
  }
}
Dries's avatar
   
Dries committed
294

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

  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.
376
  while (!feof($fp) && $data = fread($fp, 1024)) {
Dries's avatar
   
Dries committed
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
    $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
433
/* @} */
Dries's avatar
   
Dries committed
434

Dries's avatar
   
Dries committed
435
436
437
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
438
439

  if ($errno & E_ALL ^ E_NOTICE) {
Dries's avatar
   
Dries committed
440
    watchdog("error", $types[$errno] .": $message in $filename on line $line.");
Dries's avatar
Dries committed
441
442
443
    if (error_reporting()) {
      print "<pre>$entry</pre>";
    }
Dries's avatar
   
Dries committed
444
445
446
  }
}

Dries's avatar
Dries committed
447
448
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan's avatar
Kjartan committed
449
450
451
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan's avatar
Kjartan committed
452
    $item = stripslashes($item);
Dries's avatar
   
Dries committed
453
454
455
  }
}

Dries's avatar
   
Dries committed
456
457
function fix_gpc_magic() {
  static $fixed = false;
Kjartan's avatar
Kjartan committed
458
  if (!$fixed && ini_get("magic_quotes_gpc")) {
Dries's avatar
Dries committed
459
460
461
462
463
464
    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
465
466
}

Kjartan's avatar
Kjartan committed
467
468
469
470
471
472
473
/**
 * @name Conversion
 * @ingroup common
 *
 * Converts data structures to a different type.
 * @{
 */
Dries's avatar
Dries committed
474
475
476
function array2object($array) {
  if (is_array($array)) {
    foreach ($array as $key => $value) {
Dries's avatar
   
Dries committed
477
478
479
480
      $object->$key = $value;
    }
  }
  else {
Dries's avatar
Dries committed
481
    $object = $array;
Dries's avatar
   
Dries committed
482
483
484
485
486
  }

  return $object;
}

Dries's avatar
Dries committed
487
488
489
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries's avatar
   
Dries committed
490
491
492
493
      $array[$key] = $value;
    }
  }
  else {
Dries's avatar
Dries committed
494
    $array = $object;
Dries's avatar
   
Dries committed
495
496
497
498
  }

  return $array;
}
Kjartan's avatar
Kjartan committed
499
/* @} */
Dries's avatar
   
Dries committed
500

Kjartan's avatar
Kjartan committed
501
502
503
504
505
506
507
/**
 * @name Messages
 * @ingroup common
 *
 * Frequently used messages.
 * @{
 */
Dries's avatar
   
Dries committed
508
function message_access() {
Dries's avatar
   
Dries committed
509
  return t("You are not authorized to access this page.");
Dries's avatar
   
Dries committed
510
511
512
513
514
515
}

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

Kjartan's avatar
Kjartan committed
516
/* @} */
Dries's avatar
   
Dries committed
517

Dries's avatar
   
Dries committed
518
519
function locale_init() {
  global $languages, $user;
Dries's avatar
   
Dries committed
520
521
522
523
524
525
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries's avatar
   
Dries committed
526
527
}

Kjartan's avatar
Kjartan committed
528
529
530
531
532
/**
 * @ingroup common
 *
 * Translates strings to the current locale.
 *
533
534
535
536
 * 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
537
538
539
540
541
 * @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
542
543
544
 * 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
545
546
547
548
549
 *
 * @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
550
function t($string, $args = 0) {
Dries's avatar
   
Dries committed
551
  global $languages;
552

553
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
554

Dries's avatar
   
Dries committed
555
556
  if (!$args) {
    return $string;
Kjartan's avatar
Kjartan committed
557
558
  }
  else {
Dries's avatar
   
Dries committed
559
560
    return strtr($string, $args);
  }
Dries's avatar
   
Dries committed
561
562
}

Dries's avatar
   
Dries committed
563
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries's avatar
   
Dries committed
564
565
566
567
568
569
570
571
572

  /*
  ** 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
573
574
}

Kjartan's avatar
Kjartan committed
575
576
577
578
579
/**
 * @name Validation
 * @ingroup common
 *
 * Functions to validate user input.
Dries's avatar
   
Dries committed
580
 * @{
Kjartan's avatar
Kjartan committed
581
582
 */

583
/**
Dries's avatar
   
Dries committed
584
585
 * Verify the syntax of the given e-mail address. Empty e-mail addresses are
 * allowed. See RFC 2822 for details.
586
 *
Kjartan's avatar
Kjartan committed
587
 * @param $mail A string containing an email address.
Dries's avatar
   
Dries committed
588
 * @return
589
 */
Dries's avatar
   
Dries committed
590
function valid_email_address($mail) {
591
592
593
594
595
  $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
596
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
597
598
}

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

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

  /*
  ** 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 {
679
680
    $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
681
  }
Dries's avatar
   
Dries committed
682
683
684
685

  return $output;
}

Kjartan's avatar
Kjartan committed
686
687
688
689
/**
 * Render a generic search form.
 *
 * "Generic" means "universal usable" - that is, usable not only from
Dries's avatar
   
Dries committed
690
691
692
 * '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
693
 *
Dries's avatar
   
Dries committed
694
695
696
697
 * @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
698
 */
Dries's avatar
   
Dries committed
699
function search_form($action = NULL, $keys = NULL, $options = NULL) {
Dries's avatar
   
Dries committed
700
701
  $edit = $_POST['edit'];

Dries's avatar
   
Dries committed
702
  if (!$action) {
Dries's avatar
   
Dries committed
703
    $action = url("search");
Dries's avatar
   
Dries committed
704
705
  }

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

Dries's avatar
Dries committed
709
  if ($options) {
Dries's avatar
   
Dries committed
710
711
712
713
714
    $output .= "<br />";
    $output .= t("Restrict search to") .": ";

    foreach (module_list() as $name) {
      if (module_hook($name, "search")) {
Kjartan's avatar
Kjartan committed
715
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries's avatar
   
Dries committed
716
717
      }
    }
718
    $output .= "</div>";
Dries's avatar
   
Dries committed
719
720
721
722
723
724
  }

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

/*
Kjartan's avatar
Kjartan committed
725
726
 * Collect the search results:
 */
Dries's avatar
   
Dries committed
727
function search_data($keys = NULL) {
Dries's avatar
   
Dries committed
728
  $edit = $_POST["edit"];
Dries's avatar
   
Dries committed
729
  $output = '';
Dries's avatar
   
Dries committed
730

Dries's avatar
   
Dries committed
731
  if (isset($keys)) {
Dries's avatar
   
Dries committed
732
    foreach (module_list() as $name) {
Dries's avatar
   
Dries committed
733
734
735
736
      if (module_hook($name, "search") && (!$edit["type"] || $edit["type"][$name])) {
        list($title, $results) = module_invoke($name, "search", $keys);
        if ($results) {
          $output .= "<h2>$title</h2>";
737
          $output .= "<dl class=\"search-results\">";
Dries's avatar
   
Dries committed
738
739
740
          foreach ($results as $entry) {
            $output .= search_item($entry, $name);
          }
741
          $output .= "</dl>";
Dries's avatar
   
Dries committed
742
743
744
745
746
747
748
749
        }
      }
    }
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
750
751
752
/**
 * Display the search form and the resulting data.
 *
Dries's avatar
   
Dries committed
753
754
755
756
757
758
 * @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
759
 */
Dries's avatar
   
Dries committed
760
761
function search_type($type, $action = NULL, $keys = NULL, $options = NULL) {
  $_POST["edit"]["type"][$type] = "on";
Dries's avatar
   
Dries committed
762

Dries's avatar
   
Dries committed
763
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries's avatar
   
Dries committed
764
}
Kjartan's avatar
Kjartan committed
765
/* @} */
Dries's avatar
   
Dries committed
766

Dries's avatar
   
Dries committed
767
function check_form($text) {
Dries's avatar
   
Dries committed
768
  return drupal_specialchars($text, ENT_QUOTES);
Dries's avatar
   
Dries committed
769
770
}

771
772
function check_file($filename) {
  return is_uploaded_file($filename);
Dries's avatar
   
Dries committed
773
774
}

Dries's avatar
   
Dries committed
775
776
777
778
779
780
781
782
/**
 * @name Formatting
 * @ingroup common
 *
 * Functions to format numbers, strings, dates, etc.
 * @{
 */

Dries's avatar
   
Dries committed
783
784
785
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
786
  $output = "<channel>\n";
Dries's avatar
   
Dries committed
787
788
  $output .= " <title>". drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= " <link>". drupal_specialchars(strip_tags($link)) ."</link>\n";
789
  $output .= " <description>". drupal_specialchars(strip_tags($description)) ."</description>\n";
Dries's avatar
   
Dries committed
790
  $output .= " <language>". drupal_specialchars(strip_tags($language)) ."</language>\n";
Dries's avatar
   
Dries committed
791
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
792
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries's avatar
   
Dries committed
793
  }
Dries's avatar
   
Dries committed
794
795
796
797
798
799
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

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

Dries's avatar
Dries committed
803
  $output = "<item>\n";
Dries's avatar
   
Dries committed
804
805
806
  $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
807
  foreach ($args as $key => $value) {
Dries's avatar
   
Dries committed
808
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries's avatar
   
Dries committed
809
  }
Dries's avatar
   
Dries committed
810
811
812
813
814
  $output .= "</item>\n";

  return $output;
}

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

Dries's avatar
   
Dries committed
833
834
835
836
837
838
/**
 * 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
839
function format_size($size) {
Dries's avatar
   
Dries committed
840
  $suffix = t("bytes");
Dries's avatar
   
Dries committed
841
842
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
843
    $suffix = t("KB");
Dries's avatar
   
Dries committed
844
845
846
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries's avatar
   
Dries committed
847
    $suffix = t("MB");
Dries's avatar
   
Dries committed
848
  }
Dries's avatar
   
Dries committed
849
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries's avatar
   
Dries committed
850
851
}

Dries's avatar
   
Dries committed
852
853
854
855
856
857
858
/**
 * 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
859
function format_interval($timestamp, $granularity = 2) {
Dries's avatar
   
Dries committed
860
  $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
861
  $output = '';
Dries's avatar
   
Dries committed
862
  foreach ($units as $key => $value) {
Dries's avatar
   
Dries committed
863
864
865
866
    $key = explode("|", $key);
    if ($timestamp >= $value) {
      $output .= ($output ? " " : "") . format_plural(floor($timestamp / $value), $key[0], $key[1]);
      $timestamp %= $value;
Dries's avatar
   
Dries committed
867
868
869
870
871
      $granularity--;
    }

    if ($granularity == 0) {
      break;
Dries's avatar
   
Dries committed
872
873
    }
  }
Dries's avatar
   
Dries committed
874
  return $output ? $output : t("0 sec");
Dries's avatar
   
Dries committed
875
876
}

Dries's avatar
   
Dries committed
877
878
879
880
881
882
883
884
885
886
887
888
/**
 * 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.
889
890
 * @param $timezone Timezone offset in seconds in case the user timezone
 *   should not be used.
Dries's avatar
   
Dries committed
891
892
 * @return Translated date string in the requested format
 */
893
894
895
896
897
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
898

899
  $timestamp += $timezone;
Dries's avatar
   
Dries committed
900
901

  switch ($type) {
902
903
    case 'small':
      $format = variable_get('date_format_short', 'm/d/Y - H:i');
Dries's avatar
   
Dries committed
904
      break;
905
906
    case 'large':
      $format = variable_get('date_format_long', 'l, F j, Y - H:i');
Dries's avatar
   
Dries committed
907
      break;
908
    case 'custom':
Dries's avatar
   
Dries committed
909
      // No change to format
Dries's avatar
   
Dries committed
910
      break;
911
    case 'medium':
Dries's avatar
   
Dries committed
912
    default:
913
      $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
Dries's avatar
   
Dries committed
914
915
  }

916
  $max = strlen($format);
Dries's avatar
   
Dries committed
917
  $date = '';
918
919
  for ($i = 0; $i <= $max; $c = $format{$i++}) {
    if (strpos('AaDFlM', $c)) {
920
      $date .= t(gmdate($c, $timestamp));
921
922
923
924
925
926
    }
    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
927
    }
928
929
930
931
932
    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
933
934
    }
    else {
935
      $date .= $c;
Dries's avatar
   
Dries committed
936
    }
Dries's avatar
   
Dries committed
937
  }
938

Dries's avatar
   
Dries committed
939
940
941
  return $date;
}

Dries's avatar
   
Dries committed
942
943
944
945
946
947
948
949
/**
 * 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
950
951
952
function format_name($object) {

  if ($object->uid && $object->name) {
Dries's avatar
Dries committed
953
954
955
956
957
958
    /*
    ** Shorten the name when it is too long or it will break many
    ** tables.
    */

    if (strlen($object->name) > 20) {
959
      $name = truncate_utf8($object->name, 15) ."...";
Dries's avatar
Dries committed
960
961
962
963
964
    }
    else {
      $name = $object->name;
    }

Dries's avatar
   
Dries committed
965
    if (arg(0) == "admin" and user_access("administer users")) {
Dries's avatar
Dries committed
966
      $output = l($name, "admin/user/edit/$object->uid", array("title" => t("Administer user profile.")));
Dries's avatar
   
Dries committed
967
968
    }
    else {
Dries's avatar
Dries committed
969
      $output = l($name, "user/view/$object->uid", array("title" => t("View user profile.")));
Dries's avatar
   
Dries committed
970
    }
Dries's avatar
   
Dries committed
971
  }
Dries's avatar
   
Dries committed
972
973
974
975
976
977
978
979
980
981
  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
982
  else {
Dries's avatar
   
Dries committed
983
    $output = t(variable_get("anonymous", "Anonymous"));
Dries's avatar
   
Dries committed
984
985
  }

Dries's avatar
   
Dries committed
986
  return $output;
Dries's avatar
   
Dries committed
987
}
Dries's avatar
   
Dries committed
988
/* @} */
Dries's avatar
   
Dries committed
989

Kjartan's avatar
Kjartan committed
990
991
992
993
/**
 * @defgroup from Form generation
 * @{
 */
994
function form($form, $method = "post", $action = NULL, $attributes = NULL) {
Dries's avatar
   
Dries committed
995
  if (!$action) {
996
    $action = request_uri();
Dries's avatar
   
Dries committed
997
  }
998
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($attributes) .">\n$form\n</form>\n";
Dries's avatar
   
Dries committed
999
1000
}

1001
1002
function form_item($title, $value, $description = NULL, $id = NULL, $required = FALSE) {
  return theme("form_element", $title, $value, $description, $id, $required);
Dries's avatar
   
Dries committed
1003
}
Dries's avatar
   
Dries committed
1004

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

1009
function form_radio($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL, $required = FALSE) {
1010
1011
1012
1013
  $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>";
  }
1014
  return theme('form_element', NULL, $element, $description, $required);
Dries's avatar
   
Dries committed
1015
1016
}

1017
function form_radios($title, $name, $value, $options, $description = NULL, $required = FALSE) {
Dries's avatar
   
Dries committed
1018
  if (count($options) > 0) {
Dries's avatar
   
Dries committed
1019
    $choices = '';
Dries's avatar
   
Dries committed
1020
    foreach ($options as $key => $choice) {
1021
      $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
1022
    }
1023
    return theme('form_element', $title, $choices, $description, $required);
Dries's avatar
   
Dries committed
1024
  }
Dries's avatar
   
Dries committed
1025
1026
}

1027
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL, $required = FALSE) {
1028
1029
1030
1031
  $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>";
  }
1032
  return form_hidden($name, 0) . theme('form_element', NULL, $element, $description, $required);
Dries's avatar
   
Dries committed
1033
1034
}

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

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

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

1051
function form_select($title, $name, $value, $options, $description = NULL, $extra = 0, $multiple = 0, $required = FALSE) {
Dries's avatar
   
Dries committed
1052
  $select = '';
Dries's avatar
   
Dries committed
1053
1054
  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
1055
  }
1056
  return theme("form_element", $title, "<select name=\"edit[$name]". ($multiple ? "[]" : "") ."\"". ($multiple ? " multiple=\"multiple\" " : "") . ($extra ? " $extra" : "") ." id=\"$name\">$select</select>", $description, $name, $required);
Dries's avatar
   
Dries committed
1057
1058
}

1059
1060
function form_file($title, $name, $size, $description = NULL, $required = FALSE) {
  return theme("form_element", $title, "<input type=\"file\" class=\"form-file\" name=\"edit[$name]\" id=\"$name\" size=\"$size\" />\n", $description, $name, $required);
Dries's avatar
   
Dries committed
1061
1062
1063
1064
1065
1066
}

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

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

Dries's avatar
   
Dries committed
1071
function form_submit($value, $name = "op", $attributes = NULL) {
Dries's avatar
   
Dries committed
1072
  return form_button($value, $name, "submit", $attributes);
Dries's avatar
   
Dries committed
1073
1074
}

Dries's avatar
   
Dries committed
1075
function form_weight($title = NULL, $name = "weight", $value = 0, $delta = 10, $description = NULL, $extra = 0) {
Dries's avatar
   
Dries committed
1076
  for ($n = (-1 * $delta); $n <= $delta; $n++) {
Dries's avatar
   
Dries committed
1077
1078
1079
1080
1081
    $weights[$n] = $n;
  }

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

Dries's avatar
Dries committed
1084
function url($url = NULL, $query = NULL, $fragment = NULL, $absolute = NULL) {
Dries's avatar
   
Dries committed
1085
  global $base_url;
Dries's avatar
   
Dries committed
1086

Dries's avatar
   
Dries committed
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
  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
1098
  if ($alias = drupal_get_path_alias($url)) {
Dries's avatar
   
Dries committed
1099
1100
1101
    $url = $alias;
  }

Dries's avatar
   
Dries committed
1102
1103
1104
1105
  if (isset($fragment)) {
    $fragment = "#$fragment";
  }

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

Dries's avatar
   
Dries committed
1108
  if (variable_get("clean_url", "0") == "0") {
Dries's avatar
   
Dries committed
1109
1110
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
Dries committed
1111
        return "$base$script?q=$url&amp;$query$fragment";
Dries's avatar
   
Dries committed
1112
1113
      }
      else {
Dries's avatar
Dries committed
1114
        return "$base$script?q=$url$fragment";
Dries's avatar
   
Dries committed
1115
      }
Dries's avatar
   
Dries committed
1116
1117
    }
    else {
Dries's avatar
   
Dries committed
1118
      if (isset($query)) {
Dries's avatar
Dries committed
1119
        return "$base$script?$query$fragment";
Dries's avatar
   
Dries committed
1120
1121
      }
      else {
Dries's avatar
Dries committed
1122
        return "$base$fragment";
Dries's avatar
   
Dries committed
1123
      }
Dries's avatar
   
Dries committed
1124
1125
1126
    }
  }
  else {
Dries's avatar
   
Dries committed
1127
1128
    if (isset($url)) {
      if (isset($query)) {
Dries's avatar
Dries committed
1129
        return "$base$url?$query$fragment";
Dries's avatar
   
Dries committed
1130
1131
      }
      else {
Dries's avatar
Dries committed
1132
        return "$base$url$fragment";
Dries's avatar
   
Dries committed
1133
      }
Dries's avatar
   
Dries committed
1134
    }
Dries's avatar
   
Dries committed
1135
    else {
Dries's avatar
   
Dries committed
1136
      if (isset($query)) {
Dries's avatar
Dries committed
1137
        return "$base$script?$query$fragment";
Dries's avatar
   
Dries committed
1138
1139
      }
      else {
Dries's avatar
Dries committed
1140
        return "$base$fragment";
Dries's avatar
   
Dries committed
1141
      }
Dries's avatar
   
Dries committed
1142
    }
Dries's avatar
   
Dries committed
1143
  }
Dries's avatar
   
Dries committed
1144
1145
}

1146
1147
function drupal_attributes($attributes = array()) {
  if (count($attributes)) {
1148
1149
1150
1151
    $t = array();
    foreach ($attributes as $key => $value) {
      $t[] = "$key=\"$value\"";
    }
1152

1153
    return " ". implode($t, " ");
Dries's avatar
   
Dries committed
1154
  }
1155
}
Dries's avatar
   
Dries committed
1156

Dries's avatar
Dries committed
1157
function l($text, $url, $attributes = array(), $query = NULL, $fragment = NULL, $absolute = NULL) {
Dries's avatar
   
Dries committed
1158
1159
1160
1161
1162
1163
1164
1165
  if ($url == $_GET['q']) {
    if (isset($attributes['class'])) {
      $attributes['class'] .= ' active';
    }
    else {
      $attributes['class'] = 'active';
    }
  }
Dries's avatar
Dries committed
1166
  return "<a href=\"". url($url, $query, $fragment, $absolute) ."\"". drupal_attributes($attributes) .">$text</a>";
Dries's avatar
   
Dries committed
1167
1168
}

Dries's avatar
   
Dries committed
1169
function field_get($string, $name) {
Dries's avatar
   
Dries committed
1170
  ereg(",$name=([^,]+)", ",$string", $regs);
Dries's avatar
   
Dries committed
1171
1172
1173
1174
1175
  return $regs[1];
}

function field_set($string, $name, $value) {
  $rval = ereg_replace(",$name=[^,]+", "", ",$string");
Dries's avatar
   
Dries committed
1176
  if (isset($value)) {
Kjartan's avatar
Kjartan committed
1177
1178
    $rval .= ($rval == "," ? "" : ",") ."$name=$value";
  }
Dries's avatar
   
Dries committed
1179
1180
1181
1182
  return substr($rval, 1);
}

function link_page() {
1183
  global $custom_links;
Dries's avatar
   
Dries committed
1184