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 use MediaWiki\Revision\RevisionRecord;
  27
  28 require_once __DIR__ . '/Maintenance.php';
  29
  30 /**
  31  * Maintenance script that outputs page text to stdout.
  32  *
  33  * @ingroup Maintenance
  34  */
  35 class GetTextMaint extends Maintenance {
  36         public function __construct() {
  37                 parent::__construct();
  38                 $this->addDescription( 'Outputs page text to stdout' );
  39                 $this->addOption( 'show-private', 'Show the text even if it\'s not available to the public' );
  40                 $this->addArg( 'title', 'Page title' );
  41         }
  42
  43         public function execute() {
  44                 $titleText = $this->getArg( 0 );
  45                 $title = Title::newFromText( $titleText );
  46                 if ( !$title ) {
  47                         $this->fatalError( "$titleText is not a valid title.\n" );
  48                 }
  49
  50                 $rev = Revision::newFromTitle( $title );
  51                 if ( !$rev ) {
  52                         $titleText = $title->getPrefixedText();
  53                         $this->fatalError( "Page $titleText does not exist.\n" );
  54                 }
  55                 $content = $rev->getContent( $this->hasOption( 'show-private' )
  56                         ? RevisionRecord::RAW
  57                         : RevisionRecord::FOR_PUBLIC );
  58
  59                 if ( $content === false ) {
  60                         $titleText = $title->getPrefixedText();
  61                         $this->fatalError( "Couldn't extract the text from $titleText.\n" );
  62                 }
  63                 $this->output( $content->serialize() );
  64         }
  65 }
  66
  67 $maintClass = GetTextMaint::class;
  68 require_once RUN_MAINTENANCE_IF_MAIN;