X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;f=includes%2FTitle.php;h=eeaf20085dd3f2ead23334a8886e40a9aa6437e0;hb=2f933fedbaba602b04de928035cc86639d6c8531;hp=62a083a8f1990acc849c04fe7cd1e744ccb1101b;hpb=0aff6df77b3af5fd4c9ddf0775a81b160200aa8a;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/Title.php b/includes/Title.php index 62a083a8f1..eeaf20085d 100644 --- a/includes/Title.php +++ b/includes/Title.php @@ -13,7 +13,11 @@ if ( !class_exists( 'UtfNormal' ) ) { require_once( dirname( __FILE__ ) . '/normal/UtfNormal.php' ); } -define ( 'GAID_FOR_UPDATE', 1 ); +/** + * @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. @@ -27,7 +31,6 @@ class Title { /** @name Static cache variables */ // @{ static private $titleCache = array(); - static private $interwikiCache = array(); // @} /** @@ -37,6 +40,12 @@ class Title { */ const CACHE_MAX = 1000; + /** + * Used to be GAID_FOR_UPDATE define. Used with getArticleId() and friends + * to use the master DB + */ + const GAID_FOR_UPDATE = 1; + /** * @name Private member variables @@ -63,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 @@ -85,25 +94,26 @@ 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 the new object, or NULL on an error */ public static function newFromDBkey( $key ) { $t = new Title(); $t->mDbkeyform = $key; - if ( $t->secureAndSplit() ) + if ( $t->secureAndSplit() ) { return $t; - else + } else { return null; + } } /** * 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- * fied by a prefix. If you want to force a specific namespace even if @@ -129,7 +139,7 @@ class Title { } /** - * Convert things like é ā or 〗 into normalized(bug 14952) text + * Convert things like é ā or 〗 into normalized (bug 14952) text */ $filteredText = Sanitizer::decodeCharReferencesAndNormalize( $text ); @@ -167,8 +177,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; @@ -192,12 +202,12 @@ 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 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 & GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); + $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); $row = $db->selectRow( 'page', '*', array( 'page_id' => $id ), __METHOD__ ); if ( $row !== false ) { $title = Title::newFromRow( $row ); @@ -210,20 +220,28 @@ 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( 'page_namespace', 'page_title' ), - 'page_id IN (' . $dbr->makeList( $ids ) . ')', __METHOD__ ); + + $res = $dbr->select( + 'page', + array( + 'page_namespace', 'page_title', 'page_id', + 'page_len', 'page_is_redirect', 'page_latest', + ), + array( 'page_id' => $ids ), + __METHOD__ + ); $titles = array(); foreach ( $res as $row ) { - $titles[] = Title::makeTitle( $row->page_namespace, $row->page_title ); + $titles[] = Title::newFromRow( $row ); } return $titles; } @@ -231,8 +249,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 ); @@ -240,7 +258,7 @@ class Title { $t->mArticleID = isset( $row->page_id ) ? intval( $row->page_id ) : -1; $t->mLength = isset( $row->page_len ) ? intval( $row->page_len ) : -1; $t->mRedirect = isset( $row->page_is_redirect ) ? (bool)$row->page_is_redirect : null; - $t->mLatestID = isset( $row->page_latest ) ? $row->page_latest : false; + $t->mLatestID = isset( $row->page_latest ) ? intval( $row->page_latest ) : false; return $t; } @@ -252,14 +270,15 @@ 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 "#") - * @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 = '' ) { + public static function &makeTitle( $ns, $title, $fragment = '', $interwiki = '' ) { $t = new Title(); - $t->mInterwiki = ''; + $t->mInterwiki = $interwiki; $t->mFragment = $fragment; $t->mNamespace = $ns = intval( $ns ); $t->mDbkeyform = str_replace( ' ', '_', $title ); @@ -274,14 +293,15 @@ 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 "#") - * @return \type{Title} the new object, or NULL on an error + * @param $ns Int the namespace of the article + * @param $title String the database key form + * @param $fragment String The link fragment (after the "#") + * @param $interwiki String The interwiki prefix + * @return Title the new object, or NULL on an error */ - public static function makeTitleSafe( $ns, $title, $fragment = '' ) { + public static function makeTitleSafe( $ns, $title, $fragment = '', $interwiki = '' ) { $t = new Title(); - $t->mDbkeyform = Title::makeName( $ns, $title, $fragment ); + $t->mDbkeyform = Title::makeName( $ns, $title, $fragment, $interwiki ); if ( $t->secureAndSplit() ) { return $t; } else { @@ -292,7 +312,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' ) ); @@ -309,8 +329,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 ); @@ -322,8 +342,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 The corresponding Title */ public static function newFromRedirectRecurse( $text ) { $titles = self::newFromRedirectArray( $text ); @@ -336,17 +356,19 @@ 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 ) + if ( $wgMaxRedirects < 1 ) { return null; + } $title = self::newFromRedirectInternal( $text ); - if ( is_null( $title ) ) + if ( is_null( $title ) ) { return null; + } // recursive check to follow double redirects $recurse = $wgMaxRedirects; $titles = array( $title ); @@ -373,8 +395,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 The corresponding Title */ protected static function newFromRedirectInternal( $text ) { $redir = MagicWord::get( 'redirect' ); @@ -389,9 +411,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 @@ -411,18 +431,22 @@ 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 + * @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 ); - $s = $dbr->selectRow( 'page', + $s = $dbr->selectRow( + 'page', array( 'page_namespace', 'page_title' ), array( 'page_id' => $id ), - __METHOD__ ); - if ( $s === false ) { return null; } + __METHOD__ + ); + if ( $s === false ) { + return null; + } $n = self::makeName( $s->page_namespace, $s->page_title ); return $n; @@ -431,7 +455,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; @@ -442,9 +466,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 + * @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 ) { @@ -470,16 +494,20 @@ 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 "#") - * @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 = '' ) { + public static function makeName( $ns, $title, $fragment = '', $interwiki = '' ) { global $wgContLang; $namespace = $wgContLang->getNsText( $ns ); $name = $namespace == '' ? $title : "$namespace:$title"; + if ( strval( $interwiki ) != '' ) { + $name = "$interwiki:$name"; + } if ( strval( $fragment ) != '' ) { $name .= '#' . $fragment; } @@ -490,7 +518,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 + * @return Bool TRUE if this is an in-project interwiki link * or a wikilink, FALSE otherwise */ public function isLocal() { @@ -505,15 +533,30 @@ 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 == '' ) + if ( $this->mInterwiki == '' ) { return false; + } return Interwiki::fetch( $this->mInterwiki )->isTranscludable(); } + /** + * Returns the DB name of the distant wiki + * which owns the object. + * + * @return String the DB name + */ + public function getTransWikiID() { + if ( $this->mInterwiki == '' ) { + return false; + } + + return Interwiki::fetch( $this->mInterwiki )->getWikiID(); + } + /** * Escape a text fragment, say from a link, for a URL * @@ -536,35 +579,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. * - * @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; @@ -586,7 +629,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; @@ -595,7 +638,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; @@ -605,7 +648,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; @@ -615,7 +658,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 ) ); @@ -624,20 +667,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 == '' ) { @@ -650,14 +693,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() { @@ -667,7 +710,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() { @@ -680,7 +723,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() ? @@ -695,7 +738,7 @@ class Title { * Get the prefixed title with spaces, plus any fragment * (part beginning with '#') * - * @return \type{\string} the prefixed title, with spaces and + * @return String the prefixed title, with spaces and * the fragment, including '#' */ public function getFullText() { @@ -709,7 +752,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 ) ) { @@ -718,28 +761,29 @@ class Title { $parts = explode( '/', $this->getText() ); # Don't discard the real title if there's no subpage involved - if ( count( $parts ) > 1 ) - unset( $parts[ count( $parts ) - 1 ] ); + if ( count( $parts ) > 1 ) { + unset( $parts[count( $parts ) - 1] ); + } return implode( '/', $parts ); } /** * 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 ) ) { return( $this->mTextform ); } $parts = explode( '/', $this->mTextform ); - return( $parts[ count( $parts ) - 1 ] ); + return( $parts[count( $parts ) - 1] ); } /** * 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(); @@ -750,7 +794,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 ); @@ -765,11 +809,11 @@ 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 $wgContLang, $wgServer, $wgRequest; + global $wgServer, $wgRequest; if ( is_array( $query ) ) { $query = wfArrayToCGI( $query ); @@ -785,7 +829,7 @@ class Title { $url = $wgServer . $url; } } else { - $baseUrl = $interwiki->getURL( ); + $baseUrl = $interwiki->getURL(); $namespace = wfUrlencode( $this->getNsText() ); if ( $namespace != '' ) { @@ -812,24 +856,17 @@ 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; - global $wgVariantArticlePath, $wgContLang, $wgUser; + global $wgVariantArticlePath, $wgContLang; if ( is_array( $query ) ) { $query = wfArrayToCGI( $query ); } - // internal links should point to same variant as current page (only anonymous users) - if ( !$variant && $wgContLang->hasVariants() && !$wgUser->isLoggedIn() ) { - $pref = $wgContLang->getPreferredVariant( false ); - if ( $pref != $wgContLang->getCode() ) - $variant = $pref; - } - if ( $this->isExternal() ) { $url = $this->getFullURL(); if ( $query ) { @@ -863,7 +900,9 @@ class Title { $action = urldecode( $matches[2] ); if ( isset( $wgActionPaths[$action] ) ) { $query = $matches[1]; - if ( isset( $matches[4] ) ) $query .= $matches[4]; + if ( isset( $matches[4] ) ) { + $query .= $matches[4]; + } $url = str_replace( '$1', $dbkey, $wgActionPaths[$action] ); if ( $query != '' ) { $url = wfAppendQuery( $url, $query ); @@ -898,12 +937,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__ ); @@ -922,8 +961,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 ) ); @@ -933,8 +972,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 ) ); @@ -945,9 +984,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; @@ -959,11 +998,13 @@ 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() { - if ( $this->mInterwiki != '' ) { return ''; } + if ( $this->mInterwiki != '' ) { + return ''; + } $s = $this->getLocalURL( 'action=edit' ); return $s; @@ -973,7 +1014,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() ); @@ -982,23 +1023,26 @@ class Title { /** * Is this Title interwiki? * - * @return \type{\bool} + * @return Bool */ - public function isExternal() { return ( $this->mInterwiki != '' ); } + public function isExternal() { + return ( $this->mInterwiki != '' ); + } /** * 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() ) { $restrictions = $this->getRestrictions( $action ); if ( count( $restrictions ) > 0 ) { foreach ( $restrictions as $restriction ) { - if ( strtolower( $restriction ) != 'autoconfirmed' ) + if ( strtolower( $restriction ) != 'autoconfirmed' ) { return false; + } } } else { # Not protected @@ -1014,9 +1058,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; @@ -1024,8 +1068,9 @@ class Title { $restrictionTypes = $this->getRestrictionTypes(); # Special pages have inherent protection - if( $this->getNamespace() == NS_SPECIAL ) + if( $this->getNamespace() == NS_SPECIAL ) { return true; + } # Check regular protection levels foreach ( $restrictionTypes as $type ) { @@ -1045,11 +1090,14 @@ class Title { /** * Is this a conversion table for the LanguageConverter? * - * @return \type{\bool} + * @return Bool */ public function isConversionTable() { - if($this->getNamespace() == NS_MEDIAWIKI - && strpos( $this->getText(), 'Conversiontable' ) !== false ) { + if( + $this->getNamespace() == NS_MEDIAWIKI && + strpos( $this->getText(), 'Conversiontable' ) !== false + ) + { return true; } @@ -1059,7 +1107,7 @@ class Title { /** * Is $wgUser watching this page? * - * @return \type{\bool} + * @return Bool */ public function userIsWatching() { global $wgUser; @@ -1084,25 +1132,33 @@ 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; - if ( isset( $wgNamespaceProtection[ $this->mNamespace ] ) ) { - foreach ( (array)$wgNamespaceProtection[ $this->mNamespace ] as $right ) { - if ( $right != '' && !$wgUser->isAllowed( $right ) ) + 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 != '' && !$user->isAllowed( $right ) ) { return true; + } } } return false; @@ -1111,9 +1167,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; @@ -1125,21 +1181,13 @@ 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 arrays of the arguments to wfMsg to explain permissions problems. */ public function getUserPermissionsErrors( $action, $user, $doExpensiveQueries = true, $ignoreErrors = array() ) { - if ( !StubObject::isRealObject( $user ) ) { - // Since StubObject is always used on globals, we can - // unstub $wgUser here and set $user = $wgUser - global $wgUser; - $wgUser->_unstub( '', 5 ); - $user = $wgUser; - } - $errors = $this->getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries ); // Remove the errors being ignored. @@ -1169,7 +1217,7 @@ class Title { if ( $action == 'create' ) { if ( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) || ( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) ) { - $errors[] = $user->isAnon() ? array ( 'nocreatetext' ) : array ( 'nocreate-loggedin' ); + $errors[] = $user->isAnon() ? array( 'nocreatetext' ) : array( 'nocreate-loggedin' ); } } elseif ( $action == 'move' ) { if ( !$user->isAllowed( 'move-rootuserpages' ) @@ -1196,23 +1244,21 @@ class Title { } if ( $user->isAnon() && ( $userCanMove || $autoconfirmedCanMove ) ) { // custom message if logged-in users without any special rights can move - $errors[] = array ( 'movenologintext' ); + $errors[] = array( 'movenologintext' ); } else { - $errors[] = array ( 'movenotallowed' ); + $errors[] = array( 'movenotallowed' ); } } } elseif ( $action == 'move-target' ) { if ( !$user->isAllowed( 'move' ) ) { // User can't move anything - $errors[] = array ( 'movenotallowed' ); + $errors[] = array( 'movenotallowed' ); } elseif ( !$user->isAllowed( 'move-rootuserpages' ) && $this->mNamespace == NS_USER && !$this->isSubpage() ) { // Show user page-specific message only if the user can move other pages $errors[] = array( 'cant-move-to-user-page' ); } } elseif ( !$user->isAllowed( $action ) ) { - $return = null; - // We avoid expensive display logic for quickUserCan's and such $groups = false; if ( !$short ) { @@ -1228,7 +1274,7 @@ class Title { count( $groups ) ); } else { - $return = array( "badaccess-group0" ); + $return = array( 'badaccess-group0' ); } $errors[] = $return; } @@ -1263,10 +1309,18 @@ 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 + $result = ''; if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) { return $result ? array() : array( array( 'badaccess-group0' ) ); } @@ -1285,7 +1339,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 @@ -1296,7 +1357,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 ? @@ -1308,7 +1369,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 @@ -1332,7 +1400,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 ) { @@ -1359,7 +1434,14 @@ class Title { /** * Check restrictions on cascading pages. - * @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 checkCascadingSourcesRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) { if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) { @@ -1391,7 +1473,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 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' ) { @@ -1430,16 +1519,21 @@ 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 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; } - global $wgContLang; - global $wgLang; - global $wgEmailConfirmToEdit; + global $wgContLang, $wgLang, $wgEmailConfirmToEdit; if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() && $action != 'createaccount' ) { $errors[] = array( 'confirmedittext' ); @@ -1477,7 +1571,7 @@ class Title { if ( !strpos( $option, ':' ) ) continue; - list ( $show, $value ) = explode( ":", $option ); + list( $show, $value ) = explode( ':', $option ); if ( $value == 'infinite' || $value == 'indefinite' ) { $blockExpiry = $show; @@ -1502,24 +1596,26 @@ 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__ ); $errors = array(); - $checks = array( 'checkQuickPermissions', + $checks = array( + 'checkQuickPermissions', 'checkPermissionHooks', 'checkSpecialsAndNSPermissions', 'checkCSSandJSPermissions', 'checkPageRestrictions', 'checkCascadingSourcesRestrictions', 'checkActionPermissions', - 'checkUserBlock' ); + 'checkUserBlock' + ); while( count( $checks ) > 0 && !( $short && count( $errors ) > 0 ) ) { @@ -1533,8 +1629,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() { @@ -1563,9 +1660,9 @@ class Title { /** * 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 ) { @@ -1587,15 +1684,13 @@ class Title { if ( $encodedExpiry != 'infinity' ) { $expiry_description = ' (' . wfMsgForContent( 'protect-expiring', $wgContLang->timeanddate( $expiry ), $wgContLang->date( $expiry ) , $wgContLang->time( $expiry ) ) . ')'; - } - else { + } else { $expiry_description .= ' (' . wfMsgForContent( 'protect-expiry-indefinite' ) . ')'; } # 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, @@ -1603,12 +1698,15 @@ 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; } + # Update the protection log if ( $dbw->affectedRows() ) { $log = new LogPage( 'protect' ); @@ -1630,16 +1728,19 @@ class Title { public function deleteTitleProtection() { $dbw = wfGetDB( DB_MASTER ); - $dbw->delete( 'protected_titles', + $dbw->delete( + 'protected_titles', array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ), - __METHOD__ ); + __METHOD__ + ); + $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() == ''; @@ -1648,7 +1749,7 @@ class Title { /** * Can $wgUser read this page? * - * @return \type{\bool} + * @return Bool * @todo fold these checks into userCan() */ public function userCanRead() { @@ -1687,8 +1788,9 @@ class Title { } # Shortcut for public wikis, allows skipping quite a bit of code - if ( $useShortcut ) + if ( $useShortcut ) { return true; + } if ( $wgUser->isAllowed( 'read' ) ) { return true; @@ -1724,8 +1826,9 @@ class Title { * a colon for main-namespace pages */ if ( $this->getNamespace() == NS_MAIN ) { - if ( in_array( ':' . $name, $wgWhitelistRead ) ) + if ( in_array( ':' . $name, $wgWhitelistRead ) ) { return true; + } } /** @@ -1741,18 +1844,32 @@ class Title { } $pure = SpecialPage::getTitleFor( $name )->getPrefixedText(); - if ( in_array( $pure, $wgWhitelistRead, true ) ) + if ( in_array( $pure, $wgWhitelistRead, true ) ) { return true; + } } } 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() ); @@ -1761,7 +1878,7 @@ class Title { /** * Is this a subpage? * - * @return \type{\bool} + * @return Bool */ public function isSubpage() { return MWNamespace::hasSubpages( $this->mNamespace ) @@ -1772,7 +1889,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 ) ) { @@ -1789,28 +1906,31 @@ class Title { } $subpages = $this->getSubpages( 1 ); - if ( $subpages instanceof TitleArray ) + if ( $subpages instanceof TitleArray ) { return $this->mHasSubpages = (bool)$subpages->count(); + } return $this->mHasSubpages = false; } /** * 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 */ public function getSubpages( $limit = -1 ) { - if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) + if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) { return array(); + } $dbr = wfGetDB( DB_SLAVE ); $conds['page_namespace'] = $this->getNamespace(); $conds[] = 'page_title ' . $dbr->buildLike( $this->getDBkey() . '/', $dbr->anyString() ); $options = array(); - if ( $limit > -1 ) + if ( $limit > -1 ) { $options['LIMIT'] = $limit; + } return $this->mSubpages = TitleArray::newFromResult( $dbr->select( 'page', array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ), @@ -1825,7 +1945,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 @@ -1834,7 +1954,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 ) ); @@ -1842,19 +1962,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 */ 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(); } /** @@ -1871,7 +1984,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 ) ); @@ -1880,7 +1993,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 ) ); @@ -1890,7 +2003,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() { @@ -1898,11 +2011,12 @@ class Title { return ( ( $wgUser->isAllowed( 'editusercssjs' ) && $wgUser->isAllowed( 'editusercss' ) ) || preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform ) ); } + /** * 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() { @@ -1914,7 +2028,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 ); @@ -1924,9 +2038,9 @@ 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 + * @return Mixed 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 @@ -1946,18 +2060,20 @@ class Title { $dbr = wfGetDB( DB_SLAVE ); if ( $this->getNamespace() == NS_FILE ) { - $tables = array ( 'imagelinks', 'page_restrictions' ); + $tables = array( 'imagelinks', 'page_restrictions' ); $where_clauses = array( 'il_to' => $this->getDBkey(), 'il_from=pr_page', - 'pr_cascade' => 1 ); + 'pr_cascade' => 1 + ); } else { - $tables = array ( 'templatelinks', 'page_restrictions' ); + $tables = array( 'templatelinks', 'page_restrictions' ); $where_clauses = array( 'tl_namespace' => $this->getNamespace(), 'tl_title' => $this->getDBkey(), 'tl_from=pr_page', - 'pr_cascade' => 1 ); + 'pr_cascade' => 1 + ); } if ( $getPages ) { @@ -2034,15 +2150,14 @@ class Title { /** * Loads a string into mRestrictions array * - * @param $res \type{Resource} restrictions as an SQL result. + * @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 ) { $rows = array(); - $dbr = wfGetDB( DB_SLAVE ); - while ( $row = $dbr->fetchObject( $res ) ) { + foreach ( $res as $row ) { $rows[] = $row; } @@ -2051,7 +2166,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 @@ -2142,7 +2258,7 @@ class Title { $dbr = wfGetDB( DB_SLAVE ); $res = $dbr->select( 'page_restrictions', '*', - array ( 'pr_page' => $this->getArticleId() ), __METHOD__ ); + array( 'pr_page' => $this->getArticleId() ), __METHOD__ ); $this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions ); } else { @@ -2158,6 +2274,7 @@ class Title { $this->mRestrictions['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) ); } else { // Get rid of the old restrictions Title::purgeExpiredRestrictions(); + $this->mTitleProtection = false; } } else { $this->mRestrictionsExpiry['create'] = Block::decodeExpiry( '' ); @@ -2172,20 +2289,24 @@ class Title { */ static function purgeExpiredRestrictions() { $dbw = wfGetDB( DB_MASTER ); - $dbw->delete( 'page_restrictions', + $dbw->delete( + 'page_restrictions', array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ), - __METHOD__ ); + __METHOD__ + ); - $dbw->delete( 'protected_titles', + $dbw->delete( + 'protected_titles', array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ), - __METHOD__ ); + __METHOD__ + ); } /** * 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 ) { @@ -2212,7 +2333,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 ) { @@ -2260,16 +2381,16 @@ 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 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 ) { return $this->mArticleID = 0; } $linkCache = LinkCache::singleton(); - if ( $flags & GAID_FOR_UPDATE ) { + if ( $flags & self::GAID_FOR_UPDATE ) { $oldUpdate = $linkCache->forUpdate( true ); $linkCache->clearLink( $this ); $this->mArticleID = $linkCache->addLinkObj( $this ); @@ -2286,12 +2407,13 @@ 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 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 ) ) + if ( !is_null( $this->mRedirect ) ) { return $this->mRedirect; + } # Calling getArticleID() loads the field from cache as needed if ( !$this->getArticleID( $flags ) ) { return $this->mRedirect = false; @@ -2306,12 +2428,13 @@ 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 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 ) + if ( $this->mLength != -1 ) { return $this->mLength; + } # Calling getArticleID() loads the field from cache as needed if ( !$this->getArticleID( $flags ) ) { return $this->mLength = 0; @@ -2325,12 +2448,13 @@ class Title { /** * What is the page_latest field for this page? * - * @param $flags \type{\int} a bit field; may be 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 ) - return $this->mLatestID; + if ( $this->mLatestID !== false ) { + return intval( $this->mLatestID ); + } # Calling getArticleID() loads the field from cache as needed if ( !$this->getArticleID( $flags ) ) { return $this->mLatestID = 0; @@ -2345,11 +2469,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(); @@ -2370,14 +2494,15 @@ 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() ) { return; } $dbw = wfGetDB( DB_MASTER ); - $success = $dbw->update( 'page', + $success = $dbw->update( + 'page', array( 'page_touched' => $dbw->timestamp() ), $this->pageCond(), __METHOD__ @@ -2390,8 +2515,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 ) { @@ -2442,10 +2567,11 @@ class Title { public static function capitalize( $text, $ns = NS_MAIN ) { global $wgContLang; - if ( MWNamespace::isCapitalized( $ns ) ) + if ( MWNamespace::isCapitalized( $ns ) ) { return $wgContLang->ucfirst( $text ); - else + } else { return $text; + } } /** @@ -2457,7 +2583,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; @@ -2515,10 +2641,11 @@ class Title { $this->mNamespace = $ns; # 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] ) ) + if ( $wgContLang->getNsIndex( $x[1] ) ) { return false; # Disallow Talk:File:x type titles... - else if ( Interwiki::isValidInterwiki( $x[1] ) ) + } else if ( Interwiki::isValidInterwiki( $x[1] ) ) { return false; # Disallow Talk:Interwiki:x type titles... + } } } elseif ( Interwiki::isValidInterwiki( $p ) ) { if ( !$firstPass ) { @@ -2532,7 +2659,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; @@ -2563,7 +2692,7 @@ class Title { } $fragment = strstr( $dbkey, '#' ); if ( false !== $fragment ) { - $this->setFragment( $fragment ); + $this->setFragment( preg_replace( '/^#_*/', '#', $fragment ) ); $dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) ); # remove whitespace again: prevents "Foo_bar_#" # becoming "Foo_bar_" @@ -2622,7 +2751,7 @@ class Title { * site might be case-sensitive. */ $this->mUserCaseDBKey = $dbkey; - if ( $this->mInterwiki == '' ) { + if ( $this->mInterwiki == '' ) { $dbkey = self::capitalize( $dbkey, $this->mNamespace ); } @@ -2666,7 +2795,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 ) ); @@ -2675,7 +2804,7 @@ class Title { /** * Get a Title object associated with the talk page of this article * - * @return \type{Title} the object for the talk page + * @return Title the object for the talk page */ public function getTalkPage() { return Title::makeTitle( MWNamespace::getTalk( $this->getNamespace() ), $this->getDBkey() ); @@ -2685,7 +2814,7 @@ class Title { * Get a title object associated with the subject page of this * talk page * - * @return \type{Title} the object for the subject page + * @return Title the object for the subject page */ public function getSubjectPage() { // Is this the same title? @@ -2706,7 +2835,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(); @@ -2717,25 +2846,27 @@ class Title { $db = wfGetDB( DB_SLAVE ); } - $res = $db->select( array( 'page', $table ), + $res = $db->select( + array( 'page', $table ), array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ), array( "{$prefix}_from=page_id", "{$prefix}_namespace" => $this->getNamespace(), "{$prefix}_title" => $this->getDBkey() ), __METHOD__, - $options ); + $options + ); $retVal = array(); if ( $db->numRows( $res ) ) { foreach ( $res as $row ) { - if ( $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title ) ) { + $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title ); + if ( $titleObj ) { $linkCache->addGoodLinkObj( $row->page_id, $titleObj, $row->page_len, $row->page_is_redirect, $row->page_latest ); $retVal[] = $titleObj; } } } - $db->freeResult( $res ); return $retVal; } @@ -2747,7 +2878,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' ); @@ -2757,7 +2888,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 ) { @@ -2794,7 +2925,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; @@ -2808,7 +2939,6 @@ class Title { if ( $wgContLang->hasVariants() ) { $variants = $wgContLang->getVariants(); foreach ( $variants as $vCode ) { - if ( $vCode == $wgContLang->getCode() ) continue; // we don't want default variant $urls[] = $this->getInternalURL( '', $vCode ); } } @@ -2831,8 +2961,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 ); @@ -2842,11 +2972,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; @@ -2884,11 +3014,11 @@ class Title { // Image-specific checks if ( $this->getNamespace() == NS_FILE ) { + if ( $nt->getNamespace() != NS_FILE ) { + $errors[] = array( 'imagenocrossnamespace' ); + } $file = wfLocalFile( $this ); if ( $file->exists() ) { - if ( $nt->getNamespace() != NS_FILE ) { - $errors[] = array( 'imagenocrossnamespace' ); - } if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) { $errors[] = array( 'imageinvalidfilename' ); } @@ -2900,7 +3030,10 @@ class Title { if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destfile->exists() && wfFindFile( $nt ) ) { $errors[] = array( 'file-exists-sharedrepo' ); } + } + if ( $nt->getNamespace() == NS_FILE && $this->getNamespace() != NS_FILE ) { + $errors[] = array( 'nonfile-cannot-move-to-file' ); } if ( $auth ) { @@ -2927,7 +3060,7 @@ class Title { # (so we can undo bad moves right after they're done). if ( 0 != $newid ) { # Target exists; check for validity - if ( ! $this->isValidMoveTarget( $nt ) ) { + if ( !$this->isValidMoveTarget( $nt ) ) { $errors[] = array( 'articleexists' ); } } else { @@ -2937,23 +3070,26 @@ class Title { $errors[] = array( 'cantmove-titleprotected' ); } } - if ( empty( $errors ) ) + if ( empty( $errors ) ) { return true; + } 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; @@ -2973,37 +3109,29 @@ 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(); - // Category memberships include a sort key which may be customized. - // If it's left as the default (the page title), we need to update - // the sort key to match the new title. - // - // Be careful to avoid resetting cl_timestamp, which may disturb - // time-based lists on some sites. - // - // Warning -- if the sort key is *explicitly* set to the old title, - // we can't actually distinguish it from a default here, and it'll - // be set to the new title even though it really shouldn't. - // It'll get corrected on the next edit, but resetting cl_timestamp. + // 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( + 'categorylinks', + 'cl_sortkey_prefix', + array( 'cl_from' => $pageid ), + __METHOD__ + ); $dbw->update( 'categorylinks', array( - 'cl_sortkey' => $nt->getPrefixedText(), + 'cl_sortkey' => $wgContLang->convertToSortkey( $nt->getCategorySortkey( $prefix ) ), 'cl_timestamp=cl_timestamp' ), - array( - 'cl_from' => $pageid, - 'cl_sortkey' => $this->getPrefixedText() ), + array( 'cl_from' => $pageid ), __METHOD__ ); if ( $protected ) { @@ -3024,7 +3152,9 @@ class Title { # Update the protection log $log = new LogPage( 'protect' ); $comment = wfMsgForContent( 'prot_1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() ); - if ( $reason ) $comment .= wfMsgForContent( 'colon-separator' ) . $reason; + if ( $reason ) { + $comment .= wfMsgForContent( 'colon-separator' ) . $reason; + } $log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) ); // FIXME: $params? } @@ -3060,12 +3190,12 @@ class Title { # Nothing special $u = false; } - if ( $u ) + if ( $u ) { $u->doUpdate(); + } # Update message cache for interface messages - if ( $nt->getNamespace() == NS_MEDIAWIKI ) { - global $wgMessageCache; - + 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 ) { @@ -3074,7 +3204,8 @@ class Title { $oldarticle = new Article( $this ); $wgMessageCache->replace( $this->getDBkey(), $oldarticle->getContent() ); } - + } + if ( $nt->getNamespace() == NS_MEDIAWIKI ) { $newarticle = new Article( $nt ); $wgMessageCache->replace( $nt->getDBkey(), $newarticle->getContent() ); } @@ -3085,19 +3216,23 @@ 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; + + $moveOverRedirect = $nt->exists(); - $comment = wfMsgForContent( '1movedto2_redir', $this->getPrefixedText(), $nt->getPrefixedText() ); + $commentMsg = ( $moveOverRedirect ? '1movedto2_redir' : '1movedto2' ); + $comment = wfMsgForContent( $commentMsg, $this->getPrefixedText(), $nt->getPrefixedText() ); if ( $reason ) { $comment .= wfMsgForContent( 'colon-separator' ) . $reason; @@ -3105,43 +3240,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__ ); - $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 ( $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__ ); + } + // 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 ); @@ -3150,7 +3291,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, @@ -3192,106 +3333,18 @@ 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 $wgUseSquid, $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 ); - - $newid = $nt->getArticleID(); - $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 ); + $logType = ( $moveOverRedirect ? 'move_redir' : 'move' ); + $log->addEntry( $logType, $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) ); - $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 ) ); - - # 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(); - } /** @@ -3308,15 +3361,18 @@ class Title { public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) { global $wgMaximumMovedPages; // Check permissions - if ( !$this->userCan( 'move-subpages' ) ) + if ( !$this->userCan( 'move-subpages' ) ) { return array( 'cant-move-subpages' ); + } // Do the source and target namespaces support subpages? - if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) + if ( !MWNamespace::hasSubpages( $this->getNamespace() ) ) { return array( 'namespace-nosubpages', MWNamespace::getCanonicalName( $this->getNamespace() ) ); - if ( !MWNamespace::hasSubpages( $nt->getNamespace() ) ) + } + if ( !MWNamespace::hasSubpages( $nt->getNamespace() ) ) { return array( 'namespace-nosubpages', MWNamespace::getCanonicalName( $nt->getNamespace() ) ); + } $subpages = $this->getSubpages( $wgMaximumMovedPages + 1 ); $retval = array(); @@ -3335,9 +3391,11 @@ class Title { // $this and $nt if ( $oldSubpage->getArticleId() == $this->getArticleId() || $oldSubpage->getArticleID() == $nt->getArticleId() ) + { // When moving a page to a subpage of itself, // don't move it twice continue; + } $newPageName = preg_replace( '#^' . preg_quote( $this->getDBkey(), '#' ) . '#', StringUtils::escapeRegexReplacement( $nt->getDBkey() ), # bug 21234 @@ -3365,7 +3423,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 ); @@ -3402,12 +3460,11 @@ 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 TRUE or FALSE */ public function isValidMoveTarget( $nt ) { - $dbw = wfGetDB( DB_MASTER ); - # Is it an existsing file? + # Is it an existing file? if ( $nt->getNamespace() == NS_FILE ) { $file = wfLocalFile( $nt ); if ( $file->exists() ) { @@ -3445,7 +3502,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() ); @@ -3455,7 +3512,7 @@ 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: + * @return Array of parents in the form: * $parent => $currentarticle */ public function getParentCategories() { @@ -3472,14 +3529,13 @@ class Title { . " ORDER BY cl_sortkey"; $res = $dbr->query( $sql ); + $data = array(); if ( $dbr->numRows( $res ) > 0 ) { - foreach ( $res as $row ) + foreach ( $res as $row ) { // $data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to); $data[$wgContLang->getNSText( NS_CATEGORY ) . ':' . $row->cl_to] = $this->getFullText(); - $dbr->freeResult( $res ); - } else { - $data = array(); + } } return $data; } @@ -3487,8 +3543,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(); @@ -3506,10 +3562,9 @@ class Title { } } } - return $stack; - } else { - return array(); } + + return $stack; } @@ -3517,7 +3572,7 @@ class Title { * Get an associative array for selecting this title from * the "page" table * - * @return \type{\array} Selection array + * @return Array Selection array */ public function pageCond() { if ( $this->mArticleID > 0 ) { @@ -3531,12 +3586,12 @@ 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} GAID_FOR_UPDATE + * @param $revId Int Revision ID. Get the revision that was before this one. + * @param $flags Int Title::GAID_FOR_UPDATE * @return \twotypes{\int,\bool} Old revision ID, or FALSE if none exists */ public function getPreviousRevisionID( $revId, $flags = 0 ) { - $db = ( $flags & GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); + $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); return $db->selectField( 'revision', 'rev_id', array( 'rev_page' => $this->getArticleId( $flags ), @@ -3550,12 +3605,12 @@ 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} GAID_FOR_UPDATE + * @param $revId Int Revision ID. Get the revision that was after this one. + * @param $flags Int Title::GAID_FOR_UPDATE * @return \twotypes{\int,\bool} Next revision ID, or FALSE if none exists */ public function getNextRevisionID( $revId, $flags = 0 ) { - $db = ( $flags & GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); + $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); return $db->selectField( 'revision', 'rev_id', array( 'rev_page' => $this->getArticleId( $flags ), @@ -3569,13 +3624,15 @@ class Title { /** * Get the first revision of the page * - * @param $flags \type{\int} GAID_FOR_UPDATE + * @param $flags Int Title::GAID_FOR_UPDATE * @return Revision (or NULL if page doesn't exist) */ public function getFirstRevision( $flags = 0 ) { - $db = ( $flags & GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); + $db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE ); $pageId = $this->getArticleId( $flags ); - if ( !$pageId ) return null; + if ( !$pageId ) { + return null; + } $row = $db->selectRow( 'revision', '*', array( 'rev_page' => $pageId ), __METHOD__, @@ -3619,25 +3676,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 TRUE or FALSE */ public function equals( Title $title ) { // Note: === is necessary for proper matching of number-like titles. @@ -3662,7 +3742,7 @@ class Title { /** * Return a string representation of this title * - * @return \type{\string} String representation of this title + * @return String String representation of this title */ public function __toString() { return $this->getPrefixedText(); @@ -3675,7 +3755,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; @@ -3695,28 +3775,28 @@ 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 != '' ) { return true; // any interwiki link might be viewable, for all we know } switch( $this->mNamespace ) { - case NS_MEDIA: - case NS_FILE: - return (bool)wfFindFile( $this ); // file exists, possibly in a foreign repo - case NS_SPECIAL: - return SpecialPage::exists( $this->getDBkey() ); // valid special page - case NS_MAIN: - return $this->mDbkeyform == ''; // selflink, possibly with fragment - 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 - default: - return false; + case NS_MEDIA: + case NS_FILE: + return (bool)wfFindFile( $this ); // file exists, possibly in a foreign repo + case NS_SPECIAL: + return SpecialPage::exists( $this->getDBkey() ); // valid special page + case NS_MAIN: + return $this->mDbkeyform == ''; // selflink, possibly with fragment + 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 + default: + return false; } } @@ -3726,10 +3806,10 @@ 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->exists() || $this->isAlwaysKnown(); + return $this->isAlwaysKnown() || $this->exists(); } /** @@ -3738,8 +3818,9 @@ class Title { * @return Boolean */ public function hasSourceText() { - if ( $this->exists() ) + if ( $this->exists() ) { return true; + } if ( $this->mNamespace == NS_MEDIAWIKI ) { // If the page doesn't exist but is a known system message, default @@ -3755,11 +3836,11 @@ class Title { } /** - * Is this in a namespace that allows actual pages? - * - * @return \type{\bool} - * @internal note -- uses hardcoded namespace index instead of constants - */ + * Is this in a namespace that allows actual pages? + * + * @return Bool + * @internal note -- uses hardcoded namespace index instead of constants + */ public function canExist() { return $this->mNamespace >= 0 && $this->mNamespace != NS_MEDIA; } @@ -3783,7 +3864,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 ); @@ -3800,7 +3881,9 @@ class Title { public function getNotificationTimestamp( $user = null ) { global $wgUser, $wgShowUpdatedMarker; // Assume current user if none given - if ( !$user ) $user = $wgUser; + if ( !$user ) { + $user = $wgUser; + } // Check cache first $uid = $user->getId(); if ( isset( $this->mNotificationTimestamp[$uid] ) ) { @@ -3828,7 +3911,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; @@ -3840,7 +3923,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() ); @@ -3869,7 +3952,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; @@ -3901,14 +3984,14 @@ class Title { * * @return boolean */ - public function isSpecialPage( ) { + public function isSpecialPage() { return $this->getNamespace() == NS_SPECIAL; } /** * 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 ) { @@ -3924,7 +4007,7 @@ class Title { /** * If the Title refers to a special page alias which is not the local default, * - * @return \type{Title} A new Title which points to the local default. + * @return Title A new Title which points to the local default. * Otherwise, returns $this. */ public function fixSpecialName() { @@ -3945,7 +4028,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() ); @@ -3954,9 +4037,9 @@ class Title { /** * Get all extant redirects to this Title * - * @param $ns \twotypes{\int,\null} Single namespace to consider; + * @param $ns Int|Null Single namespace to consider; * NULL to consider all namespaces - * @return \type{\arrayof{Title}} Redirects to this title + * @return Array of Title redirects to this title */ public function getRedirectsHere( $ns = null ) { $redirs = array(); @@ -3967,7 +4050,9 @@ class Title { 'rd_title' => $this->getDBkey(), 'rd_from = page_id' ); - if ( !is_null( $ns ) ) $where['page_namespace'] = $ns; + if ( !is_null( $ns ) ) { + $where['page_namespace'] = $ns; + } $res = $dbr->select( array( 'redirect', 'page' ), @@ -3976,7 +4061,6 @@ class Title { __METHOD__ ); - foreach ( $res as $row ) { $redirs[] = self::newFromRow( $row ); } @@ -3986,7 +4070,7 @@ class Title { /** * Check if this Title is a valid redirect target * - * @return \type{\bool} + * @return Bool */ public function isValidRedirectTarget() { global $wgInvalidRedirectTargets; @@ -4024,8 +4108,7 @@ class Title { * @return Boolean */ public function canUseNoindex() { - global $wgArticleRobotPolicies, $wgContentNamespaces, - $wgExemptFromUserRobotsControl; + global $wgContentNamespaces, $wgExemptFromUserRobotsControl; $bannedNamespaces = is_null( $wgExemptFromUserRobotsControl ) ? $wgContentNamespaces @@ -4042,14 +4125,36 @@ 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 + * binary sortkey that can be used for actual sorting. + * + * @param $prefix string The prefix to be used, specified using + * {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no + * prefix. + * @return string + */ + 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"; + } + return $unprefixed; + } }