X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FTitle.php;h=38cc32790fe7982ee4e9412005d6f4c6efbdcf2f;hb=dfd6988313d7033c8294d4b1ce7d9e92604501dc;hp=24e121264c1e80e10e181d85b5c851cbf4155690;hpb=10ecfeb03b223b22db1966c2967f2a405aa59723;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/Title.php b/includes/Title.php index 24e121264c..38cc32790f 100644 --- a/includes/Title.php +++ b/includes/Title.php @@ -41,7 +41,7 @@ class Title { const CACHE_MAX = 1000; /** - * Used to be GAID_FOR_UPDATE define. Used with getArticleId() and friends + * Used to be GAID_FOR_UPDATE define. Used with getArticleID() and friends * to use the master DB */ const GAID_FOR_UPDATE = 1; @@ -72,7 +72,7 @@ class Title { var $mCascadeSources; ///< Where are the cascading restrictions coming from on this page? var $mRestrictionsLoaded = false; ///< Boolean for initialisation on demand var $mPrefixedText; ///< Text form including namespace/interwiki, initialised on demand - var $mTitleProtection; ///< Cached value of getTitleProtection + var $mTitleProtection; ///< Cached value for getTitleProtection (create protection) # Don't change the following default, NS_MAIN is hardcoded in several # places. See bug 696. var $mDefaultNamespace = NS_MAIN; // /< Namespace index when there is no namespace @@ -94,10 +94,10 @@ class Title { /** * Create a new Title from a prefixed DB key * - * @param $key \type{\string} The database key, which has underscores + * @param $key String the database key, which has underscores * instead of spaces, possibly including namespace and * interwiki prefixes - * @return \type{Title} the new object, or NULL on an error + * @return Title, or NULL on an error */ public static function newFromDBkey( $key ) { $t = new Title(); @@ -113,13 +113,13 @@ class Title { * Create a new Title from text, such as what one would find in a link. De- * codes any HTML entities in the text. * - * @param $text string The link text; spaces, prefixes, and an + * @param $text String the link text; spaces, prefixes, and an * initial ':' indicating the main namespace are accepted. - * @param $defaultNamespace int The namespace to use if none is speci- + * @param $defaultNamespace Int the namespace to use if none is speci- * fied by a prefix. If you want to force a specific namespace even if * $text might begin with a namespace prefix, use makeTitle() or * makeTitleSafe(). - * @return Title The new object, or null on an error. + * @return Title, or null on an error. */ public static function newFromText( $text, $defaultNamespace = NS_MAIN ) { if ( is_object( $text ) ) { @@ -138,9 +138,7 @@ class Title { return Title::$titleCache[$text]; } - /** - * Convert things like é ā or 〗 into normalized (bug 14952) text - */ + # Convert things like é ā or 〗 into normalized (bug 14952) text $filteredText = Sanitizer::decodeCharReferencesAndNormalize( $text ); $t = new Title(); @@ -177,8 +175,8 @@ class Title { * Create a new Title from URL-encoded text. Ensures that * the given title's length does not exceed the maximum. * - * @param $url \type{\string} the title, as might be taken from a URL - * @return \type{Title} the new object, or NULL on an error + * @param $url String the title, as might be taken from a URL + * @return Title the new object, or NULL on an error */ public static function newFromURL( $url ) { global $wgLegalTitleChars; @@ -202,9 +200,9 @@ class Title { /** * Create a new Title from an article ID * - * @param $id \type{\int} the page_id corresponding to the Title to create - * @param $flags \type{\int} use Title::GAID_FOR_UPDATE to use master - * @return \type{Title} the new object, or NULL on an error + * @param $id Int the page_id corresponding to the Title to create + * @param $flags Int use Title::GAID_FOR_UPDATE to use master + * @return Title the new object, or NULL on an error */ public static function newFromID( $id, $flags = 0 ) { $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); @@ -220,8 +218,8 @@ class Title { /** * Make an array of titles from an array of IDs * - * @param $ids \type{\arrayof{\int}} Array of IDs - * @return \type{\arrayof{Title}} Array of Titles + * @param $ids Array of Int Array of IDs + * @return Array of Titles */ public static function newFromIDs( $ids ) { if ( !count( $ids ) ) { @@ -249,8 +247,8 @@ class Title { /** * Make a Title object from a DB row * - * @param $row \type{Row} (needs at least page_title,page_namespace) - * @return \type{Title} corresponding Title + * @param $row Object database row (needs at least page_title,page_namespace) + * @return Title corresponding Title */ public static function newFromRow( $row ) { $t = self::makeTitle( $row->page_namespace, $row->page_title ); @@ -270,11 +268,11 @@ class Title { * For convenience, spaces are converted to underscores so that * eg user_text fields can be used directly. * - * @param $ns \type{\int} the namespace of the article - * @param $title \type{\string} the unprefixed database key form - * @param $fragment \type{\string} The link fragment (after the "#") - * @param $interwiki \type{\string} The interwiki prefix - * @return \type{Title} the new object + * @param $ns Int the namespace of the article + * @param $title String the unprefixed database key form + * @param $fragment String the link fragment (after the "#") + * @param $interwiki String the interwiki prefix + * @return Title the new object */ public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) { $t = new Title(); @@ -293,11 +291,11 @@ class Title { * The parameters will be checked for validity, which is a bit slower * than makeTitle() but safer for user-provided data. * - * @param $ns \type{\int} the namespace of the article - * @param $title \type{\string} the database key form - * @param $fragment \type{\string} The link fragment (after the "#") - * @param $interwiki \type{\string} The interwiki prefix - * @return \type{Title} the new object, or NULL on an error + * @param $ns Int the namespace of the article + * @param $title String database key form + * @param $fragment String the link fragment (after the "#") + * @param $interwiki String interwiki prefix + * @return Title the new object, or NULL on an error */ public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) { $t = new Title(); @@ -312,7 +310,7 @@ class Title { /** * Create a new Title for the Main Page * - * @return \type{Title} the new object + * @return Title the new object */ public static function newMainPage() { $title = Title::newFromText( wfMsgForContent( 'mainpage' ) ); @@ -329,8 +327,8 @@ class Title { * This will only return the very next target, useful for * the redirect table and other checks that don't need full recursion * - * @param $text \type{\string} Text with possible redirect - * @return \type{Title} The corresponding Title + * @param $text String: Text with possible redirect + * @return Title: The corresponding Title */ public static function newFromRedirect( $text ) { return self::newFromRedirectInternal( $text ); @@ -342,8 +340,8 @@ class Title { * This will recurse down $wgMaxRedirects times or until a non-redirect target is hit * in order to provide (hopefully) the Title of the final destination instead of another redirect * - * @param $text \type{\string} Text with possible redirect - * @return \type{Title} The corresponding Title + * @param $text String Text with possible redirect + * @return Title */ public static function newFromRedirectRecurse( $text ) { $titles = self::newFromRedirectArray( $text ); @@ -356,8 +354,8 @@ class Title { * The last element in the array is the final destination after all redirects * have been resolved (up to $wgMaxRedirects times) * - * @param $text \type{\string} Text with possible redirect - * @return \type{\array} Array of Titles, with the destination last + * @param $text String Text with possible redirect + * @return Array of Titles, with the destination last */ public static function newFromRedirectArray( $text ) { global $wgMaxRedirects; @@ -395,8 +393,8 @@ class Title { * Really extract the redirect destination * Do not call this function directly, use one of the newFromRedirect* functions above * - * @param $text \type{\string} Text with possible redirect - * @return \type{Title} The corresponding Title + * @param $text String Text with possible redirect + * @return Title */ protected static function newFromRedirectInternal( $text ) { $redir = MagicWord::get( 'redirect' ); @@ -411,9 +409,7 @@ class Title { // and URL-decode links if ( strpos( $m[1], '%' ) !== false ) { // Match behavior of inline link parsing here; - // don't interpret + as " " most of the time! - // It might be safe to just use rawurldecode instead, though. - $m[1] = urldecode( ltrim( $m[1], ':' ) ); + $m[1] = rawurldecode( ltrim( $m[1], ':' ) ); } $title = Title::newFromText( $m[1] ); // If the title is a redirect to bad special pages or is invalid, return null @@ -433,9 +429,8 @@ class Title { /** * Get the prefixed DB key associated with an ID * - * @param $id \type{\int} the page_id of the article - * @return \type{Title} an object representing the article, or NULL - * if no such article was found + * @param $id Int the page_id of the article + * @return Title an object representing the article, or NULL if no such article was found */ public static function nameOf( $id ) { $dbr = wfGetDB( DB_SLAVE ); @@ -457,7 +452,7 @@ class Title { /** * Get a regex character class describing the legal characters in a link * - * @return \type{\string} the list of characters, not delimited + * @return String the list of characters, not delimited */ public static function legalChars() { global $wgLegalTitleChars; @@ -468,10 +463,9 @@ class Title { * Get a string representation of a title suitable for * including in a search index * - * @param $ns \type{\int} a namespace index - * @param $title \type{\string} text-form main part - * @return \type{\string} a stripped-down title string ready for the - * search index + * @param $ns Int a namespace index + * @param $title String text-form main part + * @return String a stripped-down title string ready for the search index */ public static function indexTitle( $ns, $title ) { global $wgContLang; @@ -496,11 +490,11 @@ class Title { /** * Make a prefixed DB key from a DB key and a namespace index * - * @param $ns \type{\int} numerical representation of the namespace - * @param $title \type{\string} the DB key form the title - * @param $fragment \type{\string} The link fragment (after the "#") - * @param $interwiki \type{\string} The interwiki prefix - * @return \type{\string} the prefixed form of the title + * @param $ns Int numerical representation of the namespace + * @param $title String the DB key form the title + * @param $fragment String The link fragment (after the "#") + * @param $interwiki String The interwiki prefix + * @return String the prefixed form of the title */ public static function makeName( $ns, $title, $fragment = '', $interwiki = '' ) { global $wgContLang; @@ -520,8 +514,7 @@ class Title { * Determine whether the object refers to a page within * this project. * - * @return \type{\bool} TRUE if this is an in-project interwiki link - * or a wikilink, FALSE otherwise + * @return Bool TRUE if this is an in-project interwiki link or a wikilink, FALSE otherwise */ public function isLocal() { if ( $this->mInterwiki != '' ) { @@ -535,7 +528,7 @@ class Title { * Determine whether the object refers to a page within * this project and is transcludable. * - * @return \type{\bool} TRUE if this is transcludable + * @return Bool TRUE if this is transcludable */ public function isTrans() { if ( $this->mInterwiki == '' ) { @@ -546,10 +539,9 @@ class Title { } /** - * Returns the DB name of the distant wiki - * which owns the object. + * Returns the DB name of the distant wiki which owns the object. * - * @return \type{\string} the DB name + * @return String the DB name */ public function getTransWikiID() { if ( $this->mInterwiki == '' ) { @@ -581,35 +573,35 @@ class Title { /** * Get the text form (spaces not underscores) of the main part * - * @return \type{\string} Main part of the title + * @return String Main part of the title */ public function getText() { return $this->mTextform; } /** * Get the URL-encoded form of the main part * - * @return \type{\string} Main part of the title, URL-encoded + * @return String Main part of the title, URL-encoded */ public function getPartialURL() { return $this->mUrlform; } /** * Get the main part with underscores * - * @return \type{\string} Main part of the title, with underscores + * @return String: Main part of the title, with underscores */ public function getDBkey() { return $this->mDbkeyform; } /** - * Get the namespace index, i.e.\ one of the NS_xxxx constants. + * Get the namespace index, i.e. one of the NS_xxxx constants. * - * @return \type{\int} Namespace index + * @return Integer: Namespace index */ public function getNamespace() { return $this->mNamespace; } /** * Get the namespace text * - * @return \type{\string} Namespace text + * @return String: Namespace text */ public function getNsText() { global $wgContLang; @@ -631,7 +623,7 @@ class Title { /** * Get the DB key with the initial letter case as specified by the user * - * @return \type{\string} DB key + * @return String DB key */ function getUserCaseDBKey() { return $this->mUserCaseDBKey; @@ -640,7 +632,7 @@ class Title { /** * Get the namespace text of the subject (rather than talk) page * - * @return \type{\string} Namespace text + * @return String Namespace text */ public function getSubjectNsText() { global $wgContLang; @@ -650,7 +642,7 @@ class Title { /** * Get the namespace text of the talk page * - * @return \type{\string} Namespace text + * @return String Namespace text */ public function getTalkNsText() { global $wgContLang; @@ -660,7 +652,7 @@ class Title { /** * Could this title have a corresponding talk page? * - * @return \type{\bool} TRUE or FALSE + * @return Bool TRUE or FALSE */ public function canTalk() { return( MWNamespace::canTalk( $this->mNamespace ) ); @@ -669,20 +661,20 @@ class Title { /** * Get the interwiki prefix (or null string) * - * @return \type{\string} Interwiki prefix + * @return String Interwiki prefix */ public function getInterwiki() { return $this->mInterwiki; } /** * Get the Title fragment (i.e.\ the bit after the #) in text form * - * @return \type{\string} Title fragment + * @return String Title fragment */ public function getFragment() { return $this->mFragment; } /** * Get the fragment in URL form, including the "#" character if there is one - * @return \type{\string} Fragment in URL form + * @return String Fragment in URL form */ public function getFragmentForURL() { if ( $this->mFragment == '' ) { @@ -695,14 +687,14 @@ class Title { /** * Get the default namespace index, for when there is no namespace * - * @return \type{\int} Default namespace index + * @return Int Default namespace index */ public function getDefaultNamespace() { return $this->mDefaultNamespace; } /** * Get title for search index * - * @return \type{\string} a stripped-down title string ready for the + * @return String a stripped-down title string ready for the * search index */ public function getIndexTitle() { @@ -712,7 +704,7 @@ class Title { /** * Get the prefixed database key form * - * @return \type{\string} the prefixed title, with underscores and + * @return String the prefixed title, with underscores and * any interwiki and namespace prefixes */ public function getPrefixedDBkey() { @@ -725,7 +717,7 @@ class Title { * Get the prefixed title with spaces. * This is the form usually used for display * - * @return \type{\string} the prefixed title, with spaces + * @return String the prefixed title, with spaces */ public function getPrefixedText() { if ( empty( $this->mPrefixedText ) ) { // FIXME: bad usage of empty() ? @@ -740,8 +732,7 @@ class Title { * Get the prefixed title with spaces, plus any fragment * (part beginning with '#') * - * @return \type{\string} the prefixed title, with spaces and - * the fragment, including '#' + * @return String the prefixed title, with spaces and the fragment, including '#' */ public function getFullText() { $text = $this->getPrefixedText(); @@ -754,7 +745,7 @@ class Title { /** * Get the base name, i.e. the leftmost parts before the / * - * @return \type{\string} Base name + * @return String Base name */ public function getBaseText() { if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) { @@ -772,7 +763,7 @@ class Title { /** * Get the lowest-level subpage name, i.e. the rightmost part after / * - * @return \type{\string} Subpage name + * @return String Subpage name */ public function getSubpageText() { if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) { @@ -785,7 +776,7 @@ class Title { /** * Get a URL-encoded form of the subpage text * - * @return \type{\string} URL-encoded subpage name + * @return String URL-encoded subpage name */ public function getSubpageUrlForm() { $text = $this->getSubpageText(); @@ -796,7 +787,7 @@ class Title { /** * Get a URL-encoded title (not an actual URL) including interwiki * - * @return \type{\string} the URL-encoded form + * @return String the URL-encoded form */ public function getPrefixedURL() { $s = $this->prefix( $this->mDbkeyform ); @@ -811,8 +802,8 @@ class Title { * @param $query \twotypes{\string,\array} an optional query string, not used for interwiki * links. Can be specified as an associative array as well, e.g., * array( 'action' => 'edit' ) (keys and values will be URL-escaped). - * @param $variant \type{\string} language variant of url (for sr, zh..) - * @return \type{\string} the URL + * @param $variant String language variant of url (for sr, zh..) + * @return String the URL */ public function getFullURL( $query = '', $variant = false ) { global $wgServer, $wgRequest; @@ -858,8 +849,8 @@ class Title { * $wgArticlePath will be used. Can be specified as an associative array * as well, e.g., array( 'action' => 'edit' ) (keys and values will be * URL-escaped). - * @param $variant \type{\string} language variant of url (for sr, zh..) - * @return \type{\string} the URL + * @param $variant String language variant of url (for sr, zh..) + * @return String the URL */ public function getLocalURL( $query = '', $variant = false ) { global $wgArticlePath, $wgScript, $wgServer, $wgRequest; @@ -939,12 +930,12 @@ class Title { * The result obviously should not be URL-escaped, but does need to be * HTML-escaped if it's being output in HTML. * - * @param $query \type{\arrayof{\string}} An associative array of key => value pairs for the + * @param $query Array of Strings An associative array of key => value pairs for the * query string. Keys and values will be escaped. - * @param $variant \type{\string} Language variant of URL (for sr, zh..). Ignored + * @param $variant String language variant of URL (for sr, zh..). Ignored * for external links. Default is "false" (same variant as current page, * for anonymous users). - * @return \type{\string} the URL + * @return String the URL */ public function getLinkUrl( $query = array(), $variant = false ) { wfProfileIn( __METHOD__ ); @@ -963,8 +954,8 @@ class Title { * Get an HTML-escaped version of the URL form, suitable for * using in a link, without a server name or fragment * - * @param $query \type{\string} an optional query string - * @return \type{\string} the URL + * @param $query String an optional query string + * @return String the URL */ public function escapeLocalURL( $query = '' ) { return htmlspecialchars( $this->getLocalURL( $query ) ); @@ -974,8 +965,8 @@ class Title { * Get an HTML-escaped version of the URL form, suitable for * using in a link, including the server name and fragment * - * @param $query \type{\string} an optional query string - * @return \type{\string} the URL + * @param $query String an optional query string + * @return String the URL */ public function escapeFullURL( $query = '' ) { return htmlspecialchars( $this->getFullURL( $query ) ); @@ -986,9 +977,9 @@ class Title { * - Used in various Squid-related code, in case we have a different * internal hostname for the server from the exposed one. * - * @param $query \type{\string} an optional query string - * @param $variant \type{\string} language variant of url (for sr, zh..) - * @return \type{\string} the URL + * @param $query String an optional query string + * @param $variant String language variant of url (for sr, zh..) + * @return String the URL */ public function getInternalURL( $query = '', $variant = false ) { global $wgInternalServer; @@ -1000,7 +991,7 @@ class Title { /** * Get the edit URL for this Title * - * @return \type{\string} the URL, or a null string if this is an + * @return String the URL, or a null string if this is an * interwiki link */ public function getEditURL() { @@ -1016,7 +1007,7 @@ class Title { * Get the HTML-escaped displayable text form. * Used for the title field in tags. * - * @return \type{\string} the text, including any prefixes + * @return String the text, including any prefixes */ public function getEscapedText() { return htmlspecialchars( $this->getPrefixedText() ); @@ -1025,7 +1016,7 @@ class Title { /** * Is this Title interwiki? * - * @return \type{\bool} + * @return Bool */ public function isExternal() { return ( $this->mInterwiki != '' ); @@ -1034,8 +1025,8 @@ class Title { /** * Is this page "semi-protected" - the *only* protection is autoconfirm? * - * @param $action \type{\string} Action to check (default: edit) - * @return \type{\bool} + * @param $action String Action to check (default: edit) + * @return Bool */ public function isSemiProtected( $action = 'edit' ) { if ( $this->exists() ) { @@ -1060,9 +1051,9 @@ class Title { /** * Does the title correspond to a protected article? * - * @param $action \type{\string} the action the page is protected from, + * @param $action String the action the page is protected from, * by default checks all actions. - * @return \type{\bool} + * @return Bool */ public function isProtected( $action = '' ) { global $wgRestrictionLevels; @@ -1092,7 +1083,7 @@ class Title { /** * Is this a conversion table for the LanguageConverter? * - * @return \type{\bool} + * @return Bool */ public function isConversionTable() { if( @@ -1109,7 +1100,7 @@ class Title { /** * Is $wgUser watching this page? * - * @return \type{\bool} + * @return Bool */ public function userIsWatching() { global $wgUser; @@ -1134,24 +1125,31 @@ class Title { * * May provide false positives, but should never provide a false negative. * - * @param $action \type{\string} action that permission needs to be checked for - * @return \type{\bool} + * @param $action String action that permission needs to be checked for + * @return Bool */ public function quickUserCan( $action ) { return $this->userCan( $action, false ); } /** - * Determines if $wgUser is unable to edit this page because it has been protected + * Determines if $user is unable to edit this page because it has been protected * by $wgNamespaceProtection. * - * @return \type{\bool} + * @param $user User object, $wgUser will be used if not passed + * @return Bool */ - public function isNamespaceProtected() { - global $wgNamespaceProtection, $wgUser; + public function isNamespaceProtected( User $user = null ) { + global $wgNamespaceProtection; + + if ( $user === null ) { + global $wgUser; + $user = $wgUser; + } + if ( isset( $wgNamespaceProtection[$this->mNamespace] ) ) { foreach ( (array)$wgNamespaceProtection[$this->mNamespace] as $right ) { - if ( $right != '' && !$wgUser->isAllowed( $right ) ) { + if ( $right != '' && !$user->isAllowed( $right ) ) { return true; } } @@ -1162,9 +1160,9 @@ class Title { /** * Can $wgUser perform $action on this page? * - * @param $action \type{\string} action that permission needs to be checked for - * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries. - * @return \type{\bool} + * @param $action String action that permission needs to be checked for + * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries. + * @return Bool */ public function userCan( $action, $doExpensiveQueries = true ) { global $wgUser; @@ -1176,11 +1174,11 @@ class Title { * * FIXME: This *does not* check throttles (User::pingLimiter()). * - * @param $action \type{\string}action that permission needs to be checked for - * @param $user \type{User} user to check - * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries. - * @param $ignoreErrors \type{\arrayof{\string}} Set this to a list of message keys whose corresponding errors may be ignored. - * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems. + * @param $action String action that permission needs to be checked for + * @param $user User to check + * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries. + * @param $ignoreErrors Array of Strings Set this to a list of message keys whose corresponding errors may be ignored. + * @return Array of arguments to wfMsg to explain permissions problems. */ public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) { $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries ); @@ -1304,7 +1302,14 @@ class Title { /** * Check various permission hooks - * @see checkQuickPermissions for parameter information + * + * @param $action String the action to check + * @param $user User user to check + * @param $errors Array list of current errors + * @param $doExpensiveQueries Boolean whether or not to perform expensive queries + * @param $short Boolean short circuit on first error + * + * @return Array list of errors */ private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) { // Use getUserPermissionsErrors instead @@ -1327,7 +1332,14 @@ class Title { /** * Check permissions on special pages & namespaces - * @see checkQuickPermissions for parameter information + * + * @param $action String the action to check + * @param $user User user to check + * @param $errors Array list of current errors + * @param $doExpensiveQueries Boolean whether or not to perform expensive queries + * @param $short Boolean short circuit on first error + * + * @return Array list of errors */ private function checkSpecialsAndNSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) { # Only 'createaccount' and 'execute' can be performed on @@ -1338,7 +1350,7 @@ class Title { } # Check $wgNamespaceProtection for restricted namespaces - if ( $this->isNamespaceProtected() ) { + if ( $this->isNamespaceProtected( $user ) ) { $ns = $this->mNamespace == NS_MAIN ? wfMsg( 'nstab-main' ) : $this->getNsText(); $errors[] = $this->mNamespace == NS_MEDIAWIKI ? @@ -1350,7 +1362,14 @@ class Title { /** * Check CSS/JS sub-page permissions - * @see checkQuickPermissions for parameter information + * + * @param $action String the action to check + * @param $user User user to check + * @param $errors Array list of current errors + * @param $doExpensiveQueries Boolean whether or not to perform expensive queries + * @param $short Boolean short circuit on first error + * + * @return Array list of errors */ private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) { # Protect css/js subpages of user pages @@ -1374,7 +1393,14 @@ class Title { * Check against page_restrictions table requirements on this * page. The user must possess all required rights for this * action. - * @see checkQuickPermissions for parameter information + * + * @param $action String the action to check + * @param $user User user to check + * @param $errors Array list of current errors + * @param $doExpensiveQueries Boolean whether or not to perform expensive queries + * @param $short Boolean short circuit on first error + * + * @return Array list of errors */ private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) { foreach ( $this->getRestrictions( $action ) as $right ) { @@ -1401,7 +1427,14 @@ class Title { /** * Check restrictions on cascading pages. - * @see checkQuickPermissions for parameter information + * + * @param $action String the action to check + * @param $user User to check + * @param $errors Array list of current errors + * @param $doExpensiveQueries Boolean whether or not to perform expensive queries + * @param $short Boolean short circuit on first error + * + * @return Array list of errors */ private function checkCascadingSourcesRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) { if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) { @@ -1433,7 +1466,14 @@ class Title { /** * Check action permissions not already checked in checkQuickPermissions - * @see checkQuickPermissions for parameter information + * + * @param $action String the action to check + * @param $user User to check + * @param $errors Array list of current errors + * @param $doExpensiveQueries Boolean whether or not to perform expensive queries + * @param $short Boolean short circuit on first error + * + * @return Array list of errors */ private function checkActionPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) { if ( $action == 'protect' ) { @@ -1472,10 +1512,17 @@ class Title { /** * Check that the user isn't blocked from editting. - * @see checkQuickPermissions for parameter information + * + * @param $action String the action to check + * @param $user User to check + * @param $errors Array list of current errors + * @param $doExpensiveQueries Boolean whether or not to perform expensive queries + * @param $short Boolean short circuit on first error + * + * @return Array list of errors */ private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) { - if( $short ) { + if( $short && count( $errors ) > 0 ) { return $errors; } @@ -1542,11 +1589,11 @@ class Title { * which checks ONLY that previously checked by userCan (i.e. it leaves out * checks on wfReadOnly() and blocks) * - * @param $action \type{\string} action that permission needs to be checked for - * @param $user \type{User} user to check - * @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries. - * @param $short \type{\bool} Set this to true to stop after the first permission error. - * @return \type{\array} Array of arrays of the arguments to wfMsg to explain permissions problems. + * @param $action String action that permission needs to be checked for + * @param $user User to check + * @param $doExpensiveQueries Bool Set this to false to avoid doing unnecessary queries. + * @param $short Bool Set this to true to stop after the first permission error. + * @return Array of arrays of the arguments to wfMsg to explain permissions problems. */ protected function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true, $short = false ) { wfProfileIn( __METHOD__ ); @@ -1575,8 +1622,9 @@ class Title { /** * Is this title subject to title protection? + * Title protection is the one applied against creation of such title. * - * @return \type{\mixed} An associative array representing any existent title + * @return Mixed An associative array representing any existent title * protection, or false if there's none. */ private function getTitleProtection() { @@ -1602,16 +1650,12 @@ class Title { return $this->mTitleProtection; } - private function invalidateTitleProtectionCache() { - unset( $this->mTitleProtection ); - } - /** * Update the title protection status * - * @param $create_perm \type{\string} Permission required for creation - * @param $reason \type{\string} Reason for protection - * @param $expiry \type{\string} Expiry timestamp + * @param $create_perm String Permission required for creation + * @param $reason String Reason for protection + * @param $expiry String Expiry timestamp * @return boolean true */ public function updateTitleProtection( $create_perm, $reason, $expiry ) { @@ -1639,8 +1683,7 @@ class Title { # Update protection table if ( $create_perm != '' ) { - $dbw->replace( 'protected_titles', array( array( 'pt_namespace', 'pt_title' ) ), - array( + $this->mTitleProtection = array( 'pt_namespace' => $namespace, 'pt_title' => $title, 'pt_create_perm' => $create_perm, @@ -1648,13 +1691,14 @@ class Title { 'pt_expiry' => $encodedExpiry, 'pt_user' => $wgUser->getId(), 'pt_reason' => $reason, - ), __METHOD__ - ); + ); + $dbw->replace( 'protected_titles', array( array( 'pt_namespace', 'pt_title' ) ), + $this->mTitleProtection, __METHOD__ ); } else { $dbw->delete( 'protected_titles', array( 'pt_namespace' => $namespace, 'pt_title' => $title ), __METHOD__ ); + $this->mTitleProtection = false; } - $this->invalidateTitleProtectionCache(); # Update the protection log if ( $dbw->affectedRows() ) { @@ -1682,14 +1726,14 @@ class Title { array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ), __METHOD__ ); - $this->invalidateTitleProtectionCache(); + $this->mTitleProtection = false; } /** * Would anybody with sufficient privileges be able to move this page? * Some pages just aren't movable. * - * @return \type{\bool} TRUE or FALSE + * @return Bool TRUE or FALSE */ public function isMovable() { return MWNamespace::isMovable( $this->getNamespace() ) && $this->getInterwiki() == ''; @@ -1698,7 +1742,7 @@ class Title { /** * Can $wgUser read this page? * - * @return \type{\bool} + * @return Bool * @todo fold these checks into userCan() */ public function userCanRead() { @@ -1746,44 +1790,33 @@ class Title { } else { global $wgWhitelistRead; - /** - * Always grant access to the login page. - * Even anons need to be able to log in. - */ + # Always grant access to the login page. + # Even anons need to be able to log in. if ( $this->isSpecial( 'Userlogin' ) || $this->isSpecial( 'Resetpass' ) ) { return true; } - /** - * Bail out if there isn't whitelist - */ + # Bail out if there isn't whitelist if ( !is_array( $wgWhitelistRead ) ) { return false; } - /** - * Check for explicit whitelisting - */ + # Check for explicit whitelisting $name = $this->getPrefixedText(); $dbName = $this->getPrefixedDBKey(); // Check with and without underscores if ( in_array( $name, $wgWhitelistRead, true ) || in_array( $dbName, $wgWhitelistRead, true ) ) return true; - /** - * Old settings might have the title prefixed with - * a colon for main-namespace pages - */ + # Old settings might have the title prefixed with + # a colon for main-namespace pages if ( $this->getNamespace() == NS_MAIN ) { if ( in_array( ':' . $name, $wgWhitelistRead ) ) { return true; } } - /** - * If it's a special page, ditch the subpage bit - * and check again - */ + # If it's a special page, ditch the subpage bit and check again if ( $this->getNamespace() == NS_SPECIAL ) { $name = $this->getDBkey(); list( $name, /* $subpage */ ) = SpecialPage::resolveAliasWithSubpage( $name ); @@ -1802,10 +1835,23 @@ class Title { return false; } + /** + * Is this the mainpage? + * @note Title::newFromText seams to be sufficiently optimized by the title + * cache that we don't need to over-optimize by doing direct comparisons and + * acidentally creating new bugs where $title->equals( Title::newFromText() ) + * ends up reporting something differently than $title->isMainPage(); + * + * @return Bool + */ + public function isMainPage() { + return $this->equals( Title::newMainPage() ); + } + /** * Is this a talk page of some sort? * - * @return \type{\bool} + * @return Bool */ public function isTalkPage() { return MWNamespace::isTalk( $this->getNamespace() ); @@ -1814,7 +1860,7 @@ class Title { /** * Is this a subpage? * - * @return \type{\bool} + * @return Bool */ public function isSubpage() { return MWNamespace::hasSubpages( $this->mNamespace ) @@ -1825,7 +1871,7 @@ class Title { /** * Does this have subpages? (Warning, usually requires an extra DB query.) * - * @return \type{\bool} + * @return Bool */ public function hasSubpages() { if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) { @@ -1851,7 +1897,7 @@ class Title { /** * Get all subpages of this page. * - * @param $limit Maximum number of subpages to fetch; -1 for no limit + * @param $limit Int maximum number of subpages to fetch; -1 for no limit * @return mixed TitleArray, or empty array if this page's namespace * doesn't allow subpages */ @@ -1881,7 +1927,7 @@ class Title { * Could this page contain custom CSS or JavaScript, based * on the title? * - * @return \type{\bool} + * @return Bool */ public function isCssOrJsPage() { return $this->mNamespace == NS_MEDIAWIKI @@ -1890,7 +1936,7 @@ class Title { /** * Is this a .css or .js subpage of a user page? - * @return \type{\bool} + * @return Bool */ public function isCssJsSubpage() { return ( NS_USER == $this->mNamespace and preg_match( "/\\/.*\\.(?:css|js)$/", $this->mTextform ) ); @@ -1898,21 +1944,12 @@ class Title { /** * Is this a *valid* .css or .js subpage of a user page? - * Check that the corresponding skin exists * - * @return \type{\bool} + * @return Bool + * @deprecated @since 1.17 */ public function isValidCssJsSubpage() { - if ( $this->isCssJsSubpage() ) { - $name = $this->getSkinFromCssJsSubpage(); - if ( $name == 'common' ) { - return true; - } - $skinNames = Skin::getSkinNames(); - return array_key_exists( $name, $skinNames ); - } else { - return false; - } + return $this->isCssJsSubpage(); } /** @@ -1929,7 +1966,7 @@ class Title { /** * Is this a .css subpage of a user page? * - * @return \type{\bool} + * @return Bool */ public function isCssSubpage() { return ( NS_USER == $this->mNamespace && preg_match( "/\\/.*\\.css$/", $this->mTextform ) ); @@ -1938,7 +1975,7 @@ class Title { /** * Is this a .js subpage of a user page? * - * @return \type{\bool} + * @return Bool */ public function isJsSubpage() { return ( NS_USER == $this->mNamespace && preg_match( "/\\/.*\\.js$/", $this->mTextform ) ); @@ -1948,7 +1985,7 @@ class Title { * Protect css subpages of user pages: can $wgUser edit * this page? * - * @return \type{\bool} + * @return Bool * @todo XXX: this might be better using restrictions */ public function userCanEditCssSubpage() { @@ -1961,7 +1998,7 @@ class Title { * Protect js subpages of user pages: can $wgUser edit * this page? * - * @return \type{\bool} + * @return Bool * @todo XXX: this might be better using restrictions */ public function userCanEditJsSubpage() { @@ -1973,7 +2010,7 @@ class Title { /** * Cascading protection: Return true if cascading restrictions apply to this page, false if not. * - * @return \type{\bool} If the page is subject to cascading restrictions. + * @return Bool If the page is subject to cascading restrictions. */ public function isCascadeProtected() { list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false ); @@ -1983,13 +2020,12 @@ class Title { /** * Cascading protection: Get the source of any cascading restrictions on this page. * - * @param $getPages \type{\bool} Whether or not to retrieve the actual pages + * @param $getPages Bool Whether or not to retrieve the actual pages * that the restrictions have come from. - * @return \type{\arrayof{mixed title array, restriction array}} Array of the Title - * objects of the pages from which cascading restrictions have come, - * false for none, or true if such restrictions exist, but $getPages was not set. - * The restriction array is an array of each type, each of which contains a - * array of unique groups. + * @return Mixed Array of Title objects of the pages from which cascading restrictions + * have come, false for none, or true if such restrictions exist, but $getPages + * was not set. The restriction array is an array of each type, each of which + * contains a array of unique groups. */ public function getCascadeProtectionSources( $getPages = true ) { $pagerestrictions = array(); @@ -2065,7 +2101,6 @@ class Title { } if ( $purgeExpired ) { Title::purgeExpiredRestrictions(); - $this->invalidateTitleProtectionCache(); } wfProfileOut( __METHOD__ ); @@ -2096,8 +2131,8 @@ class Title { /** * Loads a string into mRestrictions array * - * @param $res \type{Resource} restrictions as an SQL result. - * @param $oldFashionedRestrictions string comma-separated list of page + * @param $res Resource restrictions as an SQL result. + * @param $oldFashionedRestrictions String comma-separated list of page * restrictions from page table (pre 1.10) */ private function loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions = null ) { @@ -2112,7 +2147,8 @@ class Title { /** * Compiles list of active page restrictions from both page table (pre 1.10) - * and page_restrictions table + * and page_restrictions table for this existing page. + * Public for usage by LiquidThreads. * * @param $rows array of db result objects * @param $oldFashionedRestrictions string comma-separated list of page @@ -2159,11 +2195,10 @@ class Title { $now = wfTimestampNow(); $purgeExpired = false; + # Cycle through all the restrictions. foreach ( $rows as $row ) { - # Cycle through all the restrictions. // Don't take care of restrictions types that aren't allowed - if ( !in_array( $row->pr_type, $restrictionTypes ) ) continue; @@ -2185,7 +2220,6 @@ class Title { if ( $purgeExpired ) { Title::purgeExpiredRestrictions(); - $this->invalidateTitleProtectionCache(); } } @@ -2195,7 +2229,7 @@ class Title { /** * Load restrictions from the page_restrictions table * - * @param $oldFashionedRestrictions string comma-separated list of page + * @param $oldFashionedRestrictions String comma-separated list of page * restrictions from page table (pre 1.10) */ public function loadRestrictions( $oldFashionedRestrictions = null ) { @@ -2220,7 +2254,7 @@ class Title { $this->mRestrictions['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) ); } else { // Get rid of the old restrictions Title::purgeExpiredRestrictions(); - $this->invalidateTitleProtectionCache(); + $this->mTitleProtection = false; } } else { $this->mRestrictionsExpiry['create'] = Block::decodeExpiry( '' ); @@ -2251,8 +2285,8 @@ class Title { /** * Accessor/initialisation for mRestrictions * - * @param $action \type{\string} action that permission needs to be checked for - * @return \type{\arrayof{\string}} the array of groups allowed to edit this article + * @param $action String action that permission needs to be checked for + * @return Array of Strings the array of groups allowed to edit this article */ public function getRestrictions( $action ) { if ( !$this->mRestrictionsLoaded ) { @@ -2266,7 +2300,7 @@ class Title { /** * Get the expiry time for the restriction against a given action * - * @return 14-char timestamp, or 'infinity' if the page is protected forever + * @return String|Bool 14-char timestamp, or 'infinity' if the page is protected forever * or not protected at all, or false if the action is not recognised. */ public function getRestrictionExpiry( $action ) { @@ -2279,7 +2313,7 @@ class Title { /** * Is there a version of this page in the deletion archive? * - * @return \type{\int} the number of archived revisions + * @return Int the number of archived revisions */ public function isDeleted() { if ( $this->getNamespace() < 0 ) { @@ -2327,9 +2361,9 @@ class Title { * Get the article ID for this Title from the link cache, * adding it if necessary * - * @param $flags \type{\int} a bit field; may be Title::GAID_FOR_UPDATE to select + * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select * for update - * @return \type{\int} the ID + * @return Int the ID */ public function getArticleID( $flags = 0 ) { if ( $this->getNamespace() < 0 ) { @@ -2353,8 +2387,8 @@ class Title { * Is this an article that is a redirect page? * Uses link cache, adding it if necessary * - * @param $flags \type{\int} a bit field; may be Title::GAID_FOR_UPDATE to select for update - * @return \type{\bool} + * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update + * @return Bool */ public function isRedirect( $flags = 0 ) { if ( !is_null( $this->mRedirect ) ) { @@ -2374,8 +2408,8 @@ class Title { * What is the length of this page? * Uses link cache, adding it if necessary * - * @param $flags \type{\int} a bit field; may be Title::GAID_FOR_UPDATE to select for update - * @return \type{\bool} + * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update + * @return Int */ public function getLength( $flags = 0 ) { if ( $this->mLength != -1 ) { @@ -2394,8 +2428,8 @@ class Title { /** * What is the page_latest field for this page? * - * @param $flags \type{\int} a bit field; may be Title::GAID_FOR_UPDATE to select for update - * @return \type{\int} or 0 if the page doesn't exist + * @param $flags Int a bit field; may be Title::GAID_FOR_UPDATE to select for update + * @return Int or 0 if the page doesn't exist */ public function getLatestRevID( $flags = 0 ) { if ( $this->mLatestID !== false ) { @@ -2415,11 +2449,11 @@ class Title { * This clears some fields in this object, and clears any associated * keys in the "bad links" section of the link cache. * - * - This is called from Article::insertNewArticle() to allow + * - This is called from Article::doEdit() and Article::insertOn() to allow * loading of the new page_id. It's also called from * Article::doDeleteArticle() * - * @param $newid \type{\int} the new Article ID + * @param $newid Int the new Article ID */ public function resetArticleID( $newid ) { $linkCache = LinkCache::singleton(); @@ -2440,7 +2474,7 @@ class Title { /** * Updates page_touched for this page; called from LinksUpdate.php * - * @return \type{\bool} true if the update succeded + * @return Bool true if the update succeded */ public function invalidateCache() { if ( wfReadOnly() ) { @@ -2461,8 +2495,8 @@ class Title { * Prefix some arbitrary text with the namespace or interwiki prefix * of this object * - * @param $name \type{\string} the text - * @return \type{\string} the prefixed text + * @param $name String the text + * @return String the prefixed text * @private */ /* private */ function prefix( $name ) { @@ -2481,7 +2515,7 @@ class Title { * Note that this doesn't pick up many things that could be wrong with titles, but that * replacing this regex with something valid will make many titles valid. * - * @return string regex string + * @return String regex string */ static function getTitleInvalidRegex() { static $rxTc = false; @@ -2506,7 +2540,7 @@ class Title { /** * Capitalize a text string for a title if it belongs to a namespace that capitalizes * - * @param $text string containing title to capitalize + * @param $text String containing title to capitalize * @param $ns int namespace index, defaults to NS_MAIN * @return String containing capitalized title */ @@ -2529,7 +2563,7 @@ class Title { * namespace prefixes, sets the other forms, and canonicalizes * everything. * - * @return \type{\bool} true on success + * @return Bool true on success */ private function secureAndSplit() { global $wgContLang, $wgLocalInterwiki; @@ -2551,7 +2585,6 @@ class Title { # Note: use of the /u option on preg_replace here will cause # input with invalid UTF-8 sequences to be nullified out in PHP 5.2.x, # conveniently disabling them. - # $dbkey = preg_replace( '/[ _\xA0\x{1680}\x{180E}\x{2000}-\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}]+/u', '_', $dbkey ); $dbkey = trim( $dbkey, '_' ); @@ -2588,9 +2621,11 @@ class Title { # For Talk:X pages, check if X has a "namespace" prefix if ( $ns == NS_TALK && preg_match( $prefixRegexp, $dbkey, $x ) ) { if ( $wgContLang->getNsIndex( $x[1] ) ) { - return false; # Disallow Talk:File:x type titles... + # Disallow Talk:File:x type titles... + return false; } else if ( Interwiki::isValidInterwiki( $x[1] ) ) { - return false; # Disallow Talk:Interwiki:x type titles... + # Disallow Talk:Interwiki:x type titles... + return false; } } } elseif ( Interwiki::isValidInterwiki( $p ) ) { @@ -2605,7 +2640,9 @@ class Title { $this->mInterwiki = $wgContLang->lc( $p ); # Redundant interwiki prefix to the local wiki - if ( 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) ) { + if ( $wgLocalInterwiki !== false + && 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) ) + { if ( $dbkey == '' ) { # Can't have an empty self-link return false; @@ -2630,7 +2667,6 @@ class Title { } while ( true ); # We already know that some pages won't be in the database! - # if ( $this->mInterwiki != '' || NS_SPECIAL == $this->mNamespace ) { $this->mArticleID = 0; } @@ -2644,16 +2680,13 @@ class Title { } # Reject illegal characters. - # if ( preg_match( $rxTc, $dbkey ) ) { return false; } - /** - * Pages with "/./" or "/../" appearing in the URLs will often be un- - * reachable due to the way web browsers deal with 'relative' URLs. - * Also, they conflict with subpage syntax. Forbid them explicitly. - */ + # Pages with "/./" or "/../" appearing in the URLs will often be un- + # reachable due to the way web browsers deal with 'relative' URLs. + # Also, they conflict with subpage syntax. Forbid them explicitly. if ( strpos( $dbkey, '.' ) !== false && ( $dbkey === '.' || $dbkey === '..' || strpos( $dbkey, './' ) === 0 || @@ -2666,57 +2699,45 @@ class Title { return false; } - /** - * Magic tilde sequences? Nu-uh! - */ + # Magic tilde sequences? Nu-uh! if ( strpos( $dbkey, '~~~' ) !== false ) { return false; } - /** - * Limit the size of titles to 255 bytes. - * This is typically the size of the underlying database field. - * We make an exception for special pages, which don't need to be stored - * in the database, and may edge over 255 bytes due to subpage syntax - * for long titles, e.g. [[Special:Block/Long name]] - */ + # Limit the size of titles to 255 bytes. This is typically the size of the + # underlying database field. We make an exception for special pages, which + # don't need to be stored in the database, and may edge over 255 bytes due + # to subpage syntax for long titles, e.g. [[Special:Block/Long name]] if ( ( $this->mNamespace != NS_SPECIAL && strlen( $dbkey ) > 255 ) || strlen( $dbkey ) > 512 ) { return false; } - /** - * Normally, all wiki links are forced to have - * an initial capital letter so [[foo]] and [[Foo]] - * point to the same place. - * - * Don't force it for interwikis, since the other - * site might be case-sensitive. - */ + # Normally, all wiki links are forced to have an initial capital letter so [[foo]] + # and [[Foo]] point to the same place. Don't force it for interwikis, since the + # other site might be case-sensitive. $this->mUserCaseDBKey = $dbkey; if ( $this->mInterwiki == '' ) { $dbkey = self::capitalize( $dbkey, $this->mNamespace ); } - /** - * Can't make a link to a namespace alone... - * "empty" local links can only be self-links - * with a fragment identifier. - */ - if ( $dbkey == '' && - $this->mInterwiki == '' && - $this->mNamespace != NS_MAIN ) { + # Can't make a link to a namespace alone... "empty" local links can only be + # self-links with a fragment identifier. + if ( $dbkey == '' && $this->mInterwiki == '' && $this->mNamespace != NS_MAIN ) { return false; } + // Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles. // IP names are not allowed for accounts, and can only be referring to // edits from the IP. Given '::' abbreviations and caps/lowercaps, // there are numerous ways to present the same IP. Having sp:contribs scan // them all is silly and having some show the edits and others not is // inconsistent. Same for talk/userpages. Keep them normalized instead. - $dbkey = ( $this->mNamespace == NS_USER || $this->mNamespace == NS_USER_TALK ) ? - IP::sanitizeIP( $dbkey ) : $dbkey; + $dbkey = ( $this->mNamespace == NS_USER || $this->mNamespace == NS_USER_TALK ) + ? IP::sanitizeIP( $dbkey ) + : $dbkey; + // Any remaining initial :s are illegal. if ( $dbkey !== '' && ':' == $dbkey { 0 } ) { return false; @@ -2739,7 +2760,7 @@ class Title { * Deprecated for public use, use Title::makeTitle() with fragment parameter. * Still in active use privately. * - * @param $fragment \type{\string} text + * @param $fragment String text */ public function setFragment( $fragment ) { $this->mFragment = str_replace( '_', ' ', substr( $fragment, 1 ) ); @@ -2779,7 +2800,7 @@ class Title { * @param $options Array: may be FOR UPDATE * @param $table String: table name * @param $prefix String: fields prefix - * @return \type{\arrayof{Title}} the Title objects linking here + * @return Array of Title objects linking here */ public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) { $linkCache = LinkCache::singleton(); @@ -2822,7 +2843,7 @@ class Title { * On heavily-used templates it will max out the memory. * * @param $options Array: may be FOR UPDATE - * @return \type{\arrayof{Title}} the Title objects linking here + * @return Array of Title the Title objects linking here */ public function getTemplateLinksTo( $options = array() ) { return $this->getLinksTo( $options, 'templatelinks', 'tl' ); @@ -2832,7 +2853,7 @@ class Title { * Get an array of Title objects referring to non-existent articles linked from this page * * @todo check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case) - * @return \type{\arrayof{Title}} the Title objects + * @return Array of Title the Title objects */ public function getBrokenLinksFrom() { if ( $this->getArticleId() == 0 ) { @@ -2869,7 +2890,7 @@ class Title { * Get a list of URLs to purge from the Squid cache when this * page changes * - * @return \type{\arrayof{\string}} the URLs + * @return Array of String the URLs */ public function getSquidURLs() { global $wgContLang; @@ -2905,8 +2926,8 @@ class Title { /** * Move this page without authentication * - * @param $nt \type{Title} the new page Title - * @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure + * @param $nt Title the new page Title + * @return Mixed true on success, getUserPermissionsErrors()-like array on failure */ public function moveNoAuth( &$nt ) { return $this->moveTo( $nt, false ); @@ -2916,11 +2937,11 @@ class Title { * Check whether a given move operation would be valid. * Returns true if ok, or a getUserPermissionsErrors()-like array otherwise * - * @param $nt \type{Title} the new title - * @param $auth \type{\bool} indicates whether $wgUser's permissions + * @param $nt Title the new title + * @param $auth Bool indicates whether $wgUser's permissions * should be checked - * @param $reason \type{\string} is the log summary of the move, used for spam checking - * @return \type{\mixed} True on success, getUserPermissionsErrors()-like array on failure + * @param $reason String is the log summary of the move, used for spam checking + * @return Mixed True on success, getUserPermissionsErrors()-like array on failure */ public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) { global $wgUser; @@ -3023,23 +3044,22 @@ class Title { /** * Move a title to a new location * - * @param $nt \type{Title} the new title - * @param $auth \type{\bool} indicates whether $wgUser's permissions + * @param $nt Title the new title + * @param $auth Bool indicates whether $wgUser's permissions * should be checked - * @param $reason \type{\string} The reason for the move - * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title. + * @param $reason String the reason for the move + * @param $createRedirect Bool Whether to create a redirect from the old title to the new title. * Ignored if the user doesn't have the suppressredirect right. - * @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure + * @return Mixed true on success, getUserPermissionsErrors()-like array on failure */ public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) { - global $wgContLang; - $err = $this->isValidMoveOperation( $nt, $auth, $reason ); if ( is_array( $err ) ) { return $err; } - // If it is a file, move it first. It is done before all other moving stuff is done because it's hard to revert + // If it is a file, move it first. It is done before all other moving stuff is + // done because it's hard to revert $dbw = wfGetDB( DB_MASTER ); if ( $this->getNamespace() == NS_FILE ) { $file = wfLocalFile( $this ); @@ -3053,17 +3073,14 @@ class Title { $pageid = $this->getArticleID(); $protected = $this->isProtected(); - if ( $nt->exists() ) { - $err = $this->moveOverExistingRedirect( $nt, $reason, $createRedirect ); - $pageCountChange = ( $createRedirect ? 0 : -1 ); - } else { # Target didn't exist, do normal move. - $err = $this->moveToNewTitle( $nt, $reason, $createRedirect ); - $pageCountChange = ( $createRedirect ? 1 : 0 ); - } + $pageCountChange = ( $createRedirect ? 1 : 0 ) - ( $nt->exists() ? 1 : 0 ); + // Do the actual move + $err = $this->moveToInternal( $nt, $reason, $createRedirect ); if ( is_array( $err ) ) { return $err; } + $redirid = $this->getArticleID(); // Refresh the sortkey for this row. Be careful to avoid resetting @@ -3076,7 +3093,8 @@ class Title { ); $dbw->update( 'categorylinks', array( - 'cl_sortkey' => $wgContLang->convertToSortkey( $nt->getCategorySortkey( $prefix ) ), + 'cl_sortkey' => Collation::singleton()->getSortKey( + $nt->getCategorySortkey( $prefix ) ), 'cl_timestamp=cl_timestamp' ), array( 'cl_from' => $pageid ), __METHOD__ ); @@ -3141,20 +3159,19 @@ class Title { $u->doUpdate(); } # Update message cache for interface messages - global $wgMessageCache; if ( $this->getNamespace() == NS_MEDIAWIKI ) { # @bug 17860: old article can be deleted, if this the case, # delete it from message cache if ( $this->getArticleID() === 0 ) { - $wgMessageCache->replace( $this->getDBkey(), false ); + MessageCache::singleton()->replace( $this->getDBkey(), false ); } else { $oldarticle = new Article( $this ); - $wgMessageCache->replace( $this->getDBkey(), $oldarticle->getContent() ); + MessageCache::singleton()->replace( $this->getDBkey(), $oldarticle->getContent() ); } } if ( $nt->getNamespace() == NS_MEDIAWIKI ) { $newarticle = new Article( $nt ); - $wgMessageCache->replace( $nt->getDBkey(), $newarticle->getContent() ); + MessageCache::singleton()->replace( $nt->getDBkey(), $newarticle->getContent() ); } global $wgUser; @@ -3163,19 +3180,21 @@ class Title { } /** - * Move page to a title which is at present a redirect to the - * source page + * Move page to a title which is either a redirect to the + * source page or nonexistent * - * @param $nt \type{Title} the page to move to, which should currently - * be a redirect - * @param $reason \type{\string} The reason for the move - * @param $createRedirect \type{\bool} Whether to leave a redirect at the old title. - * Ignored if the user doesn't have the suppressredirect right + * @param $nt Title the page to move to, which should be a redirect or nonexistent + * @param $reason String The reason for the move + * @param $createRedirect Bool Whether to leave a redirect at the old title. Ignored + * if the user doesn't have the suppressredirect right */ - private function moveOverExistingRedirect( &$nt, $reason = '', $createRedirect = true ) { - global $wgUseSquid, $wgUser, $wgContLang; + private function moveToInternal( &$nt, $reason = '', $createRedirect = true ) { + global $wgUser, $wgContLang; - $comment = wfMsgForContent( '1movedto2_redir', $this->getPrefixedText(), $nt->getPrefixedText() ); + $moveOverRedirect = $nt->exists(); + + $commentMsg = ( $moveOverRedirect ? '1movedto2_redir' : '1movedto2' ); + $comment = wfMsgForContent( $commentMsg, $this->getPrefixedText(), $nt->getPrefixedText() ); if ( $reason ) { $comment .= wfMsgForContent( 'colon-separator' ) . $reason; @@ -3183,44 +3202,49 @@ class Title { # Truncate for whole multibyte characters. +5 bytes for ellipsis $comment = $wgContLang->truncate( $comment, 250 ); - $now = wfTimestampNow(); - $newid = $nt->getArticleID(); $oldid = $this->getArticleID(); $latest = $this->getLatestRevID(); $dbw = wfGetDB( DB_MASTER ); - $rcts = $dbw->timestamp( $nt->getEarliestRevTime() ); - $newns = $nt->getNamespace(); - $newdbk = $nt->getDBkey(); - - # Delete the old redirect. We don't save it to history since - # by definition if we've got here it's rather uninteresting. - # We have to remove it so that the next step doesn't trigger - # a conflict on the unique namespace+title index... - $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__ ); - if ( !$dbw->cascadingDeletes() ) { - $dbw->delete( 'revision', array( 'rev_page' => $newid ), __METHOD__ ); - global $wgUseTrackbacks; - if ( $wgUseTrackbacks ) { - $dbw->delete( 'trackbacks', array( 'tb_page' => $newid ), __METHOD__ ); + if ( $moveOverRedirect ) { + $rcts = $dbw->timestamp( $nt->getEarliestRevTime() ); + + $newid = $nt->getArticleID(); + $newns = $nt->getNamespace(); + $newdbk = $nt->getDBkey(); + + # Delete the old redirect. We don't save it to history since + # by definition if we've got here it's rather uninteresting. + # We have to remove it so that the next step doesn't trigger + # a conflict on the unique namespace+title index... + $dbw->delete( 'page', array( 'page_id' => $newid ), __METHOD__ ); + if ( !$dbw->cascadingDeletes() ) { + $dbw->delete( 'revision', array( 'rev_page' => $newid ), __METHOD__ ); + global $wgUseTrackbacks; + if ( $wgUseTrackbacks ) { + $dbw->delete( 'trackbacks', array( 'tb_page' => $newid ), __METHOD__ ); + } + $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__ ); + $dbw->delete( 'imagelinks', array( 'il_from' => $newid ), __METHOD__ ); + $dbw->delete( 'categorylinks', array( 'cl_from' => $newid ), __METHOD__ ); + $dbw->delete( 'templatelinks', array( 'tl_from' => $newid ), __METHOD__ ); + $dbw->delete( 'externallinks', array( 'el_from' => $newid ), __METHOD__ ); + $dbw->delete( 'langlinks', array( 'll_from' => $newid ), __METHOD__ ); + $dbw->delete( 'redirect', array( 'rd_from' => $newid ), __METHOD__ ); } - $dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__ ); - $dbw->delete( 'imagelinks', array( 'il_from' => $newid ), __METHOD__ ); - $dbw->delete( 'categorylinks', array( 'cl_from' => $newid ), __METHOD__ ); - $dbw->delete( 'templatelinks', array( 'tl_from' => $newid ), __METHOD__ ); - $dbw->delete( 'externallinks', array( 'el_from' => $newid ), __METHOD__ ); - $dbw->delete( 'langlinks', array( 'll_from' => $newid ), __METHOD__ ); - $dbw->delete( 'redirect', array( 'rd_from' => $newid ), __METHOD__ ); - } - // If the redirect was recently created, it may have an entry in recentchanges still - $dbw->delete( 'recentchanges', - array( 'rc_timestamp' => $rcts, 'rc_namespace' => $newns, 'rc_title' => $newdbk, 'rc_new' => 1 ), - __METHOD__ - ); + // If the target page was recently created, it may have an entry in recentchanges still + $dbw->delete( 'recentchanges', + array( 'rc_timestamp' => $rcts, 'rc_namespace' => $newns, 'rc_title' => $newdbk, 'rc_new' => 1 ), + __METHOD__ + ); + } # Save a null revision in the page's history notifying of the move $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true ); + if ( !is_object( $nullRevision ) ) { + throw new MWException( 'No valid null revision produced in ' . __METHOD__ ); + } $nullRevId = $nullRevision->insertOn( $dbw ); $article = new Article( $this ); @@ -3229,7 +3253,7 @@ class Title { # Change the name of the target page: $dbw->update( 'page', /* SET */ array( - 'page_touched' => $dbw->timestamp( $now ), + 'page_touched' => $dbw->timestamp(), 'page_namespace' => $nt->getNamespace(), 'page_title' => $nt->getDBkey(), 'page_latest' => $nullRevId, @@ -3271,103 +3295,17 @@ class Title { # Log the move $log = new LogPage( 'move' ); - $log->addEntry( 'move_redir', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) ); - - # Purge squid - if ( $wgUseSquid ) { - $urls = array_merge( $nt->getSquidURLs(), $this->getSquidURLs() ); - $u = new SquidUpdate( $urls ); - $u->doUpdate(); - } - - } - - /** - * Move page to non-existing title. - * - * @param $nt \type{Title} the new Title - * @param $reason \type{\string} The reason for the move - * @param $createRedirect \type{\bool} Whether to create a redirect from the old title to the new title - * Ignored if the user doesn't have the suppressredirect right - */ - private function moveToNewTitle( &$nt, $reason = '', $createRedirect = true ) { - global $wgUser, $wgContLang; - - $comment = wfMsgForContent( '1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() ); - if ( $reason ) { - $comment .= wfMsgExt( 'colon-separator', - array( 'escapenoentities', 'content' ) ); - $comment .= $reason; - } - # Truncate for whole multibyte characters. +5 bytes for ellipsis - $comment = $wgContLang->truncate( $comment, 250 ); - - $oldid = $this->getArticleID(); - $latest = $this->getLatestRevId(); - - $dbw = wfGetDB( DB_MASTER ); - $now = $dbw->timestamp(); - - # Save a null revision in the page's history notifying of the move - $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true ); - if ( !is_object( $nullRevision ) ) { - throw new MWException( 'No valid null revision produced in ' . __METHOD__ ); - } - $nullRevId = $nullRevision->insertOn( $dbw ); - - $article = new Article( $this ); - wfRunHooks( 'NewRevisionFromEditComplete', array( $article, $nullRevision, $latest, $wgUser ) ); - - # Rename page entry - $dbw->update( 'page', - /* SET */ array( - 'page_touched' => $now, - 'page_namespace' => $nt->getNamespace(), - 'page_title' => $nt->getDBkey(), - 'page_latest' => $nullRevId, - ), - /* WHERE */ array( 'page_id' => $oldid ), - __METHOD__ - ); - $nt->resetArticleID( $oldid ); - - if ( $createRedirect || !$wgUser->isAllowed( 'suppressredirect' ) ) { - # Insert redirect - $mwRedir = MagicWord::get( 'redirect' ); - $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $nt->getPrefixedText() . "]]\n"; - $redirectArticle = new Article( $this ); - $newid = $redirectArticle->insertOn( $dbw ); - $redirectRevision = new Revision( array( - 'page' => $newid, - 'comment' => $comment, - 'text' => $redirectText ) ); - $redirectRevision->insertOn( $dbw ); - $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 ); - - wfRunHooks( 'NewRevisionFromEditComplete', array( $redirectArticle, $redirectRevision, false, $wgUser ) ); + $logType = ( $moveOverRedirect ? 'move_redir' : 'move' ); + $log->addEntry( $logType, $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) ); - # Record the just-created redirect's linking to the page - $dbw->insert( 'pagelinks', - array( - 'pl_from' => $newid, - 'pl_namespace' => $nt->getNamespace(), - 'pl_title' => $nt->getDBkey() ), - __METHOD__ ); - $redirectSuppressed = false; + # Purge caches for old and new titles + if ( $moveOverRedirect ) { + # A simple purge is enough when moving over a redirect + $nt->purgeSquid(); } else { - $this->resetArticleID( 0 ); - $redirectSuppressed = true; + # Purge caches as per article creation, including any pages that link to this title + Article::onArticleCreate( $nt ); } - - # Log the move - $log = new LogPage( 'move' ); - $log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) ); - - # Purge caches as per article creation - Article::onArticleCreate( $nt ); - - # Purge old title from squid - # The new title, and links to the new title, are purged in Article::onArticleCreate() $this->purgeSquid(); } @@ -3377,10 +3315,11 @@ class Title { * @param $nt Title Move target * @param $auth bool Whether $wgUser's permissions should be checked * @param $reason string The reason for the move - * @param $createRedirect bool Whether to create redirects from the old subpages to the new ones - * Ignored if the user doesn't have the 'suppressredirect' right + * @param $createRedirect bool Whether to create redirects from the old subpages to + * the new ones Ignored if the user doesn't have the 'suppressredirect' right * @return mixed array with old page titles as keys, and strings (new page titles) or - * arrays (errors) as values, or an error array with numeric indices if no pages were moved + * arrays (errors) as values, or an error array with numeric indices if no pages + * were moved */ public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) { global $wgMaximumMovedPages; @@ -3447,7 +3386,7 @@ class Title { * Checks if this page is just a one-rev redirect. * Adds lock, so don't use just for light purposes. * - * @return \type{\bool} + * @return Bool */ public function isSingleRevRedirect() { $dbw = wfGetDB( DB_MASTER ); @@ -3484,8 +3423,8 @@ class Title { * Checks if $this can be moved to a given Title * - Selects for update, so don't call it unless you mean business * - * @param $nt \type{Title} the new title to check - * @return \type{\bool} TRUE or FALSE + * @param $nt Title the new title to check + * @return Bool */ public function isValidMoveTarget( $nt ) { # Is it an existing file? @@ -3526,7 +3465,7 @@ class Title { /** * Can this title be added to a user's watchlist? * - * @return \type{\bool} TRUE or FALSE + * @return Bool TRUE or FALSE */ public function isWatchable() { return !$this->isExternal() && MWNamespace::isWatchable( $this->getNamespace() ); @@ -3536,24 +3475,29 @@ class Title { * Get categories to which this Title belongs and return an array of * categories' names. * - * @return \type{\array} array an array of parents in the form: - * $parent => $currentarticle + * @return Array of parents in the form: + * $parent => $currentarticle */ public function getParentCategories() { global $wgContLang; - $titlekey = $this->getArticleId(); - $dbr = wfGetDB( DB_SLAVE ); - $categorylinks = $dbr->tableName( 'categorylinks' ); + $data = array(); - # NEW SQL - $sql = "SELECT * FROM $categorylinks" - . " WHERE cl_from='$titlekey'" - . " AND cl_from <> '0'" - . " ORDER BY cl_sortkey"; + $titleKey = $this->getArticleId(); - $res = $dbr->query( $sql ); - $data = array(); + if ( $titleKey === 0 ) { + return $data; + } + + $dbr = wfGetDB( DB_SLAVE ); + + $res = $dbr->select( 'categorylinks', '*', + array( + 'cl_from' => $titleKey, + ), + __METHOD__, + array() + ); if ( $dbr->numRows( $res ) > 0 ) { foreach ( $res as $row ) { @@ -3567,8 +3511,8 @@ class Title { /** * Get a tree of parent categories * - * @param $children \type{\array} an array with the children in the keys, to check for circular refs - * @return \type{\array} Tree of parent categories + * @param $children Array with the children in the keys, to check for circular refs + * @return Array Tree of parent categories */ public function getParentCategoryTree( $children = array() ) { $stack = array(); @@ -3591,12 +3535,11 @@ class Title { return $stack; } - /** * Get an associative array for selecting this title from * the "page" table * - * @return \type{\array} Selection array + * @return Array suitable for the $where parameter of DB::select() */ public function pageCond() { if ( $this->mArticleID > 0 ) { @@ -3610,9 +3553,9 @@ class Title { /** * Get the revision ID of the previous revision * - * @param $revId \type{\int} Revision ID. Get the revision that was before this one. - * @param $flags \type{\int} Title::GAID_FOR_UPDATE - * @return \twotypes{\int,\bool} Old revision ID, or FALSE if none exists + * @param $revId Int Revision ID. Get the revision that was before this one. + * @param $flags Int Title::GAID_FOR_UPDATE + * @return Int|Bool Old revision ID, or FALSE if none exists */ public function getPreviousRevisionID( $revId, $flags = 0 ) { $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); @@ -3629,9 +3572,9 @@ class Title { /** * Get the revision ID of the next revision * - * @param $revId \type{\int} Revision ID. Get the revision that was after this one. - * @param $flags \type{\int} Title::GAID_FOR_UPDATE - * @return \twotypes{\int,\bool} Next revision ID, or FALSE if none exists + * @param $revId Int Revision ID. Get the revision that was after this one. + * @param $flags Int Title::GAID_FOR_UPDATE + * @return Int|Bool Next revision ID, or FALSE if none exists */ public function getNextRevisionID( $revId, $flags = 0 ) { $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); @@ -3648,8 +3591,8 @@ class Title { /** * Get the first revision of the page * - * @param $flags \type{\int} Title::GAID_FOR_UPDATE - * @return Revision (or NULL if page doesn't exist) + * @param $flags Int Title::GAID_FOR_UPDATE + * @return Revision|Null if page doesn't exist */ public function getFirstRevision( $flags = 0 ) { $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); @@ -3700,25 +3643,48 @@ class Title { * Get the number of revisions between the given revision IDs. * Used for diffs and other things that really need it. * - * @param $old \type{\int} Revision ID. - * @param $new \type{\int} Revision ID. - * @return \type{\int} Number of revisions between these IDs. + * @param $old Int Revision ID. + * @param $new Int Revision ID. + * @return Int Number of revisions between these IDs. */ public function countRevisionsBetween( $old, $new ) { $dbr = wfGetDB( DB_SLAVE ); - return (int)$dbr->selectField( 'revision', 'count(*)', - 'rev_page = ' . intval( $this->getArticleId() ) . - ' AND rev_id > ' . intval( $old ) . - ' AND rev_id < ' . intval( $new ), - __METHOD__ + return (int)$dbr->selectField( 'revision', 'count(*)', array( + 'rev_page' => intval( $this->getArticleId() ), + 'rev_id > ' . intval( $old ), + 'rev_id < ' . intval( $new ) + ), __METHOD__ + ); + } + + /** + * Get the number of authors between the given revision IDs. + * Used for diffs and other things that really need it. + * + * @param $fromRevId Int Revision ID (first before range) + * @param $toRevId Int Revision ID (first after range) + * @param $limit Int Maximum number of authors + * @param $flags Int Title::GAID_FOR_UPDATE + * @return Int + */ + public function countAuthorsBetween( $fromRevId, $toRevId, $limit, $flags = 0 ) { + $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); + $res = $db->select( 'revision', 'DISTINCT rev_user_text', + array( + 'rev_page' => $this->getArticleID(), + 'rev_id > ' . (int)$fromRevId, + 'rev_id < ' . (int)$toRevId + ), __METHOD__, + array( 'LIMIT' => $limit ) ); + return (int)$db->numRows( $res ); } /** * Compare with another title. * - * @param $title \type{Title} - * @return \type{\bool} TRUE or FALSE + * @param $title Title + * @return Bool */ public function equals( Title $title ) { // Note: === is necessary for proper matching of number-like titles. @@ -3743,7 +3709,7 @@ class Title { /** * Return a string representation of this title * - * @return \type{\string} String representation of this title + * @return String representation of this title */ public function __toString() { return $this->getPrefixedText(); @@ -3756,7 +3722,7 @@ class Title { * If you want to know if a title can be meaningfully viewed, you should * probably call the isKnown() method instead. * - * @return \type{\bool} + * @return Bool */ public function exists() { return $this->getArticleId() != 0; @@ -3776,7 +3742,7 @@ class Title { * existing code, but we might want to add an optional parameter to skip * it and any other expensive checks.) * - * @return \type{\bool} + * @return Bool */ public function isAlwaysKnown() { if ( $this->mInterwiki != '' ) { @@ -3785,17 +3751,21 @@ class Title { switch( $this->mNamespace ) { case NS_MEDIA: case NS_FILE: - return (bool)wfFindFile( $this ); // file exists, possibly in a foreign repo + // file exists, possibly in a foreign repo + return (bool)wfFindFile( $this ); case NS_SPECIAL: - return SpecialPage::exists( $this->getDBkey() ); // valid special page + // valid special page + return SpecialPage::exists( $this->getDBkey() ); case NS_MAIN: - return $this->mDbkeyform == ''; // selflink, possibly with fragment + // selflink, possibly with fragment + return $this->mDbkeyform == ''; case NS_MEDIAWIKI: // If the page is form Mediawiki:message/lang, calling wfMsgWeirdKey causes // the full l10n of that language to be loaded. That takes much memory and // isn't needed. So we strip the language part away. list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform, 2 ); - return (bool)wfMsgWeirdKey( $basename ); // known system message + // known system message + return (bool)wfMsgWeirdKey( $basename ); default: return false; } @@ -3807,7 +3777,7 @@ class Title { * links to the title should be rendered as "bluelinks" (as opposed to * "redlinks" to non-existent pages). * - * @return \type{\bool} + * @return Bool */ public function isKnown() { return $this->isAlwaysKnown() || $this->exists(); @@ -3839,7 +3809,7 @@ class Title { /** * Is this in a namespace that allows actual pages? * - * @return \type{\bool} + * @return Bool * @internal note -- uses hardcoded namespace index instead of constants */ public function canExist() { @@ -3865,7 +3835,7 @@ class Title { * Get the last touched timestamp * * @param $db DatabaseBase: optional db - * @return \type{\string} Last touched timestamp + * @return String last-touched timestamp */ public function getTouched( $db = null ) { $db = isset( $db ) ? $db : wfGetDB( DB_SLAVE ); @@ -3877,7 +3847,7 @@ class Title { * Get the timestamp when this page was updated since the user last saw it. * * @param $user User - * @return Mixed: string/null + * @return String|Null */ public function getNotificationTimestamp( $user = null ) { global $wgUser, $wgShowUpdatedMarker; @@ -3912,7 +3882,7 @@ class Title { /** * Get the trackback URL for this page * - * @return \type{\string} Trackback URL + * @return String Trackback URL */ public function trackbackURL() { global $wgScriptPath, $wgServer, $wgScriptExtension; @@ -3924,7 +3894,7 @@ class Title { /** * Get the trackback RDF for this page * - * @return \type{\string} Trackback RDF + * @return String Trackback RDF */ public function trackbackRDF() { $url = htmlspecialchars( $this->getFullURL() ); @@ -3953,7 +3923,7 @@ class Title { * Generate strings used for xml 'id' names in monobook tabs * * @param $prepend string defaults to 'nstab-' - * @return \type{\string} XML 'id' name + * @return String XML 'id' name */ public function getNamespaceKey( $prepend = 'nstab-' ) { global $wgContLang; @@ -3992,7 +3962,7 @@ class Title { /** * Returns true if this title resolves to the named special page * - * @param $name \type{\string} The special page name + * @param $name String The special page name * @return boolean */ public function isSpecial( $name ) { @@ -4006,10 +3976,10 @@ class Title { } /** - * If the Title refers to a special page alias which is not the local default, + * If the Title refers to a special page alias which is not the local default, resolve + * the alias, and localise the name as necessary. Otherwise, return $this * - * @return \type{Title} A new Title which points to the local default. - * Otherwise, returns $this. + * @return Title */ public function fixSpecialName() { if ( $this->getNamespace() == NS_SPECIAL ) { @@ -4029,7 +3999,7 @@ class Title { * In other words, is this a content page, for the purposes of calculating * statistics, etc? * - * @return \type{\bool} + * @return Boolean */ public function isContentPage() { return MWNamespace::isContent( $this->getNamespace() ); @@ -4038,9 +4008,8 @@ class Title { /** * Get all extant redirects to this Title * - * @param $ns \twotypes{\int,\null} Single namespace to consider; - * NULL to consider all namespaces - * @return \type{\arrayof{Title}} Redirects to this title + * @param $ns Int|Null Single namespace to consider; NULL to consider all namespaces + * @return Array of Title redirects to this title */ public function getRedirectsHere( $ns = null ) { $redirs = array(); @@ -4071,7 +4040,7 @@ class Title { /** * Check if this Title is a valid redirect target * - * @return \type{\bool} + * @return Bool */ public function isValidRedirectTarget() { global $wgInvalidRedirectTargets; @@ -4103,8 +4072,7 @@ class Title { } /** - * Whether the magic words __INDEX__ and __NOINDEX__ function for - * this page. + * Whether the magic words __INDEX__ and __NOINDEX__ function for this page. * * @return Boolean */ @@ -4126,20 +4094,21 @@ class Title { */ public function getRestrictionTypes() { global $wgRestrictionTypes; + $types = $this->exists() ? $wgRestrictionTypes : array( 'create' ); - if ( $this->getNamespace() == NS_FILE ) { - $types[] = 'upload'; + if ( $this->getNamespace() != NS_FILE ) { + $types = array_diff( $types, array( 'upload' ) ); } - + wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) ); - + return $types; } /** * Returns the raw sort key to be used for categories, with the specified - * prefix. This will be fed to Language::convertToSortkey() to get a + * prefix. This will be fed to Collation::getSortKey() to get a * binary sortkey that can be used for actual sorting. * * @param $prefix string The prefix to be used, specified using @@ -4150,10 +4119,12 @@ class Title { public function getCategorySortkey( $prefix = '' ) { $unprefixed = $this->getText(); if ( $prefix !== '' ) { - # Separate with a null byte, so the unprefixed part is only used as - # a tiebreaker when two pages have the exact same prefix -- null - # sorts before everything else (hopefully). - return "$prefix\0$unprefixed"; + # Separate with a line feed, so the unprefixed part is only used as + # a tiebreaker when two pages have the exact same prefix. + # In UCA, tab is the only character that can sort above LF + # so we strip both of them from the original prefix. + $prefix = strtr( $prefix, "\n\t", ' ' ); + return "$prefix\n$unprefixed"; } return $unprefixed; }