Rewrite the importTextFile.php script; remove un-needed include file, use Article...
authorRob Church <robchurch@users.mediawiki.org>
Sat, 2 Dec 2006 22:16:21 +0000 (22:16 +0000)
committerRob Church <robchurch@users.mediawiki.org>
Sat, 2 Dec 2006 22:16:21 +0000 (22:16 +0000)
* (bug 7461) Allow overwriting pages using importTextFile.php
* (bug 7946) importTextFile.php doesn't perform pre-save transform

RELEASE-NOTES
maintenance/importTextFile.inc [deleted file]
maintenance/importTextFile.php

index 99d3841..ea89aa7 100644 (file)
@@ -234,7 +234,9 @@ it from source control: http://www.mediawiki.org/wiki/Download_from_SVN
 * Added 'EditPage::attemptSave' hook before an article is saved.
 * (bug 8083) Applied patch for sk localisation
 * Add a backslash character to the edit token, to prevent edits via certain
-  broken proxies that mangle such characters in form submissions.
+  broken proxies that mangle such characters in form submissions
+* (bug 7461) Allow overwriting pages using importTextFile.php
+* (bug 7946) importTextFile.php doesn't perform pre-save transform
 
 == Languages updated ==
 
diff --git a/maintenance/importTextFile.inc b/maintenance/importTextFile.inc
deleted file mode 100644 (file)
index 50b936c..0000000
+++ /dev/null
@@ -1,75 +0,0 @@
-<?php
-
-/**
- * Support functions for the importTextFile script
- *
- * @package MediaWiki
- * @subpackage Maintenance
- * @author Rob Church <robchur@gmail.com>
- */
-
-require_once( "$IP/includes/RecentChange.php" );
-
-/**
- * Insert a new article
- *
- * @param $title Title of the article
- * @param $text Text of the article
- * @param $user User associated with the edit
- * @param $comment Edit summary
- * @param $rc Whether or not to add a recent changes event
- * @return bool
- */
-function insertNewArticle( &$title, $text, &$user, $comment, $rc ) {
-       if( !$title->exists() ) {
-               # Create the article
-               $dbw =& wfGetDB( DB_MASTER );
-               $dbw->immediateBegin();
-               $article = new Article( $title );
-               $articleId = $article->insertOn( $dbw );
-               # Prepare and save associated revision
-               $revision = new Revision( array( 'page' => $articleId, 'text' => $text, 'user' => $user->mId, 'user_text' => $user->getName(), 'comment' => $comment ) );
-               $revisionId = $revision->insertOn( $dbw );
-               # Make it the current revision
-               $article->updateRevisionOn( $dbw, $revision );
-               $dbw->immediateCommit();
-               # Update recent changes if appropriate
-               if( $rc )
-                       updateRecentChanges( $dbw, $title, $user, $comment, strlen( $text ), $articleId );
-               # Touch links etc.
-               Article::onArticleCreate( $title );
-               $article->editUpdates( $text, $comment, false, $dbw->timestamp(), $revisionId );
-               return true;
-       } else {
-               # Title exists; touch nothing
-               return false;
-       }
-}
-
-/**
- * Turn a filename into a title
- *
- * @param $filename Filename to be transformed
- * @return Title
- */
-function titleFromFilename( $filename ) {
-       $parts = explode( '/', $filename );
-       $parts = explode( '.', $parts[ count( $parts ) - 1 ] );
-       return Title::newFromText( $parts[0] );
-}
-
-/**
- * Update recent changes with the page creation event
- *
- * @param $dbw Database in use
- * @param $title Title of the new page
- * @param $user User responsible for the creation
- * @param $comment Edit summary associated with the edit
- * @param $size Size of the page
- * @param $articleId Article identifier
- */ 
-function updateRecentChanges( &$dbw, &$title, &$user, $comment, $size, $articleId ) {
-       RecentChange::notifyNew( $dbw->timestamp(), $title, false, $user, $comment, 'default', '', $size, $articleId );
-}
-
-?>
\ No newline at end of file
index 625763b..a29d879 100644 (file)
-<?php
-
-/**
- * Maintenance script to insert an article, importing text from a file
- *
- * @package MediaWiki
- * @subpackage Maintenance
- * @author Rob Church <robchur@gmail.com>
- */
-
-$options = array( 'help', 'norc' ); 
-$optionsWithArgs = array( 'title', 'user', 'comment' );
-require_once( 'commandLine.inc' );
-require_once( 'importTextFile.inc' );
-echo( "Import Text File\n\n" );
-
-if( !isset( $options['help'] ) || !$options['help'] ) {
-
-       # Check file existence
-       $filename = $args[0];
-       echo( "Using file '{$filename}'..." );
-       if( file_exists( $filename ) ) {
-               echo( "found.\n" );
-       
-               # Work out the title for the page       
-               if( isset( $option['title'] ) || trim( $options['title'] ) != '' ) {
-                       $titleText = $options['title'];
-                       # Use the supplied title
-                       echo( "Using title '{$titleText}'..." );
-                       $title = Title::newFromText( $options['title'] );
-               } else {
-                       # Attempt to make a title out of the filename
-                       echo( "Using title from filename..." );
-                       $title = titleFromFilename( $filename );
-               }
-               
-               # Check the title's valid
-               if( !is_null( $title ) && is_object( $title ) ) {
-                       echo( "ok.\n" );
-               
-                       # Read in the text
-                       $text = file_get_contents( $filename );
-                       
-                       # Check the supplied user and fall back to a default if needed
-                       if( isset( $options['user'] ) && trim( $options['user'] ) != '' ) {
-                               $username = $options['user'];
-                       } else {
-                               $username = 'MediaWiki default';
-                       }
-                       echo( "Using user '{$username}'..." );
-                       $user = User::newFromName( $username );
-                       
-                       # Check the user's valid
-                       if( !is_null( $user ) && is_object( $user ) ) {
-                               echo( "ok.\n" );
-                               $wgUser =& $user;
-                       
-                               # If a comment was supplied, use it (replace _ with spaces ) else use a default
-                               if( isset( $options['comment'] ) || trim( $options['comment'] != '' ) ) {
-                                       $comment = str_replace( '_', ' ', $options['comment'] );
-                               } else {
-                                       $comment = 'Importing text file';
-                               }
-                               echo( "Using edit summary '{$comment}'.\n" );
-                       
-                               # Do we need to update recent changes?
-                               if( isset( $options['norc'] ) && $options['norc'] ) {
-                                       $rc = false;
-                               } else {
-                                       $rc = true;
-                               }
-                       
-                               # Attempt the insertion
-                               echo( "Attempting to insert page..." );
-                               $success = insertNewArticle( $title, $text, $user, $comment, $rc );
-                               if( $success ) {
-                                       echo( "done.\n" );
-                               } else {
-                                       echo( "failed. Title exists.\n" );
-                               }
-                       
-                       } else {
-                               # Dud user
-                               echo( "invalid username.\n" );
-                       }
-                       
-               } else {
-                       # Dud title
-                       echo( "invalid title.\n" );
-               }
-               
-       } else {
-               # File not found
-               echo( "not found.\n" );
-       }
-
-} else {
-       # Show help
-       echo( "Imports the contents of a text file into a wiki page.\n\n" );
-       echo( "USAGE: php importTextFile.php [--help|--title <title>|--user <user>|--comment <comment>|--norc] <filename>\n\n" );
-       echo( "              --help: Show this help information\n" );
-       echo( "    --title <title> : Title for the new page; if not supplied, the filename is used as a base for the title\n" );
-       echo( "      --user <user> : User to be associated with the edit; if not supplied, a default is used\n" );
-       echo( "--comment <comment> : Edit summary to be associated with the edit; underscores are transformed into spaces; if not supplied, a default is used\n" );
-       echo( "         <filename> : Path to the file containing the wikitext to import\n" );
-       echo( "             --norc : Do not add a page creation event to recent changes\n" );
-
-}
-echo( "\n" );  
-
+<?php\r
+\r
+/**\r
+ * Maintenance script allows creating or editing pages using\r
+ * the contents of a text file\r
+ *\r
+ * @package MediaWiki\r
+ * @subpackage Maintenance\r
+ * @author Rob Church <robchur@gmail.com>\r
+ */\r
\r
+$options = array( 'help', 'nooverwrite' ); \r
+$optionsWithArgs = array( 'title', 'user', 'comment' );\r
+require_once( 'commandLine.inc' );\r
+echo( "Import Text File\n\n" );\r
+\r
+if( isset( $options['help'] ) ) {\r
+       showHelp();\r
+} else {\r
+\r
+       $filename = $args[0];\r
+       echo( "Using {$filename}..." );\r
+       if( is_file( $filename ) ) {\r
+               \r
+               $title = isset( $options['title'] ) ? $options['title'] : titleFromFilename( $filename );\r
+               $title = Title::newFromUrl( $title );\r
+               echo( "\nUsing title '" . $title->getPrefixedText() . "'..." );\r
+               \r
+               if( is_object( $title ) ) {\r
+                       \r
+                       if( !$title->exists() || !isset( $options['nooverwrite'] ) ) {\r
+                       \r
+                               $text = file_get_contents( $filename );\r
+                               $user = isset( $options['user'] ) ? $options['user'] : 'MediaWiki default';\r
+                               $user = User::newFromName( $user );\r
+                               echo( "\nUsing username '" . $user->getName() . "'..." );\r
+                               \r
+                               if( is_object( $user ) ) {\r
+                               \r
+                                       $wgUser =& $user;\r
+                                       $comment = isset( $options['comment'] ) ? $options['comment'] : 'Importing text file';\r
+                                       $comment = str_replace( '_', ' ', $comment );\r
+                                       \r
+                                       echo( "\nPerforming edit..." );\r
+                                       $article = new Article( $title );\r
+                                       $article->doEdit( $text, $comment );\r
+                                       echo( "done.\n" );\r
+                               \r
+                               } else {\r
+                                       echo( "invalid username.\n" );\r
+                               }\r
+                       \r
+                       } else {\r
+                               echo( "page exists.\n" );\r
+                       }\r
+                       \r
+               } else {\r
+                       echo( "invalid title.\n" );\r
+               }\r
+               \r
+       } else {\r
+               echo( "does not exist.\n" );\r
+       }\r
+\r
+}\r
+\r
+function titleFromFilename( $filename ) {\r
+       $parts = explode( '/', $filename );\r
+       $parts = explode( '.', $parts[ count( $parts ) - 1 ] );\r
+       return $parts[0];\r
+}\r
+\r
+function showHelp() {\r
+       echo( "Import the contents of a text file into a wiki page.\n\n" );\r
+       echo( "USAGE: php importTextFile.php [--help|--title <title>|--user <user>|--comment <comment>|--nooverwrite] <filename>\n\n" );\r
+       echo( "              --help: Show this help information\n" );\r
+       echo( "    --title <title> : Title for the new page; if not supplied, the filename is used as a base for the title\n" );\r
+       echo( "      --user <user> : User to be associated with the edit; if not supplied, a default is used\n" );\r
+       echo( "--comment <comment> : Edit summary to be associated with the edit; underscores are transformed into spaces; if not supplied, a default is used\n" );\r
+       echo( "      --nooverwrite : Don't overwrite existing page content\n" );\r
+       echo( "         <filename> : Path to the file containing the wikitext to import\n\n" );\r
+}\r
+\r
 ?>
\ No newline at end of file