<?php
/**
* MediaWiki is the to-be base class for this whole project
+ *
+ * @internal documentation reviewed 15 Mar 2010
*/
class MediaWiki {
-
- var $GET; /* Stores the $_GET variables at time of creation, can be changed */
var $params = array();
- /** Constructor. It just save the $_GET variable */
- function __construct() {
- $this->GET = $_GET;
- }
-
/**
* Stores key/value pairs to circumvent global variables
* Note that keys are case-insensitive!
*
- * @param String $key key to store
- * @param mixed $value value to put for the key
+ * @param $key String: key to store
+ * @param $value Mixed: value to put for the key
*/
function setVal( $key, &$value ) {
$key = strtolower( $key );
* Retrieves key/value pairs to circumvent global variables
* Note that keys are case-insensitive!
*
- * @param String $key key to get
- * @param mixed $default default value if if the key doesn't exist
+ * @param $key String: key to get
+ * @param $default string default value, defaults to empty string
+ * @return $default Mixed: default value if if the key doesn't exist
*/
function getVal( $key, $default = '' ) {
$key = strtolower( $key );
* Initialization of ... everything
* Performs the request too
*
- * @param Title $title
- * @param Article $article
- * @param OutputPage $output
- * @param User $user
- * @param WebRequest $request
+ * @param $title Title ($wgTitle)
+ * @param $article Article
+ * @param $output OutputPage
+ * @param $user User
+ * @param $request WebRequest
*/
- function initialize( &$title, &$article, &$output, &$user, $request ) {
+ function performRequestForTitle( &$title, &$article, &$output, &$user, $request ) {
wfProfileIn( __METHOD__ );
- $this->preliminaryChecks( $title, $output, $request ) ;
- if ( !$this->initializeSpecialCases( $title, $output, $request ) ) {
- $new_article = $this->initializeArticle( $title, $request );
+
+ $output->setTitle( $title );
+ if( $request->getVal( 'printable' ) === 'yes' ) {
+ $output->setPrintable();
+ }
+
+ wfRunHooks( 'BeforeInitialize', array( &$title, &$article, &$output, &$user, $request, $this ) );
+
+ if( !$this->preliminaryChecks( $title, $output ) ) {
+ wfProfileOut( __METHOD__ );
+ return;
+ }
+ // Call handleSpecialCases() to deal with all special requests...
+ if( !$this->handleSpecialCases( $title, $output, $request ) ) {
+ // ...otherwise treat it as an article view. The article
+ // may be a redirect to another article or URL.
+ $new_article = $this->initializeArticle( $title, $output, $request );
if( is_object( $new_article ) ) {
$article = $new_article;
$this->performAction( $output, $article, $title, $user, $request );
} elseif( is_string( $new_article ) ) {
$output->redirect( $new_article );
} else {
+ wfProfileOut( __METHOD__ );
throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle() returned neither an object nor a URL" );
}
}
* Check if the maximum lag of database slaves is higher that $maxLag, and
* if it's the case, output an error message
*
- * @param int $maxLag maximum lag allowed for the request, as supplied by
- * the client
+ * @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 ) {
list( $host, $lag ) = wfGetLB()->getMaxLag();
- if ( $lag > $maxLag ) {
+ if( $lag > $maxLag ) {
wfMaxlagError( $host, $lag, $maxLag );
return false;
} else {
}
}
-
/**
* Checks some initial queries
- * Note that $title here is *not* a Title object, but a string!
*
- * @param String $title
- * @param String $action
+ * @param $request WebRequest
* @return Title object to be $wgTitle
*/
- function checkInitialQueries( $title, $action ) {
- global $wgOut, $wgRequest, $wgContLang;
- if( $wgRequest->getVal( 'printable' ) == 'yes' ){
- $wgOut->setPrintable();
- }
+ function checkInitialQueries( WebRequest $request ) {
+ global $wgContLang;
- $ret = NULL;
+ $curid = $request->getInt( 'curid' );
+ $title = $request->getVal( 'title' );
- if ( '' == $title && 'delete' != $action ) {
- $ret = Title::newMainPage();
- } elseif ( $curid = $wgRequest->getInt( 'curid' ) ) {
- # URLs like this are generated by RC, because rc_title isn't always accurate
+ 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).
+ $ret = SpecialPage::getTitleFor( 'Search' );
+ } elseif( $curid ) {
+ // URLs like this are generated by RC, because rc_title isn't always accurate
$ret = Title::newFromID( $curid );
+ } elseif( $title == '' && $this->getAction( $request ) != 'delete' ) {
+ $ret = Title::newMainPage();
} 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( $wgContLang->getVariants() ) > 1 && !is_null( $ret ) && $ret->getArticleID() == 0 )
$wgContLang->findVariantLink( $title, $ret );
-
}
- 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 );
- if( $rev ) {
- $ret = $rev->getTitle();
+ // For non-special titles, check for implicit titles
+ if( is_null( $ret ) || $ret->getNamespace() != NS_SPECIAL ) {
+ // We can have urls with just ?diff=,?oldid= or even just ?diff=
+ $oldid = $request->getInt( 'oldid' );
+ $oldid = $oldid ? $oldid : $request->getInt( 'diff' );
+ // Allow oldid to override a changed or missing title
+ if( $oldid ) {
+ $rev = Revision::newFromId( $oldid );
+ $ret = $rev ? $rev->getTitle() : $ret;
}
}
return $ret;
}
/**
- * Checks for search query and anon-cannot-read case
+ * Checks for anon-cannot-read case
*
- * @param Title $title
- * @param OutputPage $output
- * @param WebRequest $request
+ * @param $title Title
+ * @param $output OutputPage
+ * @return boolean true if successful
*/
- 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' );
- }
-
- # If the user is not logged in, the Namespace:title of the article must be in
- # the Read array in order for the user to see it. (We have to check here to
- # catch special pages etc. We check again in Article::view())
- if ( !is_null( $title ) && !$title->userCanRead() ) {
+ function preliminaryChecks( &$title, &$output ) {
+ // If the user is not logged in, the Namespace:title of the article must be in
+ // the Read array in order for the user to see it. (We have to check here to
+ // catch special pages etc. We check again in Article::view())
+ if( !is_null( $title ) && !$title->userCanRead() ) {
$output->loginToUse();
- $output->output();
- exit;
+ $this->finalCleanup( $output );
+ $output->disable();
+ return false;
}
-
+ return true;
}
/**
* - redirect loop
* - special pages
*
- * @param Title $title
- * @param OutputPage $output
- * @param WebRequest $request
+ * @param $title Title
+ * @param $output OutputPage
+ * @param $request WebRequest
* @return bool true if the request is already executed
*/
- function initializeSpecialCases( &$title, &$output, $request ) {
+ function handleSpecialCases( &$title, &$output, $request ) {
wfProfileIn( __METHOD__ );
- $action = $this->getVal( 'Action' );
- if( !$title || $title->getDBkey() == '' ) {
+ // Invalid titles. Bug 21776: The interwikis must redirect even if the page name is empty.
+ if( is_null($title) || ( ( $title->getDBkey() == '' ) && ( $title->getInterwiki() == '' ) ) ) {
$title = SpecialPage::getTitleFor( 'Badtitle' );
- # Die now before we mess up $wgArticle and the skin stops working
+ $output->setTitle( $title ); // bug 21456
+ // Die now before we mess up $wgArticle and the skin stops working
throw new ErrorPageError( 'badtitle', 'badtitletext' );
- } else if ( $title->getInterwiki() != '' ) {
- if( $rdfrom = $request->getVal( 'rdfrom' ) ) {
+
+ // Interwiki redirects
+ } else if( $title->getInterwiki() != '' ) {
+ $rdfrom = $request->getVal( 'rdfrom' );
+ if( $rdfrom ) {
$url = $title->getFullURL( 'rdfrom=' . urlencode( $rdfrom ) );
} else {
- $url = $title->getFullURL();
+ $query = $request->getValues();
+ unset( $query['title'] );
+ $url = $title->getFullURL( $query );
}
/* Check for a redirect loop */
- if ( !preg_match( '/^' . preg_quote( $this->getVal('Server'), '/' ) . '/', $url ) && $title->isLocal() ) {
+ if( !preg_match( '/^' . preg_quote( $this->getVal('Server'), '/' ) . '/', $url ) && $title->isLocal() ) {
$output->redirect( $url );
} else {
$title = SpecialPage::getTitleFor( 'Badtitle' );
+ $output->setTitle( $title ); // bug 21456
+ wfProfileOut( __METHOD__ );
throw new ErrorPageError( 'badtitle', 'badtitletext' );
}
- } 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' ) ) ) )
+ // Redirect loops, no title in URL, $wgUsePathInfo URLs, and URLs with a variant
+ } else if ( $request->getVal( 'action', 'view' ) == 'view' && !$request->wasPosted()
+ && ( $request->getVal( 'title' ) === null || $title->getPrefixedDBKey() != $request->getVal( 'title' ) )
+ && !count( array_diff( array_keys( $request->getValues() ), array( 'action', 'title' ) ) ) )
{
+ if ( $title->getNamespace() == NS_SPECIAL ) {
+ list( $name, $subpage ) = SpecialPage::resolveAliasWithSubpage( $title->getDBkey() );
+ if ( $name ) {
+ $title = SpecialPage::getTitleFor( $name, $subpage );
+ }
+ }
$targetUrl = $title->getFullURL();
// Redirect to canonical url, make it a 301 to allow caching
if( $targetUrl == $request->getFullRequestURL() ) {
"to true.";
}
wfHttpError( 500, "Internal error", $message );
+ wfProfileOut( __METHOD__ );
return false;
} else {
$output->setSquidMaxage( 1200 );
$output->redirect( $targetUrl, '301' );
}
- } else if ( NS_SPECIAL == $title->getNamespace() ) {
+ // Special pages
+ } else if( NS_SPECIAL == $title->getNamespace() ) {
/* actions that need to be made when we have a special pages */
SpecialPage::executePath( $title );
} else {
/**
* Create an Article object of the appropriate class for the given page.
*
- * @param Title $title
+ * @param $title Title
* @return Article object
*/
static function articleFromTitle( &$title ) {
if( NS_MEDIA == $title->getNamespace() ) {
// FIXME: where should this go?
- $title = Title::makeTitle( NS_IMAGE, $title->getDBkey() );
+ $title = Title::makeTitle( NS_FILE, $title->getDBkey() );
}
$article = null;
}
switch( $title->getNamespace() ) {
- case NS_IMAGE:
- $file = wfFindFile( $title );
- if( $file && $file->getRedirected() ) {
+ case NS_FILE:
+ return new ImagePage( $title );
+ case NS_CATEGORY:
+ return new CategoryPage( $title );
+ default:
return new Article( $title );
+ }
+ }
+
+ /**
+ * Returns the action that will be executed, not necesserly the one passed
+ * passed through the "action" parameter. Actions disabled in
+ * $wgDisabledActions will be replaced by "nosuchaction"
+ *
+ * @param $request WebRequest
+ * @return String: action
+ */
+ public function getAction( WebRequest $request ) {
+ global $wgDisabledActions;
+
+ $action = $request->getVal( 'action', 'view' );
+
+ // Check for disabled actions
+ if( in_array( $action, $wgDisabledActions ) ) {
+ return 'nosuchaction';
+ }
+
+ // Workaround for bug #20966: inability of IE to provide an action dependent
+ // on which submit button is clicked.
+ if ( $action === 'historysubmit' ) {
+ if ( $request->getBool( 'revisiondelete' ) ) {
+ return 'revisiondelete';
+ } elseif ( $request->getBool( 'revisionmove' ) ) {
+ return 'revisionmove';
+ } else {
+ return 'view';
}
- return new ImagePage( $title );
- case NS_CATEGORY:
- return new CategoryPage( $title );
- default:
- return new Article( $title );
+ } elseif ( $action == 'editredlink' ) {
+ return 'edit';
}
+
+ return $action;
}
/**
* 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 $title Title ($wgTitle)
+ * @param $output OutputPage ($wgOut)
+ * @param $request WebRequest ($wgRequest)
* @return mixed an Article, or a string to redirect to another URL
*/
- function initializeArticle( &$title, $request ) {
+ function initializeArticle( &$title, &$output, $request ) {
wfProfileIn( __METHOD__ );
- $action = $this->getVal( 'action' );
+ $action = $request->getVal( 'action', 'view' );
$article = self::articleFromTitle( $title );
-
+ // NS_MEDIAWIKI has no redirects.
+ // It is also used for CSS/JS, so performance matters here...
+ if( $title->getNamespace() == NS_MEDIAWIKI ) {
+ wfProfileOut( __METHOD__ );
+ return $article;
+ }
// Namespace might change when using redirects
- if( ( $action == 'view' || $action == 'render' ) && !$request->getVal( 'oldid' ) &&
- $request->getVal( 'redirect' ) != 'no' &&
- !( $title->getNamespace() == NS_IMAGE && wfFindFile( $title->getText() ) ) ) {
+ // Check for redirects ...
+ $file = ($title->getNamespace() == NS_FILE) ? $article->getFile() : null;
+ if( ( $action == 'view' || $action == 'render' ) // ... for actions that show content
+ && !$request->getVal( 'oldid' ) && // ... and are not old revisions
+ !$request->getVal( 'diff' ) && // ... and not when showing diff
+ $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;
- $dbr = wfGetDB( DB_SLAVE );
- $article->loadPageData( $article->pageDataFromTitle( $dbr, $title ) );
+ wfRunHooks( 'InitializeArticleMaybeRedirect',
+ array(&$title,&$request,&$ignoreRedirect,&$target,&$article) );
- // Follow redirects only for... redirects
- if( $article->mIsRedirect ) {
- $target = $article->followRedirect();
+ // Follow redirects only for... redirects.
+ // If $target is set, then a hook wanted to redirect.
+ if( !$ignoreRedirect && ($target || $article->isRedirect()) ) {
+ // Is the target already set by an extension?
+ $target = $target ? $target : $article->followRedirect();
if( is_string( $target ) ) {
if( !$this->getVal( 'DisableHardRedirects' ) ) {
// we'll need to redirect
+ wfProfileOut( __METHOD__ );
return $target;
}
}
- if( is_object( $target ) ) {
+ if( is_object($target) ) {
// Rewrite environment to redirected article
$rarticle = self::articleFromTitle( $target );
- $rarticle->loadPageData( $rarticle->pageDataFromTitle( $dbr, $target ) );
- if ( $rarticle->mTitle->exists() ) {
+ $rarticle->loadPageData();
+ if( $rarticle->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
$rarticle->setRedirectedFrom( $title );
$article = $rarticle;
$title = $target;
+ $output->setTitle( $title );
}
}
} else {
- $title = $article->mTitle;
+ $title = $article->getTitle();
}
}
wfProfileOut( __METHOD__ );
}
/**
- * Cleaning up by doing deferred updates, calling LBFactory and doing the output
+ * Cleaning up request by doing:
+ ** deferred updates, DB transaction, and the output
*
- * @param Array $deferredUpdates array of updates to do
- * @param OutputPage $output
+ * @param $output OutputPage
*/
- function finalCleanup ( &$deferredUpdates, &$output ) {
+ function finalCleanup( &$output ) {
wfProfileIn( __METHOD__ );
- $this->doUpdates( $deferredUpdates );
- $this->doJobs();
- # Now commit any transactions, so that unreported errors after output() don't roll back the whole thing
+ // Now commit any transactions, so that unreported errors after
+ // output() don't roll back the whole DB transaction
$factory = wfGetLBFactory();
- $factory->shutdown();
+ $factory->commitMasterChanges();
+ // Output everything!
$output->output();
- 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.
- *
- * @param Array $updates array of objects that hold an update to do
- */
- function doUpdates( &$updates ) {
- wfProfileIn( __METHOD__ );
- /* No need to get master connections in case of empty updates array */
- if (!$updates) {
- wfProfileOut( __METHOD__ );
- return;
- }
-
- $dbw = wfGetDB( DB_MASTER );
- foreach( $updates as $up ) {
- $up->doUpdate();
-
- # Commit after every update to prevent lock contention
- if ( $dbw->trxLevel() ) {
- $dbw->commit();
- }
- }
+ // Do any deferred jobs
+ wfDoUpdates( 'commit' );
+ // Close the session so that jobs don't access the current session
+ session_write_close();
+ $this->doJobs();
wfProfileOut( __METHOD__ );
}
* Do a job from the job queue
*/
function doJobs() {
- $jobRunRate = $this->getVal( 'JobRunRate' );
+ global $wgJobRunRate;
- if ( $jobRunRate <= 0 || wfReadOnly() ) {
+ if( $wgJobRunRate <= 0 || wfReadOnly() ) {
return;
}
- if ( $jobRunRate < 1 ) {
+ if( $wgJobRunRate < 1 ) {
$max = mt_getrandmax();
- if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
+ if( mt_rand( 0, $max ) > $max * $wgJobRunRate ) {
return;
}
$n = 1;
} else {
- $n = intval( $jobRunRate );
+ $n = intval( $wgJobRunRate );
}
while ( $n-- && false != ( $job = Job::pop() ) ) {
$success = $job->run();
$t += wfTime();
$t = round( $t*1000 );
- if ( !$success ) {
+ if( !$success ) {
$output .= "Error: " . $job->getLastError() . ", Time: $t ms\n";
} else {
$output .= "Success, Time: $t ms\n";
* Ends this task peacefully
*/
function restInPeace() {
+ MessageCache::logMessages();
wfLogProfilingData();
+ // Commit and close up!
+ $factory = wfGetLBFactory();
+ $factory->commitMasterChanges();
+ $factory->shutdown();
wfDebug( "Request ended normally\n" );
}
/**
* Perform one of the "standard" actions
*
- * @param OutputPage $output
- * @param Article $article
- * @param Title $title
- * @param User $user
- * @param WebRequest $request
+ * @param $output OutputPage
+ * @param $article Article
+ * @param $title Title
+ * @param $user User
+ * @param $request WebRequest
*/
function performAction( &$output, &$article, &$title, &$user, &$request ) {
wfProfileIn( __METHOD__ );
- if ( !wfRunHooks( 'MediaWikiPerformAction', array( $output, $article, $title, $user, $request ) ) ) {
+ 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() ) ) ) {
- /* No such action; this will switch to the default case */
- $action = 'nosuchaction';
- }
+ $action = $this->getAction( $request );
switch( $action ) {
case 'view':
$output->setSquidMaxage( $this->getVal( 'SquidMaxage' ) );
$article->view();
break;
+ case 'raw': // includes JS/CSS
+ wfProfileIn( __METHOD__.'-raw' );
+ $raw = new RawPage( $article );
+ $raw->view();
+ wfProfileOut( __METHOD__.'-raw' );
+ break;
case 'watch':
case 'unwatch':
case 'delete':
if( !$this->getVal( 'EnableDublinCoreRdf' ) ) {
wfHttpError( 403, 'Forbidden', wfMsg( 'nodublincore' ) );
} else {
- require_once( 'includes/Metadata.php' );
- wfDublinCoreRdf( $article );
+ $rdf = new DublinCoreRdf( $article );
+ $rdf->show();
}
break;
case 'creativecommons':
if( !$this->getVal( 'EnableCreativeCommonsRdf' ) ) {
wfHttpError( 403, 'Forbidden', wfMsg( 'nocreativecommons' ) );
} else {
- require_once( 'includes/Metadata.php' );
- wfCreativeCommonsRdf( $article );
+ $rdf = new CreativeCommonsRdf( $article );
+ $rdf->show();
}
break;
case 'credits':
- require_once( 'includes/Credits.php' );
- showCreditsPage( $article );
+ Credits::showPage( $article );
break;
case 'submit':
if( session_id() == '' ) {
}
/* Continue... */
case 'edit':
- case 'editredlink':
if( wfRunHooks( 'CustomEditor', array( $article, $user ) ) ) {
$internal = $request->getVal( 'internaledit' );
$external = $request->getVal( 'externaledit' );
if( $request->getFullRequestURL() == $title->getInternalURL( 'action=history' ) ) {
$output->setSquidMaxage( $this->getVal( 'SquidMaxage' ) );
}
- $history = new PageHistory( $article );
+ $history = new HistoryPage( $article );
$history->history();
break;
- case 'raw':
- $raw = new RawPage( $article );
- $raw->view();
+ case 'revisiondelete':
+ // For show/hide submission from history page
+ $special = SpecialPage::getPage( 'Revisiondelete' );
+ $special->execute( '' );
+ break;
+ case 'revisionmove':
+ // For revision move submission from history page
+ $special = SpecialPage::getPage( 'RevisionMove' );
+ $special->execute( '' );
break;
default:
if( wfRunHooks( 'UnknownAction', array( $action, $article ) ) ) {
}
-}; /* End of class MediaWiki */
+}