batch.inc 11.4 KB
Newer Older
1
<?php
2
// $Id$
3 4 5 6 7 8

/**
 * @file Batch processing API for processes to run in multiple HTTP requests.
 */

/**
9
 * State-based dispatcher for the batch processing page.
10 11 12 13
 */
function _batch_page() {
  $batch =& batch_get();

14
  // Retrieve the current state of batch from db.
15
  if (isset($_REQUEST['id']) && $data = db_result(db_query("SELECT batch FROM {batch} WHERE bid = %d AND token = '%s'", $_REQUEST['id'], drupal_get_token($_REQUEST['id'])))) {
16 17 18 19 20 21 22 23 24
    $batch = unserialize($data);
  }
  else {
    return FALSE;
  }

  // Register database update for end of processing.
  register_shutdown_function('_batch_shutdown');

25 26 27 28 29 30 31
  // Add batch-specific css.
  foreach ($batch['sets'] as $batch_set) {
    foreach ($batch_set['css'] as $css) {
      drupal_add_css($css);
    }
  }

32
  $op = isset($_REQUEST['op']) ? $_REQUEST['op'] : '';
33
  $output = NULL;
34 35 36 37 38 39
  switch ($op) {
    case 'start':
      $output = _batch_start();
      break;

    case 'do':
40
      // JS-version AJAX callback.
41
      _batch_do();
42 43 44
      break;

    case 'do_nojs':
45
      // Non-JS progress page.
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
      $output = _batch_progress_page_nojs();
      break;

    case 'finished':
      $output = _batch_finished();
      break;
  }

  return $output;
}

/**
 * Initiate the batch processing
 */
function _batch_start() {
  // Choose between the JS and non-JS version.
  // JS-enabled users are identified through the 'has_js' cookie set in drupal.js.
  // If the user did not visit any JS enabled page during his browser session,
  // he gets the non-JS version...
  if (isset($_COOKIE['has_js']) && $_COOKIE['has_js']) {
    return _batch_progress_page_js();
  }
  else {
    return _batch_progress_page_nojs();
  }
}

/**
 * Batch processing page with JavaScript support.
 */
function _batch_progress_page_js() {
  $batch = batch_get();

79 80 81
  // The first batch set gets to set the page title
  // and the initialization and error messages.
  $current_set = _batch_current_set();
82
  drupal_set_title($current_set['title']);
83
  drupal_add_js('misc/progress.js', 'core', 'header', FALSE, FALSE);
84 85 86 87

  $url = url($batch['url'], array('query' => array('id' => $batch['id'])));
  $js_setting = array(
    'batch' => array(
88
      'errorMessage' => $current_set['error_message'] . '<br/>' . $batch['error_message'],
89 90 91 92 93
      'initMessage' => $current_set['init_message'],
      'uri' => $url,
    ),
  );
  drupal_add_js($js_setting, 'setting');
94
  drupal_add_js('misc/batch.js', 'core', 'header', FALSE, FALSE);
95 96 97 98 99 100

  $output = '<div id="progress"></div>';
  return $output;
}

/**
101 102
 * Do one pass of execution and inform back the browser about progression
 * (used for JavaScript-mode only).
103 104 105 106 107 108 109 110 111
 */
function _batch_do() {
  // HTTP POST required
  if ($_SERVER['REQUEST_METHOD'] != 'POST') {
    drupal_set_message(t('HTTP POST is required.'), 'error');
    drupal_set_title(t('Error'));
    return '';
  }

112
  // Perform actual processing.
113 114
  list($percentage, $message) = _batch_process();

115
  drupal_json(array('status' => TRUE, 'percentage' => $percentage, 'message' => $message));
116 117 118 119 120 121 122 123 124 125 126 127 128 129
}

/**
 * Batch processing page without JavaScript support.
 */
function _batch_progress_page_nojs() {
  $batch =& batch_get();
  $current_set = _batch_current_set();

  drupal_set_title($current_set['title']);

  $new_op = 'do_nojs';

  if (!isset($batch['running'])) {
130
    // This is the first page so we return some output immediately.
131 132 133 134 135 136 137 138 139 140 141
    $percentage = 0;
    $message = $current_set['init_message'];
    $batch['running'] = TRUE;
  }
  else {
    // This is one of the later requests: do some processing first.

    // Error handling: if PHP dies due to a fatal error (e.g. non-existant
    // function), it will output whatever is in the output buffer,
    // followed by the error message.
    ob_start();
142
    $fallback = $current_set['error_message'] . '<br/>' . $batch['error_message'];
143
    $fallback = theme('maintenance_page', $fallback, FALSE, FALSE);
144 145 146 147 148 149 150 151

    // We strip the end of the page using a marker in the template, so any
    // additional HTML output by PHP shows up inside the page rather than
    // below it. While this causes invalid HTML, the same would be true if
    // we didn't, as content is not allowed to appear after </html> anyway.
    list($fallback) = explode('<!--partial-->', $fallback);
    print $fallback;

152
    // Perform actual processing.
153 154 155 156 157
    list($percentage, $message) = _batch_process($batch);
    if ($percentage == 100) {
      $new_op = 'finished';
    }

158
    // PHP did not die : remove the fallback output.
159 160 161 162
    ob_end_clean();
  }

  $url = url($batch['url'], array('query' => array('id' => $batch['id'], 'op' => $new_op)));
163
  drupal_set_html_head('<meta http-equiv="Refresh" content="0; URL=' . $url . '">');
164 165 166 167 168 169
  $output = theme('progress_bar', $percentage, $message);
  return $output;
}

/**
 * Advance batch processing for 1 second (or process the whole batch if it
170
 * was not set for progressive execution - e.g forms submitted by drupal_execute).
171 172 173 174
 */
function _batch_process() {
  $batch =& batch_get();
  $current_set =& _batch_current_set();
175
  $set_changed = TRUE;
176

177 178 179 180
  if ($batch['progressive']) {
    timer_start('batch_processing');
  }

181
  while (!$current_set['success']) {
182 183 184 185 186 187 188
    // If this is the first time we iterate this batch set in the current
    // request, we check if it requires an additional file for functions
    // definitions.
    if ($set_changed && isset($current_set['file']) && is_file($current_set['file'])) {
      include_once($current_set['file']);
    }

189
    $task_message = '';
190 191 192
    // We assume a single pass operation and set the completion level
    // to 1 by default.
    $finished = 1;
193
    if ((list($function, $args) = reset($current_set['operations'])) && function_exists($function)) {
194 195
      // Build the 'context' array, execute the function call,
      // and retrieve the user message.
196
      $batch_context = array('sandbox' => &$current_set['sandbox'], 'results' => &$current_set['results'], 'finished' => &$finished, 'message' => &$task_message);
197
      // Process the current operation.
198 199
      call_user_func_array($function, array_merge($args, array(&$batch_context)));
    }
200

201
    if ($finished == 1) {
202
      // Make sure this step isn't counted double when computing $current.
203
      $finished = 0;
204
      // Remove the operation and clear the sandbox.
205 206
      array_shift($current_set['operations']);
      $current_set['sandbox'] = array();
207
    }
208

209
    // If the batch set is completed, browse through the remaining sets,
210 211 212
    // executing 'control sets' (stored form submit handlers) along the way -
    // this might in turn insert new batch sets.
    // Stop when we find a set that actually has operations.
213 214
    $set_changed = FALSE;
    $old_set = $current_set;
215 216
    while (empty($current_set['operations']) && ($current_set['success'] = TRUE) && _batch_next_set()) {
      $current_set =& _batch_current_set();
217
      $set_changed = TRUE;
218
    }
219 220
    // At this point, either $current_set is a 'real' batch set (has operations),
    // or all sets have been completed.
221

222
    // If we're in progressive mode, stop after 1 second.
223
    if ($batch['progressive'] && timer_read('batch_processing') > 1000) {
224 225 226 227 228
      break;
    }
  }

  if ($batch['progressive']) {
229 230 231 232
    // Gather progress information.

    // Reporting 100% progress will cause the whole batch to be considered
    // processed. If processing was paused right after moving to a new set,
233
    // we have to use the info from the new (unprocessed) one.
234 235 236 237 238 239 240 241 242 243 244 245 246
    if ($set_changed && isset($current_set['operations'])) {
      // Processing will continue with a fresh batch set.
      $remaining = count($current_set['operations']);
      $total = $current_set['total'];
      $progress_message = $current_set['init_message'];
      $task_message = '';
    }
    else {
      $remaining = count($old_set['operations']);
      $total = $old_set['total'];
      $progress_message = $old_set['progress_message'];
    }

247
    $current    = $total - $remaining + $finished;
248
    $percentage = $total ? floor($current / $total * 100) : 100;
249 250 251 252 253 254
    $values = array(
      '@remaining'  => $remaining,
      '@total'      => $total,
      '@current'    => floor($current),
      '@percentage' => $percentage,
      );
255
    $message = strtr($progress_message, $values) . '<br/>';
256
    $message .= $task_message ? $task_message : '&nbsp';
257 258 259 260

    return array($percentage, $message);
  }
  else {
261
    // If we're not in progressive mode, the whole batch has been processed by now.
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
    return _batch_finished();
  }

}

/**
 * Retrieve the batch set being currently processed.
 */
function &_batch_current_set() {
  $batch =& batch_get();
  return $batch['sets'][$batch['current_set']];
}

/**
 * Move execution to the next batch set if any, executing the stored
277
 * form _submit handlers along the way (thus possibly inserting
278
 * additional batch sets).
279 280 281
 */
function _batch_next_set() {
  $batch =& batch_get();
282
  if (isset($batch['sets'][$batch['current_set'] + 1])) {
283 284
    $batch['current_set']++;
    $current_set =& _batch_current_set();
285 286 287
    if (isset($current_set['form_submit']) && ($function = $current_set['form_submit']) && function_exists($function)) {
      // We use our stored copies of $form and $form_state, to account for
      // possible alteration by the submit handlers.
Dries's avatar
Dries committed
288
      $function($batch['form'], $batch['form_state']);
289 290 291 292 293 294
    }
    return TRUE;
  }
}

/**
295
 * End the batch processing:
296 297 298 299 300 301
 * Call the 'finished' callbacks to allow custom handling of results,
 * and resolve page redirection.
 */
function _batch_finished() {
  $batch =& batch_get();

302
  // Execute the 'finished' callbacks for each batch set.
303
  foreach ($batch['sets'] as $key => $batch_set) {
304 305 306 307 308 309 310 311
    if (isset($batch_set['finished'])) {
      // Check if the set requires an additional file for functions definitions.
      if (isset($batch_set['file']) && is_file($batch_set['file'])) {
        include_once($batch_set['file']);
      }
      if (function_exists($batch_set['finished'])) {
        $batch_set['finished']($batch_set['success'], $batch_set['results'], $batch_set['operations']);
      }
312 313 314 315
    }
  }

  // Cleanup the batch table and unset the global $batch variable.
316 317 318
  if ($batch['progressive']) {
    db_query("DELETE FROM {batch} WHERE bid = %d", $batch['id']);
  }
319 320 321 322 323
  $_batch = $batch;
  $batch = NULL;

  // Redirect if needed.
  if ($_batch['progressive']) {
324
    // Put back the 'destination' that was saved in batch_process().
325 326 327
    if (isset($_batch['destination'])) {
      $_REQUEST['destination'] = $_batch['destination'];
    }
328

329 330
    // Use $_batch['form_state']['redirect'], or $_batch['redirect'],
    // or $_batch['source_page'].
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
    if (isset($_batch['form_state']['redirect'])) {
      $redirect = $_batch['form_state']['redirect'];
    }
    elseif (isset($_batch['redirect'])) {
      $redirect = $_batch['redirect'];
    }
    else {
      $redirect = $_batch['source_page'];
    }

    // Let drupal_redirect_form handle redirection logic.
    $form = isset($batch['form']) ? $batch['form'] : array();
    if (empty($_batch['form_state']['rebuild']) && empty($_batch['form_state']['storage'])) {
      drupal_redirect_form($form, $redirect);
    }

347 348 349
    // We get here if $form['#redirect'] was FALSE, or if the form is a
    // multi-step form. We save the final $form_state value to be retrieved
    // by drupal_get_form, and we redirect to the originating page.
350
    $_SESSION['batch_form_state'] = $_batch['form_state'];
351 352 353 354 355
    drupal_goto($_batch['source_page']);
  }
}

/**
356 357
 * Shutdown function: store the batch data for next request,
 * or clear the table if the batch is finished.
358 359 360 361 362 363
 */
function _batch_shutdown() {
  if ($batch = batch_get()) {
    db_query("UPDATE {batch} SET batch = '%s' WHERE bid = %d", serialize($batch), $batch['id']);
  }
}