Merge "Move HTMLForm-specific styles out of mediawiki.legacy.shared"

[lhc/web/wiklou.git] / maintenance / generateSitemap.php

diff --git a/maintenance/generateSitemap.php b/maintenance/generateSitemap.php
index 959cc8f..12711ea 100644 (file)
--- a/maintenance/generateSitemap.php
+++ b/maintenance/generateSitemap.php
@@ -63,7 +63,8 @@ class GenerateSitemap extends Maintenance {
        public $fspath;
 
        /**
-        * The URL path to prepend to filenames in the index; should resolve to the same directory as $fspath
+        * The URL path to prepend to filenames in the index;
+        * should resolve to the same directory as $fspath.
         *
         * @var string
         */
@@ -145,11 +146,32 @@ class GenerateSitemap extends Maintenance {
        public function __construct() {
                parent::__construct();
                $this->mDescription = "Creates a sitemap for the site";
-               $this->addOption( 'fspath', 'The file system path to save to, e.g. /tmp/sitemap; defaults to current directory', false, true );
-               $this->addOption( 'urlpath', 'The URL path corresponding to --fspath, prepended to filenames in the index; defaults to an empty string', false, true );
-               $this->addOption( 'compress', 'Compress the sitemap files, can take value yes|no, default yes', false, true );
+               $this->addOption(
+                       'fspath',
+                       'The file system path to save to, e.g. /tmp/sitemap; defaults to current directory',
+                       false,
+                       true
+               );
+               $this->addOption(
+                       'urlpath',
+                       'The URL path corresponding to --fspath, prepended to filenames in the index; '
+                               . 'defaults to an empty string',
+                       false,
+                       true
+               );
+               $this->addOption(
+                       'compress',
+                       'Compress the sitemap files, can take value yes|no, default yes',
+                       false,
+                       true
+               );
                $this->addOption( 'skip-redirects', 'Do not include redirecting articles in the sitemap' );
-               $this->addOption( 'identifier', 'What site identifier to use for the wiki, defaults to $wgDBname', false, true );
+               $this->addOption(
+                       'identifier',
+                       'What site identifier to use for the wiki, defaults to $wgDBname',
+                       false,
+                       true
+               );
        }
 
        /**
@@ -159,7 +181,14 @@ class GenerateSitemap extends Maintenance {
                $this->setNamespacePriorities();
                $this->url_limit = 50000;
                $this->size_limit = pow( 2, 20 ) * 10;
-               $this->fspath = self::init_path( $this->getOption( 'fspath', getcwd() ) );
+
+               # Create directory if needed
+               $fspath = $this->getOption( 'fspath', getcwd() );
+               if ( !wfMkdirParents( $fspath, null, __METHOD__ ) ) {
+                       $this->error( "Can not create directory $fspath.", 1 );
+               }
+
+               $this->fspath = realpath( $fspath ) . DIRECTORY_SEPARATOR;
                $this->urlpath = $this->getOption( 'urlpath', "" );
                if ( $this->urlpath !== "" && substr( $this->urlpath, -1 ) !== '/' ) {
                        $this->urlpath .= '/';
@@ -216,23 +245,6 @@ class GenerateSitemap extends Maintenance {
                }
        }
 
-       /**
-        * Create directory if it does not exist and return pathname with a trailing slash
-        * @param string $fspath
-        * @return null|string
-        */
-       private static function init_path( $fspath ) {
-               if ( !isset( $fspath ) ) {
-                       return null;
-               }
-               # Create directory if needed
-               if ( $fspath && !is_dir( $fspath ) ) {
-                       wfMkdirParents( $fspath, null, __METHOD__ ) or die( "Can not create directory $fspath.\n" );
-               }
-
-               return realpath( $fspath ) . DIRECTORY_SEPARATOR;
-       }
-
        /**
         * Generate a one-dimensional array of existing namespaces
         */
@@ -241,6 +253,7 @@ class GenerateSitemap extends Maintenance {
                global $wgSitemapNamespaces;
                if ( is_array( $wgSitemapNamespaces ) ) {
                        $this->namespaces = $wgSitemapNamespaces;
+
                        return;
                }
 
@@ -266,7 +279,9 @@ class GenerateSitemap extends Maintenance {
         * @return string
         */
        function priority( $namespace ) {
-               return isset( $this->priorities[$namespace] ) ? $this->priorities[$namespace] : $this->guessPriority( $namespace );
+               return isset( $this->priorities[$namespace] )
+                       ? $this->priorities[$namespace]
+                       : $this->guessPriority( $namespace );
        }
 
        /**
@@ -278,7 +293,9 @@ class GenerateSitemap extends Maintenance {
         * @return string
         */
        function guessPriority( $namespace ) {
-               return MWNamespace::isSubject( $namespace ) ? $this->priorities[self::GS_MAIN] : $this->priorities[self::GS_TALK];
+               return MWNamespace::isSubject( $namespace )
+                       ? $this->priorities[self::GS_MAIN]
+                       : $this->priorities[self::GS_TALK];
        }
 
        /**
@@ -317,14 +334,17 @@ class GenerateSitemap extends Maintenance {
 
                        $fns = $wgContLang->getFormattedNsText( $namespace );
                        $this->output( "$namespace ($fns)\n" );
-                       $skippedRedirects = 0;  // Number of redirects skipped for that namespace
+                       $skippedRedirects = 0; // Number of redirects skipped for that namespace
                        foreach ( $res as $row ) {
                                if ( $this->skipRedirects && $row->page_is_redirect ) {
                                        $skippedRedirects++;
                                        continue;
                                }
 
-                               if ( $i++ === 0 || $i === $this->url_limit + 1 || $length + $this->limit[1] + $this->limit[2] > $this->size_limit ) {
+                               if ( $i++ === 0
+                                       || $i === $this->url_limit + 1
+                                       || $length + $this->limit[1] + $this->limit[2] > $this->size_limit
+                               ) {
                                        if ( $this->file !== false ) {
                                                $this->write( $this->file, $this->closeFile() );
                                                $this->close( $this->file );
@@ -349,7 +369,11 @@ class GenerateSitemap extends Maintenance {
                                                if ( $vCode == $wgContLang->getCode() ) {
                                                        continue; // we don't want default variant
                                                }
-                                               $entry = $this->fileEntry( $title->getCanonicalURL( '', $vCode ), $date, $this->priority( $namespace ) );
+                                               $entry = $this->fileEntry(
+                                                       $title->getCanonicalURL( '', $vCode ),
+                                                       $date,
+                                                       $this->priority( $namespace )
+                                               );
                                                $length += strlen( $entry );
                                                $this->write( $this->file, $entry );
                                        }
@@ -379,8 +403,10 @@ class GenerateSitemap extends Maintenance {
        function open( $file, $flags ) {
                $resource = $this->compress ? gzopen( $file, $flags ) : fopen( $file, $flags );
                if ( $resource === false ) {
-                       throw new MWException( __METHOD__ . " error opening file $file with flags $flags. Check permissions?" );
+                       throw new MWException( __METHOD__
+                               . " error opening file $file with flags $flags. Check permissions?" );
                }
+
                return $resource;
        }
 
@@ -423,6 +449,7 @@ class GenerateSitemap extends Maintenance {
         */
        function sitemapFilename( $namespace, $count ) {
                $ext = $this->compress ? '.gz' : '';
+
                return "sitemap-{$this->identifier}-NS_$namespace-$count.xml$ext";
        }
 
@@ -523,7 +550,11 @@ class GenerateSitemap extends Maintenance {
 
                $this->limit = array(
                        strlen( $this->openFile() ),
-                       strlen( $this->fileEntry( $title->getCanonicalURL(), wfTimestamp( TS_ISO_8601, wfTimestamp() ), $this->priority( $namespace ) ) ),
+                       strlen( $this->fileEntry(
+                               $title->getCanonicalURL(),
+                               wfTimestamp( TS_ISO_8601, wfTimestamp() ),
+                               $this->priority( $namespace )
+                       ) ),
                        strlen( $this->closeFile() )
                );
        }