<?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
+ * 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 MediaWiki () {
- $this->GET = $_GET ;
- }
-
function setVal( $key, &$value ) {
- $this->param[strtolower( $key )] = $value;
+ $key = strtolower( $key );
+ $this->params[$key] =& $value;
}
-
- function getVal( $key, $default = "" ) {
+
+ /**
+ * Retrieves key/value pairs to circumvent global variables
+ * Note that keys are case-insensitive!
+ *
+ * @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 );
if( isset( $this->params[$key] ) ) {
return $this->params[$key];
}
return $default;
}
-
+
+ /**
+ * Initialization of ... everything
+ * Performs the request too
+ *
+ * @param $title Title ($wgTitle)
+ * @param $article Article
+ * @param $output OutputPage
+ * @param $user User
+ * @param $request WebRequest
+ */
+ function performRequestForTitle( &$title, &$article, &$output, &$user, $request ) {
+ wfProfileIn( __METHOD__ );
+
+ $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" );
+ }
+ }
+ 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 ) {
+ list( $host, $lag ) = wfGetLB()->getMaxLag();
+ if( $lag > $maxLag ) {
+ wfMaxlagError( $host, $lag, $maxLag );
+ return false;
+ } else {
+ return true;
+ }
+ }
+
+ /**
+ * Checks some initial queries
+ *
+ * @param $request WebRequest
+ * @return Title object to be $wgTitle
+ */
+ function checkInitialQueries( WebRequest $request ) {
+ global $wgContLang;
+
+ $curid = $request->getInt( 'curid' );
+ $title = $request->getVal( 'title' );
+
+ 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 );
+ }
+ // 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 anon-cannot-read case
+ *
+ * @param $title Title
+ * @param $output OutputPage
+ * @return boolean true if successful
+ */
+ 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();
+ $this->finalCleanup( $output );
+ $output->disable();
+ return false;
+ }
+ return true;
+ }
+
/**
- * 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 , $action ) {
- if ( ( $action == 'view' ) &&
- (!isset( $this->GET['title'] ) || $title->getPrefixedDBKey() != $this->GET['title'] ) &&
- !count( array_diff( array_keys( $this->GET ), array( 'action', 'title' ) ) ) )
+ function handleSpecialCases( &$title, &$output, $request ) {
+ wfProfileIn( __METHOD__ );
+
+ // 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' );
+ $output->setTitle( $title ); // bug 21456
+ // Die now before we mess up $wgArticle and the skin stops working
+ throw new ErrorPageError( 'badtitle', 'badtitletext' );
+
+ // Interwiki redirects
+ } else if( $title->getInterwiki() != '' ) {
+ $rdfrom = $request->getVal( 'rdfrom' );
+ if( $rdfrom ) {
+ $url = $title->getFullURL( 'rdfrom=' . urlencode( $rdfrom ) );
+ } else {
+ $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() ) {
+ $output->redirect( $url );
+ } else {
+ $title = SpecialPage::getTitleFor( 'Badtitle' );
+ $output->setTitle( $title ); // bug 21456
+ wfProfileOut( __METHOD__ );
+ throw new ErrorPageError( 'badtitle', 'badtitletext' );
+ }
+ // 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->getText( 'title' ) )
+ && !count( array_diff( array_keys( $request->getValues() ), array( 'action', 'title' ) ) ) )
{
- /* Redirect to canonical url, make it a 301 to allow caching */
- $output->setSquidMaxage( 1200 );
- $output->redirect( $title->getFullURL(), '301');
- } else if ( NS_SPECIAL == $title->getNamespace() ) {
- # actions that need to be made when we have a special pages
+ 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() ) {
+ $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( $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 " .
+ "setting \"\$wgUsePathInfo = false;\" in your " .
+ "LocalSettings.php, or check that \$wgArticlePath " .
+ "is correct.";
+ } else {
+ $message .= "Your web server was detected as possibly not " .
+ "supporting URL path components (PATH_INFO) correctly; " .
+ "check your LocalSettings.php for a customized " .
+ "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
+ "to true.";
+ }
+ wfHttpError( 500, "Internal error", $message );
+ wfProfileOut( __METHOD__ );
+ return false;
+ } else {
+ $output->setSquidMaxage( 1200 );
+ $output->redirect( $targetUrl, '301' );
+ }
+ // Special pages
+ } 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( __METHOD__ );
return false;
}
/* Did match a special case */
+ wfProfileOut( __METHOD__ );
return true;
}
/**
- * Initialize the object to be known as $wgArticle for "standard" actions
+ * Create an Article object of the appropriate class for the given page.
+ *
+ * @param $title Title
+ * @return Article object
*/
- function initializeArticle( &$title, $request, $action ) {
+ static function articleFromTitle( &$title ) {
if( NS_MEDIA == $title->getNamespace() ) {
- $title = Title::makeTitle( NS_IMAGE, $title->getDBkey() );
- }
-
- $ns = $title->getNamespace();
-
- /* Namespace might change when using redirects */
- $article = new Article( $title );
- if( $action == 'view' && !$request->getVal( 'oldid' ) ) {
- $rTitle = Title::newFromRedirect( $article->fetchContent() );
- if( $rTitle ) {
- # Reload from the page pointed to later
- $article->mContentLoaded = false;
- $ns = $rTitle->getNamespace();
- $wasRedirected = true;
- }
+ // FIXME: where should this go?
+ $title = Title::makeTitle( NS_FILE, $title->getDBkey() );
+ }
+
+ $article = null;
+ wfRunHooks( 'ArticleFromTitle', array( &$title, &$article ) );
+ if( $article ) {
+ return $article;
}
- /* Categories and images are handled by a different class */
- if( $ns == NS_IMAGE ) {
- $b4 = $title->getPrefixedText();
- unset( $article );
- require_once( 'includes/ImagePage.php' );
- $article = new ImagePage( $title );
- if( isset( $wasRedirected ) && $request->getVal( 'redirect' ) != 'no' ) {
- $article->mTitle = $rTitle;
- $article->mRedirectedFrom = $b4;
+ switch( $title->getNamespace() ) {
+ 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';
}
- } elseif( $ns == NS_CATEGORY ) {
- unset( $article );
- require_once( 'includes/CategoryPage.php' );
- $article = new CategoryPage( $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 ($wgTitle)
+ * @param $output OutputPage ($wgOut)
+ * @param $request WebRequest ($wgRequest)
+ * @return mixed an Article, or a string to redirect to another URL
+ */
+ function initializeArticle( &$title, &$output, $request ) {
+ wfProfileIn( __METHOD__ );
+
+ $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
+ // 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;
+
+ wfRunHooks( 'InitializeArticleMaybeRedirect',
+ array(&$title,&$request,&$ignoreRedirect,&$target,&$article) );
+
+ // 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) ) {
+ // Rewrite environment to redirected article
+ $rarticle = self::articleFromTitle( $target );
+ $rarticle->loadPageData();
+ if( $rarticle->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
+ $rarticle->setRedirectedFrom( $title );
+ $article = $rarticle;
+ $title = $target;
+ $output->setTitle( $title );
+ }
+ }
+ } else {
+ $title = $article->getTitle();
+ }
+ }
+ wfProfileOut( __METHOD__ );
return $article;
}
+ /**
+ * Cleaning up request by doing:
+ ** deferred updates, DB transaction, and the output
+ *
+ * @param $output OutputPage
+ */
+ function finalCleanup( &$output ) {
+ wfProfileIn( __METHOD__ );
+ // Now commit any transactions, so that unreported errors after
+ // output() don't roll back the whole DB transaction
+ $factory = wfGetLBFactory();
+ $factory->commitMasterChanges();
+ // Output everything!
+ $output->output();
+ // 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() {
+ global $wgJobRunRate;
+
+ if( $wgJobRunRate <= 0 || wfReadOnly() ) {
+ return;
+ }
+ if( $wgJobRunRate < 1 ) {
+ $max = mt_getrandmax();
+ if( mt_rand( 0, $max ) > $max * $wgJobRunRate ) {
+ return;
+ }
+ $n = 1;
+ } else {
+ $n = intval( $wgJobRunRate );
+ }
+
+ while ( $n-- && false != ( $job = Job::pop() ) ) {
+ $output = $job->toString() . "\n";
+ $t = -wfTime();
+ $success = $job->run();
+ $t += wfTime();
+ $t = round( $t*1000 );
+ if( !$success ) {
+ $output .= "Error: " . $job->getLastError() . ", Time: $t ms\n";
+ } else {
+ $output .= "Success, Time: $t ms\n";
+ }
+ wfDebugLog( 'jobqueue', $output );
+ }
+ }
+
+ /**
+ * 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 $output OutputPage
+ * @param $article Article
+ * @param $title Title
+ * @param $user User
+ * @param $request WebRequest
*/
- function performAction( $action, &$output, &$article, &$title, &$user, &$request ) {
+ function performAction( &$output, &$article, &$title, &$user, &$request ) {
+ wfProfileIn( __METHOD__ );
+
+ if( !wfRunHooks( 'MediaWikiPerformAction', array( $output, $article, $title, $user, $request, $this ) ) ) {
+ wfProfileOut( __METHOD__ );
+ return;
+ }
+
+ $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':
case 'unprotect':
case 'info':
case 'markpatrolled':
- case 'validate':
case 'render':
case 'deletetrackback':
case 'purge':
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( !$this->getVal( 'CommandLineMode' ) && !$request->checkSessionCookie() ) {
- # Send a cookie so anons get talk message notifications
- User::SetupSession();
+ if( session_id() == '' ) {
+ /* Send a cookie so anons get talk message notifications */
+ wfSetupSession();
}
- # Continue...
+ /* Continue... */
case 'edit':
- $internal = $request->getVal( 'internaledit' );
- $external = $request->getVal( 'externaledit' );
- $section = $request->getVal( 'section' );
- $oldid = $request->getVal( 'oldid' );
- if( !$this->getVal( 'UseExternalEditor' ) || $action=='submit' || $internal ||
- $section || $oldid ||( !$user->getOption( 'externaleditor' ) && !$external ) ) {
- require_once( 'includes/EditPage.php' );
- $editor = new EditPage( $article );
- $editor->submit();
- } elseif( $this->getVal( 'UseExternalEditor' ) && ( $external || $user->getOption( 'externaleditor' ) ) ) {
- require_once( 'includes/ExternalEdit.php' );
- $mode = $request->getVal( 'mode' );
- $extedit = new ExternalEdit( $article, $mode );
- $extedit->edit();
+ if( wfRunHooks( 'CustomEditor', array( $article, $user ) ) ) {
+ $internal = $request->getVal( 'internaledit' );
+ $external = $request->getVal( 'externaledit' );
+ $section = $request->getVal( 'section' );
+ $oldid = $request->getVal( 'oldid' );
+ if( !$this->getVal( 'UseExternalEditor' ) || $action=='submit' || $internal ||
+ $section || $oldid || ( !$user->getOption( 'externaleditor' ) && !$external ) ) {
+ $editor = new EditPage( $article );
+ $editor->submit();
+ } elseif( $this->getVal( 'UseExternalEditor' ) && ( $external || $user->getOption( 'externaleditor' ) ) ) {
+ $mode = $request->getVal( 'mode' );
+ $extedit = new ExternalEdit( $article, $mode );
+ $extedit->edit();
+ }
}
break;
case 'history':
- if( $_SERVER['REQUEST_URI'] == $title->getInternalURL( 'action=history' ) ) {
+ if( $request->getFullRequestURL() == $title->getInternalURL( 'action=history' ) ) {
$output->setSquidMaxage( $this->getVal( 'SquidMaxage' ) );
}
- require_once( 'includes/PageHistory.php' );
- $history = new PageHistory( $article );
+ $history = new HistoryPage( $article );
$history->history();
break;
- case 'raw':
- require_once( 'includes/RawPage.php' );
- $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 ) ) ) {
- $output->errorpage( 'nosuchaction', 'nosuchactiontext' );
+ $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
}
}
- }
-
-}; # End of class MediaWiki
+ wfProfileOut( __METHOD__ );
-?>
+ }
+}