form.inc 95.6 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
51
52
 * Retrieves a form from a constructor function, or from the cache if
 * the form was built in a previous page-load. The form is then passesed
 * on for processing, after and rendered for display if necessary.
53
54
 *
 * @param $form_id
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
59
 *   different $form_id values to the proper form constructor function. Examples
60
61
 *   may be found in node_forms(), search_forms(), and user_forms().
 * @param ...
62
63
64
65
 *   Any additional arguments are passed on to the functions called by
 *   drupal_get_form(), 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.
66
67
68
69
 * @return
 *   The rendered form.
 */
function drupal_get_form($form_id) {
70
71
72
  $form_state = array('storage' => NULL, 'submitted' => FALSE);

  $args = func_get_args();
73
  $cacheable = FALSE;
74
75
76
77
78
79
80

  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']);
81
82
  }
  else {
83
84
85
86
87
88
    // If the incoming $_POST contains a form_build_id, we'll check the
    // 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.
    if (isset($_POST['form_id']) && $_POST['form_id'] == $form_id && !empty($_POST['form_build_id'])) {
89
      $form = form_get_cache($_POST['form_build_id'], $form_state);
90
91
    }

92
93
94
95
    // 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)) {
96
      $form_state['post'] = $_POST;
97
98
      // Use a copy of the function's arguments for manipulation
      $args_temp = $args;
99
      $args_temp[0] = &$form_state;
100
      array_unshift($args_temp, $form_id);
101

102
      $form = call_user_func_array('drupal_retrieve_form', $args_temp);
103
      $form_build_id = 'form-' . md5(uniqid(mt_rand(), TRUE));
104
      $form['#build_id'] = $form_build_id;
105
      drupal_prepare_form($form_id, $form, $form_state);
106
107
108
109
      // 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;
110
      unset($form_state['post']);
111
    }
112
    $form['#post'] = $_POST;
113

114
115
116
117
118
119
    // 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);
120
121
122
123
124
125
    if ($cacheable && !empty($form['#cache'])) {
      // Caching is done past drupal_process_form so #process callbacks can
      // set #cache. By not sending the form state, we avoid storing
      // $form_state['storage'].
      form_set_cache($form_build_id, $original_form, NULL);
    }
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
  }

  // 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.
  //
  // If $form_state['storage'] or $form_state['rebuild'] have been
  // set by any submit or validate handlers, however, 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['rebuild']) || !empty($form_state['storage'])) {
143
    $form = drupal_rebuild_form($form_id, $form_state, $args);
144
145
  }

146
147
148
149
  // 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);
}
150

151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/**
 * 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.
 *
 * @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 $args
 *   Any additional arguments are passed on to the functions called by
 *   drupal_get_form(), plus the original form_state in the beginning. If you
 *   are getting a form from the cache, use $form['#parameters'] to shift off
 *   the $form_id from its beginning then the resulting array can be used as
 *   $arg here.
 * @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.
 */
function drupal_rebuild_form($form_id, &$form_state, $args, $form_build_id = NULL) {
  // Remove the first argument. This is $form_id.when called from
  // drupal_get_form and the original $form_state when called from some AHAH
191
192
  // callback. Neither is needed. After that, put in the current state.
  $args[0] = &$form_state;
193
194
195
196
197
198
  // And the form_id.
  array_unshift($args, $form_id);
  $form = call_user_func_array('drupal_retrieve_form', $args);

  if (!isset($form_build_id)) {
    // We need a new build_id for the new version of the form.
199
    $form_build_id = 'form-' . md5(mt_rand());
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
  }
  $form['#build_id'] = $form_build_id;
  drupal_prepare_form($form_id, $form, $form_state);

  // Now, we cache the form structure so it can be retrieved later for
  // validation. If $form_state['storage'] is populated, we'll also cache
  // it so that it can be used to resume complex multi-step processes.
  form_set_cache($form_build_id, $form, $form_state);

  // 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.
  $_POST = array();
  $form['#post'] = array();
  drupal_process_form($form_id, $form, $form_state);
  return $form;
}

218
219
220
221
/**
 * Fetch a form from cache.
 */
function form_get_cache($form_build_id, &$form_state) {
222
  if ($cached = cache_get('form_' . $form_build_id, 'cache_form')) {
223
    $form = $cached->data;
224
225
226
227
228
229
    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;
230
231
232
233
234
235
236
237
    }
  }
}

/**
 * Store a form in the cache
 */
function form_set_cache($form_build_id, $form, $form_state) {
238
239
  // 6 hours cache life time for forms should be plenty.
  $expire = 21600;
240
241
242
243
  global $user;
  if ($user->uid) {
    $form['#cache_token'] = drupal_get_token();
  }
244
  cache_set('form_' . $form_build_id, $form, 'cache_form', REQUEST_TIME + $expire);
245
  if (!empty($form_state['storage'])) {
246
    cache_set('storage_' . $form_build_id, $form_state['storage'], 'cache_form', REQUEST_TIME + $expire);
247
248
249
  }
}

250
/**
251
 * Retrieves a form using a form_id, populates it with $form_state['values'],
252
253
254
255
256
257
258
259
 * 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
260
 *   different $form_id values to the proper form constructor function. Examples
261
 *   may be found in node_forms(), search_forms(), and user_forms().
262
263
264
265
266
 * @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.
267
 * @param ...
268
269
270
271
 *   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.
272
273
274
 * For example:
 *
 * // register a new user
275
276
277
278
 * $form_state = array();
 * $form_state['values']['name'] = 'robo-user';
 * $form_state['values']['mail'] = 'robouser@example.com';
 * $form_state['values']['pass'] = 'password';
279
 * $form_state['values']['op'] = t('Create new account');
280
 * drupal_execute('user_register', $form_state);
281
282
 *
 * // Create a new node
283
 * $form_state = array();
284
 * module_load_include('inc', 'node', 'node.pages');
285
 * $node = array('type' => 'story');
286
287
288
 * $form_state['values']['title'] = 'My node';
 * $form_state['values']['body'] = 'This is the body text!';
 * $form_state['values']['name'] = 'robo-user';
289
 * $form_state['values']['op'] = t('Save');
290
 * drupal_execute('story_node_form', $form_state, (object)$node);
291
 */
292
function drupal_execute($form_id, &$form_state) {
293
  $args = func_get_args();
294
295
296
297
  $form = call_user_func_array('drupal_retrieve_form', $args);
  $form['#post'] = $form_state['values'];
  drupal_prepare_form($form_id, $form, $form_state);
  drupal_process_form($form_id, $form, $form_state);
298
299
}

300
301
302
303
304
305
306
307
/**
 * 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
308
 *   different $form_id values to the proper form constructor function.
309
310
 * @param $form_state
 *   A keyed array containing the current state of the form.
311
 * @param ...
312
313
314
315
316
317
 *   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.
318
 */
319
function drupal_retrieve_form($form_id, &$form_state) {
320
321
  static $forms;

322
  // We save two copies of the incoming arguments: one for modules to use
323
324
325
  // when mapping form ids to constructor functions, and another to pass to
  // the constructor function itself. We shift out the first argument -- the
  // $form_id itself -- from the list to pass into the constructor function,
326
  // since it's already known.
327
  $args = func_get_args();
328
  $saved_args = $args;
329
  array_shift($args);
330
331
332
  if (isset($form_state)) {
    array_shift($args);
  }
333
334
335

  // 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.
336
  if (!drupal_function_exists($form_id)) {
337
    // In cases where many form_ids need to share a central constructor function,
338
    // such as the node editing form, modules can implement hook_forms(). It
339
    // maps one or more form_ids to the correct constructor functions.
340
341
342
343
344
345
346
347
348
    //
    // 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])) {
349
      $forms = module_invoke_all('forms', $form_id, $args);
350
351
352
353
354
355
356
    }
    $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'];
357
      drupal_function_exists($callback);
358
359
    }
  }
360

361
362
  array_unshift($args, NULL);
  $args[0] = &$form_state;
363

364
365
  // If $callback was returned by a hook_forms() implementation, call it.
  // Otherwise, call the function named after the form id.
366
367
368
369
370
371
  $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.
372
  $form['#parameters'] = $saved_args;
373
  return $form;
374
375
376
377
378
379
380
381
}

/**
 * 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.
382
383
 * @param $form
 *   An associative array containing the structure of the form.
384
385
 * @param $form_state
 *   A keyed array containing the current state of the form. This
Dries's avatar
Dries committed
386
 *   includes the current persistent storage data for the form, and
387
388
389
 *   any data passed along by earlier steps when displaying a
 *   multi-step form. Additional information, like the sanitized $_POST
 *   data, is also accumulated here.
390
 */
391
392
393
394
function drupal_process_form($form_id, &$form, &$form_state) {
  $form_state['values'] = array();

  $form = form_builder($form_id, $form, $form_state);
395
396
397
  // 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.
  if ((!empty($form['#programmed'])) || (!empty($form['#post']) && (isset($form['#post']['form_id']) && ($form['#post']['form_id'] == $form_id)))) {
398
399
    drupal_validate_form($form_id, $form, $form_state);

400
401
402
403
404
405
406
    // 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
    // cache when a form is processed, so scenerios that result in
    // 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);

407
408
409
410
411
412
413
    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.
414
      if (variable_get('cache', CACHE_DISABLED) == CACHE_DISABLED && !empty($form_state['values']['form_build_id'])) {
415
416
        cache_clear_all('form_' . $form_state['values']['form_build_id'], 'cache_form');
        cache_clear_all('storage_' . $form_state['values']['form_build_id'], 'cache_form');
417
418
419
      }

      // If batches were set in the submit handlers, we process them now,
420
421
422
423
      // 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'])) {
424
425
426
427
        // The batch uses its own copies of $form and $form_state for
        // late execution of submit handers and post-batch redirection.
        $batch['form'] = $form;
        $batch['form_state'] = $form_state;
428
429
        $batch['progressive'] = !$form['#programmed'];
        batch_process();
430
431
432
433
        // 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.
434
      }
435
436
437
438
439
440
441
442
443

      // 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.
      if (!$form['#programmed'] && empty($form_state['rebuild']) && empty($form_state['storage'])) {
444
        drupal_redirect_form($form, $form_state['redirect']);
445
      }
446
447
448
449
450
451
452
453
454
455
456
457
458
459
    }
  }
}

/**
 * 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.
460
461
462
 * @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.
463
 */
464
function drupal_prepare_form($form_id, &$form, &$form_state) {
465
466
  global $user;

467
  $form['#type'] = 'form';
468
  $form['#programmed'] = isset($form['#post']);
469

470
471
472
473
474
475
476
477
478
  if (isset($form['#build_id'])) {
    $form['form_build_id'] = array(
      '#type' => 'hidden',
      '#value' => $form['#build_id'],
      '#id' => $form['#build_id'],
      '#name' => 'form_build_id',
    );
  }

479
480
481
482
  // 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.
483
  if (isset($form['#token'])) {
484
    if ($form['#token'] === FALSE || $user->uid == 0 || $form['#programmed']) {
485
      unset($form['#token']);
486
    }
487
    else {
488
      $form['form_token'] = array('#type' => 'token', '#default_value' => drupal_get_token($form['#token']));
489
    }
490
  }
491
  elseif (isset($user->uid) && $user->uid && !$form['#programmed']) {
492
493
    $form['#token'] = $form_id;
    $form['form_token'] = array(
494
      '#id' => form_clean_id('edit-' . $form_id . '-form-token'),
495
496
497
498
499
      '#type' => 'token',
      '#default_value' => drupal_get_token($form['#token']),
    );
  }

500
  if (isset($form_id)) {
501
502
503
504
505
    $form['form_id'] = array(
      '#type' => 'hidden',
      '#value' => $form_id,
      '#id' => form_clean_id("edit-$form_id"),
    );
506
  }
507
  if (!isset($form['#id'])) {
508
    $form['#id'] = form_clean_id($form_id);
509
  }
Steven Wittens's avatar
Steven Wittens committed
510

511
  $form += _element_info('form');
512
  $form += array('#tree' => FALSE, '#parents' => array());
513

Dries's avatar
Dries committed
514
  if (!isset($form['#validate'])) {
515
    if (drupal_function_exists($form_id . '_validate')) {
516
      $form['#validate'] = array($form_id . '_validate');
Dries's avatar
Dries committed
517
518
519
    }
  }

520
  if (!isset($form['#submit'])) {
521
    if (drupal_function_exists($form_id . '_submit')) {
522
      // We set submit here so that it can be altered.
523
      $form['#submit'] = array($form_id . '_submit');
Dries's avatar
Dries committed
524
525
526
    }
  }

527
528
529
530
531
532
533
534
  // 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);
535
  drupal_alter('form_' . $form_id, $data);
536
537
538
539
540

  // __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);
541
542
}

543
544

/**
545
 * Validates user-submitted form data from the $form_state using
546
547
548
549
550
551
552
 * 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.
553
554
555
556
557
558
559
560
561
562
 * @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.
563
 */
564
function drupal_validate_form($form_id, $form, &$form_state) {
565
566
567
568
569
  static $validated_forms = array();

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

571
  // If the session token was set by drupal_prepare_form(), ensure that it
572
  // matches the current user's session.
573
  if (isset($form['#token'])) {
574
    if (!drupal_valid_token($form_state['values']['form_token'], $form['#token'])) {
575
      // Setting this error will cause the form to fail validation.
576
      form_set_error('form_token', t('Validation error, please try again. If this error persists, please contact the site administrator.'));
577
578
579
    }
  }

580
  _form_validate($form, $form_state, $form_id);
581
  $validated_forms[$form_id] = TRUE;
582
583
}

584
585
586
587
588
589
590
591
592
593
594
595
/**
 * 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.
 */
596
function drupal_render_form($form_id, &$form) {
597
598
  // Don't override #theme if someone already set it.
  if (!isset($form['#theme'])) {
599
600
601
    init_theme();
    $registry = theme_get_registry();
    if (isset($registry[$form_id])) {
602
603
604
605
      $form['#theme'] = $form_id;
    }
  }

606
  $output = drupal_render($form);
607
608
609
610
611
612
613
614
615
  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
616
 *   An optional value containing the destination path to redirect
617
618
619
 *   to if none is specified by the form.
 */
function drupal_redirect_form($form, $redirect = NULL) {
620
  $goto = NULL;
621
622
623
  if (isset($redirect)) {
    $goto = $redirect;
  }
624
  if ($goto !== FALSE && isset($form['#redirect'])) {
625
626
    $goto = $form['#redirect'];
  }
627
628
629
630
631
632
633
634
635
636
637
  if (!isset($goto) || ($goto !== FALSE)) {
    if (isset($goto)) {
      if (is_array($goto)) {
        call_user_func_array('drupal_goto', $goto);
      }
      else {
        drupal_goto($goto);
      }
    }
    drupal_goto($_GET['q']);
  }
638
639
}

640
641
642
643
644
645
646
/**
 * 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.
647
648
649
650
651
652
653
654
655
656
 * @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.
657
658
659
660
 * @param $form_id
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
 */
661
function _form_validate($elements, &$form_state, $form_id = NULL) {
662
663
  static $complete_form;

664
665
  // Also used in the installer, pre-database setup.
  $t = get_t();
666

667
668
669
  // Recurse through all children.
  foreach (element_children($elements) as $key) {
    if (isset($elements[$key]) && $elements[$key]) {
670
      _form_validate($elements[$key], $form_state);
671
672
    }
  }
673
  // Validate the current input.
drumm's avatar
drumm committed
674
  if (!isset($elements['#validated']) || !$elements['#validated']) {
675
    if (isset($elements['#needs_validation'])) {
676
677
678
679
680
      // 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))) {
681
        form_error($elements, $t('!name field is required.', array('!name' => $elements['#title'])));
682
      }
683

684
685
      // Verify that the value is not longer than #maxlength.
      if (isset($elements['#maxlength']) && drupal_strlen($elements['#value']) > $elements['#maxlength']) {
686
        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']))));
687
688
      }

689
      if (isset($elements['#options']) && isset($elements['#value'])) {
690
691
692
693
694
695
696
697
698
699
        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])) {
700
              form_error($elements, $t('An illegal choice has been detected. Please contact the site administrator.'));
701
              watchdog('form', 'Illegal choice %choice in !name element.', array('%choice' => $v, '!name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title']), WATCHDOG_ERROR);
702
            }
703
704
          }
        }
705
        elseif (!isset($options[$elements['#value']])) {
706
          form_error($elements, $t('An illegal choice has been detected. Please contact the site administrator.'));
707
          watchdog('form', 'Illegal choice %choice in %name element.', array('%choice' => $elements['#value'], '%name' => empty($elements['#title']) ? $elements['#parents'][0] : $elements['#title']), WATCHDOG_ERROR);
708
        }
709
710
711
      }
    }

712
713
714
    // 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.
715
716
    if (isset($form_id)) {
      form_execute_handlers('validate', $elements, $form_state);
717
      $complete_form = $elements;
718
719
720
721
722
    }
    // Call any element-specific validators. These must act on the element
    // #value data.
    elseif (isset($elements['#element_validate'])) {
      foreach ($elements['#element_validate'] as $function) {
723
        if (drupal_function_exists($function))  {
724
          $function($elements, $form_state, $complete_form);
725
726
727
        }
      }
    }
728
    $elements['#validated'] = TRUE;
729
730
731
  }
}

732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
/**
 * 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;
749
750
  if (isset($form_state[$type . '_handlers'])) {
    $handlers = $form_state[$type . '_handlers'];
751
  }
752
753
  elseif (isset($form['#' . $type])) {
    $handlers = $form['#' . $type];
754
755
756
757
758
759
  }
  else {
    $handlers = array();
  }

  foreach ($handlers as $function) {
760
    if (drupal_function_exists($function))  {
761
762
763
764
      if ($type == 'submit' && ($batch =& batch_get())) {
        // 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.
765
        $batch['sets'][] = array('form_submit' => $function);
766
767
      }
      else {
768
        $function($form, $form_state);
769
770
771
772
773
774
775
      }
      $return = TRUE;
    }
  }
  return $return;
}

776
/**
777
778
779
780
781
782
783
784
785
 * 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.
786
787
 * @param $reset
 *   Reset the form errors static cache.
788
789
790
 * @return
 *   Never use the return value of this function, use form_get_errors and
 *   form_get_error instead.
791
 */
792
function form_set_error($name = NULL, $message = '', $reset = FALSE) {
793
  static $form = array();
794
795
796
  if ($reset) {
    $form = array();
  }
797
798
  if (isset($name) && !isset($form[$name])) {
    $form[$name] = $message;
799
800
801
    if ($message) {
      drupal_set_message($message, 'error');
    }
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
  }
  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];
  }
}

831
832
833
/**
 * Flag an element as having an error.
 */
834
function form_error(&$element, $message = '') {
835
  form_set_error(implode('][', $element['#parents']), $message);
836
837
838
}

/**
839
840
841
 * Walk through the structured form array, adding any required
 * properties to each element and mapping the incoming $_POST
 * data to the proper elements.
842
843
 *
 * @param $form_id
844
845
 *   A unique string identifying the form for validation, submission,
 *   theming, and hook_form_alter functions.
846
847
 * @param $form
 *   An associative array containing the structure of the form.
848
849
850
851
852
 * @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.
853
 */
854
function form_builder($form_id, $form, &$form_state) {
855
  static $complete_form, $cache, $file;
856

857
858
859
  // Initialize as unprocessed.
  $form['#processed'] = FALSE;

860
  // Use element defaults.
861
  if ((!empty($form['#type'])) && ($info = _element_info($form['#type']))) {
862
    // Overlay $info onto $form, retaining preexisting keys in $form.
863
864
865
    $form += $info;
  }

866
  if (isset($form['#type']) && $form['#type'] == 'form') {
867
    $cache = NULL;
868
869
870
871
    $complete_form = $form;
    if (!empty($form['#programmed'])) {
      $form_state['submitted'] = TRUE;
    }
872
873
  }

874
  if (isset($form['#input']) && $form['#input']) {
875
    _form_builder_handle_input_element($form_id, $form, $form_state, $complete_form);
876
  }
877
  $form['#defaults_loaded'] = TRUE;
878

879
880
881
  // We start off assuming all form elements are in the correct order.
  $form['#sorted'] = TRUE;

882
  // Recurse through all child elements.
883
  $count = 0;
884
  foreach (element_children($form) as $key) {
885
886
    $form[$key]['#post'] = $form['#post'];
    $form[$key]['#programmed'] = $form['#programmed'];
887
    // Don't squash an existing tree value.
888
889
890
    if (!isset($form[$key]['#tree'])) {
      $form[$key]['#tree'] = $form['#tree'];
    }
Steven Wittens's avatar
Steven Wittens committed
891

892
    // Deny access to child elements if parent is denied.
893
894
895
896
    if (isset($form['#access']) && !$form['#access']) {
      $form[$key]['#access'] = FALSE;
    }

897
    // Don't squash existing parents value.
898
    if (!isset($form[$key]['#parents'])) {
899
900
      // Check to see if a tree of child elements is present. If so,
      // continue down the tree if required.
901
      $form[$key]['#parents'] = $form[$key]['#tree'] && $form['#tree'] ? array_merge($form['#parents'], array($key)) : array($key);
902
903
904
      $array_parents = isset($form['#array_parents']) ? $form['#array_parents'] : array();
      $array_parents[] = $key;
      $form[$key]['#array_parents'] = $array_parents;
Steven Wittens's avatar
Steven Wittens committed
905
906
    }

907
    // Assign a decimal placeholder weight to preserve original array order.
908
909
910
    if (!isset($form[$key]['#weight'])) {
      $form[$key]['#weight'] = $count/1000;
    }
911
    else {
912
913
      // If one of the child elements has a weight then we will need to sort
      // later.
914
915
      unset($form['#sorted']);
    }
916
    $form[$key] = form_builder($form_id, $form[$key], $form_state);
917
918
919
    $count++;
  }

920
921
  // The #after_build flag allows any piece of a form to be altered
  // after normal input parsing has been completed.
922
923
  if (isset($form['#after_build']) && !isset($form['#after_build_done'])) {
    foreach ($form['#after_build'] as $function) {
924
      $form = $function($form, $form_state);
925
926
927
928
929
      $form['#after_build_done'] = TRUE;
    }
  }

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

933
934
935
936
937
938
939
  // We shoud keep the buttons array until the IE clean up function
  // 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']);
  }
940

941
942
  // If some callback set #cache, we need to flip a static flag so later it
  // can be found.
943
  if (!empty($form['#cache'])) {
944
945
    $cache = $form['#cache'];
  }
946
947
948
949
950
951
952
953
954
955
956
957
958
959
  // If there is a file element, we need to flip a static flag so later the
  // form encoding can be set.
  if ($form['#type'] == 'file') {
    $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;
    }
    // If there is a file element, we set the form encoding.
    if (isset($file)) {
      $form['#attributes']['enctype'] = 'multipart/form-data';
    }
960
  }
961
962
963
964
965
966
967
968
  return $form;
}

/**
 * Populate the #value and #name properties of input elements so they
 * can be processed and rendered. Also, execute any #process handlers
 * attached to a specific element.
 */
969
function _form_builder_handle_input_element($form_id, &$form, &$form_state, $complete_form) {
970
971
972
973
974
975
976
  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.
977
      $form['#name'] = 'files[' . $form['#name'] . ']';
978
979
    }
    elseif (count($form['#parents'])) {
980
      $form['#name'] .= '[' . implode('][', $form['#parents']) . ']';
981
982
983
984
    }
    array_unshift($form['#parents'], $name);
  }
  if (!isset($form['#id'])) {
985
    $form['#id'] = form_clean_id('edit-' . implode('-', $form['#parents']));
986
987
  }

988
  unset($edit);
989
990
991
992
993
  if (!empty($form['#disabled'])) {
    $form['#attributes']['disabled'] = 'disabled';
  }

  if (!isset($form['#value']) && !array_key_exists('#value', $form)) {
994
    $function = !empty($form['#value_callback']) ? $form['#value_callback'] : 'form_type_' . $form['#type'] . '_value';
995
996
997
998
999
1000
    if (($form['#programmed']) || ((!isset($form['#access']) || $form['#access']) && isset($form['#post']) && (isset($form['#post']['form_id']) && $form['#post']['form_id'] == $form_id))) {
      $edit = $form['#post'];
      foreach ($form['#parents'] as $parent) {
        $edit = isset($edit[$parent]) ? $edit[$parent] : NULL;
      }
      if (!$form['#programmed'] || isset($edit)) {
1001
1002
1003
        // Call #type_value to set the form value;
        if (function_exists($function)) {
          $form['#value'] = $function($form, $edit);
1004
        }
1005
1006
        if (!isset($form['#value']) && isset($edit)) {
          $form['#value'] = $edit;
1007
1008
        }
      }
1009
1010
1011
1012
      // Mark all posted values for validation.
      if (isset($form['#value']) || (isset($form['#required']) && $form['#required'])) {
        $form['#needs_validation'] = TRUE;
      }
1013
    }
1014
    // Load defaults.
1015
    if (!isset($form['#value'])) {
1016
      // Call #type_value without a second argument to request default_value handling.
1017
      if (function_exists($function)) {
1018
        $form['#value'] = $function($form);
1019
      }
1020
      // Final catch. If we haven't set a value yet, use the explicit default value.
1021
1022
1023
      // 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'])) {
1024
        $form['#value'] = isset($form['#default_value']) ? $form['#default_value'] : '';
1025
1026
      }
    }
Steven Wittens's avatar
Steven Wittens committed
1027
  }
1028

1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
  // 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.
  if (!empty($form['#post']) && isset($form['#executes_submit_callback'])) {
    // 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;

1039
    if (_form_button_was_clicked($form)) {
1040
1041
1042
1043
1044
1045
      $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'];
1046
      $form_state['clicked_button'] = $form;
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059

      if (isset($form['#validate'])) {
        $form_state['validate_handlers'] = $form['#validate'];
      }
      if (isset($form['#submit'])) {
        $form_state['submit_handlers'] = $form['#submit'];
      }
    }
  }
  // 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) {
1060
      if (drupal_function_exists($process)) {
1061
        $form = $process($form, isset($edit) ? $edit : NULL, $form_state, $complete_form);
1062
1063
1064
1065
1066
1067
1068
      }
    }
    $form['#processed'] = TRUE;
  }
  form_set_value($form, $form['#value'], $form_state);
}

1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
/**
 * 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().
 */
function _form_button_was_clicked($form) {
  // 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.
  if (isset($form['#post'][$form['#name']]) && $form['#post'][$form['#name']] == $form['#value']) {
    return TRUE;
  }
  // When image buttons are clicked, browsers do NOT pass the form element
  // value in $_POST. Instead they pass an integer representing the
  // coordinates of the click on the button image. This means that image
  // buttons MUST have unique $form['#name'] values, but the details of
  // their $_POST data should be ignored.
  elseif (!empty($form['#has_garbage_value']) && isset($form['#value']) && $form['#value'] !== '') {
    return TRUE;
  }
  return FALSE;
}

/**
 * In IE, 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 our normal
 * button detection code will never detect a match. We call this
 * function after all other button-detection is complete to check
 * for the proper conditions, and treat the single button on the form
 * as 'clicked' if they are met.
 */
function _form_builder_ie_cleanup($form, &$form_state) {
  // Quick check to make sure we're always looking at the full form
  // and not a sub-element.
  if (!empty($form['#type']) && $form['#type'] == 'form') {
    // If we haven't recognized a submission yet, and there's a single
    // submit button, we know that we've hit the right conditions. Grab
    // the first one and treat it as the clicked button.
    if (empty($form_state['submitted']) && !empty($form_state['buttons']['submit']) && empty($form_state['buttons']['button'])) {
      $button = $form_state['buttons']['submit'][0];

      // Set up all the $form_state information that would have been
      // populated had the button been recognized earlier.
      $form_state['submitted'] = TRUE;
      $form_state['submit_handlers'] = empty($button['#submit']) ? NULL : $button['#submit'];
      $form_state['validate_handlers'] = empty($button['#validate']) ? NULL : $button['#validate'];
      $form_state['values'][$button['#name']] = $button['#value'];
      $form_state['clicked_button'] = $button;
    }
  }
}

1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
/**
 * Helper function to determine the value for an image button form element.
 *
 * @param $form
 *   The form element whose value is being populated.
 * @param $edit
 *   The incoming POST data to populate the form element. If this is FALSE,
 *   the element's default value should be returned.
 * @return
 *   The data that will appear in the $form_state['values'] collection
 *   for this element. Return nothing to use the default.
 */
function form_type_image_button_value($form, $edit = FALSE) {
  if ($edit !== FALSE) {
    if (!empty($edit)) {
      // If we're dealing with Mozilla or Opera, we're lucky. It will
      // return a proper value, and we can get on with things.
      return $form['#return_value'];
    }
    else {
      // Unfortunately, in IE we never get back a proper value for THIS
      // form element. Instead, we get back two split values: one for the
      // X and one for the Y coordinates on which the user clicked the
      // button. We'll find this element in the #post data, and search
      // in the same spot for its name, with '_x'.
      $post = $form['#post'];
      foreach (split('\[', $form['#name']) as $element_name) {
        // chop off the ] that may exist.
        if (substr($element_name, -1) == ']') {
          $element_name = substr($element_name, 0, -1);
        }

        if (!isset($post[$element_name])) {
1160
          if (isset($post[$element_name . '_x'])) {
1161
1162
1163
1164
            return $form['#return_value'];
          }
          return NULL;
        }