3 * Import pages from text files
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
21 * @ingroup Maintenance
24 require_once __DIR__
. '/Maintenance.php';
27 * Maintenance script which reads in text files
28 * and imports their content to a page of the wiki.
30 * @ingroup Maintenance
32 class ImportTextFiles
extends Maintenance
{
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' );
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', '' );
58 // Get all the arguments. A loop is required since Maintenance doesn't
59 // support an arbitrary number of arguments.
62 while ( $arg = $this->getArg( $i++
) ) {
63 if ( file_exists( $arg ) ) {
64 $files[$arg] = file_get_contents( $arg );
66 // use glob to support the Windows shell, which doesn't automatically
69 foreach ( glob( $arg ) as $filename ) {
71 $files[$filename] = file_get_contents( $filename );
74 $this->error( "Fatal error: The file '$arg' does not exist!", 1 );
79 $count = count( $files );
80 $this->output( "Importing $count pages...\n" );
82 if ( $userName === false ) {
83 $user = User
::newSystemUser( 'Maintenance script', [ 'steal' => true ] );
85 $user = User
::newFromName( $userName );
89 $this->error( "Invalid username\n", true );
91 if ( $user->isAnon() ) {
92 $user->addToDatabase();
101 foreach ( $files as $file => $text ) {
102 $pageName = $prefix . pathinfo( $file, PATHINFO_FILENAME
);
103 $timestamp = $useTimestamp ?
wfTimestamp( TS_UNIX
, filemtime( $file ) ) : wfTimestampNow();
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" );
113 $exists = $title->exists();
114 $oldRevID = $title->getLatestRevID();
115 $oldRev = $oldRevID ? Revision
::newFromId( $oldRevID ) : null;
116 $actualTitle = $title->getPrefixedText();
119 $touched = wfTimestamp( TS_UNIX
, $title->getTouched() );
121 $this->output( "Title $actualTitle already exists. Skipping.\n" );
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" );
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 );
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" );
146 $status = $rev->importOldRevision();
147 $newId = $title->getLatestRevID();
150 $action = $exists ?
'updated' : 'created';
151 $this->output( "Successfully $action $actualTitle\n" );
154 $action = $exists ?
'update' : 'create';
155 $this->output( "Failed to $action $actualTitle\n" );
160 // Create the RecentChanges entry if necessary
161 if ( $rc && $status ) {
163 if ( is_object( $oldRev ) ) {
164 $oldContent = $oldRev->getContent();
165 RecentChange
::notifyEdit(
172 $oldRev->getTimestamp(),
175 $oldContent ?
$oldContent->getSize() : 0,
176 $rev->getContent()->getSize(),
178 1 /* the pages don't need to be patrolled */
182 RecentChange
::notifyNew(
190 $rev->getContent()->getSize(),
198 $this->output( "Done! $successCount succeeded, $skipCount skipped.\n" );
200 $this->error( "Import failed with $failCount failed pages.\n", $exit );
205 $maintClass = "ImportTextFiles";
206 require_once RUN_MAINTENANCE_IF_MAIN
;