<?php
/**
- * Creates a Google sitemap for the site
+ * Creates a sitemap for the site
*
- * @package MediaWiki
- * @subpackage Maintenance
+ * Copyright © 2005, Ævar Arnfjörð Bjarmason, Jens Frank <jeluf@gmx.de> and
+ * Brion Vibber <brion@pobox.com>
*
- * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason
- * @copyright Copyright © 2005, Jens Frank <jeluf@gmx.de>
- * @copyright Copyright © 2005, Brion Vibber <brion@pobox.com>
+ * 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.
*
- * @link https://www.google.com/webmasters/sitemaps/docs/en/about.html
- * @link http://www.google.com/schemas/sitemap/0.84/sitemap.xsd
+ * 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.
*
- * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
+ * 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
*/
-$optionsWithArgs = array( 'host', 'path' );
-/* */
-require_once 'commandLine.inc';
+require_once( dirname( __FILE__ ) . '/Maintenance.php' );
-if ( ! isset( $options['host'] ) ) {
- echo "Usage: php generateSitemap.php --host=hostname [--path=/pa/th/]\n";
- exit(1);
-} else {
- $_SERVER['HOSTNAME'] = $options['host'];
-}
+class GenerateSitemap extends Maintenance {
+ const GS_MAIN = -2;
+ const GS_TALK = -1;
-$gs = new GenerateSitemap( $options['host'], $options['path'] );
-$gs->main();
+ /**
+ * The maximum amount of urls in a sitemap file
+ *
+ * @link http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd
+ *
+ * @var int
+ */
+ var $url_limit;
-class GenerateSitemap {
- var $host;
- var $cutoff = 9000;
- var $priorities = array(
- // Custom main namespaces
- -2 => '0.5',
- // Custom talk namesspaces
- -1 => '0.1',
- 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_IMAGE => '0.5',
- NS_IMAGE_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',
- );
+ /**
+ * The maximum size of a sitemap file
+ *
+ * @link http://www.sitemaps.org/faq.php#faq_sitemap_size
+ *
+ * @var int
+ */
+ var $size_limit;
+
+ /**
+ * The path to prepend to the filename
+ *
+ * @var string
+ */
+ var $fspath;
+
+ /**
+ * The URL path to prepend to filenames in the index; should resolve to the same directory as $fspath
+ *
+ * @var string
+ */
+ var $urlpath;
+
+ /**
+ * Whether or not to use compression
+ *
+ * @var bool
+ */
+ var $compress;
+
+ /**
+ * Whether or not to include redirection pages
+ *
+ * @var bool
+ */
+ var $skipRedirects;
+
+ /**
+ * The number of entries to save in each sitemap file
+ *
+ * @var array
+ */
+ var $limit = array();
+
+ /**
+ * Key => value entries of namespaces and their priorities
+ *
+ * @var array
+ */
+ var $priorities = array();
+
+ /**
+ * A one-dimensional array of namespaces in the wiki
+ *
+ * @var array
+ */
var $namespaces = array();
+
+ /**
+ * When this sitemap batch was generated
+ *
+ * @var string
+ */
+ var $timestamp;
+
+ /**
+ * A database slave object
+ *
+ * @var object
+ */
var $dbr;
- var $path, $file, $findex;
- var $stderr;
-
- function GenerateSitemap( $host, $path ) {
- global $wgDBname;
-
- $this->path = isset( $path ) ? $path : '';
- $this->stderr = fopen( 'php://stderr', 'wt' );
-
- $this->host = $host;
- $this->dbr =& wfGetDB( DB_SLAVE );
+
+ /**
+ * A resource pointing to the sitemap index file
+ *
+ * @var resource
+ */
+ var $findex;
+
+
+ /**
+ * A resource pointing to a sitemap file
+ *
+ * @var resource
+ */
+ var $file;
+
+ /**
+ * Identifier to use in filenames, default $wgDBname
+ *
+ * @var string
+ */
+ private $identifier;
+
+ /**
+ * Constructor
+ */
+ 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( '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 );
+ }
+
+ /**
+ * Execute
+ */
+ public function execute() {
+ $this->setNamespacePriorities();
+ $this->url_limit = 50000;
+ $this->size_limit = pow( 2, 20 ) * 10;
+ $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->skipRedirects = $this->getOption( 'skip-redirects', false ) !== false ;
+ $this->dbr = wfGetDB( DB_SLAVE );
$this->generateNamespaces();
- $this->findex = fopen( "{$this->path}sitemap-index-$wgDBname.xml", 'wb' );
+ $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;
+
+ // 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 ) {
+ /**
+ * @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 ) ) {
+ 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
+ */
function generateNamespaces() {
- $fname = 'GenerateSitemap::generateNamespaces';
-
+ // Only generate for specific namespaces if $wgSitemapNamespaces is an array.
+ global $wgSitemapNamespaces;
+ if ( is_array( $wgSitemapNamespaces ) ) {
+ $this->namespaces = $wgSitemapNamespaces;
+ return;
+ }
+
$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 $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 );
}
+ /**
+ * If the namespace isn't listed on the priority list return the
+ * default priority for the namespace, varies depending on whether it's
+ * a talkpage or not.
+ *
+ * @param $namespace Integer: the namespace to get the priority for
+ * @return String
+ */
function guessPriority( $namespace ) {
- return Namespace::isMain( $namespace ) ? $this->priorities[-2] : $this->priorities[-1];
+ return MWNamespace::isSubject( $namespace ) ? $this->priorities[self::GS_MAIN] : $this->priorities[self::GS_TALK];
}
+ /**
+ * Return a database resolution of all the pages in a given namespace
+ *
+ * @param $namespace Integer: limit the query to this namespace
+ * @return Resource
+ */
function getPageRes( $namespace ) {
- $fname = 'GenerateSitemap::getPageRes';
-
return $this->dbr->select( 'page',
- array(
+ array(
'page_namespace',
'page_title',
- 'page_is_redirect',
'page_touched',
+ 'page_is_redirect'
),
array( 'page_namespace' => $namespace ),
- $fname
+ __METHOD__
);
}
- function main() {
- global $wgDBname;
+ /**
+ * Main loop
+ */
+ public function main() {
+ global $wgContLang;
fwrite( $this->findex, $this->openIndex() );
-
+
foreach ( $this->namespaces as $namespace ) {
$res = $this->getPageRes( $namespace );
$this->file = false;
+ $this->generateLimit( $namespace );
+ $length = $this->limit[0];
$i = $smcount = 0;
-
- $this->debug( $namespace );
- while ( $row = $this->dbr->fetchObject( $res ) ) {
- if ( $i % $this->cutoff == 0 ) {
+
+ $fns = $wgContLang->getFormattedNsText( $namespace );
+ $this->output( "$namespace ($fns)\n" );
+ $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 ( $this->file !== false ) {
- gzwrite( $this->file, $this->closeFile() );
- gzclose( $this->file );
+ $this->write( $this->file, $this->closeFile() );
+ $this->close( $this->file );
}
- $filename = "{$this->path}sitemap-$wgDBname-NS_$namespace-$smcount.xml.gz";
- ++$smcount;
- $this->file = gzopen( $filename, 'wb' );
- gzwrite( $this->file, $this->openFile() );
+ $filename = $this->sitemapFilename( $namespace, $smcount++ );
+ $this->file = $this->open( $this->fspath . $filename, 'wb' );
+ $this->write( $this->file, $this->openFile() );
fwrite( $this->findex, $this->indexEntry( $filename ) );
- $this->debug( "\t$filename" );
+ $this->output( "\t$this->fspath$filename\n" );
+ $length = $this->limit[0];
+ $i = 1;
}
- ++$i;
$title = Title::makeTitle( $row->page_namespace, $row->page_title );
- $date = $this->ISO8601( $row->page_touched );
- gzwrite( $this->file, $this->fileEntry( $title->getFullURL(), $date, $this->priority( $namespace ) ) );
+ $date = wfTimestamp( TS_ISO_8601, $row->page_touched );
+ $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() ) {
+ $variants = $wgContLang->getVariants();
+ 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 );
+ }
+ }
+ }
+
+ if ($this->skipRedirects && $skippedRedirects > 0) {
+ $this->output( " skipped $skippedRedirects redirect(s)\n" );
}
+
if ( $this->file ) {
- gzwrite( $this->file, $this->closeFile() );
- gzclose( $this->file );
+ $this->write( $this->file, $this->closeFile() );
+ $this->close( $this->file );
}
}
fwrite( $this->findex, $this->closeIndex() );
fclose( $this->findex );
}
+ /**
+ * gzopen() / fopen() wrapper
+ *
+ * @return Resource
+ */
+ function open( $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
+ fwrite( $handle, $str );
+ }
+
+ /**
+ * gzclose() / fclose() wrapper
+ */
+ function close( &$handle ) {
+ if ( $this->compress )
+ gzclose( $handle );
+ else
+ fclose( $handle );
+ }
+
+ /**
+ * Get a sitemap filename
+ *
+ * @param $namespace Integer: the namespace
+ * @param $count Integer: the count
+ * @return String
+ */
+ function sitemapFilename( $namespace, $count ) {
+ $ext = $this->compress ? '.gz' : '';
+ return "sitemap-{$this->identifier}-NS_$namespace-$count.xml$ext";
+ }
+
+ /**
+ * Return the XML required to open an XML file
+ *
+ * @return string
+ */
function xmlHead() {
return '<?xml version="1.0" encoding="UTF-8"?>' . "\n";
}
+ /**
+ * Return the XML schema being used
+ *
+ * @return String
+ */
function xmlSchema() {
- return 'http://www.google.com/schemas/sitemap/0.84';
+ return 'http://www.sitemaps.org/schemas/sitemap/0.9';
}
+ /**
+ * Return the XML required to open a sitemap index file
+ *
+ * @return String
+ */
function openIndex() {
return $this->xmlHead() . '<sitemapindex xmlns="' . $this->xmlSchema() . '">' . "\n";
}
+ /**
+ * Return the XML for a single sitemap indexfile entry
+ *
+ * @param $filename String: the filename of the sitemap file
+ * @return String
+ */
function indexEntry( $filename ) {
- global $wgServer;
-
return
"\t<sitemap>\n" .
- "\t\t<loc>$wgServer/$filename</log>\n" .
+ "\t\t<loc>{$this->urlpath}$filename</loc>\n" .
+ "\t\t<lastmod>{$this->timestamp}</lastmod>\n" .
"\t</sitemap>\n";
}
+ /**
+ * Return the XML required to close a sitemap index file
+ *
+ * @return String
+ */
function closeIndex() {
return "</sitemapindex>\n";
}
-
+
+ /**
+ * Return the XML required to open a sitemap file
+ *
+ * @return String
+ */
function openFile() {
return $this->xmlHead() . '<urlset xmlns="' . $this->xmlSchema() . '">' . "\n";
}
-
+
+ /**
+ * Return the XML for a single sitemap entry
+ *
+ * @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
"\t<url>\n" .
"\t</url>\n";
}
+ /**
+ * Return the XML required to close sitemap file
+ *
+ * @return String
+ */
function closeFile() {
return "</urlset>\n";
}
-
- function ISO8601( $timestamp ) {
- return substr( wfTimestamp( TS_DB, $timestamp ), 0, 4 + 1 + 2 + 1 + 2 );
- }
- 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->getCanonicalURL(), wfTimestamp( TS_ISO_8601, wfTimestamp() ), $this->priority( $namespace ) ) ),
+ strlen( $this->closeFile() )
+ );
}
}
-?>
+$maintClass = "GenerateSitemap";
+require_once( RUN_MAINTENANCE_IF_MAIN );
dépôts / lhc / web / wiklou.git / blobdiff