Merge "[FileRepo] Made getDescription() respect *_deleted fields."
[lhc/web/wiklou.git] / maintenance / importImages.php
index f3b10ea..bd077ff 100644 (file)
@@ -40,255 +40,265 @@ $processed = $added = $ignored = $skipped = $overwritten = $failed = 0;
 echo( "Import Images\n\n" );
 
 # Need a path
-if ( count( $args ) > 0 ) {
-
-       $dir = $args[0];
-
-       # Check Protection
-       if ( isset( $options['protect'] ) && isset( $options['unprotect'] ) )
-                       die( "Cannot specify both protect and unprotect.  Only 1 is allowed.\n" );
-
-       if ( isset( $options['protect'] ) && $options['protect'] == 1 )
-                       die( "You must specify a protection option.\n" );
-
-       # Prepare the list of allowed extensions
-       global $wgFileExtensions;
-       $extensions = isset( $options['extensions'] )
-               ? explode( ',', strtolower( $options['extensions'] ) )
-               : $wgFileExtensions;
-
-       # Search the path provided for candidates for import
-       $files = findFiles( $dir, $extensions );
-
-       # Initialise the user for this operation
-       $user = isset( $options['user'] )
-               ? User::newFromName( $options['user'] )
-               : User::newFromName( 'Maintenance script' );
-       if ( !$user instanceof User )
-               $user = User::newFromName( 'Maintenance script' );
-       $wgUser = $user;
-
-       # Get block check. If a value is given, this specified how often the check is performed
-       if ( isset( $options['check-userblock'] ) ) {
-               if ( !$options['check-userblock'] ) $checkUserBlock = 1;
-               else $checkUserBlock = (int)$options['check-userblock'];
+if ( count( $args ) == 0 ) {
+       showUsage();
+}
+
+$dir = $args[0];
+
+# Check Protection
+if ( isset( $options['protect'] ) && isset( $options['unprotect'] ) ) {
+       die( "Cannot specify both protect and unprotect.  Only 1 is allowed.\n" );
+}
+
+if ( isset( $options['protect'] ) && $options['protect'] == 1 ) {
+       die( "You must specify a protection option.\n" );
+}
+
+# Prepare the list of allowed extensions
+global $wgFileExtensions;
+$extensions = isset( $options['extensions'] )
+       ? explode( ',', strtolower( $options['extensions'] ) )
+       : $wgFileExtensions;
+
+# Search the path provided for candidates for import
+$files = findFiles( $dir, $extensions );
+
+# Initialise the user for this operation
+$user = isset( $options['user'] )
+       ? User::newFromName( $options['user'] )
+       : User::newFromName( 'Maintenance script' );
+if ( !$user instanceof User ) {
+       $user = User::newFromName( 'Maintenance script' );
+}
+$wgUser = $user;
+
+# Get block check. If a value is given, this specified how often the check is performed
+if ( isset( $options['check-userblock'] ) ) {
+       if ( !$options['check-userblock'] ) {
+               $checkUserBlock = 1;
        } else {
-               $checkUserBlock = false;
+               $checkUserBlock = (int)$options['check-userblock'];
        }
+} else {
+       $checkUserBlock = false;
+}
 
-       # Get --from
-       $from = @$options['from'];
+# Get --from
+$from = @$options['from'];
 
-       # Get sleep time.
-       $sleep = @$options['sleep'];
-       if ( $sleep ) $sleep = (int)$sleep;
+# Get sleep time.
+$sleep = @$options['sleep'];
+if ( $sleep ) {
+       $sleep = (int)$sleep;
+}
 
-       # Get limit number
-       $limit = @$options['limit'];
-       if ( $limit ) $limit = (int)$limit;
+# Get limit number
+$limit = @$options['limit'];
+if ( $limit ) {
+       $limit = (int)$limit;
+}
 
-       # Get the upload comment. Provide a default one in case there's no comment given.
-       $comment = 'Importing image file';
+# Get the upload comment. Provide a default one in case there's no comment given.
+$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" );
-               }
-       }
-       elseif ( isset( $options['comment'] ) ) {
-               $comment =  $options['comment'];
+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" );
        }
+} elseif ( isset( $options['comment'] ) ) {
+       $comment =  $options['comment'];
+}
+
+$commentExt = isset( $options['comment-ext'] ) ? $options['comment-ext'] : false;
 
-       $commentExt = isset( $options['comment-ext'] ) ? $options['comment-ext'] : false;
+# Get the license specifier
+$license = isset( $options['license'] ) ? $options['license'] : '';
 
-       # Get the license specifier
-       $license = isset( $options['license'] ) ? $options['license'] : '';
+# Batch "upload" operation
+$count = count( $files );
+if ( $count > 0 ) {
 
-       # Batch "upload" operation
-       if ( ( $count = count( $files ) ) > 0 ) {
+       foreach ( $files as $file ) {
+               $base = wfBaseName( $file );
 
-               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;
+               }
 
-                       # 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" );
+               if ( $from ) {
+                       if ( $from == $title->getDBkey() ) {
+                               $from = null;
+                       } else {
+                               $ignored++;
                                continue;
                        }
+               }
 
-                       if ( $from ) {
-                               if ( $from == $title->getDBkey() ) {
-                                       $from = NULL;
-                               } else {
-                                       $ignored++;
-                                       continue;
-                               }
+               if ( $checkUserBlock && ( ( $processed % $checkUserBlock ) == 0 ) ) {
+                       $user->clearInstanceCache( 'name' ); // reload from DB!
+                       if ( $user->isBlocked() ) {
+                               echo( $user->getName() . " was blocked! Aborting.\n" );
+                               break;
                        }
+               }
 
-                       if ( $checkUserBlock && ( ( $processed % $checkUserBlock ) == 0 ) ) {
-                               $user->clearInstanceCache( 'name' ); // reload from DB!
-                               if ( $user->isBlocked() ) {
-                                       echo( $user->getName() . " was blocked! Aborting.\n" );
-                                       break;
-                               }
+               # Check existence
+               $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 {
+                       if ( isset( $options['skip-dupes'] ) ) {
+                               $repo = $image->getRepo();
+                               $sha1 = File::sha1Base36( $file ); # XXX: we end up calculating this again when actually uploading. that sucks.
 
-                       # Check existence
-                       $image = wfLocalFile( $title );
-                       if ( $image->exists() ) {
-                               if ( isset( $options['overwrite'] ) ) {
-                                       echo( "{$base} exists, overwriting..." );
-                                       $svar = 'overwritten';
-                               } else {
-                                       echo( "{$base} exists, skipping\n" );
+                               $dupes = $repo->findBySha1( $sha1 );
+
+                               if ( $dupes ) {
+                                       echo( "{$base} already exists as " . $dupes[0]->getName() . ", skipping\n" );
                                        $skipped++;
                                        continue;
                                }
-                       } else {
-                               if ( isset( $options['skip-dupes'] ) ) {
-                                       $repo = $image->getRepo();
-                                       $sha1 = File::sha1Base36( $file ); # XXX: we end up calculating this again when actually uploading. that sucks.
+                       }
 
-                                       $dupes = $repo->findBySha1( $sha1 );
+                       echo( "Importing {$base}..." );
+                       $svar = 'added';
+               }
 
-                                       if ( $dupes ) {
-                                               echo( "{$base} already exists as " . $dupes[0]->getName() . ", skipping\n" );
-                                               $skipped++;
-                                               continue;
-                                       }
+               if ( isset( $options['source-wiki-url'] ) ) {
+                       /* find comment text directly from source wiki, through MW's API */
+                       $real_comment = getFileCommentFromSourceWiki( $options['source-wiki-url'], $base );
+                       if ( $real_comment === false )
+                               $commentText = $comment;
+                       else
+                               $commentText = $real_comment;
+
+                       /* find user directly from source wiki, through MW's API */
+                       $real_user = getFileUserFromSourceWiki( $options['source-wiki-url'], $base );
+                       if ( $real_user === false ) {
+                               $wgUser = $user;
+                       } else {
+                               $wgUser = User::newFromName( $real_user );
+                               if ( $wgUser === false ) {
+                                       # user does not exist in target wiki
+                                       echo ( "failed: user '$real_user' does not exist in target wiki." );
+                                       continue;
                                }
-
-                               echo( "Importing {$base}..." );
-                               $svar = 'added';
                        }
-
-                       if ( isset( $options['source-wiki-url'] ) ) {
-                               /* find comment text directly from source wiki, through MW's API */
-                               $real_comment = getFileCommentFromSourceWiki( $options['source-wiki-url'], $base );
-                               if ( $real_comment === false )
-                                       $commentText = $comment;
-                               else
-                                       $commentText = $real_comment;
-
-                               /* find user directly from source wiki, through MW's API */
-                               $real_user = getFileUserFromSourceWiki( $options['source-wiki-url'], $base );
-                               if ( $real_user === false ) {
-                                       $wgUser = $user;
+               } else {
+                       # 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 {
-                                       $wgUser = User::newFromName( $real_user );
-                                       if ( $wgUser === false ) {
-                                               # user does not exist in target wiki
-                                               echo ( "failed: user '$real_user' does not exist in target wiki." );
-                                               continue;
+                                       $commentText = file_get_contents( $f );
+                                       if ( !$commentText ) {
+                                               echo( " Failed to load comment file {$f}, using default comment. " );
                                        }
                                }
-                       } else {
-                               # 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. " );
-                                               }
-                                       }
-                               }
-
-                               if ( !$commentText ) {
-                                       $commentText = $comment;
-                               }
                        }
 
+                       if ( !$commentText ) {
+                               $commentText = $comment;
+                       }
+               }
 
-                       # Import the file
-                       if ( isset( $options['dry'] ) ) {
-                               echo( " publishing {$file} by '" . $wgUser->getName() . "', comment '$commentText'... " );
-                       } else {
-                               $archive = $image->publish( $file );
-                               if ( !$archive->isGood() ) {
-                                       echo( "failed. (" .
-                                               $archive->getWikiText() .
-                                               ")\n" );
-                                       $failed++;
-                                       continue;
-                               }
+               # Import the file
+               if ( isset( $options['dry'] ) ) {
+                       echo( " publishing {$file} by '" . $wgUser->getName() . "', comment '$commentText'... " );
+               } else {
+                       $archive = $image->publish( $file );
+                       if ( !$archive->isGood() ) {
+                               echo( "failed. (" .
+                                       $archive->getWikiText() .
+                                       ")\n" );
+                               $failed++;
+                               continue;
                        }
+               }
+
+               if ( isset( $options['dry'] ) ) {
+                       echo( "done.\n" );
+               } elseif ( $image->recordUpload( $archive->value, $commentText, $license ) ) {
+                       # We're done!
+                       echo( "done.\n" );
 
                        $doProtect = false;
-                       $restrictions = array();
 
                        global $wgRestrictionLevels;
 
                        $protectLevel = isset( $options['protect'] ) ? $options['protect'] : null;
 
                        if ( $protectLevel && in_array( $protectLevel, $wgRestrictionLevels ) ) {
-                                       $restrictions['move'] = $protectLevel;
-                                       $restrictions['edit'] = $protectLevel;
-                                       $doProtect = true;
+                               $doProtect = true;
                        }
                        if ( isset( $options['unprotect'] ) ) {
-                                       $restrictions['move'] = '';
-                                       $restrictions['edit'] = '';
-                                       $doProtect = true;
+                               $protectLevel = '';
+                               $doProtect = true;
                        }
 
+                       if ( $doProtect ) {
+                                       # Protect the file
+                                       echo "\nWaiting for slaves...\n";
+                                       // Wait for slaves.
+                                       sleep( 2.0 ); # Why this sleep?
+                                       wfWaitForSlaves();
 
-                       if ( isset( $options['dry'] ) ) {
-                               echo( "done.\n" );
-                       } elseif ( $image->recordUpload( $archive->value, $commentText, $license ) ) {
-                               # We're done!
-                               echo( "done.\n" );
-                               if ( $doProtect ) {
-                                               # Protect the file
-                                               $article = new Article( $title );
-                                               echo "\nWaiting for slaves...\n";
-                                               // Wait for slaves.
-                                               sleep( 2.0 ); # Why this sleep?
-                                               wfWaitForSlaves();
-
-                                               echo( "\nSetting image restrictions ... " );
-                                               if ( $article->updateRestrictions( $restrictions ) )
-                                                       echo( "done.\n" );
-                                               else
-                                                       echo( "failed.\n" );
-                               }
+                                       echo( "\nSetting image restrictions ... " );
 
-                       } else {
-                               echo( "failed. (at recordUpload stage)\n" );
-                               $svar = 'failed';
+                                       $cascade = false;
+                                       $restrictions = array();
+                                       foreach( $title->getRestrictionTypes() as $type ) {
+                                               $restrictions[$type] = $protectLevel;
+                                       }
+
+                                       $page = WikiPage::factory( $title );
+                                       $status = $page->doUpdateRestrictions( $restrictions, array(), $cascade, '', $user );
+                                       echo( ( $status->isOK() ? 'done' : 'failed' ) . "\n" );
                        }
 
-                       $$svar++;
-                       $processed++;
+               } else {
+                       echo( "failed. (at recordUpload stage)\n" );
+                       $svar = 'failed';
+               }
 
-                       if ( $limit && $processed >= $limit )
-                               break;
+               $$svar++;
+               $processed++;
 
-                       if ( $sleep )
-                               sleep( $sleep );
+               if ( $limit && $processed >= $limit ) {
+                       break;
                }
 
-               # Print out some statistics
-               echo( "\n" );
-               foreach ( array( 'count' => 'Found', 'limit' => 'Limit', 'ignored' => 'Ignored',
-                       'added' => 'Added', 'skipped' => 'Skipped', 'overwritten' => 'Overwritten',
-                       'failed' => 'Failed' ) as $var => $desc ) {
-                       if ( $$var > 0 )
-                               echo( "{$desc}: {$$var}\n" );
+               if ( $sleep ) {
+                       sleep( $sleep );
                }
+       }
 
-       } else {
-               echo( "No suitable files could be found for import.\n" );
+       # Print out some statistics
+       echo( "\n" );
+       foreach ( array( 'count' => 'Found', 'limit' => 'Limit', 'ignored' => 'Ignored',
+               'added' => 'Added', 'skipped' => 'Skipped', 'overwritten' => 'Overwritten',
+               'failed' => 'Failed' ) as $var => $desc ) {
+               if ( $$var > 0 )
+                       echo( "{$desc}: {$$var}\n" );
        }
 
 } else {
-       showUsage();
+       echo( "No suitable files could be found for import.\n" );
 }
 
 exit( 0 );