* 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>
*/
+$optionsWithArgs = array( 'extensions', 'comment', 'comment-file', 'comment-ext', 'user', 'license' );
require_once( 'commandLine.inc' );
require_once( 'importImages.inc.php' );
+$added = $skipped = $overwritten = 0;
+
echo( "Import Images\n\n" );
-# Need a directory and at least one extension
-if( count( $args ) > 1 ) {
+# Need a path
+if( count( $args ) > 0 ) {
- $dir = array_shift( $args );
+ $dir = $args[0];
- # Check the allowed extensions
- while( $ext = array_shift( $args ) ) {
- $exts[] = ltrim( $ext, '.' );
- }
+ # Prepare the list of allowed extensions
+ global $wgFileExtensions;
+ $extensions = isset( $options['extensions'] )
+ ? explode( ',', strtolower( $options['extensions'] ) )
+ : $wgFileExtensions;
- # Search the directory given and pull out suitable candidates
- $files = findFiles( $dir, $exts );
+ # Search the path provided for candidates for import
+ $files = findFiles( $dir, $extensions );
# Initialise the user for this operation
$user = isset( $options['user'] )
$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
- foreach( $files as $file ) {
-
- $base = wfBaseName( $file );
-
- # Validate a title
- $title = Title::makeTitleSafe( NS_IMAGE, $base );
- if( is_object( $title ) ) {
-
+ if( ( $count = count( $files ) ) > 0 ) {
+
+ foreach( $files as $file ) {
+ $base = wfBaseName( $file );
+
+ # Validate a title
+ $title = Title::makeTitleSafe( NS_FILE, $base );
+ if( !is_object( $title ) ) {
+ echo( "{$base} could not be imported; a valid title cannot be produced\n" );
+ continue;
+ }
+
# Check existence
- $image = new Image( $title );
- if( !$image->exists() ) {
-
- global $wgUploadDirectory;
-
- # copy() doesn't create paths so if the hash path doesn't exist, we
- # have to create it
- makeHashPath( wfGetHashPath( $image->name ) );
-
- # Stash the file
- echo( "Saving {$base}..." );
-
- if( copy( $file, $image->getFullPath() ) ) {
-
- echo( "importing..." );
-
- # Grab the metadata
- $image->loadFromFile();
-
- # Record the upload
- if( $image->recordUpload( '', $comment, $license ) ) {
+ $image = wfLocalFile( $title );
+ if( $image->exists() ) {
+ if( isset( $options['overwrite'] ) ) {
+ echo( "{$base} exists, overwriting..." );
+ $svar = 'overwritten';
+ } else {
+ echo( "{$base} exists, skipping\n" );
+ $skipped++;
+ continue;
+ }
+ } else {
+ echo( "Importing {$base}..." );
+ $svar = 'added';
+ }
- # We're done!
- echo( "done.\n" );
+ # Find comment text
+ $commentText = false;
- } else {
- echo( "failed.\n" );
+ 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. " );
}
+ }
+ }
- } else {
+ 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( "{$base} could not be imported; a file with this name exists in the wiki\n" );
+ echo( "failed.\n" );
}
-
- } else {
- echo( "{$base} could not be imported; a valid title cannot be produced\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 {
+ echo( "No suitable files could be found for import.\n" );
}
} else {
}
echo <<<END
-USAGE: php importImages.php [options] <dir> <ext1> ...
+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
-<ext1+> File extensions to import
Options:
---user=<username> Set username of uploader, default 'Image import script'
---comment=<text> Set upload summary comment, default 'Importing image file'
---license=<code> Use an optional license template
+--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
dépôts / lhc / web / wiklou.git / blobdiff