image import new supports per-image description files

[lhc/web/wiklou.git] / maintenance / importImages.php

diff --git a/maintenance/importImages.php b/maintenance/importImages.php
index 0c560d7..a39c502 100644 (file)
--- a/maintenance/importImages.php
+++ b/maintenance/importImages.php
@@ -4,13 +4,16 @@
  * Maintenance script to import one or more images from the local file system into
  * the wiki without using the web-based interface
  *
- * @addtogroup Maintenance
+ * @file
+ * @ingroup Maintenance
  * @author Rob Church <robchur@gmail.com>
  */
 
-$optionsWithArguments = array( 'extensions' );
+$optionsWithArgs = array( 'extensions', 'comment-file', 'comment-ext' );
 require_once( 'commandLine.inc' );
 require_once( 'importImages.inc.php' );
+$added = $skipped = $overwritten = 0;
+
 echo( "Import Images\n\n" );
 
 # Need a path
@@ -36,16 +39,25 @@ if( count( $args ) > 0 ) {
        $wgUser = $user;
 
        # Get the upload comment
-       $comment = isset( $options['comment'] )
-               ? $options['comment']
-               : 'Importing image file';
+       $comment = 'Importing image file';
+
+       if ( isset( $options['comment-file'] ) ) {
+               $comment =  file_get_contents( $options['comment-file'] );
+               if ( $comment === false || $comment === NULL ) {
+                       die( "failed to read comment file: {$options['comment-file']}\n" );
+               }
+       }
+       else if ( isset( $options['comment'] ) ) {
+               $comment =  $options['comment'];
+       }
+
+       $commentExt = isset( $options['comment-ext'] ) ? $options['comment-ext'] : false;
 
        # Get the license specifier
        $license = isset( $options['license'] ) ? $options['license'] : '';
 
        # Batch "upload" operation
-       global $wgUploadDirectory;
-       if( count( $files ) > 0 ) {
+       if( ( $count = count( $files ) ) > 0 ) {
        
                foreach( $files as $file ) {
                        $base = wfBaseName( $file );
@@ -60,26 +72,67 @@ if( count( $args ) > 0 ) {
                        # Check existence
                        $image = wfLocalFile( $title );
                        if( $image->exists() ) {
-                               echo( "{$base} could not be imported; a file with this name exists in the wiki\n" );
-                               continue;
+                               if( isset( $options['overwrite'] ) ) {
+                                       echo( "{$base} exists, overwriting..." );
+                                       $svar = 'overwritten';
+                               } else {
+                                       echo( "{$base} exists, skipping\n" );
+                                       $skipped++;
+                                       continue;
+                               }
+                       } else {
+                               echo( "Importing {$base}..." );
+                               $svar = 'added';
                        }
-       
-                       # Stash the file
-                       echo( "Saving {$base}..." );
-       
-                       $archive = $image->publish( $file );
-                       if ( WikiError::isError( $archive ) ) {
-                               echo( "failed.\n" );
-                               continue;
+
+                       # Find comment text
+                       $commentText = false;
+
+                       if ( $commentExt ) {
+                               $f = findAuxFile( $file, $commentExt );
+                               if ( !$f ) {
+                                       echo( " No comment file with extension {$commentExt} found for {$file}, using default comment. " );
+                               } else {
+                                       $commentText = file_get_contents( $f );
+                                       if ( !$f ) {
+                                               echo( " Failed to load comment file {$f}, using default comment. " );
+                                       }
+                               }
                        }
-                       echo( "importing..." );
-       
-                       if ( $image->recordUpload( $archive, $comment, $license ) ) {
+
+                       if ( !$commentText ) {
+                               $commentText = $comment;
+                       }
+
+                       # Import the file       
+                       if ( isset( $options['dry'] ) ) {
+                               echo( " publishing {$file}... " );
+                       } else {
+                               $archive = $image->publish( $file );
+                               if( WikiError::isError( $archive ) || !$archive->isGood() ) {
+                                       echo( "failed.\n" );
+                                       continue;
+                               }
+                       }
+
+                       $$svar++;
+                       if ( isset( $options['dry'] ) ) {
+                               echo( "done.\n" );
+                       } else if ( $image->recordUpload( $archive->value, $commentText, $license ) ) {
                                # We're done!
                                echo( "done.\n" );
                        } else {
                                echo( "failed.\n" );
                        }
+                       
+               }
+               
+               # Print out some statistics
+               echo( "\n" );
+               foreach( array( 'count' => 'Found', 'added' => 'Added',
+                       'skipped' => 'Skipped', 'overwritten' => 'Overwritten' ) as $var => $desc ) {
+                       if( $$var > 0 )
+                               echo( "{$desc}: {$$var}\n" );
                }
                
        } else {
@@ -98,18 +151,22 @@ function showUsage( $reason = false ) {
        }
 
        echo <<<END
+Imports images and other media files into the wiki
 USAGE: php importImages.php [options] <dir>
 
 <dir> : Path to the directory containing images to be imported
 
 Options:
---extensions=<exts>    Comma-separated list of allowable extensions, defaults to $wgFileExtensions
+--extensions=<exts>    Comma-separated list of allowable extensions, defaults to \$wgFileExtensions
+--overwrite            Overwrite existing images if a conflicting-named image is found
 --user=<username>      Set username of uploader, default 'Maintenance script'
 --comment=<text>       Set upload summary comment, default 'Importing image file'
+--comment-file=<file>          Set upload summary comment the the content of <file>.
+--comment-ext=<ext>    Causes the comment for each file to be loaded from a file with the same name
+                       but the extension <ext>.
 --license=<code>       Use an optional license template
+--dry                  Dry run, don't import anything
 
 END;
        exit();
-}
-
-?>
+}
\ No newline at end of file