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
26use MediaWiki\MediaWikiServices;
27use MediaWiki\Revision\RevisionRecord;
28use MediaWiki\Revision\SlotRecord;
29
30require_once __DIR__ . '/Maintenance.php';
31
32/**
33 * Maintenance script that outputs page text to stdout.
34 *
35 * @ingroup Maintenance
36 */
37class GetTextMaint extends Maintenance {
38	public function __construct() {
39		parent::__construct();
40		$this->addDescription( 'Outputs page text to stdout' );
41		$this->addOption( 'show-private', 'Show the text even if it\'s not available to the public' );
42		$this->addArg( 'title', 'Page title' );
43		$this->addOption( 'revision', 'Revision ID', false, true );
44	}
45
46	public function execute() {
47		$titleText = $this->getArg( 0 );
48		$title = Title::newFromText( $titleText );
49		if ( !$title ) {
50			$this->fatalError( "$titleText is not a valid title.\n" );
51		}
52
53		if ( !$title->exists() ) {
54			$titleText = $title->getPrefixedText();
55			$this->fatalError( "Page $titleText does not exist.\n" );
56		}
57
58		$revId = (int)$this->getOption( 'revision', $title->getLatestRevID() );
59
60		$rev = MediaWikiServices::getInstance()
61			->getRevisionLookup()
62			->getRevisionByTitle( $title, $revId );
63
64		if ( !$rev ) {
65			$titleText = $title->getPrefixedText();
66			$this->fatalError( "Could not load revision $revId of $titleText.\n" );
67		}
68
69		$audience = $this->hasOption( 'show-private' ) ?
70			RevisionRecord::RAW :
71			RevisionRecord::FOR_PUBLIC;
72		$content = $rev->getContent( SlotRecord::MAIN, $audience );
73
74		if ( $content === false ) {
75			$titleText = $title->getPrefixedText();
76			$this->fatalError( "Couldn't extract the text from $titleText.\n" );
77		}
78		$this->output( $content->serialize() );
79
80		if ( stream_isatty( STDOUT ) ) {
81			// When writing to a TTY, add a linebreak, to keep the terminal output tidy.
82			// Wikitext will generally not have a trailing newline.
83			$this->output( "\n" );
84		}
85	}
86}
87
88$maintClass = GetTextMaint::class;
89require_once RUN_MAINTENANCE_IF_MAIN;
90