Followup r92081: SQL fix for cleanupUploadStash.php on PostgreSQL (bug 32822)

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

diff --git a/maintenance/generateSitemap.php b/maintenance/generateSitemap.php
index 4f2ecba..80d31f9 100644 (file)
--- a/maintenance/generateSitemap.php
+++ b/maintenance/generateSitemap.php
@@ -121,6 +121,13 @@ class GenerateSitemap extends Maintenance {
         */
        var $file;
 
+       /**
+        * Identifier to use in filenames, default $wgDBname
+        *
+        * @var string
+        */
+       private $identifier;
+
        /**
         * Constructor
         */
@@ -130,6 +137,7 @@ class GenerateSitemap extends Maintenance {
                $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( 'identifier', 'What site identifier to use for the wiki, defaults to $wgDBname', false, true );
        }
 
        /**
@@ -144,15 +152,18 @@ class GenerateSitemap extends Maintenance {
                if ( $this->urlpath !== "" && substr( $this->urlpath, -1 ) !== '/' ) {
                        $this->urlpath .= '/';
                }
+               $this->identifier = $this->getOption( 'identifier', wfWikiID() );
                $this->compress = $this->getOption( 'compress', 'yes' ) !== 'no';
                $this->dbr = wfGetDB( DB_SLAVE );
                $this->generateNamespaces();
                $this->timestamp = wfTimestamp( TS_ISO_8601, wfTimestampNow() );
-               $this->findex = fopen( "{$this->fspath}sitemap-index-" . wfWikiID() . ".xml", 'wb' );
+               $this->findex = fopen( "{$this->fspath}sitemap-index-{$this->identifier}.xml", 'wb' );
                $this->main();
        }
 
        private function setNamespacePriorities() {
+               global $wgSitemapNamespacesPriorities;
+
                // Custom main namespaces
                $this->priorities[self::GS_MAIN] = '0.5';
                // Custom talk namesspaces
@@ -174,10 +185,28 @@ class GenerateSitemap extends Maintenance {
                $this->priorities[NS_HELP_TALK] = '0.1';
                $this->priorities[NS_CATEGORY] = '0.5';
                $this->priorities[NS_CATEGORY_TALK] = '0.1';
+
+               // Custom priorities
+               if ( $wgSitemapNamespacesPriorities !== false ) {
+                       /**
+                        * @var $wgSitemapNamespacesPriorities array
+                        */
+                       foreach ( $wgSitemapNamespacesPriorities as $namespace => $priority ) {
+                               $float = floatval( $priority );
+                               if ( $float > 1.0 ) {
+                                       $priority = '1.0';
+                               } elseif ( $float < 0.0 ) {
+                                       $priority = '0.0';
+                               }
+                               $this->priorities[$namespace] = $priority;
+                       }
+               }
        }
 
        /**
         * Create directory if it does not exist and return pathname with a trailing slash
+        * @param $fspath string
+        * @return null|string
         */
        private static function init_path( $fspath ) {
                if ( !isset( $fspath ) ) {
@@ -185,7 +214,7 @@ class GenerateSitemap extends Maintenance {
                }
                # Create directory if needed
                if ( $fspath && !is_dir( $fspath ) ) {
-                       wfMkdirParents( $fspath ) or die( "Can not create directory $fspath.\n" );
+                       wfMkdirParents( $fspath, null, __METHOD__ ) or die( "Can not create directory $fspath.\n" );
                }
 
                return realpath( $fspath ) . DIRECTORY_SEPARATOR ;
@@ -289,7 +318,7 @@ class GenerateSitemap extends Maintenance {
                                }
                                $title = Title::makeTitle( $row->page_namespace, $row->page_title );
                                $date = wfTimestamp( TS_ISO_8601, $row->page_touched );
-                               $entry = $this->fileEntry( $title->getFullURL(), $date, $this->priority( $namespace ) );
+                               $entry = $this->fileEntry( $title->getCanonicalURL(), $date, $this->priority( $namespace ) );
                                $length += strlen( $entry );
                                $this->write( $this->file, $entry );
                                // generate pages for language variants
@@ -297,7 +326,7 @@ class GenerateSitemap extends Maintenance {
                                        $variants = $wgContLang->getVariants();
                                        foreach ( $variants as $vCode ) {
                                                if ( $vCode == $wgContLang->getCode() ) continue; // we don't want default variant
-                                               $entry = $this->fileEntry( $title->getFullURL( '', $vCode ), $date, $this->priority( $namespace ) );
+                                               $entry = $this->fileEntry( $title->getCanonicalURL( '', $vCode ), $date, $this->priority( $namespace ) );
                                                $length += strlen( $entry );
                                                $this->write( $this->file, $entry );
                                        }
@@ -318,13 +347,20 @@ class GenerateSitemap extends Maintenance {
         * @return Resource
         */
        function open( $file, $flags ) {
-               return $this->compress ? gzopen( $file, $flags ) : fopen( $file, $flags );
+               $resource = $this->compress ? gzopen( $file, $flags ) : fopen( $file, $flags );
+               if( $resource === false ) {
+                       wfDebugDieBacktrace( __METHOD__ . " error opening file $file with flags $flags. Check permissions?" );
+               }
+               return $resource;
        }
 
        /**
         * gzwrite() / fwrite() wrapper
         */
        function write( &$handle, $str ) {
+               if( $handle === true || $handle === false ) {
+                       wfDebugDieBacktrace( __METHOD__ . " was passed a boolean as a file handle.\n" );
+               }
                if ( $this->compress )
                        gzwrite( $handle, $str );
                else
@@ -350,7 +386,7 @@ class GenerateSitemap extends Maintenance {
         */
        function sitemapFilename( $namespace, $count ) {
                $ext = $this->compress ? '.gz' : '';
-               return "sitemap-" . wfWikiID() . "-NS_$namespace-$count.xml$ext";
+               return "sitemap-{$this->identifier}-NS_$namespace-$count.xml$ext";
        }
 
        /**
@@ -447,7 +483,7 @@ class GenerateSitemap extends Maintenance {
 
                $this->limit = array(
                        strlen( $this->openFile() ),
-                       strlen( $this->fileEntry( $title->getFullUrl(), wfTimestamp( TS_ISO_8601, wfTimestamp() ), $this->priority( $namespace ) ) ),
+                       strlen( $this->fileEntry( $title->getCanonicalURL(), wfTimestamp( TS_ISO_8601, wfTimestamp() ), $this->priority( $namespace ) ) ),
                        strlen( $this->closeFile() )
                );
        }