X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;ds=sidebyside;f=includes%2FSpecialPage.php;h=419c595125f0340deec49a2115b01a1862016094;hb=f50eab171e0db645483a0c36e0e00a0441fe8561;hp=6f2cc5722acc53c66b47fde4ce52a97cadfda8c6;hpb=2c9cfd7cce6ba9de336cff9f9917385e5901b0c4;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/SpecialPage.php b/includes/SpecialPage.php index 6f2cc5722a..419c595125 100644 --- a/includes/SpecialPage.php +++ b/includes/SpecialPage.php @@ -28,178 +28,38 @@ * @ingroup SpecialPage */ class SpecialPage { - /**#@+ - * @access private - */ - /** - * The canonical name of this special page - * Also used for the default

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(); - /** - * Query parameteres added by redirects - */ - var $mAddedRedirectParams = array(); + + // The canonical name of this special page + // Also used for the default

heading, @see getDescription() + protected $mName; + + // The local name of this special page + private $mLocalName; + + // Minimum user level required to access this page, or "" for anyone. + // Also used to categorise the pages in Special:Specialpages + private $mRestriction; + + // Listed in Special:Specialpages? + private $mListed; + + // Function name called by the default execute() + private $mFunction; + + // File which needs to be included before the function above can be called + private $mFile; + + // Whether or not this special page is being included from an article + protected $mIncluding; + + // Whether the special page can be included in an article + protected $mIncludable; + /** * Current request context - * @var RequestContext + * @var IContextSource */ protected $mContext; - - /** - * List of special page names to the subclass of SpecialPage which handles them. - */ - static public $mList = array( - # Maintenance Reports - 'BrokenRedirects' => 'BrokenRedirectsPage', - 'Deadendpages' => 'DeadendpagesPage', - 'DoubleRedirects' => 'DoubleRedirectsPage', - 'Longpages' => 'LongpagesPage', - 'Ancientpages' => 'AncientpagesPage', - 'Lonelypages' => 'LonelypagesPage', - 'Fewestrevisions' => 'FewestrevisionsPage', - 'Withoutinterwiki' => 'WithoutinterwikiPage', - 'Protectedpages' => 'SpecialProtectedpages', - 'Protectedtitles' => 'SpecialProtectedtitles', - 'Shortpages' => 'ShortpagesPage', - 'Uncategorizedcategories' => 'UncategorizedcategoriesPage', - 'Uncategorizedimages' => 'UncategorizedimagesPage', - 'Uncategorizedpages' => 'UncategorizedpagesPage', - 'Uncategorizedtemplates' => 'UncategorizedtemplatesPage', - 'Unusedcategories' => 'UnusedcategoriesPage', - 'Unusedimages' => 'UnusedimagesPage', - 'Unusedtemplates' => 'UnusedtemplatesPage', - 'Unwatchedpages' => 'UnwatchedpagesPage', - 'Wantedcategories' => 'WantedcategoriesPage', - 'Wantedfiles' => 'WantedfilesPage', - 'Wantedpages' => 'WantedpagesPage', - 'Wantedtemplates' => 'WantedtemplatesPage', - - # List of pages - 'Allpages' => 'SpecialAllpages', - 'Prefixindex' => 'SpecialPrefixindex', - 'Categories' => 'SpecialCategories', - 'Disambiguations' => 'DisambiguationsPage', - 'Listredirects' => 'ListredirectsPage', - - # Login/create account - 'Userlogin' => 'LoginForm', - 'CreateAccount' => 'SpecialCreateAccount', - - # Users and rights - 'Block' => 'SpecialBlock', - 'Unblock' => 'SpecialUnblock', - 'BlockList' => 'SpecialBlockList', - 'Resetpass' => 'SpecialResetpass', - 'DeletedContributions' => 'DeletedContributionsPage', - 'Preferences' => 'SpecialPreferences', - 'Contributions' => 'SpecialContributions', - 'Listgrouprights' => 'SpecialListGroupRights', - 'Listusers' => 'SpecialListUsers' , - 'Listadmins' => 'SpecialListAdmins', - 'Listbots' => 'SpecialListBots', - 'Activeusers' => 'SpecialActiveUsers', - 'Userrights' => 'UserrightsPage', - 'EditWatchlist' => 'SpecialEditWatchlist', - - # Recent changes and logs - 'Newimages' => 'SpecialNewFiles', - 'Log' => 'SpecialLog', - 'Watchlist' => 'SpecialWatchlist', - 'Newpages' => 'SpecialNewpages', - 'Recentchanges' => 'SpecialRecentchanges', - 'Recentchangeslinked' => 'SpecialRecentchangeslinked', - 'Tags' => 'SpecialTags', - - # Media reports and uploads - 'Listfiles' => 'SpecialListFiles', - 'Filepath' => 'SpecialFilepath', - 'MIMEsearch' => 'MIMEsearchPage', - 'FileDuplicateSearch' => 'FileDuplicateSearchPage', - 'Upload' => 'SpecialUpload', - 'UploadStash' => 'SpecialUploadStash', - - # Wiki data and tools - 'Statistics' => 'SpecialStatistics', - 'Allmessages' => 'SpecialAllmessages', - 'Version' => 'SpecialVersion', - 'Lockdb' => 'SpecialLockdb', - 'Unlockdb' => 'SpecialUnlockdb', - - # Redirecting special pages - 'LinkSearch' => 'LinkSearchPage', - 'Randompage' => 'Randompage', - 'Randomredirect' => 'SpecialRandomredirect', - - # High use pages - 'Mostlinkedcategories' => 'MostlinkedCategoriesPage', - 'Mostimages' => 'MostimagesPage', - 'Mostlinked' => 'MostlinkedPage', - 'Mostlinkedtemplates' => 'MostlinkedTemplatesPage', - 'Mostcategories' => 'MostcategoriesPage', - 'Mostrevisions' => 'MostrevisionsPage', - - # Page tools - 'ComparePages' => 'SpecialComparePages', - 'Export' => 'SpecialExport', - 'Import' => 'SpecialImport', - 'Undelete' => 'SpecialUndelete', - 'Whatlinkshere' => 'SpecialWhatlinkshere', - 'MergeHistory' => 'SpecialMergeHistory', - - # Other - 'Booksources' => 'SpecialBookSources', - - # Unlisted / redirects - 'Blankpage' => 'SpecialBlankpage', - 'Blockme' => 'SpecialBlockme', - 'Emailuser' => 'SpecialEmailUser', - 'Movepage' => 'MovePageForm', - 'Mycontributions' => 'SpecialMycontributions', - 'Mypage' => 'SpecialMypage', - 'Mytalk' => 'SpecialMytalk', - 'Myuploads' => 'SpecialMyuploads', - 'PermanentLink' => 'SpecialPermanentLink', - 'Revisiondelete' => 'SpecialRevisionDelete', - 'Specialpages' => 'SpecialSpecialpages', - 'Userlogout' => 'SpecialUserlogout', - ); - - static public $mAliases; - static public $mListInitialised = false; /** * Initialise the special page list @@ -249,7 +109,7 @@ class SpecialPage { * an associative record to $wgSpecialPages. This avoids autoloading SpecialPage. * * @param $page SpecialPage - * @deprecated in 1.7, warnings in 1.17, might be removed in 1.20 + * @deprecated since 1.7, warnings in 1.17, might be removed in 1.20 */ static function addPage( &$page ) { wfDeprecated( __METHOD__ ); @@ -261,6 +121,7 @@ class SpecialPage { * * @param $page Mixed: SpecialPage or string * @param $group String + * @return null * @deprecated since 1.18 call SpecialPageFactory method directly */ static function setGroup( $page, $group ) { @@ -268,9 +129,10 @@ class SpecialPage { } /** - * Add a page to a certain display group for Special:SpecialPages + * Get the group that the special page belongs in on Special:SpecialPage * * @param $page SpecialPage + * @return null * @deprecated since 1.18 call SpecialPageFactory method directly */ static function getGroup( &$page ) { @@ -282,6 +144,8 @@ class SpecialPage { * Formerly used to disable expensive or dangerous special pages. The * preferred method is now to add a SpecialPage_initList hook. * @deprecated since 1.18 + * + * @param $name String the page to remove */ static function removePage( $name ) { unset( SpecialPageFactory::getList()->$name ); @@ -313,6 +177,7 @@ class SpecialPage { * Get a special page with a given localised name, or NULL if there * is no such special page. * + * @param $alias String * @return SpecialPage object or null if the page doesn't exist * @deprecated since 1.18 call SpecialPageFactory method directly */ @@ -324,11 +189,13 @@ class SpecialPage { * Return categorised listable special pages which are available * for the current user, and everyone. * + * @param $user User object to check permissions, $wgUser will be used + * if not provided * @return Associative array mapping page's name to its SpecialPage object * @deprecated since 1.18 call SpecialPageFactory method directly */ - static function getUsablePages() { - return SpecialPageFactory::getUsablePages(); + static function getUsablePages( User $user = null ) { + return SpecialPageFactory::getUsablePages( $user ); } /** @@ -361,26 +228,15 @@ class SpecialPage { * page, and true if it was successful. * * @param $title Title object - * @param $context RequestContext + * @param $context IContextSource * @param $including Bool output is being captured for use in {{special:whatever}} + * @return Bool * @deprecated since 1.18 call SpecialPageFactory method directly */ - public static function executePath( &$title, RequestContext &$context, $including = false ) { + public static function executePath( &$title, IContextSource &$context, $including = false ) { return SpecialPageFactory::executePath( $title, $context, $including ); } - /** - * 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. - * - * @return String: HTML fragment - * @deprecated since 1.18 call SpecialPageFactory method directly - */ - static function capturePath( &$title ) { - return SpecialPageFactory::capturePath( $title ); - } - /** * Get the local name for a specified canonical name * @@ -397,6 +253,8 @@ class SpecialPage { /** * Get a localised Title object for a specified special page name * + * @param $name String + * @param $subpage String|Bool subpage string, or false to not use a subpage * @return Title object */ public static function getTitleFor( $name, $subpage = false ) { @@ -411,6 +269,8 @@ class SpecialPage { /** * Get a localised Title object for a page name with a possibly unvalidated subpage * + * @param $name String + * @param $subpage String|Bool subpage string, or false to not use a subpage * @return Title object or null if the page doesn't exist */ public static function getSafeTitleFor( $name, $subpage = false ) { @@ -425,6 +285,7 @@ class SpecialPage { /** * Get a title for a given alias * + * @param $alias String * @return Title or null if there is no such alias * @deprecated since 1.18 call SpecialPageFactory method directly */ @@ -444,19 +305,27 @@ class SpecialPage { * * @param $name String: name of the special page, as seen in links and URLs * @param $restriction String: user right required, e.g. "block" or "delete" - * @param $listed Boolean: whether the page is listed in Special:Specialpages - * @param $function Callback: function called by execute(). By default it is constructed from $name + * @param $listed Bool: whether the page is listed in Special:Specialpages + * @param $function Callback|Bool: function called by execute(). By default it is constructed from $name * @param $file String: file which is included by execute(). It is also constructed from $name by default - * @param $includable Boolean: whether the page can be included in normal pages + * @param $includable Bool: whether the page can be included in normal pages */ - public function __construct( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) { + public function __construct( + $name = '', $restriction = '', $listed = true, + $function = false, $file = 'default', $includable = false + ) { $this->init( $name, $restriction, $listed, $function, $file, $includable ); } /** * Do the real work for the constructor, mainly so __call() can intercept * calls to SpecialPage() - * @see __construct() for param docs + * @param $name String: name of the special page, as seen in links and URLs + * @param $restriction String: user right required, e.g. "block" or "delete" + * @param $listed Bool: whether the page is listed in Special:Specialpages + * @param $function Callback|Bool: function called by execute(). By default it is constructed from $name + * @param $file String: file which is included by execute(). It is also constructed from $name by default + * @param $includable Bool: whether the page can be included in normal pages */ private function init( $name, $restriction, $listed, $function, $file, $includable ) { $this->mName = $name; @@ -502,33 +371,90 @@ class SpecialPage { } } - /**#@+ - * 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) { - # Use the one below this - wfDeprecated( __METHOD__ ); - return wfSetVar( $this->mRestriction, $x ); + /** + * Get the name of this Special Page. + * @return String + */ + function getName() { + return $this->mName; } + + /** + * Get the permission that a user must have to execute this page + * @return String + */ + function getRestriction() { + return $this->mRestriction; + } + + /** + * Get the file which will be included by SpecialPage::execute() if your extension is + * still stuck in the past and hasn't overridden the execute() method. No modern code + * should want or need to know this. + * @return String + * @deprecated since 1.18 + */ + function getFile() { + return $this->mFile; + } + + // @todo FIXME: Decide which syntax to use for this, and stick to it + /** + * Whether this special page is listed in Special:SpecialPages + * @since r3583 (v1.3) + * @return Bool + */ + function isListed() { + return $this->mListed; + } + /** + * Set whether this page is listed in Special:Specialpages, at run-time + * @since r3583 (v1.3) + * @param $listed Bool + * @return Bool + */ + function setListed( $listed ) { + return wfSetVar( $this->mListed, $listed ); + } + /** + * Get or set whether this special page is listed in Special:SpecialPages + * @since r11308 (v1.6) + * @param $x Bool + * @return Bool + */ + function listed( $x = null) { + return wfSetVar( $this->mListed, $x ); + } + + /** + * Whether it's allowed to transclude the special page via {{Special:Foo/params}} + * @return Bool + */ + public function isIncludable(){ + return $this->mIncludable; + } + + /** + * These mutators are very evil, as the relevant variables should not mutate. So + * don't use them. + * @param $x Mixed + * @return Mixed + * @deprecated since 1.18 + */ + function name( $x = null ) { return wfSetVar( $this->mName, $x ); } function restriction( $x = null) { return wfSetVar( $this->mRestriction, $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 ); } - /**#@-*/ + + /** + * Whether the special page is being evaluated via transclusion + * @param $x Bool + * @return Bool + */ + function including( $x = null ) { + return wfSetVar( $this->mIncluding, $x ); + } /** * Get the localised name of the special page @@ -573,7 +499,7 @@ class SpecialPage { * @param $user User: the user to check * @return Boolean: does the user have permission to view the page? */ - public function userCanExecute( $user ) { + public function userCanExecute( User $user ) { return $user->isAllowed( $this->mRestriction ); } @@ -584,6 +510,29 @@ class SpecialPage { throw new PermissionsError( $this->mRestriction ); } + /** + * Checks if userCanExecute, and if not throws a PermissionsError + * + * @since 1.19 + */ + public function checkPermissions() { + if ( !$this->userCanExecute( $this->getUser() ) ) { + $this->displayRestrictionError(); + } + } + + /** + * If the wiki is currently in readonly mode, throws a ReadOnlyError + * + * @since 1.19 + * @throws ReadOnlyError + */ + public function checkReadOnly() { + if ( wfReadOnly() ) { + throw new ReadOnlyError; + } + } + /** * Sets headers - this should be called from the execute() method of all derived classes! */ @@ -598,22 +547,21 @@ class SpecialPage { * Default execute method * Checks user permissions, calls the function given in mFunction * - * This may be overridden by subclasses. + * This must be overridden by subclasses; it will be made abstract in a future version + * + * @param $par String subpage string, if one was specified */ function execute( $par ) { $this->setHeaders(); + $this->checkPermissions(); - if ( $this->userCanExecute( $this->getUser() ) ) { - $func = $this->mFunction; - // only load file if the function does not exist - if(!is_callable($func) and $this->mFile) { - require_once( $this->mFile ); - } - $this->outputHeader(); - call_user_func( $func, $par, $this ); - } else { - $this->displayRestrictionError(); + $func = $this->mFunction; + // only load file if the function does not exist + if( !is_callable($func) && $this->mFile ) { + require_once( $this->mFile ); } + $this->outputHeader(); + call_user_func( $func, $par, $this ); } /** @@ -628,12 +576,13 @@ class SpecialPage { global $wgContLang; if( $summaryMessageKey == '' ) { - $msg = $wgContLang->lc( $this->name() ) . '-summary'; + $msg = $wgContLang->lc( $this->getName() ) . '-summary'; } else { $msg = $summaryMessageKey; } - if ( !wfMessage( $msg )->isBlank() and ! $this->including() ) { - $this->getOutput()->wrapWikiMsg( "
\n$1\n
", $msg ); + if ( !$this->msg( $msg )->isBlank() && !$this->including() ) { + $this->getOutput()->wrapWikiMsg( + "
\n$1\n
", $msg ); } } @@ -649,65 +598,23 @@ class SpecialPage { * @return String */ function getDescription() { - return wfMsg( strtolower( $this->mName ) ); + return $this->msg( strtolower( $this->mName ) )->text(); } /** * Get a self-referential title object * + * @param $subpage String|Bool * @return Title object */ function getTitle( $subpage = false ) { return self::getTitleFor( $this->mName, $subpage ); } - /** - * Set whether this page is listed in Special:Specialpages, at run-time - * - * @return Bool - */ - 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. - * - * @return Title|false - */ - 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() { - $params = array(); - - foreach( $this->mAllowedRedirectParams as $arg ) { - if( $this->getContext()->request->getVal( $arg, null ) !== null ){ - $params[$arg] = $this->getContext()->request->getVal( $arg ); - } - } - - foreach( $this->mAddedRedirectParams as $arg => $val ) { - $params[$arg] = $val; - } - - return count( $params ) - ? $params - : false; - } - /** * Sets the context this SpecialPage is executed in - * - * @param $context RequestContext + * + * @param $context IContextSource * @since 1.18 */ public function setContext( $context ) { @@ -716,12 +623,12 @@ class SpecialPage { /** * Gets the context this SpecialPage is executed in - * - * @return RequestContext + * + * @return IContextSource * @since 1.18 */ public function getContext() { - if ( $this->mContext instanceof RequestContext ) { + if ( $this->mContext instanceof IContextSource ) { return $this->mContext; } else { wfDebug( __METHOD__ . " called and \$mContext is null. Return RequestContext::getMain(); for sanity\n" ); @@ -750,7 +657,7 @@ class SpecialPage { } /** - * Shortcut to get the skin being used for this instance + * Shortcut to get the User executing this instance * * @return User * @since 1.18 @@ -769,6 +676,27 @@ class SpecialPage { return $this->getContext()->getSkin(); } + /** + * Shortcut to get user's language + * + * @deprecated 1.19 Use getLanguage instead + * @return Language + * @since 1.18 + */ + public function getLang() { + return $this->getLanguage(); + } + + /** + * Shortcut to get user's language + * + * @return Language + * @since 1.19 + */ + public function getLanguage() { + return $this->getContext()->getLanguage(); + } + /** * Return the full title, including $par * @@ -780,13 +708,165 @@ class SpecialPage { } /** - * Wrapper around wfMessage that sets the current context. Currently this - * is only the title. - * + * Wrapper around wfMessage that sets the current context. + * + * @return Message * @see wfMessage */ public function msg( /* $args */ ) { - return call_user_func_array( 'wfMessage', func_get_args() )->title( $this->getFullTitle() ); + // Note: can't use func_get_args() directly as second or later item in + // a parameter list until PHP 5.3 or you get a fatal error. + // Works fine as the first parameter, which appears elsewhere in the + // code base. Sighhhh. + $args = func_get_args(); + return call_user_func_array( array( $this->getContext(), 'msg' ), $args ); + } + + /** + * Adds RSS/atom links + * + * @param $params array + */ + protected function addFeedLinks( $params ) { + global $wgFeedClasses; + + $feedTemplate = wfScript( 'api' ) . '?'; + + foreach( $wgFeedClasses as $format => $class ) { + $theseParams = $params + array( 'feedformat' => $format ); + $url = $feedTemplate . wfArrayToCGI( $theseParams ); + $this->getOutput()->addFeedLink( $format, $url ); + } + } +} + +/** + * Special page which uses an HTMLForm to handle processing. This is mostly a + * clone of FormAction. More special pages should be built this way; maybe this could be + * a new structure for SpecialPages + */ +abstract class FormSpecialPage extends SpecialPage { + + /** + * Get an HTMLForm descriptor array + * @return Array + */ + protected abstract function getFormFields(); + + /** + * Add pre- or post-text to the form + * @return String HTML which will be sent to $form->addPreText() + */ + protected function preText() { return ''; } + protected function postText() { return ''; } + + /** + * Play with the HTMLForm if you need to more substantially + * @param $form HTMLForm + */ + protected function alterForm( HTMLForm $form ) {} + + /** + * Get the HTMLForm to control behaviour + * @return HTMLForm|null + */ + protected function getForm() { + $this->fields = $this->getFormFields(); + + $form = new HTMLForm( $this->fields, $this->getContext() ); + $form->setSubmitCallback( array( $this, 'onSubmit' ) ); + $form->setWrapperLegend( $this->msg( strtolower( $this->getName() ) . '-legend' ) ); + $form->addHeaderText( + $this->msg( strtolower( $this->getName() ) . '-text' )->parseAsBlock() ); + + // Retain query parameters (uselang etc) + $params = array_diff_key( + $this->getRequest()->getQueryValues(), array( 'title' => null ) ); + $form->addHiddenField( 'redirectparams', wfArrayToCGI( $params ) ); + + $form->addPreText( $this->preText() ); + $form->addPostText( $this->postText() ); + $this->alterForm( $form ); + + // Give hooks a chance to alter the form, adding extra fields or text etc + wfRunHooks( "Special{$this->getName()}BeforeFormDisplay", array( &$form ) ); + + return $form; + } + + /** + * Process the form on POST submission. + * @param $data Array + * @return Bool|Array true for success, false for didn't-try, array of errors on failure + */ + public abstract function onSubmit( array $data ); + + /** + * Do something exciting on successful processing of the form, most likely to show a + * confirmation message + */ + public abstract function onSuccess(); + + /** + * Basic SpecialPage workflow: get a form, send it to the user; get some data back, + * + * @param $par String Subpage string if one was specified + */ + public function execute( $par ) { + $this->setParameter( $par ); + $this->setHeaders(); + + // This will throw exceptions if there's a problem + $this->checkExecutePermissions( $this->getUser() ); + + $form = $this->getForm(); + if ( $form->show() ) { + $this->onSuccess(); + } + } + + /** + * Maybe do something interesting with the subpage parameter + * @param $par String + */ + protected function setParameter( $par ){} + + /** + * Called from execute() to check if the given user can perform this action. + * Failures here must throw subclasses of ErrorPageError. + * @param $user User + * @return Bool true + * @throws ErrorPageError + */ + protected function checkExecutePermissions( User $user ) { + $this->checkPermissions(); + + if ( $this->requiresUnblock() && $user->isBlocked() ) { + $block = $user->mBlock; + throw new UserBlockedError( $block ); + } + + if ( $this->requiresWrite() ) { + $this->checkReadOnly(); + } + + return true; + } + + /** + * Whether this action requires the wiki not to be locked + * @return Bool + */ + public function requiresWrite() { + return true; + } + + /** + * Whether this action cannot be executed by a blocked user + * @return Bool + */ + public function requiresUnblock() { + return true; } } @@ -794,32 +874,107 @@ class SpecialPage { * Shortcut to construct a special page which is unlisted by default * @ingroup SpecialPage */ -class UnlistedSpecialPage extends SpecialPage -{ +class UnlistedSpecialPage extends SpecialPage { function __construct( $name, $restriction = '', $function = false, $file = 'default' ) { parent::__construct( $name, $restriction, false, $function, $file ); } + + public function isListed(){ + return false; + } } /** * Shortcut to construct an includable special page * @ingroup SpecialPage */ -class IncludableSpecialPage extends SpecialPage -{ - function __construct( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) { +class IncludableSpecialPage extends SpecialPage { + function __construct( + $name, $restriction = '', $listed = true, $function = false, $file = 'default' + ) { parent::__construct( $name, $restriction, $listed, $function, $file, true ); } + + public function isIncludable(){ + return true; + } } /** * Shortcut to construct a special page alias. * @ingroup SpecialPage */ -abstract class SpecialRedirectToSpecial extends UnlistedSpecialPage { +abstract class RedirectSpecialPage extends UnlistedSpecialPage { + + // Query parameters that can be passed through redirects + protected $mAllowedRedirectParams = array(); + + // Query parameteres added by redirects + protected $mAddedRedirectParams = array(); + + public function execute( $par ){ + $redirect = $this->getRedirect( $par ); + $query = $this->getRedirectQuery(); + // Redirect to a page title with possible query parameters + if ( $redirect instanceof Title ) { + $url = $redirect->getFullUrl( $query ); + $this->getOutput()->redirect( $url ); + wfProfileOut( __METHOD__ ); + return $redirect; + // Redirect to index.php with query parameters + } elseif ( $redirect === true ) { + global $wgScript; + $url = $wgScript . '?' . wfArrayToCGI( $query ); + $this->getOutput()->redirect( $url ); + wfProfileOut( __METHOD__ ); + return $redirect; + } else { + $class = __CLASS__; + throw new MWException( "RedirectSpecialPage $class doesn't redirect!" ); + } + } + + /** + * If the special page is a redirect, then get the Title object it redirects to. + * False otherwise. + * + * @param $par String Subpage string + * @return Title|false + */ + abstract public function getRedirect( $par ); + + /** + * Return part of the request string for a special redirect page + * This allows passing, e.g. action=history to Special:Mypage, etc. + * + * @return String + */ + public function getRedirectQuery() { + $params = array(); + + foreach( $this->mAllowedRedirectParams as $arg ) { + if( $this->getRequest()->getVal( $arg, null ) !== null ){ + $params[$arg] = $this->getRequest()->getVal( $arg ); + } + } + + foreach( $this->mAddedRedirectParams as $arg => $val ) { + $params[$arg] = $val; + } + + return count( $params ) + ? $params + : false; + } +} + +abstract class SpecialRedirectToSpecial extends RedirectSpecialPage { var $redirName, $redirSubpage; - function __construct( $name, $redirName, $redirSubpage = false, $allowedRedirectParams = array(), $addedRedirectParams = array() ) { + function __construct( + $name, $redirName, $redirSubpage = false, + $allowedRedirectParams = array(), $addedRedirectParams = array() + ) { parent::__construct( $name ); $this->redirName = $redirName; $this->redirSubpage = $redirSubpage; @@ -827,36 +982,36 @@ abstract class SpecialRedirectToSpecial extends UnlistedSpecialPage { $this->mAddedRedirectParams = $addedRedirectParams; } - function getRedirect( $subpage ) { + public function getRedirect( $subpage ) { if ( $this->redirSubpage === false ) { - return SpecialPageFactory::getTitleFor( $this->redirName, $subpage ); + return SpecialPage::getTitleFor( $this->redirName, $subpage ); } else { - return SpecialPageFactory::getTitleFor( $this->redirName, $this->redirSubpage ); + return SpecialPage::getTitleFor( $this->redirName, $this->redirSubpage ); } } } /** - * ListAdmins --> ListUsers/admin + * ListAdmins --> ListUsers/sysop */ class SpecialListAdmins extends SpecialRedirectToSpecial { function __construct(){ - parent::__construct( 'ListAdmins', 'ListUsers', 'sysop' ); + parent::__construct( 'Listadmins', 'Listusers', 'sysop' ); } } /** - * ListBots --> ListUsers/admin + * ListBots --> ListUsers/bot */ class SpecialListBots extends SpecialRedirectToSpecial { function __construct(){ - parent::__construct( 'ListAdmins', 'ListUsers', 'bot' ); + parent::__construct( 'Listbots', 'Listusers', 'bot' ); } } /** * CreateAccount --> UserLogin/signup - * FIXME: this (and the rest of the login frontend) needs to die a horrible painful death + * @todo FIXME: This (and the rest of the login frontend) needs to die a horrible painful death */ class SpecialCreateAccount extends SpecialRedirectToSpecial { function __construct(){ @@ -875,19 +1030,20 @@ class SpecialCreateAccount extends SpecialRedirectToSpecial { * Shortcut to construct a special page pointing to current user user's page. * @ingroup SpecialPage */ -class SpecialMypage extends UnlistedSpecialPage { +class SpecialMypage extends RedirectSpecialPage { function __construct() { parent::__construct( 'Mypage' ); $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro', - 'section', 'oldid', 'diff', 'dir' ); + 'section', 'oldid', 'diff', 'dir', + // Options for action=raw; missing ctype can break JS or CSS in some browsers + 'ctype', 'maxage', 'smaxage' ); } function getRedirect( $subpage ) { - global $wgUser; if ( strval( $subpage ) !== '' ) { - return Title::makeTitle( NS_USER, $wgUser->getName() . '/' . $subpage ); + return Title::makeTitle( NS_USER, $this->getUser()->getName() . '/' . $subpage ); } else { - return Title::makeTitle( NS_USER, $wgUser->getName() ); + return Title::makeTitle( NS_USER, $this->getUser()->getName() ); } } } @@ -896,7 +1052,7 @@ class SpecialMypage extends UnlistedSpecialPage { * Shortcut to construct a special page pointing to current user talk page. * @ingroup SpecialPage */ -class SpecialMytalk extends UnlistedSpecialPage { +class SpecialMytalk extends RedirectSpecialPage { function __construct() { parent::__construct( 'Mytalk' ); $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro', @@ -904,11 +1060,10 @@ class SpecialMytalk extends UnlistedSpecialPage { } function getRedirect( $subpage ) { - global $wgUser; if ( strval( $subpage ) !== '' ) { - return Title::makeTitle( NS_USER_TALK, $wgUser->getName() . '/' . $subpage ); + return Title::makeTitle( NS_USER_TALK, $this->getUser()->getName() . '/' . $subpage ); } else { - return Title::makeTitle( NS_USER_TALK, $wgUser->getName() ); + return Title::makeTitle( NS_USER_TALK, $this->getUser()->getName() ); } } } @@ -917,7 +1072,7 @@ class SpecialMytalk extends UnlistedSpecialPage { * Shortcut to construct a special page pointing to current user contributions. * @ingroup SpecialPage */ -class SpecialMycontributions extends UnlistedSpecialPage { +class SpecialMycontributions extends RedirectSpecialPage { function __construct() { parent::__construct( 'Mycontributions' ); $this->mAllowedRedirectParams = array( 'limit', 'namespace', 'tagfilter', @@ -925,30 +1080,28 @@ class SpecialMycontributions extends UnlistedSpecialPage { } function getRedirect( $subpage ) { - global $wgUser; - return SpecialPageFactory::getTitleFor( 'Contributions', $wgUser->getName() ); + return SpecialPage::getTitleFor( 'Contributions', $this->getUser()->getName() ); } } /** * Redirect to Special:Listfiles?user=$wgUser */ -class SpecialMyuploads extends UnlistedSpecialPage { +class SpecialMyuploads extends RedirectSpecialPage { function __construct() { parent::__construct( 'Myuploads' ); $this->mAllowedRedirectParams = array( 'limit' ); } function getRedirect( $subpage ) { - global $wgUser; - return SpecialPageFactory::getTitleFor( 'Listfiles', $wgUser->getName() ); + return SpecialPage::getTitleFor( 'Listfiles', $this->getUser()->getName() ); } } /** * Redirect from Special:PermanentLink/### to index.php?oldid=### */ -class SpecialPermanentLink extends UnlistedSpecialPage { +class SpecialPermanentLink extends RedirectSpecialPage { function __construct() { parent::__construct( 'PermanentLink' ); $this->mAllowedRedirectParams = array(); @@ -956,6 +1109,10 @@ class SpecialPermanentLink extends UnlistedSpecialPage { function getRedirect( $subpage ) { $subpage = intval( $subpage ); + if( $subpage === 0 ) { + # throw an error page when no subpage was given + throw new ErrorPageError( 'nopagetitle', 'nopagetext' ); + } $this->mAddedRedirectParams['oldid'] = $subpage; return true; }