form.inc 49.4 KB
Newer Older
1
<?php
2 3
// $Id$

4 5 6
/**
 * @defgroup form Form generation
 * @{
7
 * Functions to enable the processing and display of HTML forms.
8
 *
9 10 11 12 13 14 15 16 17 18 19
 * Drupal uses these functions to achieve consistency in its form processing and
 * presentation, while simplifying code and reducing the amount of HTML that
 * must be explicitly generated by modules.
 *
 * The drupal_get_form() function handles retrieving, processing, and
 * displaying a rendered HTML form for modules automatically. For example:
 *
 * // display the user registration form
 * $output = drupal_get_form('user_register');
 *
 * Forms can also be built and submitted programmatically without any user input
20
 * using the drupal_execute() function.
21 22 23 24
 *
 *
 * For information on the format of the structured arrays used to define forms,
 * and more detailed explanations of the Form API workflow, see the reference at
25
 * http://api.drupal.org/api/HEAD/file/developer/topics/forms_api_reference.html
26
 * and the quickstart guide at
27
 * http://api.drupal.org/api/HEAD/file/developer/topics/forms_api.html
28 29 30
 */

/**
31 32
 * Retrieves a form from a builder function, passes it on for
 * processing, and renders the form or redirects to its destination
33
 * as appropriate. In multi-step form scenarios, it handles properly
34 35
 * processing the values using the previous step's form definition,
 * then rendering the requested step for display.
36 37
 *
 * @param $form_id
38 39 40 41 42 43 44 45 46 47 48 49
 *   The unique string identifying the desired form. If a function
 *   with that name exists, it is called to build the form array.
 *   Modules that need to generate the same form (or very similar forms)
 *   using different $form_ids can implement hook_forms(), which maps
 *   different $form_id values to the proper form building function. Examples
 *   may be found in node_forms(), search_forms(), and user_forms().
 * @param ...
 *   Any additional arguments needed by the form building function.
 * @return
 *   The rendered form.
 */
function drupal_get_form($form_id) {
50
  // In multi-step form scenarios, the incoming $_POST values are not
51 52 53 54 55
  // necessarily intended for the current form. We need to build
  // a copy of the previously built form for validation and processing,
  // then go on to the one that was requested if everything works.

  $form_build_id = md5(mt_rand());
56
  if (isset($_POST['form_build_id']) && isset($_SESSION['form'][$_POST['form_build_id']]) && $_POST['form_id'] == $form_id) {
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
    // There's a previously stored multi-step form. We should handle
    // IT first.
    $stored = TRUE;
    $args = $_SESSION['form'][$_POST['form_build_id']];
    $form = call_user_func_array('drupal_retrieve_form', $args);
  }
  else {
    // We're coming in fresh; build things as they would be. If the
    // form's #multistep flag is set, store the build parameters so
    // the same form can be reconstituted for validation.
    $args = func_get_args();
    $form = call_user_func_array('drupal_retrieve_form', $args);
    if (isset($form['#multistep']) && $form['#multistep']) {
      $_SESSION['form'][$form_build_id] = $args;
      $form['#build_id'] = $form_build_id;
    }
    $stored = FALSE;
  }

  // Process the form, submit it, and store any errors if necessary.
  drupal_process_form($args[0], $form);

  if ($stored && !form_get_errors()) {
    // If it's a stored form and there were no errors, we processed the
    // stored form successfully. Now we need to build the form that was
    // actually requested. We always pass in the current $_POST values
    // to the builder function, as values from one stage of a multistep
    // form can determine how subsequent steps are displayed.
    $args = func_get_args();
86
    $args[] = $_POST;
87 88 89 90 91 92
    $form = call_user_func_array('drupal_retrieve_form', $args);
    unset($_SESSION['form'][$_POST['form_build_id']]);
    if (isset($form['#multistep']) && $form['#multistep']) {
      $_SESSION['form'][$form_build_id] = $args;
      $form['#build_id'] = $form_build_id;
    }
93
    drupal_prepare_form($args[0], $form);
94 95 96
  }

  return drupal_render_form($args[0], $form);
97 98
}

99

100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
/**
 * Retrieves a form using a form_id, populates it with $form_values,
 * processes it, and returns any validation errors encountered. This
 * function is the programmatic counterpart to drupal_get_form().
 *
 * @param $form_id
 *   The unique string identifying the desired form. If a function
 *   with that name exists, it is called to build the form array.
 *   Modules that need to generate the same form (or very similar forms)
 *   using different $form_ids can implement hook_forms(), which maps
 *   different $form_id values to the proper form building function. Examples
 *   may be found in node_forms(), search_forms(), and user_forms().
 * @param $form_values
 *   An array of values mirroring the values returned by a given form
 *   when it is submitted by a user.
 * @param ...
 *   Any additional arguments needed by the form building function.
 * @return
 *   Any form validation errors encountered.
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
 *
 * For example:
 *
 * // register a new user
 * $values['name'] = 'robo-user';
 * $values['mail'] = 'robouser@example.com';
 * $values['pass'] = 'password';
 * drupal_execute('user_register', $values);
 *
 * // Create a new node
 * $node = array('type' => 'story');
 * $values['title'] = 'My node';
 * $values['body'] = 'This is the body text!';
 * $values['name'] = 'robo-user';
 * drupal_execute('story_node_form', $values, $node);
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
 */
function drupal_execute($form_id, $form_values) {
  $args = func_get_args();

  $form_id = array_shift($args);
  $form_values = array_shift($args);
  array_unshift($args, $form_id);

  if (isset($form_values)) {
    $form = call_user_func_array('drupal_retrieve_form', $args);
    $form['#post'] = $form_values;
    return drupal_process_form($form_id, $form);
  }
}

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
/**
 * Retrieves the structured array that defines a given form.
 *
 * @param $form_id
 *   The unique string identifying the desired form. If a function
 *   with that name exists, it is called to build the form array.
 *   Modules that need to generate the same form (or very similar forms)
 *   using different $form_ids can implement hook_forms(), which maps
 *   different $form_id values to the proper form building function.
 * @param ...
 *   Any additional arguments needed by the form building function.
 */
function drupal_retrieve_form($form_id) {
  static $forms;

164 165 166 167 168
  // We save two copies of the incoming arguments: one for modules to use
  // when mapping form ids to builder functions, and another to pass to
  // the builder function itself. We shift out the first argument -- the
  // $form_id itself -- from the list to pass into the builder function,
  // since it's already known.
169
  $args = func_get_args();
170
  $saved_args = $args;
171
  array_shift($args);
172 173 174

  // We first check to see if there's a function named after the $form_id.
  // If there is, we simply pass the arguments on to it to get the form.
175
  if (!function_exists($form_id)) {
176 177 178 179 180 181 182 183 184 185 186 187 188
    // In cases where many form_ids need to share a central builder function,
    // such as the node editing form, modules can implement hook_forms(). It
    // maps one or more form_ids to the correct builder functions.
    //
    // We cache the results of that hook to save time, but that only works
    // for modules that know all their form_ids in advance. (A module that
    // adds a small 'rate this comment' form to each comment in a list
    // would need a unique form_id for each one, for example.)
    //
    // So, we call the hook if $forms isn't yet populated, OR if it doesn't
    // yet have an entry for the requested form_id.
    if (!isset($forms) || !isset($forms[$form_id])) {
      $forms = module_invoke_all('forms', $saved_args);
189 190 191 192 193 194 195 196 197
    }
    $form_definition = $forms[$form_id];
    if (isset($form_definition['callback arguments'])) {
      $args = array_merge($form_definition['callback arguments'], $args);
    }
    if (isset($form_definition['callback'])) {
      $callback = $form_definition['callback'];
    }
  }
198 199
  // If $callback was returned by a hook_forms() implementation, call it.
  // Otherwise, call the function named after the form id.
200 201 202 203 204 205
  $form = call_user_func_array(isset($callback) ? $callback : $form_id, $args);

  // We store the original function arguments, rather than the final $arg
  // value, so that form_alter functions can see what was originally
  // passed to drupal_retrieve_form(). This allows the contents of #parameters
  // to be saved and passed in at a later date to recreate the form.
206
  $form['#parameters'] = $saved_args;
207
  return $form;
208 209 210 211 212 213 214 215
}

/**
 * This function is the heart of form API. The form gets built, validated and in
 * appropriate cases, submitted.
 *
 * @param $form_id
 *   The unique string identifying the current form.
216 217
 * @param $form
 *   An associative array containing the structure of the form.
218 219
 * @return
 *   The path to redirect the user to upon completion.
220
 */
221
function drupal_process_form($form_id, &$form) {
222
  global $form_values, $form_submitted, $user, $form_button_counter;
223
  static $saved_globals = array();
224
  // In some scenarios, this function can be called recursively. Pushing any pre-existing
225 226
  // $form_values and form submission data lets us start fresh without clobbering work done
  // in earlier recursive calls.
227 228
  array_push($saved_globals, array($form_values, $form_submitted, $form_button_counter));

229
  $form_values = array();
Dries's avatar
Dries committed
230
  $form_submitted = FALSE;
231
  $form_button_counter = array(0, 0);
232

233
  drupal_prepare_form($form_id, $form);
234
  if (($form['#programmed']) || (!empty($_POST) && (($_POST['form_id'] == $form_id) || ($_POST['form_id'] == $form['#base'])))) {
235
    drupal_validate_form($form_id, $form);
236 237 238
    // IE does not send a button value when there is only one submit button (and no non-submit buttons)
    // and you submit by pressing enter.
    // In that case we accept a submission without button values.
239 240
    if ((($form['#programmed']) || $form_submitted || (!$form_button_counter[0] && $form_button_counter[1])) && !form_get_errors()) {
      $redirect = drupal_submit_form($form_id, $form);
241 242 243
      if (!$form['#programmed']) {
        drupal_redirect_form($form, $redirect);
      }
244 245 246
    }
  }

247 248
  // We've finished calling functions that alter the global values, so we can
  // restore the ones that were there before this function was called.
249
  list($form_values, $form_submitted, $form_button_counter) = array_pop($saved_globals);
250
  return $redirect;
251 252 253 254 255 256 257 258 259 260 261 262 263
}

/**
 * Prepares a structured form array by adding required elements,
 * executing any hook_form_alter functions, and optionally inserting
 * a validation token to prevent tampering.
 *
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 * @param $form
 *   An associative array containing the structure of the form.
 */
264
function drupal_prepare_form($form_id, &$form) {
265 266
  global $user;

267
  $form['#type'] = 'form';
268 269 270 271 272 273 274 275 276

  if (!isset($form['#post'])) {
    $form['#post'] = $_POST;
    $form['#programmed'] = FALSE;
  }
  else {
    $form['#programmed'] = TRUE;
  }

277
  // In multi-step form scenarios, this id is used to identify
278 279 280 281 282 283 284 285 286 287
  // a unique instance of a particular form for retrieval.
  if (isset($form['#build_id'])) {
    $form['form_build_id'] = array(
      '#type' => 'hidden',
      '#value' => $form['#build_id'],
      '#id' => $form['#build_id'],
      '#name' => 'form_build_id',
    );
  }

288 289 290 291 292 293 294
  // If $base is set, it is used in place of $form_id when constructing validation,
  // submission, and theming functions. Useful for mapping many similar or duplicate
  // forms with different $form_ids to the same processing functions.
  if (isset($form['#base'])) {
    $base = $form['#base'];
  }

295 296 297 298
  // Add a token, based on either #token or form_id, to any form displayed to authenticated users.
  // This ensures that any submitted form was actually requested previously by the user and protects against
  // cross site request forgeries.

299
  if (isset($form['#token'])) {
300
    if ($form['#token'] === FALSE || $user->uid == 0 || $form['#programmed']) {
301
      unset($form['#token']);
302
    }
303
    else {
304
      $form['form_token'] = array('#type' => 'token', '#default_value' => drupal_get_token($form['#token']));
305
    }
306
  }
307 308 309 310 311 312 313 314 315
  else if ($user->uid && !$form['#programmed']) {
    $form['#token'] = $form_id;
    $form['form_token'] = array(
      '#id' => 'edit-'. str_replace('_', '-', $form_id) .'-form-token',
      '#type' => 'token',
      '#default_value' => drupal_get_token($form['#token']),
    );
  }

316

317
  if (isset($form_id)) {
318
    $form['form_id'] = array('#type' => 'hidden', '#value' => $form_id, '#id' => str_replace('_', '-', "edit-$form_id"));
319
  }
320 321 322
  if (!isset($form['#id'])) {
    $form['#id'] = $form_id;
  }
323

324
  $form += _element_info('form');
325

Dries's avatar
Dries committed
326 327
  if (!isset($form['#validate'])) {
    if (function_exists($form_id .'_validate')) {
328
      $form['#validate'] = array($form_id .'_validate' => array());
Dries's avatar
Dries committed
329
    }
330 331
    elseif (function_exists($base .'_validate')) {
      $form['#validate'] = array($base .'_validate' => array());
Dries's avatar
Dries committed
332 333 334
    }
  }

335 336
  if (!isset($form['#submit'])) {
    if (function_exists($form_id .'_submit')) {
337 338
      // we set submit here so that it can be altered but use reference for
      // $form_values because it will change later
339
      $form['#submit'] = array($form_id .'_submit' => array());
Dries's avatar
Dries committed
340
    }
341 342
    elseif (function_exists($base .'_submit')) {
      $form['#submit'] = array($base .'_submit' => array());
Dries's avatar
Dries committed
343 344 345
    }
  }

346 347
  foreach (module_implements('form_alter') as $module) {
    $function = $module .'_form_alter';
348
    $function($form_id, $form);
349 350
  }

351
  $form = form_builder($form_id, $form);
352 353
}

354 355 356 357 358 359 360 361 362 363 364 365

/**
 * Validates user-submitted form data from a global variable using
 * the validate functions defined in a structured form array.
 *
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 * @param $form
 *   An associative array containing the structure of the form.
 *
 */
366
function drupal_validate_form($form_id, $form) {
367
  global $form_values;
368 369 370 371 372
  static $validated_forms = array();

  if (isset($validated_forms[$form_id])) {
    return;
  }
373

374
  // If the session token was set by drupal_prepare_form(), ensure that it
375
  // matches the current user's session
376
  if (isset($form['#token'])) {
377
    if (!drupal_valid_token($form_values['form_token'], $form['#token'])) {
378
      // setting this error will cause the form to fail validation
379
      form_set_error('form_token', t('Validation error, please try again. If this error persists, please contact the site administrator.'));
380 381 382
    }
  }

383
  _form_validate($form, $form_id);
384
  $validated_forms[$form_id] = TRUE;
385 386
}

387 388 389 390 391 392 393 394 395 396 397 398 399 400
/**
 * Processes user-submitted form data from a global variable using
 * the submit functions defined in a structured form array.
 *
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 * @param $form
 *   An associative array containing the structure of the form.
 * @return
 *   A string containing the path of the page to display when processing
 *   is complete.
 *
 */
401
function drupal_submit_form($form_id, $form) {
402 403
  global $form_values;
  $default_args = array($form_id, &$form_values);
404

405
  if (isset($form['#submit'])) {
406 407
    foreach ($form['#submit'] as $function => $args) {
      if (function_exists($function)) {
408
        $args = array_merge($default_args, (array) $args);
409 410
        // Since we can only redirect to one page, only the last redirect will work
        $redirect = call_user_func_array($function, $args);
411 412 413
        if (isset($redirect)) {
          $goto = $redirect;
        }
Dries's avatar
Dries committed
414 415
      }
    }
416
  }
417
  return $goto;
418 419
}

420 421 422 423 424 425 426 427 428 429 430 431 432
/**
 * Renders a structured form array into themed HTML.
 *
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 * @param $form
 *   An associative array containing the structure of the form.
 * @return
 *   A string containing the path of the page to display when processing
 *   is complete.
 *
 */
433
function drupal_render_form($form_id, &$form) {
434
  // Don't override #theme if someone already set it.
435 436 437 438
  if (isset($form['#base'])) {
    $base = $form['#base'];
  }

439 440 441 442
  if (!isset($form['#theme'])) {
    if (theme_get_function($form_id)) {
      $form['#theme'] = $form_id;
    }
443 444
    elseif (theme_get_function($base)) {
      $form['#theme'] = $base;
445 446 447 448 449 450 451 452 453 454 455
    }
  }

  if (isset($form['#pre_render'])) {
    foreach ($form['#pre_render'] as $function) {
      if (function_exists($function)) {
        $function($form_id, $form);
      }
    }
  }

456
  $output = drupal_render($form);
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
  return $output;
}

/**
 * Redirect the user to a URL after a form has been processed.
 *
 * @param $form
 *   An associative array containing the structure of the form.
 * @param $redirect
 *   An optional string containing the destination path to redirect
 *   to if none is specified by the form.
 *
 */
function drupal_redirect_form($form, $redirect = NULL) {
  if (isset($redirect)) {
    $goto = $redirect;
  }
  if (isset($form['#redirect'])) {
    $goto = $form['#redirect'];
  }
  if ($goto !== FALSE) {
    if (is_array($goto)) {
      call_user_func_array('drupal_goto', $goto);
    }
    elseif (!isset($goto)) {
      drupal_goto($_GET['q']);
    }
    else {
      drupal_goto($goto);
    }
  }
}

490
function _form_validate($elements, $form_id = NULL) {
491 492 493 494 495 496
  // Recurse through all children.
  foreach (element_children($elements) as $key) {
    if (isset($elements[$key]) && $elements[$key]) {
      _form_validate($elements[$key]);
    }
  }
497
  /* Validate the current input */
498
  if (!isset($elements['#validated']) || !$elements['#validated']) {
499
    if (isset($elements['#needs_validation'])) {
500 501 502 503
      // An empty textfield returns '' so we use empty(). An empty checkbox
      // and a textfield could return '0' and empty('0') returns TRUE so we
      // need a special check for the '0' string.
      if ($elements['#required'] && empty($elements['#value']) && $elements['#value'] !== '0') {
504
        form_error($elements, t('!name field is required.', array('!name' => $elements['#title'])));
505
      }
506 507 508 509 510 511 512 513 514 515 516 517 518 519

      // Add legal choice check if element has #options. Can be skipped, but then you must validate your own element.
      if (isset($elements['#options']) && isset($elements['#value']) && !isset($elements['#DANGEROUS_SKIP_CHECK'])) {
        if ($elements['#type'] == 'select') {
          $options = form_options_flatten($elements['#options']);
        }
        else {
          $options = $elements['#options'];
        }
        if (is_array($elements['#value'])) {
          $value = $elements['#type'] == 'checkboxes' ? array_keys(array_filter($elements['#value'])) : $elements['#value'];
          foreach ($value as $v) {
            if (!isset($options[$v])) {
              form_error($elements, t('An illegal choice has been detected. Please contact the site administrator.'));
520
              watchdog('form', t('Illegal choice %choice in !name element.', array('%choice' => $v, '!name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title'])), WATCHDOG_ERROR);
521
            }
522 523
          }
        }
524 525
        elseif (!isset($options[$elements['#value']])) {
          form_error($elements, t('An illegal choice has been detected. Please contact the site administrator.'));
526
          watchdog('form', t('Illegal choice %choice in %name element.', array('%choice' => $elements['#value'], '%name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title'])), WATCHDOG_ERROR);
527
        }
528 529 530 531
      }
    }

    // User-applied checks.
Dries's avatar
Dries committed
532
    if (isset($elements['#validate'])) {
533 534 535 536 537
      foreach ($elements['#validate'] as $function => $args) {
        $args = array_merge(array($elements), $args);
        // for the full form we hand over a copy of $form_values
        if (isset($form_id)) {
          $args = array_merge(array($form_id, $GLOBALS['form_values']), $args);
538
        }
539 540
        if (function_exists($function))  {
          call_user_func_array($function, $args);
541 542 543
        }
      }
    }
544
    $elements['#validated'] = TRUE;
545 546 547
  }
}

548 549 550 551 552
/**
 * File an error against a form element. If the name of the element is
 * edit[foo][bar] then you may pass either foo or foo][bar as $name
 * foo will set an error for all its children.
 */
553
function form_set_error($name = NULL, $message = '') {
554 555 556
  static $form = array();
  if (isset($name) && !isset($form[$name])) {
    $form[$name] = $message;
557 558 559
    if ($message) {
      drupal_set_message($message, 'error');
    }
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
  }
  return $form;
}

/**
 * Return an associative array of all errors.
 */
function form_get_errors() {
  $form = form_set_error();
  if (!empty($form)) {
    return $form;
  }
}

/**
 * Return the error message filed against the form with the specified name.
 */
function form_get_error($element) {
  $form = form_set_error();
  $key = $element['#parents'][0];
  if (isset($form[$key])) {
    return $form[$key];
  }
  $key = implode('][', $element['#parents']);
  if (isset($form[$key])) {
    return $form[$key];
  }
}

589 590 591
/**
 * Flag an element as having an error.
 */
592
function form_error(&$element, $message = '') {
593
  $element['#error'] = TRUE;
594
  form_set_error(implode('][', $element['#parents']), $message);
595 596 597
}

/**
598 599 600 601 602 603
 * Adds some required properties to each form element, which are used
 * internally in the form api. This function also automatically assigns
 * the value property from the $edit array, provided the element doesn't
 * already have an assigned value.
 *
 * @param $form_id
604 605
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
606 607
 * @param $form
 *   An associative array containing the structure of the form.
608
 */
609
function form_builder($form_id, $form) {
610
  global $form_values, $form_submitted, $form_button_counter;
611

612 613 614
  // Initialize as unprocessed.
  $form['#processed'] = FALSE;

615
  /* Use element defaults */
616
  if ((!empty($form['#type'])) && ($info = _element_info($form['#type']))) {
617
    // overlay $info onto $form, retaining preexisting keys in $form
618 619 620
    $form += $info;
  }

621
  if (isset($form['#input']) && $form['#input']) {
622
    if (!isset($form['#name'])) {
623 624
      $name = array_shift($form['#parents']);
      $form['#name'] = $name;
625 626 627 628 629 630 631
      if ($form['#type'] == 'file') {
        // to make it easier to handle $_FILES in file.inc, we place all
        // file fields in the 'files' array. Also, we do not support
        // nested file names
        $form['#name'] = 'files['. $form['#name'] .']';
      }
      elseif (count($form['#parents'])) {
632 633 634
        $form['#name'] .= '['. implode('][', $form['#parents']) .']';
      }
      array_unshift($form['#parents'], $name);
635 636
    }
    if (!isset($form['#id'])) {
637
      $form['#id'] = 'edit-'. implode('-', $form['#parents']);
638
    }
639

640 641 642 643
    if (isset($form['#disabled']) && $form['#disabled']) {
      $form['#attributes']['disabled'] = 'disabled';
    }

644
    if (!isset($form['#value']) && !array_key_exists('#value', $form)) {
645
      if (($form['#programmed']) || ((!isset($form['#access']) || $form['#access']) && isset($form['#post']) && (isset($form['#post']['form_id']) && $form['#post']['form_id'] == $form_id))) {
646
        $edit = $form['#post'];
647 648 649
        foreach ($form['#parents'] as $parent) {
          $edit = isset($edit[$parent]) ? $edit[$parent] : NULL;
        }
650 651 652 653 654 655 656 657 658 659 660 661 662 663
        if (!$form['#programmed'] || isset($edit)) {
          switch ($form['#type']) {
            case 'checkbox':
              $form['#value'] = !empty($edit) ? $form['#return_value'] : 0;
              break;

            case 'select':
              if (isset($form['#multiple']) && $form['#multiple']) {
                if (isset($edit) && is_array($edit)) {
                  $form['#value'] = drupal_map_assoc($edit);
                }
                else {
                  $form['#value'] = array();
                }
664
              }
665 666
              elseif (isset($edit)) {
                $form['#value'] = $edit;
667
              }
668 669 670 671 672 673 674 675 676 677
              break;

            case 'textfield':
              if (isset($edit)) {
                // Equate $edit to the form value to ensure it's marked for validation
                $edit = str_replace(array("\r", "\n"), '', $edit);
                $form['#value'] = $edit;
              }
              break;

678 679 680 681
            case 'token':
              $form['#value'] = (string)$edit;
              break;

682 683 684 685 686 687 688 689 690
            default:
              if (isset($edit)) {
                $form['#value'] = $edit;
              }
          }
          // Mark all posted values for validation
          if ((isset($form['#value']) && $form['#value'] === $edit) || (isset($form['#required']) && $form['#required'])) {
            $form['#needs_validation'] = TRUE;
          }
691 692 693
        }
      }
      if (!isset($form['#value'])) {
694 695 696 697 698
        $function = $form['#type'] . '_value';
        if (function_exists($function)) {
          $function($form);
        }
        else {
699
          $form['#value'] = isset($form['#default_value']) ? $form['#default_value'] : '';
700
        }
701
      }
702
    }
703 704 705 706
    if (isset($form['#executes_submit_callback'])) {
      // Count submit and non-submit buttons
      $form_button_counter[$form['#executes_submit_callback']]++;
      // See if a submit button was pressed
707
      if (isset($form['#post'][$form['#name']]) && $form['#post'][$form['#name']] == $form['#value']) {
708
        $form_submitted = $form_submitted || $form['#executes_submit_callback'];
709 710 711 712 713

        // In most cases, we want to use form_set_value() to manipulate the global variables.
        // In this special case, we want to make sure that the value of this element is listed
        // in $form_variables under 'op'.
        $form_values[$form['#name']] = $form['#value'];
714 715 716 717
      }
    }
  }

718
  // Allow for elements to expand to multiple elements, e.g. radios, checkboxes and files.
719
  if (isset($form['#process']) && !$form['#processed']) {
720 721
    foreach ($form['#process'] as $process => $args) {
      if (function_exists($process)) {
722
        $args = array_merge(array($form), array($edit), $args);
723
        $form = call_user_func_array($process, $args);
724 725
      }
    }
726
    $form['#processed'] = TRUE;
727 728
  }

729 730 731
  // Set the $form_values key that gets passed to validate and submit.
  // We call this after #process gets called so that #process has a
  // chance to update #value if desired.
732
  if (isset($form['#input']) && $form['#input']) {
733
    form_set_value($form, $form['#value']);
734 735
  }

736 737 738
  // Recurse through all child elements.
  $count  = 0;
  foreach (element_children($form) as $key) {
739 740
    $form[$key]['#post'] = $form['#post'];
    $form[$key]['#programmed'] = $form['#programmed'];
741
    // don't squash an existing tree value
742 743 744
    if (!isset($form[$key]['#tree'])) {
      $form[$key]['#tree'] = $form['#tree'];
    }
745

746 747 748 749 750
    // deny access to child elements if parent is denied
    if (isset($form['#access']) && !$form['#access']) {
      $form[$key]['#access'] = FALSE;
    }

751 752
    // don't squash existing parents value
    if (!isset($form[$key]['#parents'])) {
753 754
      // Check to see if a tree of child elements is present. If so, continue down the tree if required.
      $form[$key]['#parents'] = $form[$key]['#tree'] && $form['#tree'] ? array_merge($form['#parents'], array($key)) : array($key);
755 756
    }

757
    // Assign a decimal placeholder weight to preserve original array order
758 759 760
    if (!isset($form[$key]['#weight'])) {
      $form[$key]['#weight'] = $count/1000;
    }
761
    $form[$key] = form_builder($form_id, $form[$key]);
762 763 764
    $count++;
  }

765 766 767 768 769 770
  if (isset($form['#after_build']) && !isset($form['#after_build_done'])) {
    foreach ($form['#after_build'] as $function) {
      if (function_exists($function)) {
        $form = $function($form, $form_values);
      }
    }
771
    $form['#after_build_done'] = TRUE;
772
  }
773 774

  return $form;
775 776
}

777
/**
Dries's avatar
Dries committed
778
 * Use this function to make changes to form values in the form validate
779 780 781 782
 * phase, so they will be available in the submit phase in $form_values.
 *
 * Specifically, if $form['#parents'] is array('foo', 'bar')
 * and $value is 'baz' then this function will make
Dries's avatar
Dries committed
783
 * $form_values['foo']['bar'] to be 'baz'.
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
 *
 * @param $form
 *   The form item. Keys used: #parents, #value
 * @param $value
 *   The value for the form item.
 */
function form_set_value($form, $value) {
  global $form_values;
  _form_set_value($form_values, $form, $form['#parents'], $value);
}

/**
 * Helper function for form_set_value().
 *
 * We iterate of $parents and create nested arrays for them
 * in $form_values if needed. Then we insert the value in
 * the right array.
 */
function _form_set_value(&$form_values, $form, $parents, $value) {
  $parent = array_shift($parents);
  if (empty($parents)) {
    $form_values[$parent] = $value;
  }
  else {
    if (!isset($form_values[$parent])) {
      $form_values[$parent] = array();
    }
    _form_set_value($form_values[$parent], $form, $parents, $value);
  }
  return $form;
}

816 817 818
/**
 * Retrieve the default properties for the defined element type.
 */
819
function _element_info($type, $refresh = NULL) {
820
  static $cache;
821

822
  $basic_defaults = array(
823 824 825
    '#description' => NULL,
    '#attributes' => array(),
    '#required' => FALSE,
826
    '#tree' => FALSE,
827
    '#parents' => array()
828
  );
829
  if (!isset($cache) || $refresh) {
830 831 832
    $cache = array();
    foreach (module_implements('elements') as $module) {
      $elements = module_invoke($module, 'elements');
833
      if (isset($elements) && is_array($elements)) {
834
        $cache = array_merge_recursive($cache, $elements);
835 836 837 838
      }
    }
    if (sizeof($cache)) {
      foreach ($cache as $element_type => $info) {
839
        $cache[$element_type] = array_merge_recursive($basic_defaults, $info);
840 841 842 843 844 845 846
      }
    }
  }

  return $cache[$type];
}

847 848 849 850 851 852 853 854
function form_options_flatten($array, $reset = TRUE) {
  static $return;

  if ($reset) {
    $return = array();
  }

  foreach ($array as $key => $value) {
855 856 857 858
    if (is_object($value)) {
      form_options_flatten($value->option, FALSE);
    }
    else if (is_array($value)) {
859 860 861 862 863 864 865 866 867 868
      form_options_flatten($value, FALSE);
    }
    else {
      $return[$key] = 1;
    }
  }

  return $return;
}

869 870 871 872 873
/**
 * Format a dropdown menu or scrolling selection box.
 *
 * @param $element
 *   An associative array containing the properties of the element.
874
 *   Properties used: title, value, options, description, extra, multiple, required
875 876 877 878 879 880 881 882 883
 * @return
 *   A themed HTML string representing the form element.
 *
 * It is possible to group options together; to do this, change the format of
 * $options to an associative array in which the keys are group labels, and the
 * values are associative arrays in the normal $options format.
 */
function theme_select($element) {
  $select = '';
884
  $size = $element['#size'] ? ' size="' . $element['#size'] . '"' : '';
885
  _form_set_class($element, array('form-select'));
886 887
  $multiple = isset($element['#multiple']) && $element['#multiple'];
  return theme('form_element', $element, '<select name="'. $element['#name'] .''. ($multiple ? '[]' : '') .'"'. ($multiple ? ' multiple="multiple" ' : '') . drupal_attributes($element['#attributes']) .' id="'. $element['#id'] .'" '. $size .'>'. form_select_options($element) .'</select>');
888 889 890 891 892 893
}

function form_select_options($element, $choices = NULL) {
  if (!isset($choices)) {
    $choices = $element['#options'];
  }
894
  // array_key_exists() accommodates the rare event where $element['#value'] is NULL.
895 896 897
  // isset() fails in this situation.
  $value_valid = isset($element['#value']) || array_key_exists('#value', $element);
  $value_is_array = is_array($element['#value']);
898 899
  $options = '';
  foreach ($choices as $key => $choice) {
900
    if (is_array($choice)) {
901 902 903
      $options .= '<optgroup label="'. $key .'">';
      $options .= form_select_options($element, $choice);
      $options .= '</optgroup>';
904
    }
905 906 907
    elseif (is_object($choice)) {
      $options .= form_select_options($element, $choice->option);
    }
908
    else {
909 910
      $key = (string)$key;
      if ($value_valid && ($element['#value'] == $key || ($value_is_array && in_array($key, $element['#value'])))) {
911 912 913 914 915
        $selected = ' selected="selected"';
      }
      else {
        $selected = '';
      }
916
      $options .= '<option value="'. $key .'"'. $selected .'>'. check_plain($choice) .'</option>';
917 918
    }
  }
919
  return $options;
920 921 922 923 924 925 926
}

/**
 * Format a group of form items.
 *
 * @param $element
 *   An associative array containing the properties of the element.
927
 *   Properties used: attributes, title, value, description, children, collapsible, collapsed
928 929 930 931
 * @return
 *   A themed HTML string representing the form item group.
 */
function theme_fieldset($element) {
932
  if ($element['#collapsible']) {
933 934
    drupal_add_js('misc/collapse.js');

935 936 937 938
    if (!isset($element['#attributes']['class'])) {
      $element['#attributes']['class'] = '';
    }

939 940 941
    $element['#attributes']['class'] .= ' collapsible';
    if ($element['#collapsed']) {
     $element['#attributes']['class'] .= ' collapsed';
942 943 944
    }
  }

945
  return '<fieldset' . drupal_attributes($element['#attributes']) .'>' . ($element['#title'] ? '<legend>'. $element['#title'] .'</legend>' : '') . ($element['#description'] ? '<div class="description">'. $element['#description'] .'</div>' : '') . $element['#children'] . $element['#value'] . "</fieldset>\n";
946 947 948 949 950 951 952
}

/**
 * Format a radio button.
 *
 * @param $element
 *   An associative array containing the properties of the element.
953
 *   Properties used: required, return_value, value, attributes, title, description
954 955 956 957
 * @return
 *   A themed HTML string representing the form item group.
 */
function theme_radio($element) {
958
  _form_set_class($element, array('form-radio'));
959
  $output = '<input type="radio" ';
960 961 962 963 964 965
  $output .= 'name="' . $element['#name'] .'" ';
  $output .= 'value="'. $element['#return_value'] .'" ';
  $output .= ($element['#value'] == $element['#return_value']) ? ' checked="checked" ' : ' ';
  $output .= drupal_attributes($element['#attributes']) .' />';
  if (!is_null($element['#title'])) {
    $output = '<label class="option">'. $output .' '. $element['#title'] .'</label>';
966
  }
967 968 969

  unset($element['#title']);
  return theme('form_element', $element, $output);
970 971 972 973 974 975 976
}

/**
 * Format a set of radio buttons.
 *
 * @param $element
 *   An associative array containing the properties of the element.
977
 *   Properties used: title, value, options, description, required and attributes.
978 979 980 981
 * @return
 *   A themed HTML string representing the radio button set.
 */
function theme_radios($element) {
982
  $element['#children'] = '<div class="form-radios">'. $element['#children'] .'</div>';
983
  if ($element['#title'] || $element['#description']) {
984 985
    unset($element['#id']);
    return theme('form_element', $element, $element['#children']);
986 987
  }
  else {
988
    return $element['#children'];
989 990 991
  }
}

992 993 994 995 996 997 998 999 1000 1001
/**
 * Format a password_confirm item.
 *
 * @param $element
 *   An associative array containing the properties of the element.
 *   Properties used: title, value, id, required, error.
 * @return
 *   A themed HTML string representing the form item.
 */
function theme_password_confirm($element) {
Dries's avatar
Dries committed
1002
  return theme('form_element', $element, $element['#children']);
1003 1004
}

1005 1006 1007 1008
/*
 * Expand a password_confirm field into two text boxes.
 */
function expand_password_confirm($element) {
Dries's avatar
Dries committed
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
  $element['pass1'] =  array(
    '#type' => 'password',
    '#title' => t('Password'),
    '#value' => $element['#value']['pass1'],
  );
  $element['pass2'] =  array(
    '#type' => 'password',
    '#title' => t('Confirm password'),
    '#value' => $element['#value']['pass2'],
  );
1019 1020 1021 1022 1023 1024
  $element['#validate'] = array('password_confirm_validate' => array());
  $element['#tree'] = TRUE;

  return $element;
}

1025
/**
1026
 * Validate password_confirm element.
1027
 */
1028
function password_confirm_validate($form) {
1029 1030
  $pass1 = trim($form['pass1']['#value']);
  if (!empty($pass1)) {
1031
    $pass2 = trim($form['pass2']['#value']);
1032
    if ($pass1 != $pass2) {
1033
      form_error($form, t('The specified passwords do not match.'));
1034
    }
1035
  }
1036
  elseif ($form['#required'] && !empty($form['#post'])) {
1037
    form_error($form, t('Password field is required.'));
1038
  }
1039

1040 1041 1042 1043 1044 1045
  // Password field must be converted from a two-element array into a single
  // string regardless of validation results.
  form_set_value($form['pass1'], NULL);
  form_set_value($form['pass2'], NULL);
  form_set_value($form, $pass1);

1046 1047 1048
  return $form;
}

1049
/**
1050
 * Format a date selection element.
1051 1052 1053
 *
 * @param $element
 *   An associative array containing the properties of the element.
1054
 *   Properties used: title, value, options, description, required and attributes.
1055
 * @return
1056
 *   A themed HTML string representing the date selection boxes.
1057 1058
 */
function theme_date($element) {
1059
  return theme('form_element', $element, '<div class="container-inline">'. $element['#children'] .'</div>');
1060 1061 1062
}

/**
1063
 * Roll out a single date element.
1064 1065 1066
 */
function expand_date($element) {
  // Default to current date
1067 1068
  if (!isset($element['#value'])) {
    $element['#value'] = array('day' => format_date(time(), 'custom', 'j'),
1069 1070 1071 1072
                            'month' => format_date(time(), 'custom', 'n'),
                            'year' => format_date(time(), 'custom', 'Y'));
  }

1073 1074
  $element['#tree'] = TRUE;

1075
  // Determine the order of day, month, year in the site's chosen date format.
1076
  $format = variable_get('date_format_short', 'm/d/Y - H:i');
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
  $sort = array();
  $sort['day'] = max(strpos($format, 'd'), strpos($format, 'j'));
  $sort['month'] = max(strpos($format, 'm'), strpos($format, 'M'));
  $sort['year'] = strpos($format, 'Y');
  asort($sort);
  $order = array_keys($sort);

  // Output multi-selector for date
  foreach ($order as $type) {
    switch ($type) {
      case 'day':
        $options = drupal_map_assoc(range(1, 31));
        break;
      case 'month':
1091
        $options = drupal_map_assoc(range(1, 12), 'map_month');
1092 1093 1094 1095 1096
        break;
      case 'year':
        $options = drupal_map_assoc(range(1900, 2050));
        break;
    }
1097 1098 1099 1100 1101 1102 1103 1104
    $parents = $element['#parents'];
    $parents[] = $type;
    $element[$type] = array(
      '#type' => 'select',
      '#value' => $element['#value'][$type],
      '#attributes' => $element['#attributes'],
      '#options' => $options,
    );
1105 1106 1107 1108 1109
  }

  return $element;
}

1110 1111 1112 1113 1114 1115 1116 1117 1118
/**
 * Validates the date type to stop dates like February 30, 2006.
 */
function date_validate($form) {
  if (!checkdate($form['#value']['month'], $form['#value']['day'], $form['#value']['year'])) {
    form_error($form, t('The specified date is invalid.'));
  }
}

1119 1120 1121 1122 1123 1124
/**
 * Helper function for usage with drupal_map_assoc to display month names.
 */
function map_month($month) {
  return format_date(gmmktime(0, 0, 0, $month, 2, 1970), 'custom', 'M', 0);
}
1125

1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
/**
 * Helper function to load value from default value for checkboxes
 */
function checkboxes_value(&$form) {
  $value = array();
  foreach ((array)$form['#default_value'] as $key) {
    $value[$key] = 1;
  }
  $form['#value'] = $value;
}

1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
/**
 * If no default value is set for weight select boxes, use 0.
 */
function weight_value(&$form) {
  if (isset($form['#default_value'])) {
    $form['#value'] = $form['#default_value'];
  }
  else {
    $form['#value'] = 0;
  }
}

1149
/**
1150 1151
 * Roll out a single radios element to a list of radios,
 * using the options array as index.
1152 1153
 */
function expand_radios($element) {
1154 1155
  if (count($element['#options']) > 0) {
    foreach ($element['#options'] as $key => $choice) {
1156
      if (!isset($element[$key])) {
1157
        $element[$key] = array('#type' => 'radio', '#title' => $choice, '#return_value' => $key, '#default_value' => $element['#default_value'], '#attributes' => $element['#attributes'], '#parents' => $element['#parents'], '#spawned' => TRUE);
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
      }
    }
  }
  return $element;
}

/**
 * Format a form item.
 *
 * @param $element
 *   An associative array containing the properties of the element.
1169
 *   Properties used:  title, value, description, required, error
1170 1171 1172 1173
 * @return
 *   A themed HTML string representing the form item.
 */
function theme_item($element) {
1174
  return theme('form_element', $element, $element['#value'] . $element['#children']);
1175 1176 1177 1178 1179 1180 1181
}

/**
 * Format a checkbox.
 *
 * @param $element
 *   An associative array containing the properties of the element.
1182
 *   Properties used:  title, value, return_value, description, required
1183 1184 1185 1186
 * @return
 *   A themed HTML string representing the checkbox.
 */
function theme_checkbox($element) {
1187
  _form_set_class($element, array('form-checkbox'));
1188 1189
  $checkbox = '<input ';
  $checkbox .= 'type="checkbox" ';
1190 1191 1192
  $checkbox .= 'name="'. $element['#name'] .'" ';
  $checkbox .= 'id="'. $element['#id'].'" ' ;
  $checkbox .= 'value="'. $element['#return_value'] .'" ';
1193
  $checkbox .= $element['#value'] ? ' checked="checked" ' : ' ';
1194 1195 1196 1197
  $checkbox .= drupal_attributes($element['#attributes']) . ' />';

  if (!is_null($element['#title'])) {
    $checkbox = '<label class="option">'. $checkbox .' '. $element['#title'] .'</label>';
1198 1199
  }

1200 1201
  unset($element['#title']);
  return theme('form_element', $element, $checkbox);
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
}

/**
 * Format a set of checkboxes.
 *
 * @param $element
 *   An associative array containing the properties of the element.
 * @return
 *   A themed HTML string representing the checkbox set.
 */
function theme_checkboxes($element) {
1213
  $element['#children'] = '<div class="form-checkboxes">'. $element['#children'] .'</div>';
1214
  if ($element['#title'] || $element['#description']) {
1215 1216
    unset($element['#id']);
    return theme('form_element', $element, $element['#children']);
1217 1218
  }
  else {
1219
    return $element['#children'];
1220 1221 1222 1223
  }
}

function expand_checkboxes($element) {
1224
  $value = is_array($element['#value']) ? $element['#value'] : array();
1225
  $element['#tree'] = TRUE;
1226 1227 1228
  if (count($element['#options']) > 0) {
    if (!isset($element['#default_value']) || $element['#default_value'] == 0) {
      $element['#default_value'] = array();
1229
    }
1230
    foreach ($element['#options'] as $key => $choice) {
1231
      if (!isset($element[$key])) {
1232
        $element[$key] = array('#type' => 'checkbox', '#processed' => TRUE, '#title' => $choice, '#return_value' => $key, '#default_value' => isset($value[$key]), '#attributes' => $element['#attributes']);
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
      }
    }
  }
  return $element;
}

function theme_submit($element) {
  return theme('button', $element);
}

function theme_button($element) {
1244 1245 1246 1247 1248 1249 1250
  //Make sure not to overwrite classes
  if (isset($element['#attributes']['class'])) {
    $element['#attributes']['class'] = 'form-'. $element['#button_type'] .' '. $element['#attributes']['class'];
  }
  else {
    $element['#attributes']['class'] = 'form-'. $element['#button_type'];
  }
1251

1252
  return '<input type="submit" '. (empty($element['#name']) ? '' : 'name="'. $element['#name'] .'" ') .'value="'. check_plain($element['#value']) .'" '. drupal_attributes($element['#attributes']) ." />\n";
1253 1254 1255 1256 1257 1258 1259
}

/**
 * Format a hidden form field.
 *
 * @param $element
 *   An associative array containing the properties of the element.
1260
 *   Properties used:  value, edit
1261 1262 1263 1264
 * @return
 *   A themed HTML string representing the hidden form field.
 */
function theme_hidden($element) {
1265
  return '<input type="hidden" name="'. $element['#name'] . '" id="'. $element['#id'] . '" value="'. check_plain($element['#value']) ."\" " . drupal_attributes($element['#attributes']) ." />\n";
1266 1267