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

4
/**
5 6 7 8 9 10
 * @defgroup forms Form builder functions
 * @{
 * Functions that build an abstract representation of a HTML form.
 *
 * All modules should declare their form builder functions to be in this
 * group and each builder function should reference its validate and submit
11
 * functions using \@see. Conversely, validate and submit functions should
12
 * reference the form builder function using \@see. For examples, of this see
13
 * system_modules_uninstall() or user_pass(), the latter of which has the
14 15 16 17 18 19 20 21 22 23 24
 * following in its doxygen documentation:
 *
 * \@ingroup forms
 * \@see user_pass_validate().
 * \@see user_pass_submit().
 *
 * @} End of "defgroup forms".
 */

/**
 * @defgroup form_api Form generation
25
 * @{
26
 * Functions to enable the processing and display of HTML forms.
27
 *
28 29 30 31 32 33 34
 * 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:
 *
35
 * @code
36
 * // Display the user registration form.
37
 * $output = drupal_get_form('user_register');
38
 * @endcode
39 40
 *
 * Forms can also be built and submitted programmatically without any user input
41
 * using the drupal_execute() function.
42 43
 *
 * For information on the format of the structured arrays used to define forms,
44
 * and more detailed explanations of the Form API workflow, see the
45 46
 * @link http://api.drupal.org/api/file/developer/topics/forms_api_reference.html reference @endlink
 * and the @link http://api.drupal.org/api/file/developer/topics/forms_api.html quickstart guide. @endlink
47 48 49
 */

/**
50
 * Wrapper for drupal_build_form() for use when $form_state is not needed.
51 52
 *
 * @param $form_id
53 54 55 56 57 58
 *   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 constructor function. Examples may be found in node_forms(),
 *   search_forms(), and user_forms().
59
 * @param ...
60
 *   Any additional arguments are passed on to the functions called by
61 62 63
 *   drupal_get_form(), including the unique form constructor function. For
 *   example, the node_edit form requires that a node object is passed in here
 *   when it is called.
64 65
 * @return
 *   The rendered form.
66 67
 *
 * @see drupal_build_form()
68 69
 */
function drupal_get_form($form_id) {
70
  $form_state = array();
71 72

  $args = func_get_args();
73 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 103 104 105 106 107 108 109 110 111 112 113 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
  // Remove $form_id from the arguments.
  array_shift($args);
  $form_state['args'] = $args;

  return drupal_build_form($form_id, $form_state);
}

/**
 * Build, render, and process a form based on a form id.
 *
 * The form may also be retrieved from the cache if the form was built in a
 * previous page-load. The form is then passed on for processing, validation
 * and submission if there is proper input, and then rendered for display
 * if necessary.
 *
 * @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 constructor function. Examples may be found in node_forms(),
 *   search_forms(), and user_forms().
 * @param &$form_state
 *   An array which stores information about the form. This is passed as a
 *   reference so that the caller can use it to examine what the form changed
 *   when the form submission process is complete.
 *
 *   The following parameters may be set in $form_state to affect how the form
 *   is rendered:
 *   - args: An array of arguments to pass to the form builder.
 *   - input: An array of input that corresponds to $_POST or $_GET, depending
 *     on the 'method' chosen (see below).
 *   - method: The HTTP form method to use for finding the input for this form.
 *     May be 'post' or 'get'. Defaults to 'post'. Note that 'get' method
 *     forms do not use form ids so are always considered to be submitted, which
 *     can have unexpected effects. The 'get' method should only be used on
 *     forms that do not change data, as that is exclusively the domain of post.
 *   - rerender: May be set to FALSE to force the form to not be re-rendered
 *     after submit. Ordinarily, forms are re-rendered after a successful submit
 *     if there is no redirect. However, many forms may want to perform some
 *     other action, but not necessarily re-render the form. This is
 *     particularly true when using AHAH or AJAX where some data may be returned
 *     to the calling JavaScript. Note that a form validation error will always
 *     re-render the form.
 *   - no_redirect: If set to TRUE the form will NOT perform a drupal_goto(),
 *     even if a redirect is set.
 *   - always_process: If TRUE and the method is GET, a form_id is not
 *     necessary. This should only be used on RESTful GET forms that do NOT
 *     write data, as this could lead to security issues. It is useful so that
 *     searches do not need to have a form_id in their query arguments to
 *     trigger the search.
 *   - must_validate: Ordinarily, a form is only validated once but there are
 *     times when a form is resubmitted internally and should be validated
 *     again. Setting this to TRUE will force that to happen. This is most
 *     likely to occur during AHAH or AJAX operations.
 * @return
 *   The rendered form or NULL, depending upon the $form_state flags that were set.
 */
function drupal_build_form($form_id, &$form_state) {
  // Ensure some defaults; if already set they will not be overridden.
  $form_state += form_state_defaults();

  if (!isset($form_state['input'])) {
    $form_state['input'] = $form_state['method'] == 'get' ? $_GET : $_POST;
  }

139
  $cacheable = FALSE;
140 141 142 143 144 145 146

  if (isset($_SESSION['batch_form_state'])) {
    // We've been redirected here after a batch processing : the form has
    // already been processed, so we grab the post-process $form_state value
    // and move on to form display. See _batch_finished() function.
    $form_state = $_SESSION['batch_form_state'];
    unset($_SESSION['batch_form_state']);
147 148
  }
  else {
149
    // If the incoming input contains a form_build_id, we'll check the
150 151 152 153
    // cache for a copy of the form in question. If it's there, we don't
    // have to rebuild the form to proceed. In addition, if there is stored
    // form_state data from a previous step, we'll retrieve it so it can
    // be passed on to the form processing code.
154 155
    if (isset($form_state['input']['form_id']) && $form_state['input']['form_id'] == $form_id && !empty($form_state['input']['form_build_id'])) {
      $form = form_get_cache($form_state['input']['form_build_id'], $form_state);
156 157
    }

158 159 160 161
    // If the previous bit of code didn't result in a populated $form
    // object, we're hitting the form for the first time and we need
    // to build it from scratch.
    if (!isset($form)) {
162
      $form = drupal_retrieve_form($form_id, $form_state);
163
      $form_build_id = 'form-' . md5(uniqid(mt_rand(), TRUE));
164
      $form['#build_id'] = $form_build_id;
165 166 167 168 169 170

      // Fix the form method, if it is 'get' in $form_state, but not in $form.
      if ($form_state['method'] == 'get' && !isset($form['#method'])) {
        $form['#method'] = 'get';
      }

171
      drupal_prepare_form($form_id, $form, $form_state);
172 173 174 175
      // Store a copy of the unprocessed form for caching and indicate that it
      // is cacheable if #cache will be set.
      $original_form = $form;
      $cacheable = TRUE;
176
    }
177

178 179 180 181 182 183
    // Now that we know we have a form, we'll process it (validating,
    // submitting, and handling the results returned by its submission
    // handlers. Submit handlers accumulate data in the form_state by
    // altering the $form_state variable, which is passed into them by
    // reference.
    drupal_process_form($form_id, $form, $form_state);
184 185 186 187 188 189
    // If we were told not to redirect, but not told to re-render, return here.
    if (!empty($form_state['executed']) && empty($form_state['rerender'])) {
      return;
    }

    if ($cacheable && !empty($form['#cache']) && empty($form['#no_cache'])) {
190
      // Caching is done past drupal_process_form so #process callbacks can
191 192
      // set #cache.
      form_set_cache($form_build_id, $original_form, $form_state);
193
    }
194 195 196 197 198 199 200 201 202
  }

  // Most simple, single-step forms will be finished by this point --
  // drupal_process_form() usually redirects to another page (or to
  // a 'fresh' copy of the form) once processing is complete. If one
  // of the form's handlers has set $form_state['redirect'] to FALSE,
  // the form will simply be re-rendered with the values still in its
  // fields.
  //
203 204 205 206 207 208 209 210
  // If $form_state['storage'] or $form_state['rebuild'] has been set
  // and the form has been submitted, we know that we're in a complex
  // multi-part process of some sort and the form's workflow is NOT
  // complete. We need to construct a fresh copy of the form, passing
  // in the latest $form_state in addition to any other variables passed
  // into drupal_get_form().

  if ((!empty($form_state['storage']) || !empty($form_state['rebuild'])) && !empty($form_state['submitted']) && !form_get_errors()) {
211
    $form = drupal_rebuild_form($form_id, $form_state);
212 213
  }

214 215 216 217
  // If we haven't redirected to a new location by now, we want to
  // render whatever form array is currently in hand.
  return drupal_render_form($form_id, $form);
}
218

219 220 221 222 223 224 225 226 227 228
/**
 * Retrieve default values for the $form_state array.
 */
function form_state_defaults() {
  return array(
    'storage' => NULL,
    'submitted' => FALSE,
    'method' => 'post',
    'rerender' => TRUE,
    'programmed' => FALSE,
229
    'groups' => array(),
230 231 232
  );
}

233 234 235 236 237 238 239 240 241 242 243 244 245 246
/**
 * Retrieves a form, caches it and processes it with an empty $_POST.
 *
 * This function clears $_POST and passes the empty $_POST to the form_builder.
 * To preserve some parts from $_POST, pass them in $form_state.
 *
 * If your AHAH callback simulates the pressing of a button, then your AHAH
 * callback will need to do the same as what drupal_get_form would do when the
 * button is pressed: get the form from the cache, run drupal_process_form over
 * it and then if it needs rebuild, run drupal_rebuild_form over it. Then send
 * back a part of the returned form.
 * $form_state['clicked_button']['#array_parents'] will help you to find which
 * part.
 *
247 248 249
 * When getting a form from the cache, the $form_id must be shifted off from
 * $form['#args'], so the resulting array can be given to $form_state['args'].
 *
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
 * @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 constructor function. Examples
 *   may be found in node_forms(), search_forms(), and user_forms().
 * @param $form_state
 *   A keyed array containing the current state of the form. Most
 *   important is the $form_state['storage'] collection.
 * @param $form_build_id
 *   If the AHAH callback calling this function only alters part of the form,
 *   then pass in the existing form_build_id so we can re-cache with the same
 *   csid.
 * @return
 *   The newly built form.
 */
267 268
function drupal_rebuild_form($form_id, &$form_state, $form_build_id = NULL) {
  $form = drupal_retrieve_form($form_id, $form_state);
269 270 271

  if (!isset($form_build_id)) {
    // We need a new build_id for the new version of the form.
272
    $form_build_id = 'form-' . md5(mt_rand());
273 274 275 276
  }
  $form['#build_id'] = $form_build_id;
  drupal_prepare_form($form_id, $form, $form_state);

277 278 279 280 281 282
  if (empty($form['#no_cache'])) {
    // We cache the form structure so it can be retrieved later for validation.
    // If $form_state['storage'] is populated, we also cache it so that it can
    // be used to resume complex multi-step processes.
    form_set_cache($form_build_id, $form, $form_state);
  }
283 284 285 286

  // Clear out all post data, as we don't want the previous step's
  // data to pollute this one and trigger validate/submit handling,
  // then process the form for rendering.
287 288
  $form_state['input'] = array();

289 290 291 292
  // Also clear out all group associations as these might be different
  // when rerendering the form.
  $form_state['groups'] = array();

293 294 295
  // Do not call drupal_process_form(), since it would prevent the rebuilt form
  // to submit.
  $form = form_builder($form_id, $form, $form_state);
296 297 298
  return $form;
}

299 300 301 302
/**
 * Fetch a form from cache.
 */
function form_get_cache($form_build_id, &$form_state) {
303
  if ($cached = cache_get('form_' . $form_build_id, 'cache_form')) {
304
    $form = $cached->data;
305 306 307 308 309 310
    global $user;
    if ((isset($form['#cache_token']) && drupal_valid_token($form['#cache_token'])) || (!isset($form['#cache_token']) && !$user->uid)) {
      if ($cached = cache_get('storage_' . $form_build_id, 'cache_form')) {
        $form_state['storage'] = $cached->data;
      }
      return $form;
311 312 313 314 315 316 317 318
    }
  }
}

/**
 * Store a form in the cache
 */
function form_set_cache($form_build_id, $form, $form_state) {
319 320
  // 6 hours cache life time for forms should be plenty.
  $expire = 21600;
321 322 323 324
  global $user;
  if ($user->uid) {
    $form['#cache_token'] = drupal_get_token();
  }
325
  cache_set('form_' . $form_build_id, $form, 'cache_form', REQUEST_TIME + $expire);
326
  if (!empty($form_state['storage'])) {
327
    cache_set('storage_' . $form_build_id, $form_state['storage'], 'cache_form', REQUEST_TIME + $expire);
328 329 330
  }
}

331
/**
332
 * Retrieves a form using a form_id, populates it with $form_state['values'],
333 334 335 336 337 338 339 340
 * 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
341
 *   different $form_id values to the proper form constructor function. Examples
342
 *   may be found in node_forms(), search_forms(), and user_forms().
343 344 345 346 347
 * @param $form_state
 *   A keyed array containing the current state of the form. Most
 *   important is the $form_state['values'] collection, a tree of data
 *   used to simulate the incoming $_POST information from a user's
 *   form submission.
348
 * @param ...
349 350 351 352
 *   Any additional arguments are passed on to the functions called by
 *   drupal_execute(), including the unique form constructor function.
 *   For example, the node_edit form requires that a node object be passed
 *   in here when it is called.
353 354 355
 * For example:
 *
 * // register a new user
356 357 358 359
 * $form_state = array();
 * $form_state['values']['name'] = 'robo-user';
 * $form_state['values']['mail'] = 'robouser@example.com';
 * $form_state['values']['pass'] = 'password';
360
 * $form_state['values']['op'] = t('Create new account');
361
 * drupal_execute('user_register', $form_state);
362 363
 *
 * // Create a new node
364
 * $form_state = array();
365
 * module_load_include('inc', 'node', 'node.pages');
366
 * $node = array('type' => 'story');
367 368 369
 * $form_state['values']['title'] = 'My node';
 * $form_state['values']['body'] = 'This is the body text!';
 * $form_state['values']['name'] = 'robo-user';
370
 * $form_state['values']['op'] = t('Save');
371
 * drupal_execute('story_node_form', $form_state, (object)$node);
372
 */
373
function drupal_execute($form_id, &$form_state) {
374 375 376 377 378 379
  if (!isset($form_state['args'])) {
    $args = func_get_args();
    array_shift($args);
    array_shift($args);
    $form_state['args'] = $args;
  }
Dries's avatar
Dries committed
380

381 382 383 384 385
  $form = drupal_retrieve_form($form_id, $form_state);
  $form_state['input'] = $form_state['values'];
  $form_state['programmed'] = TRUE;
  // Merge in default values.
  $form_state += form_state_defaults();
386

387 388
  drupal_prepare_form($form_id, $form, $form_state);
  drupal_process_form($form_id, $form, $form_state);
389 390
}

391 392 393 394 395 396 397 398
/**
 * 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
399
 *   different $form_id values to the proper form constructor function.
400 401
 * @param $form_state
 *   A keyed array containing the current state of the form.
402
 * @param ...
403 404 405 406 407 408
 *   Any additional arguments needed by the unique form constructor
 *   function. Generally, these are any arguments passed into the
 *   drupal_get_form() or drupal_execute() functions after the first
 *   argument. If a module implements hook_forms(), it can examine
 *   these additional arguments and conditionally return different
 *   builder functions as well.
409
 */
410
function drupal_retrieve_form($form_id, &$form_state) {
411 412
  static $forms;

413
  // We save two copies of the incoming arguments: one for modules to use
414
  // when mapping form ids to constructor functions, and another to pass to
415 416
  // the constructor function itself.
  $args = $form_state['args'];
417 418 419

  // 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.
420
  if (!drupal_function_exists($form_id)) {
421
    // In cases where many form_ids need to share a central constructor function,
422
    // such as the node editing form, modules can implement hook_forms(). It
423
    // maps one or more form_ids to the correct constructor functions.
424 425 426 427 428 429 430 431 432
    //
    // 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])) {
433
      $forms = module_invoke_all('forms', $form_id, $args);
434 435 436 437 438 439 440
    }
    $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'];
441
      drupal_function_exists($callback);
442 443
    }
  }
444

445
  $args = array_merge(array(&$form_state), $args);
446

447 448
  // If $callback was returned by a hook_forms() implementation, call it.
  // Otherwise, call the function named after the form id.
449
  $form = call_user_func_array(isset($callback) ? $callback : $form_id, $args);
450 451
  $form['#form_id'] = $form_id;
  $form['#args'] = $form_state['args'];
452
  return $form;
453 454 455 456 457 458 459 460
}

/**
 * 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.
461 462
 * @param $form
 *   An associative array containing the structure of the form.
463 464
 * @param $form_state
 *   A keyed array containing the current state of the form. This
Dries's avatar
Dries committed
465
 *   includes the current persistent storage data for the form, and
466 467 468
 *   any data passed along by earlier steps when displaying a
 *   multi-step form. Additional information, like the sanitized $_POST
 *   data, is also accumulated here.
469
 */
470 471 472
function drupal_process_form($form_id, &$form, &$form_state) {
  $form_state['values'] = array();

473 474 475 476 477 478 479 480 481 482 483 484 485
  // With $_GET, these forms are always submitted if requested.
  if ($form_state['method'] == 'get' && !empty($form_state['always_process'])) {
    if (!isset($form_state['input']['form_build_id'])) {
      $form_state['input']['form_build_id'] = $form['#build_id'];
    }
    if (!isset($form_state['input']['form_id'])) {
      $form_state['input']['form_id'] = $form_id;
    }
    if (!isset($form_state['input']['form_token']) && isset($form['#token'])) {
      $form_state['input']['form_token'] = drupal_get_token($form['#token']);
    }
  }

486
  $form = form_builder($form_id, $form, $form_state);
487 488
  // Only process the form if it is programmed or the form_id coming
  // from the POST data is set and matches the current form_id.
489
  if ((!empty($form_state['programmed'])) || (!empty($form_state['input']) && (isset($form_state['input']['form_id']) && ($form_state['input']['form_id'] == $form_id)))) {
490 491
    drupal_validate_form($form_id, $form, $form_state);

492 493
    // form_clean_id() maintains a cache of element IDs it has seen,
    // so it can prevent duplicates. We want to be sure we reset that
494
    // cache when a form is processed, so scenarios that result in
495 496 497 498
    // the form being built behind the scenes and again for the
    // browser don't increment all the element IDs needlessly.
    form_clean_id(NULL, TRUE);

499 500 501 502 503 504 505
    if ((!empty($form_state['submitted'])) && !form_get_errors() && empty($form_state['rebuild'])) {
      $form_state['redirect'] = NULL;
      form_execute_handlers('submit', $form, $form_state);

      // We'll clear out the cached copies of the form and its stored data
      // here, as we've finished with them. The in-memory copies are still
      // here, though.
506
      if (!empty($form_state['values']['form_build_id'])) {
507 508
        cache_clear_all('form_' . $form_state['values']['form_build_id'], 'cache_form');
        cache_clear_all('storage_' . $form_state['values']['form_build_id'], 'cache_form');
509 510 511
      }

      // If batches were set in the submit handlers, we process them now,
512 513 514 515
      // possibly ending execution. We make sure we do not react to the batch
      // that is already being processed (if a batch operation performs a
      // drupal_execute).
      if ($batch =& batch_get() && !isset($batch['current_set'])) {
516
        // The batch uses its own copies of $form and $form_state for
517
        // late execution of submit handlers and post-batch redirection.
518 519
        $batch['form'] = $form;
        $batch['form_state'] = $form_state;
520
        $batch['progressive'] = !$form_state['programmed'];
521
        batch_process();
522 523 524 525
        // Execution continues only for programmatic forms.
        // For 'regular' forms, we get redirected to the batch processing
        // page. Form redirection will be handled in _batch_finished(),
        // after the batch is processed.
526
      }
527 528 529 530 531 532 533 534

      // If no submit handlers have populated the $form_state['storage']
      // bundle, and the $form_state['rebuild'] flag has not been set,
      // we're finished and should redirect to a new destination page
      // if one has been set (and a fresh, unpopulated copy of the form
      // if one hasn't). If the form was called by drupal_execute(),
      // however, we'll skip this and let the calling function examine
      // the resulting $form_state bundle itself.
535 536 537 538 539 540 541
      if (!$form_state['programmed'] && empty($form_state['rebuild']) && empty($form_state['storage'])) {
        if (!empty($form_state['no_redirect'])) {
          $form_state['executed'] = TRUE;
        }
        else {
          drupal_redirect_form($form, $form_state['redirect']);
        }
542
      }
543 544 545 546 547 548 549 550 551 552 553 554 555 556
    }
  }
}

/**
 * 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.
557 558 559
 * @param $form_state
 *   A keyed array containing the current state of the form. Passed
 *   in here so that hook_form_alter() calls can use it, as well.
560
 */
561
function drupal_prepare_form($form_id, &$form, &$form_state) {
562 563
  global $user;

564
  $form['#type'] = 'form';
565
  $form_state['programmed'] = isset($form_state['programmed']) ? $form_state['programmed'] : FALSE;
566

567 568 569 570 571 572 573 574 575
  if (isset($form['#build_id'])) {
    $form['form_build_id'] = array(
      '#type' => 'hidden',
      '#value' => $form['#build_id'],
      '#id' => $form['#build_id'],
      '#name' => 'form_build_id',
    );
  }

576 577 578 579
  // 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.
580
  if (isset($form['#token'])) {
581
    if ($form['#token'] === FALSE || $user->uid == 0 || $form_state['programmed']) {
582
      unset($form['#token']);
583
    }
584
    else {
585
      $form['form_token'] = array('#type' => 'token', '#default_value' => drupal_get_token($form['#token']));
586
    }
587
  }
588
  elseif (isset($user->uid) && $user->uid && !$form_state['programmed']) {
589 590
    $form['#token'] = $form_id;
    $form['form_token'] = array(
591
      '#id' => form_clean_id('edit-' . $form_id . '-form-token'),
592 593 594 595 596
      '#type' => 'token',
      '#default_value' => drupal_get_token($form['#token']),
    );
  }

597
  if (isset($form_id)) {
598 599 600 601 602
    $form['form_id'] = array(
      '#type' => 'hidden',
      '#value' => $form_id,
      '#id' => form_clean_id("edit-$form_id"),
    );
603
  }
604
  if (!isset($form['#id'])) {
605
    $form['#id'] = form_clean_id($form_id);
606
  }
607

608
  $form += element_info('form');
609
  $form += array('#tree' => FALSE, '#parents' => array());
610

Dries's avatar
Dries committed
611
  if (!isset($form['#validate'])) {
612
    if (drupal_function_exists($form_id . '_validate')) {
613
      $form['#validate'] = array($form_id . '_validate');
Dries's avatar
Dries committed
614 615 616
    }
  }

617
  if (!isset($form['#submit'])) {
618
    if (drupal_function_exists($form_id . '_submit')) {
619
      // We set submit here so that it can be altered.
620
      $form['#submit'] = array($form_id . '_submit');
Dries's avatar
Dries committed
621 622 623
    }
  }

624 625 626 627 628 629 630 631
  // Normally, we would call drupal_alter($form_id, $form, $form_state).
  // However, drupal_alter() normally supports just one byref parameter. Using
  // the __drupal_alter_by_ref key, we can store any additional parameters
  // that need to be altered, and they'll be split out into additional params
  // for the hook_form_alter() implementations.
  // @todo: Remove this in Drupal 7.
  $data = &$form;
  $data['__drupal_alter_by_ref'] = array(&$form_state);
632
  drupal_alter('form_' . $form_id, $data);
633 634 635 636 637

  // __drupal_alter_by_ref is unset in the drupal_alter() function, we need
  // to repopulate it to ensure both calls get the data.
  $data['__drupal_alter_by_ref'] = array(&$form_state);
  drupal_alter('form', $data, $form_id);
638 639
}

640 641

/**
642
 * Validates user-submitted form data from the $form_state using
643 644 645 646 647 648 649
 * 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.
650 651 652 653 654 655 656 657 658 659
 * @param $form_state
 *   A keyed array containing the current state of the form. The current
 *   user-submitted data is stored in $form_state['values'], though
 *   form validation functions are passed an explicit copy of the
 *   values for the sake of simplicity. Validation handlers can also
 *   $form_state to pass information on to submit handlers. For example:
 *     $form_state['data_for_submision'] = $data;
 *   This technique is useful when validation requires file parsing,
 *   web service requests, or other expensive requests that should
 *   not be repeated in the submission step.
660
 */
661
function drupal_validate_form($form_id, $form, &$form_state) {
662 663
  static $validated_forms = array();

664
  if (isset($validated_forms[$form_id]) && empty($form_state['must_validate'])) {
665 666
    return;
  }
667

668
  // If the session token was set by drupal_prepare_form(), ensure that it
669
  // matches the current user's session.
670
  if (isset($form['#token'])) {
671
    if (!drupal_valid_token($form_state['values']['form_token'], $form['#token'])) {
672
      // Setting this error will cause the form to fail validation.
673
      form_set_error('form_token', t('Validation error, please try again. If this error persists, please contact the site administrator.'));
674 675 676
    }
  }

677
  _form_validate($form, $form_state, $form_id);
678
  $validated_forms[$form_id] = TRUE;
679 680
}

681 682 683 684 685 686 687 688 689
/**
 * 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
690
 *   A string containing the themed HTML.
691
 */
692
function drupal_render_form($form_id, &$form) {
693 694
  // Don't override #theme if someone already set it.
  if (!isset($form['#theme'])) {
695 696 697
    init_theme();
    $registry = theme_get_registry();
    if (isset($registry[$form_id])) {
698 699 700 701
      $form['#theme'] = $form_id;
    }
  }

702
  $output = drupal_render($form);
703 704 705 706 707 708 709 710 711
  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
712
 *   An optional value containing the destination path to redirect
713 714 715
 *   to if none is specified by the form.
 */
function drupal_redirect_form($form, $redirect = NULL) {
716
  $goto = NULL;
717 718 719
  if (isset($redirect)) {
    $goto = $redirect;
  }
720
  if ($goto !== FALSE && isset($form['#redirect'])) {
721 722
    $goto = $form['#redirect'];
  }
723 724
  if (!isset($goto) || ($goto !== FALSE)) {
    if (isset($goto)) {
725 726 727 728 729 730
      // Remove any fake destination set by drupal_not_found() or
      // drupal_access_denied() so that we can properly redirect from those
      // pages.
      if (isset($_REQUEST['destination']) && $_REQUEST['destination'] == $_GET['q']) {
        unset($_REQUEST['destination']);
      }
731 732 733 734 735 736 737 738 739
      if (is_array($goto)) {
        call_user_func_array('drupal_goto', $goto);
      }
      else {
        drupal_goto($goto);
      }
    }
    drupal_goto($_GET['q']);
  }
740 741
}

742 743 744 745 746 747 748
/**
 * 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.
749 750 751 752 753 754 755 756 757 758
 * @param $form_state
 *   A keyed array containing the current state of the form. The current
 *   user-submitted data is stored in $form_state['values'], though
 *   form validation functions are passed an explicit copy of the
 *   values for the sake of simplicity. Validation handlers can also
 *   $form_state to pass information on to submit handlers. For example:
 *     $form_state['data_for_submision'] = $data;
 *   This technique is useful when validation requires file parsing,
 *   web service requests, or other expensive requests that should
 *   not be repeated in the submission step.
759 760 761 762
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 */
763
function _form_validate($elements, &$form_state, $form_id = NULL) {
764 765
  static $complete_form;

766 767
  // Also used in the installer, pre-database setup.
  $t = get_t();
768

769 770 771
  // Recurse through all children.
  foreach (element_children($elements) as $key) {
    if (isset($elements[$key]) && $elements[$key]) {
772
      _form_validate($elements[$key], $form_state);
773 774
    }
  }
775
  // Validate the current input.
776
  if (!isset($elements['#validated']) || !$elements['#validated']) {
777
    if (isset($elements['#needs_validation'])) {
778 779 780 781 782
      // Make sure a value is passed when the field is required.
      // A simple call to empty() will not cut it here as some fields, like
      // checkboxes, can return a valid value of '0'. Instead, check the
      // length if it's a string, and the item count if it's an array.
      if ($elements['#required'] && (!count($elements['#value']) || (is_string($elements['#value']) && strlen(trim($elements['#value'])) == 0))) {
783
        form_error($elements, $t('!name field is required.', array('!name' => $elements['#title'])));
784
      }
785

786 787
      // Verify that the value is not longer than #maxlength.
      if (isset($elements['#maxlength']) && drupal_strlen($elements['#value']) > $elements['#maxlength']) {
788
        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']))));
789 790
      }

791
      if (isset($elements['#options']) && isset($elements['#value'])) {
792 793 794 795 796 797 798 799 800 801
        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])) {
802
              form_error($elements, $t('An illegal choice has been detected. Please contact the site administrator.'));
803
              watchdog('form', 'Illegal choice %choice in !name element.', array('%choice' => $v, '!name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title']), WATCHDOG_ERROR);
804
            }
805 806
          }
        }
807
        elseif (!isset($options[$elements['#value']])) {
808
          form_error($elements, $t('An illegal choice has been detected. Please contact the site administrator.'));
809
          watchdog('form', 'Illegal choice %choice in %name element.', array('%choice' => $elements['#value'], '%name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title']), WATCHDOG_ERROR);
810
        }
811 812 813
      }
    }

814 815 816
    // Call user-defined form level validators and store a copy of the full
    // form so that element-specific validators can examine the entire structure
    // if necessary.
817 818
    if (isset($form_id)) {
      form_execute_handlers('validate', $elements, $form_state);
819
      $complete_form = $elements;
820 821 822 823 824
    }
    // Call any element-specific validators. These must act on the element
    // #value data.
    elseif (isset($elements['#element_validate'])) {
      foreach ($elements['#element_validate'] as $function) {
825
        if (drupal_function_exists($function))  {
826
          $function($elements, $form_state, $complete_form);
827 828 829
        }
      }
    }
830
    $elements['#validated'] = TRUE;
831 832 833
  }
}

834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
/**
 * A helper function used to execute custom validation and submission
 * handlers for a given form. Button-specific handlers are checked
 * first. If none exist, the function falls back to form-level handlers.
 *
 * @param $type
 *   The type of handler to execute. 'validate' or 'submit' are the
 *   defaults used by Form API.
 * @param $form
 *   An associative array containing the structure of the form.
 * @param $form_state
 *   A keyed array containing the current state of the form. If the user
 *   submitted the form by clicking a button with custom handler functions
 *   defined, those handlers will be stored here.
 */
function form_execute_handlers($type, &$form, &$form_state) {
  $return = FALSE;
851 852
  if (isset($form_state[$type . '_handlers'])) {
    $handlers = $form_state[$type . '_handlers'];
853
  }
854 855
  elseif (isset($form['#' . $type])) {
    $handlers = $form['#' . $type];
856 857 858 859 860 861
  }
  else {
    $handlers = array();
  }

  foreach ($handlers as $function) {
862
    if (drupal_function_exists($function))  {
863 864 865 866
      // Check to see if a previous _submit handler has set a batch, but 
      // make sure we do not react to a batch that is already being processed 
      // (for instance if a batch operation performs a drupal_execute()).
      if ($type == 'submit' && ($batch =& batch_get()) && !isset($batch['current_set'])) {
867 868 869
        // Some previous _submit handler 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.
870
        $batch['sets'][] = array('form_submit' => $function);
871 872
      }
      else {
873
        $function($form, $form_state);
874 875 876 877 878 879 880
      }
      $return = TRUE;
    }
  }
  return $return;
}

881
/**
882 883 884 885 886 887 888 889 890
 * File an error against a form element.
 *
 * @param $name
 *   The name of the form element. If the #parents property of your form
 *   element is array('foo', 'bar', 'baz') then you may set an error on 'foo'
 *   or 'foo][bar][baz'. Setting an error on 'foo' sets an error for every
 *   element where the #parents array starts with 'foo'.
 * @param $message
 *   The error message to present to the user.
891 892
 * @param $reset
 *   Reset the form errors static cache.
893 894 895
 * @return
 *   Never use the return value of this function, use form_get_errors and
 *   form_get_error instead.
896
 */
897
function form_set_error($name = NULL, $message = '', $reset = FALSE) {
898
  static $form = array();
899 900 901
  if ($reset) {
    $form = array();
  }
902 903
  if (isset($name) && !isset($form[$name])) {
    $form[$name] = $message;
904 905 906
    if ($message) {
      drupal_set_message($message, 'error');
    }
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
  }
  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];
  }
}

936 937 938
/**
 * Flag an element as having an error.
 */
939
function form_error(&$element, $message = '') {
940
  form_set_error(implode('][', $element['#parents']), $message);
941 942 943
}

/**
944 945
 * Walk through the structured form array, adding any required
 * properties to each element and mapping the incoming $_POST
946 947
 * data to the proper elements. Also, execute any #process handlers
 * attached to a specific element.
948 949
 *
 * @param $form_id
950 951
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
952 953
 * @param $form
 *   An associative array containing the structure of the form.
954 955 956 957 958
 * @param $form_state
 *   A keyed array containing the current state of the form. In this
 *   context, it is used to accumulate information about which button
 *   was clicked when the form was submitted, as well as the sanitized
 *   $_POST data.
959
 */
960
function form_builder($form_id, $form, &$form_state) {
961
  static $complete_form, $cache, $file;
962

963 964 965
  // Initialize as unprocessed.
  $form['#processed'] = FALSE;

966
  // Use element defaults.
967
  if ((!empty($form['#type'])) && ($info = element_info($form['#type']))) {
968
    // Overlay $info onto $form, retaining preexisting keys in $form.
969 970 971
    $form += $info;
  }

972
  if (isset($form['#type']) && $form['#type'] == 'form') {
973
    $cache = NULL;
974
    $complete_form = $form;
975
    if (!empty($form_state['programmed'])) {
976 977
      $form_state['submitted'] = TRUE;
    }
978 979
  }

980 981 982
  if (!isset($form['#id'])) {
    $form['#id'] = form_clean_id('edit-' . implode('-', $form['#parents']));
  }
983
  if (isset($form['#input']) && $form['#input']) {
984
    _form_builder_handle_input_element($form_id, $form, $form_state, $complete_form);
985
  }
986 987 988 989 990 991 992 993 994 995
  // Allow for elements to expand to multiple elements, e.g., radios,
  // checkboxes and files.
  if (isset($form['#process']) && !$form['#processed']) {
    foreach ($form['#process'] as $process) {
      if (drupal_function_exists($process)) {
        $form = $process($form, $form_state, $complete_form);
      }
    }
    $form['#processed'] = TRUE;
  }
996
  $form['#defaults_loaded'] = TRUE;
997

998 999 1000
  // We start off assuming all form elements are in the correct order.
  $form['#sorted'] = TRUE;

1001
  // Recurse through all child elements.
1002
  $count = 0;
1003
  foreach (element_children($form) as $key) {
1004
    // Don't squash an existing tree value.
1005 1006 1007
    if (!isset($form[$key]['#tree'])) {
      $form[$key]['#tree'] = $form['#tree'];
    }
1008

1009
    // Deny access to child elements if parent is denied.
1010 1011 1012 1013
    if (isset($form['#access']) && !$form['#access']) {
      $form[$key]['#access'] = FALSE;
    }

1014
    // Don't squash existing parents value.
1015
    if (!isset($form[$key]['#parents'])) {
1016 1017
      // Check to see if a tree of child elements is present. If so,
      // continue down the tree if required.
1018
      $form[$key]['#parents'] = $form[$key]['#tree'] && $form['#tree'] ? array_merge($form['#parents'], array($key)) : array($key);
1019 1020 1021
      $array_parents = isset($form['#array_parents']) ? $form['#array_parents'] : array();
      $array_parents[] = $key;
      $form[$key]['#array_parents'] = $array_parents;
1022 1023
    }

1024
    // Assign a decimal placeholder weight to preserve original array order.
1025 1026 1027
    if (!isset($form[$key]['#weight'])) {
      $form[$key]['#weight'] = $count/1000;
    }
1028
    else {
1029 1030
      // If one of the child elements has a weight then we will need to sort
      // later.
1031 1032
      unset($form['#sorted']);
    }
1033
    $form[$key] = form_builder($form_id, $form[$key], $form_state);
1034 1035 1036
    $count++;
  }

1037 1038
  // The #after_build flag allows any piece of a form to be altered
  // after normal input parsing has been completed.
1039 1040
  if (isset($form['#after_build']) && !isset($form['#after_build_done'])) {
    foreach ($form['#after_build'] as $function) {
1041
      $form = $function($form, $form_state);
1042 1043 1044 1045 1046
      $form['#after_build_done'] = TRUE;
    }
  }

  // Now that we've processed everything, we can go back to handle the funky
Dries's avatar
Dries committed
1047
  // Internet Explorer button-click scenario.
1048
  _form_builder_ie_cleanup($form, $form_state);
1049

1050
  // We should keep the buttons array until the IE clean up function
1051 1052 1053 1054 1055 1056
  // has recognized the submit button so the form has been marked
  // as submitted. If we already know which button was submitted,
  // we don't need the array.
  if (!empty($form_state['submitted'])) {
    unset($form_state['buttons']);
  }
1057

1058 1059
  // If some callback set #cache, we need to flip a static flag so later it
  // can be found.
1060
  if (!empty($form['#cache'])) {
1061 1062
    $cache = $form['#cache'];
  }
1063 1064
  // If there is a file element, we need to flip a static flag so later the
  // form encoding can be set.
1065
  if (isset($form['#type']) && $form['#type'] == 'file') {
1066 1067 1068 1069 1070 1071 1072
    $file = TRUE;
  }
  if (isset($form['#type']) && $form['#type'] == 'form') {
    // We are on the top form, we can copy back #cache if it's set.
    if (isset($cache)) {
      $form['#cache'] = TRUE;
    }
1073 1074 1075 1076
    // If there is a file element, we set the form encoding.
    if (isset($file)) {
      $form['#attributes']['enctype'] = 'multipart/form-data';
    }
1077
  }
1078 1079 1080 1081 1082
  return $form;
}

/**
 * Populate the #value and #name properties of input elements so they
1083
 * can be processed and rendered.
1084
 */
1085
function _form_builder_handle_input_element($form_id, &$form, &$form_state, $complete_form) {
1086 1087 1088 1089 1090 1091 1092
  if (!isset($form['#name'])) {
    $name = array_shift($form['#parents']);
    $form['#name'] = $name;
    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.
1093
      $form['#name'] = 'files[' . $form['#name'] . ']';
1094 1095
    }
    elseif (count($form['#parents'])) {
1096
      $form['#name'] .= '[' . implode('][', $form['#parents']) . ']';
1097 1098 1099 1100 1101 1102 1103 1104 1105
    }
    array_unshift($form['#parents'], $name);
  }

  if (!empty($form['#disabled'])) {
    $form['#attributes']['disabled'] = 'disabled';
  }

  if (!isset($form['#value']) && !array_key_exists('#value', $form)) {
1106
    $function = !empty($form['#value_callback']) ? $form['#value_callback'] : 'form_type_' . $form['#type'] . '_value';
1107 1108
    if (($form_state['programmed']) || ((!isset($form['#access']) || $form['#access']) && isset($form_state['input']) && (isset($form_state['input']['form_id']) && $form_state['input']['form_id'] == $form_id))) {
      $edit = $form_state['input'];
1109 1110 1111
      foreach ($form['#parents'] as $parent) {
        $edit = isset($edit[$parent]) ? $edit[$parent] : NULL;
      }
1112
      if (!$form_state['programmed'] || isset($edit)) {
1113 1114
        // Call #type_value to set the form value;
        if (function_exists($function)) {
1115
          $form['#value'] = $function($form, $edit, $form_state);
1116
        }
1117 1118
        if (!isset($form['#value']) && isset($edit)) {
          $form['#value'] = $edit;
1119 1120
        }
      }
1121 1122 1123 1124
      // Mark all posted values for validation.
      if (isset($form['#value']) || (isset($form['#required']) && $form['#required'])) {
        $form['#needs_validation'] = TRUE;
      }
1125
    }
1126
    // Load defaults.
1127
    if (!isset($form['#value'])) {
1128
      // Call #type_value without a second argument to request default_value handling.
1129
      if (function_exists($function)) {
1130
        $form['#value'] = $function($form);
1131
      }
1132
      // Final catch. If we haven't set a value yet, use the explicit default value.
1133 1134 1135
      // Avoid image buttons (which come with garbage value), so we only get value
      // for the button actually clicked.
      if (!isset($form['#value']) && empty($form['#has_garbage_value'])) {
1136
        $form['#value'] = isset($form['#default_value']) ? $form['#default_value'] : '';
1137 1138
      }
    }
1139
  }
1140

1141 1142 1143 1144
  // Determine which button (if any) was clicked to submit the form.
  // We compare the incoming values with the buttons defined in the form,
  // and flag the one that matches. We have to do some funky tricks to
  // deal with Internet Explorer's handling of single-button forms, though.
1145
  if (!empty($form_state['input']) && isset($form['#executes_submit_callback'])) {
1146 1147 1148 1149 1150
    // First, accumulate a collection of buttons, divided into two bins:
    // those that execute full submit callbacks and those that only validate.
    $button_type = $form['#executes_submit_callback'] ? 'submit' : 'button';
    $form_state['buttons'][$button_type][] = $form;

1151
    if (_form_button_was_clicked($form, $form_state)) {
1152 1153 1154 1155 1156 1157
      $form_state['submitted'] = $form_state['submitted'] || $form['#executes_submit_callback'];

      // 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_state['values'][$form['#name']] = $form['#value'];
1158
      $form_state['clicked_button'] = $form;
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170

      if (isset($form['#validate'])) {
        $form_state['validate_handlers'] = $form['#validate'];
      }
      if (isset($form['#submit'])) {
        $form_state['submit_handlers'] = $form['#submit'];
      }
    }
  }
  form_set_value($form, $form['#value'], $form_state);
}

1171 1172 1173 1174 1175 1176 1177 1178 1179
/**
 * Helper function to handle the sometimes-convoluted logic of button
 * click detection.
 *
 * In Internet Explorer, if ONLY one submit button is present, AND the
 * enter key is used to submit the form, no form value is sent for it
 * and we'll never detect a match. That special case is handled by
 * _form_builder_ie_cleanup().
 */
1180
function _form_button_was_clicked($form, &$form_state) {
1181 1182 1183 1184 1185
  // First detect normal 'vanilla' button clicks. Traditionally, all
  // standard buttons on a form share the same name (usually 'op'),
  // and the specific return value is used to determine which was
  // clicked. This ONLY works as long as $form['#name'] puts the
  // value at the top level of the tree of $_POST data.
1186
  if (isset($form_state['input'][$form['#name']]) && $form_state['input'][$form['#name']] == $form['#value']) {
Dries's avatar