MediaWiki 1.30.2

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

diff --git a/maintenance/fetchText.php b/maintenance/fetchText.php
index ea56535def26fe838089bc5ca32bbb2ef8fe8585..9c5a375154aa3f3cca84066c86b7624468d37cb3 100644 (file)
--- a/maintenance/fetchText.php
+++ b/maintenance/fetchText.php
@@ -1,6 +1,7 @@
 <?php
 /**
- * Communications protocol...
+ * Communications protocol.
+ * This is used by dumpTextPass.php when the --spawn option is present.
  *
  * 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
@@ -17,29 +18,40 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 
-require_once( dirname( __FILE__ ) . '/Maintenance.php' );
+require_once __DIR__ . '/Maintenance.php';
 
+use Wikimedia\Rdbms\IDatabase;
+
+/**
+ * Maintenance script used to fetch page text in a subprocess.
+ *
+ * @ingroup Maintenance
+ */
 class FetchText extends Maintenance {
        public function __construct() {
                parent::__construct();
-               $this->mDescription = "Fetch the revision text from an old_id";
+               $this->addDescription( "Fetch the raw revision blob from an old_id.\n" .
+                       "NOTE: Export transformations are NOT applied. " .
+                       "This is left to backupTextPass.php"
+               );
        }
 
-       /*
+       /**
         * returns a string containing the following in order:
-        *       textid
-        *       \n
-        *       length of text (-1 on error = failure to retrieve/unserialize/gunzip/etc)
-        *       \n
-        *       text  (may be empty)
+        *   textid
+        *   \n
+        *   length of text (-1 on error = failure to retrieve/unserialize/gunzip/etc)
+        *   \n
+        *   text  (may be empty)
         *
-        * note that that the text string itself is *not* followed by newline
+        * note that the text string itself is *not* followed by newline
         */
-        public function execute() {
-               $db = wfGetDB( DB_SLAVE );
+       public function execute() {
+               $db = $this->getDB( DB_REPLICA );
                $stdin = $this->getStdin();
                while ( !feof( $stdin ) ) {
                        $line = fgets( $stdin );
@@ -49,12 +61,11 @@ class FetchText extends Maintenance {
                        }
                        $textId = intval( $line );
                        $text = $this->doGetText( $db, $textId );
-                       if ($text === false) {
+                       if ( $text === false ) {
                                # actual error, not zero-length text
                                $textLen = "-1";
-                       }
-                       else {
-                               $textLen = strlen($text);
+                       } else {
+                               $textLen = strlen( $text );
                        }
                        $this->output( $textId . "\n" . $textLen . "\n" . $text );
                }
@@ -62,23 +73,24 @@ class FetchText extends Maintenance {
 
        /**
         * May throw a database error if, say, the server dies during query.
-        * @param $db Database object
-        * @param $id int The old_id
-        * @return String
+        * @param IDatabase $db
+        * @param int $id The old_id
+        * @return string
         */
        private function doGetText( $db, $id ) {
                $id = intval( $id );
                $row = $db->selectRow( 'text',
-                       array( 'old_text', 'old_flags' ),
-                       array( 'old_id' => $id ),
+                       [ 'old_text', 'old_flags' ],
+                       [ 'old_id' => $id ],
                        __METHOD__ );
                $text = Revision::getRevisionText( $row );
                if ( $text === false ) {
                        return false;
                }
+
                return $text;
        }
 }
 
 $maintClass = "FetchText";
-require_once( RUN_MAINTENANCE_IF_MAIN );
+require_once RUN_MAINTENANCE_IF_MAIN;