maintenance/importImages.php

   1 <?php
   2 /**
   3  * Import one or more images from the local file system into the wiki without
   4  * using the web-based interface.
   5  *
   6  * "Smart import" additions:
   7  * - aim: preserve the essential metadata (user, description) when importing medias from an existing wiki
   8  * - process:
   9  *      - interface with the source wiki, don't use bare files only (see --source-wiki-url).
  10  *      - fetch metadata from source wiki for each file to import.
  11  *      - commit the fetched metadata to the destination wiki while submitting.
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License along
  24  * with this program; if not, write to the Free Software Foundation, Inc.,
  25  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  26  * http://www.gnu.org/copyleft/gpl.html
  27  *
  28  * @file
  29  * @ingroup Maintenance
  30  * @author Rob Church <robchur@gmail.com>
  31  * @author Mij <mij@bitchx.it>
  32  */
  33
  34 $optionsWithArgs = array(
  35         'extensions', 'comment', 'comment-file', 'comment-ext', 'summary', 'user',
  36         'license', 'sleep', 'limit', 'from', 'source-wiki-url', 'timestamp',
  37 );
  38 require_once( __DIR__ . '/commandLine.inc' );
  39 require_once( __DIR__ . '/importImages.inc' );
  40 $processed = $added = $ignored = $skipped = $overwritten = $failed = 0;
  41
  42 echo( "Import Images\n\n" );
  43
  44 # Need a path
  45 if ( count( $args ) == 0 ) {
  46         showUsage();
  47 }
  48
  49 $dir = $args[0];
  50
  51 # Check Protection
  52 if ( isset( $options['protect'] ) && isset( $options['unprotect'] ) ) {
  53         die( "Cannot specify both protect and unprotect.  Only 1 is allowed.\n" );
  54 }
  55
  56 if ( isset( $options['protect'] ) && $options['protect'] == 1 ) {
  57         die( "You must specify a protection option.\n" );
  58 }
  59
  60 # Prepare the list of allowed extensions
  61 global $wgFileExtensions;
  62 $extensions = isset( $options['extensions'] )
  63         ? explode( ',', strtolower( $options['extensions'] ) )
  64         : $wgFileExtensions;
  65
  66 # Search the path provided for candidates for import
  67 $files = findFiles( $dir, $extensions, isset( $options['search-recursively'] ) );
  68
  69 # Initialise the user for this operation
  70 $user = isset( $options['user'] )
  71         ? User::newFromName( $options['user'] )
  72         : User::newFromName( 'Maintenance script' );
  73 if ( !$user instanceof User ) {
  74         $user = User::newFromName( 'Maintenance script' );
  75 }
  76 $wgUser = $user;
  77
  78 # Get block check. If a value is given, this specified how often the check is performed
  79 if ( isset( $options['check-userblock'] ) ) {
  80         if ( !$options['check-userblock'] ) {
  81                 $checkUserBlock = 1;
  82         } else {
  83                 $checkUserBlock = (int)$options['check-userblock'];
  84         }
  85 } else {
  86         $checkUserBlock = false;
  87 }
  88
  89 # Get --from
  90 $from = @$options['from'];
  91
  92 # Get sleep time.
  93 $sleep = @$options['sleep'];
  94 if ( $sleep ) {
  95         $sleep = (int)$sleep;
  96 }
  97
  98 # Get limit number
  99 $limit = @$options['limit'];
 100 if ( $limit ) {
 101         $limit = (int)$limit;
 102 }
 103
 104 $timestamp = isset( $options['timestamp'] ) ? $options['timestamp'] : false;
 105
 106 # Get the upload comment. Provide a default one in case there's no comment given.
 107 $comment = 'Importing image file';
 108
 109 if ( isset( $options['comment-file'] ) ) {
 110         $comment = file_get_contents( $options['comment-file'] );
 111         if ( $comment === false || $comment === null ) {
 112                 die( "failed to read comment file: {$options['comment-file']}\n" );
 113         }
 114 } elseif ( isset( $options['comment'] ) ) {
 115         $comment = $options['comment'];
 116 }
 117
 118 $commentExt = isset( $options['comment-ext'] ) ? $options['comment-ext'] : false;
 119
 120 $summary = isset( $options['summary'] ) ? $options['summary'] : '';
 121
 122 # Get the license specifier
 123 $license = isset( $options['license'] ) ? $options['license'] : '';
 124
 125 # Batch "upload" operation
 126 $count = count( $files );
 127 if ( $count > 0 ) {
 128
 129         foreach ( $files as $file ) {
 130                 $base = wfBaseName( $file );
 131
 132                 # Validate a title
 133                 $title = Title::makeTitleSafe( NS_FILE, $base );
 134                 if ( !is_object( $title ) ) {
 135                         echo( "{$base} could not be imported; a valid title cannot be produced\n" );
 136                         continue;
 137                 }
 138
 139                 if ( $from ) {
 140                         if ( $from == $title->getDBkey() ) {
 141                                 $from = null;
 142                         } else {
 143                                 $ignored++;
 144                                 continue;
 145                         }
 146                 }
 147
 148                 if ( $checkUserBlock && ( ( $processed % $checkUserBlock ) == 0 ) ) {
 149                         $user->clearInstanceCache( 'name' ); // reload from DB!
 150                         if ( $user->isBlocked() ) {
 151                                 echo( $user->getName() . " was blocked! Aborting.\n" );
 152                                 break;
 153                         }
 154                 }
 155
 156                 # Check existence
 157                 $image = wfLocalFile( $title );
 158                 if ( $image->exists() ) {
 159                         if ( isset( $options['overwrite'] ) ) {
 160                                 echo( "{$base} exists, overwriting..." );
 161                                 $svar = 'overwritten';
 162                         } else {
 163                                 echo( "{$base} exists, skipping\n" );
 164                                 $skipped++;
 165                                 continue;
 166                         }
 167                 } else {
 168                         if ( isset( $options['skip-dupes'] ) ) {
 169                                 $repo = $image->getRepo();
 170                                 $sha1 = File::sha1Base36( $file ); # XXX: we end up calculating this again when actually uploading. that sucks.
 171
 172                                 $dupes = $repo->findBySha1( $sha1 );
 173
 174                                 if ( $dupes ) {
 175                                         echo( "{$base} already exists as " . $dupes[0]->getName() . ", skipping\n" );
 176                                         $skipped++;
 177                                         continue;
 178                                 }
 179                         }
 180
 181                         echo( "Importing {$base}..." );
 182                         $svar = 'added';
 183                 }
 184
 185                 if ( isset( $options['source-wiki-url'] ) ) {
 186                         /* find comment text directly from source wiki, through MW's API */
 187                         $real_comment = getFileCommentFromSourceWiki( $options['source-wiki-url'], $base );
 188                         if ( $real_comment === false ) {
 189                                 $commentText = $comment;
 190                         } else {
 191                                 $commentText = $real_comment;
 192                         }
 193
 194                         /* find user directly from source wiki, through MW's API */
 195                         $real_user = getFileUserFromSourceWiki( $options['source-wiki-url'], $base );
 196                         if ( $real_user === false ) {
 197                                 $wgUser = $user;
 198                         } else {
 199                                 $wgUser = User::newFromName( $real_user );
 200                                 if ( $wgUser === false ) {
 201                                         # user does not exist in target wiki
 202                                         echo ( "failed: user '$real_user' does not exist in target wiki." );
 203                                         continue;
 204                                 }
 205                         }
 206                 } else {
 207                         # Find comment text
 208                         $commentText = false;
 209
 210                         if ( $commentExt ) {
 211                                 $f = findAuxFile( $file, $commentExt );
 212                                 if ( !$f ) {
 213                                         echo( " No comment file with extension {$commentExt} found for {$file}, using default comment. " );
 214                                 } else {
 215                                         $commentText = file_get_contents( $f );
 216                                         if ( !$commentText ) {
 217                                                 echo( " Failed to load comment file {$f}, using default comment. " );
 218                                         }
 219                                 }
 220                         }
 221
 222                         if ( !$commentText ) {
 223                                 $commentText = $comment;
 224                         }
 225                 }
 226
 227                 # Import the file
 228                 if ( isset( $options['dry'] ) ) {
 229                         echo( " publishing {$file} by '" . $wgUser->getName() . "', comment '$commentText'... " );
 230                 } else {
 231                         $archive = $image->publish( $file );
 232                         if ( !$archive->isGood() ) {
 233                                 echo( "failed. (" .
 234                                         $archive->getWikiText() .
 235                                         ")\n" );
 236                                 $failed++;
 237                                 continue;
 238                         }
 239                 }
 240
 241                 $commentText = SpecialUpload::getInitialPageText( $commentText, $license );
 242                 if ( !$summary ) {
 243                         $summary = $commentText;
 244                 }
 245
 246                 if ( isset( $options['dry'] ) ) {
 247                         echo( "done.\n" );
 248                 } elseif ( $image->recordUpload2( $archive->value, $summary, $commentText, false, $timestamp ) ) {
 249                         # We're done!
 250                         echo( "done.\n" );
 251
 252                         $doProtect = false;
 253
 254                         global $wgRestrictionLevels;
 255
 256                         $protectLevel = isset( $options['protect'] ) ? $options['protect'] : null;
 257
 258                         if ( $protectLevel && in_array( $protectLevel, $wgRestrictionLevels ) ) {
 259                                 $doProtect = true;
 260                         }
 261                         if ( isset( $options['unprotect'] ) ) {
 262                                 $protectLevel = '';
 263                                 $doProtect = true;
 264                         }
 265
 266                         if ( $doProtect ) {
 267                                         # Protect the file
 268                                         echo "\nWaiting for slaves...\n";
 269                                         // Wait for slaves.
 270                                         sleep( 2.0 ); # Why this sleep?
 271                                         wfWaitForSlaves();
 272
 273                                         echo( "\nSetting image restrictions ... " );
 274
 275                                         $cascade = false;
 276                                         $restrictions = array();
 277                                         foreach ( $title->getRestrictionTypes() as $type ) {
 278                                                 $restrictions[$type] = $protectLevel;
 279                                         }
 280
 281                                         $page = WikiPage::factory( $title );
 282                                         $status = $page->doUpdateRestrictions( $restrictions, array(), $cascade, '', $user );
 283                                         echo( ( $status->isOK() ? 'done' : 'failed' ) . "\n" );
 284                         }
 285
 286                 } else {
 287                         echo( "failed. (at recordUpload stage)\n" );
 288                         $svar = 'failed';
 289                 }
 290
 291                 $$svar++;
 292                 $processed++;
 293
 294                 if ( $limit && $processed >= $limit ) {
 295                         break;
 296                 }
 297
 298                 if ( $sleep ) {
 299                         sleep( $sleep );
 300                 }
 301         }
 302
 303         # Print out some statistics
 304         echo( "\n" );
 305         foreach ( array( 'count' => 'Found', 'limit' => 'Limit', 'ignored' => 'Ignored',
 306                 'added' => 'Added', 'skipped' => 'Skipped', 'overwritten' => 'Overwritten',
 307                 'failed' => 'Failed' ) as $var => $desc ) {
 308                 if ( $$var > 0 ) {
 309                         echo( "{$desc}: {$$var}\n" );
 310                 }
 311         }
 312
 313 } else {
 314         echo( "No suitable files could be found for import.\n" );
 315 }
 316
 317 exit( 0 );
 318
 319 function showUsage( $reason = false ) {
 320         if ( $reason ) {
 321                 echo( $reason . "\n" );
 322         }
 323
 324         echo <<<TEXT
 325 Imports images and other media files into the wiki
 326 USAGE: php importImages.php [options] <dir>
 327
 328 <dir> : Path to the directory containing images to be imported
 329
 330 Options:
 331 --extensions=<exts>     Comma-separated list of allowable extensions, defaults to \$wgFileExtensions
 332 --overwrite             Overwrite existing images with the same name (default is to skip them)
 333 --limit=<num>           Limit the number of images to process. Ignored or skipped images are not counted.
 334 --from=<name>           Ignore all files until the one with the given name. Useful for resuming
 335                         aborted imports. <name> should be the file's canonical database form.
 336 --skip-dupes            Skip images that were already uploaded under a different name (check SHA1)
 337 --search-recursively    Search recursively for files in subdirectories
 338 --sleep=<sec>           Sleep between files. Useful mostly for debugging.
 339 --user=<username>       Set username of uploader, default 'Maintenance script'
 340 --check-userblock       Check if the user got blocked during import.
 341 --comment=<text>        Set file description, default 'Importing image file'.
 342 --comment-file=<file>   Set description to the content of <file>.
 343 --comment-ext=<ext>     Causes the description for each file to be loaded from a file with the same name
 344                         but the extension <ext>. If a global description is also given, it is appended.
 345 --license=<code>        Use an optional license template
 346 --dry                   Dry run, don't import anything
 347 --protect=<protect>     Specify the protect value (autoconfirmed,sysop)
 348 --summary=<summary>     Upload summary, description will be used if not provided
 349 --timestamp=<timestamp> Override upload time/date, all MediaWiki timestamp formats are accepted
 350 --unprotect             Unprotects all uploaded images
 351 --source-wiki-url       If specified, take User and Comment data for each imported file from this URL.
 352                         For example, --source-wiki-url="http://en.wikipedia.org/"
 353
 354 TEXT;
 355         exit( 1 );
 356 }