Can someone standardi[sz]e SQL already!?

[lhc/web/wiklou.git] / maintenance / Maintenance.php

diff --git a/maintenance/Maintenance.php b/maintenance/Maintenance.php
index 95854b0..fda12f9 100644 (file)
--- a/maintenance/Maintenance.php
+++ b/maintenance/Maintenance.php
@@ -20,6 +20,11 @@
  * @defgroup Maintenance Maintenance
  */
 
+/**
+ * @defgroup MaintenanceArchive Maintenance archives
+ * @ingroup Maintenance
+ */
+
 // Define this so scripts can easily find doMaintenance.php
 define( 'RUN_MAINTENANCE_IF_MAIN', dirname( __FILE__ ) . '/doMaintenance.php' );
 define( 'DO_MAINTENANCE', RUN_MAINTENANCE_IF_MAIN ); // original name, harmless
@@ -292,6 +297,9 @@ abstract class Maintenance {
                return rtrim( $input );
        }
 
+       /**
+        * @return bool
+        */
        public function isQuiet() {
                return $this->mQuiet;
        }
@@ -309,12 +317,12 @@ abstract class Maintenance {
                }
                if ( $channel === null ) {
                        $this->cleanupChanneled();
-
-                       $f = fopen( 'php://stdout', 'w' );
-                       fwrite( $f, $out );
-                       fclose( $f );
-               }
-               else {
+                       if( php_sapi_name() == 'cli' ) {
+                               fwrite( STDOUT, $out );
+                       } else {
+                               print( $out );
+                       }
+               } else {
                        $out = preg_replace( '/\n\z/', '', $out );
                        $this->outputChanneled( $out, $channel );
                }
@@ -331,9 +339,7 @@ abstract class Maintenance {
                if ( php_sapi_name() == 'cli' ) {
                        fwrite( STDERR, $err . "\n" );
                } else {
-                       $f = fopen( 'php://stderr', 'w' );
-                       fwrite( $f, $err . "\n" );
-                       fclose( $f );
+                       print $err;
                }
                $die = intval( $die );
                if ( $die > 0 ) {
@@ -349,9 +355,11 @@ abstract class Maintenance {
         */
        public function cleanupChanneled() {
                if ( !$this->atLineStart ) {
-                       $handle = fopen( 'php://stdout', 'w' );
-                       fwrite( $handle, "\n" );
-                       fclose( $handle );
+                       if( php_sapi_name() == 'cli' ) {
+                               fwrite( STDOUT, "\n" );
+                       } else {
+                               print "\n";
+                       }
                        $this->atLineStart = true;
                }
        }
@@ -361,7 +369,7 @@ abstract class Maintenance {
         * same channel are concatenated, but any intervening messages in another
         * channel start a new line.
         * @param $msg String: the message without trailing newline
-        * @param $channel Channel identifier or null for no
+        * @param $channel string Channel identifier or null for no
         *     channel. Channel comparison uses ===.
         */
        public function outputChanneled( $msg, $channel = null ) {
@@ -370,25 +378,34 @@ abstract class Maintenance {
                        return;
                }
 
-               $handle = fopen( 'php://stdout', 'w' );
+               $cli = php_sapi_name() == 'cli';
 
                // End the current line if necessary
                if ( !$this->atLineStart && $channel !== $this->lastChannel ) {
-                       fwrite( $handle, "\n" );
+                       if( $cli ) {
+                               fwrite( STDOUT, "\n" );
+                       } else {
+                               print "\n";
+                       }
                }
 
-               fwrite( $handle, $msg );
+               if( $cli ) {
+                       fwrite( STDOUT, $msg );
+               } else {
+                       print $msg;
+               }
 
                $this->atLineStart = false;
                if ( $channel === null ) {
                        // For unchanneled messages, output trailing newline immediately
-                       fwrite( $handle, "\n" );
+                       if( $cli ) {
+                               fwrite( STDOUT, "\n" );
+                       } else {
+                               print "\n";
+                       }
                        $this->atLineStart = true;
                }
                $this->lastChannel = $channel;
-
-               // Cleanup handle
-               fclose( $handle );
        }
 
        /**
@@ -456,6 +473,9 @@ abstract class Maintenance {
                        }
                }
 
+               /**
+                * @var $child Maintenance
+                */
                $child = new $maintClass();
                $child->loadParamsAndArgs( $this->mSelf, $this->mOptions, $this->mArgs );
                if ( !is_null( $this->mDb ) ) {
@@ -934,7 +954,7 @@ abstract class Maintenance {
        public function purgeRedundantText( $delete = true ) {
                # Data should come off the master, wrapped in a transaction
                $dbw = $this->getDB( DB_MASTER );
-               $dbw->begin();
+               $dbw->begin( __METHOD__ );
 
                $tbl_arc = $dbw->tableName( 'archive' );
                $tbl_rev = $dbw->tableName( 'revision' );
@@ -979,7 +999,7 @@ abstract class Maintenance {
                }
 
                # Done
-               $dbw->commit();
+               $dbw->commit( __METHOD__ );
        }
 
        /**
@@ -1009,7 +1029,6 @@ abstract class Maintenance {
                if ( !self::$mCoreScripts ) {
                        $paths = array(
                                dirname( __FILE__ ),
-                               dirname( __FILE__ ) . '/gearman',
                                dirname( __FILE__ ) . '/language',
                                dirname( __FILE__ ) . '/storage',
                        );
@@ -1063,7 +1082,7 @@ abstract class Maintenance {
 
        /**
         * Lock the search index
-        * @param &$db Database object
+        * @param &$db DatabaseBase object
         */
        private function lockSearchindex( &$db ) {
                $write = array( 'searchindex' );
@@ -1073,7 +1092,7 @@ abstract class Maintenance {
 
        /**
         * Unlock the tables
-        * @param &$db Database object
+        * @param &$db DatabaseBase object
         */
        private function unlockSearchindex( &$db ) {
                $db->unlockTables(  __CLASS__ . '::' . __METHOD__ );
@@ -1082,7 +1101,7 @@ abstract class Maintenance {
        /**
         * Unlock and lock again
         * Since the lock is low-priority, queued reads will be able to complete
-        * @param &$db Database object
+        * @param &$db DatabaseBase object
         */
        private function relockSearchindex( &$db ) {
                $this->unlockSearchindex( $db );
@@ -1130,7 +1149,7 @@ abstract class Maintenance {
 
        /**
         * Update the searchindex table for a given pageid
-        * @param $dbw Database: a database write handle
+        * @param $dbw DatabaseBase a database write handle
         * @param $pageId Integer: the page ID to update.
         * @return null|string
         */
@@ -1276,6 +1295,15 @@ abstract class LoggedUpdateMaintenance extends Maintenance {
                }
        }
 
+       /**
+        * Message to show that the update was done already and was just skipped
+        * @return String
+        */
+       protected function updateSkippedMessage() {
+               $key = $this->getUpdateKey();
+               return "Update '{$key}' already logged as completed.";
+       }
+
        /**
         * Message to show the the update log was unable to log the completion of this update
         * @return String
@@ -1297,10 +1325,4 @@ abstract class LoggedUpdateMaintenance extends Maintenance {
         * @return String
         */
        abstract protected function getUpdateKey();
-
-       /**
-        * Message to show that the update was done already and was just skipped
-        * @return String
-        */
-       abstract protected function updateSkippedMessage();
 }