Merge "Added release notes for 'ContentHandler::runLegacyHooks' removal"
[mediawiki.git] / maintenance / edit.php
blob4219ed05179b391cce6d4d9376f532704130d7e7
1 <?php
2 /**
3 * Make a page edit.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
20 * @file
21 * @ingroup Maintenance
24 require_once __DIR__ . '/Maintenance.php';
26 /**
27 * Maintenance script to make a page edit.
29 * @ingroup Maintenance
31 class EditCLI extends Maintenance {
32 public function __construct() {
33 parent::__construct();
34 $this->addDescription( 'Edit an article from the command line, text is from stdin' );
35 $this->addOption( 'user', 'Username', false, true, 'u' );
36 $this->addOption( 'summary', 'Edit summary', false, true, 's' );
37 $this->addOption( 'minor', 'Minor edit', false, false, 'm' );
38 $this->addOption( 'bot', 'Bot edit', false, false, 'b' );
39 $this->addOption( 'autosummary', 'Enable autosummary', false, false, 'a' );
40 $this->addOption( 'no-rc', 'Do not show the change in recent changes', false, false, 'r' );
41 $this->addOption( 'nocreate', 'Don\'t create new pages', false, false );
42 $this->addOption( 'createonly', 'Only create new pages', false, false );
43 $this->addArg( 'title', 'Title of article to edit' );
46 public function execute() {
47 global $wgUser;
49 $userName = $this->getOption( 'user', false );
50 $summary = $this->getOption( 'summary', '' );
51 $minor = $this->hasOption( 'minor' );
52 $bot = $this->hasOption( 'bot' );
53 $autoSummary = $this->hasOption( 'autosummary' );
54 $noRC = $this->hasOption( 'no-rc' );
56 if ( $userName === false ) {
57 $wgUser = User::newSystemUser( 'Maintenance script', [ 'steal' => true ] );
58 } else {
59 $wgUser = User::newFromName( $userName );
61 if ( !$wgUser ) {
62 $this->error( "Invalid username", true );
64 if ( $wgUser->isAnon() ) {
65 $wgUser->addToDatabase();
68 $title = Title::newFromText( $this->getArg() );
69 if ( !$title ) {
70 $this->error( "Invalid title", true );
73 if ( $this->hasOption( 'nocreate' ) && !$title->exists() ) {
74 $this->error( "Page does not exist", true );
75 } elseif ( $this->hasOption( 'createonly' ) && $title->exists() ) {
76 $this->error( "Page already exists", true );
79 $page = WikiPage::factory( $title );
81 # Read the text
82 $text = $this->getStdin( Maintenance::STDIN_ALL );
83 $content = ContentHandler::makeContent( $text, $title );
85 # Do the edit
86 $this->output( "Saving... " );
87 $status = $page->doEditContent( $content, $summary,
88 ( $minor ? EDIT_MINOR : 0 ) |
89 ( $bot ? EDIT_FORCE_BOT : 0 ) |
90 ( $autoSummary ? EDIT_AUTOSUMMARY : 0 ) |
91 ( $noRC ? EDIT_SUPPRESS_RC : 0 ) );
92 if ( $status->isOK() ) {
93 $this->output( "done\n" );
94 $exit = 0;
95 } else {
96 $this->output( "failed\n" );
97 $exit = 1;
99 if ( !$status->isGood() ) {
100 $this->output( $status->getWikiText( false, false, 'en' ) . "\n" );
102 exit( $exit );
106 $maintClass = "EditCLI";
107 require_once RUN_MAINTENANCE_IF_MAIN;