batch.inc 17.1 KB
Newer Older
1 2 3
<?php

/**
4 5 6
 * @file
 * Batch processing API for processes to run in multiple HTTP requests.
 *
7
 * Note that batches are usually invoked by form submissions, which is
8 9 10 11 12 13 14
 * why the core interaction functions of the batch processing API live in
 * form.inc.
 *
 * @see form.inc
 * @see batch_set()
 * @see batch_process()
 * @see batch_get()
15 16
 */

17 18 19 20 21 22
/**
 * Loads a batch from the database.
 *
 * @param $id
 *   The ID of the batch to load. When a progressive batch is being processed,
 *   the relevant ID is found in $_REQUEST['id'].
23
 *
24 25 26 27 28 29 30 31 32 33 34 35 36 37
 * @return
 *   An array representing the batch, or FALSE if no batch was found.
 */
function batch_load($id) {
  $batch = db_query("SELECT batch FROM {batch} WHERE bid = :bid AND token = :token", array(
    ':bid' => $id,
    ':token' => drupal_get_token($id),
  ))->fetchField();
  if ($batch) {
    return unserialize($batch);
  }
  return FALSE;
}

38
/**
39
 * Renders the batch processing page based on the current state of the batch.
40 41
 *
 * @see _batch_shutdown()
42 43
 */
function _batch_page() {
44
  $batch = &batch_get();
45

46
  if (!isset($_REQUEST['id'])) {
47 48 49
    return FALSE;
  }

50
  // Retrieve the current state of the batch.
51
  if (!$batch) {
52 53 54 55 56
    $batch = batch_load($_REQUEST['id']);
    if (!$batch) {
      drupal_set_message(t('No active batch.'), 'error');
      drupal_goto();
    }
57 58
  }

59
  // Register database update for the end of processing.
60
  drupal_register_shutdown_function('_batch_shutdown');
61

62
  // Add batch-specific CSS.
63
  foreach ($batch['sets'] as $batch_set) {
64 65 66 67
    if (isset($batch_set['css'])) {
      foreach ($batch_set['css'] as $css) {
        drupal_add_css($css);
      }
68 69 70
    }
  }

71
  $op = isset($_REQUEST['op']) ? $_REQUEST['op'] : '';
72
  $output = NULL;
73 74 75 76 77 78
  switch ($op) {
    case 'start':
      $output = _batch_start();
      break;

    case 'do':
79
      // JavaScript-based progress page callback.
80
      _batch_do();
81 82 83
      break;

    case 'do_nojs':
84
      // Non-JavaScript-based progress page.
85 86 87 88 89 90 91 92 93 94 95 96
      $output = _batch_progress_page_nojs();
      break;

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

  return $output;
}

/**
97
 * Initializes the batch processing.
98 99 100 101
 *
 * JavaScript-enabled clients are identified by the 'has_js' cookie set in
 * drupal.js. If no JavaScript-enabled page has been visited during the current
 * user's browser session, the non-JavaScript version is returned.
102 103 104 105 106 107 108 109 110 111 112
 */
function _batch_start() {
  if (isset($_COOKIE['has_js']) && $_COOKIE['has_js']) {
    return _batch_progress_page_js();
  }
  else {
    return _batch_progress_page_nojs();
  }
}

/**
113
 * Outputs a batch processing page with JavaScript support.
114 115 116 117 118 119 120 121
 *
 * This initializes the batch and error messages. Note that in JavaScript-based
 * processing, the batch processing page is displayed only once and updated via
 * AHAH requests, so only the first batch set gets to define the page title.
 * Titles specified by subsequent batch sets are not displayed.
 *
 * @see batch_set()
 * @see _batch_do()
122 123 124 125
 */
function _batch_progress_page_js() {
  $batch = batch_get();

126
  $current_set = _batch_current_set();
127
  drupal_set_title($current_set['title'], PASS_THROUGH);
128

129 130 131 132
  // Merge required query parameters for batch processing into those provided by
  // batch_set() or hook_batch_alter().
  $batch['url_options']['query']['id'] = $batch['id'];

133 134
  $js_setting = array(
    'batch' => array(
135
      'errorMessage' => $current_set['error_message'] . '<br />' . $batch['error_message'],
136
      'initMessage' => $current_set['init_message'],
137
      'uri' => url($batch['url'], $batch['url_options']),
138 139 140
    ),
  );
  drupal_add_js($js_setting, 'setting');
141
  drupal_add_library('system', 'drupal.batch');
142

143
  return '<div id="progress"></div>';
144 145 146
}

/**
147
 * Does one execution pass with JavaScript and returns progress to the browser.
148 149 150
 *
 * @see _batch_progress_page_js()
 * @see _batch_process()
151 152
 */
function _batch_do() {
153
  // HTTP POST required.
154 155 156 157 158 159
  if ($_SERVER['REQUEST_METHOD'] != 'POST') {
    drupal_set_message(t('HTTP POST is required.'), 'error');
    drupal_set_title(t('Error'));
    return '';
  }

160
  // Perform actual processing.
161 162
  list($percentage, $message) = _batch_process();

163
  drupal_json_output(array('status' => TRUE, 'percentage' => $percentage, 'message' => $message));
164 165 166
}

/**
167
 * Outputs a batch processing page without JavaScript support.
168 169
 *
 * @see _batch_process()
170 171
 */
function _batch_progress_page_nojs() {
172
  $batch = &batch_get();
173

174
  $current_set = _batch_current_set();
175
  drupal_set_title($current_set['title'], PASS_THROUGH);
176 177 178 179

  $new_op = 'do_nojs';

  if (!isset($batch['running'])) {
180
    // This is the first page so we return some output immediately.
181 182
    $percentage       = 0;
    $message          = $current_set['init_message'];
183 184 185
    $batch['running'] = TRUE;
  }
  else {
186
    // This is one of the later requests; do some processing first.
187

188 189 190
    // Error handling: if PHP dies due to a fatal error (e.g. a nonexistent
    // function), it will output whatever is in the output buffer, followed by
    // the error message.
191
    ob_start();
192
    $fallback = $current_set['error_message'] . '<br />' . $batch['error_message'];
193
    $fallback = theme('maintenance_page', array('content' => $fallback, 'show_messages' => FALSE));
194 195

    // We strip the end of the page using a marker in the template, so any
196 197 198
    // 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.
199 200 201
    list($fallback) = explode('<!--partial-->', $fallback);
    print $fallback;

202
    // Perform actual processing.
203 204 205 206 207
    list($percentage, $message) = _batch_process($batch);
    if ($percentage == 100) {
      $new_op = 'finished';
    }

208
    // PHP did not die; remove the fallback output.
209 210 211
    ob_end_clean();
  }

212 213 214 215 216 217
  // Merge required query parameters for batch processing into those provided by
  // batch_set() or hook_batch_alter().
  $batch['url_options']['query']['id'] = $batch['id'];
  $batch['url_options']['query']['op'] = $new_op;

  $url = url($batch['url'], $batch['url_options']);
218 219 220 221 222 223 224 225
  $element = array(
    '#tag' => 'meta',
    '#attributes' => array(
      'http-equiv' => 'Refresh',
      'content' => '0; URL=' . $url,
    ),
  );
  drupal_add_html_head($element, 'batch_progress_meta_refresh');
226

227
  return theme('progress_bar', array('percent' => $percentage, 'message' => $message));
228 229 230
}

/**
231
 * Processes sets in a batch.
232 233 234 235 236 237 238 239
 *
 * If the batch was marked for progressive execution (default), this executes as
 * many operations in batch sets until an execution time of 1 second has been
 * exceeded. It will continue with the next operation of the same batch set in
 * the next request.
 *
 * @return
 *   An array containing a completion value (in percent) and a status message.
240 241
 */
function _batch_process() {
242 243 244
  $batch       = &batch_get();
  $current_set = &_batch_current_set();
  // Indicate that this batch set needs to be initialized.
245
  $set_changed = TRUE;
246

247
  // If this batch was marked for progressive execution (e.g. forms submitted by
248
  // drupal_form_submit()), initialize a timer to determine whether we need to
249 250
  // proceed with the same batch phase when a processing time of 1 second has
  // been exceeded.
251 252 253 254
  if ($batch['progressive']) {
    timer_start('batch_processing');
  }

255 256 257 258 259 260
  if (empty($current_set['start'])) {
    $current_set['start'] = microtime(TRUE);
  }

  $queue = _batch_queue($current_set);

261
  while (!$current_set['success']) {
262 263 264 265
    // 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'])) {
266
      include_once DRUPAL_ROOT . '/' . $current_set['file'];
267 268
    }

269
    $task_message = '';
270
    // Assume a single pass operation and set the completion level to 1 by
271
    // default.
272
    $finished = 1;
273 274 275 276 277

    if ($item = $queue->claimItem()) {
      list($function, $args) = $item->data;

      // Build the 'context' array and execute the function call.
278 279 280 281 282 283
      $batch_context = array(
        'sandbox'  => &$current_set['sandbox'],
        'results'  => &$current_set['results'],
        'finished' => &$finished,
        'message'  => &$task_message,
      );
284
      call_user_func_array($function, array_merge($args, array(&$batch_context)));
285

286
      if ($finished >= 1) {
287 288 289 290 291 292 293
        // Make sure this step is not counted twice when computing $current.
        $finished = 0;
        // Remove the processed operation and clear the sandbox.
        $queue->deleteItem($item);
        $current_set['count']--;
        $current_set['sandbox'] = array();
      }
294
    }
295

296
    // When all operations in the current batch set are completed, browse
297 298 299 300 301
    // through the remaining sets, marking them 'successfully processed'
    // along the way, until we find a set that contains operations.
    // _batch_next_set() executes form submit handlers stored in 'control'
    // sets (see form_execute_handlers()), which can in turn add new sets to
    // the batch.
302 303
    $set_changed = FALSE;
    $old_set = $current_set;
304
    while (empty($current_set['count']) && ($current_set['success'] = TRUE) && _batch_next_set()) {
305
      $current_set = &_batch_current_set();
306
      $current_set['start'] = microtime(TRUE);
307
      $set_changed = TRUE;
308
    }
309

310 311
    // At this point, either $current_set contains operations that need to be
    // processed or all sets have been completed.
312
    $queue = _batch_queue($current_set);
313

314
    // If we are in progressive mode, break processing after 1 second.
315
    if ($batch['progressive'] && timer_read('batch_processing') > 1000) {
Dries's avatar
Dries committed
316
      // Record elapsed wall clock time.
317
      $current_set['elapsed'] = round((microtime(TRUE) - $current_set['start']) * 1000, 2);
318 319 320 321 322
      break;
    }
  }

  if ($batch['progressive']) {
323 324 325 326
    // 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,
327
    // we have to use the info from the new (unprocessed) set.
328
    if ($set_changed && isset($current_set['queue'])) {
329
      // Processing will continue with a fresh batch set.
330
      $remaining        = $current_set['count'];
331
      $total            = $current_set['total'];
332
      $progress_message = $current_set['init_message'];
333
      $task_message     = '';
334 335
    }
    else {
336
      // Processing will continue with the current batch set.
337
      $remaining        = $old_set['count'];
338
      $total            = $old_set['total'];
339 340 341
      $progress_message = $old_set['progress_message'];
    }

342 343
    // Total progress is the number of operations that have fully run plus the
    // completion level of the current operation.
344
    $current    = $total - $remaining + $finished;
345
    $percentage = _batch_api_percentage($total, $current);
346
    $elapsed    = isset($current_set['elapsed']) ? $current_set['elapsed'] : 0;
347
    $values     = array(
348 349 350 351
      '@remaining'  => $remaining,
      '@total'      => $total,
      '@current'    => floor($current),
      '@percentage' => $percentage,
352
      '@elapsed'    => format_interval($elapsed / 1000),
353 354
      // If possible, estimate remaining processing time.
      '@estimate'   => ($current > 0) ? format_interval(($elapsed * ($total - $current) / $current) / 1000) : '-',
355 356 357
    );
    $message = strtr($progress_message, $values);
    if (!empty($message)) {
358 359 360 361
      $message .= '<br />';
    }
    if (!empty($task_message)) {
      $message .= $task_message;
362
    }
363 364 365 366

    return array($percentage, $message);
  }
  else {
367
    // If we are not in progressive mode, the entire batch has been processed.
368 369 370 371
    return _batch_finished();
  }
}

372
/**
373
 * Formats the percent completion for a batch set.
374 375 376 377
 *
 * @param $total
 *   The total number of operations.
 * @param $current
378 379 380 381
 *   The number of the current operation. This may be a floating point number
 *   rather than an integer in the case of a multi-step operation that is not
 *   yet complete; in that case, the fractional part of $current represents the
 *   fraction of the operation that has been completed.
382
 *
383 384 385 386 387
 * @return
 *   The properly formatted percentage, as a string. We output percentages
 *   using the correct number of decimal places so that we never print "100%"
 *   until we are finished, but we also never print more decimal places than
 *   are meaningful.
388 389
 *
 * @see _batch_process()
390 391 392 393 394 395 396 397 398 399 400
 */
function _batch_api_percentage($total, $current) {
  if (!$total || $total == $current) {
    // If $total doesn't evaluate as true or is equal to the current set, then
    // we're finished, and we can return "100".
    $percentage = "100";
  }
  else {
    // We add a new digit at 200, 2000, etc. (since, for example, 199/200
    // would round up to 100% if we didn't).
    $decimal_places = max(0, floor(log10($total / 2.0)) - 1);
401 402 403 404 405 406 407 408 409 410
    do {
      // Calculate the percentage to the specified number of decimal places.
      $percentage = sprintf('%01.' . $decimal_places . 'f', round($current / $total * 100, $decimal_places));
      // When $current is an integer, the above calculation will always be
      // correct. However, if $current is a floating point number (in the case
      // of a multi-step batch operation that is not yet complete), $percentage
      // may be erroneously rounded up to 100%. To prevent that, we add one
      // more decimal place and try again.
      $decimal_places++;
    } while ($percentage == '100');
411 412 413 414
  }
  return $percentage;
}

415
/**
416
 * Returns the batch set being currently processed.
417 418
 */
function &_batch_current_set() {
419
  $batch = &batch_get();
420 421 422 423
  return $batch['sets'][$batch['current_set']];
}

/**
424
 * Retrieves the next set in a batch.
425 426 427 428 429 430 431
 *
 * If there is a subsequent set in this batch, assign it as the new set to
 * process and execute its form submit handler (if defined), which may add
 * further sets to this batch.
 *
 * @return
 *   TRUE if a subsequent set was found in the batch.
432 433
 */
function _batch_next_set() {
434
  $batch = &batch_get();
435
  if (isset($batch['sets'][$batch['current_set'] + 1])) {
436
    $batch['current_set']++;
437
    $current_set = &_batch_current_set();
438
    if (isset($current_set['form_submit']) && ($function = $current_set['form_submit']) && function_exists($function)) {
439 440
      // We use our stored copies of $form and $form_state to account for
      // possible alterations by previous form submit handlers.
441
      $function($batch['form_state']['complete_form'], $batch['form_state']);
442 443 444 445 446 447
    }
    return TRUE;
  }
}

/**
448
 * Ends the batch processing.
449 450 451
 *
 * Call the 'finished' callback of each batch set to allow custom handling of
 * the results and resolve page redirection.
452 453
 */
function _batch_finished() {
454
  $batch = &batch_get();
455

456
  // Execute the 'finished' callbacks for each batch set, if defined.
457
  foreach ($batch['sets'] as $batch_set) {
458
    if (isset($batch_set['finished'])) {
459
      // Check if the set requires an additional file for function definitions.
460
      if (isset($batch_set['file']) && is_file($batch_set['file'])) {
461
        include_once DRUPAL_ROOT . '/' . $batch_set['file'];
462 463
      }
      if (function_exists($batch_set['finished'])) {
464 465 466
        $queue = _batch_queue($batch_set);
        $operations = $queue->getAllItems();
        $batch_set['finished']($batch_set['success'], $batch_set['results'], $operations, format_interval($batch_set['elapsed'] / 1000));
467
      }
468 469 470
    }
  }

471
  // Clean up the batch table and unset the static $batch variable.
472
  if ($batch['progressive']) {
473 474 475
    db_delete('batch')
      ->condition('bid', $batch['id'])
      ->execute();
476 477 478 479 480
    foreach ($batch['sets'] as $batch_set) {
      if ($queue = _batch_queue($batch_set)) {
        $queue->deleteQueue();
      }
    }
481
  }
482 483 484
  $_batch = $batch;
  $batch = NULL;

485 486 487 488 489 490
  // Clean-up the session. Not needed for CLI updates.
  if (isset($_SESSION)) {
    unset($_SESSION['batches'][$batch['id']]);
    if (empty($_SESSION['batches'])) {
      unset($_SESSION['batches']);
    }
491 492
  }

493 494
  // Redirect if needed.
  if ($_batch['progressive']) {
495
    // Revert the 'destination' that was saved in batch_process().
496
    if (isset($_batch['destination'])) {
497
      $_GET['destination'] = $_batch['destination'];
498
    }
499

500
    // Determine the target path to redirect to.
501 502 503 504 505
    if (!isset($_batch['form_state']['redirect'])) {
      if (isset($_batch['redirect'])) {
        $_batch['form_state']['redirect'] = $_batch['redirect'];
      }
      else {
506
        $_batch['form_state']['redirect'] = $_batch['source_url'];
507
      }
508 509
    }

510
    // Use drupal_redirect_form() to handle the redirection logic.
511
    drupal_redirect_form($_batch['form_state']);
512

513 514 515 516 517 518
    // If no redirection happened, redirect to the originating page. In case the
    // form needs to be rebuilt, save the final $form_state for
    // drupal_build_form().
    if (!empty($_batch['form_state']['rebuild'])) {
      $_SESSION['batch_form_state'] = $_batch['form_state'];
    }
519 520
    $function = $_batch['redirect_callback'];
    if (function_exists($function)) {
521
      $function($_batch['source_url'], array('query' => array('op' => 'finish', 'id' => $_batch['id'])));
522
    }
523 524 525 526
  }
}

/**
527 528 529 530
 * Shutdown function: Stores the current batch data for the next request.
 *
 * @see _batch_page()
 * @see drupal_register_shutdown_function()
531 532 533
 */
function _batch_shutdown() {
  if ($batch = batch_get()) {
534 535 536 537
    db_update('batch')
      ->fields(array('batch' => serialize($batch)))
      ->condition('bid', $batch['id'])
      ->execute();
538 539
  }
}