X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;ds=sidebyside;f=includes%2FTitle.php;h=3a4c3fe657a4126da28472e3467903e0c6bbb0a6;hb=e514478ba52bbae35955dc9b23e9a015aa86cdaf;hp=ca4c35e8755ba96a15ae0d92fea2842ed95e9ab5;hpb=c4254794169d791deb451a8d993071806a70dc65;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/Title.php b/includes/Title.php index ca4c35e875..3a4c3fe657 100644 --- a/includes/Title.php +++ b/includes/Title.php @@ -4,21 +4,6 @@ * @file */ -/** - * @todo: determine if it is really necessary to load this. Appears to be left over from pre-autoloader versions, and - * is only really needed to provide access to constant UTF8_REPLACEMENT, which actually resides in UtfNormalDefines.php - * and is loaded by UtfNormalUtil.php, which is loaded by UtfNormal.php. - */ -if ( !class_exists( 'UtfNormal' ) ) { - require_once( dirname( __FILE__ ) . '/normal/UtfNormal.php' ); -} - -/** - * @deprecated This used to be a define, but was moved to - * Title::GAID_FOR_UPDATE in 1.17. This will probably be removed in 1.18 - */ -define( 'GAID_FOR_UPDATE', Title::GAID_FOR_UPDATE ); - /** * Represents a title within MediaWiki. * Optionally may contain an interwiki designation or namespace. @@ -41,7 +26,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,11 +57,11 @@ 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 - # Zero except in {{transclusion}} tags + # Zero except in {{transclusion}} tags var $mWatched = null; // /< Is $wgUser watching this page? null if unfilled, accessed through userIsWatching() var $mLength = -1; // /< The page length, 0 for special pages var $mRedirect = null; // /< Is the article at this title a redirect? @@ -87,17 +72,16 @@ class Title { /** * Constructor - * @private */ - /* private */ function __construct() { } + /*protected*/ function __construct() { } /** * 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 +97,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 +122,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 +159,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 +184,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,15 +202,15 @@ 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 ) ) { return array(); } $dbr = wfGetDB( DB_SLAVE ); - + $res = $dbr->select( 'page', array( @@ -249,8 +231,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 +252,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 +275,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 +294,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' ) ); @@ -342,8 +324,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,15 +338,11 @@ 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; - // are redirects disabled? - if ( $wgMaxRedirects < 1 ) { - return null; - } $title = self::newFromRedirectInternal( $text ); if ( is_null( $title ) ) { return null; @@ -395,10 +373,15 @@ 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 ) { + global $wgMaxRedirects; + if ( $wgMaxRedirects < 1 ) { + //redirects are disabled, so quit early + return null; + } $redir = MagicWord::get( 'redirect' ); $text = trim( $text ); if ( $redir->matchStartAndRemove( $text ) ) { @@ -431,9 +414,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 ); @@ -455,7 +437,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; @@ -466,10 +448,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; @@ -494,11 +475,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; @@ -518,8 +499,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 != '' ) { @@ -533,7 +513,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 == '' ) { @@ -544,10 +524,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 == '' ) { @@ -579,14 +558,14 @@ 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; } @@ -598,7 +577,7 @@ class Title { 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 Integer: Namespace index */ @@ -623,13 +602,20 @@ class Title { return MWNamespace::getCanonicalName( $this->mNamespace ); } } + + if ( $wgContLang->needsGenderDistinction() && + MWNamespace::hasGenderDistinction( $this->mNamespace ) ) { + $gender = GenderCache::singleton()->getGenderOf( $this->getText(), __METHOD__ ); + return $wgContLang->getGenderNsText( $this->mNamespace, $gender ); + } + return $wgContLang->getNsText( $this->mNamespace ); } /** * 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; @@ -638,7 +624,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; @@ -648,7 +634,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; @@ -658,7 +644,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 ) ); @@ -667,20 +653,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 == '' ) { @@ -693,14 +679,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() { @@ -710,7 +696,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() { @@ -723,10 +709,11 @@ 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() ? + // @todo FIXME: Bad usage of empty() ? + if ( empty( $this->mPrefixedText ) ) { $s = $this->prefix( $this->mTextform ); $s = str_replace( '_', ' ', $s ); $this->mPrefixedText = $s; @@ -738,8 +725,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(); @@ -752,7 +738,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 ) ) { @@ -770,7 +756,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 ) ) { @@ -783,7 +769,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(); @@ -794,7 +780,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 ); @@ -809,8 +795,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; @@ -856,8 +842,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; @@ -891,33 +877,25 @@ class Title { $url = str_replace( '$1', $dbkey, $wgArticlePath ); } } else { - global $wgActionPaths; $url = false; - $matches = array(); - if ( !empty( $wgActionPaths ) && - preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) ) - { - $action = urldecode( $matches[2] ); - if ( isset( $wgActionPaths[$action] ) ) { - $query = $matches[1]; - if ( isset( $matches[4] ) ) { - $query .= $matches[4]; - } - $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] ); - if ( $query != '' ) { - $url = wfAppendQuery( $url, $query ); - } - } + + global $wgActionPaths; + if( !empty( $wgActionPaths ) ) { + $url = Title::resolveActionPath( $dbkey, $query ); } + if ( $url === false ) { if ( $query == '-' ) { $query = ''; } - $url = "{$wgScript}?title={$dbkey}&{$query}"; + #$url = "{$wgScript}?title={$dbkey}&{$query}"; + # forge a nice URL (ex: /wiki/Special:Foo?q=1&r=2 ) + $baseurl = str_replace( '$1', $dbkey, $wgArticlePath ); + $url = wfAppendQuery( $baseurl, $query ); } } - // FIXME: this causes breakage in various places when we + // @todo FIXME: This causes breakage in various places when we // actually expected a local URL and end up with dupe prefixes. if ( $wgRequest->getVal( 'action' ) == 'render' ) { $url = $wgServer . $url; @@ -927,6 +905,38 @@ class Title { return $url; } + /** + * Helper for getLocalUrl() to handles $wgActionPaths + * + * @param $dbkey string Title in database key format + * @param $query string request parameters in CGI format (p=1&q=2&..) + * @return Url resolved or boolean false + */ + private static function resolveActionPath( $dbkey, $query ) { + $url = ''; + + # query parameters are easier to handle using an array: + $queryArray = wfCGIToArray( $query ); + + global $wgActionPaths; + if( !array_key_exists( 'action', $queryArray ) ) { + // Makes the default action 'view' and points to $wgArticlePath + // @todo FIXME: This should be handled in Setup or Wiki! + global $wgArticlePath; + $url = str_replace( '$1', $dbkey, $wgArticlePath ); + } elseif( isset( $wgActionPaths[$queryArray['action']] ) ) { + $url = str_replace( '$1', $dbkey, $wgActionPaths[$queryArray['action']] ); + } else { + # No path found + return false; + } + + # No need to append the action since we have embed it in the path + unset( $queryArray['action'] ); + $url = wfAppendQuery( $url, wfArrayToCGI( $queryArray ) ); + return $url; + } + /** * Get a URL that's the simplest URL that will be valid to link, locally, * to the current Title. It includes the fragment, but does not include @@ -937,12 +947,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__ ); @@ -961,8 +971,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 ) ); @@ -972,8 +982,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 ) ); @@ -984,13 +994,14 @@ 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; - $url = $wgInternalServer . $this->getLocalURL( $query, $variant ); + global $wgInternalServer, $wgServer; + $server = $wgInternalServer !== false ? $wgInternalServer : $wgServer; + $url = $server . $this->getLocalURL( $query, $variant ); wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) ); return $url; } @@ -998,7 +1009,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() { @@ -1014,7 +1025,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() ); @@ -1023,7 +1034,7 @@ class Title { /** * Is this Title interwiki? * - * @return \type{\bool} + * @return Bool */ public function isExternal() { return ( $this->mInterwiki != '' ); @@ -1032,8 +1043,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() ) { @@ -1058,9 +1069,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; @@ -1090,7 +1101,7 @@ class Title { /** * Is this a conversion table for the LanguageConverter? * - * @return \type{\bool} + * @return Bool */ public function isConversionTable() { if( @@ -1107,7 +1118,7 @@ class Title { /** * Is $wgUser watching this page? * - * @return \type{\bool} + * @return Bool */ public function userIsWatching() { global $wgUser; @@ -1132,8 +1143,8 @@ 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 ); @@ -1144,7 +1155,7 @@ class Title { * by $wgNamespaceProtection. * * @param $user User object, $wgUser will be used if not passed - * @return \type{\bool} + * @return Bool */ public function isNamespaceProtected( User $user = null ) { global $wgNamespaceProtection; @@ -1167,9 +1178,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; @@ -1179,13 +1190,14 @@ class Title { /** * Can $user perform $action on this page? * - * FIXME: This *does not* check throttles (User::pingLimiter()). + * @todo 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 by + * skipping checks for cascading protections and user blocks. + * @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 ); @@ -1434,9 +1446,9 @@ class Title { /** * Check restrictions on cascading pages. - * + * * @param $action String the action to check - * @param $user User user 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 @@ -1475,7 +1487,7 @@ class Title { * Check action permissions not already checked in checkQuickPermissions * * @param $action String the action to check - * @param $user User user 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 @@ -1521,7 +1533,7 @@ class Title { * Check that the user isn't blocked from editting. * * @param $action String the action to check - * @param $user User user 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 @@ -1529,7 +1541,7 @@ class Title { * @return Array list of errors */ private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) { - if( $short && count( $errors ) > 0 ) { + if( !$doExpensiveQueries ) { return $errors; } @@ -1539,8 +1551,14 @@ class Title { $errors[] = array( 'confirmedittext' ); } - // Edit blocks should not affect reading. Account creation blocks handled at userlogin. - if ( $action != 'read' && $action != 'createaccount' && $user->isBlockedFrom( $this ) ) { + if ( in_array( $action, array( 'read', 'createaccount', 'unblock' ) ) ){ + // Edit blocks should not affect reading. + // Account creation blocks handled at userlogin. + // Unblocking handled in SpecialUnblock + } elseif( ( $action == 'edit' || $action == 'create' ) && !$user->isBlockedFrom( $this ) ){ + // Don't block the user from editing their own talk page unless they've been + // explicitly blocked from that too. + } elseif( $user->isBlocked() && $user->mBlock->prevents( $action ) !== false ) { $block = $user->mBlock; // This is from OutputPage::blockedPage @@ -1560,29 +1578,16 @@ class Title { } $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]"; - $blockid = $block->mId; + $blockid = $block->getId(); $blockExpiry = $user->mBlock->mExpiry; $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW, $user->mBlock->mTimestamp ), true ); if ( $blockExpiry == 'infinity' ) { - // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite' - $scBlockExpiryOptions = wfMsg( 'ipboptions' ); - - foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) { - if ( !strpos( $option, ':' ) ) - continue; - - list( $show, $value ) = explode( ':', $option ); - - if ( $value == 'infinite' || $value == 'indefinite' ) { - $blockExpiry = $show; - break; - } - } + $blockExpiry = wfMessage( 'infiniteblock' )->text(); } else { $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW, $blockExpiry ), true ); } - $intended = $user->mBlock->mAddress; + $intended = strval( $user->mBlock->getTarget() ); $errors[] = array( ( $block->mAuto ? 'autoblockedtext' : 'blockedtext' ), $link, $reason, $ip, $name, $blockid, $blockExpiry, $intended, $blockTimestamp ); @@ -1596,11 +1601,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__ ); @@ -1629,8 +1634,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() { @@ -1656,16 +1662,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 ) { @@ -1681,10 +1683,10 @@ class Title { $dbw = wfGetDB( DB_MASTER ); - $encodedExpiry = Block::encodeExpiry( $expiry, $dbw ); + $encodedExpiry = $dbw->encodeExpiry( $expiry ); $expiry_description = ''; - if ( $encodedExpiry != 'infinity' ) { + if ( $encodedExpiry != $dbw->getInfinity() ) { $expiry_description = ' (' . wfMsgForContent( 'protect-expiring', $wgContLang->timeanddate( $expiry ), $wgContLang->date( $expiry ) , $wgContLang->time( $expiry ) ) . ')'; } else { @@ -1693,22 +1695,22 @@ 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, - 'pt_timestamp' => Block::encodeExpiry( wfTimestampNow(), $dbw ), + 'pt_timestamp' => $dbw->encodeExpiry( wfTimestampNow() ), '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() ) { @@ -1736,14 +1738,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() == ''; @@ -1752,7 +1754,7 @@ class Title { /** * Can $wgUser read this page? * - * @return \type{\bool} + * @return Bool * @todo fold these checks into userCan() */ public function userCanRead() { @@ -1768,7 +1770,7 @@ class Title { # Not a public wiki, so no shortcut $useShortcut = false; } elseif ( !empty( $wgRevokePermissions ) ) { - /* + /** * Iterate through each group with permissions being revoked (key not included since we don't care * what the group name is), then check if the read permission is being revoked. If it is, then * we don't use the shortcut below since the user might not be able to read, even though anon @@ -1800,47 +1802,36 @@ class Title { } else { global $wgWhitelistRead; - /** - * Always grant access to the login page. - * Even anons need to be able to log in. - */ - if ( $this->isSpecial( 'Userlogin' ) || $this->isSpecial( 'Resetpass' ) ) { + # Always grant access to the login page. + # Even anons need to be able to log in. + if ( $this->isSpecial( 'Userlogin' ) || $this->isSpecial( 'ChangePassword' ) ) { 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 ); + list( $name, /* $subpage */ ) = SpecialPageFactory::resolveAlias( $name ); if ( $name === false ) { # Invalid special page, but we show standard login required message return false; @@ -1856,10 +1847,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() ); @@ -1868,7 +1872,7 @@ class Title { /** * Is this a subpage? * - * @return \type{\bool} + * @return Bool */ public function isSubpage() { return MWNamespace::hasSubpages( $this->mNamespace ) @@ -1879,7 +1883,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 ) ) { @@ -1905,7 +1909,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 */ @@ -1935,7 +1939,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 @@ -1944,7 +1948,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 ) ); @@ -1953,8 +1957,8 @@ class Title { /** * Is this a *valid* .css or .js subpage of a user page? * - * @return \type{\bool} - * @deprecated + * @return Bool + * @deprecated since 1.17 */ public function isValidCssJsSubpage() { return $this->isCssJsSubpage(); @@ -1974,7 +1978,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 ) ); @@ -1983,7 +1987,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 ) ); @@ -1993,12 +1997,12 @@ 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() { global $wgUser; - return ( ( $wgUser->isAllowed( 'editusercssjs' ) && $wgUser->isAllowed( 'editusercss' ) ) + return ( ( $wgUser->isAllowedAll( 'editusercssjs', 'editusercss' ) ) || preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform ) ); } @@ -2006,19 +2010,19 @@ 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() { global $wgUser; - return ( ( $wgUser->isAllowed( 'editusercssjs' ) && $wgUser->isAllowed( 'edituserjs' ) ) - || preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform ) ); + return ( ( $wgUser->isAllowedAll( 'editusercssjs', 'edituserjs' ) ) + || preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform ) ); } /** * 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 ); @@ -2028,15 +2032,15 @@ 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 ) { + global $wgContLang; $pagerestrictions = array(); if ( isset( $this->mCascadeSources ) && $getPages ) { @@ -2082,7 +2086,7 @@ class Title { $purgeExpired = false; foreach ( $res as $row ) { - $expiry = Block::decodeExpiry( $row->pr_expiry ); + $expiry = $wgContLang->formatExpiry( $row->pr_expiry, TS_MW ); if ( $expiry > $now ) { if ( $getPages ) { $page_id = $row->pr_page; @@ -2110,11 +2114,8 @@ class Title { } if ( $purgeExpired ) { Title::purgeExpiredRestrictions(); - $this->invalidateTitleProtectionCache(); } - wfProfileOut( __METHOD__ ); - if ( $getPages ) { $this->mCascadeSources = $sources; $this->mCascadingRestrictions = $pagerestrictions; @@ -2122,6 +2123,7 @@ class Title { $this->mHasCascadingRestrictions = $sources; } + wfProfileOut( __METHOD__ ); return array( $sources, $pagerestrictions ); } @@ -2141,8 +2143,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 ) { @@ -2157,20 +2159,22 @@ 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 * restrictions from page table (pre 1.10) */ public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) { + global $wgContLang; $dbr = wfGetDB( DB_SLAVE ); $restrictionTypes = $this->getRestrictionTypes(); foreach ( $restrictionTypes as $type ) { $this->mRestrictions[$type] = array(); - $this->mRestrictionsExpiry[$type] = Block::decodeExpiry( '' ); + $this->mRestrictionsExpiry[$type] = $wgContLang->formatExpiry( '', TS_MW ); } $this->mCascadeRestriction = false; @@ -2204,17 +2208,16 @@ 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; // This code should be refactored, now that it's being used more generally, // But I don't really see any harm in leaving it in Block for now -werdna - $expiry = Block::decodeExpiry( $row->pr_expiry ); + $expiry = $wgContLang->formatExpiry( $row->pr_expiry, TS_MW ); // Only apply the restrictions if they haven't expired! if ( !$expiry || $expiry > $now ) { @@ -2230,7 +2233,6 @@ class Title { if ( $purgeExpired ) { Title::purgeExpiredRestrictions(); - $this->invalidateTitleProtectionCache(); } } @@ -2240,16 +2242,21 @@ 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 ) { + global $wgContLang; if ( !$this->mRestrictionsLoaded ) { if ( $this->exists() ) { $dbr = wfGetDB( DB_SLAVE ); - $res = $dbr->select( 'page_restrictions', '*', - array( 'pr_page' => $this->getArticleId() ), __METHOD__ ); + $res = $dbr->select( + 'page_restrictions', + '*', + array( 'pr_page' => $this->getArticleId() ), + __METHOD__ + ); $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions ); } else { @@ -2257,7 +2264,7 @@ class Title { if ( $title_protection ) { $now = wfTimestampNow(); - $expiry = Block::decodeExpiry( $title_protection['pt_expiry'] ); + $expiry = $wgContLang->formatExpiry( $title_protection['pt_expiry'], TS_MW ); if ( !$expiry || $expiry > $now ) { // Apply the restrictions @@ -2265,10 +2272,10 @@ 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( '' ); + $this->mRestrictionsExpiry['create'] = $wgContLang->formatExpiry( '', TS_MW ); } $this->mRestrictionsLoaded = true; } @@ -2296,8 +2303,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 ) { @@ -2311,7 +2318,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 ) { @@ -2324,7 +2331,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 ) { @@ -2372,9 +2379,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 ) { @@ -2398,8 +2405,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 ) ) { @@ -2419,8 +2426,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{\int} + * @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 ) { @@ -2439,8 +2446,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 ) { @@ -2464,7 +2471,7 @@ class Title { * 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(); @@ -2485,7 +2492,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() ) { @@ -2506,15 +2513,16 @@ 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 ) { + private function prefix( $name ) { $p = ''; if ( $this->mInterwiki != '' ) { $p = $this->mInterwiki . ':'; } + if ( 0 != $this->mNamespace ) { $p .= $this->getNsText() . ':'; } @@ -2526,7 +2534,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; @@ -2551,7 +2559,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 */ @@ -2574,14 +2582,12 @@ 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; # Initialisation - $rxTc = self::getTitleInvalidRegex(); - $this->mInterwiki = $this->mFragment = ''; $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN @@ -2596,7 +2602,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, '_' ); @@ -2633,9 +2638,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 ) ) { @@ -2651,7 +2658,7 @@ class Title { # Redundant interwiki prefix to the local wiki if ( $wgLocalInterwiki !== false - && 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) ) + && 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) ) { if ( $dbkey == '' ) { # Can't have an empty self-link @@ -2677,13 +2684,12 @@ 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; } $fragment = strstr( $dbkey, '#' ); if ( false !== $fragment ) { - $this->setFragment( preg_replace( '/^#_*/', '#', $fragment ) ); + $this->setFragment( $fragment ); $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) ); # remove whitespace again: prevents "Foo_bar_#" # becoming "Foo_bar_" @@ -2691,79 +2697,65 @@ class Title { } # Reject illegal characters. - # + $rxTc = self::getTitleInvalidRegex(); 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 || - strpos( $dbkey, '../' ) === 0 || - strpos( $dbkey, '/./' ) !== false || - strpos( $dbkey, '/../' ) !== false || - substr( $dbkey, -2 ) == '/.' || - substr( $dbkey, -3 ) == '/..' ) ) + ( $dbkey === '.' || $dbkey === '..' || + strpos( $dbkey, './' ) === 0 || + strpos( $dbkey, '../' ) === 0 || + strpos( $dbkey, '/./' ) !== false || + strpos( $dbkey, '/../' ) !== false || + substr( $dbkey, -2 ) == '/.' || + substr( $dbkey, -3 ) == '/..' ) ) { 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; @@ -2786,7 +2778,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 ) ); @@ -2826,7 +2818,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(); @@ -2869,7 +2861,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' ); @@ -2879,7 +2871,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 ) { @@ -2916,7 +2908,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; @@ -2952,8 +2944,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 ); @@ -2963,11 +2955,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; @@ -2999,28 +2991,13 @@ class Title { } if ( ( $this->getDBkey() == '' ) || ( !$oldid ) || - ( $nt->getDBkey() == '' ) ) { + ( $nt->getDBkey() == '' ) ) { $errors[] = array( 'badarticleerror' ); } // Image-specific checks if ( $this->getNamespace() == NS_FILE ) { - if ( $nt->getNamespace() != NS_FILE ) { - $errors[] = array( 'imagenocrossnamespace' ); - } - $file = wfLocalFile( $this ); - if ( $file->exists() ) { - if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) { - $errors[] = array( 'imageinvalidfilename' ); - } - if ( !File::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) { - $errors[] = array( 'imagetypemismatch' ); - } - } - $destfile = wfLocalFile( $nt ); - if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destfile->exists() && wfFindFile( $nt ) ) { - $errors[] = array( 'file-exists-sharedrepo' ); - } + $errors = array_merge( $errors, $this->validateFileMoveOperation( $nt ) ); } if ( $nt->getNamespace() == NS_FILE && $this->getNamespace() != NS_FILE ) { @@ -3067,26 +3044,57 @@ class Title { return $errors; } + /** + * Check if the requested move target is a valid file move target + * @param Title $nt Target title + * @return array List of errors + */ + protected function validateFileMoveOperation( $nt ) { + global $wgUser; + + $errors = array(); + + if ( $nt->getNamespace() != NS_FILE ) { + $errors[] = array( 'imagenocrossnamespace' ); + } + + $file = wfLocalFile( $this ); + if ( $file->exists() ) { + if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) { + $errors[] = array( 'imageinvalidfilename' ); + } + if ( !File::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) { + $errors[] = array( 'imagetypemismatch' ); + } + } + + $destFile = wfLocalFile( $nt ); + if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destFile->exists() && wfFindFile( $nt ) ) { + $errors[] = array( 'file-exists-sharedrepo' ); + } + + return $errors; + } + /** * 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 ); @@ -3098,13 +3106,16 @@ class Title { } } - $pageid = $this->getArticleID(); + $dbw->begin(); # If $file was a LocalFile, its transaction would have closed our own. + $pageid = $this->getArticleID( self::GAID_FOR_UPDATE ); $protected = $this->isProtected(); $pageCountChange = ( $createRedirect ? 1 : 0 ) - ( $nt->exists() ? 1 : 0 ); // Do the actual move $err = $this->moveToInternal( $nt, $reason, $createRedirect ); if ( is_array( $err ) ) { + # @todo FIXME: What about the File we have already moved? + $dbw->rollback(); return $err; } @@ -3112,18 +3123,26 @@ class Title { // Refresh the sortkey for this row. Be careful to avoid resetting // cl_timestamp, which may disturb time-based lists on some sites. - $prefix = $dbw->selectField( + $prefixes = $dbw->select( 'categorylinks', - 'cl_sortkey_prefix', + array( 'cl_sortkey_prefix', 'cl_to' ), array( 'cl_from' => $pageid ), __METHOD__ ); - $dbw->update( 'categorylinks', - array( - 'cl_sortkey' => $wgContLang->convertToSortkey( $nt->getCategorySortkey( $prefix ) ), - 'cl_timestamp=cl_timestamp' ), - array( 'cl_from' => $pageid ), - __METHOD__ ); + foreach ( $prefixes as $prefixRow ) { + $prefix = $prefixRow->cl_sortkey_prefix; + $catTo = $prefixRow->cl_to; + $dbw->update( 'categorylinks', + array( + 'cl_sortkey' => Collation::singleton()->getSortKey( + $nt->getCategorySortkey( $prefix ) ), + 'cl_timestamp=cl_timestamp' ), + array( + 'cl_from' => $pageid, + 'cl_to' => $catTo ), + __METHOD__ + ); + } if ( $protected ) { # Protect the redirect title as the title used to be... @@ -3146,7 +3165,8 @@ class Title { if ( $reason ) { $comment .= wfMsgForContent( 'colon-separator' ) . $reason; } - $log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) ); // FIXME: $params? + // @todo FIXME: $params? + $log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) ); } # Update watchlists @@ -3165,6 +3185,8 @@ class Title { $u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' ); $u->doUpdate(); + $dbw->commit(); + # Update site_stats if ( $this->isContentPage() && !$nt->isContentPage() ) { # No longer a content page @@ -3185,20 +3207,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; @@ -3210,12 +3231,10 @@ class Title { * 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 - * be a redirect or nonexistent - * @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 moveToInternal( &$nt, $reason = '', $createRedirect = true ) { global $wgUser, $wgContLang; @@ -3228,12 +3247,15 @@ class Title { if ( $reason ) { $comment .= wfMsgForContent( 'colon-separator' ) . $reason; } - # Truncate for whole multibyte characters. +5 bytes for ellipsis - $comment = $wgContLang->truncate( $comment, 250 ); + # Truncate for whole multibyte characters. + $comment = $wgContLang->truncate( $comment, 255 ); $oldid = $this->getArticleID(); $latest = $this->getLatestRevID(); + $oldns = $this->getNamespace(); + $olddbk = $this->getDBkey(); + $dbw = wfGetDB( DB_MASTER ); if ( $moveOverRedirect ) { @@ -3276,9 +3298,6 @@ class Title { } $nullRevId = $nullRevision->insertOn( $dbw ); - $article = new Article( $this ); - wfRunHooks( 'NewRevisionFromEditComplete', array( $article, $nullRevision, $latest, $wgUser ) ); - # Change the name of the target page: $dbw->update( 'page', /* SET */ array( @@ -3292,6 +3311,9 @@ class Title { ); $nt->resetArticleID( $oldid ); + $article = new Article( $nt ); + wfRunHooks( 'NewRevisionFromEditComplete', array( $article, $nullRevision, $latest, $wgUser ) ); + # Recreate the redirect, this time in the other direction. if ( $createRedirect || !$wgUser->isAllowed( 'suppressredirect' ) ) { $mwRedir = MagicWord::get( 'redirect' ); @@ -3318,6 +3340,17 @@ class Title { __METHOD__ ); $redirectSuppressed = false; } else { + // Get rid of old new page entries in Special:NewPages and RC. + // Needs to be before $this->resetArticleID( 0 ). + $dbw->delete( 'recentchanges', array( + 'rc_timestamp' => $dbw->timestamp( $this->getEarliestRevTime() ), + 'rc_namespace' => $oldns, + 'rc_title' => $olddbk, + 'rc_new' => 1 + ), + __METHOD__ + ); + $this->resetArticleID( 0 ); $redirectSuppressed = true; } @@ -3344,10 +3377,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; @@ -3414,7 +3448,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 ); @@ -3451,8 +3485,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? @@ -3493,7 +3527,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() ); @@ -3503,24 +3537,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 ) { @@ -3534,8 +3573,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(); @@ -3558,12 +3597,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 ) { @@ -3577,9 +3615,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 ); @@ -3596,9 +3634,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 ); @@ -3615,69 +3653,72 @@ 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 ); $pageId = $this->getArticleId( $flags ); - if ( !$pageId ) { - return null; - } - $row = $db->selectRow( 'revision', '*', - array( 'rev_page' => $pageId ), - __METHOD__, - array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 ) - ); - if ( !$row ) { - return null; - } else { - return new Revision( $row ); + if ( $pageId ) { + $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); + $row = $db->selectRow( 'revision', '*', + array( 'rev_page' => $pageId ), + __METHOD__, + array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 ) + ); + if ( $row ) { + return new Revision( $row ); + } } + return null; } /** - * Check if this is a new page + * Get the oldest revision timestamp of this page * - * @return bool + * @param $flags Int Title::GAID_FOR_UPDATE + * @return String: MW timestamp */ - public function isNewPage() { - $dbr = wfGetDB( DB_SLAVE ); - return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__ ); + public function getEarliestRevTime( $flags = 0 ) { + $rev = $this->getFirstRevision( $flags ); + return $rev ? $rev->getTimestamp() : null; } /** - * Get the oldest revision timestamp of this page + * Check if this is a new page * - * @return String: MW timestamp + * @return bool */ - public function getEarliestRevTime() { + public function isNewPage() { $dbr = wfGetDB( DB_SLAVE ); - if ( $this->exists() ) { - $min = $dbr->selectField( 'revision', - 'MIN(rev_timestamp)', - array( 'rev_page' => $this->getArticleId() ), - __METHOD__ ); - return wfTimestampOrNull( TS_MW, $min ); - } - return null; + return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__ ); } /** - * Get the number of revisions between the given revision IDs. + * Get the number of revisions between the given revision. * 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 Old revision or rev ID (first before range) + * @param $new int|Revision New revision or rev ID (first after range) + * @return Int Number of revisions between these revisions. */ public function countRevisionsBetween( $old, $new ) { + if ( !( $old instanceof Revision ) ) { + $old = Revision::newFromTitle( $this, (int)$old ); + } + if ( !( $new instanceof Revision ) ) { + $new = Revision::newFromTitle( $this, (int)$new ); + } + if ( !$old || !$new ) { + return 0; // nothing to compare + } $dbr = wfGetDB( DB_SLAVE ); - return (int)$dbr->selectField( 'revision', 'count(*)', array( - 'rev_page' => intval( $this->getArticleId() ), - 'rev_id > ' . intval( $old ), - 'rev_id < ' . intval( $new ) - ), __METHOD__ + return (int)$dbr->selectField( 'revision', 'count(*)', + array( + 'rev_page' => $this->getArticleId(), + 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ), + 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) ) + ), + __METHOD__ ); } @@ -3685,30 +3726,38 @@ class Title { * Get the number of authors between the given revision IDs. * Used for diffs and other things that really need it. * - * @param $fromRevId \type{\int} Revision ID (first before range) - * @param $toRevId \type{\int} Revision ID (first after range) - * @param $limit \type{\int} Maximum number of authors - * @param $flags \type{\int} Title::GAID_FOR_UPDATE - * @return \type{\int} + * @param $old int|Revision Old revision or rev ID (first before range) + * @param $new int|Revision New revision or rev ID (first after range) + * @param $limit Int Maximum number of authors + * @return Int Number of revision authors between these revisions. */ - 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', + public function countAuthorsBetween( $old, $new, $limit ) { + if ( !( $old instanceof Revision ) ) { + $old = Revision::newFromTitle( $this, (int)$old ); + } + if ( !( $new instanceof Revision ) ) { + $new = Revision::newFromTitle( $this, (int)$new ); + } + if ( !$old || !$new ) { + return 0; // nothing to compare + } + $dbr = wfGetDB( DB_SLAVE ); + $res = $dbr->select( 'revision', 'DISTINCT rev_user_text', array( 'rev_page' => $this->getArticleID(), - 'rev_id > ' . (int)$fromRevId, - 'rev_id < ' . (int)$toRevId + 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $old->getTimestamp() ) ), + 'rev_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $new->getTimestamp() ) ) ), __METHOD__, - array( 'LIMIT' => $limit ) + array( 'LIMIT' => $limit + 1 ) // add one so caller knows it was truncated ); - return (int)$db->numRows( $res ); + return (int)$dbr->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. @@ -3719,7 +3768,10 @@ class Title { /** * Callback for usort() to do title sorts by (namespace, title) - * + * + * @param $a Title + * @param $b Title + * * @return Integer: result of string comparison, or namespace comparison */ public static function compare( $a, $b ) { @@ -3733,7 +3785,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(); @@ -3746,7 +3798,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; @@ -3766,7 +3818,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 != '' ) { @@ -3775,17 +3827,17 @@ 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 SpecialPageFactory::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 $this->getDefaultMessageText() !== false; default: return false; } @@ -3797,7 +3849,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(); @@ -3816,20 +3868,38 @@ class Title { if ( $this->mNamespace == NS_MEDIAWIKI ) { // If the page doesn't exist but is a known system message, default // message content will be displayed, same for language subpages - // Also, 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 ); + return $this->getDefaultMessageText() !== false; } return false; } + /** + * Get the default message text or false if the message doesn't exist + * + * @return String or false + */ + public function getDefaultMessageText() { + global $wgContLang; + + if ( $this->getNamespace() != NS_MEDIAWIKI ) { // Just in case + return false; + } + + list( $name, $lang ) = MessageCache::singleton()->figureMessage( $wgContLang->lcfirst( $this->getText() ) ); + $message = wfMessage( $name )->inLanguage( $lang )->useDatabase( false ); + + if ( $message->exists() ) { + return $message->plain(); + } else { + return false; + } + } + /** * 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() { @@ -3855,7 +3925,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 ); @@ -3867,7 +3937,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; @@ -3877,7 +3947,8 @@ class Title { } // Check cache first $uid = $user->getId(); - if ( isset( $this->mNotificationTimestamp[$uid] ) ) { + // avoid isset here, as it'll return false for null entries + if ( array_key_exists( $uid, $this->mNotificationTimestamp ) ) { return $this->mNotificationTimestamp[$uid]; } if ( !$uid || !$wgShowUpdatedMarker ) { @@ -3902,7 +3973,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; @@ -3914,7 +3985,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() ); @@ -3928,8 +3999,8 @@ class Title { // Spec: http://www.sixapart.com/pronet/docs/trackback_spec return "