Updated link to official distribution
[lhc/web/wiklou.git] / maintenance / dumpUploads.php
index 50d03ae..726153f 100644 (file)
@@ -1,33 +1,55 @@
 <?php
+/**
+ * Dump a the list of files uploaded, for feeding to tar or similar
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @ingroup Maintenance
+ */
 
-require_once 'commandLine.inc';
+require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
-class UploadDumper {
-       function __construct( $args ) {
-               global $IP, $wgUseSharedUploads;
+class UploadDumper extends Maintenance {
+       public function __construct() {
+               parent::__construct();
+               $this->mDescription = "Generates list of uploaded files which can be fed to tar or similar.
+By default, outputs relative paths against the parent directory of \$wgUploadDirectory.";
+               $this->addOption( 'base', 'Set base relative path instead of wiki include root', false, true );
+               $this->addOption( 'local', 'List all local files, used or not. No shared files included' );
+               $this->addOption( 'used', 'Skip local images that are not used' );
+               $this->addOption( 'shared', 'Include images used from shared repository' );
+       }
+
+       public function execute() {
+               global $IP;
                $this->mAction = 'fetchLocal';
-               $this->mBasePath = $IP;
+               $this->mBasePath = $this->getOption( 'base', $IP );
                $this->mShared = false;
                $this->mSharedSupplement = false;
-               
-               if( isset( $args['help'] ) ) {
-                       $this->mAction = 'help';
-               }
-               
-               if( isset( $args['base'] ) ) {
-                       $this->mBasePath = $args['base'];
-               }
-               
-               if( isset( $args['local'] ) ) {
+
+               if ( $this->hasOption( 'local' ) ) {
                        $this->mAction = 'fetchLocal';
                }
                
-               if( isset( $args['used'] ) ) {
+               if ( $this->hasOption( 'used' ) ) {
                        $this->mAction = 'fetchUsed';
                }
                
-               if( isset( $args['shared'] ) ) {
-                       if( isset( $args['used'] ) ) {
+               if ( $this->hasOption( 'shared' ) ) {
+                       if ( $this->hasOption( 'used' ) ) {
                                // Include shared-repo files in the used check
                                $this->mShared = true;
                        } else {
@@ -35,39 +57,16 @@ class UploadDumper {
                                $this->mSharedSupplement = true;
                        }
                }
-       }
-       
-       function run() {
-               $this->{$this->mAction}( $this->mShared );
-               if( $this->mSharedSupplement ) {
+               $this-> { $this->mAction } ( $this->mShared );
+               if ( $this->mSharedSupplement ) {
                        $this->fetchUsed( true );
                }
        }
-       
-       function help() {
-               echo <<<END
-Generates list of uploaded files which can be fed to tar or similar.
-By default, outputs relative paths against the parent directory of
-\$wgUploadDirectory.
-
-Usage:
-php dumpUploads.php [options] > list-o-files.txt
 
-Options:
---base=<path>  Set base relative path instead of wiki include root
-
---local        List all local files, used or not. No shared files included.
---used         Skip local images that are not used
---shared       Include images used from shared repository
-
-END;
-       }
-       
        /**
-        * Fetch a list of all or used images from a particular image source.
-        * @param string $table
-        * @param string $directory Base directory where files are located
-        * @param bool $shared true to pass shared-dir settings to hash func
+        * Fetch a list of used images from a particular image source.
+        *
+        * @param $shared Boolean: true to pass shared-dir settings to hash func
         */
        function fetchUsed( $shared ) {
                $dbr = wfGetDB( DB_SLAVE );
@@ -80,12 +79,16 @@ END;
                        ON il_to=img_name";
                $result = $dbr->query( $sql );
                
-               foreach( $result as $row ) {
+               foreach ( $result as $row ) {
                        $this->outputItem( $row->il_to, $shared );
                }
-               $dbr->freeResult( $result );
        }
-       
+
+       /**
+        * Fetch a list of all images from a particular image source.
+        *
+        * @param $shared Boolean: true to pass shared-dir settings to hash func
+        */
        function fetchLocal( $shared ) {
                $dbr = wfGetDB( DB_SLAVE );
                $result = $dbr->select( 'image',
@@ -93,28 +96,26 @@ END;
                        '',
                        __METHOD__ );
                
-               foreach( $result as $row ) {
+               foreach ( $result as $row ) {
                        $this->outputItem( $row->img_name, $shared );
                }
-               $dbr->freeResult( $result );
        }
        
        function outputItem( $name, $shared ) {
                $file = wfFindFile( $name );
-               if( $file && $this->filterItem( $file, $shared ) ) {
+               if ( $file && $this->filterItem( $file, $shared ) ) {
                        $filename = $file->getFullPath();
                        $rel = wfRelativePath( $filename, $this->mBasePath );
-                       echo "$rel\n";
+                       $this->output( "$rel\n" );
                } else {
                        wfDebug( __METHOD__ . ": base file? $name\n" );
                }
        }
-       
+
        function filterItem( $file, $shared ) {
                return $shared || $file->isLocal();
        }
 }
 
-$dumper = new UploadDumper( $options );
-$dumper->run();
-
+$maintClass = "UploadDumper";
+require_once( DO_MAINTENANCE );