wiki.techinc.nl/includes/Title.php

4051 lines
124 KiB
PHP
Raw Normal View History

<?php
/**
* See title.txt
* @file
*/
2003-04-14 23:10:40 +00:00
/**
* @todo: determine if it is really necessary to load this. Appears to be left over from pre-autoloader versions, and
* is only really needed to provide access to constant UTF8_REPLACEMENT, which actually resides in UtfNormalDefines.php
* and is loaded by UtfNormalUtil.php, which is loaded by UtfNormal.php.
*/
2007-04-05 02:30:29 +00:00
if ( !class_exists( 'UtfNormal' ) ) {
require_once( dirname( __FILE__ ) . '/normal/UtfNormal.php' );
2007-04-05 02:30:29 +00:00
}
2006-06-01 08:12:49 +00:00
define ( 'GAID_FOR_UPDATE', 1 );
/**
2008-08-11 04:39:00 +00:00
* Represents a title within MediaWiki.
* Optionally may contain an interwiki designation or namespace.
* @note This class can fetch various kinds of data from the database;
* however, it does so inefficiently.
*
* @internal documentation reviewed 15 Mar 2010
*/
2003-04-14 23:10:40 +00:00
class Title {
2008-08-11 04:39:00 +00:00
/** @name Static cache variables */
// @{
static private $titleCache = array();
static private $interwikiCache = array();
// @}
/**
* Title::newFromText maintains a cache to avoid expensive re-normalization of
* commonly used titles. On a batch operation this can become a memory leak
* if not bounded. After hitting this many titles reset the cache.
*/
const CACHE_MAX = 1000;
/**
2008-08-11 04:39:00 +00:00
* @name Private member variables
* Please use the accessor functions instead.
2006-06-10 18:28:50 +00:00
* @private
*/
// @{
var $mTextform = ''; // /< Text form (spaces not underscores) of the main part
var $mUrlform = ''; // /< URL-encoded form of the main part
var $mDbkeyform = ''; // /< Main part with underscores
var $mUserCaseDBKey; // /< DB key with the initial letter in the case specified by the user
var $mNamespace = NS_MAIN; // /< Namespace index, i.e. one of the NS_xxxx constants
var $mInterwiki = ''; // /< Interwiki prefix (or null string)
var $mFragment; // /< Title fragment (i.e. the bit after the #)
var $mArticleID = -1; // /< Article ID, fetched from the link cache on demand
var $mLatestID = false; // /< ID of most recent revision
var $mRestrictions = array(); // /< Array of groups allowed to edit this article
var $mOldRestrictions = false;
var $mCascadeRestriction; ///< Cascade restrictions on this page to included templates and images?
2010-04-23 18:37:33 +00:00
var $mCascadingRestrictions; // Caching the results of getCascadeProtectionSources
var $mRestrictionsExpiry = array(); ///< When do the restrictions on this page expire?
var $mHasCascadingRestrictions; ///< Are cascading restrictions in effect on this page?
var $mCascadeSources; ///< Where are the cascading restrictions coming from on this page?
2008-08-11 04:39:00 +00:00
var $mRestrictionsLoaded = false; ///< Boolean for initialisation on demand
var $mPrefixedText; ///< Text form including namespace/interwiki, initialised on demand
var $mTitleProtection; ///< Cached value of getTitleProtection
# Don't change the following default, NS_MAIN is hardcoded in several
# places. See bug 696.
var $mDefaultNamespace = NS_MAIN; // /< Namespace index when there is no namespace
# Zero except in {{transclusion}} tags
var $mWatched = null; // /< Is $wgUser watching this page? null if unfilled, accessed through userIsWatching()
var $mLength = -1; // /< The page length, 0 for special pages
var $mRedirect = null; // /< Is the article at this title a redirect?
var $mNotificationTimestamp = array(); // /< Associative array of user ID -> timestamp/false
var $mBacklinkCache = null; // /< Cache of links to this title
// @}
2003-04-14 23:10:40 +00:00
/**
* Constructor
2006-06-10 18:28:50 +00:00
* @private
*/
/* private */ function __construct() { }
2003-04-14 23:10:40 +00:00
/**
* Create a new Title from a prefixed DB key
*
2008-08-11 04:39:00 +00:00
* @param $key \type{\string} The database key, which has underscores
* instead of spaces, possibly including namespace and
* interwiki prefixes
2008-08-11 04:39:00 +00:00
* @return \type{Title} the new object, or NULL on an error
*/
public static function newFromDBkey( $key ) {
2003-04-14 23:10:40 +00:00
$t = new Title();
$t->mDbkeyform = $key;
if ( $t->secureAndSplit() )
return $t;
else
return null;
2003-04-14 23:10:40 +00:00
}
/**
* 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
* 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
* $text might begin with a namespace prefix, use makeTitle() or
* makeTitleSafe().
* @return Title The new object, or null on an error.
*/
2006-07-10 15:08:51 +00:00
public static function newFromText( $text, $defaultNamespace = NS_MAIN ) {
if ( is_object( $text ) ) {
throw new MWException( 'Title::newFromText given an object' );
}
/**
* Wiki pages often contain multiple links to the same page.
* Title normalization and parsing can become expensive on
* pages with many links, so we can save a little time by
* caching them.
*
* In theory these are value objects and won't get changed...
*/
if ( $defaultNamespace == NS_MAIN && isset( Title::$titleCache[$text] ) ) {
return Title::$titleCache[$text];
}
/**
* Convert things like &eacute; &#257; or &#x3017; into normalized(bug 14952) text
*/
$filteredText = Sanitizer::decodeCharReferencesAndNormalize( $text );
2003-04-14 23:10:40 +00:00
$t = new Title();
$t->mDbkeyform = str_replace( ' ', '_', $filteredText );
$t->mDefaultNamespace = $defaultNamespace;
static $cachedcount = 0 ;
if ( $t->secureAndSplit() ) {
if ( $defaultNamespace == NS_MAIN ) {
if ( $cachedcount >= self::CACHE_MAX ) {
# Avoid memory leaks on mass operations...
Title::$titleCache = array();
$cachedcount = 0;
}
$cachedcount++;
Title::$titleCache[$text] =& $t;
}
return $t;
} else {
$ret = null;
return $ret;
}
2003-04-14 23:10:40 +00:00
}
/**
* THIS IS NOT THE FUNCTION YOU WANT. Use Title::newFromText().
*
* Example of wrong and broken code:
* $title = Title::newFromURL( $wgRequest->getVal( 'title' ) );
*
* Example of right code:
* $title = Title::newFromText( $wgRequest->getVal( 'title' ) );
*
* Create a new Title from URL-encoded text. Ensures that
* the given title's length does not exceed the maximum.
*
2008-08-11 04:39:00 +00:00
* @param $url \type{\string} the title, as might be taken from a URL
* @return \type{Title} the new object, or NULL on an error
*/
public static function newFromURL( $url ) {
2006-01-05 05:27:16 +00:00
global $wgLegalTitleChars;
2003-04-14 23:10:40 +00:00
$t = new Title();
2006-01-05 05:27:16 +00:00
# For compatibility with old buggy URLs. "+" is usually not valid in titles,
# but some URLs used it as a space replacement and they still come
# from some external search tools.
2006-01-05 05:27:16 +00:00
if ( strpos( $wgLegalTitleChars, '+' ) === false ) {
$url = str_replace( '+', ' ', $url );
}
2006-01-05 05:27:16 +00:00
$t->mDbkeyform = str_replace( ' ', '_', $url );
if ( $t->secureAndSplit() ) {
return $t;
} else {
return null;
}
2003-04-14 23:10:40 +00:00
}
/**
* Create a new Title from an article ID
2005-05-04 00:33:08 +00:00
*
2008-08-11 04:39:00 +00:00
* @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
*/
2008-05-10 23:31:52 +00:00
public static function newFromID( $id, $flags = 0 ) {
$db = ( $flags & 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 );
} else {
$title = null;
}
return $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
*/
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__ );
$titles = array();
foreach ( $res as $row ) {
$titles[] = Title::makeTitle( $row->page_namespace, $row->page_title );
}
return $titles;
}
/**
* Make a Title object from a DB row
*
2008-08-11 04:39:00 +00:00
* @param $row \type{Row} (needs at least page_title,page_namespace)
* @return \type{Title} corresponding Title
*/
public static function newFromRow( $row ) {
$t = self::makeTitle( $row->page_namespace, $row->page_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 ) ? intval( $row->page_latest ) : false;
return $t;
}
/**
* Create a new Title from a namespace index and a DB key.
* It's assumed that $ns and $title are *valid*, for instance when
* they came directly from the database or a special page name.
* For convenience, spaces are converted to underscores so that
* eg user_text fields can be used directly.
*
2008-08-11 04:39:00 +00:00
* @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
*/
public static function &makeTitle( $ns, $title, $fragment = '' ) {
$t = new Title();
$t->mInterwiki = '';
$t->mFragment = $fragment;
$t->mNamespace = $ns = intval( $ns );
$t->mDbkeyform = str_replace( ' ', '_', $title );
$t->mArticleID = ( $ns >= 0 ) ? -1 : 0;
$t->mUrlform = wfUrlencode( $t->mDbkeyform );
$t->mTextform = str_replace( '_', ' ', $title );
return $t;
}
/**
* Create a new Title from a namespace index and a DB key.
* The parameters will be checked for validity, which is a bit slower
* than makeTitle() but safer for user-provided data.
2005-05-04 00:33:08 +00:00
*
2008-08-11 04:39:00 +00:00
* @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
*/
public static function makeTitleSafe( $ns, $title, $fragment = '' ) {
$t = new Title();
$t->mDbkeyform = Title::makeName( $ns, $title, $fragment );
if ( $t->secureAndSplit() ) {
return $t;
} else {
return null;
}
}
2003-04-14 23:10:40 +00:00
/**
* Create a new Title for the Main Page
*
2008-08-11 04:39:00 +00:00
* @return \type{Title} the new object
*/
public static function newMainPage() {
$title = Title::newFromText( wfMsgForContent( 'mainpage' ) );
// Don't give fatal errors if the message is broken
if ( !$title ) {
$title = Title::newFromText( 'Main Page' );
}
return $title;
}
/**
* Extract a redirect destination from a string and return the
* Title, or null if the text doesn't contain a valid redirect
* 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
2008-08-11 04:39:00 +00:00
* @return \type{Title} The corresponding Title
*/
public static function newFromRedirect( $text ) {
return self::newFromRedirectInternal( $text );
}
/**
* Extract a redirect destination from a string and return the
* Title, or null if the text doesn't contain a valid redirect
* 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
*/
public static function newFromRedirectRecurse( $text ) {
$titles = self::newFromRedirectArray( $text );
return $titles ? array_pop( $titles ) : null;
}
/**
* Extract a redirect destination from a string and return an
* array of Titles, or null if the text doesn't contain a valid redirect
* 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
*/
public static function newFromRedirectArray( $text ) {
global $wgMaxRedirects;
// are redirects disabled?
if ( $wgMaxRedirects < 1 )
return null;
$title = self::newFromRedirectInternal( $text );
if ( is_null( $title ) )
return null;
// recursive check to follow double redirects
$recurse = $wgMaxRedirects;
$titles = array( $title );
while ( --$recurse > 0 ) {
if ( $title->isRedirect() ) {
$article = new Article( $title, 0 );
$newtitle = $article->getRedirectTarget();
} else {
break;
}
// Redirects to some special pages are not permitted
if ( $newtitle instanceOf Title && $newtitle->isValidRedirectTarget() ) {
// the new title passes the checks, so make that our current title so that further recursion can be checked
$title = $newtitle;
$titles[] = $newtitle;
} else {
break;
}
}
return $titles;
}
/**
* 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
*/
protected static function newFromRedirectInternal( $text ) {
$redir = MagicWord::get( 'redirect' );
$text = trim( $text );
if ( $redir->matchStartAndRemove( $text ) ) {
// Extract the first link and see if it's usable
// Ensure that it really does come directly after #REDIRECT
// Some older redirects included a colon, so don't freak about that!
Static code analysis housekeeping time... things that could be double-checked are marked with "[Note: some-comment]" : if-if-else without curly braces [api/ApiQuerySiteinfo.php] --> adding Unused global declaration: $wgGroupPermissions --> removing Unused global declaration: $wgEmailConfirmToEdit (line 301) --> removing Variable $id appears only once (line 1021) --> removing Variable $m was used before it was defined (line 805) --> defining. Variable $retval was used before it was defined (line 2346) --> renaming to $result Variable $rcid appears only once (line 244 of RecentChange.php) --> using this instead of $change [Note: was left over from r24607 refactoring, revert if wrong please] Unused global declaration: $wgCommandLineMode (line 11) --> removing Variable $k appears only once (line 132 of ImagePage.php) --> removing. Variable $info appears only once (line 311 of ImagePage.php) --> removing. Unused global declaration: $wgTitle (line 569 of ImagePage.php) -> removing. Variable $handlerParams was used before it was defined (line 616 of Linker.php) --> resolved by Raymond in r24966 Variable $match was used before it was defined (line 1031 of Linker.php) --> defining. Unused global declaration: $wgEnotifWatchlist (line 253 of UserMailer.php) --> removing Unused global declaration: $wgShowUpdatedMarker (line 253 of UserMailer.php) --> removing Variable $img appears only once (line 446 of SpecialUpload.php) --> added definition, defined as null, flagged with @todo [Note: should $img be defined in this context, or is it intended to be null? And should the return value after the hook be checked in some way?] Unused global declaration: $wgEnableAPI (line 739 of SpecialUpload.php) --> removing. Unused global declaration: $wgNamespaceProtection (line 1030 of OutputPage.php) --> removing. Unused global declaration: $wgContLang (line 18 of SpecialWatchlist.php) --> removing. Unused global declaration: $wgRawHtml (line 269 of SpecialMovepage.php) --> removing. The value of variable $page was never used (line 331 of SpecialUndelete.php) --> removing line, as $page gets redefined a few lines down. Variable $synIndex appears only once (line 521 of MagicWord.php) --> commenting out. Variable $case appears only once (line 539 of MagicWord.php) --> removing from foreach index key usage. Variable $wgUser appears only once (line 1039 of Title.php) --> adding line to declare as a global, would be null otherwise. Variable $m was used before it was defined (line 285 of Title.php) --> defining. Variable $id appears only once (line 1150 of Title.php) --> removing from foreach index key usage. Variable $subpage appears only once (line 1297 of Title.php) --> commenting out. Variable $restrictions appears only once (line 1399 of Title.php) --> commenting out. Variable $mime appears only once (line 210 of filerepo/OldLocalFile.php) --> removing. Variable $deprefixedName appears only once (line 213 of filerepo/LocalFile.php) --> removing. Variable $m appears only once (line 541 of filerepo/LocalFile.php) --> removing. Variable $where appears only once (line 1245 of filerepo/LocalFile.php) --> removing. Variable $info appears only once (line 1427 of filerepo/LocalFile.php) --> removing. Variable $rel appears only once (line 138 of filerepo/RepoGroup.php) --> commenting out. Variable $zone appears only once (line 138 of filerepo/RepoGroup.php) --> commenting out. Variable $nbytes appears only once (line 208 of media/Generic.php) --> added a return line that uses $nbytes. [Note: I'm assuming that this was the intent] Variable $offset appears only once (line 201 of SpecialListusers.php) --> removing. Variable $limit appears only once (line 201 of SpecialListusers.php) --> removing. Variable $groupTarget appears only once (line 203 of SpecialListusers.php) --> removing. Unused global declaration: $wgLang (line 74 of SpecialWantedpages.php) --> removing. Variable $block appears only once (line 244 of SpecialProtectedpages.php) --> removing. Variable $offset appears only once (line 281 of SpecialProtectedpages.php) --> removing. Variable $limit appears only once (line 281 of SpecialProtectedpages.php) --> removing. Unused global declaration: $wgLang (line 30 of FileDeleteForm.php) --> removing. Unused global declaration: $wgServer (line 30 of FileDeleteForm.php) --> removing.
2007-08-21 03:57:54 +00:00
$m = array();
if ( preg_match( '!^\s*:?\s*\[{2}(.*?)(?:\|.*?)?\]{2}!', $text, $m ) ) {
// Strip preceding colon used to "escape" categories, etc.
// 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], ':' ) );
}
$title = Title::newFromText( $m[1] );
// If the title is a redirect to bad special pages or is invalid, return null
if ( !$title instanceof Title || !$title->isValidRedirectTarget() ) {
return null;
}
return $title;
}
}
return null;
}
# ----------------------------------------------------------------------------
# Static functions
# ----------------------------------------------------------------------------
/**
* Get the prefixed DB key associated with an ID
*
2008-08-11 04:39:00 +00:00
* @param $id \type{\int} the page_id of the article
* @return \type{Title} an object representing the article, or NULL
* if no such article was found
*/
public static function nameOf( $id ) {
$dbr = wfGetDB( DB_SLAVE );
2008-11-13 22:20:51 +00:00
$s = $dbr->selectRow( 'page',
array( 'page_namespace', 'page_title' ),
array( 'page_id' => $id ),
2008-11-13 22:20:51 +00:00
__METHOD__ );
if ( $s === false ) { return null; }
$n = self::makeName( $s->page_namespace, $s->page_title );
return $n;
}
/**
* Get a regex character class describing the legal characters in a link
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} the list of characters, not delimited
*/
public static function legalChars() {
global $wgLegalTitleChars;
return $wgLegalTitleChars;
}
/**
* Get a string representation of a title suitable for
* including in a search index
*
2008-08-11 04:39:00 +00:00
* @param $ns \type{\int} a namespace index
* @param $title \type{\string} text-form main part
* @return \type{\string} a stripped-down title string ready for the
* search index
*/
public static function indexTitle( $ns, $title ) {
2005-12-04 18:27:59 +00:00
global $wgContLang;
2004-08-16 20:14:35 +00:00
$lc = SearchEngine::legalSearchChars() . '&#;';
$t = $wgContLang->normalizeForSearch( $title );
2004-08-16 20:14:35 +00:00
$t = preg_replace( "/[^{$lc}]+/", ' ', $t );
$t = $wgContLang->lc( $t );
# Handle 's, s'
$t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
$t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
2004-08-16 20:14:35 +00:00
$t = preg_replace( "/\\s+/", ' ', $t );
if ( $ns == NS_FILE ) {
$t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
}
return trim( $t );
2003-04-14 23:10:40 +00:00
}
/**
* Make a prefixed DB key from a DB key and a namespace index
*
2008-08-11 04:39:00 +00:00
* @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
*/
public static function makeName( $ns, $title, $fragment = '' ) {
global $wgContLang;
2003-04-14 23:10:40 +00:00
$namespace = $wgContLang->getNsText( $ns );
$name = $namespace == '' ? $title : "$namespace:$title";
if ( strval( $fragment ) != '' ) {
$name .= '#' . $fragment;
}
return $name;
}
/**
* Determine whether the object refers to a page within
* this project.
*
2008-08-11 04:39:00 +00:00
* @return \type{\bool} TRUE if this is an in-project interwiki link
* or a wikilink, FALSE otherwise
*/
public function isLocal() {
2004-08-16 20:14:35 +00:00
if ( $this->mInterwiki != '' ) {
return Interwiki::fetch( $this->mInterwiki )->isLocal();
} else {
return true;
}
}
/**
* Determine whether the object refers to a page within
* this project and is transcludable.
*
2008-08-11 04:39:00 +00:00
* @return \type{\bool} TRUE if this is transcludable
*/
public function isTrans() {
if ( $this->mInterwiki == '' )
return false;
return Interwiki::fetch( $this->mInterwiki )->isTranscludable();
}
/**
* Escape a text fragment, say from a link, for a URL
*
* @param $fragment string containing a URL or link fragment (after the "#")
* @return String: escaped string
*/
static function escapeFragmentForURL( $fragment ) {
2009-01-05 15:59:17 +00:00
# Note that we don't urlencode the fragment. urlencoded Unicode
# fragments appear not to work in IE (at least up to 7) or in at least
# one version of Opera 9.x. The W3C validator, for one, doesn't seem
# to care if they aren't encoded.
return Sanitizer::escapeId( $fragment, 'noninitial' );
}
# ----------------------------------------------------------------------------
# Other stuff
# ----------------------------------------------------------------------------
/** Simple accessors */
/**
* Get the text form (spaces not underscores) of the main part
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} Main part of the title
*/
public function getText() { return $this->mTextform; }
/**
* Get the URL-encoded form of the main part
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} Main part of the title, URL-encoded
*/
public function getPartialURL() { return $this->mUrlform; }
/**
* Get the main part with underscores
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} Main part of the title, with underscores
*/
public function getDBkey() { return $this->mDbkeyform; }
/**
2008-08-11 04:39:00 +00:00
* Get the namespace index, i.e.\ one of the NS_xxxx constants.
*
2008-08-11 04:39:00 +00:00
* @return \type{\int} Namespace index
*/
public function getNamespace() { return $this->mNamespace; }
/**
* Get the namespace text
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} Namespace text
*/
public function getNsText() {
global $wgContLang;
if ( $this->mInterwiki != '' ) {
// This probably shouldn't even happen. ohh man, oh yuck.
// But for interwiki transclusion it sometimes does.
// Shit. Shit shit shit.
//
// Use the canonical namespaces if possible to try to
// resolve a foreign namespace.
if ( MWNamespace::exists( $this->mNamespace ) ) {
return MWNamespace::getCanonicalName( $this->mNamespace );
}
}
return $wgContLang->getNsText( $this->mNamespace );
}
/**
* Get the DB key with the initial letter case as specified by the user
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} DB key
*/
function getUserCaseDBKey() {
return $this->mUserCaseDBKey;
}
/**
* Get the namespace text of the subject (rather than talk) page
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} Namespace text
*/
public function getSubjectNsText() {
global $wgContLang;
return $wgContLang->getNsText( MWNamespace::getSubject( $this->mNamespace ) );
}
/**
* Get the namespace text of the talk page
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} Namespace text
*/
public function getTalkNsText() {
global $wgContLang;
return( $wgContLang->getNsText( MWNamespace::getTalk( $this->mNamespace ) ) );
}
/**
* Could this title have a corresponding talk page?
*
2008-08-11 04:39:00 +00:00
* @return \type{\bool} TRUE or FALSE
*/
public function canTalk() {
return( MWNamespace::canTalk( $this->mNamespace ) );
}
/**
* Get the interwiki prefix (or null string)
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} Interwiki prefix
*/
public function getInterwiki() { return $this->mInterwiki; }
/**
2008-08-11 04:39:00 +00:00
* Get the Title fragment (i.e.\ the bit after the #) in text form
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} Title fragment
*/
public function getFragment() { return $this->mFragment; }
/**
* Get the fragment in URL form, including the "#" character if there is one
2008-08-11 04:39:00 +00:00
* @return \type{\string} Fragment in URL form
*/
public function getFragmentForURL() {
if ( $this->mFragment == '' ) {
return '';
} else {
return '#' . Title::escapeFragmentForURL( $this->mFragment );
}
}
/**
* Get the default namespace index, for when there is no namespace
*
2008-08-11 04:39:00 +00:00
* @return \type{\int} Default namespace index
*/
public function getDefaultNamespace() { return $this->mDefaultNamespace; }
2003-04-14 23:10:40 +00:00
/**
* Get title for search index
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} a stripped-down title string ready for the
* search index
*/
public function getIndexTitle() {
2003-04-14 23:10:40 +00:00
return Title::indexTitle( $this->mNamespace, $this->mTextform );
}
/**
* Get the prefixed database key form
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} the prefixed title, with underscores and
* any interwiki and namespace prefixes
*/
public function getPrefixedDBkey() {
2003-04-14 23:10:40 +00:00
$s = $this->prefix( $this->mDbkeyform );
2004-08-16 20:14:35 +00:00
$s = str_replace( ' ', '_', $s );
2003-04-14 23:10:40 +00:00
return $s;
}
/**
* Get the prefixed title with spaces.
* This is the form usually used for display
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} the prefixed title, with spaces
*/
public function getPrefixedText() {
if ( empty( $this->mPrefixedText ) ) { // FIXME: bad usage of empty() ?
2003-10-22 23:56:49 +00:00
$s = $this->prefix( $this->mTextform );
2004-08-16 20:14:35 +00:00
$s = str_replace( '_', ' ', $s );
2003-10-22 23:56:49 +00:00
$this->mPrefixedText = $s;
}
return $this->mPrefixedText;
2003-04-14 23:10:40 +00:00
}
/**
* Get the prefixed title with spaces, plus any fragment
* (part beginning with '#')
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} the prefixed title, with spaces and
* the fragment, including '#'
*/
public function getFullText() {
$text = $this->getPrefixedText();
if ( $this->mFragment != '' ) {
$text .= '#' . $this->mFragment;
}
return $text;
}
2003-04-14 23:10:40 +00:00
/**
* Get the base name, i.e. the leftmost parts before the /
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} Base name
*/
public function getBaseText() {
if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
return $this->getText();
}
$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 ] );
return implode( '/', $parts );
}
/**
* Get the lowest-level subpage name, i.e. the rightmost part after /
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} Subpage name
*/
public function getSubpageText() {
if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
return( $this->mTextform );
}
$parts = explode( '/', $this->mTextform );
return( $parts[ count( $parts ) - 1 ] );
}
2006-04-02 16:19:29 +00:00
/**
* Get a URL-encoded form of the subpage text
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} URL-encoded subpage name
2006-04-02 16:19:29 +00:00
*/
public function getSubpageUrlForm() {
2006-04-02 16:19:29 +00:00
$text = $this->getSubpageText();
$text = wfUrlencode( str_replace( ' ', '_', $text ) );
return( $text );
}
/**
* Get a URL-encoded title (not an actual URL) including interwiki
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} the URL-encoded form
*/
public function getPrefixedURL() {
2003-04-14 23:10:40 +00:00
$s = $this->prefix( $this->mDbkeyform );
$s = wfUrlencode( str_replace( ' ', '_', $s ) );
2003-04-14 23:10:40 +00:00
return $s;
}
/**
* Get a real URL referring to this title, with interwiki link and
* fragment
*
2008-08-11 04:39:00 +00:00
* @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).
2008-08-11 04:39:00 +00:00
* @param $variant \type{\string} language variant of url (for sr, zh..)
* @return \type{\string} the URL
*/
public function getFullURL( $query = '', $variant = false ) {
global $wgContLang, $wgServer, $wgRequest;
if ( is_array( $query ) ) {
$query = wfArrayToCGI( $query );
}
$interwiki = Interwiki::fetch( $this->mInterwiki );
if ( !$interwiki ) {
$url = $this->getLocalURL( $query, $variant );
// Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
// Correct fix would be to move the prepending elsewhere.
if ( $wgRequest->getVal( 'action' ) != 'render' ) {
$url = $wgServer . $url;
}
} else {
$baseUrl = $interwiki->getURL( );
$namespace = wfUrlencode( $this->getNsText() );
if ( $namespace != '' ) {
# Can this actually happen? Interwikis shouldn't be parsed.
# Yes! It can in interwiki transclusion. But... it probably shouldn't.
$namespace .= ':';
}
$url = str_replace( '$1', $namespace . $this->mUrlform, $baseUrl );
$url = wfAppendQuery( $url, $query );
}
# Finally, add the fragment.
$url .= $this->getFragmentForURL();
wfRunHooks( 'GetFullURL', array( &$this, &$url, $query ) );
return $url;
}
/**
2005-07-04 04:20:07 +00:00
* Get a URL with no fragment or server name. If this page is generated
* with action=render, $wgServer is prepended.
*
* @param $query Mixed: an optional query string; if not specified,
* $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).
2008-08-11 04:39:00 +00:00
* @param $variant \type{\string} language variant of url (for sr, zh..)
* @return \type{\string} the URL
*/
public function getLocalURL( $query = '', $variant = false ) {
global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
global $wgVariantArticlePath, $wgContLang, $wgUser;
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;
}
2005-07-03 08:17:18 +00:00
if ( $this->isExternal() ) {
$url = $this->getFullURL();
if ( $query ) {
2006-03-11 17:13:49 +00:00
// This is currently only used for edit section links in the
// context of interwiki transclusion. In theory we should
// append the query to the end of any existing query string,
// but interwiki transclusion is already broken in that case.
$url .= "?$query";
}
} else {
$dbkey = wfUrlencode( $this->getPrefixedDBkey() );
if ( $query == '' ) {
if ( $variant != false && $wgContLang->hasVariants() ) {
if ( !$wgVariantArticlePath ) {
$variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
} else {
$variantArticlePath = $wgVariantArticlePath;
}
$url = str_replace( '$2', urlencode( $variant ), $variantArticlePath );
$url = str_replace( '$1', $dbkey, $url );
} else {
$url = str_replace( '$1', $dbkey, $wgArticlePath );
}
} else {
global $wgActionPaths;
$url = false;
$matches = array();
if ( !empty( $wgActionPaths ) &&
2006-01-07 13:09:30 +00:00
preg_match( '/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches ) )
{
$action = urldecode( $matches[2] );
if ( isset( $wgActionPaths[$action] ) ) {
$query = $matches[1];
if ( isset( $matches[4] ) ) $query .= $matches[4];
$url = str_replace( '$1', $dbkey, $wgActionPaths[$action] );
if ( $query != '' ) {
2009-01-02 17:10:26 +00:00
$url = wfAppendQuery( $url, $query );
}
}
}
if ( $url === false ) {
if ( $query == '-' ) {
$query = '';
}
$url = "{$wgScript}?title={$dbkey}&{$query}";
}
}
// FIXME: this causes breakage in various places when we
// actually expected a local URL and end up with dupe prefixes.
if ( $wgRequest->getVal( 'action' ) == 'render' ) {
$url = $wgServer . $url;
}
}
wfRunHooks( 'GetLocalURL', array( &$this, &$url, $query ) );
return $url;
}
/**
* Get a URL that's the simplest URL that will be valid to link, locally,
* to the current Title. It includes the fragment, but does not include
* the server unless action=render is used (or the link is external). If
* there's a fragment but the prefixed text is empty, we just return a link
* to the fragment.
*
* 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
* query string. Keys and values will be escaped.
2008-08-11 04:39:00 +00:00
* @param $variant \type{\string} Language variant of URL (for sr, zh..). Ignored
* for external links. Default is "false" (same variant as current page,
* for anonymous users).
2008-08-11 04:39:00 +00:00
* @return \type{\string} the URL
*/
public function getLinkUrl( $query = array(), $variant = false ) {
wfProfileIn( __METHOD__ );
if ( $this->isExternal() ) {
$ret = $this->getFullURL( $query );
} elseif ( $this->getPrefixedText() === '' && $this->getFragment() !== '' ) {
$ret = $this->getFragmentForURL();
} else {
2009-02-24 00:03:33 +00:00
$ret = $this->getLocalURL( $query, $variant ) . $this->getFragmentForURL();
}
wfProfileOut( __METHOD__ );
return $ret;
}
/**
* Get an HTML-escaped version of the URL form, suitable for
* using in a link, without a server name or fragment
*
2008-08-11 04:39:00 +00:00
* @param $query \type{\string} an optional query string
* @return \type{\string} the URL
*/
public function escapeLocalURL( $query = '' ) {
return htmlspecialchars( $this->getLocalURL( $query ) );
}
/**
* Get an HTML-escaped version of the URL form, suitable for
* using in a link, including the server name and fragment
*
2008-08-11 04:39:00 +00:00
* @param $query \type{\string} an optional query string
* @return \type{\string} the URL
*/
public function escapeFullURL( $query = '' ) {
return htmlspecialchars( $this->getFullURL( $query ) );
}
/**
* Get the URL form for an internal link.
* - Used in various Squid-related code, in case we have a different
* internal hostname for the server from the exposed one.
*
2008-08-11 04:39:00 +00:00
* @param $query \type{\string} an optional query string
* @param $variant \type{\string} language variant of url (for sr, zh..)
* @return \type{\string} the URL
*/
public function getInternalURL( $query = '', $variant = false ) {
global $wgInternalServer;
$url = $wgInternalServer . $this->getLocalURL( $query, $variant );
wfRunHooks( 'GetInternalURL', array( &$this, &$url, $query ) );
return $url;
}
/**
* Get the edit URL for this Title
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} the URL, or a null string if this is an
* interwiki link
*/
public function getEditURL() {
if ( $this->mInterwiki != '' ) { return ''; }
2004-08-16 20:14:35 +00:00
$s = $this->getLocalURL( 'action=edit' );
2003-04-14 23:10:40 +00:00
return $s;
}
/**
* Get the HTML-escaped displayable text form.
* Used for the title field in <a> tags.
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} the text, including any prefixes
*/
public function getEscapedText() {
return htmlspecialchars( $this->getPrefixedText() );
2003-10-22 23:56:49 +00:00
}
/**
* Is this Title interwiki?
*
2008-08-11 04:39:00 +00:00
* @return \type{\bool}
*/
public function isExternal() { return ( $this->mInterwiki != '' ); }
2003-04-14 23:10:40 +00:00
/**
* Is this page "semi-protected" - the *only* protection is autoconfirm?
*
2010-02-23 18:36:46 +00:00
* @param $action \type{\string} Action to check (default: edit)
2008-08-11 04:39:00 +00:00
* @return \type{\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' )
return false;
}
} else {
# Not protected
return false;
}
2006-12-27 07:48:01 +00:00
return true;
} else {
# If it doesn't exist, it can't be protected
return false;
}
}
/**
* Does the title correspond to a protected article?
*
2010-02-23 18:36:46 +00:00
* @param $action \type{\string} the action the page is protected from,
* by default checks all actions.
2008-08-11 04:39:00 +00:00
* @return \type{\bool}
*/
public function isProtected( $action = '' ) {
global $wgRestrictionLevels;
$restrictionTypes = $this->getRestrictionTypes();
# Special pages have inherent protection
if( $this->getNamespace() == NS_SPECIAL )
return true;
# Check regular protection levels
foreach ( $restrictionTypes as $type ) {
if ( $action == $type || $action == '' ) {
$r = $this->getRestrictions( $type );
foreach ( $wgRestrictionLevels as $level ) {
if ( in_array( $level, $r ) && $level != '' ) {
return true;
}
2006-01-18 03:24:21 +00:00
}
}
}
2006-01-18 03:24:21 +00:00
2003-04-14 23:10:40 +00:00
return false;
}
/**
* Is this a conversion table for the LanguageConverter?
*
* @return \type{\bool}
*/
public function isConversionTable() {
if($this->getNamespace() == NS_MEDIAWIKI
&& strpos( $this->getText(), 'Conversiontable' ) !== false ) {
return true;
}
return false;
}
/**
* Is $wgUser watching this page?
*
2008-08-11 04:39:00 +00:00
* @return \type{\bool}
*/
public function userIsWatching() {
2003-04-14 23:10:40 +00:00
global $wgUser;
if ( is_null( $this->mWatched ) ) {
if ( NS_SPECIAL == $this->mNamespace || !$wgUser->isLoggedIn() ) {
$this->mWatched = false;
} else {
$this->mWatched = $wgUser->isWatched( $this );
}
}
return $this->mWatched;
2003-04-14 23:10:40 +00:00
}
2007-11-15 14:47:40 +00:00
/**
* Can $wgUser perform $action on this page?
* This skips potentially expensive cascading permission checks
* as well as avoids expensive error formatting
*
* Suitable for use for nonessential UI controls in common cases, but
* _not_ for functional access control.
*
* May provide false positives, but should never provide a false negative.
*
2008-08-11 04:39:00 +00:00
* @param $action \type{\string} action that permission needs to be checked for
* @return \type{\bool}
*/
Revert r38196, r38204 -- "(bugs 6089, 13079) Show edit section links for transcluded template if, and only if the user can edit it, made Title::getUserPermissionsErrorsInternal() public so that it can be used in Parser and it can pass the User object from ParserOptions. " & co Cause regression in 19 parser test cases, looks like messing up the tooltips for section edit links. 19 previously failing test(s) now PASSING! :) * Bug 6563: Edit link generation for section shown by <includeonly> [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Bug 6563: Edit link generation for section suppressed by <includeonly> [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Basic section headings [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Section headings with TOC [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Handling of sections up to level 6 and beyond [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * TOC regression (bug 9764) [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * TOC with wgMaxTocLevel=3 (bug 6204) [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Resolving duplicate section names [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Resolving duplicate section names with differing case (bug 10721) [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Template with sections, __NOTOC__ [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Link inside a section heading [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * TOC regression (bug 12077) [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Fuzz testing: Parser14 [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Fuzz testing: Parser14-table [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Inclusion of !userCanEdit() content [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Out-of-order TOC heading levels [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * -{}- tags within headlines (within html for parserConvert()) [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Morwen/13: Unclosed link followed by heading [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * HHP2.2: Heuristics for headings in preprocessor parenthetical structures [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)]
2008-07-29 23:56:30 +00:00
public function quickUserCan( $action ) {
return $this->userCan( $action, false );
}
/**
* Determines if $wgUser is unable to edit this page because it has been protected
* by $wgNamespaceProtection.
2007-11-15 14:47:40 +00:00
*
2008-08-11 04:39:00 +00:00
* @return \type{\bool}
*/
public function isNamespaceProtected() {
global $wgNamespaceProtection, $wgUser;
if ( isset( $wgNamespaceProtection[ $this->mNamespace ] ) ) {
foreach ( (array)$wgNamespaceProtection[ $this->mNamespace ] as $right ) {
if ( $right != '' && !$wgUser->isAllowed( $right ) )
return true;
}
}
return false;
}
2007-11-15 14:47:40 +00:00
/**
* Can $wgUser perform $action on this page?
*
* @param $action \type{\string} action that permission needs to be checked for
2008-08-11 04:39:00 +00:00
* @param $doExpensiveQueries \type{\bool} Set this to false to avoid doing unnecessary queries.
* @return \type{\bool}
*/
Revert r38196, r38204 -- "(bugs 6089, 13079) Show edit section links for transcluded template if, and only if the user can edit it, made Title::getUserPermissionsErrorsInternal() public so that it can be used in Parser and it can pass the User object from ParserOptions. " & co Cause regression in 19 parser test cases, looks like messing up the tooltips for section edit links. 19 previously failing test(s) now PASSING! :) * Bug 6563: Edit link generation for section shown by <includeonly> [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Bug 6563: Edit link generation for section suppressed by <includeonly> [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Basic section headings [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Section headings with TOC [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Handling of sections up to level 6 and beyond [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * TOC regression (bug 9764) [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * TOC with wgMaxTocLevel=3 (bug 6204) [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Resolving duplicate section names [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Resolving duplicate section names with differing case (bug 10721) [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Template with sections, __NOTOC__ [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Link inside a section heading [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * TOC regression (bug 12077) [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Fuzz testing: Parser14 [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Fuzz testing: Parser14-table [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Inclusion of !userCanEdit() content [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Out-of-order TOC heading levels [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * -{}- tags within headlines (within html for parserConvert()) [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * Morwen/13: Unclosed link followed by heading [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)] * HHP2.2: Heuristics for headings in preprocessor parenthetical structures [Fixed between 29-Jul-2008 22:42:06, 1.14alpha (r38207) and 29-Jul-2008 23:54:51, 1.14alpha (r38207)]
2008-07-29 23:56:30 +00:00
public function userCan( $action, $doExpensiveQueries = true ) {
global $wgUser;
return ( $this->getUserPermissionsErrorsInternal( $action, $wgUser, $doExpensiveQueries, true ) === array() );
}
2007-11-15 14:47:40 +00:00
/**
2008-01-13 22:26:08 +00:00
* Can $user perform $action on this page?
*
* FIXME: This *does not* check throttles (User::pingLimiter()).
*
2008-08-11 04:39:00 +00:00
* @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.
2008-08-11 04:39:00 +00:00
* @return \type{\array} 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.
foreach ( $errors as $index => $error ) {
$error_key = is_array( $error ) ? $error[0] : $error;
if ( in_array( $error_key, $ignoreErrors ) ) {
unset( $errors[$index] );
}
}
return $errors;
}
/**
* Permissions checks that fail most often, and which are easiest to test.
*
* @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 checkQuickPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
if ( $action == 'create' ) {
if ( ( $this->isTalkPage() && !$user->isAllowed( 'createtalk' ) ) ||
( !$this->isTalkPage() && !$user->isAllowed( 'createpage' ) ) ) {
$errors[] = $user->isAnon() ? array ( 'nocreatetext' ) : array ( 'nocreate-loggedin' );
}
} elseif ( $action == 'move' ) {
if ( !$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-user-page' );
}
// Check if user is allowed to move files if it's a file
if ( $this->mNamespace == NS_FILE && !$user->isAllowed( 'movefile' ) ) {
$errors[] = array( 'movenotallowedfile' );
}
if ( !$user->isAllowed( 'move' ) ) {
// User can't move anything
global $wgGroupPermissions;
$userCanMove = false;
2009-07-17 22:26:39 +00:00
if ( isset( $wgGroupPermissions['user']['move'] ) ) {
$userCanMove = $wgGroupPermissions['user']['move'];
}
$autoconfirmedCanMove = false;
2009-07-17 22:26:39 +00:00
if ( isset( $wgGroupPermissions['autoconfirmed']['move'] ) ) {
$autoconfirmedCanMove = $wgGroupPermissions['autoconfirmed']['move'];
}
if ( $user->isAnon() && ( $userCanMove || $autoconfirmedCanMove ) ) {
// custom message if logged-in users without any special rights can move
$errors[] = array ( 'movenologintext' );
} else {
$errors[] = array ( 'movenotallowed' );
}
}
} elseif ( $action == 'move-target' ) {
if ( !$user->isAllowed( 'move' ) ) {
// User can't move anything
$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 ) {
$groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
User::getGroupsWithPermission( $action ) );
}
if ( $groups ) {
2010-03-13 16:50:36 +00:00
global $wgLang;
$return = array(
2010-03-13 16:09:23 +00:00
'badaccess-groups',
$wgLang->commaList( $groups ),
2010-03-13 16:09:23 +00:00
count( $groups )
);
} else {
$return = array( "badaccess-group0" );
}
$errors[] = $return;
}
return $errors;
}
/**
* Add the resulting error code to the errors array
*
* @param $errors Array list of current errors
* @param $result Mixed result of errors
*
* @return Array list of errors
*/
private function resultToError( $errors, $result ) {
if ( is_array( $result ) && count( $result ) && !is_array( $result[0] ) ) {
// A single array representing an error
$errors[] = $result;
} else if ( is_array( $result ) && is_array( $result[0] ) ) {
// A nested array representing multiple errors
$errors = array_merge( $errors, $result );
} else if ( $result !== '' && is_string( $result ) ) {
// A string representing a message-id
$errors[] = array( $result );
} else if ( $result === false ) {
// a generic "We don't want them to do that"
$errors[] = array( 'badaccess-group0' );
}
return $errors;
}
/**
* Check various permission hooks
* @see checkQuickPermissions for parameter information
*/
private function checkPermissionHooks( $action, $user, $errors, $doExpensiveQueries, $short ) {
// Use getUserPermissionsErrors instead
if ( !wfRunHooks( 'userCan', array( &$this, &$user, $action, &$result ) ) ) {
return $result ? array() : array( array( 'badaccess-group0' ) );
}
// Check getUserPermissionsErrors hook
if ( !wfRunHooks( 'getUserPermissionsErrors', array( &$this, &$user, $action, &$result ) ) ) {
$errors = $this->resultToError( $errors, $result );
}
// Check getUserPermissionsErrorsExpensive hook
if ( $doExpensiveQueries && !( $short && count( $errors ) > 0 ) &&
!wfRunHooks( 'getUserPermissionsErrorsExpensive', array( &$this, &$user, $action, &$result ) ) ) {
$errors = $this->resultToError( $errors, $result );
}
return $errors;
}
/**
* Check permissions on special pages & namespaces
* @see checkQuickPermissions for parameter information
*/
private function checkSpecialsAndNSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
# Only 'createaccount' and 'execute' can be performed on
# special pages, which don't actually exist in the DB.
$specialOKActions = array( 'createaccount', 'execute' );
if ( NS_SPECIAL == $this->mNamespace && !in_array( $action, $specialOKActions ) ) {
$errors[] = array( 'ns-specialprotected' );
}
# Check $wgNamespaceProtection for restricted namespaces
if ( $this->isNamespaceProtected() ) {
$ns = $this->mNamespace == NS_MAIN ?
2008-12-08 00:10:22 +00:00
wfMsg( 'nstab-main' ) : $this->getNsText();
$errors[] = $this->mNamespace == NS_MEDIAWIKI ?
array( 'protectedinterface' ) : array( 'namespaceprotected', $ns );
}
return $errors;
}
/**
* Check CSS/JS sub-page permissions
* @see checkQuickPermissions for parameter information
*/
private function checkCSSandJSPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
# Protect css/js subpages of user pages
# XXX: this might be better using restrictions
# XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssSubpage()
# and $this->userCanEditJsSubpage() from working
# XXX: right 'editusercssjs' is deprecated, for backward compatibility only
if ( $action != 'patrol' && !$user->isAllowed( 'editusercssjs' )
&& !preg_match( '/^' . preg_quote( $user->getName(), '/' ) . '\//', $this->mTextform ) ) {
if ( $this->isCssSubpage() && !$user->isAllowed( 'editusercss' ) ) {
$errors[] = array( 'customcssjsprotected' );
} else if ( $this->isJsSubpage() && !$user->isAllowed( 'edituserjs' ) ) {
$errors[] = array( 'customcssjsprotected' );
}
}
return $errors;
}
/**
* Check against page_restrictions table requirements on this
* page. The user must possess all required rights for this
* action.
* @see checkQuickPermissions for parameter information
*/
private function checkPageRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
foreach ( $this->getRestrictions( $action ) as $right ) {
// Backwards compatibility, rewrite sysop -> protect
if ( $right == 'sysop' ) {
$right = 'protect';
}
if ( $right != '' && !$user->isAllowed( $right ) ) {
// Users with 'editprotected' permission can edit protected pages
if ( $action == 'edit' && $user->isAllowed( 'editprotected' ) ) {
// Users with 'editprotected' permission cannot edit protected pages
// with cascading option turned on.
if ( $this->mCascadeRestriction ) {
$errors[] = array( 'protectedpagetext', $right );
}
} else {
$errors[] = array( 'protectedpagetext', $right );
}
}
}
return $errors;
}
/**
* Check restrictions on cascading pages.
* @see checkQuickPermissions for parameter information
*/
private function checkCascadingSourcesRestrictions( $action, $user, $errors, $doExpensiveQueries, $short ) {
if ( $doExpensiveQueries && !$this->isCssJsSubpage() ) {
# We /could/ use the protection level on the source page, but it's
# fairly ugly as we have to establish a precedence hierarchy for pages
# included by multiple cascade-protected pages. So just restrict
# it to people with 'protect' permission, as they could remove the
# protection anyway.
list( $cascadingSources, $restrictions ) = $this->getCascadeProtectionSources();
# Cascading protection depends on more than this page...
# Several cascading protected pages may include this page...
# Check each cascading level
# This is only for protection restrictions, not for all actions
if ( isset( $restrictions[$action] ) ) {
foreach ( $restrictions[$action] as $right ) {
$right = ( $right == 'sysop' ) ? 'protect' : $right;
if ( $right != '' && !$user->isAllowed( $right ) ) {
$pages = '';
foreach ( $cascadingSources as $page )
$pages .= '* [[:' . $page->getPrefixedText() . "]]\n";
$errors[] = array( 'cascadeprotected', count( $cascadingSources ), $pages );
}
}
}
}
return $errors;
}
/**
* Check action permissions not already checked in checkQuickPermissions
* @see checkQuickPermissions for parameter information
*/
private function checkActionPermissions( $action, $user, $errors, $doExpensiveQueries, $short ) {
if ( $action == 'protect' ) {
if ( $this->getUserPermissionsErrors( 'edit', $user ) != array() ) {
// If they can't edit, they shouldn't protect.
$errors[] = array( 'protect-cantedit' );
}
} elseif ( $action == 'create' ) {
$title_protection = $this->getTitleProtection();
if( $title_protection ) {
if( $title_protection['pt_create_perm'] == 'sysop' ) {
$title_protection['pt_create_perm'] = 'protect'; // B/C
2008-12-08 00:10:22 +00:00
}
if( $title_protection['pt_create_perm'] == '' || !$user->isAllowed( $title_protection['pt_create_perm'] ) ) {
$errors[] = array( 'titleprotected', User::whoIs( $title_protection['pt_user'] ), $title_protection['pt_reason'] );
}
}
} elseif ( $action == 'move' ) {
// Check for immobile pages
if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
// Specific message for this case
$errors[] = array( 'immobile-source-namespace', $this->getNsText() );
} elseif ( !$this->isMovable() ) {
// Less specific message for rarer cases
$errors[] = array( 'immobile-page' );
}
} elseif ( $action == 'move-target' ) {
if ( !MWNamespace::isMovable( $this->mNamespace ) ) {
$errors[] = array( 'immobile-target-namespace', $this->getNsText() );
} elseif ( !$this->isMovable() ) {
$errors[] = array( 'immobile-target-page' );
}
}
return $errors;
}
/**
* Check that the user isn't blocked from editting.
* @see checkQuickPermissions for parameter information
*/
private function checkUserBlock( $action, $user, $errors, $doExpensiveQueries, $short ) {
if( $short ) {
return $errors;
}
global $wgContLang;
global $wgLang;
global $wgEmailConfirmToEdit;
if ( $wgEmailConfirmToEdit && !$user->isEmailConfirmed() && $action != 'createaccount' ) {
$errors[] = array( 'confirmedittext' );
}
// Edit blocks should not affect reading. Account creation blocks handled at userlogin.
if ( $action != 'read' && $action != 'createaccount' && $user->isBlockedFrom( $this ) ) {
$block = $user->mBlock;
// This is from OutputPage::blockedPage
// Copied at r23888 by werdna
$id = $user->blockedBy();
$reason = $user->blockedFor();
if ( $reason == '' ) {
$reason = wfMsg( 'blockednoreason' );
}
$ip = wfGetIP();
if ( is_numeric( $id ) ) {
$name = User::whoIs( $id );
} else {
$name = $id;
}
$link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]";
$blockid = $block->mId;
$blockExpiry = $user->mBlock->mExpiry;
$blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW, $user->mBlock->mTimestamp ), true );
if ( $blockExpiry == 'infinity' ) {
// Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
$scBlockExpiryOptions = wfMsg( 'ipboptions' );
foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
if ( !strpos( $option, ':' ) )
continue;
list ( $show, $value ) = explode( ":", $option );
if ( $value == 'infinite' || $value == 'indefinite' ) {
$blockExpiry = $show;
break;
}
}
} else {
$blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW, $blockExpiry ), true );
}
$intended = $user->mBlock->mAddress;
$errors[] = array( ( $block->mAuto ? 'autoblockedtext' : 'blockedtext' ), $link, $reason, $ip, $name,
$blockid, $blockExpiry, $intended, $blockTimestamp );
}
return $errors;
}
/**
* Can $user perform $action on this page? This is an internal function,
* 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.
*/
protected function getUserPermissionsErrorsInternal( $action, $user, $doExpensiveQueries = true, $short = false ) {
wfProfileIn( __METHOD__ );
$errors = array();
$checks = array( 'checkQuickPermissions',
'checkPermissionHooks',
'checkSpecialsAndNSPermissions',
'checkCSSandJSPermissions',
'checkPageRestrictions',
'checkCascadingSourcesRestrictions',
'checkActionPermissions',
'checkUserBlock' );
while( count( $checks ) > 0 &&
!( $short && count( $errors ) > 0 ) ) {
$method = array_shift( $checks );
$errors = $this->$method( $action, $user, $errors, $doExpensiveQueries, $short );
}
wfProfileOut( __METHOD__ );
return $errors;
2003-04-14 23:10:40 +00:00
}
/**
* Is this title subject to title protection?
*
2008-08-11 04:39:00 +00:00
* @return \type{\mixed} An associative array representing any existent title
* protection, or false if there's none.
*/
private function getTitleProtection() {
// Can't protect pages in special namespaces
if ( $this->getNamespace() < 0 ) {
return false;
}
// Can't protect pages that exist.
if ( $this->exists() ) {
return false;
}
if ( !isset( $this->mTitleProtection ) ) {
$dbr = wfGetDB( DB_SLAVE );
$res = $dbr->select( 'protected_titles', '*',
array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
__METHOD__ );
// fetchRow returns false if there are no rows.
$this->mTitleProtection = $dbr->fetchRow( $res );
}
return $this->mTitleProtection;
}
2008-08-11 04:39:00 +00:00
/**
* Update the title protection status
*
2008-08-11 04:39:00 +00:00
* @param $create_perm \type{\string} Permission required for creation
* @param $reason \type{\string} Reason for protection
* @param $expiry \type{\string} Expiry timestamp
* @return boolean true
2008-08-11 04:39:00 +00:00
*/
public function updateTitleProtection( $create_perm, $reason, $expiry ) {
global $wgUser, $wgContLang;
if ( $create_perm == implode( ',', $this->getRestrictions( 'create' ) )
&& $expiry == $this->mRestrictionsExpiry['create'] ) {
// No change
return true;
}
list ( $namespace, $title ) = array( $this->getNamespace(), $this->getDBkey() );
$dbw = wfGetDB( DB_MASTER );
$encodedExpiry = Block::encodeExpiry( $expiry, $dbw );
$expiry_description = '';
if ( $encodedExpiry != 'infinity' ) {
$expiry_description = ' (' . wfMsgForContent( 'protect-expiring', $wgContLang->timeanddate( $expiry ),
$wgContLang->date( $expiry ) , $wgContLang->time( $expiry ) ) . ')';
}
else {
$expiry_description .= ' (' . wfMsgForContent( 'protect-expiry-indefinite' ) . ')';
}
# Update protection table
if ( $create_perm != '' ) {
$dbw->replace( 'protected_titles', array( array( 'pt_namespace', 'pt_title' ) ),
array(
'pt_namespace' => $namespace,
'pt_title' => $title,
'pt_create_perm' => $create_perm,
'pt_timestamp' => Block::encodeExpiry( wfTimestampNow(), $dbw ),
'pt_expiry' => $encodedExpiry,
'pt_user' => $wgUser->getId(),
'pt_reason' => $reason,
), __METHOD__
);
} else {
$dbw->delete( 'protected_titles', array( 'pt_namespace' => $namespace,
'pt_title' => $title ), __METHOD__ );
}
# Update the protection log
if ( $dbw->affectedRows() ) {
$log = new LogPage( 'protect' );
if ( $create_perm ) {
$params = array( "[create=$create_perm] $expiry_description", '' );
$log->addEntry( ( isset( $this->mRestrictions['create'] ) && $this->mRestrictions['create'] ) ? 'modify' : 'protect', $this, trim( $reason ), $params );
} else {
$log->addEntry( 'unprotect', $this, $reason );
}
}
return true;
}
/**
2008-08-11 04:39:00 +00:00
* Remove any title protection due to page existing
*/
public function deleteTitleProtection() {
$dbw = wfGetDB( DB_MASTER );
$dbw->delete( 'protected_titles',
array( 'pt_namespace' => $this->getNamespace(), 'pt_title' => $this->getDBkey() ),
2008-11-13 22:20:51 +00:00
__METHOD__ );
}
/**
2005-04-25 13:09:29 +00:00
* Would anybody with sufficient privileges be able to move this page?
* Some pages just aren't movable.
*
2008-08-11 04:39:00 +00:00
* @return \type{\bool} TRUE or FALSE
*/
public function isMovable() {
2008-11-13 22:20:51 +00:00
return MWNamespace::isMovable( $this->getNamespace() ) && $this->getInterwiki() == '';
}
/**
* Can $wgUser read this page?
*
* @return \type{\bool}
* @todo fold these checks into userCan()
*/
public function userCanRead() {
global $wgUser, $wgGroupPermissions;
static $useShortcut = null;
# Initialize the $useShortcut boolean, to determine if we can skip quite a bit of code below
if ( is_null( $useShortcut ) ) {
global $wgRevokePermissions;
$useShortcut = true;
if ( empty( $wgGroupPermissions['*']['read'] ) ) {
# Not a public wiki, so no shortcut
$useShortcut = false;
} elseif ( !empty( $wgRevokePermissions ) ) {
/*
* Iterate through each group with permissions being revoked (key not included since we don't care
* what the group name is), then check if the read permission is being revoked. If it is, then
* we don't use the shortcut below since the user might not be able to read, even though anon
* reading is allowed.
*/
foreach ( $wgRevokePermissions as $perms ) {
if ( !empty( $perms['read'] ) ) {
# We might be removing the read right from the user, so no shortcut
$useShortcut = false;
break;
}
}
}
}
$result = null;
wfRunHooks( 'userCan', array( &$this, &$wgUser, 'read', &$result ) );
if ( $result !== null ) {
return $result;
}
# Shortcut for public wikis, allows skipping quite a bit of code
if ( $useShortcut )
return true;
if ( $wgUser->isAllowed( 'read' ) ) {
return true;
} else {
global $wgWhitelistRead;
/**
* Always grant access to the login page.
* Even anons need to be able to log in.
*/
if ( $this->isSpecial( 'Userlogin' ) || $this->isSpecial( 'Resetpass' ) ) {
return true;
}
/**
* Bail out if there isn't whitelist
*/
if ( !is_array( $wgWhitelistRead ) ) {
return false;
}
/**
* Check for explicit whitelisting
*/
$name = $this->getPrefixedText();
$dbName = $this->getPrefixedDBKey();
// Check with and without underscores
if ( in_array( $name, $wgWhitelistRead, true ) || in_array( $dbName, $wgWhitelistRead, true ) )
return true;
/**
* Old settings might have the title prefixed with
* a colon for main-namespace pages
*/
if ( $this->getNamespace() == NS_MAIN ) {
if ( in_array( ':' . $name, $wgWhitelistRead ) )
return true;
}
/**
* If it's a special page, ditch the subpage bit
* and check again
*/
if ( $this->getNamespace() == NS_SPECIAL ) {
$name = $this->getDBkey();
list( $name, /* $subpage */ ) = SpecialPage::resolveAliasWithSubpage( $name );
if ( $name === false ) {
# Invalid special page, but we show standard login required message
return false;
}
$pure = SpecialPage::getTitleFor( $name )->getPrefixedText();
if ( in_array( $pure, $wgWhitelistRead, true ) )
return true;
}
}
return false;
}
/**
* Is this a talk page of some sort?
*
* @return \type{\bool}
*/
public function isTalkPage() {
return MWNamespace::isTalk( $this->getNamespace() );
}
2006-12-12 19:14:29 +00:00
/**
* Is this a subpage?
*
* @return \type{\bool}
2006-12-12 19:14:29 +00:00
*/
public function isSubpage() {
return MWNamespace::hasSubpages( $this->mNamespace )
2008-05-23 22:20:09 +00:00
? strpos( $this->getText(), '/' ) !== false
: false;
2006-12-12 19:14:29 +00:00
}
/**
* Does this have subpages? (Warning, usually requires an extra DB query.)
*
* @return \type{\bool}
*/
public function hasSubpages() {
if ( !MWNamespace::hasSubpages( $this->mNamespace ) ) {
# Duh
return false;
}
# We dynamically add a member variable for the purpose of this method
# alone to cache the result. There's no point in having it hanging
# around uninitialized in every Title object; therefore we only add it
# if needed and don't declare it statically.
if ( isset( $this->mHasSubpages ) ) {
return $this->mHasSubpages;
}
$subpages = $this->getSubpages( 1 );
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
* @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() ) )
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 )
$options['LIMIT'] = $limit;
return $this->mSubpages = TitleArray::newFromResult(
$dbr->select( 'page',
array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' ),
$conds,
__METHOD__,
$options
)
);
}
/**
* Could this page contain custom CSS or JavaScript, based
* on the title?
*
* @return \type{\bool}
*/
public function isCssOrJsPage() {
return $this->mNamespace == NS_MEDIAWIKI
&& preg_match( '!\.(?:css|js)$!u', $this->mTextform ) > 0;
}
2006-12-12 19:14:29 +00:00
/**
* Is this a .css or .js subpage of a user page?
* @return \type{\bool}
*/
public function isCssJsSubpage() {
return ( NS_USER == $this->mNamespace and preg_match( "/\\/.*\\.(?:css|js)$/", $this->mTextform ) );
}
/**
* Is this a *valid* .css or .js subpage of a user page?
* Check that the corresponding skin exists
*
* @return \type{\bool}
*/
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;
}
}
/**
* Trim down a .css or .js subpage title to get the corresponding skin name
*
* @return string containing skin name from .css or .js subpage title
*/
public function getSkinFromCssJsSubpage() {
$subpage = explode( '/', $this->mTextform );
$subpage = $subpage[ count( $subpage ) - 1 ];
return( str_replace( array( '.css', '.js' ), array( '', '' ), $subpage ) );
}
/**
* Is this a .css subpage of a user page?
*
* @return \type{\bool}
*/
public function isCssSubpage() {
return ( NS_USER == $this->mNamespace && preg_match( "/\\/.*\\.css$/", $this->mTextform ) );
}
/**
* Is this a .js subpage of a user page?
*
* @return \type{\bool}
*/
public function isJsSubpage() {
return ( NS_USER == $this->mNamespace && preg_match( "/\\/.*\\.js$/", $this->mTextform ) );
}
/**
* Protect css subpages of user pages: can $wgUser edit
* this page?
*
* @return \type{\bool}
* @todo XXX: this might be better using restrictions
*/
public function userCanEditCssSubpage() {
global $wgUser;
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}
* @todo XXX: this might be better using restrictions
*/
public function userCanEditJsSubpage() {
global $wgUser;
return ( ( $wgUser->isAllowed( 'editusercssjs' ) && $wgUser->isAllowed( 'edituserjs' ) )
|| preg_match( '/^' . preg_quote( $wgUser->getName(), '/' ) . '\//', $this->mTextform ) );
}
/**
* Cascading protection: Return true if cascading restrictions apply to this page, false if not.
*
2008-08-11 04:39:00 +00:00
* @return \type{\bool} If the page is subject to cascading restrictions.
*/
public function isCascadeProtected() {
Static code analysis housekeeping time... things that could be double-checked are marked with "[Note: some-comment]" : if-if-else without curly braces [api/ApiQuerySiteinfo.php] --> adding Unused global declaration: $wgGroupPermissions --> removing Unused global declaration: $wgEmailConfirmToEdit (line 301) --> removing Variable $id appears only once (line 1021) --> removing Variable $m was used before it was defined (line 805) --> defining. Variable $retval was used before it was defined (line 2346) --> renaming to $result Variable $rcid appears only once (line 244 of RecentChange.php) --> using this instead of $change [Note: was left over from r24607 refactoring, revert if wrong please] Unused global declaration: $wgCommandLineMode (line 11) --> removing Variable $k appears only once (line 132 of ImagePage.php) --> removing. Variable $info appears only once (line 311 of ImagePage.php) --> removing. Unused global declaration: $wgTitle (line 569 of ImagePage.php) -> removing. Variable $handlerParams was used before it was defined (line 616 of Linker.php) --> resolved by Raymond in r24966 Variable $match was used before it was defined (line 1031 of Linker.php) --> defining. Unused global declaration: $wgEnotifWatchlist (line 253 of UserMailer.php) --> removing Unused global declaration: $wgShowUpdatedMarker (line 253 of UserMailer.php) --> removing Variable $img appears only once (line 446 of SpecialUpload.php) --> added definition, defined as null, flagged with @todo [Note: should $img be defined in this context, or is it intended to be null? And should the return value after the hook be checked in some way?] Unused global declaration: $wgEnableAPI (line 739 of SpecialUpload.php) --> removing. Unused global declaration: $wgNamespaceProtection (line 1030 of OutputPage.php) --> removing. Unused global declaration: $wgContLang (line 18 of SpecialWatchlist.php) --> removing. Unused global declaration: $wgRawHtml (line 269 of SpecialMovepage.php) --> removing. The value of variable $page was never used (line 331 of SpecialUndelete.php) --> removing line, as $page gets redefined a few lines down. Variable $synIndex appears only once (line 521 of MagicWord.php) --> commenting out. Variable $case appears only once (line 539 of MagicWord.php) --> removing from foreach index key usage. Variable $wgUser appears only once (line 1039 of Title.php) --> adding line to declare as a global, would be null otherwise. Variable $m was used before it was defined (line 285 of Title.php) --> defining. Variable $id appears only once (line 1150 of Title.php) --> removing from foreach index key usage. Variable $subpage appears only once (line 1297 of Title.php) --> commenting out. Variable $restrictions appears only once (line 1399 of Title.php) --> commenting out. Variable $mime appears only once (line 210 of filerepo/OldLocalFile.php) --> removing. Variable $deprefixedName appears only once (line 213 of filerepo/LocalFile.php) --> removing. Variable $m appears only once (line 541 of filerepo/LocalFile.php) --> removing. Variable $where appears only once (line 1245 of filerepo/LocalFile.php) --> removing. Variable $info appears only once (line 1427 of filerepo/LocalFile.php) --> removing. Variable $rel appears only once (line 138 of filerepo/RepoGroup.php) --> commenting out. Variable $zone appears only once (line 138 of filerepo/RepoGroup.php) --> commenting out. Variable $nbytes appears only once (line 208 of media/Generic.php) --> added a return line that uses $nbytes. [Note: I'm assuming that this was the intent] Variable $offset appears only once (line 201 of SpecialListusers.php) --> removing. Variable $limit appears only once (line 201 of SpecialListusers.php) --> removing. Variable $groupTarget appears only once (line 203 of SpecialListusers.php) --> removing. Unused global declaration: $wgLang (line 74 of SpecialWantedpages.php) --> removing. Variable $block appears only once (line 244 of SpecialProtectedpages.php) --> removing. Variable $offset appears only once (line 281 of SpecialProtectedpages.php) --> removing. Variable $limit appears only once (line 281 of SpecialProtectedpages.php) --> removing. Unused global declaration: $wgLang (line 30 of FileDeleteForm.php) --> removing. Unused global declaration: $wgServer (line 30 of FileDeleteForm.php) --> removing.
2007-08-21 03:57:54 +00:00
list( $sources, /* $restrictions */ ) = $this->getCascadeProtectionSources( false );
return ( $sources > 0 );
}
/**
* Cascading protection: Get the source of any cascading restrictions on this page.
*
* @param $getPages \type{\bool} Whether or not to retrieve the actual pages
* that the restrictions have come from.
* @return \type{\arrayof{mixed title array, restriction array}} Array of the Title
* objects of the pages from which cascading restrictions have come,
* false for none, or true if such restrictions exist, but $getPages was not set.
* The restriction array is an array of each type, each of which contains a
* array of unique groups.
*/
public function getCascadeProtectionSources( $getPages = true ) {
$pagerestrictions = array();
if ( isset( $this->mCascadeSources ) && $getPages ) {
return array( $this->mCascadeSources, $this->mCascadingRestrictions );
} else if ( isset( $this->mHasCascadingRestrictions ) && !$getPages ) {
return array( $this->mHasCascadingRestrictions, $pagerestrictions );
}
wfProfileIn( __METHOD__ );
2008-11-06 22:30:55 +00:00
$dbr = wfGetDB( DB_SLAVE );
if ( $this->getNamespace() == NS_FILE ) {
$tables = array ( 'imagelinks', 'page_restrictions' );
$where_clauses = array(
'il_to' => $this->getDBkey(),
'il_from=pr_page',
'pr_cascade' => 1 );
} else {
$tables = array ( 'templatelinks', 'page_restrictions' );
$where_clauses = array(
'tl_namespace' => $this->getNamespace(),
'tl_title' => $this->getDBkey(),
'tl_from=pr_page',
'pr_cascade' => 1 );
}
if ( $getPages ) {
$cols = array( 'pr_page', 'page_namespace', 'page_title',
'pr_expiry', 'pr_type', 'pr_level' );
$where_clauses[] = 'page_id=pr_page';
2007-01-12 09:10:30 +00:00
$tables[] = 'page';
2007-01-12 12:46:01 +00:00
} else {
$cols = array( 'pr_expiry' );
}
$res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__ );
$sources = $getPages ? array() : false;
$now = wfTimestampNow();
$purgeExpired = false;
foreach ( $res as $row ) {
$expiry = Block::decodeExpiry( $row->pr_expiry );
if ( $expiry > $now ) {
if ( $getPages ) {
$page_id = $row->pr_page;
$page_ns = $row->page_namespace;
$page_title = $row->page_title;
$sources[$page_id] = Title::makeTitle( $page_ns, $page_title );
# Add groups needed for each restriction type if its not already there
# Make sure this restriction type still exists
if ( !isset( $pagerestrictions[$row->pr_type] ) ) {
$pagerestrictions[$row->pr_type] = array();
}
if ( isset( $pagerestrictions[$row->pr_type] ) &&
!in_array( $row->pr_level, $pagerestrictions[$row->pr_type] ) ) {
$pagerestrictions[$row->pr_type][] = $row->pr_level;
}
} else {
$sources = true;
}
2007-01-12 09:10:30 +00:00
} else {
// Trigger lazy purge of expired restrictions from the db
$purgeExpired = true;
2007-01-12 09:10:30 +00:00
}
}
if ( $purgeExpired ) {
Title::purgeExpiredRestrictions();
}
wfProfileOut( __METHOD__ );
if ( $getPages ) {
$this->mCascadeSources = $sources;
$this->mCascadingRestrictions = $pagerestrictions;
2007-01-12 09:10:30 +00:00
} else {
$this->mHasCascadingRestrictions = $sources;
}
return array( $sources, $pagerestrictions );
}
/**
* Returns cascading restrictions for the current article
*
* @return Boolean
*/
function areRestrictionsCascading() {
if ( !$this->mRestrictionsLoaded ) {
$this->loadRestrictions();
}
return $this->mCascadeRestriction;
}
/**
* Loads a string into mRestrictions array
*
2008-08-11 04:39:00 +00:00
* @param $res \type{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 ) ) {
$rows[] = $row;
}
$this->loadRestrictionsFromRows( $rows, $oldFashionedRestrictions );
}
/**
* Compiles list of active page restrictions from both page table (pre 1.10)
* and page_restrictions table
*
* @param $rows array of db result objects
* @param $oldFashionedRestrictions string comma-separated list of page
* restrictions from page table (pre 1.10)
*/
public function loadRestrictionsFromRows( $rows, $oldFashionedRestrictions = null ) {
$dbr = wfGetDB( DB_SLAVE );
$restrictionTypes = $this->getRestrictionTypes();
foreach ( $restrictionTypes as $type ) {
$this->mRestrictions[$type] = array();
$this->mRestrictionsExpiry[$type] = Block::decodeExpiry( '' );
}
$this->mCascadeRestriction = false;
# Backwards-compatibility: also load the restrictions from the page record (old format).
if ( $oldFashionedRestrictions === null ) {
$oldFashionedRestrictions = $dbr->selectField( 'page', 'page_restrictions',
2008-05-28 17:50:17 +00:00
array( 'page_id' => $this->getArticleId() ), __METHOD__ );
}
if ( $oldFashionedRestrictions != '' ) {
foreach ( explode( ':', trim( $oldFashionedRestrictions ) ) as $restrict ) {
$temp = explode( '=', trim( $restrict ) );
if ( count( $temp ) == 1 ) {
// old old format should be treated as edit/move restriction
$this->mRestrictions['edit'] = explode( ',', trim( $temp[0] ) );
$this->mRestrictions['move'] = explode( ',', trim( $temp[0] ) );
} else {
$this->mRestrictions[$temp[0]] = explode( ',', trim( $temp[1] ) );
}
}
$this->mOldRestrictions = true;
}
if ( count( $rows ) ) {
# Current system - load second to make them override.
$now = wfTimestampNow();
$purgeExpired = false;
foreach ( $rows as $row ) {
# Cycle through all the restrictions.
// Don't take care of restrictions types that aren't allowed
if ( !in_array( $row->pr_type, $restrictionTypes ) )
continue;
// This code should be refactored, now that it's being used more generally,
// But I don't really see any harm in leaving it in Block for now -werdna
$expiry = Block::decodeExpiry( $row->pr_expiry );
// Only apply the restrictions if they haven't expired!
if ( !$expiry || $expiry > $now ) {
$this->mRestrictionsExpiry[$row->pr_type] = $expiry;
$this->mRestrictions[$row->pr_type] = explode( ',', trim( $row->pr_level ) );
$this->mCascadeRestriction |= $row->pr_cascade;
} else {
// Trigger a lazy purge of expired restrictions
$purgeExpired = true;
}
}
if ( $purgeExpired ) {
Title::purgeExpiredRestrictions();
}
}
$this->mRestrictionsLoaded = true;
}
2008-08-11 04:39:00 +00:00
/**
* Load restrictions from the page_restrictions table
*
* @param $oldFashionedRestrictions string comma-separated list of page
* restrictions from page table (pre 1.10)
2008-08-11 04:39:00 +00:00
*/
public function loadRestrictions( $oldFashionedRestrictions = null ) {
if ( !$this->mRestrictionsLoaded ) {
if ( $this->exists() ) {
$dbr = wfGetDB( DB_SLAVE );
$res = $dbr->select( 'page_restrictions', '*',
array ( 'pr_page' => $this->getArticleId() ), __METHOD__ );
$this->loadRestrictionsFromResultWrapper( $res, $oldFashionedRestrictions );
} else {
$title_protection = $this->getTitleProtection();
if ( $title_protection ) {
$now = wfTimestampNow();
$expiry = Block::decodeExpiry( $title_protection['pt_expiry'] );
if ( !$expiry || $expiry > $now ) {
// Apply the restrictions
$this->mRestrictionsExpiry['create'] = $expiry;
$this->mRestrictions['create'] = explode( ',', trim( $title_protection['pt_create_perm'] ) );
} else { // Get rid of the old restrictions
Title::purgeExpiredRestrictions();
}
2008-07-03 12:25:52 +00:00
} else {
$this->mRestrictionsExpiry['create'] = Block::decodeExpiry( '' );
}
$this->mRestrictionsLoaded = true;
}
}
}
/**
* Purge expired restrictions from the page_restrictions table
*/
static function purgeExpiredRestrictions() {
$dbw = wfGetDB( DB_MASTER );
$dbw->delete( 'page_restrictions',
array( 'pr_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
__METHOD__ );
$dbw->delete( 'protected_titles',
array( 'pt_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ),
__METHOD__ );
}
/**
* Accessor/initialisation for mRestrictions
*
2008-08-11 04:39:00 +00:00
* @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
*/
public function getRestrictions( $action ) {
if ( !$this->mRestrictionsLoaded ) {
$this->loadRestrictions();
2004-11-24 22:31:48 +00:00
}
return isset( $this->mRestrictions[$action] )
? $this->mRestrictions[$action]
: array();
2003-04-14 23:10:40 +00:00
}
/**
* Get the expiry time for the restriction against a given action
*
* @return 14-char timestamp, or 'infinity' if the page is protected forever
* or not protected at all, or false if the action is not recognised.
*/
public function getRestrictionExpiry( $action ) {
if ( !$this->mRestrictionsLoaded ) {
$this->loadRestrictions();
}
return isset( $this->mRestrictionsExpiry[$action] ) ? $this->mRestrictionsExpiry[$action] : false;
}
/**
* Is there a version of this page in the deletion archive?
*
2008-08-11 04:39:00 +00:00
* @return \type{\int} the number of archived revisions
*/
public function isDeleted() {
if ( $this->getNamespace() < 0 ) {
$n = 0;
} else {
$dbr = wfGetDB( DB_SLAVE );
$n = $dbr->selectField( 'archive', 'COUNT(*)',
array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
__METHOD__
);
if ( $this->getNamespace() == NS_FILE ) {
$n += $dbr->selectField( 'filearchive', 'COUNT(*)',
array( 'fa_name' => $this->getDBkey() ),
__METHOD__
);
}
}
return (int)$n;
}
/**
* Is there a version of this page in the deletion archive?
*
* @return Boolean
*/
public function isDeletedQuick() {
if ( $this->getNamespace() < 0 ) {
return false;
}
$dbr = wfGetDB( DB_SLAVE );
$deleted = (bool)$dbr->selectField( 'archive', '1',
array( 'ar_namespace' => $this->getNamespace(), 'ar_title' => $this->getDBkey() ),
__METHOD__
);
if ( !$deleted && $this->getNamespace() == NS_FILE ) {
$deleted = (bool)$dbr->selectField( 'filearchive', '1',
array( 'fa_name' => $this->getDBkey() ),
__METHOD__
);
}
return $deleted;
}
2003-04-14 23:10:40 +00:00
/**
* Get the article ID for this Title from the link cache,
* adding it if necessary
*
2008-08-11 04:39:00 +00:00
* @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select
* for update
2008-08-11 04:39:00 +00:00
* @return \type{\int} the ID
*/
public function getArticleID( $flags = 0 ) {
if ( $this->getNamespace() < 0 ) {
2008-11-13 22:20:51 +00:00
return $this->mArticleID = 0;
}
$linkCache = LinkCache::singleton();
if ( $flags & GAID_FOR_UPDATE ) {
$oldUpdate = $linkCache->forUpdate( true );
2008-09-07 08:24:06 +00:00
$linkCache->clearLink( $this );
$this->mArticleID = $linkCache->addLinkObj( $this );
$linkCache->forUpdate( $oldUpdate );
} else {
if ( -1 == $this->mArticleID ) {
$this->mArticleID = $linkCache->addLinkObj( $this );
}
}
2003-04-14 23:10:40 +00:00
return $this->mArticleID;
}
/**
* Is this an article that is a redirect page?
* Uses link cache, adding it if necessary
*
2008-08-11 04:39:00 +00:00
* @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
* @return \type{\bool}
*/
public function isRedirect( $flags = 0 ) {
if ( !is_null( $this->mRedirect ) )
2008-04-09 16:32:14 +00:00
return $this->mRedirect;
2008-11-13 22:20:51 +00:00
# Calling getArticleID() loads the field from cache as needed
if ( !$this->getArticleID( $flags ) ) {
2008-11-13 22:20:51 +00:00
return $this->mRedirect = false;
}
$linkCache = LinkCache::singleton();
2008-04-09 16:32:14 +00:00
$this->mRedirect = (bool)$linkCache->getGoodLinkFieldObj( $this, 'redirect' );
2008-04-09 16:32:14 +00:00
return $this->mRedirect;
}
/**
* What is the length of this page?
* Uses link cache, adding it if necessary
*
2008-08-11 04:39:00 +00:00
* @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
* @return \type{\bool}
*/
public function getLength( $flags = 0 ) {
if ( $this->mLength != -1 )
2008-04-09 16:32:14 +00:00
return $this->mLength;
2008-11-13 22:20:51 +00:00
# Calling getArticleID() loads the field from cache as needed
if ( !$this->getArticleID( $flags ) ) {
2008-11-13 22:20:51 +00:00
return $this->mLength = 0;
}
$linkCache = LinkCache::singleton();
2008-04-09 16:32:14 +00:00
$this->mLength = intval( $linkCache->getGoodLinkFieldObj( $this, 'length' ) );
2008-04-09 16:32:14 +00:00
return $this->mLength;
}
2003-04-14 23:10:40 +00:00
2008-05-06 14:54:17 +00:00
/**
* What is the page_latest field for this page?
*
2008-08-11 04:39:00 +00:00
* @param $flags \type{\int} a bit field; may be GAID_FOR_UPDATE to select for update
2010-06-15 12:14:54 +00:00
* @return \type{\int} or 0 if the page doesn't exist
2008-05-06 14:54:17 +00:00
*/
public function getLatestRevID( $flags = 0 ) {
if ( $this->mLatestID !== false )
return intval( $this->mLatestID );
2010-06-15 12:14:54 +00:00
# Calling getArticleID() loads the field from cache as needed
if ( !$this->getArticleID( $flags ) ) {
return $this->mLatestID = 0;
}
$linkCache = LinkCache::singleton();
$this->mLatestID = intval( $linkCache->getGoodLinkFieldObj( $this, 'revision' ) );
2008-09-02 21:29:22 +00:00
return $this->mLatestID;
}
/**
* This clears some fields in this object, and clears any associated
* keys in the "bad links" section of the link cache.
*
2008-08-11 04:39:00 +00:00
* @param $newid \type{\int} the new Article ID
*/
public function resetArticleID( $newid ) {
$linkCache = LinkCache::singleton();
$linkCache->clearBadLink( $this->getPrefixedDBkey() );
2003-04-14 23:10:40 +00:00
if ( $newid === false ) {
$this->mArticleID = -1;
} else {
$this->mArticleID = intval( $newid );
}
2003-04-14 23:10:40 +00:00
$this->mRestrictionsLoaded = false;
$this->mRestrictions = array();
$this->mRedirect = null;
$this->mLength = -1;
$this->mLatestID = false;
2003-04-14 23:10:40 +00:00
}
/**
* Updates page_touched for this page; called from LinksUpdate.php
*
2008-08-11 04:39:00 +00:00
* @return \type{\bool} true if the update succeded
*/
public function invalidateCache() {
if ( wfReadOnly() ) {
return;
}
$dbw = wfGetDB( DB_MASTER );
$success = $dbw->update( 'page',
array( 'page_touched' => $dbw->timestamp() ),
$this->pageCond(),
2008-11-13 22:20:51 +00:00
__METHOD__
);
HTMLFileCache::clearFileCache( $this );
return $success;
}
2003-04-14 23:10:40 +00:00
/**
* Prefix some arbitrary text with the namespace or interwiki prefix
* of this object
*
2008-08-11 04:39:00 +00:00
* @param $name \type{\string} the text
* @return \type{\string} the prefixed text
2006-06-10 18:28:50 +00:00
* @private
*/
2004-08-16 20:14:35 +00:00
/* private */ function prefix( $name ) {
$p = '';
if ( $this->mInterwiki != '' ) {
2004-08-16 20:14:35 +00:00
$p = $this->mInterwiki . ':';
2003-04-14 23:10:40 +00:00
}
if ( 0 != $this->mNamespace ) {
$p .= $this->getNsText() . ':';
2003-04-14 23:10:40 +00:00
}
return $p . $name;
}
/**
* Returns a simple regex that will match on characters and sequences invalid in titles.
* Note that this doesn't pick up many things that could be wrong with titles, but that
* replacing this regex with something valid will make many titles valid.
*
* @return string regex string
*/
static function getTitleInvalidRegex() {
static $rxTc = false;
if ( !$rxTc ) {
# Matching titles will be held as illegal.
$rxTc = '/' .
# Any character not allowed is forbidden...
'[^' . Title::legalChars() . ']' .
# URL percent encoding sequences interfere with the ability
# to round-trip titles -- you can't link to them consistently.
'|%[0-9A-Fa-f]{2}' .
# XML/HTML character references produce similar issues.
'|&[A-Za-z0-9\x80-\xff]+;' .
'|&#[0-9]+;' .
'|&#x[0-9A-Fa-f]+;' .
'/S';
2003-10-22 23:56:49 +00:00
}
return $rxTc;
}
/**
* Capitalize a text string for a title if it belongs to a namespace that capitalizes
*
* @param $text string containing title to capitalize
* @param $ns int namespace index, defaults to NS_MAIN
* @return String containing capitalized title
*/
public static function capitalize( $text, $ns = NS_MAIN ) {
global $wgContLang;
if ( MWNamespace::isCapitalized( $ns ) )
return $wgContLang->ucfirst( $text );
else
return $text;
}
/**
* Secure and split - main initialisation function for this object
*
* Assumes that mDbkeyform has been set, and is urldecoded
* and uses underscores, but not otherwise munged. This function
* removes illegal characters, splits off the interwiki and
* namespace prefixes, sets the other forms, and canonicalizes
* everything.
*
* @return \type{\bool} true on success
*/
private function secureAndSplit() {
global $wgContLang, $wgLocalInterwiki;
# Initialisation
$rxTc = self::getTitleInvalidRegex();
2003-10-22 23:56:49 +00:00
2004-08-16 20:14:35 +00:00
$this->mInterwiki = $this->mFragment = '';
$this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
$dbkey = $this->mDbkeyform;
2003-04-14 23:10:40 +00:00
# Strip Unicode bidi override characters.
# Sometimes they slip into cut-n-pasted page titles, where the
# override chars get included in list displays.
$dbkey = preg_replace( '/\xE2\x80[\x8E\x8F\xAA-\xAE]/S', '', $dbkey );
# Clean up whitespace
# Note: use of the /u option on preg_replace here will cause
# input with invalid UTF-8 sequences to be nullified out in PHP 5.2.x,
# conveniently disabling them.
#
$dbkey = preg_replace( '/[ _\xA0\x{1680}\x{180E}\x{2000}-\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}]+/u', '_', $dbkey );
$dbkey = trim( $dbkey, '_' );
if ( $dbkey == '' ) {
return false;
}
if ( false !== strpos( $dbkey, UTF8_REPLACEMENT ) ) {
# Contained illegal UTF-8 sequences or forbidden Unicode chars.
return false;
}
2003-04-14 23:10:40 +00:00
$this->mDbkeyform = $dbkey;
# Initial colon indicates main namespace rather than specified default
# but should not create invalid {ns,title} pairs such as {0,Project:Foo}
if ( ':' == $dbkey { 0 } ) {
$this->mNamespace = NS_MAIN;
$dbkey = substr( $dbkey, 1 ); # remove the colon but continue processing
$dbkey = trim( $dbkey, '_' ); # remove any subsequent whitespace
}
# Namespace or interwiki prefix
$firstPass = true;
$prefixRegexp = "/^(.+?)_*:_*(.*)$/S";
do {
$m = array();
if ( preg_match( $prefixRegexp, $dbkey, $m ) ) {
$p = $m[1];
if ( ( $ns = $wgContLang->getNsIndex( $p ) ) !== false ) {
# Ordinary namespace
$dbkey = $m[2];
$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] ) )
return false; # Disallow Talk:File:x type titles...
else if ( Interwiki::isValidInterwiki( $x[1] ) )
return false; # Disallow Talk:Interwiki:x type titles...
}
} elseif ( Interwiki::isValidInterwiki( $p ) ) {
if ( !$firstPass ) {
# Can't make a local interwiki link to an interwiki link.
# That's just crazy!
return false;
}
# Interwiki link
$dbkey = $m[2];
$this->mInterwiki = $wgContLang->lc( $p );
# Redundant interwiki prefix to the local wiki
if ( 0 == strcasecmp( $this->mInterwiki, $wgLocalInterwiki ) ) {
if ( $dbkey == '' ) {
# Can't have an empty self-link
return false;
}
$this->mInterwiki = '';
$firstPass = false;
# Do another namespace split...
continue;
2003-10-22 23:56:49 +00:00
}
2006-03-11 17:13:49 +00:00
# If there's an initial colon after the interwiki, that also
# resets the default namespace
if ( $dbkey !== '' && $dbkey[0] == ':' ) {
$this->mNamespace = NS_MAIN;
$dbkey = substr( $dbkey, 1 );
}
2003-04-14 23:10:40 +00:00
}
# If there's no recognized interwiki or namespace,
# then let the colon expression be part of the title.
}
break;
} while ( true );
2003-04-14 23:10:40 +00:00
# We already know that some pages won't be in the database!
#
if ( $this->mInterwiki != '' || NS_SPECIAL == $this->mNamespace ) {
2003-04-14 23:10:40 +00:00
$this->mArticleID = 0;
}
$fragment = strstr( $dbkey, '#' );
if ( false !== $fragment ) {
$this->setFragment( preg_replace( '/^#_*/', '#', $fragment ) );
$dbkey = substr( $dbkey, 0, strlen( $dbkey ) - strlen( $fragment ) );
2004-09-14 05:35:34 +00:00
# remove whitespace again: prevents "Foo_bar_#"
# becoming "Foo_bar_"
$dbkey = preg_replace( '/_*$/', '', $dbkey );
2003-04-14 23:10:40 +00:00
}
# Reject illegal characters.
#
if ( preg_match( $rxTc, $dbkey ) ) {
return false;
}
/**
* Pages with "/./" or "/../" appearing in the URLs will often be un-
* reachable due to the way web browsers deal with 'relative' URLs.
* Also, they conflict with subpage syntax. Forbid them explicitly.
*/
if ( strpos( $dbkey, '.' ) !== false &&
( $dbkey === '.' || $dbkey === '..' ||
strpos( $dbkey, './' ) === 0 ||
strpos( $dbkey, '../' ) === 0 ||
strpos( $dbkey, '/./' ) !== false ||
strpos( $dbkey, '/../' ) !== false ||
substr( $dbkey, -2 ) == '/.' ||
substr( $dbkey, -3 ) == '/..' ) )
{
return false;
}
/**
* Magic tilde sequences? Nu-uh!
*/
if ( strpos( $dbkey, '~~~' ) !== false ) {
return false;
}
/**
* Limit the size of titles to 255 bytes.
* This is typically the size of the underlying database field.
* We make an exception for special pages, which don't need to be stored
* in the database, and may edge over 255 bytes due to subpage syntax
* for long titles, e.g. [[Special:Block/Long name]]
*/
if ( ( $this->mNamespace != NS_SPECIAL && strlen( $dbkey ) > 255 ) ||
strlen( $dbkey ) > 512 )
{
return false;
}
/**
* Normally, all wiki links are forced to have
* an initial capital letter so [[foo]] and [[Foo]]
* point to the same place.
*
* Don't force it for interwikis, since the other
* site might be case-sensitive.
*/
$this->mUserCaseDBKey = $dbkey;
if ( $this->mInterwiki == '' ) {
$dbkey = self::capitalize( $dbkey, $this->mNamespace );
}
/**
* Can't make a link to a namespace alone...
* "empty" local links can only be self-links
* with a fragment identifier.
*/
if ( $dbkey == '' &&
$this->mInterwiki == '' &&
$this->mNamespace != NS_MAIN ) {
return false;
}
// Allow IPv6 usernames to start with '::' by canonicalizing IPv6 titles.
// IP names are not allowed for accounts, and can only be referring to
// edits from the IP. Given '::' abbreviations and caps/lowercaps,
// there are numerous ways to present the same IP. Having sp:contribs scan
// them all is silly and having some show the edits and others not is
2007-09-04 15:05:08 +00:00
// inconsistent. Same for talk/userpages. Keep them normalized instead.
$dbkey = ( $this->mNamespace == NS_USER || $this->mNamespace == NS_USER_TALK ) ?
2007-09-07 11:01:46 +00:00
IP::sanitizeIP( $dbkey ) : $dbkey;
// Any remaining initial :s are illegal.
if ( $dbkey !== '' && ':' == $dbkey { 0 } ) {
return false;
}
# Fill fields
$this->mDbkeyform = $dbkey;
$this->mUrlform = wfUrlencode( $dbkey );
$this->mTextform = str_replace( '_', ' ', $dbkey );
return true;
2003-04-14 23:10:40 +00:00
}
/**
2008-09-04 03:22:26 +00:00
* Set the fragment for this title. Removes the first character from the
* specified fragment before setting, so it assumes you're passing it with
2008-09-04 03:22:26 +00:00
* an initial "#".
*
2008-09-04 07:45:52 +00:00
* Deprecated for public use, use Title::makeTitle() with fragment parameter.
* Still in active use privately.
*
2008-08-11 04:39:00 +00:00
* @param $fragment \type{\string} text
*/
public function setFragment( $fragment ) {
$this->mFragment = str_replace( '_', ' ', substr( $fragment, 1 ) );
}
/**
* Get a Title object associated with the talk page of this article
*
2008-08-11 04:39:00 +00:00
* @return \type{Title} the object for the talk page
*/
public function getTalkPage() {
return Title::makeTitle( MWNamespace::getTalk( $this->getNamespace() ), $this->getDBkey() );
2003-11-20 06:57:00 +00:00
}
/**
* Get a title object associated with the subject page of this
* talk page
*
2008-08-11 04:39:00 +00:00
* @return \type{Title} the object for the subject page
*/
public function getSubjectPage() {
// Is this the same title?
$subjectNS = MWNamespace::getSubject( $this->getNamespace() );
if ( $this->getNamespace() == $subjectNS ) {
return $this;
}
return Title::makeTitle( $subjectNS, $this->getDBkey() );
2003-11-20 06:57:00 +00:00
}
/**
* Get an array of Title objects linking to this Title
2005-05-04 00:33:08 +00:00
* Also stores the IDs in the link cache.
*
* WARNING: do not use this function on arbitrary user-supplied titles!
* On heavily-used templates it will max out the memory.
*
* @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
*/
public function getLinksTo( $options = array(), $table = 'pagelinks', $prefix = 'pl' ) {
$linkCache = LinkCache::singleton();
if ( count( $options ) > 0 ) {
$db = wfGetDB( DB_MASTER );
} else {
$db = wfGetDB( DB_SLAVE );
}
$res = $db->select( array( 'page', $table ),
2010-06-15 12:14:54 +00:00
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 );
$retVal = array();
if ( $db->numRows( $res ) ) {
foreach ( $res as $row ) {
if ( $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title ) ) {
2010-06-15 12:14:54 +00:00
$linkCache->addGoodLinkObj( $row->page_id, $titleObj, $row->page_len, $row->page_is_redirect, $row->page_latest );
$retVal[] = $titleObj;
}
}
}
$db->freeResult( $res );
return $retVal;
}
/**
* Get an array of Title objects using this Title as a template
* Also stores the IDs in the link cache.
*
* WARNING: do not use this function on arbitrary user-supplied titles!
* 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
*/
public function getTemplateLinksTo( $options = array() ) {
return $this->getLinksTo( $options, 'templatelinks', 'tl' );
}
2005-04-24 04:13:47 +00:00
/**
* 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
2005-04-24 04:13:47 +00:00
*/
public function getBrokenLinksFrom() {
if ( $this->getArticleId() == 0 ) {
# All links from article ID 0 are false positives
return array();
}
$dbr = wfGetDB( DB_SLAVE );
$res = $dbr->select(
array( 'page', 'pagelinks' ),
array( 'pl_namespace', 'pl_title' ),
array(
'pl_from' => $this->getArticleId(),
'page_namespace IS NULL'
),
__METHOD__, array(),
array(
'page' => array(
'LEFT JOIN',
array( 'pl_namespace=page_namespace', 'pl_title=page_title' )
)
)
);
2005-04-24 04:13:47 +00:00
$retVal = array();
foreach ( $res as $row ) {
$retVal[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
2005-04-24 04:13:47 +00:00
}
return $retVal;
}
/**
* Get a list of URLs to purge from the Squid cache when this
* page changes
*
* @return \type{\arrayof{\string}} the URLs
*/
public function getSquidURLs() {
global $wgContLang;
$urls = array(
$this->getInternalURL(),
2004-08-16 20:14:35 +00:00
$this->getInternalURL( 'action=history' )
);
// purge variant urls as well
if ( $wgContLang->hasVariants() ) {
$variants = $wgContLang->getVariants();
foreach ( $variants as $vCode ) {
$urls[] = $this->getInternalURL( '', $vCode );
}
}
return $urls;
}
2008-08-11 04:39:00 +00:00
/**
* Purge all applicable Squid URLs
*/
public function purgeSquid() {
global $wgUseSquid;
if ( $wgUseSquid ) {
$urls = $this->getSquidURLs();
$u = new SquidUpdate( $urls );
$u->doUpdate();
}
}
/**
* Move this page without authentication
*
* @param $nt \type{Title} the new page Title
* @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure
*/
public function moveNoAuth( &$nt ) {
return $this->moveTo( $nt, false );
}
/**
* 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
2008-08-11 04:39:00 +00:00
* @param $auth \type{\bool} indicates whether $wgUser's permissions
* should be checked
2008-08-11 04:39:00 +00:00
* @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
*/
public function isValidMoveOperation( &$nt, $auth = true, $reason = '' ) {
global $wgUser;
$errors = array();
if ( !$nt ) {
// Normally we'd add this to $errors, but we'll get
// lots of syntax errors if $nt is not an object
return array( array( 'badtitletext' ) );
}
if ( $this->equals( $nt ) ) {
$errors[] = array( 'selfmove' );
}
if ( !$this->isMovable() ) {
$errors[] = array( 'immobile-source-namespace', $this->getNsText() );
}
if ( $nt->getInterwiki() != '' ) {
$errors[] = array( 'immobile-target-namespace-iw' );
}
if ( !$nt->isMovable() ) {
$errors[] = array( 'immobile-target-namespace', $nt->getNsText() );
}
$oldid = $this->getArticleID();
$newid = $nt->getArticleID();
if ( strlen( $nt->getDBkey() ) < 1 ) {
$errors[] = array( 'articleexists' );
}
if ( ( $this->getDBkey() == '' ) ||
( !$oldid ) ||
( $nt->getDBkey() == '' ) ) {
$errors[] = array( 'badarticleerror' );
}
// Image-specific checks
if ( $this->getNamespace() == NS_FILE ) {
$file = wfLocalFile( $this );
if ( $file->exists() ) {
if ( $nt->getNamespace() != NS_FILE ) {
$errors[] = array( 'imagenocrossnamespace' );
}
if ( $nt->getText() != wfStripIllegalFilenameChars( $nt->getText() ) ) {
$errors[] = array( 'imageinvalidfilename' );
}
if ( !File::checkExtensionCompatibility( $file, $nt->getDBkey() ) ) {
$errors[] = array( 'imagetypemismatch' );
}
}
$destfile = wfLocalFile( $nt );
if ( !$wgUser->isAllowed( 'reupload-shared' ) && !$destfile->exists() && wfFindFile( $nt ) ) {
$errors[] = array( 'file-exists-sharedrepo' );
}
}
if ( $auth ) {
$errors = wfMergeErrorArrays( $errors,
$this->getUserPermissionsErrors( 'move', $wgUser ),
$this->getUserPermissionsErrors( 'edit', $wgUser ),
$nt->getUserPermissionsErrors( 'move-target', $wgUser ),
$nt->getUserPermissionsErrors( 'edit', $wgUser ) );
}
$match = EditPage::matchSummarySpamRegex( $reason );
if ( $match !== false ) {
// This is kind of lame, won't display nice
$errors[] = array( 'spamprotectiontext' );
}
2007-12-08 18:30:00 +00:00
$err = null;
if ( !wfRunHooks( 'AbortMove', array( $this, $nt, $wgUser, &$err, $reason ) ) ) {
$errors[] = array( 'hookaborted', $err );
2007-12-08 18:30:00 +00:00
}
# The move is allowed only if (1) the target doesn't exist, or
# (2) the target is a redirect to the source, and has no history
# (so we can undo bad moves right after they're done).
if ( 0 != $newid ) { # Target exists; check for validity
if ( ! $this->isValidMoveTarget( $nt ) ) {
$errors[] = array( 'articleexists' );
}
} else {
$tp = $nt->getTitleProtection();
$right = ( $tp['pt_create_perm'] == 'sysop' ) ? 'protect' : $tp['pt_create_perm'];
if ( $tp and !$wgUser->isAllowed( $right ) ) {
$errors[] = array( 'cantmove-titleprotected' );
}
}
if ( empty( $errors ) )
return true;
return $errors;
}
/**
* Move a title to a new location
*
* @param $nt \type{Title} the new title
2008-08-11 04:39:00 +00:00
* @param $auth \type{\bool} indicates whether $wgUser's permissions
* should be checked
2008-08-11 04:39:00 +00:00
* @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.
2008-08-11 04:39:00 +00:00
* @return \type{\mixed} true on success, getUserPermissionsErrors()-like array on failure
*/
public function moveTo( &$nt, $auth = true, $reason = '', $createRedirect = true ) {
$err = $this->isValidMoveOperation( $nt, $auth, $reason );
if ( is_array( $err ) ) {
return $err;
}
2009-12-14 13:41:32 +00:00
// If it is a file, move it first. It is done before all other moving stuff is done because it's hard to revert
$dbw = wfGetDB( DB_MASTER );
if ( $this->getNamespace() == NS_FILE ) {
$file = wfLocalFile( $this );
if ( $file->exists() ) {
$status = $file->move( $nt );
if ( !$status->isOk() ) {
return $status->getErrorsArray();
}
}
}
$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 );
}
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.
$dbw->update( 'categorylinks',
array(
'cl_sortkey' => $nt->getPrefixedText(),
'cl_timestamp=cl_timestamp' ),
array(
'cl_from' => $pageid,
'cl_sortkey' => $this->getPrefixedText() ),
__METHOD__ );
if ( $protected ) {
# Protect the redirect title as the title used to be...
$dbw->insertSelect( 'page_restrictions', 'page_restrictions',
array(
'pr_page' => $redirid,
'pr_type' => 'pr_type',
'pr_level' => 'pr_level',
'pr_cascade' => 'pr_cascade',
'pr_user' => 'pr_user',
'pr_expiry' => 'pr_expiry'
),
array( 'pr_page' => $pageid ),
__METHOD__,
array( 'IGNORE' )
);
# Update the protection log
$log = new LogPage( 'protect' );
$comment = wfMsgForContent( 'prot_1movedto2', $this->getPrefixedText(), $nt->getPrefixedText() );
if ( $reason ) $comment .= wfMsgForContent( 'colon-separator' ) . $reason;
$log->addEntry( 'move_prot', $nt, $comment, array( $this->getPrefixedText() ) ); // FIXME: $params?
}
# Update watchlists
$oldnamespace = $this->getNamespace() & ~1;
$newnamespace = $nt->getNamespace() & ~1;
$oldtitle = $this->getDBkey();
$newtitle = $nt->getDBkey();
if ( $oldnamespace != $newnamespace || $oldtitle != $newtitle ) {
WatchedItem::duplicateEntries( $this, $nt );
}
# Update search engine
$u = new SearchUpdate( $pageid, $nt->getPrefixedDBkey() );
$u->doUpdate();
$u = new SearchUpdate( $redirid, $this->getPrefixedDBkey(), '' );
$u->doUpdate();
2005-06-19 00:21:49 +00:00
# Update site_stats
if ( $this->isContentPage() && !$nt->isContentPage() ) {
# No longer a content page
# Not viewed, edited, removing
$u = new SiteStatsUpdate( 0, 1, -1, $pageCountChange );
} elseif ( !$this->isContentPage() && $nt->isContentPage() ) {
# Now a content page
# Not viewed, edited, adding
$u = new SiteStatsUpdate( 0, 1, + 1, $pageCountChange );
} elseif ( $pageCountChange ) {
# Redirect added
2005-06-19 00:21:49 +00:00
$u = new SiteStatsUpdate( 0, 0, 0, 1 );
} else {
# Nothing special
2005-06-19 00:21:49 +00:00
$u = false;
}
if ( $u )
2005-06-19 00:21:49 +00:00
$u->doUpdate();
2007-12-20 06:03:46 +00:00
# Update message cache for interface messages
if ( $nt->getNamespace() == NS_MEDIAWIKI ) {
global $wgMessageCache;
# @bug 17860: old article can be deleted, if this the case,
# delete it from message cache
2009-04-24 18:48:56 +00:00
if ( $this->getArticleID() === 0 ) {
$wgMessageCache->replace( $this->getDBkey(), false );
} else {
$oldarticle = new Article( $this );
$wgMessageCache->replace( $this->getDBkey(), $oldarticle->getContent() );
}
$newarticle = new Article( $nt );
$wgMessageCache->replace( $nt->getDBkey(), $newarticle->getContent() );
}
global $wgUser;
wfRunHooks( 'TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ) );
return true;
}
/**
* Move page to a title which is at present a redirect to the
* source page
*
* @param $nt \type{Title} the page to move to, which should currently
* be a redirect
2008-08-11 04:39:00 +00:00
* @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
*/
private function moveOverExistingRedirect( &$nt, $reason = '', $createRedirect = true ) {
global $wgUseSquid, $wgUser, $wgContLang;
$comment = wfMsgForContent( '1movedto2_redir', $this->getPrefixedText(), $nt->getPrefixedText() );
if ( $reason ) {
$comment .= wfMsgForContent( 'colon-separator' ) . $reason;
}
# Truncate for whole multibyte characters. +5 bytes for ellipsis
$comment = $wgContLang->truncate( $comment, 250 );
$now = wfTimestampNow();
$newid = $nt->getArticleID();
$oldid = $this->getArticleID();
2008-07-31 07:39:05 +00:00
$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__
);
# Save a null revision in the page's history notifying of the move
$nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true );
$nullRevId = $nullRevision->insertOn( $dbw );
2008-05-30 21:42:05 +00:00
$article = new Article( $this );
wfRunHooks( 'NewRevisionFromEditComplete', array( $article, $nullRevision, $latest, $wgUser ) );
# Change the name of the target page:
$dbw->update( 'page',
/* SET */ array(
'page_touched' => $dbw->timestamp( $now ),
'page_namespace' => $nt->getNamespace(),
'page_title' => $nt->getDBkey(),
'page_latest' => $nullRevId,
),
/* WHERE */ array( 'page_id' => $oldid ),
__METHOD__
);
$nt->resetArticleID( $oldid );
# Recreate the redirect, this time in the other direction.
if ( $createRedirect || !$wgUser->isAllowed( 'suppressredirect' ) ) {
$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 ) );
# Now, we record the link from the redirect to the new title.
# It should have no other outgoing links...
$dbw->delete( 'pagelinks', array( 'pl_from' => $newid ), __METHOD__ );
$dbw->insert( 'pagelinks',
array(
'pl_from' => $newid,
'pl_namespace' => $nt->getNamespace(),
'pl_title' => $nt->getDBkey() ),
__METHOD__ );
$redirectSuppressed = false;
} else {
$this->resetArticleID( 0 );
$redirectSuppressed = true;
}
# 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
2008-08-11 04:39:00 +00:00
* @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();
2008-07-31 07:39:05 +00:00
$latest = $this->getLatestRevId();
$dbw = wfGetDB( DB_MASTER );
2004-09-06 09:57:30 +00:00
$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 );
2008-05-30 21:42:05 +00:00
$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;
} else {
$this->resetArticleID( 0 );
$redirectSuppressed = true;
}
# Log the move
$log = new LogPage( 'move' );
$log->addEntry( 'move', $this, $reason, array( 1 => $nt->getPrefixedText(), 2 => $redirectSuppressed ) );
2004-06-05 04:52:33 +00:00
# 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();
}
/**
* Move this page's subpages to be subpages of $nt
*
* @param $nt Title Move target
* @param $auth bool Whether $wgUser's permissions should be checked
* @param $reason string The reason for the move
* @param $createRedirect bool Whether to create redirects from the old subpages to the new ones
* Ignored if the user doesn't have the 'suppressredirect' right
* @return mixed array with old page titles as keys, and strings (new page titles) or
* arrays (errors) as values, or an error array with numeric indices if no pages were moved
*/
public function moveSubpages( $nt, $auth = true, $reason = '', $createRedirect = true ) {
2009-04-28 03:03:48 +00:00
global $wgMaximumMovedPages;
// Check permissions
if ( !$this->userCan( 'move-subpages' ) )
return array( 'cant-move-subpages' );
// Do the source and target namespaces support subpages?
if ( !MWNamespace::hasSubpages( $this->getNamespace() ) )
return array( 'namespace-nosubpages',
MWNamespace::getCanonicalName( $this->getNamespace() ) );
if ( !MWNamespace::hasSubpages( $nt->getNamespace() ) )
return array( 'namespace-nosubpages',
MWNamespace::getCanonicalName( $nt->getNamespace() ) );
$subpages = $this->getSubpages( $wgMaximumMovedPages + 1 );
$retval = array();
$count = 0;
foreach ( $subpages as $oldSubpage ) {
$count++;
if ( $count > $wgMaximumMovedPages ) {
$retval[$oldSubpage->getPrefixedTitle()] =
array( 'movepage-max-pages',
$wgMaximumMovedPages );
break;
}
// We don't know whether this function was called before
// or after moving the root page, so check both
// $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
$oldSubpage->getDBkey() );
if ( $oldSubpage->isTalkPage() ) {
$newNs = $nt->getTalkPage()->getNamespace();
} else {
$newNs = $nt->getSubjectPage()->getNamespace();
}
# Bug 14385: we need makeTitleSafe because the new page names may
# be longer than 255 characters.
$newSubpage = Title::makeTitleSafe( $newNs, $newPageName );
$success = $oldSubpage->moveTo( $newSubpage, $auth, $reason, $createRedirect );
if ( $success === true ) {
$retval[$oldSubpage->getPrefixedText()] = $newSubpage->getPrefixedText();
} else {
$retval[$oldSubpage->getPrefixedText()] = $success;
}
}
return $retval;
}
/**
* Checks if this page is just a one-rev redirect.
* Adds lock, so don't use just for light purposes.
*
* @return \type{\bool}
*/
2008-11-13 22:20:51 +00:00
public function isSingleRevRedirect() {
$dbw = wfGetDB( DB_MASTER );
# Is it a redirect?
$row = $dbw->selectRow( 'page',
2008-11-13 22:20:51 +00:00
array( 'page_is_redirect', 'page_latest', 'page_id' ),
$this->pageCond(),
__METHOD__,
array( 'FOR UPDATE' )
);
# Cache some fields we may want
$this->mArticleID = $row ? intval( $row->page_id ) : 0;
$this->mRedirect = $row ? (bool)$row->page_is_redirect : false;
$this->mLatestID = $row ? intval( $row->page_latest ) : false;
if ( !$this->mRedirect ) {
return false;
}
# Does the article have a history?
$row = $dbw->selectField( array( 'page', 'revision' ),
'rev_id',
array( 'page_namespace' => $this->getNamespace(),
'page_title' => $this->getDBkey(),
'page_id=rev_page',
'page_latest != rev_id'
),
__METHOD__,
array( 'FOR UPDATE' )
);
# Return true if there was no history
return ( $row === false );
}
/**
* 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
2008-08-11 04:39:00 +00:00
* @return \type{\bool} TRUE or FALSE
*/
public function isValidMoveTarget( $nt ) {
$dbw = wfGetDB( DB_MASTER );
# Is it an existsing file?
if ( $nt->getNamespace() == NS_FILE ) {
$file = wfLocalFile( $nt );
if ( $file->exists() ) {
wfDebug( __METHOD__ . ": file exists\n" );
return false;
}
}
# Is it a redirect with no history?
if ( !$nt->isSingleRevRedirect() ) {
wfDebug( __METHOD__ . ": not a one-rev redirect\n" );
return false;
}
# Get the article text
$rev = Revision::newFromTitle( $nt );
$text = $rev->getText();
# Does the redirect point to the source?
# Or is it a broken self-redirect, usually caused by namespace collisions?
$m = array();
if ( preg_match( "/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m ) ) {
$redirTitle = Title::newFromText( $m[1] );
if ( !is_object( $redirTitle ) ||
( $redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
$redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey() ) ) {
wfDebug( __METHOD__ . ": redirect points to other page\n" );
return false;
}
} else {
# Fail safe
wfDebug( __METHOD__ . ": failsafe\n" );
return false;
}
return true;
}
/**
* Can this title be added to a user's watchlist?
*
2008-08-11 04:39:00 +00:00
* @return \type{\bool} TRUE or FALSE
*/
public function isWatchable() {
2008-11-13 22:20:51 +00:00
return !$this->isExternal() && MWNamespace::isWatchable( $this->getNamespace() );
}
/**
* Get categories to which this Title belongs and return an array of
* categories' names.
*
2008-08-11 04:39:00 +00:00
* @return \type{\array} array an array of parents in the form:
* $parent => $currentarticle
*/
public function getParentCategories() {
global $wgContLang;
$titlekey = $this->getArticleId();
$dbr = wfGetDB( DB_SLAVE );
$categorylinks = $dbr->tableName( 'categorylinks' );
# NEW SQL
$sql = "SELECT * FROM $categorylinks"
. " WHERE cl_from='$titlekey'"
. " AND cl_from <> '0'"
. " ORDER BY cl_sortkey";
2008-06-26 20:26:56 +00:00
$res = $dbr->query( $sql );
if ( $dbr->numRows( $res ) > 0 ) {
foreach ( $res as $row )
// $data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$row->cl_to);
$data[$wgContLang->getNSText( NS_CATEGORY ) . ':' . $row->cl_to] = $this->getFullText();
2008-06-26 20:26:56 +00:00
$dbr->freeResult( $res );
} else {
$data = array();
}
return $data;
}
/**
* Get a tree of parent categories
*
2008-08-11 04:39:00 +00:00
* @param $children \type{\array} an array with the children in the keys, to check for circular refs
* @return \type{\array} Tree of parent categories
*/
public function getParentCategoryTree( $children = array() ) {
$stack = array();
$parents = $this->getParentCategories();
if ( $parents ) {
foreach ( $parents as $parent => $current ) {
if ( array_key_exists( $parent, $children ) ) {
# Circular reference
$stack[$parent] = array();
} else {
$nt = Title::newFromText( $parent );
if ( $nt ) {
$stack[$parent] = $nt->getParentCategoryTree( $children + array( $parent => 1 ) );
}
}
}
return $stack;
} else {
return array();
}
}
/**
* Get an associative array for selecting this title from
2006-01-09 03:52:24 +00:00
* the "page" table
*
2008-08-11 04:39:00 +00:00
* @return \type{\array} Selection array
*/
public function pageCond() {
if ( $this->mArticleID > 0 ) {
2008-12-08 23:10:24 +00:00
// PK avoids secondary lookups in InnoDB, shouldn't hurt other DBs
return array( 'page_id' => $this->mArticleID );
} else {
return array( 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform );
}
}
/**
* Get the revision ID of the previous revision
*
2008-08-11 04:39:00 +00:00
* @param $revId \type{\int} Revision ID. Get the revision that was before this one.
* @param $flags \type{\int} 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 );
2008-05-15 14:53:02 +00:00
return $db->selectField( 'revision', 'rev_id',
array(
'rev_page' => $this->getArticleId( $flags ),
2008-07-31 07:39:05 +00:00
'rev_id < ' . intval( $revId )
),
__METHOD__,
array( 'ORDER BY' => 'rev_id DESC' )
);
}
/**
* Get the revision ID of the next revision
*
2008-08-11 04:39:00 +00:00
* @param $revId \type{\int} Revision ID. Get the revision that was after this one.
* @param $flags \type{\int} 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 );
2008-05-15 14:53:02 +00:00
return $db->selectField( 'revision', 'rev_id',
array(
'rev_page' => $this->getArticleId( $flags ),
2008-07-31 07:39:05 +00:00
'rev_id > ' . intval( $revId )
),
__METHOD__,
array( 'ORDER BY' => 'rev_id' )
);
}
/**
* Get the first revision of the page
*
* @param $flags \type{\int} 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 );
$pageId = $this->getArticleId( $flags );
if ( !$pageId ) return null;
$row = $db->selectRow( 'revision', '*',
array( 'rev_page' => $pageId ),
__METHOD__,
array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 1 )
);
if ( !$row ) {
return null;
} else {
return new Revision( $row );
}
}
2008-12-21 09:33:04 +00:00
/**
* Check if this is a new page
*
* @return bool
*/
public function isNewPage() {
$dbr = wfGetDB( DB_SLAVE );
return (bool)$dbr->selectField( 'page', 'page_is_new', $this->pageCond(), __METHOD__ );
}
2008-10-28 13:42:05 +00:00
/**
* Get the oldest revision timestamp of this page
*
* @return String: MW timestamp
2008-10-28 13:42:05 +00:00
*/
public function getEarliestRevTime() {
$dbr = wfGetDB( DB_SLAVE );
if ( $this->exists() ) {
2008-10-28 13:42:05 +00:00
$min = $dbr->selectField( 'revision',
'MIN(rev_timestamp)',
array( 'rev_page' => $this->getArticleId() ),
__METHOD__ );
return wfTimestampOrNull( TS_MW, $min );
}
return null;
}
/**
* Get the number of revisions between the given revision IDs.
2008-04-10 17:55:12 +00:00
* Used for diffs and other things that really need it.
*
2008-08-11 04:39:00 +00:00
* @param $old \type{\int} Revision ID.
* @param $new \type{\int} Revision ID.
* @return \type{\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 ) .
2008-04-10 17:49:59 +00:00
' AND rev_id < ' . intval( $new ),
__METHOD__
);
}
/**
* Compare with another title.
*
* @param $title \type{Title}
2008-08-11 04:39:00 +00:00
* @return \type{\bool} TRUE or FALSE
*/
public function equals( Title $title ) {
// Note: === is necessary for proper matching of number-like titles.
return $this->getInterwiki() === $title->getInterwiki()
&& $this->getNamespace() == $title->getNamespace()
&& $this->getDBkey() === $title->getDBkey();
}
/**
* Callback for usort() to do title sorts by (namespace, title)
*
* @return Integer: result of string comparison, or namespace comparison
*/
public static function compare( $a, $b ) {
if ( $a->getNamespace() == $b->getNamespace() ) {
return strcmp( $a->getText(), $b->getText() );
} else {
return $a->getNamespace() - $b->getNamespace();
}
}
/**
* Return a string representation of this title
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} String representation of this title
*/
public function __toString() {
2010-02-01 04:57:42 +00:00
return $this->getPrefixedText();
}
/**
* Check if page exists. For historical reasons, this function simply
* checks for the existence of the title in the page table, and will
* thus return false for interwiki links, special pages and the like.
* If you want to know if a title can be meaningfully viewed, you should
* probably call the isKnown() method instead.
*
* @return \type{\bool}
*/
public function exists() {
return $this->getArticleId() != 0;
}
/**
* Should links to this title be shown as potentially viewable (i.e. as
* "bluelinks"), even if there's no record by this title in the page
* table?
*
* This function is semi-deprecated for public use, as well as somewhat
* misleadingly named. You probably just want to call isKnown(), which
* calls this function internally.
*
* (ISSUE: Most of these checks are cheap, but the file existence check
* can potentially be quite expensive. Including it here fixes a lot of
* existing code, but we might want to add an optional parameter to skip
* it and any other expensive checks.)
*
* @return \type{\bool}
*/
public function isAlwaysKnown() {
if ( $this->mInterwiki != '' ) {
return true; // any interwiki link might be viewable, for all we know
}
2009-02-25 00:48:07 +00:00
switch( $this->mNamespace ) {
case NS_MEDIA:
case NS_FILE:
2010-06-16 21:48:31 +00:00
return (bool)wfFindFile( $this ); // file exists, possibly in a foreign repo
case NS_SPECIAL:
2009-05-24 08:29:10 +00:00
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;
}
}
/**
* Does this title refer to a page that can (or might) be meaningfully
* viewed? In particular, this function may be used to determine if
* links to the title should be rendered as "bluelinks" (as opposed to
* "redlinks" to non-existent pages).
*
* @return \type{\bool}
*/
public function isKnown() {
return $this->exists() || $this->isAlwaysKnown();
}
/**
* Does this page have source text?
*
* @return Boolean
*/
public function hasSourceText() {
if ( $this->exists() )
return true;
if ( $this->mNamespace == NS_MEDIAWIKI ) {
// If the page doesn't exist but is a known system message, default
// message content will be displayed, same for language subpages
// Also, if the page is form Mediawiki:message/lang, calling wfMsgWeirdKey
// causes the full l10n of that language to be loaded. That takes much
// memory and isn't needed. So we strip the language part away.
list( $basename, /* rest */ ) = explode( '/', $this->mDbkeyform, 2 );
return (bool)wfMsgWeirdKey( $basename );
}
return false;
}
/**
* Is this in a namespace that allows actual pages?
*
* @return \type{\bool}
* @internal note -- uses hardcoded namespace index instead of constants
*/
public function canExist() {
return $this->mNamespace >= 0 && $this->mNamespace != NS_MEDIA;
}
/**
* Update page_touched timestamps and send squid purge messages for
* pages linking to this title. May be sent to the job queue depending
* on the number of links. Typically called on create and delete.
*/
public function touchLinks() {
$u = new HTMLCacheUpdate( $this, 'pagelinks' );
$u->doUpdate();
2006-01-07 13:31:29 +00:00
if ( $this->getNamespace() == NS_CATEGORY ) {
$u = new HTMLCacheUpdate( $this, 'categorylinks' );
$u->doUpdate();
}
}
2005-07-23 05:47:25 +00:00
2006-09-05 14:44:50 +00:00
/**
* Get the last touched timestamp
*
* @param $db DatabaseBase: optional db
2008-08-11 04:39:00 +00:00
* @return \type{\string} Last touched timestamp
2006-09-05 14:44:50 +00:00
*/
public function getTouched( $db = null ) {
$db = isset( $db ) ? $db : wfGetDB( DB_SLAVE );
$touched = $db->selectField( 'page', 'page_touched', $this->pageCond(), __METHOD__ );
return $touched;
2006-09-05 14:44:50 +00:00
}
/**
* Get the timestamp when this page was updated since the user last saw it.
*
* @param $user User
* @return Mixed: string/null
*/
public function getNotificationTimestamp( $user = null ) {
global $wgUser, $wgShowUpdatedMarker;
// Assume current user if none given
if ( !$user ) $user = $wgUser;
// Check cache first
$uid = $user->getId();
if ( isset( $this->mNotificationTimestamp[$uid] ) ) {
return $this->mNotificationTimestamp[$uid];
}
if ( !$uid || !$wgShowUpdatedMarker ) {
return $this->mNotificationTimestamp[$uid] = false;
}
// Don't cache too much!
if ( count( $this->mNotificationTimestamp ) >= self::CACHE_MAX ) {
$this->mNotificationTimestamp = array();
}
$dbr = wfGetDB( DB_SLAVE );
$this->mNotificationTimestamp[$uid] = $dbr->selectField( 'watchlist',
'wl_notificationtimestamp',
array( 'wl_namespace' => $this->getNamespace(),
'wl_title' => $this->getDBkey(),
'wl_user' => $user->getId()
),
__METHOD__
);
return $this->mNotificationTimestamp[$uid];
}
2006-09-05 14:44:50 +00:00
2008-08-11 04:39:00 +00:00
/**
* Get the trackback URL for this page
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} Trackback URL
*/
public function trackbackURL() {
global $wgScriptPath, $wgServer, $wgScriptExtension;
2005-07-23 05:47:25 +00:00
return "$wgServer$wgScriptPath/trackback$wgScriptExtension?article="
. htmlspecialchars( urlencode( $this->getPrefixedDBkey() ) );
2005-07-23 05:47:25 +00:00
}
2008-08-11 04:39:00 +00:00
/**
* Get the trackback RDF for this page
*
2008-08-11 04:39:00 +00:00
* @return \type{\string} Trackback RDF
*/
public function trackbackRDF() {
$url = htmlspecialchars( $this->getFullURL() );
$title = htmlspecialchars( $this->getText() );
2005-07-23 05:47:25 +00:00
$tburl = $this->trackbackURL();
// Autodiscovery RDF is placed in comments so HTML validator
// won't barf. This is a rather icky workaround, but seems
// frequently used by this kind of RDF thingy.
//
// Spec: http://www.sixapart.com/pronet/docs/trackback_spec
return "<!--
2005-07-23 05:47:25 +00:00
<rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
<rdf:Description
rdf:about=\"$url\"
dc:identifier=\"$url\"
dc:title=\"$title\"
trackback:ping=\"$tburl\" />
</rdf:RDF>
-->";
2005-07-23 05:47:25 +00:00
}
/**
* Generate strings used for xml 'id' names in monobook tabs
*
* @param $prepend string defaults to 'nstab-'
2008-08-11 04:39:00 +00:00
* @return \type{\string} XML 'id' name
*/
public function getNamespaceKey( $prepend = 'nstab-' ) {
global $wgContLang;
// Gets the subject namespace if this title
$namespace = MWNamespace::getSubject( $this->getNamespace() );
// Checks if cononical namespace name exists for namespace
if ( MWNamespace::exists( $this->getNamespace() ) ) {
// Uses canonical namespace name
$namespaceKey = MWNamespace::getCanonicalName( $namespace );
} else {
// Uses text of namespace
$namespaceKey = $this->getSubjectNsText();
}
// Makes namespace key lowercase
$namespaceKey = $wgContLang->lc( $namespaceKey );
// Uses main
if ( $namespaceKey == '' ) {
$namespaceKey = 'main';
}
// Changes file to image for backwards compatibility
if ( $namespaceKey == 'file' ) {
$namespaceKey = 'image';
}
return $prepend . $namespaceKey;
}
/**
* Returns true if this is a special page.
*
* @return boolean
*/
public function isSpecialPage( ) {
return $this->getNamespace() == NS_SPECIAL;
}
/**
* Returns true if this title resolves to the named special page
*
2008-08-11 04:39:00 +00:00
* @param $name \type{\string} The special page name
* @return boolean
*/
public function isSpecial( $name ) {
if ( $this->getNamespace() == NS_SPECIAL ) {
list( $thisName, /* $subpage */ ) = SpecialPage::resolveAliasWithSubpage( $this->getDBkey() );
if ( $name == $thisName ) {
return true;
}
}
return false;
}
/**
* 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.
* Otherwise, returns $this.
*/
public function fixSpecialName() {
if ( $this->getNamespace() == NS_SPECIAL ) {
$canonicalName = SpecialPage::resolveAlias( $this->mDbkeyform );
if ( $canonicalName ) {
$localName = SpecialPage::getLocalNameFor( $canonicalName );
if ( $localName != $this->mDbkeyform ) {
return Title::makeTitle( NS_SPECIAL, $localName );
}
}
}
return $this;
}
/**
* Is this Title in a namespace which contains content?
* In other words, is this a content page, for the purposes of calculating
* statistics, etc?
*
* @return \type{\bool}
*/
public function isContentPage() {
return MWNamespace::isContent( $this->getNamespace() );
}
2008-08-11 04:39:00 +00:00
/**
* Get all extant redirects to this Title
*
* @param $ns \twotypes{\int,\null} Single namespace to consider;
2008-08-11 04:39:00 +00:00
* NULL to consider all namespaces
* @return \type{\arrayof{Title}} Redirects to this title
2008-08-11 04:39:00 +00:00
*/
public function getRedirectsHere( $ns = null ) {
$redirs = array();
$dbr = wfGetDB( DB_SLAVE );
$where = array(
'rd_namespace' => $this->getNamespace(),
'rd_title' => $this->getDBkey(),
'rd_from = page_id'
);
if ( !is_null( $ns ) ) $where['page_namespace'] = $ns;
$res = $dbr->select(
array( 'redirect', 'page' ),
array( 'page_namespace', 'page_title' ),
$where,
__METHOD__
);
foreach ( $res as $row ) {
$redirs[] = self::newFromRow( $row );
}
return $redirs;
}
/**
* Check if this Title is a valid redirect target
*
* @return \type{\bool}
*/
public function isValidRedirectTarget() {
global $wgInvalidRedirectTargets;
// invalid redirect targets are stored in a global array, but explicity disallow Userlogout here
if ( $this->isSpecial( 'Userlogout' ) ) {
return false;
}
foreach ( $wgInvalidRedirectTargets as $target ) {
if ( $this->isSpecial( $target ) ) {
return false;
}
}
return true;
}
/**
* Get a backlink cache object
*
* @return object BacklinkCache
*/
function getBacklinkCache() {
if ( is_null( $this->mBacklinkCache ) ) {
$this->mBacklinkCache = new BacklinkCache( $this );
}
return $this->mBacklinkCache;
}
/**
* Whether the magic words __INDEX__ and __NOINDEX__ function for
* this page.
*
* @return Boolean
*/
public function canUseNoindex() {
global $wgArticleRobotPolicies, $wgContentNamespaces,
$wgExemptFromUserRobotsControl;
$bannedNamespaces = is_null( $wgExemptFromUserRobotsControl )
? $wgContentNamespaces
: $wgExemptFromUserRobotsControl;
return !in_array( $this->mNamespace, $bannedNamespaces );
}
/**
* Returns restriction types for the current Title
*
* @return array applicable restriction types
*/
public function getRestrictionTypes() {
global $wgRestrictionTypes;
$types = $this->exists() ? $wgRestrictionTypes : array( 'create' );
if ( $this->getNamespace() == NS_FILE ) {
$types[] = 'upload';
}
wfRunHooks( 'TitleGetRestrictionTypes', array( $this, &$types ) );
return $types;
}
}