Use 'email' instead of 'e-mail' in API texts.
[lhc/web/wiklou.git] / maintenance / nextJobDB.php
index 16c6070..f5bf4da 100644 (file)
@@ -37,9 +37,9 @@ class nextJobDB extends Maintenance {
        }
 
        public function execute() {
-               global $wgMemc;
+               global $wgJobTypesExcludedFromDefaultQueue;
 
-               $type = false; // job type required/picked
+               // job type required/picked
                if ( $this->hasOption( 'types' ) ) {
                        $types = explode( ' ', $this->getOption( 'types' ) );
                } elseif ( $this->hasOption( 'type' ) ) {
@@ -48,72 +48,39 @@ class nextJobDB extends Maintenance {
                        $types = false;
                }
 
-               $memcKey = 'jobqueue:dbs:v3';
-               $pendingDbInfo = $wgMemc->get( $memcKey );
+               // Handle any required periodic queue maintenance
+               $this->executeReadyPeriodicTasks();
 
-               // If the cache entry wasn't present, is stale, or in .1% of cases otherwise,
-               // regenerate the cache. Use any available stale cache if another process is
-               // currently regenerating the pending DB information.
-               if ( !is_array( $pendingDbInfo )
-                       || ( time() - $pendingDbInfo['timestamp'] ) > 300 // 5 minutes
-                       || mt_rand( 0, 999 ) == 0
-               ) {
-                       if ( $wgMemc->add( "$memcKey:rebuild", 1, 1800 ) ) { // lock
-                               $pendingDbInfo = array(
-                                       'pendingDBs' => $this->getPendingDbs(),
-                                       'timestamp'  => time()
-                               );
-                               for ( $attempts=1; $attempts <= 25; ++$attempts ) {
-                                       if ( $wgMemc->add( "$memcKey:lock", 1, 60 ) ) { // lock
-                                               $wgMemc->set( $memcKey, $pendingDbInfo );
-                                               $wgMemc->delete( "$memcKey:lock" ); // unlock
-                                               break;
-                                       }
-                               }
-                               $wgMemc->delete( "$memcKey:rebuild" ); // unlock
-                       }
-               }
-
-               if ( !is_array( $pendingDbInfo ) || !$pendingDbInfo['pendingDBs'] ) {
+               // Get all the queues with jobs in them
+               $pendingDBs = JobQueueAggregator::singleton()->getAllReadyWikiQueues();
+               if ( !count( $pendingDBs ) ) {
                        return; // no DBs with jobs or cache is both empty and locked
                }
 
-               $pendingDBs = $pendingDbInfo['pendingDBs']; // convenience
                do {
                        $again = false;
 
-                       if ( $types === false ) {
-                               $candidates = call_user_func_array( 'array_merge', $pendingDBs );
-                       } else {
-                               $candidates = array();
-                               $possTypes = array_intersect( $types, array_keys( $pendingDBs ) );
-                               if ( $possTypes ) {
-                                       $possTypes = array_values( $possTypes );
-                                       $type = $possTypes[ mt_rand( 0, count( $possTypes ) - 1 ) ];
-                                       $candidates = $pendingDBs[$type];
+                       $candidates = array(); // list of (type, db)
+                       // Flatten the tree of candidates into a flat list so that a random
+                       // item can be selected, weighing each queue (type/db tuple) equally.
+                       foreach ( $pendingDBs as $type => $dbs ) {
+                               if (
+                                       ( is_array( $types ) && in_array( $type, $types ) ) ||
+                                       ( $types === false && !in_array( $type, $wgJobTypesExcludedFromDefaultQueue ) )
+                               ) {
+                                       foreach ( $dbs as $db ) {
+                                               $candidates[] = array( $type, $db );
+                                       }
                                }
                        }
-                       if ( !$candidates ) {
+                       if ( !count( $candidates ) ) {
                                return; // no jobs for this type
                        }
 
-                       $candidates = array_values( $candidates );
-                       $db = $candidates[ mt_rand( 0, count( $candidates ) - 1 ) ];
-                       if ( !$this->checkJob( $type, $db ) ) {
-                               $pendingDBs = $this->delistDB( $pendingDBs, $db, $type );
-                               // Update the cache to remove the outdated information.
-                               // Make sure that this does not race (especially with full rebuilds).
-                               if ( $wgMemc->add( "$memcKey:lock", 1, 60 ) ) { // lock
-                                       $curInfo = $wgMemc->get( $memcKey );
-                                       if ( is_array( $curInfo ) ) {
-                                               $curInfo['pendingDBs'] =
-                                                       $this->delistDB( $curInfo['pendingDBs'], $db, $type );
-                                               $wgMemc->set( $memcKey, $curInfo );
-                                               // May as well make use of this newer information
-                                               $pendingDBs = $curInfo['pendingDBs'];
-                                       }
-                                       $wgMemc->delete( "$memcKey:lock" ); // unlock
-                               }
+                       list( $type, $db ) = $candidates[ mt_rand( 0, count( $candidates ) - 1 ) ];
+                       if ( !$this->checkJob( $type, $db ) ) { // queue is actually empty?
+                               $pendingDBs[$type] = array_diff( $pendingDBs[$type], $db );
+                               JobQueueAggregator::singleton()->notifyQueueEmpty( $db, $type );
                                $again = true;
                        }
                } while ( $again );
@@ -125,19 +92,6 @@ class nextJobDB extends Maintenance {
                }
        }
 
-       private function delistDB( array $pendingDBs, $db, $type ) {
-               if ( $type === false ) {
-                       // There are no jobs available in the current database
-                       foreach ( $pendingDBs as $type2 => $dbs ) {
-                               $pendingDBs[$type2] = array_diff( $pendingDBs[$type2], array( $db ) );
-                       }
-               } else {
-                       // There are no jobs of this type available in the current database
-                       $pendingDBs[$type] = array_diff( $pendingDBs[$type], array( $db ) );
-               }
-               return $pendingDBs;
-       }
-
        /**
         * Check if the specified database has a job of the specified type in it.
         * The type may be false to indicate "all".
@@ -146,35 +100,30 @@ class nextJobDB extends Maintenance {
         * @return bool
         */
        private function checkJob( $type, $dbName ) {
-               $group = JobQueueGroup::singleton( $dbName );
-               if ( $type === false ) {
-                       foreach ( $group->getDefaultQueueTypes() as $type ) {
-                               if ( !$group->get( $type )->isEmpty() ) {
-                                       return true;
-                               }
-                       }
-                       return false;
-               } else {
-                       return !$group->get( $type )->isEmpty();
-               }
+               return !JobQueueGroup::singleton( $dbName )->get( $type )->isEmpty();
        }
 
        /**
-        * Get all databases that have a pending job
-        * @return array
+        * Do all ready periodic jobs for all databases every 5 minutes (and .1% of the time)
+        * @return integer
         */
-       private function getPendingDbs() {
-               global $wgLocalDatabases;
+       private function executeReadyPeriodicTasks() {
+               global $wgLocalDatabases, $wgMemc;
 
-               $pendingDBs = array(); // (job type => (db list))
-               foreach ( $wgLocalDatabases as $db ) {
-                       $types = JobQueueGroup::singleton( $db )->getQueuesWithJobs();
-                       foreach ( $types as $type ) {
-                               $pendingDBs[$type][] = $db;
+               $count = 0;
+               $memcKey = 'jobqueue:periodic:lasttime';
+               $timestamp = (int)$wgMemc->get( $memcKey ); // UNIX timestamp or 0
+               if ( ( time() - $timestamp ) > 300 || mt_rand( 0, 999 ) == 0 ) { // 5 minutes
+                       if ( $wgMemc->add( "$memcKey:rebuild", 1, 1800 ) ) { // lock
+                               foreach ( $wgLocalDatabases as $db ) {
+                                       $count += JobQueueGroup::singleton( $db )->executeReadyPeriodicTasks();
+                               }
+                               $wgMemc->set( $memcKey, time() );
+                               $wgMemc->delete( "$memcKey:rebuild" ); // unlock
                        }
                }
 
-               return $pendingDBs;
+               return $count;
        }
 }