X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=maintenance%2FgenerateSitemap.php;h=b31eebd22604ed8d66e8a35b13d75aeea22fcb35;hb=b547246366dd0f8aa85bb638125819c776a943ab;hp=52dc33ae51bae1a96b05bd1a3cc43c6eac811031;hpb=413e7f9d4cb1fb7fbff618e29d0fc126987c8d99;p=lhc%2Fweb%2Fwiklou.git diff --git a/maintenance/generateSitemap.php b/maintenance/generateSitemap.php index 52dc33ae51..b31eebd226 100644 --- a/maintenance/generateSitemap.php +++ b/maintenance/generateSitemap.php @@ -1,22 +1,37 @@ and + * Brion Vibber + * + * 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. * - * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason - * @copyright Copyright © 2005, Jens Frank - * @copyright Copyright © 2005, Brion Vibber + * 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 + * + * @file + * @ingroup Maintenance * @see http://www.sitemaps.org/ * @see http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd - * - * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later */ -class GenerateSitemap { +require_once( dirname( __FILE__ ) . '/Maintenance.php' ); + +class GenerateSitemap extends Maintenance { + const GS_MAIN = -2; + const GS_TALK = -1; + /** * The maximum amount of urls in a sitemap file * @@ -43,11 +58,11 @@ class GenerateSitemap { var $fspath; /** - * The path to append to the domain name + * The URL path to prepend to filenames in the index; should resolve to the same directory as $fspath * * @var string */ - var $path; + var $urlpath; /** * Whether or not to use compression @@ -68,29 +83,7 @@ class GenerateSitemap { * * @var array */ - var $priorities = array( - // Custom main namespaces - GS_MAIN => '0.5', - // Custom talk namesspaces - GS_TALK => '0.1', - // MediaWiki standard namespaces - NS_MAIN => '1.0', - NS_TALK => '0.1', - NS_USER => '0.5', - NS_USER_TALK => '0.1', - NS_PROJECT => '0.5', - NS_PROJECT_TALK => '0.1', - NS_FILE => '0.5', - NS_FILE_TALK => '0.1', - NS_MEDIAWIKI => '0.0', - NS_MEDIAWIKI_TALK => '0.1', - NS_TEMPLATE => '0.0', - NS_TEMPLATE_TALK => '0.1', - NS_HELP => '0.5', - NS_HELP_TALK => '0.1', - NS_CATEGORY => '0.5', - NS_CATEGORY_TALK => '0.1', - ); + var $priorities = array(); /** * A one-dimensional array of namespaces in the wiki @@ -129,62 +122,106 @@ class GenerateSitemap { var $file; /** - * A resource pointing to php://stderr + * Identifier to use in filenames, default $wgDBname * - * @var resource + * @var string */ - var $stderr; + private $identifier; /** * Constructor - * - * @param string $fspath The path to prepend to the filenames, used to - * save them somewhere else than in the root directory - * @param string $path The path to append to the domain name - * @param bool $compress Whether to compress the sitemap files */ - function GenerateSitemap( $fspath, $compress ) { - global $wgScriptPath; + 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( 'identifier', 'What site identifier to use for the wiki, defaults to $wgDBname', false, true ); + } + /** + * Execute + */ + public function execute() { + $this->setNamespacePriorities(); $this->url_limit = 50000; $this->size_limit = pow( 2, 20 ) * 10; - $this->fspath = self::init_path( $fspath ); - - $this->compress = $compress; - - $this->stderr = fopen( 'php://stderr', 'wt' ); + $this->fspath = self::init_path( $this->getOption( 'fspath', getcwd() ) ); + $this->urlpath = $this->getOption( 'urlpath', "" ); + 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-{$this->identifier}.xml", 'wb' ); + $this->main(); + } + private function setNamespacePriorities() { + global $wgSitemapNamespacesPriorities; - $this->findex = fopen( "{$this->fspath}sitemap-index-" . wfWikiID() . ".xml", 'wb' ); + // Custom main namespaces + $this->priorities[self::GS_MAIN] = '0.5'; + // Custom talk namesspaces + $this->priorities[self::GS_TALK] = '0.1'; + // MediaWiki standard namespaces + $this->priorities[NS_MAIN] = '1.0'; + $this->priorities[NS_TALK] = '0.1'; + $this->priorities[NS_USER] = '0.5'; + $this->priorities[NS_USER_TALK] = '0.1'; + $this->priorities[NS_PROJECT] = '0.5'; + $this->priorities[NS_PROJECT_TALK] = '0.1'; + $this->priorities[NS_FILE] = '0.5'; + $this->priorities[NS_FILE_TALK] = '0.1'; + $this->priorities[NS_MEDIAWIKI] = '0.0'; + $this->priorities[NS_MEDIAWIKI_TALK] = '0.1'; + $this->priorities[NS_TEMPLATE] = '0.0'; + $this->priorities[NS_TEMPLATE_TALK] = '0.1'; + $this->priorities[NS_HELP] = '0.5'; + $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 ) { + 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 */ private static function init_path( $fspath ) { - if( !isset( $fspath ) ) { + if ( !isset( $fspath ) ) { return null; } # Create directory if needed - if( $fspath && !is_dir( $fspath ) ) { - mkdir( $fspath, 0755 ) or die("Can not create directory $fspath.\n"); + if ( $fspath && !is_dir( $fspath ) ) { + wfMkdirParents( $fspath, null, __METHOD__ ) or die( "Can not create directory $fspath.\n" ); } - return realpath( $fspath ). DIRECTORY_SEPARATOR ; + return realpath( $fspath ) . DIRECTORY_SEPARATOR ; } /** * Generate a one-dimensional array of existing namespaces */ function generateNamespaces() { - $fname = 'GenerateSitemap::generateNamespaces'; - // Only generate for specific namespaces if $wgSitemapNamespaces is an array. global $wgSitemapNamespaces; - if( is_array( $wgSitemapNamespaces ) ) { + if ( is_array( $wgSitemapNamespaces ) ) { $this->namespaces = $wgSitemapNamespaces; return; } @@ -192,25 +229,23 @@ class GenerateSitemap { $res = $this->dbr->select( 'page', array( 'page_namespace' ), array(), - $fname, + __METHOD__, array( 'GROUP BY' => 'page_namespace', 'ORDER BY' => 'page_namespace', ) ); - while ( $row = $this->dbr->fetchObject( $res ) ) + foreach ( $res as $row ) $this->namespaces[] = $row->page_namespace; } /** * Get the priority of a given namespace * - * @param int $namespace The namespace to get the priority for - + - * @return string + * @param $namespace Integer: the namespace to get the priority for + * @return String */ - function priority( $namespace ) { return isset( $this->priorities[$namespace] ) ? $this->priorities[$namespace] : $this->guessPriority( $namespace ); } @@ -220,24 +255,20 @@ class GenerateSitemap { * default priority for the namespace, varies depending on whether it's * a talkpage or not. * - * @param int $namespace The namespace to get the priority for - * - * @return string + * @param $namespace Integer: the namespace to get the priority for + * @return String */ function guessPriority( $namespace ) { - return MWNamespace::isMain( $namespace ) ? $this->priorities[GS_MAIN] : $this->priorities[GS_TALK]; + return MWNamespace::isMain( $namespace ) ? $this->priorities[self::GS_MAIN] : $this->priorities[self::GS_TALK]; } /** * Return a database resolution of all the pages in a given namespace * - * @param int $namespace Limit the query to this namespace - * - * @return resource + * @param $namespace Integer: limit the query to this namespace + * @return Resource */ function getPageRes( $namespace ) { - $fname = 'GenerateSitemap::getPageRes'; - return $this->dbr->select( 'page', array( 'page_namespace', @@ -245,16 +276,14 @@ class GenerateSitemap { 'page_touched', ), array( 'page_namespace' => $namespace ), - $fname + __METHOD__ ); } /** * Main loop - * - * @access public */ - function main() { + public function main() { global $wgContLang; fwrite( $this->findex, $this->openIndex() ); @@ -267,8 +296,8 @@ class GenerateSitemap { $i = $smcount = 0; $fns = $wgContLang->getFormattedNsText( $namespace ); - $this->debug( "$namespace ($fns)" ); - while ( $row = $this->dbr->fetchObject( $res ) ) { + $this->output( "$namespace ($fns)\n" ); + foreach ( $res as $row ) { 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() ); @@ -278,21 +307,21 @@ class GenerateSitemap { $this->file = $this->open( $this->fspath . $filename, 'wb' ); $this->write( $this->file, $this->openFile() ); fwrite( $this->findex, $this->indexEntry( $filename ) ); - $this->debug( "\t$this->fspath$filename" ); + $this->output( "\t$this->fspath$filename\n" ); $length = $this->limit[0]; $i = 1; } $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 - if($wgContLang->hasVariants()){ + if ( $wgContLang->hasVariants() ) { $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 ) ); + foreach ( $variants as $vCode ) { + if ( $vCode == $wgContLang->getCode() ) continue; // we don't want default variant + $entry = $this->fileEntry( $title->getCanonicalURL( '', $vCode ), $date, $this->priority( $namespace ) ); $length += strlen( $entry ); $this->write( $this->file, $entry ); } @@ -310,7 +339,7 @@ class GenerateSitemap { /** * gzopen() / fopen() wrapper * - * @return resource + * @return Resource */ function open( $file, $flags ) { return $this->compress ? gzopen( $file, $flags ) : fopen( $file, $flags ); @@ -339,23 +368,18 @@ class GenerateSitemap { /** * Get a sitemap filename * - * @static - * - * @param int $namespace The namespace - * @param int $count The count - * - * @return string + * @param $namespace Integer: the namespace + * @param $count Integer: the count + * @return String */ 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"; } /** * Return the XML required to open an XML file * - * @static - * * @return string */ function xmlHead() { @@ -365,9 +389,7 @@ class GenerateSitemap { /** * Return the XML schema being used * - * @static - * - * @returns string + * @return String */ function xmlSchema() { return 'http://www.sitemaps.org/schemas/sitemap/0.9'; @@ -376,7 +398,7 @@ class GenerateSitemap { /** * Return the XML required to open a sitemap index file * - * @return string + * @return String */ function openIndex() { return $this->xmlHead() . '' . "\n"; @@ -385,16 +407,13 @@ class GenerateSitemap { /** * Return the XML for a single sitemap indexfile entry * - * @static - * - * @param string $filename The filename of the sitemap file - * - * @return string + * @param $filename String: the filename of the sitemap file + * @return String */ function indexEntry( $filename ) { return "\t\n" . - "\t\t$filename\n" . + "\t\t{$this->urlpath}$filename\n" . "\t\t{$this->timestamp}\n" . "\t\n"; } @@ -402,9 +421,7 @@ class GenerateSitemap { /** * Return the XML required to close a sitemap index file * - * @static - * - * @return string + * @return String */ function closeIndex() { return "\n"; @@ -413,7 +430,7 @@ class GenerateSitemap { /** * Return the XML required to open a sitemap file * - * @return string + * @return String */ function openFile() { return $this->xmlHead() . '' . "\n"; @@ -422,13 +439,10 @@ class GenerateSitemap { /** * Return the XML for a single sitemap entry * - * @static - * - * @param string $url An RFC 2396 compliant URL - * @param string $date A ISO 8601 date - * @param string $priority A priority indicator, 0.0 - 1.0 inclusive with a 0.1 stepsize - * - * @return string + * @param $url String: an RFC 2396 compliant URL + * @param $date String: a ISO 8601 date + * @param $priority String: a priority indicator, 0.0 - 1.0 inclusive with a 0.1 stepsize + * @return String */ function fileEntry( $url, $date, $priority ) { return @@ -442,58 +456,26 @@ class GenerateSitemap { /** * Return the XML required to close sitemap file * - * @static - * @return string + * @return String */ function closeFile() { return "\n"; } - /** - * Write a string to stderr followed by a UNIX newline - */ - function debug( $str ) { - fwrite( $this->stderr, "$str\n" ); - } - /** * Populate $this->limit */ function generateLimit( $namespace ) { + // bug 17961: make a title with the longest possible URL in this namespace $title = Title::makeTitle( $namespace, str_repeat( "\xf0\xa8\xae\x81", 63 ) . "\xe5\x96\x83" ); $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() ) ); } } -if ( in_array( '--help', $argv ) ) { - echo << The file system path to save to, e.g /tmp/sitemap - - --server= The protocol and server name to use in URLs, e.g. - http://en.wikipedia.org. This is sometimes necessary because - server name detection may fail in command line scripts. - - --compress=[yes|no] compress the sitemap files, default yes - -EOT; - die( -1 ); -} - -$optionsWithArgs = array( 'fspath', 'server', 'compress' ); -require_once( dirname( __FILE__ ) . '/commandLine.inc' ); - -if ( isset( $options['server'] ) ) { - $wgServer = $options['server']; -} - -$gs = new GenerateSitemap( @$options['fspath'], @$options['compress'] !== 'no' ); -$gs->main(); - +$maintClass = "GenerateSitemap"; +require_once( RUN_MAINTENANCE_IF_MAIN );