danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Batch processing API for processes to run in multiple HTTP requests.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Note that batches are usually invoked by form submissions, which is
danielebarchiesi@0:  * why the core interaction functions of the batch processing API live in
danielebarchiesi@0:  * form.inc.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see form.inc
danielebarchiesi@0:  * @see batch_set()
danielebarchiesi@0:  * @see batch_process()
danielebarchiesi@0:  * @see batch_get()
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Loads a batch from the database.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $id
danielebarchiesi@0:  *   The ID of the batch to load. When a progressive batch is being processed,
danielebarchiesi@0:  *   the relevant ID is found in $_REQUEST['id'].
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array representing the batch, or FALSE if no batch was found.
danielebarchiesi@0:  */
danielebarchiesi@0: function batch_load($id) {
danielebarchiesi@0:   $batch = db_query("SELECT batch FROM {batch} WHERE bid = :bid AND token = :token", array(
danielebarchiesi@0:     ':bid' => $id,
danielebarchiesi@0:     ':token' => drupal_get_token($id),
danielebarchiesi@0:   ))->fetchField();
danielebarchiesi@0:   if ($batch) {
danielebarchiesi@0:     return unserialize($batch);
danielebarchiesi@0:   }
danielebarchiesi@0:   return FALSE;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Renders the batch processing page based on the current state of the batch.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see _batch_shutdown()
danielebarchiesi@0:  */
danielebarchiesi@0: function _batch_page() {
danielebarchiesi@0:   $batch = &batch_get();
danielebarchiesi@0: 
danielebarchiesi@0:   if (!isset($_REQUEST['id'])) {
danielebarchiesi@0:     return FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Retrieve the current state of the batch.
danielebarchiesi@0:   if (!$batch) {
danielebarchiesi@0:     $batch = batch_load($_REQUEST['id']);
danielebarchiesi@0:     if (!$batch) {
danielebarchiesi@0:       drupal_set_message(t('No active batch.'), 'error');
danielebarchiesi@0:       drupal_goto();
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Register database update for the end of processing.
danielebarchiesi@0:   drupal_register_shutdown_function('_batch_shutdown');
danielebarchiesi@0: 
danielebarchiesi@0:   // Add batch-specific CSS.
danielebarchiesi@0:   foreach ($batch['sets'] as $batch_set) {
danielebarchiesi@0:     if (isset($batch_set['css'])) {
danielebarchiesi@0:       foreach ($batch_set['css'] as $css) {
danielebarchiesi@0:         drupal_add_css($css);
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $op = isset($_REQUEST['op']) ? $_REQUEST['op'] : '';
danielebarchiesi@0:   $output = NULL;
danielebarchiesi@0:   switch ($op) {
danielebarchiesi@0:     case 'start':
danielebarchiesi@0:       $output = _batch_start();
danielebarchiesi@0:       break;
danielebarchiesi@0: 
danielebarchiesi@0:     case 'do':
danielebarchiesi@0:       // JavaScript-based progress page callback.
danielebarchiesi@0:       _batch_do();
danielebarchiesi@0:       break;
danielebarchiesi@0: 
danielebarchiesi@0:     case 'do_nojs':
danielebarchiesi@0:       // Non-JavaScript-based progress page.
danielebarchiesi@0:       $output = _batch_progress_page_nojs();
danielebarchiesi@0:       break;
danielebarchiesi@0: 
danielebarchiesi@0:     case 'finished':
danielebarchiesi@0:       $output = _batch_finished();
danielebarchiesi@0:       break;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $output;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Initializes the batch processing.
danielebarchiesi@0:  *
danielebarchiesi@0:  * JavaScript-enabled clients are identified by the 'has_js' cookie set in
danielebarchiesi@0:  * drupal.js. If no JavaScript-enabled page has been visited during the current
danielebarchiesi@0:  * user's browser session, the non-JavaScript version is returned.
danielebarchiesi@0:  */
danielebarchiesi@0: function _batch_start() {
danielebarchiesi@0:   if (isset($_COOKIE['has_js']) && $_COOKIE['has_js']) {
danielebarchiesi@0:     return _batch_progress_page_js();
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     return _batch_progress_page_nojs();
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Outputs a batch processing page with JavaScript support.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This initializes the batch and error messages. Note that in JavaScript-based
danielebarchiesi@0:  * processing, the batch processing page is displayed only once and updated via
danielebarchiesi@0:  * AHAH requests, so only the first batch set gets to define the page title.
danielebarchiesi@0:  * Titles specified by subsequent batch sets are not displayed.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see batch_set()
danielebarchiesi@0:  * @see _batch_do()
danielebarchiesi@0:  */
danielebarchiesi@0: function _batch_progress_page_js() {
danielebarchiesi@0:   $batch = batch_get();
danielebarchiesi@0: 
danielebarchiesi@0:   $current_set = _batch_current_set();
danielebarchiesi@0:   drupal_set_title($current_set['title'], PASS_THROUGH);
danielebarchiesi@0: 
danielebarchiesi@0:   // Merge required query parameters for batch processing into those provided by
danielebarchiesi@0:   // batch_set() or hook_batch_alter().
danielebarchiesi@0:   $batch['url_options']['query']['id'] = $batch['id'];
danielebarchiesi@0: 
danielebarchiesi@0:   $js_setting = array(
danielebarchiesi@0:     'batch' => array(
danielebarchiesi@0:       'errorMessage' => $current_set['error_message'] . '<br />' . $batch['error_message'],
danielebarchiesi@0:       'initMessage' => $current_set['init_message'],
danielebarchiesi@0:       'uri' => url($batch['url'], $batch['url_options']),
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0:   drupal_add_js($js_setting, 'setting');
danielebarchiesi@0:   drupal_add_library('system', 'drupal.batch');
danielebarchiesi@0: 
danielebarchiesi@0:   return '<div id="progress"></div>';
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Does one execution pass with JavaScript and returns progress to the browser.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see _batch_progress_page_js()
danielebarchiesi@0:  * @see _batch_process()
danielebarchiesi@0:  */
danielebarchiesi@0: function _batch_do() {
danielebarchiesi@0:   // HTTP POST required.
danielebarchiesi@0:   if ($_SERVER['REQUEST_METHOD'] != 'POST') {
danielebarchiesi@0:     drupal_set_message(t('HTTP POST is required.'), 'error');
danielebarchiesi@0:     drupal_set_title(t('Error'));
danielebarchiesi@0:     return '';
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Perform actual processing.
danielebarchiesi@0:   list($percentage, $message) = _batch_process();
danielebarchiesi@0: 
danielebarchiesi@0:   drupal_json_output(array('status' => TRUE, 'percentage' => $percentage, 'message' => $message));
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Outputs a batch processing page without JavaScript support.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see _batch_process()
danielebarchiesi@0:  */
danielebarchiesi@0: function _batch_progress_page_nojs() {
danielebarchiesi@0:   $batch = &batch_get();
danielebarchiesi@0: 
danielebarchiesi@0:   $current_set = _batch_current_set();
danielebarchiesi@0:   drupal_set_title($current_set['title'], PASS_THROUGH);
danielebarchiesi@0: 
danielebarchiesi@0:   $new_op = 'do_nojs';
danielebarchiesi@0: 
danielebarchiesi@0:   if (!isset($batch['running'])) {
danielebarchiesi@0:     // This is the first page so we return some output immediately.
danielebarchiesi@0:     $percentage       = 0;
danielebarchiesi@0:     $message          = $current_set['init_message'];
danielebarchiesi@0:     $batch['running'] = TRUE;
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     // This is one of the later requests; do some processing first.
danielebarchiesi@0: 
danielebarchiesi@0:     // Error handling: if PHP dies due to a fatal error (e.g. a nonexistent
danielebarchiesi@0:     // function), it will output whatever is in the output buffer, followed by
danielebarchiesi@0:     // the error message.
danielebarchiesi@0:     ob_start();
danielebarchiesi@0:     $fallback = $current_set['error_message'] . '<br />' . $batch['error_message'];
danielebarchiesi@0:     $fallback = theme('maintenance_page', array('content' => $fallback, 'show_messages' => FALSE));
danielebarchiesi@0: 
danielebarchiesi@0:     // We strip the end of the page using a marker in the template, so any
danielebarchiesi@0:     // additional HTML output by PHP shows up inside the page rather than below
danielebarchiesi@0:     // it. While this causes invalid HTML, the same would be true if we didn't,
danielebarchiesi@0:     // as content is not allowed to appear after </html> anyway.
danielebarchiesi@0:     list($fallback) = explode('<!--partial-->', $fallback);
danielebarchiesi@0:     print $fallback;
danielebarchiesi@0: 
danielebarchiesi@0:     // Perform actual processing.
danielebarchiesi@0:     list($percentage, $message) = _batch_process($batch);
danielebarchiesi@0:     if ($percentage == 100) {
danielebarchiesi@0:       $new_op = 'finished';
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // PHP did not die; remove the fallback output.
danielebarchiesi@0:     ob_end_clean();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Merge required query parameters for batch processing into those provided by
danielebarchiesi@0:   // batch_set() or hook_batch_alter().
danielebarchiesi@0:   $batch['url_options']['query']['id'] = $batch['id'];
danielebarchiesi@0:   $batch['url_options']['query']['op'] = $new_op;
danielebarchiesi@0: 
danielebarchiesi@0:   $url = url($batch['url'], $batch['url_options']);
danielebarchiesi@0:   $element = array(
danielebarchiesi@0:     '#tag' => 'meta',
danielebarchiesi@0:     '#attributes' => array(
danielebarchiesi@0:       'http-equiv' => 'Refresh',
danielebarchiesi@0:       'content' => '0; URL=' . $url,
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0:   drupal_add_html_head($element, 'batch_progress_meta_refresh');
danielebarchiesi@0: 
danielebarchiesi@0:   return theme('progress_bar', array('percent' => $percentage, 'message' => $message));
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Processes sets in a batch.
danielebarchiesi@0:  *
danielebarchiesi@0:  * If the batch was marked for progressive execution (default), this executes as
danielebarchiesi@0:  * many operations in batch sets until an execution time of 1 second has been
danielebarchiesi@0:  * exceeded. It will continue with the next operation of the same batch set in
danielebarchiesi@0:  * the next request.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array containing a completion value (in percent) and a status message.
danielebarchiesi@0:  */
danielebarchiesi@0: function _batch_process() {
danielebarchiesi@0:   $batch       = &batch_get();
danielebarchiesi@0:   $current_set = &_batch_current_set();
danielebarchiesi@0:   // Indicate that this batch set needs to be initialized.
danielebarchiesi@0:   $set_changed = TRUE;
danielebarchiesi@0: 
danielebarchiesi@0:   // If this batch was marked for progressive execution (e.g. forms submitted by
danielebarchiesi@0:   // drupal_form_submit()), initialize a timer to determine whether we need to
danielebarchiesi@0:   // proceed with the same batch phase when a processing time of 1 second has
danielebarchiesi@0:   // been exceeded.
danielebarchiesi@0:   if ($batch['progressive']) {
danielebarchiesi@0:     timer_start('batch_processing');
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($current_set['start'])) {
danielebarchiesi@0:     $current_set['start'] = microtime(TRUE);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $queue = _batch_queue($current_set);
danielebarchiesi@0: 
danielebarchiesi@0:   while (!$current_set['success']) {
danielebarchiesi@0:     // If this is the first time we iterate this batch set in the current
danielebarchiesi@0:     // request, we check if it requires an additional file for functions
danielebarchiesi@0:     // definitions.
danielebarchiesi@0:     if ($set_changed && isset($current_set['file']) && is_file($current_set['file'])) {
danielebarchiesi@0:       include_once DRUPAL_ROOT . '/' . $current_set['file'];
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $task_message = '';
danielebarchiesi@0:     // Assume a single pass operation and set the completion level to 1 by
danielebarchiesi@0:     // default.
danielebarchiesi@0:     $finished = 1;
danielebarchiesi@0: 
danielebarchiesi@0:     if ($item = $queue->claimItem()) {
danielebarchiesi@0:       list($function, $args) = $item->data;
danielebarchiesi@0: 
danielebarchiesi@0:       // Build the 'context' array and execute the function call.
danielebarchiesi@0:       $batch_context = array(
danielebarchiesi@0:         'sandbox'  => &$current_set['sandbox'],
danielebarchiesi@0:         'results'  => &$current_set['results'],
danielebarchiesi@0:         'finished' => &$finished,
danielebarchiesi@0:         'message'  => &$task_message,
danielebarchiesi@0:       );
danielebarchiesi@0:       call_user_func_array($function, array_merge($args, array(&$batch_context)));
danielebarchiesi@0: 
danielebarchiesi@0:       if ($finished >= 1) {
danielebarchiesi@0:         // Make sure this step is not counted twice when computing $current.
danielebarchiesi@0:         $finished = 0;
danielebarchiesi@0:         // Remove the processed operation and clear the sandbox.
danielebarchiesi@0:         $queue->deleteItem($item);
danielebarchiesi@0:         $current_set['count']--;
danielebarchiesi@0:         $current_set['sandbox'] = array();
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // When all operations in the current batch set are completed, browse
danielebarchiesi@0:     // through the remaining sets, marking them 'successfully processed'
danielebarchiesi@0:     // along the way, until we find a set that contains operations.
danielebarchiesi@0:     // _batch_next_set() executes form submit handlers stored in 'control'
danielebarchiesi@0:     // sets (see form_execute_handlers()), which can in turn add new sets to
danielebarchiesi@0:     // the batch.
danielebarchiesi@0:     $set_changed = FALSE;
danielebarchiesi@0:     $old_set = $current_set;
danielebarchiesi@0:     while (empty($current_set['count']) && ($current_set['success'] = TRUE) && _batch_next_set()) {
danielebarchiesi@0:       $current_set = &_batch_current_set();
danielebarchiesi@0:       $current_set['start'] = microtime(TRUE);
danielebarchiesi@0:       $set_changed = TRUE;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // At this point, either $current_set contains operations that need to be
danielebarchiesi@0:     // processed or all sets have been completed.
danielebarchiesi@0:     $queue = _batch_queue($current_set);
danielebarchiesi@0: 
danielebarchiesi@0:     // If we are in progressive mode, break processing after 1 second.
danielebarchiesi@0:     if ($batch['progressive'] && timer_read('batch_processing') > 1000) {
danielebarchiesi@0:       // Record elapsed wall clock time.
danielebarchiesi@0:       $current_set['elapsed'] = round((microtime(TRUE) - $current_set['start']) * 1000, 2);
danielebarchiesi@0:       break;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($batch['progressive']) {
danielebarchiesi@0:     // Gather progress information.
danielebarchiesi@0: 
danielebarchiesi@0:     // Reporting 100% progress will cause the whole batch to be considered
danielebarchiesi@0:     // processed. If processing was paused right after moving to a new set,
danielebarchiesi@0:     // we have to use the info from the new (unprocessed) set.
danielebarchiesi@0:     if ($set_changed && isset($current_set['queue'])) {
danielebarchiesi@0:       // Processing will continue with a fresh batch set.
danielebarchiesi@0:       $remaining        = $current_set['count'];
danielebarchiesi@0:       $total            = $current_set['total'];
danielebarchiesi@0:       $progress_message = $current_set['init_message'];
danielebarchiesi@0:       $task_message     = '';
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       // Processing will continue with the current batch set.
danielebarchiesi@0:       $remaining        = $old_set['count'];
danielebarchiesi@0:       $total            = $old_set['total'];
danielebarchiesi@0:       $progress_message = $old_set['progress_message'];
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Total progress is the number of operations that have fully run plus the
danielebarchiesi@0:     // completion level of the current operation.
danielebarchiesi@0:     $current    = $total - $remaining + $finished;
danielebarchiesi@0:     $percentage = _batch_api_percentage($total, $current);
danielebarchiesi@0:     $elapsed    = isset($current_set['elapsed']) ? $current_set['elapsed'] : 0;
danielebarchiesi@0:     $values     = array(
danielebarchiesi@0:       '@remaining'  => $remaining,
danielebarchiesi@0:       '@total'      => $total,
danielebarchiesi@0:       '@current'    => floor($current),
danielebarchiesi@0:       '@percentage' => $percentage,
danielebarchiesi@0:       '@elapsed'    => format_interval($elapsed / 1000),
danielebarchiesi@0:       // If possible, estimate remaining processing time.
danielebarchiesi@0:       '@estimate'   => ($current > 0) ? format_interval(($elapsed * ($total - $current) / $current) / 1000) : '-',
danielebarchiesi@0:     );
danielebarchiesi@0:     $message = strtr($progress_message, $values);
danielebarchiesi@0:     if (!empty($message)) {
danielebarchiesi@0:       $message .= '<br />';
danielebarchiesi@0:     }
danielebarchiesi@0:     if (!empty($task_message)) {
danielebarchiesi@0:       $message .= $task_message;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     return array($percentage, $message);
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     // If we are not in progressive mode, the entire batch has been processed.
danielebarchiesi@0:     return _batch_finished();
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Formats the percent completion for a batch set.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $total
danielebarchiesi@0:  *   The total number of operations.
danielebarchiesi@0:  * @param $current
danielebarchiesi@0:  *   The number of the current operation. This may be a floating point number
danielebarchiesi@0:  *   rather than an integer in the case of a multi-step operation that is not
danielebarchiesi@0:  *   yet complete; in that case, the fractional part of $current represents the
danielebarchiesi@0:  *   fraction of the operation that has been completed.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   The properly formatted percentage, as a string. We output percentages
danielebarchiesi@0:  *   using the correct number of decimal places so that we never print "100%"
danielebarchiesi@0:  *   until we are finished, but we also never print more decimal places than
danielebarchiesi@0:  *   are meaningful.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see _batch_process()
danielebarchiesi@0:  */
danielebarchiesi@0: function _batch_api_percentage($total, $current) {
danielebarchiesi@0:   if (!$total || $total == $current) {
danielebarchiesi@0:     // If $total doesn't evaluate as true or is equal to the current set, then
danielebarchiesi@0:     // we're finished, and we can return "100".
danielebarchiesi@0:     $percentage = "100";
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     // We add a new digit at 200, 2000, etc. (since, for example, 199/200
danielebarchiesi@0:     // would round up to 100% if we didn't).
danielebarchiesi@0:     $decimal_places = max(0, floor(log10($total / 2.0)) - 1);
danielebarchiesi@0:     do {
danielebarchiesi@0:       // Calculate the percentage to the specified number of decimal places.
danielebarchiesi@0:       $percentage = sprintf('%01.' . $decimal_places . 'f', round($current / $total * 100, $decimal_places));
danielebarchiesi@0:       // When $current is an integer, the above calculation will always be
danielebarchiesi@0:       // correct. However, if $current is a floating point number (in the case
danielebarchiesi@0:       // of a multi-step batch operation that is not yet complete), $percentage
danielebarchiesi@0:       // may be erroneously rounded up to 100%. To prevent that, we add one
danielebarchiesi@0:       // more decimal place and try again.
danielebarchiesi@0:       $decimal_places++;
danielebarchiesi@0:     } while ($percentage == '100');
danielebarchiesi@0:   }
danielebarchiesi@0:   return $percentage;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Returns the batch set being currently processed.
danielebarchiesi@0:  */
danielebarchiesi@0: function &_batch_current_set() {
danielebarchiesi@0:   $batch = &batch_get();
danielebarchiesi@0:   return $batch['sets'][$batch['current_set']];
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Retrieves the next set in a batch.
danielebarchiesi@0:  *
danielebarchiesi@0:  * If there is a subsequent set in this batch, assign it as the new set to
danielebarchiesi@0:  * process and execute its form submit handler (if defined), which may add
danielebarchiesi@0:  * further sets to this batch.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   TRUE if a subsequent set was found in the batch.
danielebarchiesi@0:  */
danielebarchiesi@0: function _batch_next_set() {
danielebarchiesi@0:   $batch = &batch_get();
danielebarchiesi@0:   if (isset($batch['sets'][$batch['current_set'] + 1])) {
danielebarchiesi@0:     $batch['current_set']++;
danielebarchiesi@0:     $current_set = &_batch_current_set();
danielebarchiesi@0:     if (isset($current_set['form_submit']) && ($function = $current_set['form_submit']) && function_exists($function)) {
danielebarchiesi@0:       // We use our stored copies of $form and $form_state to account for
danielebarchiesi@0:       // possible alterations by previous form submit handlers.
danielebarchiesi@0:       $function($batch['form_state']['complete form'], $batch['form_state']);
danielebarchiesi@0:     }
danielebarchiesi@0:     return TRUE;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Ends the batch processing.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Call the 'finished' callback of each batch set to allow custom handling of
danielebarchiesi@0:  * the results and resolve page redirection.
danielebarchiesi@0:  */
danielebarchiesi@0: function _batch_finished() {
danielebarchiesi@0:   $batch = &batch_get();
danielebarchiesi@0: 
danielebarchiesi@0:   // Execute the 'finished' callbacks for each batch set, if defined.
danielebarchiesi@0:   foreach ($batch['sets'] as $batch_set) {
danielebarchiesi@0:     if (isset($batch_set['finished'])) {
danielebarchiesi@0:       // Check if the set requires an additional file for function definitions.
danielebarchiesi@0:       if (isset($batch_set['file']) && is_file($batch_set['file'])) {
danielebarchiesi@0:         include_once DRUPAL_ROOT . '/' . $batch_set['file'];
danielebarchiesi@0:       }
danielebarchiesi@0:       if (function_exists($batch_set['finished'])) {
danielebarchiesi@0:         $queue = _batch_queue($batch_set);
danielebarchiesi@0:         $operations = $queue->getAllItems();
danielebarchiesi@0:         $batch_set['finished']($batch_set['success'], $batch_set['results'], $operations, format_interval($batch_set['elapsed'] / 1000));
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Clean up the batch table and unset the static $batch variable.
danielebarchiesi@0:   if ($batch['progressive']) {
danielebarchiesi@0:     db_delete('batch')
danielebarchiesi@0:       ->condition('bid', $batch['id'])
danielebarchiesi@0:       ->execute();
danielebarchiesi@0:     foreach ($batch['sets'] as $batch_set) {
danielebarchiesi@0:       if ($queue = _batch_queue($batch_set)) {
danielebarchiesi@0:         $queue->deleteQueue();
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   $_batch = $batch;
danielebarchiesi@0:   $batch = NULL;
danielebarchiesi@0: 
danielebarchiesi@0:   // Clean-up the session. Not needed for CLI updates.
danielebarchiesi@0:   if (isset($_SESSION)) {
danielebarchiesi@0:     unset($_SESSION['batches'][$batch['id']]);
danielebarchiesi@0:     if (empty($_SESSION['batches'])) {
danielebarchiesi@0:       unset($_SESSION['batches']);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Redirect if needed.
danielebarchiesi@0:   if ($_batch['progressive']) {
danielebarchiesi@0:     // Revert the 'destination' that was saved in batch_process().
danielebarchiesi@0:     if (isset($_batch['destination'])) {
danielebarchiesi@0:       $_GET['destination'] = $_batch['destination'];
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Determine the target path to redirect to.
danielebarchiesi@0:     if (!isset($_batch['form_state']['redirect'])) {
danielebarchiesi@0:       if (isset($_batch['redirect'])) {
danielebarchiesi@0:         $_batch['form_state']['redirect'] = $_batch['redirect'];
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         $_batch['form_state']['redirect'] = $_batch['source_url'];
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Use drupal_redirect_form() to handle the redirection logic.
danielebarchiesi@0:     drupal_redirect_form($_batch['form_state']);
danielebarchiesi@0: 
danielebarchiesi@0:     // If no redirection happened, redirect to the originating page. In case the
danielebarchiesi@0:     // form needs to be rebuilt, save the final $form_state for
danielebarchiesi@0:     // drupal_build_form().
danielebarchiesi@0:     if (!empty($_batch['form_state']['rebuild'])) {
danielebarchiesi@0:       $_SESSION['batch_form_state'] = $_batch['form_state'];
danielebarchiesi@0:     }
danielebarchiesi@0:     $function = $_batch['redirect_callback'];
danielebarchiesi@0:     if (function_exists($function)) {
danielebarchiesi@0:       $function($_batch['source_url'], array('query' => array('op' => 'finish', 'id' => $_batch['id'])));
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Shutdown function: Stores the current batch data for the next request.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see _batch_page()
danielebarchiesi@0:  * @see drupal_register_shutdown_function()
danielebarchiesi@0:  */
danielebarchiesi@0: function _batch_shutdown() {
danielebarchiesi@0:   if ($batch = batch_get()) {
danielebarchiesi@0:     db_update('batch')
danielebarchiesi@0:       ->fields(array('batch' => serialize($batch)))
danielebarchiesi@0:       ->condition('bid', $batch['id'])
danielebarchiesi@0:       ->execute();
danielebarchiesi@0:   }
danielebarchiesi@0: }