私は Batch API を使用して、通常は PHP タイムアウトまたはメモリ不足エラーにつながる処理を正常に実行してきましたが、うまく機能しています。
コードを少し調べましたが、舞台裏で何が起こっているのかまだわかりません。
プロセスに詳しい人は、それがどのように機能するかを説明できますか?
1223 次
2 に答える
5
コードを少し調べましたが、舞台裏で何が起こっているのかまだわかりません。
プロセスに詳しい人は、それがどのように機能するかを説明できますか?
PHP のタイムアウトを回避するために、ブラウザは定期的に AJAX を介して URL ( http://example.com/batch?id= $id) に ping を送信し、バッチ操作を実行させます。「バッチ」パスのメニュー コールバックであるsystem_batch_page()によって呼び出される関数である_batch_page()
を参照してください。
function _batch_page() {
$batch = &batch_get();
// Retrieve the current state of batch from db.
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'])))) {
$batch = unserialize($data);
}
else {
return FALSE;
}
// Register database update for end of processing.
register_shutdown_function('_batch_shutdown');
$op = isset($_REQUEST['op']) ? $_REQUEST['op'] : '';
$output = NULL;
switch ($op) {
case 'start':
$output = _batch_start();
break;
case 'do':
// JS-version AJAX callback.
_batch_do();
break;
case 'do_nojs':
// Non-JS progress page.
$output = _batch_progress_page_nojs();
break;
case 'finished':
$output = _batch_finished();
break;
}
return $output;
}
_batch_progress_page_nojs()では、次のコードに気付くでしょう。
$url = url($batch['url'], array('query' => array('id' => $batch['id'], 'op' => $new_op)));
drupal_set_html_head('<meta http-equiv="Refresh" content="0; URL=' . $url . '">');
$output = theme('progress_bar', $percentage, $message);
return $output;
"Refresh" メタ タグを設定すると、ページが更新されます。
Drupal 7 にも同様のコードがあります。違いは、コードが移植されており、Drupal 7 が実装する新しい機能を使用していることです。
// 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']);
$element = array(
'#tag' => 'meta',
'#attributes' => array(
'http-equiv' => 'Refresh',
'content' => '0; URL=' . $url,
),
);
drupal_add_html_head($element, 'batch_progress_meta_refresh');
return theme('progress_bar', array('percent' => $percentage, 'message' => $message));
JavaScript が有効になっている場合、すべての作業を行うコードはbatch.jsファイルにあります。
/**
* Attaches the batch behavior to progress bars.
*/
Drupal.behaviors.batch = function (context) {
// This behavior attaches by ID, so is only valid once on a page.
if ($('#progress.batch-processed').size()) {
return;
}
$('#progress', context).addClass('batch-processed').each(function () {
var holder = this;
var uri = Drupal.settings.batch.uri;
var initMessage = Drupal.settings.batch.initMessage;
var errorMessage = Drupal.settings.batch.errorMessage;
// Success: redirect to the summary.
var updateCallback = function (progress, status, pb) {
if (progress == 100) {
pb.stopMonitoring();
window.location = uri+'&op=finished';
}
};
var errorCallback = function (pb) {
var div = document.createElement('p');
div.className = 'error';
$(div).html(errorMessage);
$(holder).prepend(div);
$('#wait').hide();
};
var progress = new Drupal.progressBar('updateprogress', updateCallback, "POST", errorCallback);
progress.setProgress(-1, initMessage);
$(holder).append(progress.element);
progress.startMonitoring(uri+'&op=do', 10);
});
};
バッチ URL のポーリングは で始まりますprogress.startMonitoring(uri+'&op=do', 10)。batch.js ファイルは、 progress.jsDrupal.progressBarファイルで定義されている で公開されている機能に依存します。
同様のコードが Drupal 7 で使用されています。Drupal 7 では、わずかに異なるバージョンのbatch.jsおよびprogress.jsファイルが使用されています。
(function ($) {
/**
* Attaches the batch behavior to progress bars.
*/
Drupal.behaviors.batch = {
attach: function (context, settings) {
$('#progress', context).once('batch', function () {
var holder = $(this);
// Success: redirect to the summary.
var updateCallback = function (progress, status, pb) {
if (progress == 100) {
pb.stopMonitoring();
window.location = settings.batch.uri + '&op=finished';
}
};
var errorCallback = function (pb) {
holder.prepend($('<p class="error"></p>').html(settings.batch.errorMessage));
$('#wait').hide();
};
var progress = new Drupal.progressBar('updateprogress', updateCallback, 'POST', errorCallback);
progress.setProgress(-1, settings.batch.initMessage);
holder.append(progress.element);
progress.startMonitoring(settings.batch.uri + '&op=do', 10);
});
}
};
})(jQuery);
違いは、Drupal 7 以降、すべての jQuery コードが にラップされ(function ($) { })(jQuery);ていることと、jQuery Once プラグインが Drupal 7 に含まれていることです。Drupal 7 は、スクリーン リーダーとの互換性のために WAI-ARIA 属性も設定します。これは、progress.js ファイルにある次のような JavaScript コードから追加された HTML でも発生します。
// The WAI-ARIA setting aria-live="polite" will announce changes after users
// have completed their current activity and not interrupt the screen reader.
this.element = $('<div class="progress" aria-live="polite"></div>').attr('id', id);
this.element.html('<div class="bar"><div class="filled"></div></div>' +
'<div class="percentage"></div>' +
'<div class="message"> </div>');
バッチ ページを提供するとき、Drupal は_batch_shutdown()をシャットダウン コールバックとして設定します。タイムアウトのために PHP がシャットダウンすると、関数はデータベース内のバッチ配列を更新します。
// Drupal 6.
function _batch_shutdown() {
if ($batch = batch_get()) {
db_query("UPDATE {batch} SET batch = '%s' WHERE bid = %d", serialize($batch), $batch['id']);
}
}
// Drupal 7.
function _batch_shutdown() {
if ($batch = batch_get()) {
db_update('batch')
->fields(array('batch' => serialize($batch)))
->condition('bid', $batch['id'])
->execute();
}
}
于 2010-08-04T21:45:01.283 に答える
1
素晴らしい実装例から:
各バッチ操作のコールバックは、$context['finished'] が 1 に設定されるまで何度も繰り返されます。各パスの後、batch.inc はそのタイマーをチェックし、新しい http リクエストの時間であるかどうかを確認します。最後のリクエストから 1 分が経過しました。
非常に高速に処理されるバッチ全体では、コールバックを数回反復する場合でも、1 つの http 要求のみが必要な場合がありますが、遅いプロセスでは、コールバックの反復ごとに新しい http 要求が開始される可能性があります。
これは、php タイムアウトなしでできる限りの処理を各反復で行うように設定し、batch.inc に新しい http リクエストを作成する必要があるかどうかを判断させる必要があることを意味します。
言い換えれば、タスクのバッチをチャンク (または単一のタスク) に分割する必要があります。Drupal は、PHP タイムアウトが近づいていることを確認すると、現在の呼び出しを終了し、新しい HTTP リクエストを開きます。
于 2010-08-04T10:48:59.390 に答える