1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
|
<?php
/**
* Creates a sitemap for the site.
*
* Copyright © 2005, Ævar Arnfjörð Bjarmason, Jens Frank <jeluf@gmx.de> and
* 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.
*
* 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
*/
require_once( __DIR__ . '/Maintenance.php' );
/**
* Maintenance script that generates a sitemap for the site.
*
* @ingroup Maintenance
*/
class GenerateSitemap extends Maintenance {
const GS_MAIN = -2;
const GS_TALK = -1;
/**
* 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;
/**
* 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;
/**
* 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->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() {
// 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(),
__METHOD__,
array(
'GROUP BY' => 'page_namespace',
'ORDER BY' => 'page_namespace',
)
);
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 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 ) {
return $this->dbr->select( 'page',
array(
'page_namespace',
'page_title',
'page_touched',
'page_is_redirect'
),
array( 'page_namespace' => $namespace ),
__METHOD__
);
}
/**
* 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;
$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 ) {
$this->write( $this->file, $this->closeFile() );
$this->close( $this->file );
}
$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->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->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 ) {
$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.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 ) {
return
"\t<sitemap>\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\t<loc>$url</loc>\n" .
"\t\t<lastmod>$date</lastmod>\n" .
"\t\t<priority>$priority</priority>\n" .
"\t</url>\n";
}
/**
* Return the XML required to close sitemap file
*
* @return String
*/
function closeFile() {
return "</urlset>\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 );
|