form.inc 49.6 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 21 22
 * using the drupal_execute() function. Pass in the id of the form, the values to
 * submit to the form, and any parameters needed by the form's builder function.
 * For example:
23 24
 *
 * // register a new user
25 26 27 28
 * $values['name'] = 'robo-user';
 * $values['mail'] = 'robouser@example.com';
 * $values['pass'] = 'password';
 * drupal_execute('user_register', $values);
29
 *
30 31 32 33 34 35 36 37 38
 * // 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);
 *
 * Calling form_get_errors() after execution will return an array of any
 * validation errors encountered.
39 40 41
 *
 * 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
42
 * http://api.drupal.org/api/HEAD/file/developer/topics/forms_api_reference.html
43
 * and the quickstart guide at
44
 * http://api.drupal.org/api/HEAD/file/developer/topics/forms_api.html
45 46 47
 */

/**
48 49
 * Retrieves a form from a builder function, passes it on for
 * processing, and renders the form or redirects to its destination
50 51 52
 * as appropriate. In multi-step form scenerios, it handles properly
 * processing the values using the previous step's form definition,
 * then rendering the requested step for display.
53 54
 *
 * @param $form_id
55 56 57 58 59 60 61 62 63 64 65 66
 *   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) {
67 68 69 70 71 72
  // In multi-step form scenerios, the incoming $_POST values are not
  // 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());
73
  if (isset($_POST['form_build_id']) && isset($_SESSION['form'][$_POST['form_build_id']]) && $_POST['form_id'] == $form_id) {
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
    // 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();
103
    $args[] = $_POST;
104 105 106 107 108 109
    $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;
    }
110
    drupal_prepare_form($args[0], $form);
111 112 113
  }

  return drupal_render_form($args[0], $form);
114 115
}

116

117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
/**
 * 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.
 */
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);
  }
}

151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
/**
 * 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;

166 167 168 169 170
  // 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.
171
  $args = func_get_args();
172
  $saved_args = $args;
173
  array_shift($args);
174 175 176

  // 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.
177
  if (!function_exists($form_id)) {
178 179 180 181 182 183 184 185 186 187 188 189 190
    // 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);
191 192 193 194 195 196 197 198 199
    }
    $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'];
    }
  }
200 201
  // If $callback was returned by a hook_forms() implementation, call it.
  // Otherwise, call the function named after the form id.
202 203 204 205 206 207
  $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.
208
  $form['#parameters'] = $saved_args;
209
  return $form;
210 211 212 213 214 215 216 217
}

/**
 * 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.
218 219
 * @param $form
 *   An associative array containing the structure of the form.
220 221
 * @return
 *   The path to redirect the user to upon completion.
222
 */
223
function drupal_process_form($form_id, &$form) {
224
  global $form_values, $form_submitted, $user, $form_button_counter;
225
  static $saved_globals = array();
226 227 228
  // In some scenerios, this function can be called recursively. Pushing any pre-existing
  // $form_values and form submission data lets us start fresh without clobbering work done
  // in earlier recursive calls.
229 230
  array_push($saved_globals, array($form_values, $form_submitted, $form_button_counter));

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

235
  drupal_prepare_form($form_id, $form);
236
  if (($form['#programmed']) || (!empty($_POST) && (($_POST['form_id'] == $form_id) || ($_POST['form_id'] == $form['#base'])))) {
237
    drupal_validate_form($form_id, $form);
238 239 240
    // 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.
241 242
    if ((($form['#programmed']) || $form_submitted || (!$form_button_counter[0] && $form_button_counter[1])) && !form_get_errors()) {
      $redirect = drupal_submit_form($form_id, $form);
243 244 245
      if (!$form['#programmed']) {
        drupal_redirect_form($form, $redirect);
      }
246 247 248
    }
  }

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

/**
 * 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.
 */
266
function drupal_prepare_form($form_id, &$form) {
267 268
  global $user;

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

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

279 280 281 282 283 284 285 286 287 288 289
  // In multi-step form scenerios, this id is used to identify
  // 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',
    );
  }

290 291 292 293 294 295 296
  // 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'];
  }

297 298 299 300
  // 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.

301
  if (isset($form['#token'])) {
302
    if ($form['#token'] === FALSE || $user->uid == 0 || $form['#programmed']) {
303
      unset($form['#token']);
304
    }
305
    else {
306
      $form['form_token'] = array('#type' => 'token', '#default_value' => drupal_get_token($form['#token']));
307
    }
308
  }
309 310 311 312 313 314 315 316 317
  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']),
    );
  }

318

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

326
  $form += _element_info('form');
327

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

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

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

353
  $form = form_builder($form_id, $form);
354 355
}

356 357 358 359 360 361 362 363 364 365 366 367

/**
 * 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.
 *
 */
368
function drupal_validate_form($form_id, $form) {
369
  global $form_values;
370 371 372 373 374
  static $validated_forms = array();

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

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

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

389 390 391 392 393 394 395 396 397 398 399 400 401 402
/**
 * 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.
 *
 */
403
function drupal_submit_form($form_id, $form) {
404 405
  global $form_values;
  $default_args = array($form_id, &$form_values);
406

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

422 423 424 425 426 427 428 429 430 431 432 433 434
/**
 * 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.
 *
 */
435
function drupal_render_form($form_id, &$form) {
436
  // Don't override #theme if someone already set it.
437 438 439 440
  if (isset($form['#base'])) {
    $base = $form['#base'];
  }

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

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

458
  $output = drupal_render($form);
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 490 491
  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);
    }
  }
}

492
function _form_validate($elements, $form_id = NULL) {
493 494 495 496 497 498
  // Recurse through all children.
  foreach (element_children($elements) as $key) {
    if (isset($elements[$key]) && $elements[$key]) {
      _form_validate($elements[$key]);
    }
  }
499
  /* Validate the current input */
500
  if (!isset($elements['#validated']) || !$elements['#validated']) {
501
    if (isset($elements['#needs_validation'])) {
502 503 504 505
      // 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') {
506
        form_error($elements, t('!name field is required.', array('!name' => $elements['#title'])));
507
      }
508 509 510 511 512 513 514 515 516 517 518 519 520 521

      // 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.'));
522
              watchdog('form', t('Illegal choice %choice in !name element.', array('%choice' => $v, '!name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title'])), WATCHDOG_ERROR);
523
            }
524 525
          }
        }
526 527
        elseif (!isset($options[$elements['#value']])) {
          form_error($elements, t('An illegal choice has been detected. Please contact the site administrator.'));
528
          watchdog('form', t('Illegal choice %choice in %name element.', array('%choice' => $elements['#value'], '%name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title'])), WATCHDOG_ERROR);
529
        }
530 531 532 533
      }
    }

    // User-applied checks.
Dries's avatar
Dries committed
534
    if (isset($elements['#validate'])) {
535 536 537 538 539
      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);
540
        }
541 542
        if (function_exists($function))  {
          call_user_func_array($function, $args);
543 544 545
        }
      }
    }
546
    $elements['#validated'] = TRUE;
547 548 549
  }
}

550 551 552 553 554
/**
 * 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.
 */
555
function form_set_error($name = NULL, $message = '') {
556 557 558
  static $form = array();
  if (isset($name) && !isset($form[$name])) {
    $form[$name] = $message;
559 560 561
    if ($message) {
      drupal_set_message($message, 'error');
    }
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 589 590
  }
  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];
  }
}

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

/**
600 601 602 603 604 605
 * 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
606 607
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
608 609
 * @param $form
 *   An associative array containing the structure of the form.
610
 */
611
function form_builder($form_id, $form) {
612
  global $form_values, $form_submitted, $form_button_counter;
613

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

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

623
  if (isset($form['#input']) && $form['#input']) {
624
    if (!isset($form['#name'])) {
625 626
      $name = array_shift($form['#parents']);
      $form['#name'] = $name;
627 628 629 630 631 632 633
      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'])) {
634 635 636
        $form['#name'] .= '['. implode('][', $form['#parents']) .']';
      }
      array_unshift($form['#parents'], $name);
637 638
    }
    if (!isset($form['#id'])) {
639
      $form['#id'] = 'edit-'. implode('-', $form['#parents']);
640
    }
641

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

646
    if (!isset($form['#value']) && !array_key_exists('#value', $form)) {
647
      if (($form['#programmed']) || ((!isset($form['#access']) || $form['#access']) && isset($form['#post']) && (isset($form['#post']['form_id']) && $form['#post']['form_id'] == $form_id))) {
648
        $edit = $form['#post'];
649 650 651
        foreach ($form['#parents'] as $parent) {
          $edit = isset($edit[$parent]) ? $edit[$parent] : NULL;
        }
652 653 654 655 656 657 658 659 660 661 662 663 664 665
        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();
                }
666
              }
667 668
              elseif (isset($edit)) {
                $form['#value'] = $edit;
669
              }
670 671 672 673 674 675 676 677 678 679
              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;

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

684 685 686 687 688 689 690 691 692
            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;
          }
693 694 695
        }
      }
      if (!isset($form['#value'])) {
696 697 698 699 700
        $function = $form['#type'] . '_value';
        if (function_exists($function)) {
          $function($form);
        }
        else {
701
          $form['#value'] = isset($form['#default_value']) ? $form['#default_value'] : '';
702
        }
703
      }
704
    }
705 706 707 708
    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
709
      if (isset($form['#post'][$form['#name']]) && $form['#post'][$form['#name']] == $form['#value']) {
710
        $form_submitted = $form_submitted || $form['#executes_submit_callback'];
711 712 713 714 715

        // 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'];
716 717 718 719
      }
    }
  }

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

731 732 733
  // 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.
734
  if (isset($form['#input']) && $form['#input']) {
735
    form_set_value($form, $form['#value']);
736 737
  }

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

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

753 754
    // don't squash existing parents value
    if (!isset($form[$key]['#parents'])) {
755 756
      // 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);
757 758
    }

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

767 768 769 770 771 772
  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);
      }
    }
773
    $form['#after_build_done'] = TRUE;
774
  }
775 776

  return $form;
777 778
}

779
/**
Dries's avatar
Dries committed
780
 * Use this function to make changes to form values in the form validate
781 782 783 784
 * 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
785
 * $form_values['foo']['bar'] to be 'baz'.
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 816 817
 *
 * @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;
}

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

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

  return $cache[$type];
}

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

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

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

  return $return;
}

871 872 873 874 875
/**
 * Format a dropdown menu or scrolling selection box.
 *
 * @param $element
 *   An associative array containing the properties of the element.
876
 *   Properties used: title, value, options, description, extra, multiple, required
877 878 879 880 881 882 883 884 885
 * @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 = '';
886
  $size = $element['#size'] ? ' size="' . $element['#size'] . '"' : '';
887
  _form_set_class($element, array('form-select'));
888 889
  $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>');
890 891 892 893 894 895
}

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

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

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

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

947
  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";
948 949 950 951 952 953 954
}

/**
 * Format a radio button.
 *
 * @param $element
 *   An associative array containing the properties of the element.
955
 *   Properties used: required, return_value, value, attributes, title, description
956 957 958 959
 * @return
 *   A themed HTML string representing the form item group.
 */
function theme_radio($element) {
960
  _form_set_class($element, array('form-radio'));
961
  $output = '<input type="radio" ';
962 963 964 965 966 967
  $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>';
968
  }
969 970 971

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

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

994 995 996 997 998 999 1000 1001 1002 1003
/**
 * 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
1004
  return theme('form_element', $element, $element['#children']);
1005 1006
}

1007 1008 1009 1010
/*
 * Expand a password_confirm field into two text boxes.
 */
function expand_password_confirm($element) {
Dries's avatar
Dries committed
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
  $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'],
  );
1021 1022 1023 1024 1025 1026
  $element['#validate'] = array('password_confirm_validate' => array());
  $element['#tree'] = TRUE;

  return $element;
}

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

1042 1043 1044 1045 1046 1047
  // 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);

1048 1049 1050
  return $form;
}

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

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

1075 1076
  $element['#tree'] = TRUE;

1077
  // Determine the order of day, month, year in the site's chosen date format.
1078
  $format = variable_get('date_format_short', 'm/d/Y - H:i');
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
  $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':
1093
        $options = drupal_map_assoc(range(1, 12), 'map_month');
1094 1095 1096 1097 1098
        break;
      case 'year':
        $options = drupal_map_assoc(range(1900, 2050));
        break;
    }
1099 1100 1101 1102 1103 1104 1105 1106
    $parents = $element['#parents'];
    $parents[] = $type;
    $element[$type] = array(
      '#type' => 'select',
      '#value' => $element['#value'][$type],
      '#attributes' => $element['#attributes'],
      '#options' => $options,
    );
1107 1108 1109 1110 1111
  }

  return $element;
}

1112 1113 1114 1115 1116 1117 1118 1119 1120
/**
 * 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.'));
  }
}

1121 1122 1123 1124 1125 1126
/**
 * 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);
}
1127

1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
/**
 * 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;
}

1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
/**
 * 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;
  }
}

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

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

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

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

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

/**
 * 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) {
1215
  $element['#children'] = '<div class="form-checkboxes">'. $element['#children'] .'</div>';
1216
  if ($element['#title'] || $element['#description']) {
1217 1218
    unset($element['#id']);
    return theme('form_element', $element, $element['#children']);
1219 1220
  }
  else {
1221
    return $element['#children'];
1222 1223 1224 1225
  }
}

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

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

function theme_button($element) {
1246 1247 1248 1249 1250 1251 1252
  //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'];
  }
1253

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

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

1270 1271 1272 <