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

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

/**
 * @name Page title
 * @ingroup common
Dries Buytaert's avatar
   
Dries Buytaert committed
11
12
13
14
 *
 * Functions to get and set the title of the current page.
 * @{
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
15
16
17
18
function drupal_set_title($title = NULL) {
  static $stored_title;

  if (isset($title)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
19
    $stored_title = ucfirst($title);
Dries Buytaert's avatar
   
Dries Buytaert 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;
}
33
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
34

Dries Buytaert's avatar
   
Dries Buytaert committed
35
/**
36
37
 * @name Page messages
 * @ingroup common
Dries Buytaert's avatar
   
Dries Buytaert committed
38
39
40
41
 *
 * Functions to get and set the message of the current page.
 * @{
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
42
function drupal_set_message($message = NULL, $type = "status") {
Dries Buytaert's avatar
   
Dries Buytaert committed
43
  static $stored_message = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
44
45

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

  return $stored_message;
}

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

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

/**
 * @param $breadcrumb Array of links, starting with "home" and proceeding up
 *   to but not including the current page.
 */
Dries Buytaert's avatar
   
Dries Buytaert 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;
}
88
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
89

Dries Buytaert's avatar
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
110
  $output = "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
Dries Buytaert's avatar
Dries Buytaert committed
111
  $output .= "<base href=\"$base_url/\" />\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
112
  $output .= "<style type=\"text/css\" media=\"all\">\n";
Dries Buytaert's avatar
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
120
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
121
 * @name URL path alias
122
123
 * @ingroup common
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
124
 * Functions to handle path aliases.
Dries Buytaert's avatar
   
Dries Buytaert committed
125
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
126
function drupal_get_path_map($action = "") {
Dries Buytaert's avatar
Dries Buytaert committed
127
  static $map = NULL;
Dries Buytaert's avatar
   
Dries Buytaert committed
128

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

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

  return $map;
}

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

/**
Dries Buytaert's avatar
   
Dries Buytaert committed
149
 * Given an old url, return the alias.
150
 */
Dries Buytaert's avatar
   
Dries Buytaert 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;
  }
}
/* @} */
175

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

206
207
208
209
210
211
212
213
214
215
216
217
218
/**
 * HTTP redirects. Makes sure the redirected url is formatted correctly and
 * includes the session ID.
 *
 * @note This function ends the request.
 *
 * @param $url A string containing a fully qualified URI.
 */
function drupal_goto($url) {

  /*
  ** Translate &amp; to simply &
  */
Dries Buytaert's avatar
   
Dries Buytaert committed
219

220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
  $url = str_replace("&amp;", "&", $url);

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

  $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 {
    print theme("page", '<h1>'. t('Page not found') .'</h1>');
  }
}
Dries Buytaert's avatar
   
Dries Buytaert committed
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313

/**
 * 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(
314
315
316
    'Host' => "Host: $uri[host]",
    'User-Agent' => 'User-Agent: Drupal (+http://www.drupal.org/)',
    'Content-Length' => 'Content-Length: '. strlen($data)
Dries Buytaert's avatar
   
Dries Buytaert committed
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
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
  );

  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.
  while (!feof($fp) && $data = fgets($fp)) {
    $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;
}
391
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
392

Dries Buytaert's avatar
   
Dries Buytaert committed
393
394
395
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 Buytaert's avatar
   
Dries Buytaert committed
396
397

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

function throttle($type, $rate) {
  if (!user_access("access administration pages")) {
407
408
    if ($throttle = db_fetch_object(db_query("SELECT * FROM {watchdog} WHERE type = '%s' AND hostname = '%s' AND %d - timestamp < %d", $type, $_SERVER['REMOTE_ADDR'], time(), $rate))) {
      watchdog("warning", "throttle: '". $_SERVER['REMOTE_ADDR'] ."' exceeded submission rate - $throttle->type");
Dries Buytaert's avatar
   
Dries Buytaert committed
409
410
411
412
413
      die(message_throttle());
    }
  }
}

Dries Buytaert's avatar
Dries Buytaert committed
414
415
function _fix_gpc_magic(&$item, $key) {
  if (is_array($item)) {
Kjartan Mannes's avatar
Kjartan Mannes committed
416
417
418
    array_walk($item, '_fix_gpc_magic');
  }
  else {
Kjartan Mannes's avatar
Kjartan Mannes committed
419
    $item = stripslashes($item);
Dries Buytaert's avatar
   
Dries Buytaert committed
420
421
422
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
423
424
function fix_gpc_magic() {
  static $fixed = false;
Kjartan Mannes's avatar
Kjartan Mannes committed
425
  if (!$fixed && ini_get("magic_quotes_gpc")) {
Dries Buytaert's avatar
Dries Buytaert committed
426
427
428
429
430
431
    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 Buytaert's avatar
   
Dries Buytaert committed
432
433
}

434
435
436
437
438
439
440
/**
 * @name Conversion
 * @ingroup common
 *
 * Converts data structures to a different type.
 * @{
 */
Dries Buytaert's avatar
Dries Buytaert committed
441
442
443
function array2object($array) {
  if (is_array($array)) {
    foreach ($array as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
444
445
446
447
      $object->$key = $value;
    }
  }
  else {
Dries Buytaert's avatar
Dries Buytaert committed
448
    $object = $array;
Dries Buytaert's avatar
   
Dries Buytaert committed
449
450
451
452
453
  }

  return $object;
}

Dries Buytaert's avatar
Dries Buytaert committed
454
455
456
function object2array($object) {
  if (is_object($object)) {
    foreach ($object as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
457
458
459
460
      $array[$key] = $value;
    }
  }
  else {
Dries Buytaert's avatar
Dries Buytaert committed
461
    $array = $object;
Dries Buytaert's avatar
   
Dries Buytaert committed
462
463
464
465
  }

  return $array;
}
466
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
467

468
469
470
471
472
473
474
/**
 * @name Messages
 * @ingroup common
 *
 * Frequently used messages.
 * @{
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
475
function message_access() {
Dries Buytaert's avatar
   
Dries Buytaert committed
476
  return t("You are not authorized to access this page.");
Dries Buytaert's avatar
   
Dries Buytaert committed
477
478
479
480
481
482
483
484
485
}

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

function message_throttle() {
  return t("You exceeded the maximum submission rate.  Please wait a few minutes and try again.");
}
486
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
487

Dries Buytaert's avatar
   
Dries Buytaert committed
488
489
function locale_init() {
  global $languages, $user;
Dries Buytaert's avatar
   
Dries Buytaert committed
490
491
492
493
494
495
  if ($user->uid && $languages[$user->language]) {
    return $user->language;
  }
  else {
    return key($languages);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
496
497
}

498
499
500
501
502
/**
 * @ingroup common
 *
 * Translates strings to the current locale.
 *
503
504
505
506
 * 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:
507
508
509
510
511
 * @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
512
513
514
 * 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.
515
516
517
518
519
 *
 * @param $string A string containing the english string to translate.
 * @param $args Array of values to replace in the string.
 * @return Translated string.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
520
function t($string, $args = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
521
  global $languages;
522

523
  $string = ($languages && module_exist("locale") ? locale($string) : $string);
524

Dries Buytaert's avatar
   
Dries Buytaert committed
525
526
  if (!$args) {
    return $string;
Kjartan Mannes's avatar
Kjartan Mannes committed
527
528
  }
  else {
Dries Buytaert's avatar
   
Dries Buytaert committed
529
530
    return strtr($string, $args);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
531
532
}

Dries Buytaert's avatar
   
Dries Buytaert committed
533
function drupal_specialchars($input, $quotes = ENT_NOQUOTES) {
Dries Buytaert's avatar
   
Dries Buytaert committed
534
535
536
537
538
539
540
541
542

  /*
  ** 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 Buytaert's avatar
   
Dries Buytaert committed
543
544
}

545
546
547
548
549
/**
 * @name Validation
 * @ingroup common
 *
 * Functions to validate user input.
Dries Buytaert's avatar
   
Dries Buytaert committed
550
 * @{
551
552
 */

553
/**
Dries Buytaert's avatar
   
Dries Buytaert committed
554
555
 * Verify the syntax of the given e-mail address. Empty e-mail addresses are
 * allowed. See RFC 2822 for details.
556
 *
557
 * @param $mail A string containing an email address.
Dries Buytaert's avatar
   
Dries Buytaert committed
558
 * @return
559
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
560
function valid_email_address($mail) {
561
562
563
564
565
  $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 Buytaert's avatar
Dries Buytaert committed
566
  return preg_match("/^$user@($domain|(\[($ipv4|$ipv6)\]))$/", $mail);
567
568
}

Dries Buytaert's avatar
   
Dries Buytaert committed
569
570
571
/**
 * Verify the syntax of the given URL.
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
572
 * @param $url an URL
Dries Buytaert's avatar
   
Dries Buytaert committed
573
574
 */
function valid_url($url) {
Dries Buytaert's avatar
Dries Buytaert committed
575
  return preg_match("/^[a-zA-z0-9\/:_\-_\.,]+$/", $url);
Dries Buytaert's avatar
   
Dries Buytaert committed
576
577
}

578
579
580
581
582
583
584
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 Buytaert's avatar
   
Dries Buytaert committed
585
      if (!valid_input_data($key) || !valid_input_data($value)) {
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
615
616
617
618
619
        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 Mannes's avatar
Kjartan Mannes committed
620
621
622
/**
 * Format a single result entry of a search query:
 *
Dries Buytaert's avatar
   
Dries Buytaert committed
623
 * @param $item a single search result as returned by <i>module</i>_search of
624
 *   type array("count" => ..., "link" => ..., "title" => ..., "user" => ...,
Dries Buytaert's avatar
   
Dries Buytaert committed
625
626
 *   "date" => ..., "keywords" => ...)
 * @param $type module type of this item
Kjartan Mannes's avatar
Kjartan Mannes committed
627
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
628
function search_item($item, $type) {
Dries Buytaert's avatar
   
Dries Buytaert committed
629
630
631
632
633
634
635
636
637
638

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

  return $output;
}

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

Dries Buytaert's avatar
   
Dries Buytaert committed
663
  if (!$action) {
Dries Buytaert's avatar
   
Dries Buytaert committed
664
    $action = url("search");
Dries Buytaert's avatar
   
Dries Buytaert committed
665
666
  }

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

Dries Buytaert's avatar
Dries Buytaert committed
670
  if ($options) {
Dries Buytaert's avatar
   
Dries Buytaert committed
671
672
673
674
675
    $output .= "<br />";
    $output .= t("Restrict search to") .": ";

    foreach (module_list() as $name) {
      if (module_hook($name, "search")) {
Kjartan Mannes's avatar
Kjartan Mannes committed
676
        $output .= " <input type=\"checkbox\" name=\"edit[type][$name]\" ". ($edit["type"][$name] ? " checked=\"checked\"" : "") ." /> ". t($name);
Dries Buytaert's avatar
   
Dries Buytaert committed
677
678
679
680
      }
    }
  }

Kjartan Mannes's avatar
Kjartan Mannes committed
681
682
  $form .= "<br />";

Dries Buytaert's avatar
   
Dries Buytaert committed
683
684
685
686
  return form($output, "post", $action);
}

/*
Kjartan Mannes's avatar
Kjartan Mannes committed
687
688
 * Collect the search results:
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
689
function search_data($keys = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
690
  $edit = $_POST["edit"];
Dries Buytaert's avatar
   
Dries Buytaert committed
691

Dries Buytaert's avatar
   
Dries Buytaert committed
692
  if (isset($keys)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
693
    foreach (module_list() as $name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
694
695
696
697
698
699
700
      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 Buytaert's avatar
   
Dries Buytaert committed
701
702
703
704
705
706
707
708
        }
      }
    }
  }

  return $output;
}

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

Dries Buytaert's avatar
   
Dries Buytaert committed
722
  return search_form($action, $keys, $options) . "<br />". search_data($keys);
Dries Buytaert's avatar
   
Dries Buytaert committed
723
}
724
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
725

Dries Buytaert's avatar
   
Dries Buytaert committed
726
function check_form($text) {
Dries Buytaert's avatar
   
Dries Buytaert committed
727
  return drupal_specialchars($text, ENT_QUOTES);
Dries Buytaert's avatar
   
Dries Buytaert committed
728
729
}

730
731
function check_file($filename) {
  return is_uploaded_file($filename);
Dries Buytaert's avatar
   
Dries Buytaert committed
732
733
}

Dries Buytaert's avatar
   
Dries Buytaert committed
734
735
736
737
738
739
740
741
/**
 * @name Formatting
 * @ingroup common
 *
 * Functions to format numbers, strings, dates, etc.
 * @{
 */

Dries Buytaert's avatar
   
Dries Buytaert committed
742
743
744
function format_rss_channel($title, $link, $description, $items, $language = "en", $args = array()) {
  // arbitrary elements may be added using the $args associative array

Dries Buytaert's avatar
Dries Buytaert committed
745
  $output = "<channel>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
746
747
748
749
  $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 Buytaert's avatar
   
Dries Buytaert committed
750
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
751
    $output .= " <$key>". drupal_specialchars(strip_tags($value)) ."</$key>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
752
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
753
754
755
756
757
758
  $output .= $items;
  $output .= "</channel>\n";

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
759
760
761
function format_rss_item($title, $link, $description, $args = array()) {
  // arbitrary elements may be added using the $args associative array

Dries Buytaert's avatar
Dries Buytaert committed
762
  $output = "<item>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
763
764
765
  $output .= " <title>". drupal_specialchars(strip_tags($title)) ."</title>\n";
  $output .= " <link>". drupal_specialchars(strip_tags($link)) ."</link>\n";
  $output .= " <description>". drupal_specialchars(check_output($description)) ."</description>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
766
  foreach ($args as $key => $value) {
Dries Buytaert's avatar
   
Dries Buytaert committed
767
    $output .= "<$key>". drupal_specialchars(strip_tags($value)) ."</$key>";
Dries Buytaert's avatar
   
Dries Buytaert committed
768
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
769
770
771
772
773
  $output .= "</item>\n";

  return $output;
}

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

Dries Buytaert's avatar
   
Dries Buytaert committed
792
793
794
795
796
797
/**
 * Generates a string representation for the given byte count.
 *
 * @param $size The size in bytes
 * @return Translated string representation of the size
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
798
function format_size($size) {
Dries Buytaert's avatar
   
Dries Buytaert committed
799
  $suffix = t("bytes");
Dries Buytaert's avatar
   
Dries Buytaert committed
800
801
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
802
    $suffix = t("KB");
Dries Buytaert's avatar
   
Dries Buytaert committed
803
804
805
  }
  if ($size > 1024) {
    $size = round($size / 1024, 2);
Dries Buytaert's avatar
   
Dries Buytaert committed
806
    $suffix = t("MB");
Dries Buytaert's avatar
   
Dries Buytaert committed
807
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
808
  return t("%size %suffix", array("%size" => $size, "%suffix" => $suffix));
Dries Buytaert's avatar
   
Dries Buytaert committed
809
810
}

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

    if ($granularity == 0) {
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
830
831
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
832
  return ($output) ? $output : t("0 sec");
Dries Buytaert's avatar
   
Dries Buytaert committed
833
834
}

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

857
  $timestamp += $timezone;
Dries Buytaert's avatar
   
Dries Buytaert committed
858
859

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

874
875
876
877
878
879
880
881
882
883
  $max = strlen($format);
  for ($i = 0; $i <= $max; $c = $format{$i++}) {
    if (strpos('AaDFlM', $c)) {
      $date .= gmdate($c, $timestamp);
    }
    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 Buytaert's avatar
   
Dries Buytaert committed
884
    }
885
886
887
888
889
    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 Buytaert's avatar
   
Dries Buytaert committed
890
891
    }
    else {
892
      $date .= $c;
Dries Buytaert's avatar
   
Dries Buytaert committed
893
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
894
  }
895

Dries Buytaert's avatar
   
Dries Buytaert committed
896
897
898
  return $date;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
899
900
901
902
903
904
905
906
/**
 * 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 Buytaert's avatar
   
Dries Buytaert committed
907
908
909
function format_name($object) {

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

Dries Buytaert's avatar
   
Dries Buytaert committed
943
  return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
944
}
Dries Buytaert's avatar
   
Dries Buytaert committed
945
/* @} */
Dries Buytaert's avatar
   
Dries Buytaert committed
946

947
948
949
950
/**
 * @defgroup from Form generation
 * @{
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
951
function form($form, $method = "post", $action = 0, $options = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
952
  if (!$action) {
953
    $action = request_uri();
Dries Buytaert's avatar
   
Dries Buytaert committed
954
  }
955
  return "<form action=\"$action\" method=\"$method\"". drupal_attributes($options) .">\n$form\n</form>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
956
957
}

Dries Buytaert's avatar
   
Dries Buytaert committed
958
959
function form_item($title, $value, $description = NULL, $id = NULL) {
  return theme("form_element", $title, $value, $description, $id);
Dries Buytaert's avatar
   
Dries Buytaert committed
960
}
Dries Buytaert's avatar
   
Dries Buytaert committed
961

Dries Buytaert's avatar
   
Dries Buytaert committed
962
function form_group($legend, $group, $description = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
963
964
  return "<fieldset>" . ($legend ? "<legend>$legend</legend>" : "") . $group . ($description ? "<div class=\"description\">$description</div>" : "") . "</fieldset>\n";
}
Dries Buytaert's avatar
   
Dries Buytaert committed
965

Dries Buytaert's avatar
   
Dries Buytaert committed
966
function form_radio($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
967
  return theme("form_element", NULL, "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"$value\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) ." /> $title", $description);
Dries Buytaert's avatar
   
Dries Buytaert committed
968
969
970
971
972
}

function form_radios($title, $name, $value, $options, $description = NULL) {
  if (count($options) > 0) {
    foreach ($options as $key => $choice) {
Dries Buytaert's avatar
   
Dries Buytaert committed
973
      $choices .= "<input type=\"radio\" class=\"form-radio\" name=\"edit[$name]\" value=\"$key\"". ($key == $value ? " checked=\"checked\"" : "") ." /> $choice<br />";
Dries Buytaert's avatar
   
Dries Buytaert committed
974
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
975
    return theme("form_element", $title, $choices, $description);
Dries Buytaert's avatar
   
Dries Buytaert committed
976
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
977
978
}

Dries Buytaert's avatar
   
Dries Buytaert committed
979
function form_checkbox($title, $name, $value = 1, $checked = 0, $description = NULL, $attributes = NULL) {
Dries Buytaert's avatar
   
Dries Buytaert committed
980
  return form_hidden($name, 0) . theme("form_element", NULL, "<input type=\"checkbox\" class=\"form-checkbox\" name=\"edit[$name]\" value=\"". $value ."\"". ($checked ? " checked=\"checked\"" : "") . drupal_attributes($attributes) ." /> $title", $description);
Dries Buytaert's avatar
   
Dries Buytaert committed
981
982
}

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

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
999
function form_select($title, $name, $value, $options, $description = NULL, $extra = 0, $multiple = 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
1000
  foreach ($options as $key => $choice) {
For faster browsing, not all history is shown. View entire blame