MediaWiki REL1_35
importTextFiles.php
Go to the documentation of this file.
1<?php
26
27require_once __DIR__ . '/Maintenance.php';
28
36 public function __construct() {
37 parent::__construct();
38 $this->addDescription( 'Reads in text files and imports their content to pages of the wiki' );
39 $this->addOption( 'user', 'Username to which edits should be attributed. ' .
40 'Default: "Maintenance script"', false, true, 'u' );
41 $this->addOption( 'summary', 'Specify edit summary for the edits', false, true, 's' );
42 $this->addOption( 'use-timestamp', 'Use the modification date of the text file ' .
43 'as the timestamp for the edit' );
44 $this->addOption( 'overwrite', 'Overwrite existing pages. If --use-timestamp is passed, this ' .
45 'will only overwrite pages if the file has been modified since the page was last modified.' );
46 $this->addOption( 'prefix', 'A string to place in front of the file name', false, true, 'p' );
47 $this->addOption( 'bot', 'Mark edits as bot edits in the recent changes list.' );
48 $this->addOption( 'rc', 'Place revisions in RecentChanges.' );
49 $this->addArg( 'files', 'Files to import' );
50 }
51
52 public function execute() {
53 $userName = $this->getOption( 'user', false );
54 $summary = $this->getOption( 'summary', 'Imported from text file' );
55 $useTimestamp = $this->hasOption( 'use-timestamp' );
56 $rc = $this->hasOption( 'rc' );
57 $bot = $this->hasOption( 'bot' );
58 $overwrite = $this->hasOption( 'overwrite' );
59 $prefix = $this->getOption( 'prefix', '' );
60
61 // Get all the arguments. A loop is required since Maintenance doesn't
62 // support an arbitrary number of arguments.
63 $files = [];
64 $i = 0;
65 while ( $arg = $this->getArg( $i++ ) ) {
66 if ( file_exists( $arg ) ) {
67 $files[$arg] = file_get_contents( $arg );
68 } else {
69 // use glob to support the Windows shell, which doesn't automatically
70 // expand wildcards
71 $found = false;
72 foreach ( glob( $arg ) as $filename ) {
73 $found = true;
74 $files[$filename] = file_get_contents( $filename );
75 }
76 if ( !$found ) {
77 $this->fatalError( "Fatal error: The file '$arg' does not exist!" );
78 }
79 }
80 }
81
82 $count = count( $files );
83 $this->output( "Importing $count pages...\n" );
84
85 if ( $userName === false ) {
86 $user = User::newSystemUser( 'Maintenance script', [ 'steal' => true ] );
87 } else {
88 $user = User::newFromName( $userName );
89 }
90
91 if ( !$user ) {
92 $this->fatalError( "Invalid username\n" );
93 }
94 if ( $user->isAnon() ) {
95 $user->addToDatabase();
96 }
97
98 $exit = 0;
99
100 $successCount = 0;
101 $failCount = 0;
102 $skipCount = 0;
103
104 $revLookup = MediaWikiServices::getInstance()->getRevisionLookup();
105 foreach ( $files as $file => $text ) {
106 $pageName = $prefix . pathinfo( $file, PATHINFO_FILENAME );
107 $timestamp = $useTimestamp ? wfTimestamp( TS_UNIX, filemtime( $file ) ) : wfTimestampNow();
108
109 $title = Title::newFromText( $pageName );
110 // Have to check for # manually, since it gets interpreted as a fragment
111 if ( !$title || $title->hasFragment() ) {
112 $this->error( "Invalid title $pageName. Skipping.\n" );
113 $skipCount++;
114 continue;
115 }
116
117 $exists = $title->exists();
118 $oldRevID = $title->getLatestRevID();
119 $oldRevRecord = $oldRevID ? $revLookup->getRevisionById( $oldRevID ) : null;
120 $actualTitle = $title->getPrefixedText();
121
122 if ( $exists ) {
123 $touched = wfTimestamp( TS_UNIX, $title->getTouched() );
124 if ( !$overwrite ) {
125 $this->output( "Title $actualTitle already exists. Skipping.\n" );
126 $skipCount++;
127 continue;
128 } elseif ( $useTimestamp && intval( $touched ) >= intval( $timestamp ) ) {
129 $this->output( "File for title $actualTitle has not been modified since the " .
130 "destination page was touched. Skipping.\n" );
131 $skipCount++;
132 continue;
133 }
134 }
135
136 $content = ContentHandler::makeContent( rtrim( $text ), $title );
137 $rev = new WikiRevision( MediaWikiServices::getInstance()->getMainConfig() );
138 $rev->setContent( SlotRecord::MAIN, $content );
139 $rev->setTitle( $title );
140 $rev->setUserObj( $user );
141 $rev->setComment( $summary );
142 $rev->setTimestamp( $timestamp );
143
144 if ( $exists &&
145 $overwrite &&
146 $rev->getContent()->equals( $oldRevRecord->getContent( SlotRecord::MAIN ) )
147 ) {
148 $this->output( "File for title $actualTitle contains no changes from the current " .
149 "revision. Skipping.\n" );
150 $skipCount++;
151 continue;
152 }
153
154 $status = $rev->importOldRevision();
155 $newId = $title->getLatestRevID();
156
157 if ( $status ) {
158 $action = $exists ? 'updated' : 'created';
159 $this->output( "Successfully $action $actualTitle\n" );
160 $successCount++;
161 } else {
162 $action = $exists ? 'update' : 'create';
163 $this->output( "Failed to $action $actualTitle\n" );
164 $failCount++;
165 $exit = 1;
166 }
167
168 // Create the RecentChanges entry if necessary
169 if ( $rc && $status ) {
170 if ( $exists ) {
171 if ( is_object( $oldRevRecord ) ) {
172 $oldContent = $oldRevRecord->getContent( SlotRecord::MAIN );
173 RecentChange::notifyEdit(
174 $timestamp,
175 $title,
176 $rev->getMinor(),
177 $user,
178 $summary,
179 $oldRevID,
180 $oldRevRecord->getTimestamp(),
181 $bot,
182 '',
183 $oldRevRecord->getSize(),
184 $rev->getSize(),
185 $newId,
186 // the pages don't need to be patrolled
187 1
188 );
189 }
190 } else {
191 RecentChange::notifyNew(
192 $timestamp,
193 $title,
194 $rev->getMinor(),
195 $user,
196 $summary,
197 $bot,
198 '',
199 $rev->getSize(),
200 $newId,
201 1
202 );
203 }
204 }
205 }
206
207 $this->output( "Done! $successCount succeeded, $skipCount skipped.\n" );
208 if ( $exit ) {
209 $this->fatalError( "Import failed with $failCount failed pages.\n", $exit );
210 }
211 }
212}
213
214$maintClass = ImportTextFiles::class;
215require_once RUN_MAINTENANCE_IF_MAIN;
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
const RUN_MAINTENANCE_IF_MAIN
Maintenance script which reads in text files and imports their content to a page of the wiki.
execute()
Do the actual work.
__construct()
Default constructor.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
error( $err, $die=0)
Throw an error to the user.
addArg( $arg, $description, $required=true)
Add some args that are needed.
output( $out, $channel=null)
Throw some output to the user.
hasOption( $name)
Checks to see if a particular option was set.
getArg( $argId=0, $default=null)
Get an argument.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
MediaWikiServices is the service locator for the application scope of MediaWiki.
Value object representing a content slot associated with a page revision.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition User.php:541
static newSystemUser( $name, $options=[])
Static factory method for creation of a "system" user from username.
Definition User.php:758
Represents a revision, log entry or upload during the import process.
$content
Definition router.php:76
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Item class for a filearchive table row.
Definition router.php:42