form.inc 65.1 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
 * 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:
 *
16
 * // Display the user registration form.
17 18 19
 * $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
 *
 *
 * For information on the format of the structured arrays used to define forms,
24 25 26
 * and more detailed explanations of the Form API workflow, see the
 * @link http://api.drupal.org/api/HEAD/file/developer/topics/forms_api_reference.html reference @endlink
 * and the @link http://api.drupal.org/api/HEAD/file/developer/topics/forms_api.html quickstart guide. @endlink
27 28 29
 */

/**
30 31
 * Retrieves a form from a builder function, passes it on for
 * processing, and renders the form or redirects to its destination
32
 * as appropriate. In multi-step form scenarios, it handles properly
33 34
 * processing the values using the previous step's form definition,
 * then rendering the requested step for display.
35 36
 *
 * @param $form_id
37 38 39 40 41 42 43 44 45 46 47 48
 *   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) {
49
  // In multi-step form scenarios, the incoming $_POST values are not
50 51 52 53 54
  // 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());
55
  if (isset($_POST['form_build_id']) && isset($_SESSION['form'][$_POST['form_build_id']]['args']) && $_POST['form_id'] == $form_id) {
56 57 58
    // There's a previously stored multi-step form. We should handle
    // IT first.
    $stored = TRUE;
59
    $args = $_SESSION['form'][$_POST['form_build_id']]['args'];
60
    $form = call_user_func_array('drupal_retrieve_form', $args);
61
    $form['#build_id'] = $_POST['form_build_id'];
62 63 64 65 66 67 68 69
  }
  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']) {
70 71 72
      // Clean up old multistep form session data.
      _drupal_clean_form_sessions();
      $_SESSION['form'][$form_build_id] = array('timestamp' => time(), 'args' => $args);
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
      $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();
88
    $args[] = $_POST;
89 90 91
    $form = call_user_func_array('drupal_retrieve_form', $args);
    unset($_SESSION['form'][$_POST['form_build_id']]);
    if (isset($form['#multistep']) && $form['#multistep']) {
92
      $_SESSION['form'][$form_build_id] = array('timestamp' => time(), 'args' => $args);
93 94
      $form['#build_id'] = $form_build_id;
    }
95
    drupal_prepare_form($args[0], $form);
96 97 98
  }

  return drupal_render_form($args[0], $form);
99 100
}

101

102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
/**
 * Remove form information that's at least a day old from the
 * $_SESSION['form'] array.
 */
function _drupal_clean_form_sessions() {
  if (isset($_SESSION['form'])) {
    foreach ($_SESSION['form'] as $build_id => $data) {
      if ($data['timestamp'] < (time() - 84600)) {
        unset($_SESSION['form'][$build_id]);
      }
    }
  }
}


117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
/**
 * 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.
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
 *
 * 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);
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
 */
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);
  }
}

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
/**
 * 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;

181 182 183 184 185
  // 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.
186
  $args = func_get_args();
187
  $saved_args = $args;
188
  array_shift($args);
189 190 191

  // 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.
192
  if (!function_exists($form_id)) {
193 194 195 196 197 198 199 200 201 202 203 204 205
    // 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);
206 207 208 209 210 211 212 213 214
    }
    $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'];
    }
  }
215 216
  // If $callback was returned by a hook_forms() implementation, call it.
  // Otherwise, call the function named after the form id.
217 218 219 220 221 222
  $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.
223
  $form['#parameters'] = $saved_args;
224
  return $form;
225 226 227 228 229 230 231 232
}

/**
 * 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.
233 234
 * @param $form
 *   An associative array containing the structure of the form.
235 236
 * @return
 *   The path to redirect the user to upon completion.
237
 */
238
function drupal_process_form($form_id, &$form) {
239
  global $form_values, $form_submitted, $user, $form_button_counter;
240
  static $saved_globals = array();
241
  // In some scenarios, this function can be called recursively. Pushing any pre-existing
242 243
  // $form_values and form submission data lets us start fresh without clobbering work done
  // in earlier recursive calls.
244 245
  array_push($saved_globals, array($form_values, $form_submitted, $form_button_counter));

246
  $form_values = array();
Dries's avatar
Dries committed
247
  $form_submitted = FALSE;
248
  $form_button_counter = array(0, 0);
249

250
  drupal_prepare_form($form_id, $form);
251
  if (($form['#programmed']) || (!empty($_POST) && (($_POST['form_id'] == $form_id)))) {
252
    drupal_validate_form($form_id, $form);
253 254 255
    // 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.
256 257
    if ((($form['#programmed']) || $form_submitted || (!$form_button_counter[0] && $form_button_counter[1])) && !form_get_errors()) {
      $redirect = drupal_submit_form($form_id, $form);
258 259 260 261 262 263
      if ($batch =& batch_get()) {
        $batch['progressive'] = !$form['#programmed'];
        batch_process();
        // Progressive batch processing redirects to the progress page.
        // Execution continues only if programmed form.
      }
264 265 266
      if (!$form['#programmed']) {
        drupal_redirect_form($form, $redirect);
      }
267 268 269
    }
  }

270 271
  // We've finished calling functions that alter the global values, so we can
  // restore the ones that were there before this function was called.
272
  list($form_values, $form_submitted, $form_button_counter) = array_pop($saved_globals);
273 274 275
  if (isset($redirect)) {
    return $redirect;
  }
276 277 278 279 280 281 282 283 284 285 286 287 288
}

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

292
  $form['#type'] = 'form';
293 294 295
  if (!isset($form['#skip_duplicate_check'])) {
    $form['#skip_duplicate_check'] = FALSE;
  }
296 297 298 299 300 301 302 303 304

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

305
  // In multi-step form scenarios, this id is used to identify
306 307 308 309 310 311 312 313 314 315
  // 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',
    );
  }

316 317 318 319
  // 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.
320
  if (isset($form['#token'])) {
321
    if ($form['#token'] === FALSE || $user->uid == 0 || $form['#programmed']) {
322
      unset($form['#token']);
323
    }
324
    else {
325
      $form['form_token'] = array('#type' => 'token', '#default_value' => drupal_get_token($form['#token']));
326
    }
327
  }
328
  else if (isset($user->uid) && $user->uid && !$form['#programmed']) {
329 330
    $form['#token'] = $form_id;
    $form['form_token'] = array(
331
      '#id' => form_clean_id('edit-'. $form_id .'-form-token'),
332 333 334 335 336
      '#type' => 'token',
      '#default_value' => drupal_get_token($form['#token']),
    );
  }

337

338
  if (isset($form_id)) {
339
    $form['form_id'] = array('#type' => 'hidden', '#value' => $form_id, '#id' => form_clean_id("edit-$form_id"));
340
  }
341
  if (!isset($form['#id'])) {
342
    $form['#id'] = form_clean_id($form_id);
343
  }
344

345
  $form += _element_info('form');
346

Dries's avatar
Dries committed
347 348
  if (!isset($form['#validate'])) {
    if (function_exists($form_id .'_validate')) {
349
      $form['#validate'] = array($form_id .'_validate' => array());
Dries's avatar
Dries committed
350 351 352
    }
  }

353 354
  if (!isset($form['#submit'])) {
    if (function_exists($form_id .'_submit')) {
355
      // We set submit here so that it can be altered.
356
      $form['#submit'] = array($form_id .'_submit' => array());
Dries's avatar
Dries committed
357 358 359
    }
  }

360
  drupal_alter('form', $form, $form_id);
361

362
  $form = form_builder($form_id, $form);
363 364
}

365 366 367 368 369 370 371 372 373 374 375 376

/**
 * 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.
 *
 */
377
function drupal_validate_form($form_id, $form) {
378
  global $form_values;
379 380 381 382 383
  static $validated_forms = array();

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

385
  // If the session token was set by drupal_prepare_form(), ensure that it
386
  // matches the current user's session.
387
  if (isset($form['#token'])) {
388
    if (!drupal_valid_token($form_values['form_token'], $form['#token'])) {
389
      // Setting this error will cause the form to fail validation.
390
      form_set_error('form_token', t('Validation error, please try again. If this error persists, please contact the site administrator.'));
391 392 393
    }
  }

394 395 396 397 398
  if (!$form['#programmed'] && !$form['#skip_duplicate_check'] && isset($_SESSION['last_submitted']['hash']) && $_SESSION['last_submitted']['hash'] == md5(serialize($form['form_id']['#post']))) {
    // This is a repeat submission.
    drupal_redirect_form(NULL, $_SESSION['last_submitted']['destination']);
  }

399
  _form_validate($form, $form_id);
400
  $validated_forms[$form_id] = TRUE;
401 402
}

403 404 405 406 407 408 409 410 411 412 413 414 415 416
/**
 * 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.
 *
 */
417
function drupal_submit_form($form_id, $form) {
418 419
  global $form_values;
  $default_args = array($form_id, &$form_values);
420 421
  $submitted = FALSE;
  $goto = NULL;
422

423
  if (isset($form['#submit'])) {
424 425
    foreach ($form['#submit'] as $function => $args) {
      if (function_exists($function)) {
426
        $args = array_merge($default_args, (array) $args);
427 428
        // Since we can only redirect to one page, only the last redirect
        // will work.
429 430 431 432 433 434 435 436 437 438 439 440 441
        if ($batch =& batch_get()) {
          // Some previous _submit callback has set a batch.
          // We store the call in a special 'control' batch set for execution
          // at the correct time during the batch processing workflow.
          $batch['sets'][] = array('form submit' => array($function, $args));
        }
        else {
          $redirect = call_user_func_array($function, $args);
          if ($batch =& batch_get()) {
            // The _submit callback has opened a batch: store the needed form info.
            $batch['form_redirect'] = isset($form['#redirect']) ? $form['#redirect'] : NULL;
          }
        }
442
        $submitted = TRUE;
443 444 445
        if (isset($redirect)) {
          $goto = $redirect;
        }
Dries's avatar
Dries committed
446 447
      }
    }
448
  }
449 450 451 452 453 454 455
  // Successful submit. Hash this form's POST and store the hash in the
  // session. We'll use this hash later whenever this user submits another
  // form to make sure no identical forms get submitted twice.
  if ($submitted && !$form['#skip_duplicate_check']) {
    $_SESSION['last_submitted'] = array('destination' => $goto, 'hash' => md5(serialize($form['form_id']['#post'])));
  }

456 457 458
  if (isset($goto)) {
    return $goto;
  }
459 460
}

461 462 463 464 465 466 467 468 469 470 471 472 473
/**
 * 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.
 *
 */
474
function drupal_render_form($form_id, &$form) {
475
  // Don't override #theme if someone already set it.
476

477
  if (!isset($form['#theme'])) {
478 479 480
    init_theme();
    $registry = theme_get_registry();
    if (isset($registry[$form_id])) {
481 482 483 484 485 486 487 488 489 490 491 492
      $form['#theme'] = $form_id;
    }
  }

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

493
  $output = drupal_render($form);
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
  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'];
  }
514 515 516 517 518 519 520 521
  if (!isset($goto) || ($goto !== FALSE)) {
    if (isset($goto)) {
      if (is_array($goto)) {
        call_user_func_array('drupal_goto', $goto);
      }
      else {
        drupal_goto($goto);
      }
522
    }
523
    drupal_goto($_GET['q']);
524 525 526
  }
}

527 528 529 530 531 532 533 534 535 536 537
/**
 * Performs validation on form elements. First ensures required fields are
 * completed, #maxlength is not exceeded, and selected options were in the
 * list of options given to the user. Then calls user-defined validators.
 *
 * @param $elements
 *   An associative array containing the structure of the form.
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 */
538
function _form_validate($elements, $form_id = NULL) {
539 540 541 542 543 544
  // Recurse through all children.
  foreach (element_children($elements) as $key) {
    if (isset($elements[$key]) && $elements[$key]) {
      _form_validate($elements[$key]);
    }
  }
545
  /* Validate the current input */
546
  if (!isset($elements['#validated']) || !$elements['#validated']) {
547
    if (isset($elements['#needs_validation'])) {
548 549 550 551
      // 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') {
552
        form_error($elements, t('!name field is required.', array('!name' => $elements['#title'])));
553
      }
554

555 556 557 558 559
      // Verify that the value is not longer than #maxlength.
      if (isset($elements['#maxlength']) && drupal_strlen($elements['#value']) > $elements['#maxlength']) {
        form_error($elements, t('!name cannot be longer than %max characters but is currently %length characters long.', array('!name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title'], '%max' => $elements['#maxlength'], '%length' => drupal_strlen($elements['#value']))));
      }

560 561
       // Add legal choice check if element has #options. Can be skipped, but
       // then you must validate your own element.
562 563 564 565 566 567 568 569 570 571 572 573
      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.'));
574
              watchdog('form', 'Illegal choice %choice in !name element.', array('%choice' => $v, '!name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title']), WATCHDOG_ERROR);
575
            }
576 577
          }
        }
578 579
        elseif (!isset($options[$elements['#value']])) {
          form_error($elements, t('An illegal choice has been detected. Please contact the site administrator.'));
580
          watchdog('form', 'Illegal choice %choice in %name element.', array('%choice' => $elements['#value'], '%name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title']), WATCHDOG_ERROR);
581
        }
582 583 584
      }
    }

585
    // Call user-defined validators.
Dries's avatar
Dries committed
586
    if (isset($elements['#validate'])) {
587 588
      foreach ($elements['#validate'] as $function => $args) {
        $args = array_merge(array($elements), $args);
589
        // For the full form we hand over a copy of $form_values.
590 591
        if (isset($form_id)) {
          $args = array_merge(array($form_id, $GLOBALS['form_values']), $args);
592
        }
593 594
        if (function_exists($function))  {
          call_user_func_array($function, $args);
595 596 597
        }
      }
    }
598
    $elements['#validated'] = TRUE;
599 600 601
  }
}

602 603 604 605 606
/**
 * 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.
 */
607
function form_set_error($name = NULL, $message = '') {
608 609 610
  static $form = array();
  if (isset($name) && !isset($form[$name])) {
    $form[$name] = $message;
611 612 613
    if ($message) {
      drupal_set_message($message, 'error');
    }
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
  }
  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];
  }
}

643 644 645
/**
 * Flag an element as having an error.
 */
646
function form_error(&$element, $message = '') {
647
  $element['#error'] = TRUE;
648
  form_set_error(implode('][', $element['#parents']), $message);
649 650 651
}

/**
652
 * Adds some required properties to each form element, which are used
653
 * internally in the form API. This function also automatically assigns
654 655 656 657
 * the value property from the $edit array, provided the element doesn't
 * already have an assigned value.
 *
 * @param $form_id
658 659
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
660 661
 * @param $form
 *   An associative array containing the structure of the form.
662
 */
663
function form_builder($form_id, $form) {
664
  global $form_values, $form_submitted, $form_button_counter;
665

666 667 668
  // Initialize as unprocessed.
  $form['#processed'] = FALSE;

669
  /* Use element defaults */
670
  if ((!empty($form['#type'])) && ($info = _element_info($form['#type']))) {
671
    // Overlay $info onto $form, retaining preexisting keys in $form.
672 673 674
    $form += $info;
  }

675
  if (isset($form['#input']) && $form['#input']) {
676
    if (!isset($form['#name'])) {
677 678
      $name = array_shift($form['#parents']);
      $form['#name'] = $name;
679
      if ($form['#type'] == 'file') {
680
        // To make it easier to handle $_FILES in file.inc, we place all
681
        // file fields in the 'files' array. Also, we do not support
682
        // nested file names.
683 684 685
        $form['#name'] = 'files['. $form['#name'] .']';
      }
      elseif (count($form['#parents'])) {
686 687 688
        $form['#name'] .= '['. implode('][', $form['#parents']) .']';
      }
      array_unshift($form['#parents'], $name);
689 690
    }
    if (!isset($form['#id'])) {
691
      $form['#id'] = form_clean_id('edit-'. implode('-', $form['#parents']));
692
    }
693

694 695 696 697
    if (isset($form['#disabled']) && $form['#disabled']) {
      $form['#attributes']['disabled'] = 'disabled';
    }

698
    if (!isset($form['#value']) && !array_key_exists('#value', $form)) {
699
      if (($form['#programmed']) || ((!isset($form['#access']) || $form['#access']) && isset($form['#post']) && (isset($form['#post']['form_id']) && $form['#post']['form_id'] == $form_id))) {
700
        $edit = $form['#post'];
701 702 703
        foreach ($form['#parents'] as $parent) {
          $edit = isset($edit[$parent]) ? $edit[$parent] : NULL;
        }
704 705 706 707 708 709 710 711 712 713 714 715 716 717
        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();
                }
718
              }
719 720
              elseif (isset($edit)) {
                $form['#value'] = $edit;
721
              }
722 723 724 725
              break;

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

733 734 735 736
            case 'token':
              $form['#value'] = (string)$edit;
              break;

737 738 739 740 741
            default:
              if (isset($edit)) {
                $form['#value'] = $edit;
              }
          }
742
          // Mark all posted values for validation.
743 744 745
          if ((isset($form['#value']) && $form['#value'] === $edit) || (isset($form['#required']) && $form['#required'])) {
            $form['#needs_validation'] = TRUE;
          }
746 747 748
        }
      }
      if (!isset($form['#value'])) {
749
        $function = $form['#type'] .'_value';
750 751 752 753
        if (function_exists($function)) {
          $function($form);
        }
        else {
754
          $form['#value'] = isset($form['#default_value']) ? $form['#default_value'] : '';
755
        }
756
      }
757
    }
758
    if (isset($form['#executes_submit_callback'])) {
759
      // Count submit and non-submit buttons.
760
      $form_button_counter[$form['#executes_submit_callback']]++;
761
      // See if a submit button was pressed.
762
      if (isset($form['#post'][$form['#name']]) && $form['#post'][$form['#name']] == $form['#value']) {
763
        $form_submitted = $form_submitted || $form['#executes_submit_callback'];
764

765 766 767
        // 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'.
768
        $form_values[$form['#name']] = $form['#value'];
769 770 771 772
      }
    }
  }

773 774
  // Allow for elements to expand to multiple elements, e.g., radios,
  // checkboxes and files.
775
  if (isset($form['#process']) && !$form['#processed']) {
776 777
    foreach ($form['#process'] as $process => $args) {
      if (function_exists($process)) {
778
        $args = array_merge(array($form), array(isset($edit) ? $edit : NULL), $args);
779
        $form = call_user_func_array($process, $args);
780 781
      }
    }
782
    $form['#processed'] = TRUE;
783 784
  }

785 786 787
  // 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.
788
  if (isset($form['#input']) && $form['#input']) {
789
    form_set_value($form, $form['#value']);
790 791
  }

792 793 794
  // We start off assuming all form elements are in the correct order.
  $form['#sorted'] = TRUE;

795
  // Recurse through all child elements.
796
  $count = 0;
797
  foreach (element_children($form) as $key) {
798 799
    $form[$key]['#post'] = $form['#post'];
    $form[$key]['#programmed'] = $form['#programmed'];
800
    // Don't squash an existing tree value.
801 802 803
    if (!isset($form[$key]['#tree'])) {
      $form[$key]['#tree'] = $form['#tree'];
    }
804

805
    // Deny access to child elements if parent is denied.
806 807 808 809
    if (isset($form['#access']) && !$form['#access']) {
      $form[$key]['#access'] = FALSE;
    }

810
    // Don't squash existing parents value.
811
    if (!isset($form[$key]['#parents'])) {
812 813
      // Check to see if a tree of child elements is present. If so,
      // continue down the tree if required.
814
      $form[$key]['#parents'] = $form[$key]['#tree'] && $form['#tree'] ? array_merge($form['#parents'], array($key)) : array($key);
815 816
    }

817
    // Assign a decimal placeholder weight to preserve original array order.
818 819 820
    if (!isset($form[$key]['#weight'])) {
      $form[$key]['#weight'] = $count/1000;
    }
821
    else {
822 823
      // If one of the child elements has a weight then we will need to sort
      // later.
824 825
      unset($form['#sorted']);
    }
826
    $form[$key] = form_builder($form_id, $form[$key]);
827 828 829
    $count++;
  }

830 831 832 833 834 835
  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);
      }
    }
836
    $form['#after_build_done'] = TRUE;
837
  }
838 839

  return $form;
840 841
}

842
/**
Dries's avatar
Dries committed
843
 * Use this function to make changes to form values in the form validate
844 845 846 847
 * 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
848
 * $form_values['foo']['bar'] to be 'baz'.
849 850 851 852 853 854 855 856 857 858 859 860 861 862
 *
 * @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().
 *
863 864
 * We iterate over $parents and create nested arrays for them
 * in $form_values if needed. Then we insert the value into
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
 * 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;
}

881 882 883
/**
 * Retrieve the default properties for the defined element type.
 */
884
function _element_info($type, $refresh = NULL) {
885
  static $cache;
886

887
  $basic_defaults = array(
888 889 890
    '#description' => NULL,
    '#attributes' => array(),
    '#required' => FALSE,
891
    '#tree' => FALSE,
892
    '#parents' => array()
893
  );
894
  if (!isset($cache) || $refresh) {
895 896 897
    $cache = array();
    foreach (module_implements('elements') as $module) {
      $elements = module_invoke($module, 'elements');
898
      if (isset($elements) && is_array($elements)) {
899
        $cache = array_merge_recursive($cache, $elements);
900 901 902 903
      }
    }
    if (sizeof($cache)) {
      foreach ($cache as $element_type => $info) {
904
        $cache[$element_type] = array_merge_recursive($basic_defaults, $info);
905 906 907 908 909 910 911
      }
    }
  }

  return $cache[$type];
}

912 913 914 915 916 917 918 919
function form_options_flatten($array, $reset = TRUE) {
  static $return;

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

  foreach ($array as $key => $value) {
920 921 922 923
    if (is_object($value)) {
      form_options_flatten($value->option, FALSE);
    }
    else if (is_array($value)) {
924 925 926 927 928 929 930 931 932 933
      form_options_flatten($value, FALSE);
    }
    else {
      $return[$key] = 1;
    }
  }

  return $return;
}

934 935 936 937 938
/**
 * Format a dropdown menu or scrolling selection box.
 *
 * @param $element
 *   An associative array containing the properties of the element.
939
 *   Properties used: title, value, options, description, extra, multiple, required
940 941 942 943 944 945 946 947 948
 * @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 = '';
949
  $size = $element['#size'] ? ' size="'. $element['#size'] .'"' : '';
950
  _form_set_class($element, array('form-select'));
951
  $multiple = $element['#multiple'];
952
  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>');
953 954 955 956 957 958
}

function form_select_options($element, $choices = NULL) {
  if (!isset($choices)) {
    $choices = $element['#options'];
  }
959
  // array_key_exists() accommodates the rare event where $element['#value'] is NULL.
960 961 962
  // isset() fails in this situation.
  $value_valid = isset($element['#value']) || array_key_exists('#value', $element);
  $value_is_array = is_array($element['#value']);
963 964
  $options = '';
  foreach ($choices as $key => $choice) {
965
    if (is_array($choice)) {
966 967 968
      $options .= '<optgroup label="'. $key .'">';
      $options .= form_select_options($element, $choice);
      $options .= '</optgroup>';
969
    }
970 971 972
    elseif (is_object($choice)) {
      $options .= form_select_options($element, $choice->option);
    }
973
    else {
974
      $key = (string)$key;
975
      if ($value_valid && (!$value_is_array && (string)$element['#value'] === $key || ($value_is_array && in_array($key, $element['#value'])))) {
976 977 978 979 980
        $selected = ' selected="selected"';
      }
      else {
        $selected = '';
      }
981
      $options .= '<option value="'. $key .'"'. $selected .'>'. check_plain($choice) .'</option>';
982 983
    }
  }
984
  return $options;
985 986
}

987
/**
988 989 990 991
 * Traverses a select element's #option array looking for any values
 * that hold the given key. Returns an array of indexes that match.
 *
 * This function is useful if you need to modify the options that are
992
 * already in a form element; for example, to remove choices which are
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
 * not valid because of additional filters imposed by another module.
 * One example might be altering the choices in a taxonomy selector.
 * To correctly handle the case of a multiple hierarchy taxonomy,
 * #options arrays can now hold an array of objects, instead of a
 * direct mapping of keys to labels, so that multiple choices in the
 * selector can have the same key (and label). This makes it difficult
 * to manipulate directly, which is why this helper function exists.
 *
 * This function does not support optgroups (when the elements of the
 * #options array are themselves arrays), and will return FALSE if
 * arrays are found. The caller must either flatten/restore or
 * manually do their manipulations in this case, since returning the
 * index is not sufficient, and supporting this would make the
 * "helper" too complicated and cumbersome to be of any help.
 *
 * As usual with functions that can return array() or FALSE, do not
 * forget to use === and !== if needed.
1010 1011
 *
 * @param $element
1012
 *   The select element to search.
1013 1014 1015
 * @param $key
 *   The key to look for.
 * @return
1016 1017
 *   An array of indexes that match the given $key. Array will be
 *   empty if no elements were found. FALSE if optgroups were found.
1018
 */
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
function form_get_options($element, $key) {
  $keys = array();
  foreach ($element['#options'] as $index => $choice) {
    if (is_array($choice)) {
      return FALSE;
    }
    else if (is_object($choice)) {
      if (isset($choice->option[$key])) {
        $keys[] = $index;
      }
    }
    else if ($index == $key) {
      $keys[] = $index;
1032 1033
    }
  }
1034
  return $keys;
1035 1036
}

1037 1038 1039 1040 1041
/**
 * Format a group of form items.
 *
 * @param $element
 *   An associative array containing the properties of the element.
1042
 *   Properties used: attributes, title, value, description, children, collapsible, collapsed
1043 1044 1045 1046
 * @return
 *   A themed HTML string representing the form item group.
 */
function theme_fieldset($element) {
1047
  if ($element['#collapsible']) {
1048 1049
    drupal_add_js('misc/collapse.js');

1050 1051 1052 1053
    if (!isset($element['#attributes']['class'])) {
      $element['#attributes']['class'] = '';
    }

1054 1055 1056
    $element['#attributes']['class'] .= ' collapsible';
    if ($element['#collapsed']) {
     $element['#attributes']['class'] .= ' collapsed';
1057 1058 1059
    }
  }

1060
  return '<fieldset'. drupal_attributes($element['#attributes']) .'>'. ($element['#title'] ? '<legend>'. $element['#title'] .'</legend>' : '') . (isset($element['#description']) && $element['#description'] ? '<div class="description">'. $element['#description'] .'</div>' : '') . (!empty($element['#children']) ? $element['#children'] : '') . $element['#value'] ."</fieldset>\n";
1061 1062 1063 1064 1065 1066 1067
}

/**
 * Format a radio button.
 *
 * @param $element
 *   An associative array containing the properties of the element.
1068
 *   Properties used: required, return_value, value, attributes, title, description
1069 1070 1071 1072
 * @return
 *   A themed HTML string representing the form item group.
 */
function theme_radio($element) {
1073
  _form_set_class($element, array('form-radio'));
1074
  $output = '<input type="radio" ';
1075
  $output .= 'name="'. $element['#name'] .'" ';
1076 1077 1078 1079 1080
  $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>';
1081
  }
1082 1083 1084

  unset($element['#title']);
  return theme('form_element', $element, $output);
1085 1086 1087 1088 1089 1090 1091
}

/**
 * Format a set of radio buttons.
 *
 * @param $element
 *   An associative array containing the properties of the element.
1092
 *   Properties used: title, value, options, description, required and attributes.
1093 1094 1095 1096
 * @return
 *   A themed HTML string representing the radio button set.
 */
function theme_radios($element) {
1097 1098 1099 1100
  $class = 'form-radios';
  if (isset($element['#attributes']['class'])) {
    $class .= ' '. $element['#attributes']['class'];
  }
1101
  $element['#children'] = '<div class="'. $class .'">'. (!empty($element['#children']) ? $element['#children'] : '') .'</div>';
1102
  if ($element['#title'] || $element['#description']) {
1103 1104
    unset($element['#id']);
    return theme('form_element', $element, $element['#children']);
1105 1106
  }
  else {
1107
    return $element['#children'];
1108 1109 1110
  }
}

1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
/**
 * 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
1121
  return theme('form_element', $element, $element['#children']);
1122 1123
}

1124 1125 1126 1127
/*
 * Expand a password_confirm field into two text boxes.
 */
function expand_password_confirm($element) {
Dries's avatar
Dries committed
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
  $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'],
  );
1138 1139 1140
  $element['#validate'] = array('password_confirm_validate' => array());
  $element['#tree'] = TRUE;

1141 1142 1143 1144
  if (isset($element['#size'])) {
    $element['pass1']['#size'] = $element['pass2']['#size'] = $element['#size'];
  }

1145 1146 1147
  return $element;
}

1148
/**
1149
 * Validate password_confirm element.
1150
 */
1151
function password_confirm_validate($form) {
1152 1153
  $pass1 = trim($form['pass1']['#value']);
  if (!empty($pass1)) {
1154
    $pass2 = trim($form['pass2']['#value']);
1155
    if ($pass1 != $pass2) {
1156
      form_error($form, t('The specified passwords do not match.'));
1157
    }
1158
  }
1159
  elseif ($form['#required'] && !empty($form['#post'])) {
1160
    form_error($form, t('Password field is required.'));
1161
  }
1162

1163 1164 1165 1166 1167 1168
  // 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);

1169 1170 1171
  return $form;
}

1172
/**
1173
 * Format a date selection element.
1174 1175 1176
 *
 * @param $element
 *   An associative array containing the properties of the element.
1177
 *   Properties used: title, value, options, description, required and attributes.
1178
 * @return
1179
 *   A themed HTML string representing the date selection boxes.
1180 1181
 */
function theme_date($element) {
1182
  return theme('form_element', $element, '<div class="container-inline">'. $element['#children'] .'</div>');
1183 1184 1185
}

/**
1186
 * Roll out a single date element.
1187 1188 1189
 */
function expand_date($element) {
  // Default to current date
1190
  if (empty($element['#value'])) {
1191
    $element['#value'] = array('day' => format_date(time(), 'custom', 'j'),
1192 1193 1194