3 * Helper class for the index.php entry point.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * The MediaWiki class is the helper class for the index.php entry point.
26 * @internal documentation reviewed 15 Mar 2010
31 * TODO: fold $output, etc, into this
36 public function request( WebRequest
$x = null ){
37 $old = $this->context
->getRequest();
38 $this->context
->setRequest( $x );
42 public function output( OutputPage
$x = null ){
43 $old = $this->context
->getOutput();
44 $this->context
->setOutput( $x );
48 public function __construct( IContextSource
$context = null ) {
50 $context = RequestContext
::getMain();
53 $this->context
= $context;
54 $this->context
->setTitle( $this->parseTitle() );
58 * Parse the request to get the Title object
60 * @return Title object to be $wgTitle
62 private function parseTitle() {
65 $request = $this->context
->getRequest();
66 $curid = $request->getInt( 'curid' );
67 $title = $request->getVal( 'title' );
69 if ( $request->getCheck( 'search' ) ) {
70 // Compatibility with old search URLs which didn't use Special:Search
71 // Just check for presence here, so blank requests still
72 // show the search page when using ugly URLs (bug 8054).
73 $ret = SpecialPage
::getTitleFor( 'Search' );
75 // URLs like this are generated by RC, because rc_title isn't always accurate
76 $ret = Title
::newFromID( $curid );
77 } elseif ( $title == '' && $this->getAction() != 'delete' ) {
78 $ret = Title
::newMainPage();
80 $ret = Title
::newFromURL( $title );
81 // Alias NS_MEDIA page URLs to NS_FILE...we only use NS_MEDIA
82 // in wikitext links to tell Parser to make a direct file link
83 if ( !is_null( $ret ) && $ret->getNamespace() == NS_MEDIA
) {
84 $ret = Title
::makeTitle( NS_FILE
, $ret->getDBkey() );
86 // Check variant links so that interwiki links don't have to worry
87 // about the possible different language variants
88 if ( count( $wgContLang->getVariants() ) > 1
89 && !is_null( $ret ) && $ret->getArticleID() == 0 )
91 $wgContLang->findVariantLink( $title, $ret );
94 // For non-special titles, check for implicit titles
95 if ( is_null( $ret ) ||
!$ret->isSpecialPage() ) {
96 // We can have urls with just ?diff=,?oldid= or even just ?diff=
97 $oldid = $request->getInt( 'oldid' );
98 $oldid = $oldid ?
$oldid : $request->getInt( 'diff' );
99 // Allow oldid to override a changed or missing title
101 $rev = Revision
::newFromId( $oldid );
102 $ret = $rev ?
$rev->getTitle() : $ret;
106 if ( $ret === null ||
( $ret->getDBkey() == '' && $ret->getInterwiki() == '' ) ) {
107 $ret = SpecialPage
::getTitleFor( 'Badtitle' );
114 * Get the Title object that we'll be acting on, as specified in the WebRequest
117 public function getTitle(){
118 if( $this->context
->getTitle() === null ){
119 $this->context
->setTitle( $this->parseTitle() );
121 return $this->context
->getTitle();
125 * Performs the request.
128 * - local interwiki redirects
135 private function performRequest() {
136 global $wgServer, $wgUsePathInfo, $wgTitle;
138 wfProfileIn( __METHOD__
);
140 $request = $this->context
->getRequest();
141 $title = $this->context
->getTitle();
142 $output = $this->context
->getOutput();
143 $user = $this->context
->getUser();
145 if ( $request->getVal( 'printable' ) === 'yes' ) {
146 $output->setPrintable();
149 wfRunHooks( 'BeforeInitialize',
150 array( &$title, null, &$output, &$user, $request, $this ) );
152 // Invalid titles. Bug 21776: The interwikis must redirect even if the page name is empty.
153 if ( is_null( $title ) ||
( $title->getDBkey() == '' && $title->getInterwiki() == '' ) ||
154 $title->isSpecial( 'Badtitle' ) )
156 $this->context
->setTitle( SpecialPage
::getTitleFor( 'Badtitle' ) );
157 wfProfileOut( __METHOD__
);
158 throw new ErrorPageError( 'badtitle', 'badtitletext' );
161 // Check user's permissions to read this page.
162 // We have to check here to catch special pages etc.
163 // We will check again in Article::view().
164 $permErrors = $title->getUserPermissionsErrors( 'read', $user );
165 if ( count( $permErrors ) ) {
166 // Bug 32276: allowing the skin to generate output with $wgTitle or
167 // $this->context->title set to the input title would allow anonymous users to
168 // determine whether a page exists, potentially leaking private data. In fact, the
169 // curid and oldid request parameters would allow page titles to be enumerated even
170 // when they are not guessable. So we reset the title to Special:Badtitle before the
171 // permissions error is displayed.
173 // The skin mostly uses $this->context->getTitle() these days, but some extensions
174 // still use $wgTitle.
176 $badTitle = SpecialPage
::getTitleFor( 'Badtitle' );
177 $this->context
->setTitle( $badTitle );
178 $wgTitle = $badTitle;
180 wfProfileOut( __METHOD__
);
181 throw new PermissionsError( 'read', $permErrors );
184 $pageView = false; // was an article or special page viewed?
186 // Interwiki redirects
187 if ( $title->getInterwiki() != '' ) {
188 $rdfrom = $request->getVal( 'rdfrom' );
190 $url = $title->getFullURL( 'rdfrom=' . urlencode( $rdfrom ) );
192 $query = $request->getValues();
193 unset( $query['title'] );
194 $url = $title->getFullURL( $query );
196 // Check for a redirect loop
197 if ( !preg_match( '/^' . preg_quote( $wgServer, '/' ) . '/', $url )
198 && $title->isLocal() )
200 // 301 so google et al report the target as the actual url.
201 $output->redirect( $url, 301 );
203 $this->context
->setTitle( SpecialPage
::getTitleFor( 'Badtitle' ) );
204 wfProfileOut( __METHOD__
);
205 throw new ErrorPageError( 'badtitle', 'badtitletext' );
207 // Redirect loops, no title in URL, $wgUsePathInfo URLs, and URLs with a variant
208 } elseif ( $request->getVal( 'action', 'view' ) == 'view' && !$request->wasPosted()
209 && ( $request->getVal( 'title' ) === null ||
210 $title->getPrefixedDBKey() != $request->getVal( 'title' ) )
211 && !count( $request->getValueNames( array( 'action', 'title' ) ) )
212 && wfRunHooks( 'TestCanonicalRedirect', array( $request, $title, $output ) ) )
214 if ( $title->isSpecialPage() ) {
215 list( $name, $subpage ) = SpecialPageFactory
::resolveAlias( $title->getDBkey() );
217 $title = SpecialPage
::getTitleFor( $name, $subpage );
220 $targetUrl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT
);
221 // Redirect to canonical url, make it a 301 to allow caching
222 if ( $targetUrl == $request->getFullRequestURL() ) {
223 $message = "Redirect loop detected!\n\n" .
224 "This means the wiki got confused about what page was " .
225 "requested; this sometimes happens when moving a wiki " .
226 "to a new server or changing the server configuration.\n\n";
228 if ( $wgUsePathInfo ) {
229 $message .= "The wiki is trying to interpret the page " .
230 "title from the URL path portion (PATH_INFO), which " .
231 "sometimes fails depending on the web server. Try " .
232 "setting \"\$wgUsePathInfo = false;\" in your " .
233 "LocalSettings.php, or check that \$wgArticlePath " .
236 $message .= "Your web server was detected as possibly not " .
237 "supporting URL path components (PATH_INFO) correctly; " .
238 "check your LocalSettings.php for a customized " .
239 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
242 throw new HttpError( 500, $message );
244 $output->setSquidMaxage( 1200 );
245 $output->redirect( $targetUrl, '301' );
248 } elseif ( NS_SPECIAL
== $title->getNamespace() ) {
250 // Actions that need to be made when we have a special pages
251 SpecialPageFactory
::executePath( $title, $this->context
);
253 // ...otherwise treat it as an article view. The article
254 // may be a redirect to another article or URL.
255 $article = $this->initializeArticle();
256 if ( is_object( $article ) ) {
259 * $wgArticle is deprecated, do not use it. This will possibly be removed
260 * entirely in 1.20 or 1.21
261 * @deprecated since 1.18
264 $wgArticle = $article;
266 $this->performAction( $article );
267 } elseif ( is_string( $article ) ) {
268 $output->redirect( $article );
270 wfProfileOut( __METHOD__
);
271 throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle() returned neither an object nor a URL" );
276 // Promote user to any groups they meet the criteria for
277 $user->addAutopromoteOnceGroups( 'onView' );
280 wfProfileOut( __METHOD__
);
284 * Create an Article object of the appropriate class for the given page.
286 * @deprecated in 1.18; use Article::newFromTitle() instead
287 * @param $title Title
288 * @param $context IContextSource
289 * @return Article object
291 public static function articleFromTitle( $title, IContextSource
$context ) {
292 return Article
::newFromTitle( $title, $context );
296 * Returns the action that will be executed, not necessarily the one passed
297 * passed through the "action" parameter. Actions disabled in
298 * $wgDisabledActions will be replaced by "nosuchaction"
300 * @return String: action
302 public function getAction() {
303 global $wgDisabledActions;
305 $request = $this->context
->getRequest();
306 $action = $request->getVal( 'action', 'view' );
308 // Check for disabled actions
309 if ( in_array( $action, $wgDisabledActions ) ) {
310 return 'nosuchaction';
313 // Workaround for bug #20966: inability of IE to provide an action dependent
314 // on which submit button is clicked.
315 if ( $action === 'historysubmit' ) {
316 if ( $request->getBool( 'revisiondelete' ) ) {
317 return 'revisiondelete';
321 } elseif ( $action == 'editredlink' ) {
329 * Initialize the main Article object for "standard" actions (view, etc)
330 * Create an Article object for the page, following redirects if needed.
332 * @return mixed an Article, or a string to redirect to another URL
334 private function initializeArticle() {
335 global $wgDisableHardRedirects;
337 wfProfileIn( __METHOD__
);
339 $request = $this->context
->getRequest();
340 $title = $this->context
->getTitle();
342 $action = $request->getVal( 'action', 'view' );
343 $article = Article
::newFromTitle( $title, $this->context
);
344 // NS_MEDIAWIKI has no redirects.
345 // It is also used for CSS/JS, so performance matters here...
346 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
347 wfProfileOut( __METHOD__
);
350 // Namespace might change when using redirects
351 // Check for redirects ...
352 $file = ( $title->getNamespace() == NS_FILE
) ?
$article->getFile() : null;
353 if ( ( $action == 'view' ||
$action == 'render' ) // ... for actions that show content
354 && !$request->getVal( 'oldid' ) && // ... and are not old revisions
355 !$request->getVal( 'diff' ) && // ... and not when showing diff
356 $request->getVal( 'redirect' ) != 'no' && // ... unless explicitly told not to
357 // ... and the article is not a non-redirect image page with associated file
358 !( is_object( $file ) && $file->exists() && !$file->getRedirected() ) )
360 // Give extensions a change to ignore/handle redirects as needed
361 $ignoreRedirect = $target = false;
363 wfRunHooks( 'InitializeArticleMaybeRedirect',
364 array( &$title, &$request, &$ignoreRedirect, &$target, &$article ) );
366 // Follow redirects only for... redirects.
367 // If $target is set, then a hook wanted to redirect.
368 if ( !$ignoreRedirect && ( $target ||
$article->isRedirect() ) ) {
369 // Is the target already set by an extension?
370 $target = $target ?
$target : $article->followRedirect();
371 if ( is_string( $target ) ) {
372 if ( !$wgDisableHardRedirects ) {
373 // we'll need to redirect
374 wfProfileOut( __METHOD__
);
378 if ( is_object( $target ) ) {
379 // Rewrite environment to redirected article
380 $rarticle = Article
::newFromTitle( $target, $this->context
);
381 $rarticle->loadPageData();
382 if ( $rarticle->exists() ||
( is_object( $file ) && !$file->isLocal() ) ) {
383 $rarticle->setRedirectedFrom( $title );
384 $article = $rarticle;
385 $this->context
->setTitle( $target );
389 $this->context
->setTitle( $article->getTitle() );
393 wfProfileOut( __METHOD__
);
398 * Cleaning up request by doing deferred updates, DB transaction, and the output
400 public function finalCleanup() {
401 wfProfileIn( __METHOD__
);
402 // Now commit any transactions, so that unreported errors after
403 // output() don't roll back the whole DB transaction
404 $factory = wfGetLBFactory();
405 $factory->commitMasterChanges();
406 // Output everything!
407 $this->context
->getOutput()->output();
408 // Do any deferred jobs
409 DeferredUpdates
::doUpdates( 'commit' );
411 wfProfileOut( __METHOD__
);
415 * Do a job from the job queue
417 private function doJobs() {
418 global $wgJobRunRate;
420 if ( $wgJobRunRate <= 0 ||
wfReadOnly() ) {
423 if ( $wgJobRunRate < 1 ) {
424 $max = mt_getrandmax();
425 if ( mt_rand( 0, $max ) > $max * $wgJobRunRate ) {
430 $n = intval( $wgJobRunRate );
433 while ( $n-- && false != ( $job = Job
::pop() ) ) {
434 $output = $job->toString() . "\n";
436 $success = $job->run();
438 $t = round( $t * 1000 );
440 $output .= "Error: " . $job->getLastError() . ", Time: $t ms\n";
442 $output .= "Success, Time: $t ms\n";
444 wfDebugLog( 'jobqueue', $output );
449 * Ends this task peacefully
451 public function restInPeace() {
452 MessageCache
::logMessages();
453 wfLogProfilingData();
454 // Commit and close up!
455 $factory = wfGetLBFactory();
456 $factory->commitMasterChanges();
457 $factory->shutdown();
458 wfDebug( "Request ended normally\n" );
462 * Perform one of the "standard" actions
464 * @param $article Article
466 private function performAction( Page
$article ) {
467 global $wgSquidMaxage;
469 wfProfileIn( __METHOD__
);
471 $request = $this->context
->getRequest();
472 $output = $this->context
->getOutput();
473 $title = $this->context
->getTitle();
474 $user = $this->context
->getUser();
476 if ( !wfRunHooks( 'MediaWikiPerformAction',
477 array( $output, $article, $title, $user, $request, $this ) ) )
479 wfProfileOut( __METHOD__
);
483 $act = $this->getAction();
485 $action = Action
::factory( $act, $article );
486 if ( $action instanceof Action
) {
488 wfProfileOut( __METHOD__
);
494 $output->setSquidMaxage( $wgSquidMaxage );
504 if ( session_id() == '' ) {
505 // Send a cookie so anons get talk message notifications
510 if ( wfRunHooks( 'CustomEditor', array( $article, $user ) ) ) {
511 if ( ExternalEdit
::useExternalEngine( $this->context
, 'edit' )
512 && $act == 'edit' && !$request->getVal( 'section' )
513 && !$request->getVal( 'oldid' ) )
515 $extedit = new ExternalEdit( $this->context
);
518 $editor = new EditPage( $article );
524 if ( wfRunHooks( 'UnknownAction', array( $act, $article ) ) ) {
525 $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
528 wfProfileOut( __METHOD__
);
532 * Run the current MediaWiki instance
533 * index.php just calls this
535 public function run() {
537 $this->checkMaxLag();
539 $this->restInPeace();
540 } catch ( Exception
$e ) {
541 MWExceptionHandler
::handle( $e );
546 * Checks if the request should abort due to a lagged server,
547 * for given maxlag parameter.
549 private function checkMaxLag() {
550 global $wgShowHostnames;
552 wfProfileIn( __METHOD__
);
553 $maxLag = $this->context
->getRequest()->getVal( 'maxlag' );
554 if ( !is_null( $maxLag ) ) {
555 list( $host, $lag ) = wfGetLB()->getMaxLag();
556 if ( $lag > $maxLag ) {
557 $resp = $this->context
->getRequest()->response();
558 $resp->header( 'HTTP/1.1 503 Service Unavailable' );
559 $resp->header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
560 $resp->header( 'X-Database-Lag: ' . intval( $lag ) );
561 $resp->header( 'Content-Type: text/plain' );
562 if( $wgShowHostnames ) {
563 echo "Waiting for $host: $lag seconds lagged\n";
565 echo "Waiting for a database server: $lag seconds lagged\n";
568 wfProfileOut( __METHOD__
);
573 wfProfileOut( __METHOD__
);
577 private function main() {
578 global $wgUseFileCache, $wgTitle, $wgUseAjax;
580 wfProfileIn( __METHOD__
);
582 # Set title from request parameters
583 $wgTitle = $this->getTitle();
584 $action = $this->getAction();
585 $user = $this->context
->getUser();
587 # Send Ajax requests to the Ajax dispatcher.
588 if ( $wgUseAjax && $action == 'ajax' ) {
589 $dispatcher = new AjaxDispatcher();
590 $dispatcher->performAction();
591 wfProfileOut( __METHOD__
);
595 if ( $wgUseFileCache && $wgTitle->getNamespace() >= 0 ) {
596 wfProfileIn( 'main-try-filecache' );
597 if ( HTMLFileCache
::useFileCache( $this->context
) ) {
598 /* Try low-level file cache hit */
599 $cache = HTMLFileCache
::newFromTitle( $wgTitle, $action );
600 if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
601 /* Check incoming headers to see if client has this cached */
602 $timestamp = $cache->cacheTimestamp();
603 if ( !$this->context
->getOutput()->checkLastModified( $timestamp ) ) {
604 $cache->loadFromFileCache( $this->context
);
606 # Do any stats increment/watchlist stuff
607 $article = WikiPage
::factory( $wgTitle );
608 $article->doViewUpdates( $user );
609 # Tell OutputPage that output is taken care of
610 $this->context
->getOutput()->disable();
611 wfProfileOut( 'main-try-filecache' );
612 wfProfileOut( __METHOD__
);
616 wfProfileOut( 'main-try-filecache' );
619 $this->performRequest();
620 $this->finalCleanup();
622 wfProfileOut( __METHOD__
);