maintenance/getText.php

   1 <?php
   2 /**
   3  * Outputs page text to stdout.
   4  * Useful for command-line editing automation.
   5  * Example: php getText.php "page title" | sed -e '...' | php edit.php "page title"
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  * @file
  23  * @ingroup Maintenance
  24  */
  25
  26 require_once __DIR__ . '/Maintenance.php';
  27
  28 /**
  29  * Maintenance script that outputs page text to stdout.
  30  *
  31  * @ingroup Maintenance
  32  */
  33 class GetTextMaint extends Maintenance {
  34         public function __construct() {
  35                 parent::__construct();
  36                 $this->addDescription( 'Outputs page text to stdout' );
  37                 $this->addOption( 'show-private', 'Show the text even if it\'s not available to the public' );
  38                 $this->addArg( 'title', 'Page title' );
  39         }
  40
  41         public function execute() {
  42                 $titleText = $this->getArg( 0 );
  43                 $title = Title::newFromText( $titleText );
  44                 if ( !$title ) {
  45                         $this->fatalError( "$titleText is not a valid title.\n" );
  46                 }
  47
  48                 $rev = Revision::newFromTitle( $title );
  49                 if ( !$rev ) {
  50                         $titleText = $title->getPrefixedText();
  51                         $this->fatalError( "Page $titleText does not exist.\n" );
  52                 }
  53                 $content = $rev->getContent( $this->hasOption( 'show-private' )
  54                         ? Revision::RAW
  55                         : Revision::FOR_PUBLIC );
  56
  57                 if ( $content === false ) {
  58                         $titleText = $title->getPrefixedText();
  59                         $this->fatalError( "Couldn't extract the text from $titleText.\n" );
  60                 }
  61                 $this->output( $content->serialize() );
  62         }
  63 }
  64
  65 $maintClass = GetTextMaint::class;
  66 require_once RUN_MAINTENANCE_IF_MAIN;