Update ApiBase::PARAM_* comments
[mediawiki.git] / maintenance / getText.php
blob7d7c1cc48078ba317a73c065290eb475add8eca2
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"
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.
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.
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
22 * @file
23 * @ingroup Maintenance
26 require_once __DIR__ . '/Maintenance.php';
28 /**
29 * Maintenance script that outputs page text to stdout.
31 * @ingroup Maintenance
33 class GetTextMaint extends Maintenance {
34 public function __construct() {
35 parent::__construct();
36 $this->mDescription = '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' );
41 public function execute() {
42 $this->db = wfGetDB( DB_SLAVE );
44 $titleText = $this->getArg( 0 );
45 $title = Title::newFromText( $titleText );
46 if ( !$title ) {
47 $this->error( "$titleText is not a valid title.\n", true );
50 $rev = Revision::newFromTitle( $title );
51 if ( !$rev ) {
52 $titleText = $title->getPrefixedText();
53 $this->error( "Page $titleText does not exist.\n", true );
55 $content = $rev->getContent( $this->hasOption( 'show-private' )
56 ? Revision::RAW
57 : Revision::FOR_PUBLIC );
59 if ( $content === false ) {
60 $titleText = $title->getPrefixedText();
61 $this->error( "Couldn't extract the text from $titleText.\n", true );
63 $this->output( $content->serialize() );
67 $maintClass = "GetTextMaint";
68 require_once RUN_MAINTENANCE_IF_MAIN;