MediaWiki  1.27.2
edit.php
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
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' );
44  }
45 
46  public function execute() {
48 
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' );
55 
56  if ( $userName === false ) {
57  $wgUser = User::newSystemUser( 'Maintenance script', [ 'steal' => true ] );
58  } else {
59  $wgUser = User::newFromName( $userName );
60  }
61  if ( !$wgUser ) {
62  $this->error( "Invalid username", true );
63  }
64  if ( $wgUser->isAnon() ) {
65  $wgUser->addToDatabase();
66  }
67 
68  $title = Title::newFromText( $this->getArg() );
69  if ( !$title ) {
70  $this->error( "Invalid title", true );
71  }
72 
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 );
77  }
78 
80 
81  # Read the text
82  $text = $this->getStdin( Maintenance::STDIN_ALL );
84 
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;
98  }
99  if ( !$status->isGood() ) {
100  $this->output( $status->getWikiText( false, false, 'en' ) . "\n" );
101  }
102  exit( $exit );
103  }
104 }
105 
106 $maintClass = "EditCLI";
107 require_once RUN_MAINTENANCE_IF_MAIN;
static newFromName($name, $validate= 'valid')
Static factory method for creation from username.
Definition: User.php:568
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:99
const STDIN_ALL
Definition: Maintenance.php:63
__construct()
Definition: edit.php:32
addArg($arg, $description, $required=true)
Add some args that are needed.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
hasOption($name)
Checks to see if a particular param exists.
const EDIT_MINOR
Definition: Defines.php:181
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:277
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
getStdin($len=null)
Return input from stdin.
addOption($name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
const EDIT_FORCE_BOT
Definition: Defines.php:183
execute()
Definition: edit.php:46
$summary
const EDIT_AUTOSUMMARY
Definition: Defines.php:185
static newSystemUser($name, $options=[])
Static factory method for creation of a "system" user from username.
Definition: User.php:695
const EDIT_SUPPRESS_RC
Definition: Defines.php:182
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
static makeContent($text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
addDescription($text)
Set the description text.
getOption($name, $default=null)
Get an option, or return the default.
output($out, $channel=null)
Throw some output to the user.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
$maintClass
Definition: edit.php:106
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
Definition: hooks.txt:1004
error($err, $die=0)
Throw an error to the user.
Maintenance script to make a page edit.
Definition: edit.php:31
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1004
getArg($argId=0, $default=null)
Get an argument.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
Definition: hooks.txt:2338
$wgUser
Definition: Setup.php:794