Go to the documentation of this file.
26 require_once __DIR__ .
'/Maintenance.php';
36 parent::__construct();
37 $this->
addDescription(
'Reads in text files and imports their content to pages of the wiki' );
38 $this->
addOption(
'user',
'Username to which edits should be attributed. ' .
39 'Default: "Maintenance script"',
false,
true,
'u' );
40 $this->
addOption(
'summary',
'Specify edit summary for the edits',
false,
true,
's' );
41 $this->
addOption(
'use-timestamp',
'Use the modification date of the text file ' .
42 'as the timestamp for the edit' );
43 $this->
addOption(
'overwrite',
'Overwrite existing pages. If --use-timestamp is passed, this ' .
44 'will only overwrite pages if the file has been modified since the page was last modified.' );
45 $this->
addOption(
'prefix',
'A string to place in front of the file name',
false,
true,
'p' );
46 $this->
addOption(
'bot',
'Mark edits as bot edits in the recent changes list.' );
47 $this->
addOption(
'rc',
'Place revisions in RecentChanges.' );
48 $this->
addArg(
'files',
'Files to import' );
52 $userName = $this->
getOption(
'user',
false );
53 $summary = $this->
getOption(
'summary',
'Imported from text file' );
54 $useTimestamp = $this->
hasOption(
'use-timestamp' );
57 $overwrite = $this->
hasOption(
'overwrite' );
58 $prefix = $this->
getOption(
'prefix',
'' );
64 while ( $arg = $this->
getArg( $i++ ) ) {
65 if ( file_exists( $arg ) ) {
66 $files[$arg] = file_get_contents( $arg );
71 foreach ( glob( $arg )
as $filename ) {
73 $files[$filename] = file_get_contents( $filename );
76 $this->
error(
"Fatal error: The file '$arg' does not exist!", 1 );
81 $count =
count( $files );
82 $this->
output(
"Importing $count pages...\n" );
84 if ( $userName ===
false ) {
91 $this->
error(
"Invalid username\n",
true );
93 if (
$user->isAnon() ) {
94 $user->addToDatabase();
103 foreach ( $files
as $file => $text ) {
104 $pageName = $prefix . pathinfo( $file, PATHINFO_FILENAME );
110 $this->
error(
"Invalid title $pageName. Skipping.\n" );
115 $exists =
$title->exists();
116 $oldRevID =
$title->getLatestRevID();
118 $actualTitle =
$title->getPrefixedText();
123 $this->
output(
"Title $actualTitle already exists. Skipping.\n" );
126 } elseif ( $useTimestamp && intval( $touched ) >= intval( $timestamp ) ) {
127 $this->
output(
"File for title $actualTitle has not been modified since the " .
128 "destination page was touched. Skipping.\n" );
134 $rev =
new WikiRevision( MediaWikiServices::getInstance()->getMainConfig() );
135 $rev->setText( rtrim( $text ) );
138 $rev->setComment( $summary );
139 $rev->setTimestamp( $timestamp );
141 if ( $exists && $overwrite &&
$rev->getContent()->equals( $oldRev->getContent() ) ) {
142 $this->
output(
"File for title $actualTitle contains no changes from the current " .
143 "revision. Skipping.\n" );
149 $newId =
$title->getLatestRevID();
152 $action = $exists ?
'updated' :
'created';
153 $this->
output(
"Successfully $action $actualTitle\n" );
156 $action = $exists ?
'update' :
'create';
157 $this->
output(
"Failed to $action $actualTitle\n" );
165 if ( is_object( $oldRev ) ) {
166 $oldContent = $oldRev->getContent();
174 $oldRev->getTimestamp(),
177 $oldContent ? $oldContent->getSize() : 0,
178 $rev->getContent()->getSize(),
192 $rev->getContent()->getSize(),
200 $this->
output(
"Done! $successCount succeeded, $skipCount skipped.\n" );
202 $this->
error(
"Import failed with $failCount failed pages.\n", $exit );
static notifyNew( $timestamp, &$title, $minor, &$user, $comment, $bot, $ip='', $size=0, $newId=0, $patrol=0, $tags=[])
Makes an entry in the database corresponding to page creation Note: the title object must be loaded w...
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
addDescription( $text)
Set the description text.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
require_once RUN_MAINTENANCE_IF_MAIN
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
static notifyEdit( $timestamp, &$title, $minor, &$user, $comment, $oldId, $lastTimestamp, $bot, $ip='', $oldSize=0, $newSize=0, $newId=0, $patrol=0, $tags=[])
Makes an entry in the database corresponding to an edit.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
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
static newSystemUser( $name, $options=[])
Static factory method for creation of a "system" user from username.
__construct()
Default constructor.
namespace and then decline to actually register it file or subcat img or subcat $title
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
Maintenance script which reads in text files and imports their content to a page of the wiki.
getOption( $name, $default=null)
Get an option, or return the default.
Represents a revision, log entry or upload during the import process.
addArg( $arg, $description, $required=true)
Add some args that are needed.
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
execute()
Do the actual work.
error( $err, $die=0)
Throw an error to the user.
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 MediaWikiServices
hasOption( $name)
Checks to see if a particular param exists.
getArg( $argId=0, $default=null)
Get an argument.