MediaWiki  1.28.0
importTextFiles.php
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
33  public function __construct() {
34  parent::__construct();
35  $this->addDescription( 'Reads in text files and imports their content to pages of the wiki' );
36  $this->addOption( 'user', 'Username to which edits should be attributed. ' .
37  'Default: "Maintenance script"', false, true, 'u' );
38  $this->addOption( 'summary', 'Specify edit summary for the edits', false, true, 's' );
39  $this->addOption( 'use-timestamp', 'Use the modification date of the text file ' .
40  'as the timestamp for the edit' );
41  $this->addOption( 'overwrite', 'Overwrite existing pages. If --use-timestamp is passed, this ' .
42  'will only overwrite pages if the file has been modified since the page was last modified.' );
43  $this->addOption( 'prefix', 'A string to place in front of the file name', false, true, 'p' );
44  $this->addOption( 'bot', 'Mark edits as bot edits in the recent changes list.' );
45  $this->addOption( 'rc', 'Place revisions in RecentChanges.' );
46  $this->addArg( 'files', 'Files to import' );
47  }
48 
49  public function execute() {
50  $userName = $this->getOption( 'user', false );
51  $summary = $this->getOption( 'summary', 'Imported from text file' );
52  $useTimestamp = $this->hasOption( 'use-timestamp' );
53  $rc = $this->hasOption( 'rc' );
54  $bot = $this->hasOption( 'bot' );
55  $overwrite = $this->hasOption( 'overwrite' );
56  $prefix = $this->getOption( 'prefix', '' );
57 
58  // Get all the arguments. A loop is required since Maintenance doesn't
59  // support an arbitrary number of arguments.
60  $files = [];
61  $i = 0;
62  while ( $arg = $this->getArg( $i++ ) ) {
63  if ( file_exists( $arg ) ) {
64  $files[$arg] = file_get_contents( $arg );
65  } else {
66  // use glob to support the Windows shell, which doesn't automatically
67  // expand wildcards
68  $found = false;
69  foreach ( glob( $arg ) as $filename ) {
70  $found = true;
71  $files[$filename] = file_get_contents( $filename );
72  }
73  if ( !$found ) {
74  $this->error( "Fatal error: The file '$arg' does not exist!", 1 );
75  }
76  }
77  };
78 
79  $count = count( $files );
80  $this->output( "Importing $count pages...\n" );
81 
82  if ( $userName === false ) {
83  $user = User::newSystemUser( 'Maintenance script', [ 'steal' => true ] );
84  } else {
85  $user = User::newFromName( $userName );
86  }
87 
88  if ( !$user ) {
89  $this->error( "Invalid username\n", true );
90  }
91  if ( $user->isAnon() ) {
92  $user->addToDatabase();
93  }
94 
95  $exit = 0;
96 
97  $successCount = 0;
98  $failCount = 0;
99  $skipCount = 0;
100 
101  foreach ( $files as $file => $text ) {
102  $pageName = $prefix . pathinfo( $file, PATHINFO_FILENAME );
103  $timestamp = $useTimestamp ? wfTimestamp( TS_UNIX, filemtime( $file ) ) : wfTimestampNow();
104 
105  $title = Title::newFromText( $pageName );
106  // Have to check for # manually, since it gets interpreted as a fragment
107  if ( !$title || $title->hasFragment() ) {
108  $this->error( "Invalid title $pageName. Skipping.\n" );
109  $skipCount++;
110  continue;
111  }
112 
113  $exists = $title->exists();
114  $oldRevID = $title->getLatestRevID();
115  $oldRev = $oldRevID ? Revision::newFromId( $oldRevID ) : null;
116  $actualTitle = $title->getPrefixedText();
117 
118  if ( $exists ) {
119  $touched = wfTimestamp( TS_UNIX, $title->getTouched() );
120  if ( !$overwrite ) {
121  $this->output( "Title $actualTitle already exists. Skipping.\n" );
122  $skipCount++;
123  continue;
124  } elseif ( $useTimestamp && intval( $touched ) >= intval( $timestamp ) ) {
125  $this->output( "File for title $actualTitle has not been modified since the " .
126  "destination page was touched. Skipping.\n" );
127  $skipCount++;
128  continue;
129  }
130  }
131 
132  $rev = new WikiRevision( ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) );
133  $rev->setText( rtrim( $text ) );
134  $rev->setTitle( $title );
135  $rev->setUserObj( $user );
136  $rev->setComment( $summary );
137  $rev->setTimestamp( $timestamp );
138 
139  if ( $exists && $overwrite && $rev->getContent()->equals( $oldRev->getContent() ) ) {
140  $this->output( "File for title $actualTitle contains no changes from the current " .
141  "revision. Skipping.\n" );
142  $skipCount++;
143  continue;
144  }
145 
146  $status = $rev->importOldRevision();
147  $newId = $title->getLatestRevID();
148 
149  if ( $status ) {
150  $action = $exists ? 'updated' : 'created';
151  $this->output( "Successfully $action $actualTitle\n" );
152  $successCount++;
153  } else {
154  $action = $exists ? 'update' : 'create';
155  $this->output( "Failed to $action $actualTitle\n" );
156  $failCount++;
157  $exit = 1;
158  }
159 
160  // Create the RecentChanges entry if necessary
161  if ( $rc && $status ) {
162  if ( $exists ) {
163  if ( is_object( $oldRev ) ) {
164  $oldContent = $oldRev->getContent();
166  $timestamp,
167  $title,
168  $rev->getMinor(),
169  $user,
170  $summary,
171  $oldRevID,
172  $oldRev->getTimestamp(),
173  $bot,
174  '',
175  $oldContent ? $oldContent->getSize() : 0,
176  $rev->getContent()->getSize(),
177  $newId,
178  1 /* the pages don't need to be patrolled */
179  );
180  }
181  } else {
183  $timestamp,
184  $title,
185  $rev->getMinor(),
186  $user,
187  $summary,
188  $bot,
189  '',
190  $rev->getContent()->getSize(),
191  $newId,
192  1
193  );
194  }
195  }
196  }
197 
198  $this->output( "Done! $successCount succeeded, $skipCount skipped.\n" );
199  if ( $exit ) {
200  $this->error( "Import failed with $failCount failed pages.\n", $exit );
201  }
202  }
203 }
204 
205 $maintClass = "ImportTextFiles";
206 require_once RUN_MAINTENANCE_IF_MAIN;
static newFromName($name, $validate= 'valid')
Static factory method for creation from username.
Definition: User.php:525
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
$files
hasOption($name)
Checks to see if a particular param exists.
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:262
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
const TS_UNIX
Unix time - the number of seconds since 1970-01-01 00:00:00 UTC.
Definition: defines.php:6
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.
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
addOption($name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
if($limit) $timestamp
$summary
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
static newSystemUser($name, $options=[])
Static factory method for creation of a "system" user from username.
Definition: User.php:653
$maintClass
Represents a revision, log entry or upload during the import process.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
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
Definition: hooks.txt:1721
addDescription($text)
Set the description text.
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
Definition: distributors.txt:9
getOption($name, $default=null)
Get an option, or return the default.
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 local account $user
Definition: hooks.txt:242
output($out, $channel=null)
Throw some output to the user.
static getDefaultInstance()
static newFromId($id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:110
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
error($err, $die=0)
Throw an error to the user.
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:1046
$count
getArg($argId=0, $default=null)
Get an argument.
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...
Maintenance script which reads in text files and imports their content to a page of the wiki...