Standardised file description headers:
[lhc/web/wiklou.git] / maintenance / importImages.php
index 704cb0f..4364785 100644 (file)
  */
 
 $optionsWithArgs = array( 'extensions', 'comment', 'comment-file', 'comment-ext', 'user', 'license', 'sleep', 'limit', 'from', 'source-wiki-url' );
-require_once( dirname(__FILE__) . '/commandLine.inc' );
-require_once( dirname(__FILE__) . '/importImages.inc.php' );
+require_once( dirname( __FILE__ ) . '/commandLine.inc' );
+require_once( dirname( __FILE__ ) . '/importImages.inc' );
 $processed = $added = $ignored = $skipped = $overwritten = $failed = 0;
 
 echo( "Import Images\n\n" );
 
 # Need a path
-if( count( $args ) > 0 ) {
+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'] ) && 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");
+if ( isset( $options['protect'] ) && $options['protect'] == 1 )
+                       die( "You must specify a protection option.\n" );
 
        # Prepare the list of allowed extensions
        global $wgFileExtensions;
@@ -49,14 +49,14 @@ if (isset($options['protect']) && $options['protect'] == 1)
        $user = isset( $options['user'] )
                ? User::newFromName( $options['user'] )
                : User::newFromName( 'Maintenance script' );
-       if( !$user instanceof User )
+       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']; 
+               else $checkUserBlock = (int)$options['check-userblock'];
        } else {
                $checkUserBlock = false;
        }
@@ -66,11 +66,11 @@ if (isset($options['protect']) && $options['protect'] == 1)
 
        # Get sleep time. 
        $sleep = @$options['sleep'];
-       if ( $sleep ) $sleep = (int)$sleep; 
+       if ( $sleep ) $sleep = (int)$sleep;
 
        # Get limit number
        $limit = @$options['limit'];
-       if ( $limit ) $limit = (int)$limit; 
+       if ( $limit ) $limit = (int)$limit;
 
        # Get the upload comment
        $comment = NULL;
@@ -91,14 +91,14 @@ if (isset($options['protect']) && $options['protect'] == 1)
        $license = isset( $options['license'] ) ? $options['license'] : '';
 
        # Batch "upload" operation
-       if( ( $count = count( $files ) ) > 0 ) {
+       if ( ( $count = count( $files ) ) > 0 ) {
        
-               foreach( $files as $file ) {
+               foreach ( $files as $file ) {
                        $base = wfBaseName( $file );
        
                        # Validate a title
                        $title = Title::makeTitleSafe( NS_FILE, $base );
-                       if( !is_object( $title ) ) {
+                       if ( !is_object( $title ) ) {
                                echo( "{$base} could not be imported; a valid title cannot be produced\n" );
                                continue;
                        }
@@ -113,7 +113,7 @@ if (isset($options['protect']) && $options['protect'] == 1)
                        }
 
                        if ( $checkUserBlock && ( ( $processed % $checkUserBlock ) == 0 ) ) {
-                               $user->clearInstanceCache( 'name' ); //reload from DB!
+                               $user->clearInstanceCache( 'name' ); // reload from DB!
                                if ( $user->isBlocked() ) {
                                        echo( $user->getName() . " was blocked! Aborting.\n" );
                                        break;
@@ -122,8 +122,8 @@ if (isset($options['protect']) && $options['protect'] == 1)
 
                        # Check existence
                        $image = wfLocalFile( $title );
-                       if( $image->exists() ) {
-                               if( isset( $options['overwrite'] ) ) {
+                       if ( $image->exists() ) {
+                               if ( isset( $options['overwrite'] ) ) {
                                        echo( "{$base} exists, overwriting..." );
                                        $svar = 'overwritten';
                                } else {
@@ -134,7 +134,7 @@ if (isset($options['protect']) && $options['protect'] == 1)
                        } 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.
+                                       $sha1 = File::sha1Base36( $file ); # XXX: we end up calculating this again when actually uploading. that sucks.
 
                                        $dupes = $repo->findBySha1( $sha1 );
 
@@ -149,23 +149,23 @@ if (isset($options['protect']) && $options['protect'] == 1)
                                $svar = 'added';
                        }
 
-            if (isset( $options['source-wiki-url'])) {
+            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)
+                $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) {
+                $real_user = getFileUserFromSourceWiki( $options['source-wiki-url'], $base );
+                if ( $real_user === false ) {
                     $wgUser = $user;
                 } else {
-                    $wgUser = User::newFromName($real_user);
-                    if ($wgUser === false) {
+                    $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.");
+                        echo ( "failed: user '$real_user' does not exist in target wiki." );
                         continue;
                     }
                 }
@@ -196,7 +196,7 @@ if (isset($options['protect']) && $options['protect'] == 1)
                                echo( " publishing {$file} by '" . $wgUser->getName() . "', comment '$commentText'... " );
                        } else {
                                $archive = $image->publish( $file );
-                               if( WikiError::isError( $archive ) || !$archive->isGood() ) {
+                               if ( WikiError::isError( $archive ) || !$archive->isGood() ) {
                                        echo( "failed.\n" );
                                        $failed++;
                                        continue;
@@ -208,14 +208,14 @@ if (isset($options['protect']) && $options['protect'] == 1)
                        
                        global $wgRestrictionLevels;
                        
-                       $protectLevel = isset($options['protect']) ? $options['protect'] : null;
+                       $protectLevel = isset( $options['protect'] ) ? $options['protect'] : null;
                        
                        if ( $protectLevel && in_array( $protectLevel, $wgRestrictionLevels ) ) {
                                        $restrictions['move'] = $protectLevel;
                                        $restrictions['edit'] = $protectLevel;
                                        $doProtect = true;
                        }
-                       if (isset($options['unprotect'])) {
+                       if ( isset( $options['unprotect'] ) ) {
                                        $restrictions['move'] = '';
                                        $restrictions['edit'] = '';
                                        $doProtect = true;
@@ -227,16 +227,16 @@ if (isset($options['protect']) && $options['protect'] == 1)
                        } else if ( $image->recordUpload( $archive->value, $commentText, $license ) ) {
                                # We're done!
                                echo( "done.\n" );
-                               if ($doProtect) {
+                               if ( $doProtect ) {
                                                # Protect the file
                                                $article = new Article( $title );
                                                echo "\nWaiting for slaves...\n";
                                                // Wait for slaves.
-                                               sleep(2.0);
+                                               sleep( 2.0 );
                                                wfWaitForSlaves( 1.0 );
                                                
                                                echo( "\nSetting image restrictions ... " );
-                                               if ( $article->updateRestrictions($restrictions) )
+                                               if ( $article->updateRestrictions( $restrictions ) )
                                                                echo( "done.\n" );
                                                else
                                                                echo( "failed.\n" );
@@ -259,10 +259,10 @@ if (isset($options['protect']) && $options['protect'] == 1)
                
                # Print out some statistics
                echo( "\n" );
-               foreach( array( 'count' => 'Found', 'limit' => 'Limit', 'ignored' => 'Ignored', 
-                       'added' => 'Added', 'skipped' => 'Skipped', 'overwritten' => 'Overwritten', 
+               foreach ( array( 'count' => 'Found', 'limit' => 'Limit', 'ignored' => 'Ignored',
+                       'added' => 'Added', 'skipped' => 'Skipped', 'overwritten' => 'Overwritten',
                        'failed' => 'Failed' ) as $var => $desc ) {
-                       if( $$var > 0 )
+                       if ( $$var > 0 )
                                echo( "{$desc}: {$$var}\n" );
                }
                
@@ -274,10 +274,10 @@ if (isset($options['protect']) && $options['protect'] == 1)
        showUsage();
 }
 
-exit(0);
+exit( 0 );
 
 function showUsage( $reason = false ) {
-       if( $reason ) {
+       if ( $reason ) {
                echo( $reason . "\n" );
        }
 
@@ -309,5 +309,5 @@ Options:
                     For example, --source-wiki-url="http://en.wikipedia.org/"
 
 TEXT;
-       exit(1);
+       exit( 1 );
 }