MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / maintenance / copyJobQueue.php

diff --git a/maintenance/copyJobQueue.php b/maintenance/copyJobQueue.php
new file mode 100644 (file)
index 0000000..e1d697d
--- /dev/null
+++ b/maintenance/copyJobQueue.php
@@ -0,0 +1,98 @@
+<?php
+/**
+ * Copy all jobs from one job queue system to another.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Maintenance
+ */
+
+require_once __DIR__ . '/Maintenance.php';
+
+/**
+ * Copy all jobs from one job queue system to another.
+ * This uses an ad-hoc $wgJobQueueMigrationConfig setting,
+ * which is a map of queue system names to JobQueue::factory() parameters.
+ * The parameters should not have wiki or type settings and thus partial.
+ *
+ * @ingroup Maintenance
+ */
+class CopyJobQueue extends Maintenance {
+       public function __construct() {
+               parent::__construct();
+               $this->addDescription( 'Copy jobs from one queue system to another.' );
+               $this->addOption( 'src', 'Key to $wgJobQueueMigrationConfig for source', true, true );
+               $this->addOption( 'dst', 'Key to $wgJobQueueMigrationConfig for destination', true, true );
+               $this->addOption( 'type', 'Types of jobs to copy (use "all" for all)', true, true );
+               $this->setBatchSize( 500 );
+       }
+
+       public function execute() {
+               global $wgJobQueueMigrationConfig;
+
+               $srcKey = $this->getOption( 'src' );
+               $dstKey = $this->getOption( 'dst' );
+
+               if ( !isset( $wgJobQueueMigrationConfig[$srcKey] ) ) {
+                       $this->error( "\$wgJobQueueMigrationConfig not set for '$srcKey'.", 1 );
+               } elseif ( !isset( $wgJobQueueMigrationConfig[$dstKey] ) ) {
+                       $this->error( "\$wgJobQueueMigrationConfig not set for '$dstKey'.", 1 );
+               }
+
+               $types = ( $this->getOption( 'type' ) === 'all' )
+                       ? JobQueueGroup::singleton()->getQueueTypes()
+                       : [ $this->getOption( 'type' ) ];
+
+               foreach ( $types as $type ) {
+                       $baseConfig = [ 'type' => $type, 'wiki' => wfWikiID() ];
+                       $src = JobQueue::factory( $baseConfig + $wgJobQueueMigrationConfig[$srcKey] );
+                       $dst = JobQueue::factory( $baseConfig + $wgJobQueueMigrationConfig[$dstKey] );
+
+                       list( $total, $totalOK ) = $this->copyJobs( $src, $dst, $src->getAllQueuedJobs() );
+                       $this->output( "Copied $totalOK/$total queued $type jobs.\n" );
+
+                       list( $total, $totalOK ) = $this->copyJobs( $src, $dst, $src->getAllDelayedJobs() );
+                       $this->output( "Copied $totalOK/$total delayed $type jobs.\n" );
+               }
+       }
+
+       protected function copyJobs( JobQueue $src, JobQueue $dst, $jobs ) {
+               $total = 0;
+               $totalOK = 0;
+               $batch = [];
+               foreach ( $jobs as $job ) {
+                       ++$total;
+                       $batch[] = $job;
+                       if ( count( $batch ) >= $this->mBatchSize ) {
+                               $dst->push( $batch );
+                               $totalOK += count( $batch );
+                               $batch = [];
+                               $dst->waitForBackups();
+                       }
+               }
+               if ( count( $batch ) ) {
+                       $dst->push( $batch );
+                       $totalOK += count( $batch );
+                       $dst->waitForBackups();
+               }
+
+               return [ $total, $totalOK ];
+       }
+}
+
+$maintClass = 'CopyJobQueue';
+require_once RUN_MAINTENANCE_IF_MAIN;