summaryrefslogtreecommitdiff
path: root/includes/SpecialPage.php
blob: c9037ea7876e981caf47ac9975c40d2a0220a359 (plain)
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
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
<?php
/**
 * SpecialPage: handling special pages and lists thereof.
 *
 * To add a special page in an extension, add to $wgSpecialPages either 
 * an object instance or an array containing the name and constructor 
 * parameters. The latter is preferred for performance reasons. 
 *
 * The object instantiated must be either an instance of SpecialPage or a 
 * sub-class thereof. It must have an execute() method, which sends the HTML 
 * for the special page to $wgOut. The parent class has an execute() method 
 * which distributes the call to the historical global functions. Additionally, 
 * execute() also checks if the user has the necessary access privileges 
 * and bails out if not.
 *
 * To add a core special page, use the similar static list in 
 * SpecialPage::$mList. To remove a core static special page at runtime, use
 * a SpecialPage_initList hook.
 *
 * @addtogroup SpecialPage
 */

/**
 * @access private
 */

/**
 * Parent special page class, also static functions for handling the special
 * page list.
 * @addtogroup SpecialPage
 */
class SpecialPage
{
	/**#@+
	 * @access private
	 */
	/**
	 * The canonical name of this special page
	 * Also used for the default <h1> heading, @see getDescription()
	 */
	var $mName;
	/**
	 * The local name of this special page
	 */
	var $mLocalName;
	/**
	 * Minimum user level required to access this page, or "" for anyone.
	 * Also used to categorise the pages in Special:Specialpages
	 */
	var $mRestriction;
	/**
	 * Listed in Special:Specialpages?
	 */
	var $mListed;
	/**
	 * Function name called by the default execute()
	 */
	var $mFunction;
	/**
	 * File which needs to be included before the function above can be called
	 */
	var $mFile;
	/**
	 * Whether or not this special page is being included from an article
	 */
	var $mIncluding;
	/**
	 * Whether the special page can be included in an article
	 */
	var $mIncludable;
	/**
	 * Query parameters that can be passed through redirects
	 */
	var $mAllowedRedirectParams = array();

	static public $mList = array(
		'DoubleRedirects'           => array( 'SpecialPage', 'DoubleRedirects' ),
		'BrokenRedirects'           => array( 'SpecialPage', 'BrokenRedirects' ),
		'Disambiguations'           => array( 'SpecialPage', 'Disambiguations' ),

		'Userlogin'                 => array( 'SpecialPage', 'Userlogin' ),
		'Userlogout'                => array( 'UnlistedSpecialPage', 'Userlogout' ),
		'CreateAccount'             => array( 'SpecialRedirectToSpecial', 'CreateAccount', 'Userlogin', 'signup', array( 'uselang' ) ),
		'Preferences'               => array( 'SpecialPage', 'Preferences' ),
		'Watchlist'                 => array( 'SpecialPage', 'Watchlist' ),

		'Recentchanges'             => array( 'IncludableSpecialPage', 'Recentchanges' ),
		'Upload'                    => array( 'SpecialPage', 'Upload' ),
		'Imagelist'                 => array( 'SpecialPage', 'Imagelist' ),
		'Newimages'                 => array( 'IncludableSpecialPage', 'Newimages' ),
		'Listusers'                 => array( 'SpecialPage', 'Listusers' ),
		'Statistics'                => array( 'SpecialPage', 'Statistics' ),
		'Randompage'                => 'Randompage',
		'Lonelypages'               => array( 'SpecialPage', 'Lonelypages' ),
		'Uncategorizedpages'        => array( 'SpecialPage', 'Uncategorizedpages' ),
		'Uncategorizedcategories'   => array( 'SpecialPage', 'Uncategorizedcategories' ),
		'Uncategorizedimages'       => array( 'SpecialPage', 'Uncategorizedimages' ),
		'Uncategorizedtemplates'    => array( 'SpecialPage', 'Uncategorizedtemplates' ),
		'Unusedcategories'          => array( 'SpecialPage', 'Unusedcategories' ),
		'Unusedimages'              => array( 'SpecialPage', 'Unusedimages' ),
		'Wantedpages'               => array( 'IncludableSpecialPage', 'Wantedpages' ),
		'Wantedcategories'          => array( 'SpecialPage', 'Wantedcategories' ),
		'Mostlinked'                => array( 'SpecialPage', 'Mostlinked' ),
		'Mostlinkedcategories'      => array( 'SpecialPage', 'Mostlinkedcategories' ),
		'Mostlinkedtemplates'       => array( 'SpecialPage', 'Mostlinkedtemplates' ),
		'Mostcategories'            => array( 'SpecialPage', 'Mostcategories' ),
		'Mostimages'                => array( 'SpecialPage', 'Mostimages' ),
		'Mostrevisions'             => array( 'SpecialPage', 'Mostrevisions' ),
		'Fewestrevisions'           => array( 'SpecialPage', 'Fewestrevisions' ),
		'Shortpages'                => array( 'SpecialPage', 'Shortpages' ),
		'Longpages'                 => array( 'SpecialPage', 'Longpages' ),
		'Newpages'                  => array( 'IncludableSpecialPage', 'Newpages' ),
		'Ancientpages'              => array( 'SpecialPage', 'Ancientpages' ),
		'Deadendpages'              => array( 'SpecialPage', 'Deadendpages' ),
		'Protectedpages'            => array( 'SpecialPage', 'Protectedpages' ),
		'Protectedtitles'           => array( 'SpecialPage', 'Protectedtitles' ),
		'Allpages'                  => array( 'IncludableSpecialPage', 'Allpages' ),
		'Prefixindex'               => array( 'IncludableSpecialPage', 'Prefixindex' ) ,
		'Ipblocklist'               => array( 'SpecialPage', 'Ipblocklist' ),
		'Specialpages'              => array( 'UnlistedSpecialPage', 'Specialpages' ),
		'Contributions'             => array( 'SpecialPage', 'Contributions' ),
		'Emailuser'                 => array( 'UnlistedSpecialPage', 'Emailuser' ),
		'Whatlinkshere'             => array( 'SpecialPage', 'Whatlinkshere' ),
		'Recentchangeslinked'       => array( 'UnlistedSpecialPage', 'Recentchangeslinked' ),
		'Movepage'                  => array( 'UnlistedSpecialPage', 'Movepage' ),
		'Blockme'                   => array( 'UnlistedSpecialPage', 'Blockme' ),
		'Resetpass'                 => array( 'UnlistedSpecialPage', 'Resetpass' ),
		'Booksources'               => 'SpecialBookSources',
		'Categories'                => array( 'SpecialPage', 'Categories' ),
		'Export'                    => array( 'SpecialPage', 'Export' ),
		'Version'                   => array( 'SpecialPage', 'Version' ),
		'Allmessages'               => array( 'SpecialPage', 'Allmessages' ),
		'Log'                       => array( 'SpecialPage', 'Log' ),
		'Blockip'                   => array( 'SpecialPage', 'Blockip', 'block' ),
		'Undelete'                  => array( 'SpecialPage', 'Undelete', 'deletedhistory' ),
		'Import'                    => array( 'SpecialPage', 'Import', 'import' ),
		'Lockdb'                    => array( 'SpecialPage', 'Lockdb', 'siteadmin' ),
		'Unlockdb'                  => array( 'SpecialPage', 'Unlockdb', 'siteadmin' ),
		'Userrights'                => 'UserrightsPage',
		'MIMEsearch'                => array( 'SpecialPage', 'MIMEsearch' ),
		'Unwatchedpages'            => array( 'SpecialPage', 'Unwatchedpages', 'unwatchedpages' ),
		'Listredirects'             => array( 'SpecialPage', 'Listredirects' ),
		'Revisiondelete'            => array( 'UnlistedSpecialPage', 'Revisiondelete', 'deleterevision' ),
		'Unusedtemplates'           => array( 'SpecialPage', 'Unusedtemplates' ),
		'Randomredirect'            => 'SpecialRandomredirect',
		'Withoutinterwiki'          => array( 'SpecialPage', 'Withoutinterwiki' ),
		'Filepath'                  => array( 'SpecialPage', 'Filepath' ),

		'Mypage'                    => array( 'SpecialMypage' ),
		'Mytalk'                    => array( 'SpecialMytalk' ),
		'Mycontributions'           => array( 'SpecialMycontributions' ),
		'Listadmins'                => array( 'SpecialRedirectToSpecial', 'Listadmins', 'Listusers', 'sysop' ),
		'MergeHistory'              => array( 'SpecialPage', 'MergeHistory', 'mergehistory' ),
		'Listbots'                  => array( 'SpecialRedirectToSpecial', 'Listbots', 'Listusers', 'bot' ),
		);

	static public $mAliases;
	static public $mListInitialised = false;

	/**#@-*/

	/**
	 * Initialise the special page list
	 * This must be called before accessing SpecialPage::$mList
	 */
	static function initList() {
		global $wgSpecialPages;
		global $wgDisableCounters, $wgDisableInternalSearch, $wgEmailAuthentication;

		if ( self::$mListInitialised ) {
			return;
		}
		wfProfileIn( __METHOD__ );
		
		# Better to set this now, to avoid infinite recursion in carelessly written hooks
		self::$mListInitialised = true;

		if( !$wgDisableCounters ) {
			self::$mList['Popularpages'] = array( 'SpecialPage', 'Popularpages' );
		}

		if( !$wgDisableInternalSearch ) {
			self::$mList['Search'] = array( 'SpecialPage', 'Search' );
		}

		if( $wgEmailAuthentication ) {
			self::$mList['Confirmemail'] = 'EmailConfirmation';
		}

		# Add extension special pages
		self::$mList = array_merge( self::$mList, $wgSpecialPages );

		# Run hooks
		# This hook can be used to remove undesired built-in special pages
		wfRunHooks( 'SpecialPage_initList', array( &self::$mList ) );
		wfProfileOut( __METHOD__ );
	}

	static function initAliasList() {
		if ( !is_null( self::$mAliases ) ) {
			return;
		}

		global $wgContLang;
		$aliases = $wgContLang->getSpecialPageAliases();
		$missingPages = self::$mList;
		self::$mAliases = array();
		foreach ( $aliases as $realName => $aliasList ) {
			foreach ( $aliasList as $alias ) {
				self::$mAliases[$wgContLang->caseFold( $alias )] = $realName;
			}
			unset( $missingPages[$realName] );
		}
		foreach ( $missingPages as $name => $stuff ) {
			self::$mAliases[$wgContLang->caseFold( $name )] = $name;
		}
	}

	/**
	 * Given a special page alias, return the special page name.
	 * Returns false if there is no such alias.
	 */
	static function resolveAlias( $alias ) {
		global $wgContLang;

		if ( !self::$mListInitialised ) self::initList();
		if ( is_null( self::$mAliases ) ) self::initAliasList();
		$caseFoldedAlias = $wgContLang->caseFold( $alias );
		if ( isset( self::$mAliases[$caseFoldedAlias] ) ) {
			return self::$mAliases[$caseFoldedAlias];
		} else {
			return false;
		}
	}

	/**
	 * Given a special page name with a possible subpage, return an array 
	 * where the first element is the special page name and the second is the
	 * subpage.
	 */
	static function resolveAliasWithSubpage( $alias ) {
		$bits = explode( '/', $alias, 2 );
		$name = self::resolveAlias( $bits[0] );
		if( !isset( $bits[1] ) ) { // bug 2087
			$par = NULL;
		} else {
			$par = $bits[1];
		}
		return array( $name, $par );
	}

	/**
	 * Add a page to the list of valid special pages. This used to be the preferred 
	 * method for adding special pages in extensions. It's now suggested that you add 
	 * an associative record to $wgSpecialPages. This avoids autoloading SpecialPage.
	 *
	 * @param mixed $page Must either be an array specifying a class name and 
	 *                    constructor parameters, or an object. The object,
	 *                    when constructed, must have an execute() method which
	 *                    sends HTML to $wgOut.
	 * @static
	 */
	static function addPage( &$page ) {
		if ( !self::$mListInitialised ) {
			self::initList();
		}
		self::$mList[$page->mName] = $page;
	}

	/**
	 * Remove a special page from the list
	 * Formerly used to disable expensive or dangerous special pages. The 
	 * preferred method is now to add a SpecialPage_initList hook.
	 * 
	 * @static
	 */
	static function removePage( $name ) {
		if ( !self::$mListInitialised ) {
			self::initList();
		}
		unset( self::$mList[$name] );
	}

	/**
	 * Check if a given name exist as a special page or as a special page alias
	 * @param $name string: name of a special page
	 * @return boolean: true if a special page exists with this name
	 */
	static function exists( $name ) {
		global $wgContLang;
		if ( !self::$mListInitialised ) {
			self::initList();
		}
		if( !self::$mAliases ) {
			self::initAliasList();
		}

		# Remove special pages inline parameters:
		$bits = explode( '/', $name );
		$name = $wgContLang->caseFold($bits[0]);

		return
			array_key_exists( $name, self::$mList )
			or array_key_exists( $name, self::$mAliases )
		;
	}

	/**
	 * Find the object with a given name and return it (or NULL)
	 * @static
	 * @param string $name
	 */
	static function getPage( $name ) {
		if ( !self::$mListInitialised ) {
			self::initList();
		}
		if ( array_key_exists( $name, self::$mList ) ) {
			$rec = self::$mList[$name];
			if ( is_string( $rec ) ) {
				$className = $rec;
				self::$mList[$name] = new $className;
			} elseif ( is_array( $rec ) ) {
				$className = array_shift( $rec );
				self::$mList[$name] = wfCreateObject( $className, $rec );
			}
			return self::$mList[$name];
		} else {
			return NULL;
		}
	}

	/**
	 * Get a special page with a given localised name, or NULL if there
	 * is no such special page.
	 */
	static function getPageByAlias( $alias ) {
		$realName = self::resolveAlias( $alias );
		if ( $realName ) {
			return self::getPage( $realName );
		} else {
			return NULL;
		}
	}

	/**
	 * Return categorised listable special pages for all users
	 * @static
	 */
	static function getRegularPages() {
		if ( !self::$mListInitialised ) {
			self::initList();
		}
		$pages = array();

		foreach ( self::$mList as $name => $rec ) {
			$page = self::getPage( $name );
			if ( $page->isListed() && !$page->isRestricted() ) {
				$pages[$name] = $page;
			}
		}
		return $pages;
	}

	/**
	 * Return categorised listable special pages which are available
	 * for the current user, but not for everyone
	 * @static
	 */
	static function getRestrictedPages() {
		global $wgUser;
		if ( !self::$mListInitialised ) {
			self::initList();
		}
		$pages = array();

		foreach ( self::$mList as $name => $rec ) {
			$page = self::getPage( $name );
			if (
				$page->isListed()
				and $page->isRestricted()
				and $page->userCanExecute( $wgUser )
			) {
				$pages[$name] = $page;
			}
		}
		return $pages;
	}

	/**
	 * Execute a special page path.
	 * The path	may contain parameters, e.g. Special:Name/Params
	 * Extracts the special page name and call the execute method, passing the parameters
	 *
	 * Returns a title object if the page is redirected, false if there was no such special
	 * page, and true if it was successful.
	 *
	 * @param $title          a title object
	 * @param $including      output is being captured for use in {{special:whatever}}
	 */
	static function executePath( &$title, $including = false ) {
		global $wgOut, $wgTitle, $wgRequest;
		wfProfileIn( __METHOD__ );

		# FIXME: redirects broken due to this call
		$bits = explode( '/', $title->getDBkey(), 2 );
		$name = $bits[0];
		if( !isset( $bits[1] ) ) { // bug 2087
			$par = NULL;
		} else {
			$par = $bits[1];
		}
		$page = SpecialPage::getPageByAlias( $name );
		# Nonexistent?
		if ( !$page ) {
			if ( !$including ) {
				$wgOut->setArticleRelated( false );
				$wgOut->setRobotpolicy( 'noindex,nofollow' );
				$wgOut->setStatusCode( 404 );
				$wgOut->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
			}
			wfProfileOut( __METHOD__ );
			return false;
		}

		# Check for redirect
		if ( !$including ) {
			$redirect = $page->getRedirect( $par );
			if ( $redirect ) {
				$query = $page->getRedirectQuery();
				$url = $redirect->getFullUrl( $query );
				$wgOut->redirect( $url );
				wfProfileOut( __METHOD__ );
				return $redirect;
			}
		}

		# Redirect to canonical alias for GET commands
		# Not for POST, we'd lose the post data, so it's best to just distribute 
		# the request. Such POST requests are possible for old extensions that 
		# generate self-links without being aware that their default name has 
		# changed.
		if ( !$including && $name != $page->getLocalName() && !$wgRequest->wasPosted() ) {
			$query = $_GET;
			unset( $query['title'] );
			$query = wfArrayToCGI( $query );
			$title = $page->getTitle( $par );
			$url = $title->getFullUrl( $query );
			$wgOut->redirect( $url );
			wfProfileOut( __METHOD__ );
			return $redirect;
		}

		if ( $including && !$page->includable() ) {
			wfProfileOut( __METHOD__ );
			return false;
		} elseif ( !$including ) {
			$wgTitle = $page->getTitle();
		}
		$page->including( $including );

		// Execute special page
		$profName = 'Special:' . $page->getName();
		wfProfileIn( $profName );
		$page->execute( $par );
		wfProfileOut( $profName );
		wfProfileOut( __METHOD__ );
		return true;
	}

	/**
	 * Just like executePath() except it returns the HTML instead of outputting it
	 * Returns false if there was no such special page, or a title object if it was
	 * a redirect.
	 * @static
	 */
	static function capturePath( &$title ) {
		global $wgOut, $wgTitle;

		$oldTitle = $wgTitle;
		$oldOut = $wgOut;
		$wgOut = new OutputPage;

		$ret = SpecialPage::executePath( $title, true );
		if ( $ret === true ) {
			$ret = $wgOut->getHTML();
		}
		$wgTitle = $oldTitle;
		$wgOut = $oldOut;
		return $ret;
	}

	/**
	 * Get the local name for a specified canonical name
	 *
	 * @param $name
	 * @param mixed $subpage Boolean false, or string
	 *
	 * @return string
	 */
	static function getLocalNameFor( $name, $subpage = false ) {
		global $wgContLang;
		$aliases = $wgContLang->getSpecialPageAliases();
		if ( isset( $aliases[$name][0] ) ) {
			$name = $aliases[$name][0];
		}
		if ( $subpage !== false && !is_null( $subpage ) ) {
			$name = "$name/$subpage";
		}
		return $name;
	}

	/**
	 * Get a localised Title object for a specified special page name
	 */
	static function getTitleFor( $name, $subpage = false ) {
		$name = self::getLocalNameFor( $name, $subpage );
		if ( $name ) {
			return Title::makeTitle( NS_SPECIAL, $name );
		} else {
			throw new MWException( "Invalid special page name \"$name\"" );
		}
	}

	/**
	 * Get a localised Title object for a page name with a possibly unvalidated subpage
	 */
	static function getSafeTitleFor( $name, $subpage = false ) {
		$name = self::getLocalNameFor( $name, $subpage );
		if ( $name ) {
			return Title::makeTitleSafe( NS_SPECIAL, $name );
		} else {
			return null;
		}
	}

	/**
	 * Get a title for a given alias
	 * @return Title or null if there is no such alias
	 */
	static function getTitleForAlias( $alias ) {
		$name = self::resolveAlias( $alias );
		if ( $name ) {
			return self::getTitleFor( $name );
		} else {
			return null;
		}
	}

	/**
	 * Default constructor for special pages
	 * Derivative classes should call this from their constructor
	 *     Note that if the user does not have the required level, an error message will
	 *     be displayed by the default execute() method, without the global function ever
	 *     being called.
	 *
	 *     If you override execute(), you can recover the default behaviour with userCanExecute()
	 *     and displayRestrictionError()
	 *
	 * @param string $name Name of the special page, as seen in links and URLs
	 * @param string $restriction User right required, e.g. "block" or "delete"
	 * @param boolean $listed Whether the page is listed in Special:Specialpages
	 * @param string $function Function called by execute(). By default it is constructed from $name
	 * @param string $file File which is included by execute(). It is also constructed from $name by default
	 */
	function SpecialPage( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
		$this->mName = $name;
		$this->mRestriction = $restriction;
		$this->mListed = $listed;
		$this->mIncludable = $includable;
		if ( $function == false ) {
			$this->mFunction = 'wfSpecial'.$name;
		} else {
			$this->mFunction = $function;
		}
		if ( $file === 'default' ) {
			$this->mFile = dirname(__FILE__) . "/Special{$name}.php";
		} else {
			$this->mFile = $file;
		}
	}

	/**#@+
	  * Accessor
	  *
	  * @deprecated
	  */
	function getName() { return $this->mName; }
	function getRestriction() { return $this->mRestriction; }
	function getFile() { return $this->mFile; }
	function isListed() { return $this->mListed; }
	/**#@-*/

	/**#@+
	  * Accessor and mutator
	  */
	function name( $x = NULL ) { return wfSetVar( $this->mName, $x ); }
	function restrictions( $x = NULL) { return wfSetVar( $this->mRestrictions, $x ); }
	function listed( $x = NULL) { return wfSetVar( $this->mListed, $x ); }
	function func( $x = NULL) { return wfSetVar( $this->mFunction, $x ); }
	function file( $x = NULL) { return wfSetVar( $this->mFile, $x ); }
	function includable( $x = NULL ) { return wfSetVar( $this->mIncludable, $x ); }
	function including( $x = NULL ) { return wfSetVar( $this->mIncluding, $x ); }
	/**#@-*/

	/**
	 * Get the localised name of the special page
	 */
	function getLocalName() {
		if ( !isset( $this->mLocalName ) ) {
			$this->mLocalName = self::getLocalNameFor( $this->mName );
		}
		return $this->mLocalName;
	}

	/**
	 * Can be overridden by subclasses with more complicated permissions
	 * schemes.
	 *
	 * @return bool Should the page be displayed with the restricted-access
	 *   pages?
	 */
	public function isRestricted() {
		return $this->mRestriction != '';
	}

	/**
	 * Checks if the given user (identified by an object) can execute this
	 * special page (as defined by $mRestriction).  Can be overridden by sub-
	 * classes with more complicated permissions schemes.
	 *
	 * @param User $user The user to check
	 * @return bool Does the user have permission to view the page?
	 */
	public function userCanExecute( $user ) {
		return $user->isAllowed( $this->mRestriction );
	}

	/**
	 * Output an error message telling the user what access level they have to have
	 */
	function displayRestrictionError() {
		global $wgOut;
		$wgOut->permissionRequired( $this->mRestriction );
	}

	/**
	 * Sets headers - this should be called from the execute() method of all derived classes!
	 */
	function setHeaders() {
		global $wgOut;
		$wgOut->setArticleRelated( false );
		$wgOut->setRobotPolicy( "noindex,nofollow" );
		$wgOut->setPageTitle( $this->getDescription() );
	}

	/**
	 * Default execute method
	 * Checks user permissions, calls the function given in mFunction
	 *
	 * This may be overridden by subclasses. 
	 */
	function execute( $par ) {
		global $wgUser;

		$this->setHeaders();

		if ( $this->userCanExecute( $wgUser ) ) {
			$func = $this->mFunction;
			// only load file if the function does not exist
			if(!is_callable($func) and $this->mFile) {
				require_once( $this->mFile );
			}
			# FIXME: these hooks are broken for extensions and anything else that subclasses SpecialPage. 
			if ( wfRunHooks( 'SpecialPageExecuteBeforeHeader', array( &$this, &$par, &$func ) ) )
				$this->outputHeader();
			if ( ! wfRunHooks( 'SpecialPageExecuteBeforePage', array( &$this, &$par, &$func ) ) )
				return;
			call_user_func( $func, $par, $this );
			if ( ! wfRunHooks( 'SpecialPageExecuteAfterPage', array( &$this, &$par, &$func ) ) )
				return;
		} else {
			$this->displayRestrictionError();
		}
	}

	function outputHeader() {
		global $wgOut, $wgContLang;

		$msg = $wgContLang->lc( $this->name() ) . '-summary';
		$out = wfMsgNoTrans( $msg );
		if ( ! wfEmptyMsg( $msg, $out ) and  $out !== '' and ! $this->including() ) {
			$wgOut->addWikiText( $out );
		}

	}

	# Returns the name that goes in the <h1> in the special page itself, and also the name that
	# will be listed in Special:Specialpages
	#
	# Derived classes can override this, but usually it is easier to keep the default behaviour.
	# Messages can be added at run-time, see MessageCache.php
	function getDescription() {
		return wfMsg( strtolower( $this->mName ) );
	}

	/**
	 * Get a self-referential title object
	 */
	function getTitle( $subpage = false) {
		return self::getTitleFor( $this->mName, $subpage );
	}

	/**
	 * Set whether this page is listed in Special:Specialpages, at run-time
	 */
	function setListed( $listed ) {
		return wfSetVar( $this->mListed, $listed );
	}

	/**
	 * If the special page is a redirect, then get the Title object it redirects to. 
	 * False otherwise.
	 */
	function getRedirect( $subpage ) {
		return false;
	}

	/**
	 * Return part of the request string for a special redirect page
	 * This allows passing, e.g. action=history to Special:Mypage, etc.
	 *
	 * @return string
	 */
	function getRedirectQuery() {
		global $wgRequest;
		$params = array();
		foreach( $this->mAllowedRedirectParams as $arg ) {
			if( $val = $wgRequest->getVal( $arg, false ) )
				$params[] = $arg . '=' . $val;
		}
		
		return count( $params ) ? implode( '&', $params ) : false;
	}
}

/**
 * Shortcut to construct a special page which is unlisted by default
 * @addtogroup SpecialPage
 */
class UnlistedSpecialPage extends SpecialPage
{
	function UnlistedSpecialPage( $name, $restriction = '', $function = false, $file = 'default' ) {
		SpecialPage::SpecialPage( $name, $restriction, false, $function, $file );
	}
}

/**
 * Shortcut to construct an includable special  page
 * @addtogroup SpecialPage
 */
class IncludableSpecialPage extends SpecialPage
{
	function IncludableSpecialPage( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) {
		SpecialPage::SpecialPage( $name, $restriction, $listed, $function, $file, true );
	}
}

/**
 * Shortcut to construct a special page alias.
 * @addtogroup SpecialPage
 */
class SpecialRedirectToSpecial extends UnlistedSpecialPage {
	var $redirName, $redirSubpage;

	function __construct( $name, $redirName, $redirSubpage = false, $redirectParams = array() ) {
		parent::__construct( $name );
		$this->redirName = $redirName;
		$this->redirSubpage = $redirSubpage;
		$this->mAllowedRedirectParams = $redirectParams;
	}

	function getRedirect( $subpage ) {
		if ( $this->redirSubpage === false ) {
			return SpecialPage::getTitleFor( $this->redirName, $subpage );
		} else {
			return SpecialPage::getTitleFor( $this->redirName, $this->redirSubpage );
		}
	}
}

/** SpecialMypage, SpecialMytalk and SpecialMycontributions special pages
 * are used to get user independant links pointing to the user page, talk
 * page and list of contributions.
 * This can let us cache a single copy of any generated content for all
 * users.
 */

/**
 * Shortcut to construct a special page pointing to current user user's page.
 * @addtogroup SpecialPage
 */
class SpecialMypage extends UnlistedSpecialPage {
	function __construct() {
		parent::__construct( 'Mypage' );
		$this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro', 'section' );
	}

	function getRedirect( $subpage ) {
		global $wgUser;
		if ( strval( $subpage ) !== '' ) {
			return Title::makeTitle( NS_USER, $wgUser->getName() . '/' . $subpage );
		} else {
			return Title::makeTitle( NS_USER, $wgUser->getName() );
		}
	}
}

/**
 * Shortcut to construct a special page pointing to current user talk page.
 * @addtogroup SpecialPage
 */
class SpecialMytalk extends UnlistedSpecialPage {
	function __construct() {
		parent::__construct( 'Mytalk' );
		$this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro', 'section' );
	}

	function getRedirect( $subpage ) {
		global $wgUser;
		if ( strval( $subpage ) !== '' ) {
			return Title::makeTitle( NS_USER_TALK, $wgUser->getName() . '/' . $subpage );
		} else {
			return Title::makeTitle( NS_USER_TALK, $wgUser->getName() );
		}
	}
}

/**
 * Shortcut to construct a special page pointing to current user contributions.
 * @addtogroup SpecialPage
 */
class SpecialMycontributions extends UnlistedSpecialPage {
	function __construct() {
		parent::__construct(  'Mycontributions' );
	}

	function getRedirect( $subpage ) {
		global $wgUser;
		return SpecialPage::getTitleFor( 'Contributions', $wgUser->getName() );
	}
}