Revert "merged master"

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

diff --git a/maintenance/fetchText.php b/maintenance/fetchText.php
index 746ef8a..2833081 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,46 +18,69 @@
  * 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( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * 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";
        }
 
-       public function execute() {
+       /**
+        * 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)
+        *
+        * note that that the text string itself is *not* followed by newline
+        */
+        public function execute() {
                $db = wfGetDB( DB_SLAVE );
                $stdin = $this->getStdin();
-               while( !feof( $stdin ) ) {
+               while ( !feof( $stdin ) ) {
                        $line = fgets( $stdin );
-                       if( $line === false ) {
+                       if ( $line === false ) {
                                // We appear to have lost contact...
                                break;
                        }
                        $textId = intval( $line );
                        $text = $this->doGetText( $db, $textId );
-                       $this->output( strlen( $text ) . "\n". $text );
+                       if ($text === false) {
+                               # actual error, not zero-length text
+                               $textLen = "-1";
+                       }
+                       else {
+                               $textLen = strlen($text);
+                       }
+                       $this->output( $textId . "\n" . $textLen . "\n" . $text );
                }
        }
-       
+
        /**
-        * May throw a database error if, say, the server dies during query.
-        * @param $db Database object
+        * May throw a database error if, say, the server dies during query.
+        * @param $db DatabaseBase object
         * @param $id int 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 ),
-                       'TextPassDumper::getText' );
+                       __METHOD__ );
                $text = Revision::getRevisionText( $row );
-               if( $text === false ) {
+               if ( $text === false ) {
                        return false;
                }
                return $text;
@@ -64,4 +88,4 @@ class FetchText extends Maintenance {
 }
 
 $maintClass = "FetchText";
-require_once( DO_MAINTENANCE );
+require_once( RUN_MAINTENANCE_IF_MAIN );