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
37 * @param $x null|WebRequest
40 public function request( WebRequest
$x = null ) {
41 $old = $this->context
->getRequest();
42 $this->context
->setRequest( $x );
47 * @param $x null|OutputPage
50 public function output( OutputPage
$x = null ) {
51 $old = $this->context
->getOutput();
52 $this->context
->setOutput( $x );
57 * @param IContextSource|null $context
59 public function __construct( IContextSource
$context = null ) {
61 $context = RequestContext
::getMain();
64 $this->context
= $context;
68 * Parse the request to get the Title object
70 * @return Title object to be $wgTitle
72 private function parseTitle() {
75 $request = $this->context
->getRequest();
76 $curid = $request->getInt( 'curid' );
77 $title = $request->getVal( 'title' );
78 $action = $request->getVal( 'action', 'view' );
80 if ( $request->getCheck( 'search' ) ) {
81 // Compatibility with old search URLs which didn't use Special:Search
82 // Just check for presence here, so blank requests still
83 // show the search page when using ugly URLs (bug 8054).
84 $ret = SpecialPage
::getTitleFor( 'Search' );
86 // URLs like this are generated by RC, because rc_title isn't always accurate
87 $ret = Title
::newFromID( $curid );
89 $ret = Title
::newFromURL( $title );
90 // Alias NS_MEDIA page URLs to NS_FILE...we only use NS_MEDIA
91 // in wikitext links to tell Parser to make a direct file link
92 if ( !is_null( $ret ) && $ret->getNamespace() == NS_MEDIA
) {
93 $ret = Title
::makeTitle( NS_FILE
, $ret->getDBkey() );
95 // Check variant links so that interwiki links don't have to worry
96 // about the possible different language variants
97 if ( count( $wgContLang->getVariants() ) > 1
98 && !is_null( $ret ) && $ret->getArticleID() == 0
100 $wgContLang->findVariantLink( $title, $ret );
104 // If title is not provided, always allow oldid and diff to set the title.
105 // If title is provided, allow oldid and diff to override the title, unless
106 // we are talking about a special page which might use these parameters for
108 if ( $ret === null ||
!$ret->isSpecialPage() ) {
109 // We can have urls with just ?diff=,?oldid= or even just ?diff=
110 $oldid = $request->getInt( 'oldid' );
111 $oldid = $oldid ?
$oldid : $request->getInt( 'diff' );
112 // Allow oldid to override a changed or missing title
114 $rev = Revision
::newFromId( $oldid );
115 $ret = $rev ?
$rev->getTitle() : $ret;
119 // Use the main page as default title if nothing else has been provided
120 if ( $ret === null && strval( $title ) === '' && !$request->getCheck( 'curid' ) && $action !== 'delete' ) {
121 $ret = Title
::newMainPage();
124 if ( $ret === null ||
( $ret->getDBkey() == '' && !$ret->isExternal() ) ) {
125 $ret = SpecialPage
::getTitleFor( 'Badtitle' );
132 * Get the Title object that we'll be acting on, as specified in the WebRequest
135 public function getTitle() {
136 if ( $this->context
->getTitle() === null ) {
137 $this->context
->setTitle( $this->parseTitle() );
139 return $this->context
->getTitle();
143 * Returns the name of the action that will be executed.
145 * @return string: action
147 public function getAction() {
148 static $action = null;
150 if ( $action === null ) {
151 $action = Action
::getActionName( $this->context
);
158 * Performs the request.
161 * - local interwiki redirects
166 * @throws MWException|PermissionsError|BadTitleError|HttpError
169 private function performRequest() {
170 global $wgServer, $wgUsePathInfo, $wgTitle;
172 wfProfileIn( __METHOD__
);
174 $request = $this->context
->getRequest();
175 $requestTitle = $title = $this->context
->getTitle();
176 $output = $this->context
->getOutput();
177 $user = $this->context
->getUser();
179 if ( $request->getVal( 'printable' ) === 'yes' ) {
180 $output->setPrintable();
183 $unused = null; // To pass it by reference
184 wfRunHooks( 'BeforeInitialize', array( &$title, &$unused, &$output, &$user, $request, $this ) );
186 // Invalid titles. Bug 21776: The interwikis must redirect even if the page name is empty.
187 if ( is_null( $title ) ||
( $title->getDBkey() == '' && !$title->isExternal() )
188 ||
$title->isSpecial( 'Badtitle' )
190 $this->context
->setTitle( SpecialPage
::getTitleFor( 'Badtitle' ) );
191 wfProfileOut( __METHOD__
);
192 throw new BadTitleError();
195 // Check user's permissions to read this page.
196 // We have to check here to catch special pages etc.
197 // We will check again in Article::view().
198 $permErrors = $title->getUserPermissionsErrors( 'read', $user );
199 if ( count( $permErrors ) ) {
200 // Bug 32276: allowing the skin to generate output with $wgTitle or
201 // $this->context->title set to the input title would allow anonymous users to
202 // determine whether a page exists, potentially leaking private data. In fact, the
203 // curid and oldid request parameters would allow page titles to be enumerated even
204 // when they are not guessable. So we reset the title to Special:Badtitle before the
205 // permissions error is displayed.
207 // The skin mostly uses $this->context->getTitle() these days, but some extensions
208 // still use $wgTitle.
210 $badTitle = SpecialPage
::getTitleFor( 'Badtitle' );
211 $this->context
->setTitle( $badTitle );
212 $wgTitle = $badTitle;
214 wfProfileOut( __METHOD__
);
215 throw new PermissionsError( 'read', $permErrors );
218 $pageView = false; // was an article or special page viewed?
220 // Interwiki redirects
221 if ( $title->isExternal() ) {
222 $rdfrom = $request->getVal( 'rdfrom' );
224 $url = $title->getFullURL( array( 'rdfrom' => $rdfrom ) );
226 $query = $request->getValues();
227 unset( $query['title'] );
228 $url = $title->getFullURL( $query );
230 // Check for a redirect loop
231 if ( !preg_match( '/^' . preg_quote( $wgServer, '/' ) . '/', $url )
234 // 301 so google et al report the target as the actual url.
235 $output->redirect( $url, 301 );
237 $this->context
->setTitle( SpecialPage
::getTitleFor( 'Badtitle' ) );
238 wfProfileOut( __METHOD__
);
239 throw new BadTitleError();
241 // Redirect loops, no title in URL, $wgUsePathInfo URLs, and URLs with a variant
242 } elseif ( $request->getVal( 'action', 'view' ) == 'view' && !$request->wasPosted()
243 && ( $request->getVal( 'title' ) === null
244 ||
$title->getPrefixedDBkey() != $request->getVal( 'title' ) )
245 && !count( $request->getValueNames( array( 'action', 'title' ) ) )
246 && wfRunHooks( 'TestCanonicalRedirect', array( $request, $title, $output ) )
248 if ( $title->isSpecialPage() ) {
249 list( $name, $subpage ) = SpecialPageFactory
::resolveAlias( $title->getDBkey() );
251 $title = SpecialPage
::getTitleFor( $name, $subpage );
254 $targetUrl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT
);
255 // Redirect to canonical url, make it a 301 to allow caching
256 if ( $targetUrl == $request->getFullRequestURL() ) {
257 $message = "Redirect loop detected!\n\n" .
258 "This means the wiki got confused about what page was " .
259 "requested; this sometimes happens when moving a wiki " .
260 "to a new server or changing the server configuration.\n\n";
262 if ( $wgUsePathInfo ) {
263 $message .= "The wiki is trying to interpret the page " .
264 "title from the URL path portion (PATH_INFO), which " .
265 "sometimes fails depending on the web server. Try " .
266 "setting \"\$wgUsePathInfo = false;\" in your " .
267 "LocalSettings.php, or check that \$wgArticlePath " .
270 $message .= "Your web server was detected as possibly not " .
271 "supporting URL path components (PATH_INFO) correctly; " .
272 "check your LocalSettings.php for a customized " .
273 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
276 throw new HttpError( 500, $message );
278 $output->setSquidMaxage( 1200 );
279 $output->redirect( $targetUrl, '301' );
282 } elseif ( NS_SPECIAL
== $title->getNamespace() ) {
284 // Actions that need to be made when we have a special pages
285 SpecialPageFactory
::executePath( $title, $this->context
);
287 // ...otherwise treat it as an article view. The article
288 // may be a redirect to another article or URL.
289 $article = $this->initializeArticle();
290 if ( is_object( $article ) ) {
292 $this->performAction( $article, $requestTitle );
293 } elseif ( is_string( $article ) ) {
294 $output->redirect( $article );
296 wfProfileOut( __METHOD__
);
297 throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle()"
298 . " returned neither an object nor a URL" );
303 // Promote user to any groups they meet the criteria for
304 $user->addAutopromoteOnceGroups( 'onView' );
307 wfProfileOut( __METHOD__
);
311 * Initialize the main Article object for "standard" actions (view, etc)
312 * Create an Article object for the page, following redirects if needed.
314 * @return mixed an Article, or a string to redirect to another URL
316 private function initializeArticle() {
317 global $wgDisableHardRedirects;
319 wfProfileIn( __METHOD__
);
321 $title = $this->context
->getTitle();
322 if ( $this->context
->canUseWikiPage() ) {
323 // Try to use request context wiki page, as there
324 // is already data from db saved in per process
325 // cache there from this->getAction() call.
326 $page = $this->context
->getWikiPage();
327 $article = Article
::newFromWikiPage( $page, $this->context
);
329 // This case should not happen, but just in case.
330 $article = Article
::newFromTitle( $title, $this->context
);
331 $this->context
->setWikiPage( $article->getPage() );
334 // NS_MEDIAWIKI has no redirects.
335 // It is also used for CSS/JS, so performance matters here...
336 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
337 wfProfileOut( __METHOD__
);
341 $request = $this->context
->getRequest();
343 // Namespace might change when using redirects
344 // Check for redirects ...
345 $action = $request->getVal( 'action', 'view' );
346 $file = ( $title->getNamespace() == NS_FILE
) ?
$article->getFile() : null;
347 if ( ( $action == 'view' ||
$action == 'render' ) // ... for actions that show content
348 && !$request->getVal( 'oldid' ) // ... and are not old revisions
349 && !$request->getVal( 'diff' ) // ... and not when showing diff
350 && $request->getVal( 'redirect' ) != 'no' // ... unless explicitly told not to
351 // ... and the article is not a non-redirect image page with associated file
352 && !( is_object( $file ) && $file->exists() && !$file->getRedirected() )
354 // Give extensions a change to ignore/handle redirects as needed
355 $ignoreRedirect = $target = false;
357 wfRunHooks( 'InitializeArticleMaybeRedirect',
358 array( &$title, &$request, &$ignoreRedirect, &$target, &$article ) );
360 // Follow redirects only for... redirects.
361 // If $target is set, then a hook wanted to redirect.
362 if ( !$ignoreRedirect && ( $target ||
$article->isRedirect() ) ) {
363 // Is the target already set by an extension?
364 $target = $target ?
$target : $article->followRedirect();
365 if ( is_string( $target ) ) {
366 if ( !$wgDisableHardRedirects ) {
367 // we'll need to redirect
368 wfProfileOut( __METHOD__
);
372 if ( is_object( $target ) ) {
373 // Rewrite environment to redirected article
374 $rarticle = Article
::newFromTitle( $target, $this->context
);
375 $rarticle->loadPageData();
376 if ( $rarticle->exists() ||
( is_object( $file ) && !$file->isLocal() ) ) {
377 $rarticle->setRedirectedFrom( $title );
378 $article = $rarticle;
379 $this->context
->setTitle( $target );
380 $this->context
->setWikiPage( $article->getPage() );
384 $this->context
->setTitle( $article->getTitle() );
385 $this->context
->setWikiPage( $article->getPage() );
389 wfProfileOut( __METHOD__
);
394 * Perform one of the "standard" actions
397 * @param $requestTitle The original title, before any redirects were applied
399 private function performAction( Page
$page, Title
$requestTitle ) {
400 global $wgUseSquid, $wgSquidMaxage;
402 wfProfileIn( __METHOD__
);
404 $request = $this->context
->getRequest();
405 $output = $this->context
->getOutput();
406 $title = $this->context
->getTitle();
407 $user = $this->context
->getUser();
409 if ( !wfRunHooks( 'MediaWikiPerformAction',
410 array( $output, $page, $title, $user, $request, $this ) )
412 wfProfileOut( __METHOD__
);
416 $act = $this->getAction();
418 $action = Action
::factory( $act, $page, $this->context
);
420 if ( $action instanceof Action
) {
421 # Let Squid cache things if we can purge them.
423 in_array( $request->getFullRequestURL(), $requestTitle->getSquidURLs() )
425 $output->setSquidMaxage( $wgSquidMaxage );
429 wfProfileOut( __METHOD__
);
433 if ( wfRunHooks( 'UnknownAction', array( $request->getVal( 'action', 'view' ), $page ) ) ) {
434 $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
437 wfProfileOut( __METHOD__
);
441 * Run the current MediaWiki instance
442 * index.php just calls this
444 public function run() {
446 $this->checkMaxLag();
448 if ( function_exists( 'fastcgi_finish_request' ) ) {
449 fastcgi_finish_request();
451 $this->restInPeace();
452 } catch ( Exception
$e ) {
453 MWExceptionHandler
::handle( $e );
458 * Checks if the request should abort due to a lagged server,
459 * for given maxlag parameter.
462 private function checkMaxLag() {
463 global $wgShowHostnames;
465 wfProfileIn( __METHOD__
);
466 $maxLag = $this->context
->getRequest()->getVal( 'maxlag' );
467 if ( !is_null( $maxLag ) ) {
468 list( $host, $lag ) = wfGetLB()->getMaxLag();
469 if ( $lag > $maxLag ) {
470 $resp = $this->context
->getRequest()->response();
471 $resp->header( 'HTTP/1.1 503 Service Unavailable' );
472 $resp->header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
473 $resp->header( 'X-Database-Lag: ' . intval( $lag ) );
474 $resp->header( 'Content-Type: text/plain' );
475 if ( $wgShowHostnames ) {
476 echo "Waiting for $host: $lag seconds lagged\n";
478 echo "Waiting for a database server: $lag seconds lagged\n";
481 wfProfileOut( __METHOD__
);
486 wfProfileOut( __METHOD__
);
490 private function main() {
491 global $wgUseFileCache, $wgTitle, $wgUseAjax;
493 wfProfileIn( __METHOD__
);
495 $request = $this->context
->getRequest();
497 // Send Ajax requests to the Ajax dispatcher.
498 if ( $wgUseAjax && $request->getVal( 'action', 'view' ) == 'ajax' ) {
500 // Set a dummy title, because $wgTitle == null might break things
501 $title = Title
::makeTitle( NS_MAIN
, 'AJAX' );
502 $this->context
->setTitle( $title );
505 $dispatcher = new AjaxDispatcher();
506 $dispatcher->performAction();
507 wfProfileOut( __METHOD__
);
511 // Get title from request parameters,
512 // is set on the fly by parseTitle the first time.
513 $title = $this->getTitle();
514 $action = $this->getAction();
517 // If the user has forceHTTPS set to true, or if the user
518 // is in a group requiring HTTPS, or if they have the HTTPS
519 // preference set, redirect them to HTTPS.
520 // Note: Do this after $wgTitle is setup, otherwise the hooks run from
521 // isLoggedIn() will do all sorts of weird stuff.
524 $request->getCookie( 'forceHTTPS', '' ) ||
525 // check for prefixed version for currently logged in users
526 $request->getCookie( 'forceHTTPS' ) ||
527 // Avoid checking the user and groups unless it's enabled.
529 $this->context
->getUser()->isLoggedIn()
530 && $this->context
->getUser()->requiresHTTPS()
533 $request->getProtocol() == 'http'
535 $oldUrl = $request->getFullRequestURL();
536 $redirUrl = str_replace( 'http://', 'https://', $oldUrl );
538 if ( $request->wasPosted() ) {
539 // This is weird and we'd hope it almost never happens. This
540 // means that a POST came in via HTTP and policy requires us
541 // redirecting to HTTPS. It's likely such a request is going
542 // to fail due to post data being lost, but let's try anyway
543 // and just log the instance.
545 // @todo @fixme See if we could issue a 307 or 308 here, need
546 // to see how clients (automated & browser) behave when we do
547 wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" );
550 // Setup dummy Title, otherwise OutputPage::redirect will fail
551 $title = Title
::newFromText( NS_MAIN
, 'REDIR' );
552 $this->context
->setTitle( $title );
553 $output = $this->context
->getOutput();
554 // Since we only do this redir to change proto, always send a vary header
555 $output->addVaryHeader( 'X-Forwarded-Proto' );
556 $output->redirect( $redirUrl );
558 wfProfileOut( __METHOD__
);
562 if ( $wgUseFileCache && $title->getNamespace() >= 0 ) {
563 wfProfileIn( 'main-try-filecache' );
564 if ( HTMLFileCache
::useFileCache( $this->context
) ) {
565 // Try low-level file cache hit
566 $cache = HTMLFileCache
::newFromTitle( $title, $action );
567 if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
568 // Check incoming headers to see if client has this cached
569 $timestamp = $cache->cacheTimestamp();
570 if ( !$this->context
->getOutput()->checkLastModified( $timestamp ) ) {
571 $cache->loadFromFileCache( $this->context
);
573 // Do any stats increment/watchlist stuff
574 // Assume we're viewing the latest revision (this should always be the case with file cache)
575 $this->context
->getWikiPage()->doViewUpdates( $this->context
->getUser() );
576 // Tell OutputPage that output is taken care of
577 $this->context
->getOutput()->disable();
578 wfProfileOut( 'main-try-filecache' );
579 wfProfileOut( __METHOD__
);
583 wfProfileOut( 'main-try-filecache' );
586 $this->performRequest();
588 // Now commit any transactions, so that unreported errors after
589 // output() don't roll back the whole DB transaction
590 wfGetLBFactory()->commitMasterChanges();
592 // Output everything!
593 $this->context
->getOutput()->output();
595 wfProfileOut( __METHOD__
);
599 * Ends this task peacefully
601 public function restInPeace() {
602 // Do any deferred jobs
603 DeferredUpdates
::doUpdates( 'commit' );
605 // Execute a job from the queue
608 // Log profiling data, e.g. in the database or UDP
609 wfLogProfilingData();
611 // Commit and close up!
612 $factory = wfGetLBFactory();
613 $factory->commitMasterChanges();
614 $factory->shutdown();
616 wfDebug( "Request ended normally\n" );
620 * Do a job from the job queue
622 private function doJobs() {
623 global $wgJobRunRate, $wgPhpCli, $IP;
625 if ( $wgJobRunRate <= 0 ||
wfReadOnly() ) {
629 if ( $wgJobRunRate < 1 ) {
630 $max = mt_getrandmax();
631 if ( mt_rand( 0, $max ) > $max * $wgJobRunRate ) {
632 return; // the higher $wgJobRunRate, the less likely we return here
636 $n = intval( $wgJobRunRate );
639 if ( !wfShellExecDisabled() && is_executable( $wgPhpCli ) ) {
640 // Start a background process to run some of the jobs
641 wfProfileIn( __METHOD__
. '-exec' );
643 $cmd = wfShellWikiCmd( "$IP/maintenance/runJobs.php", array( '--maxjobs', $n ) );
644 $cmd .= " >" . wfGetNull() . " 2>&1"; // don't hang PHP on pipes
645 if ( wfIsWindows() ) {
646 // Using START makes this async and also works around a bug where using
647 // wfShellExec() with a quoted script name causes a filename syntax error.
648 $cmd = "START /B \"bg\" $cmd";
652 wfShellExec( $cmd, $retVal );
653 wfProfileOut( __METHOD__
. '-exec' );
656 // Fallback to running the jobs here while the user waits
657 $group = JobQueueGroup
::singleton();
659 $job = $group->pop( JobQueueGroup
::USE_CACHE
); // job from any queue
661 $output = $job->toString() . "\n";
662 $t = - microtime( true );
663 wfProfileIn( __METHOD__
. '-' . get_class( $job ) );
664 $success = $job->run();
665 wfProfileOut( __METHOD__
. '-' . get_class( $job ) );
666 $group->ack( $job ); // done
667 $t +
= microtime( true );
668 $t = round( $t * 1000 );
669 if ( $success === false ) {
670 $output .= "Error: " . $job->getLastError() . ", Time: $t ms\n";
672 $output .= "Success, Time: $t ms\n";
674 wfDebugLog( 'jobqueue', $output );
676 } while ( --$n && $job );
677 } catch ( MWException
$e ) {
678 // We don't want exceptions thrown during job execution to
679 // be reported to the user since the output is already sent.
680 // Instead we just log them.
681 MWExceptionHandler
::logException( $e );