summaryrefslogtreecommitdiff
path: root/includes/Wiki.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/Wiki.php')
-rw-r--r--includes/Wiki.php281
1 files changed, 163 insertions, 118 deletions
diff --git a/includes/Wiki.php b/includes/Wiki.php
index e0a57445..fa49290a 100644
--- a/includes/Wiki.php
+++ b/includes/Wiki.php
@@ -2,7 +2,6 @@
/**
* MediaWiki is the to-be base class for this whole project
*/
-
class MediaWiki {
var $GET; /* Stores the $_GET variables at time of creation, can be changed */
@@ -16,6 +15,9 @@ class MediaWiki {
/**
* Stores key/value pairs to circumvent global variables
* Note that keys are case-insensitive!
+ *
+ * @param $key String: key to store
+ * @param $value Mixed: value to put for the key
*/
function setVal( $key, &$value ) {
$key = strtolower( $key );
@@ -25,6 +27,9 @@ class MediaWiki {
/**
* Retrieves key/value pairs to circumvent global variables
* Note that keys are case-insensitive!
+ *
+ * @param $key String: key to get
+ * @param $default Mixed: default value if if the key doesn't exist
*/
function getVal( $key, $default = '' ) {
$key = strtolower( $key );
@@ -36,29 +41,41 @@ class MediaWiki {
/**
* Initialization of ... everything
- @return Article either the object to become $wgArticle, or NULL
+ * Performs the request too
+ *
+ * @param $title Title ($wgTitle)
+ * @param $article Article
+ * @param $output OutputPage
+ * @param $user User
+ * @param $request WebRequest
*/
- function initialize ( &$title, &$output, &$user, $request) {
- wfProfileIn( 'MediaWiki::initialize' );
- $this->preliminaryChecks ( $title, $output, $request ) ;
- $article = NULL;
+ function initialize( &$title, &$article, &$output, &$user, $request ) {
+ wfProfileIn( __METHOD__ );
+ $this->preliminaryChecks( $title, $output, $request ) ;
if ( !$this->initializeSpecialCases( $title, $output, $request ) ) {
- $article = $this->initializeArticle( $title, $request );
- if( is_object( $article ) ) {
+ $new_article = $this->initializeArticle( $title, $request );
+ if( is_object( $new_article ) ) {
+ $article = $new_article;
$this->performAction( $output, $article, $title, $user, $request );
- } elseif( is_string( $article ) ) {
- $output->redirect( $article );
+ } elseif( is_string( $new_article ) ) {
+ $output->redirect( $new_article );
} else {
throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle() returned neither an object nor a URL" );
}
}
- wfProfileOut( 'MediaWiki::initialize' );
- return $article;
+ wfProfileOut( __METHOD__ );
}
+ /**
+ * Check if the maximum lag of database slaves is higher that $maxLag, and
+ * if it's the case, output an error message
+ *
+ * @param $maxLag int: maximum lag allowed for the request, as supplied by
+ * the client
+ * @return bool true if the request can continue
+ */
function checkMaxLag( $maxLag ) {
- global $wgLoadBalancer;
- list( $host, $lag ) = $wgLoadBalancer->getMaxLag();
+ list( $host, $lag ) = wfGetLB()->getMaxLag();
if ( $lag > $maxLag ) {
wfMaxlagError( $host, $lag, $maxLag );
return false;
@@ -71,30 +88,33 @@ class MediaWiki {
/**
* Checks some initial queries
* Note that $title here is *not* a Title object, but a string!
+ *
+ * @param $title String
+ * @param $action String
+ * @return Title object to be $wgTitle
*/
- function checkInitialQueries( $title,$action,&$output,$request, $lang) {
- if ($request->getVal( 'printable' ) == 'yes') {
- $output->setPrintable();
+ function checkInitialQueries( $title, $action ) {
+ global $wgOut, $wgRequest, $wgContLang;
+ if( $wgRequest->getVal( 'printable' ) == 'yes' ){
+ $wgOut->setPrintable();
}
- $ret = NULL ;
-
+ $ret = NULL;
if ( '' == $title && 'delete' != $action ) {
$ret = Title::newMainPage();
- } elseif ( $curid = $request->getInt( 'curid' ) ) {
+ } elseif ( $curid = $wgRequest->getInt( 'curid' ) ) {
# URLs like this are generated by RC, because rc_title isn't always accurate
$ret = Title::newFromID( $curid );
} else {
$ret = Title::newFromURL( $title );
- /* check variant links so that interwiki links don't have to worry about
- the possible different language variants
- */
- if( count($lang->getVariants()) > 1 && !is_null($ret) && $ret->getArticleID() == 0 )
- $lang->findVariantLink( $title, $ret );
+ // check variant links so that interwiki links don't have to worry
+ // about the possible different language variants
+ if( count( $wgContLang->getVariants() ) > 1 && !is_null( $ret ) && $ret->getArticleID() == 0 )
+ $wgContLang->findVariantLink( $title, $ret );
}
- if ( ( $oldid = $request->getInt( 'oldid' ) )
+ if ( ( $oldid = $wgRequest->getInt( 'oldid' ) )
&& ( is_null( $ret ) || $ret->getNamespace() != NS_SPECIAL ) ) {
// Allow oldid to override a changed or missing title.
$rev = Revision::newFromId( $oldid );
@@ -102,19 +122,23 @@ class MediaWiki {
$ret = $rev->getTitle();
}
}
- return $ret ;
+ return $ret;
}
/**
* Checks for search query and anon-cannot-read case
+ *
+ * @param $title Title
+ * @param $output OutputPage
+ * @param $request WebRequest
*/
- function preliminaryChecks ( &$title, &$output, $request ) {
+ function preliminaryChecks( &$title, &$output, $request ) {
if( $request->getCheck( 'search' ) ) {
// Compatibility with old search URLs which didn't use Special:Search
// Just check for presence here, so blank requests still
// show the search page when using ugly URLs (bug 8054).
-
+
// Do this above the read whitelist check for security...
$title = SpecialPage::getTitleFor( 'Search' );
}
@@ -131,14 +155,22 @@ class MediaWiki {
}
/**
- * Initialize the object to be known as $wgArticle for special cases
+ * Initialize some special cases:
+ * - bad titles
+ * - local interwiki redirects
+ * - redirect loop
+ * - special pages
+ *
+ * @param $title Title
+ * @param $output OutputPage
+ * @param $request WebRequest
+ * @return bool true if the request is already executed
*/
- function initializeSpecialCases ( &$title, &$output, $request ) {
- global $wgRequest;
- wfProfileIn( 'MediaWiki::initializeSpecialCases' );
+ function initializeSpecialCases( &$title, &$output, $request ) {
+ wfProfileIn( __METHOD__ );
- $action = $this->getVal('Action');
- if( !$title or $title->getDBkey() == '' ) {
+ $action = $this->getVal( 'Action' );
+ if( !$title || $title->getDBkey() == '' ) {
$title = SpecialPage::getTitleFor( 'Badtitle' );
# Die now before we mess up $wgArticle and the skin stops working
throw new ErrorPageError( 'badtitle', 'badtitletext' );
@@ -155,20 +187,19 @@ class MediaWiki {
$title = SpecialPage::getTitleFor( 'Badtitle' );
throw new ErrorPageError( 'badtitle', 'badtitletext' );
}
- } else if ( ( $action == 'view' ) && !$wgRequest->wasPosted() &&
+ } else if ( ( $action == 'view' ) && !$request->wasPosted() &&
(!isset( $this->GET['title'] ) || $title->getPrefixedDBKey() != $this->GET['title'] ) &&
!count( array_diff( array_keys( $this->GET ), array( 'action', 'title' ) ) ) )
{
$targetUrl = $title->getFullURL();
// Redirect to canonical url, make it a 301 to allow caching
- global $wgUsePathInfo;
- if( $targetUrl == $wgRequest->getFullRequestURL() ) {
+ if( $targetUrl == $request->getFullRequestURL() ) {
$message = "Redirect loop detected!\n\n" .
"This means the wiki got confused about what page was " .
"requested; this sometimes happens when moving a wiki " .
"to a new server or changing the server configuration.\n\n";
- if( $wgUsePathInfo ) {
+ if( $this->getVal( 'UsePathInfo' ) ) {
$message .= "The wiki is trying to interpret the page " .
"title from the URL path portion (PATH_INFO), which " .
"sometimes fails depending on the web server. Try " .
@@ -186,44 +217,41 @@ class MediaWiki {
return false;
} else {
$output->setSquidMaxage( 1200 );
- $output->redirect( $targetUrl, '301');
+ $output->redirect( $targetUrl, '301' );
}
} else if ( NS_SPECIAL == $title->getNamespace() ) {
/* actions that need to be made when we have a special pages */
SpecialPage::executePath( $title );
} else {
/* No match to special cases */
- wfProfileOut( 'MediaWiki::initializeSpecialCases' );
+ wfProfileOut( __METHOD__ );
return false;
}
/* Did match a special case */
- wfProfileOut( 'MediaWiki::initializeSpecialCases' );
+ wfProfileOut( __METHOD__ );
return true;
}
/**
* Create an Article object of the appropriate class for the given page.
- * @param Title $title
- * @return Article
+ *
+ * @param $title Title
+ * @return Article object
*/
- static function articleFromTitle( $title ) {
- $article = null;
- wfRunHooks('ArticleFromTitle', array( &$title, &$article ) );
- if ( $article ) {
- return $article;
- }
-
+ static function articleFromTitle( &$title ) {
if( NS_MEDIA == $title->getNamespace() ) {
// FIXME: where should this go?
$title = Title::makeTitle( NS_IMAGE, $title->getDBkey() );
}
+ $article = null;
+ wfRunHooks( 'ArticleFromTitle', array( &$title, &$article ) );
+ if( $article ) {
+ return $article;
+ }
+
switch( $title->getNamespace() ) {
case NS_IMAGE:
- $file = wfFindFile( $title );
- if( $file && $file->getRedirected() ) {
- return new Article( $title );
- }
return new ImagePage( $title );
case NS_CATEGORY:
return new CategoryPage( $title );
@@ -235,83 +263,97 @@ class MediaWiki {
/**
* Initialize the object to be known as $wgArticle for "standard" actions
* Create an Article object for the page, following redirects if needed.
- * @param Title $title
- * @param Request $request
- * @param string $action
+ *
+ * @param $title Title ($wgTitle)
+ * @param $request WebRequest
* @return mixed an Article, or a string to redirect to another URL
*/
- function initializeArticle( $title, $request ) {
- global $wgTitle;
- wfProfileIn( 'MediaWiki::initializeArticle' );
-
- $action = $this->getVal('Action');
- $article = $this->articleFromTitle( $title );
+ function initializeArticle( &$title, $request ) {
+ wfProfileIn( __METHOD__ );
+ $action = $this->getVal( 'action' );
+ $article = self::articleFromTitle( $title );
+
+ wfDebug("Article: ".$title->getPrefixedText()."\n");
+
// Namespace might change when using redirects
- if( ( $action == 'view' || $action == 'render' ) && !$request->getVal( 'oldid' ) &&
- $request->getVal( 'redirect' ) != 'no' &&
- !( $wgTitle->getNamespace() == NS_IMAGE && wfFindFile( $wgTitle->getText() ) ) ) {
-
- $dbr = wfGetDB(DB_SLAVE);
- $article->loadPageData($article->pageDataFromTitle($dbr, $title));
-
- /* Follow redirects only for... redirects */
- if ($article->mIsRedirect) {
- $target = $article->followRedirect();
+ // Check for redirects ...
+ $file = $title->getNamespace() == NS_IMAGE ? $article->getFile() : null;
+ if( ( $action == 'view' || $action == 'render' ) // ... for actions that show content
+ && !$request->getVal( 'oldid' ) && // ... and are not old revisions
+ $request->getVal( 'redirect' ) != 'no' && // ... unless explicitly told not to
+ // ... and the article is not a non-redirect image page with associated file
+ !( is_object( $file ) && $file->exists() && !$file->getRedirected() ) ) {
+
+ # Give extensions a change to ignore/handle redirects as needed
+ $ignoreRedirect = $target = false;
+ wfRunHooks( 'InitializeArticleMaybeRedirect', array( &$title, &$request, &$ignoreRedirect, &$target ) );
+
+ $dbr = wfGetDB( DB_SLAVE );
+ $article->loadPageData( $article->pageDataFromTitle( $dbr, $title ) );
+
+ // Follow redirects only for... redirects
+ if( !$ignoreRedirect && $article->isRedirect() ) {
+ # Is the target already set by an extension?
+ $target = $target ? $target : $article->followRedirect();
if( is_string( $target ) ) {
- global $wgDisableHardRedirects;
- if( !$wgDisableHardRedirects ) {
+ if( !$this->getVal( 'DisableHardRedirects' ) ) {
// we'll need to redirect
return $target;
}
}
+
if( is_object( $target ) ) {
- /* Rewrite environment to redirected article */
- $rarticle = $this->articleFromTitle($target);
- $rarticle->loadPageData($rarticle->pageDataFromTitle($dbr,$target));
- if ($rarticle->mTitle->mArticleID) {
+ // Rewrite environment to redirected article
+ $rarticle = self::articleFromTitle( $target );
+ $rarticle->loadPageData( $rarticle->pageDataFromTitle( $dbr, $target ) );
+ if ( $rarticle->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
+ $rarticle->setRedirectedFrom( $title );
$article = $rarticle;
- $wgTitle = $target;
- $article->setRedirectedFrom( $title );
- } else {
- $wgTitle = $title;
+ $title = $target;
}
}
} else {
- $wgTitle = $article->mTitle;
+ $title = $article->getTitle();
}
}
- wfProfileOut( 'MediaWiki::initializeArticle' );
+ wfProfileOut( __METHOD__ );
return $article;
}
/**
- * Cleaning up by doing deferred updates, calling loadbalancer and doing the output
+ * Cleaning up by doing deferred updates, calling LBFactory and doing the output
+ *
+ * @param $deferredUpdates array of updates to do
+ * @param $output OutputPage
*/
- function finalCleanup ( &$deferredUpdates, &$loadBalancer, &$output ) {
- wfProfileIn( 'MediaWiki::finalCleanup' );
+ function finalCleanup ( &$deferredUpdates, &$output ) {
+ wfProfileIn( __METHOD__ );
$this->doUpdates( $deferredUpdates );
$this->doJobs();
- $loadBalancer->saveMasterPos();
# Now commit any transactions, so that unreported errors after output() don't roll back the whole thing
- $loadBalancer->commitMasterChanges();
+ $factory = wfGetLBFactory();
+ $factory->shutdown();
$output->output();
- wfProfileOut( 'MediaWiki::finalCleanup' );
+ wfProfileOut( __METHOD__ );
}
/**
- * Deferred updates aren't really deferred anymore. It's important to report errors to the
- * user, and that means doing this before OutputPage::output(). Note that for page saves,
- * the client will wait until the script exits anyway before following the redirect.
+ * Deferred updates aren't really deferred anymore. It's important to report
+ * errors to the user, and that means doing this before OutputPage::output().
+ * Note that for page saves, the client will wait until the script exits
+ * anyway before following the redirect.
+ *
+ * @param $updates array of objects that hold an update to do
*/
- function doUpdates ( &$updates ) {
- wfProfileIn( 'MediaWiki::doUpdates' );
+ function doUpdates( &$updates ) {
+ wfProfileIn( __METHOD__ );
/* No need to get master connections in case of empty updates array */
if (!$updates) {
- wfProfileOut('MediaWiki::doUpdates');
+ wfProfileOut( __METHOD__ );
return;
}
-
+
$dbw = wfGetDB( DB_MASTER );
foreach( $updates as $up ) {
$up->doUpdate();
@@ -321,29 +363,29 @@ class MediaWiki {
$dbw->commit();
}
}
- wfProfileOut( 'MediaWiki::doUpdates' );
+ wfProfileOut( __METHOD__ );
}
/**
* Do a job from the job queue
*/
function doJobs() {
- global $wgJobRunRate;
+ $jobRunRate = $this->getVal( 'JobRunRate' );
- if ( $wgJobRunRate <= 0 || wfReadOnly() ) {
+ if ( $jobRunRate <= 0 || wfReadOnly() ) {
return;
}
- if ( $wgJobRunRate < 1 ) {
+ if ( $jobRunRate < 1 ) {
$max = mt_getrandmax();
- if ( mt_rand( 0, $max ) > $max * $wgJobRunRate ) {
+ if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
return;
}
$n = 1;
} else {
- $n = intval( $wgJobRunRate );
+ $n = intval( $jobRunRate );
}
- while ( $n-- && false != ($job = Job::pop())) {
+ while ( $n-- && false != ( $job = Job::pop() ) ) {
$output = $job->toString() . "\n";
$t = -wfTime();
$success = $job->run();
@@ -361,25 +403,30 @@ class MediaWiki {
/**
* Ends this task peacefully
*/
- function restInPeace ( &$loadBalancer ) {
+ function restInPeace() {
wfLogProfilingData();
wfDebug( "Request ended normally\n" );
}
/**
* Perform one of the "standard" actions
+ *
+ * @param $output OutputPage
+ * @param $article Article
+ * @param $title Title
+ * @param $user User
+ * @param $request WebRequest
*/
function performAction( &$output, &$article, &$title, &$user, &$request ) {
+ wfProfileIn( __METHOD__ );
- wfProfileIn( 'MediaWiki::performAction' );
-
- if ( !wfRunHooks('MediaWikiPerformAction', array($output, $article, $title, $user, $request)) ) {
- wfProfileOut( 'MediaWiki::performAction' );
+ if ( !wfRunHooks( 'MediaWikiPerformAction', array( $output, $article, $title, $user, $request, $this ) ) ) {
+ wfProfileOut( __METHOD__ );
return;
}
- $action = $this->getVal('Action');
- if( in_array( $action, $this->getVal('DisabledActions',array()) ) ) {
+ $action = $this->getVal( 'Action' );
+ if( in_array( $action, $this->getVal( 'DisabledActions', array() ) ) ) {
/* No such action; this will switch to the default case */
$action = 'nosuchaction';
}
@@ -433,6 +480,7 @@ class MediaWiki {
}
/* Continue... */
case 'edit':
+ case 'editredlink':
if( wfRunHooks( 'CustomEditor', array( $article, $user ) ) ) {
$internal = $request->getVal( 'internaledit' );
$external = $request->getVal( 'externaledit' );
@@ -450,8 +498,7 @@ class MediaWiki {
}
break;
case 'history':
- global $wgRequest;
- if( $wgRequest->getFullRequestURL() == $title->getInternalURL( 'action=history' ) ) {
+ if( $request->getFullRequestURL() == $title->getInternalURL( 'action=history' ) ) {
$output->setSquidMaxage( $this->getVal( 'SquidMaxage' ) );
}
$history = new PageHistory( $article );
@@ -466,10 +513,8 @@ class MediaWiki {
$output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
}
}
- wfProfileOut( 'MediaWiki::performAction' );
+ wfProfileOut( __METHOD__ );
}
}; /* End of class MediaWiki */
-
-