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.
38 * @param IContextSource|null $context
40 public function __construct( IContextSource
$context = null ) {
42 $context = RequestContext
::getMain();
45 $this->context
= $context;
46 $this->config
= $context->getConfig();
50 * Parse the request to get the Title object
52 * @return Title Title object to be $wgTitle
54 private function parseTitle() {
57 $request = $this->context
->getRequest();
58 $curid = $request->getInt( 'curid' );
59 $title = $request->getVal( 'title' );
60 $action = $request->getVal( 'action' );
62 if ( $request->getCheck( 'search' ) ) {
63 // Compatibility with old search URLs which didn't use Special:Search
64 // Just check for presence here, so blank requests still
65 // show the search page when using ugly URLs (bug 8054).
66 $ret = SpecialPage
::getTitleFor( 'Search' );
68 // URLs like this are generated by RC, because rc_title isn't always accurate
69 $ret = Title
::newFromID( $curid );
71 $ret = Title
::newFromURL( $title );
72 // Alias NS_MEDIA page URLs to NS_FILE...we only use NS_MEDIA
73 // in wikitext links to tell Parser to make a direct file link
74 if ( !is_null( $ret ) && $ret->getNamespace() == NS_MEDIA
) {
75 $ret = Title
::makeTitle( NS_FILE
, $ret->getDBkey() );
77 // Check variant links so that interwiki links don't have to worry
78 // about the possible different language variants
79 if ( count( $wgContLang->getVariants() ) > 1
80 && !is_null( $ret ) && $ret->getArticleID() == 0
82 $wgContLang->findVariantLink( $title, $ret );
86 // If title is not provided, always allow oldid and diff to set the title.
87 // If title is provided, allow oldid and diff to override the title, unless
88 // we are talking about a special page which might use these parameters for
90 if ( $ret === null ||
!$ret->isSpecialPage() ) {
91 // We can have urls with just ?diff=,?oldid= or even just ?diff=
92 $oldid = $request->getInt( 'oldid' );
93 $oldid = $oldid ?
$oldid : $request->getInt( 'diff' );
94 // Allow oldid to override a changed or missing title
96 $rev = Revision
::newFromId( $oldid );
97 $ret = $rev ?
$rev->getTitle() : $ret;
101 // Use the main page as default title if nothing else has been provided
103 && strval( $title ) === ''
104 && !$request->getCheck( 'curid' )
105 && $action !== 'delete'
107 $ret = Title
::newMainPage();
110 if ( $ret === null ||
( $ret->getDBkey() == '' && !$ret->isExternal() ) ) {
111 $ret = SpecialPage
::getTitleFor( 'Badtitle' );
118 * Get the Title object that we'll be acting on, as specified in the WebRequest
121 public function getTitle() {
122 if ( !$this->context
->hasTitle() ) {
123 $this->context
->setTitle( $this->parseTitle() );
125 return $this->context
->getTitle();
129 * Returns the name of the action that will be executed.
131 * @return string Action
133 public function getAction() {
134 static $action = null;
136 if ( $action === null ) {
137 $action = Action
::getActionName( $this->context
);
144 * Performs the request.
147 * - local interwiki redirects
152 * @throws MWException|PermissionsError|BadTitleError|HttpError
155 private function performRequest() {
158 $request = $this->context
->getRequest();
159 $requestTitle = $title = $this->context
->getTitle();
160 $output = $this->context
->getOutput();
161 $user = $this->context
->getUser();
163 if ( $request->getVal( 'printable' ) === 'yes' ) {
164 $output->setPrintable();
167 $unused = null; // To pass it by reference
168 Hooks
::run( 'BeforeInitialize', array( &$title, &$unused, &$output, &$user, $request, $this ) );
170 // Invalid titles. Bug 21776: The interwikis must redirect even if the page name is empty.
171 if ( is_null( $title ) ||
( $title->getDBkey() == '' && !$title->isExternal() )
172 ||
$title->isSpecial( 'Badtitle' )
174 $this->context
->setTitle( SpecialPage
::getTitleFor( 'Badtitle' ) );
175 throw new BadTitleError();
178 // Check user's permissions to read this page.
179 // We have to check here to catch special pages etc.
180 // We will check again in Article::view().
181 $permErrors = $title->isSpecial( 'RunJobs' )
182 ?
array() // relies on HMAC key signature alone
183 : $title->getUserPermissionsErrors( 'read', $user );
184 if ( count( $permErrors ) ) {
185 // Bug 32276: allowing the skin to generate output with $wgTitle or
186 // $this->context->title set to the input title would allow anonymous users to
187 // determine whether a page exists, potentially leaking private data. In fact, the
188 // curid and oldid request parameters would allow page titles to be enumerated even
189 // when they are not guessable. So we reset the title to Special:Badtitle before the
190 // permissions error is displayed.
192 // The skin mostly uses $this->context->getTitle() these days, but some extensions
193 // still use $wgTitle.
195 $badTitle = SpecialPage
::getTitleFor( 'Badtitle' );
196 $this->context
->setTitle( $badTitle );
197 $wgTitle = $badTitle;
199 throw new PermissionsError( 'read', $permErrors );
202 // Interwiki redirects
203 if ( $title->isExternal() ) {
204 $rdfrom = $request->getVal( 'rdfrom' );
206 $url = $title->getFullURL( array( 'rdfrom' => $rdfrom ) );
208 $query = $request->getValues();
209 unset( $query['title'] );
210 $url = $title->getFullURL( $query );
212 // Check for a redirect loop
213 if ( !preg_match( '/^' . preg_quote( $this->config
->get( 'Server' ), '/' ) . '/', $url )
216 // 301 so google et al report the target as the actual url.
217 $output->redirect( $url, 301 );
219 $this->context
->setTitle( SpecialPage
::getTitleFor( 'Badtitle' ) );
220 throw new BadTitleError();
222 // Redirect loops, no title in URL, $wgUsePathInfo URLs, and URLs with a variant
223 } elseif ( $request->getVal( 'action', 'view' ) == 'view' && !$request->wasPosted()
224 && ( $request->getVal( 'title' ) === null
225 ||
$title->getPrefixedDBkey() != $request->getVal( 'title' ) )
226 && !count( $request->getValueNames( array( 'action', 'title' ) ) )
227 && Hooks
::run( 'TestCanonicalRedirect', array( $request, $title, $output ) )
229 if ( $title->isSpecialPage() ) {
230 list( $name, $subpage ) = SpecialPageFactory
::resolveAlias( $title->getDBkey() );
232 $title = SpecialPage
::getTitleFor( $name, $subpage );
235 $targetUrl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT
);
236 // Redirect to canonical url, make it a 301 to allow caching
237 if ( $targetUrl == $request->getFullRequestURL() ) {
238 $message = "Redirect loop detected!\n\n" .
239 "This means the wiki got confused about what page was " .
240 "requested; this sometimes happens when moving a wiki " .
241 "to a new server or changing the server configuration.\n\n";
243 if ( $this->config
->get( 'UsePathInfo' ) ) {
244 $message .= "The wiki is trying to interpret the page " .
245 "title from the URL path portion (PATH_INFO), which " .
246 "sometimes fails depending on the web server. Try " .
247 "setting \"\$wgUsePathInfo = false;\" in your " .
248 "LocalSettings.php, or check that \$wgArticlePath " .
251 $message .= "Your web server was detected as possibly not " .
252 "supporting URL path components (PATH_INFO) correctly; " .
253 "check your LocalSettings.php for a customized " .
254 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
257 throw new HttpError( 500, $message );
259 $output->setSquidMaxage( 1200 );
260 $output->redirect( $targetUrl, '301' );
263 } elseif ( NS_SPECIAL
== $title->getNamespace() ) {
264 // Actions that need to be made when we have a special pages
265 SpecialPageFactory
::executePath( $title, $this->context
);
267 // ...otherwise treat it as an article view. The article
268 // may be a redirect to another article or URL.
269 $article = $this->initializeArticle();
270 if ( is_object( $article ) ) {
271 $this->performAction( $article, $requestTitle );
272 } elseif ( is_string( $article ) ) {
273 $output->redirect( $article );
275 throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle()"
276 . " returned neither an object nor a URL" );
282 * Initialize the main Article object for "standard" actions (view, etc)
283 * Create an Article object for the page, following redirects if needed.
285 * @return mixed An Article, or a string to redirect to another URL
287 private function initializeArticle() {
289 $title = $this->context
->getTitle();
290 if ( $this->context
->canUseWikiPage() ) {
291 // Try to use request context wiki page, as there
292 // is already data from db saved in per process
293 // cache there from this->getAction() call.
294 $page = $this->context
->getWikiPage();
295 $article = Article
::newFromWikiPage( $page, $this->context
);
297 // This case should not happen, but just in case.
298 $article = Article
::newFromTitle( $title, $this->context
);
299 $this->context
->setWikiPage( $article->getPage() );
302 // NS_MEDIAWIKI has no redirects.
303 // It is also used for CSS/JS, so performance matters here...
304 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
308 $request = $this->context
->getRequest();
310 // Namespace might change when using redirects
311 // Check for redirects ...
312 $action = $request->getVal( 'action', 'view' );
313 $file = ( $title->getNamespace() == NS_FILE
) ?
$article->getFile() : null;
314 if ( ( $action == 'view' ||
$action == 'render' ) // ... for actions that show content
315 && !$request->getVal( 'oldid' ) // ... and are not old revisions
316 && !$request->getVal( 'diff' ) // ... and not when showing diff
317 && $request->getVal( 'redirect' ) != 'no' // ... unless explicitly told not to
318 // ... and the article is not a non-redirect image page with associated file
319 && !( is_object( $file ) && $file->exists() && !$file->getRedirected() )
321 // Give extensions a change to ignore/handle redirects as needed
322 $ignoreRedirect = $target = false;
324 Hooks
::run( 'InitializeArticleMaybeRedirect',
325 array( &$title, &$request, &$ignoreRedirect, &$target, &$article ) );
327 // Follow redirects only for... redirects.
328 // If $target is set, then a hook wanted to redirect.
329 if ( !$ignoreRedirect && ( $target ||
$article->isRedirect() ) ) {
330 // Is the target already set by an extension?
331 $target = $target ?
$target : $article->followRedirect();
332 if ( is_string( $target ) ) {
333 if ( !$this->config
->get( 'DisableHardRedirects' ) ) {
334 // we'll need to redirect
338 if ( is_object( $target ) ) {
339 // Rewrite environment to redirected article
340 $rarticle = Article
::newFromTitle( $target, $this->context
);
341 $rarticle->loadPageData();
342 if ( $rarticle->exists() ||
( is_object( $file ) && !$file->isLocal() ) ) {
343 $rarticle->setRedirectedFrom( $title );
344 $article = $rarticle;
345 $this->context
->setTitle( $target );
346 $this->context
->setWikiPage( $article->getPage() );
350 $this->context
->setTitle( $article->getTitle() );
351 $this->context
->setWikiPage( $article->getPage() );
359 * Perform one of the "standard" actions
362 * @param Title $requestTitle The original title, before any redirects were applied
364 private function performAction( Page
$page, Title
$requestTitle ) {
366 $request = $this->context
->getRequest();
367 $output = $this->context
->getOutput();
368 $title = $this->context
->getTitle();
369 $user = $this->context
->getUser();
371 if ( !Hooks
::run( 'MediaWikiPerformAction',
372 array( $output, $page, $title, $user, $request, $this ) )
377 $act = $this->getAction();
379 $action = Action
::factory( $act, $page, $this->context
);
381 if ( $action instanceof Action
) {
382 # Let Squid cache things if we can purge them.
383 if ( $this->config
->get( 'UseSquid' ) &&
385 // Use PROTO_INTERNAL because that's what getSquidURLs() uses
386 wfExpandUrl( $request->getRequestURL(), PROTO_INTERNAL
),
387 $requestTitle->getSquidURLs()
390 $output->setSquidMaxage( $this->config
->get( 'SquidMaxage' ) );
397 if ( Hooks
::run( 'UnknownAction', array( $request->getVal( 'action', 'view' ), $page ) ) ) {
398 $output->setStatusCode( 404 );
399 $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
405 * Run the current MediaWiki instance
406 * index.php just calls this
408 public function run() {
410 $this->checkMaxLag();
413 } catch ( ErrorPageError
$e ) {
414 // Bug 62091: while exceptions are convenient to bubble up GUI errors,
415 // they are not internal application faults. As with normal requests, this
416 // should commit, print the output, do deferred updates, jobs, and profiling.
417 wfGetLBFactory()->commitMasterChanges();
418 $e->report(); // display the GUI error
420 if ( function_exists( 'fastcgi_finish_request' ) ) {
421 fastcgi_finish_request();
423 $this->triggerJobs();
424 $this->restInPeace();
425 } catch ( Exception
$e ) {
426 MWExceptionHandler
::handleException( $e );
431 * Checks if the request should abort due to a lagged server,
432 * for given maxlag parameter.
435 private function checkMaxLag() {
436 $maxLag = $this->context
->getRequest()->getVal( 'maxlag' );
437 if ( !is_null( $maxLag ) ) {
438 list( $host, $lag ) = wfGetLB()->getMaxLag();
439 if ( $lag > $maxLag ) {
440 $resp = $this->context
->getRequest()->response();
441 $resp->header( 'HTTP/1.1 503 Service Unavailable' );
442 $resp->header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
443 $resp->header( 'X-Database-Lag: ' . intval( $lag ) );
444 $resp->header( 'Content-Type: text/plain' );
445 if ( $this->config
->get( 'ShowHostnames' ) ) {
446 echo "Waiting for $host: $lag seconds lagged\n";
448 echo "Waiting for a database server: $lag seconds lagged\n";
457 private function main() {
460 $request = $this->context
->getRequest();
462 // Send Ajax requests to the Ajax dispatcher.
463 if ( $this->config
->get( 'UseAjax' ) && $request->getVal( 'action' ) === 'ajax' ) {
464 // Set a dummy title, because $wgTitle == null might break things
465 $title = Title
::makeTitle( NS_MAIN
, 'AJAX' );
466 $this->context
->setTitle( $title );
469 $dispatcher = new AjaxDispatcher( $this->config
);
470 $dispatcher->performAction( $this->context
->getUser() );
474 // Get title from request parameters,
475 // is set on the fly by parseTitle the first time.
476 $title = $this->getTitle();
477 $action = $this->getAction();
480 $trxProfiler = Profiler
::instance()->getTransactionProfiler();
482 // Aside from rollback, master queries should not happen on GET requests.
483 // Periodic or "in passing" updates on GET should use the job queue.
484 if ( !$request->wasPosted()
485 && in_array( $action, array( 'view', 'edit', 'history' ) )
487 $trxProfiler->setExpectation( 'masterConns', 0, __METHOD__
);
488 $trxProfiler->setExpectation( 'writes', 0, __METHOD__
);
490 $trxProfiler->setExpectation( 'maxAffected', 500, __METHOD__
);
493 // If the user has forceHTTPS set to true, or if the user
494 // is in a group requiring HTTPS, or if they have the HTTPS
495 // preference set, redirect them to HTTPS.
496 // Note: Do this after $wgTitle is setup, otherwise the hooks run from
497 // isLoggedIn() will do all sorts of weird stuff.
499 $request->getProtocol() == 'http' &&
501 $request->getCookie( 'forceHTTPS', '' ) ||
502 // check for prefixed version for currently logged in users
503 $request->getCookie( 'forceHTTPS' ) ||
504 // Avoid checking the user and groups unless it's enabled.
506 $this->context
->getUser()->isLoggedIn()
507 && $this->context
->getUser()->requiresHTTPS()
511 $oldUrl = $request->getFullRequestURL();
512 $redirUrl = preg_replace( '#^http://#', 'https://', $oldUrl );
514 // ATTENTION: This hook is likely to be removed soon due to overall design of the system.
515 if ( Hooks
::run( 'BeforeHttpsRedirect', array( $this->context
, &$redirUrl ) ) ) {
517 if ( $request->wasPosted() ) {
518 // This is weird and we'd hope it almost never happens. This
519 // means that a POST came in via HTTP and policy requires us
520 // redirecting to HTTPS. It's likely such a request is going
521 // to fail due to post data being lost, but let's try anyway
522 // and just log the instance.
524 // @todo FIXME: See if we could issue a 307 or 308 here, need
525 // to see how clients (automated & browser) behave when we do
526 wfDebugLog( 'RedirectedPosts', "Redirected from HTTP to HTTPS: $oldUrl" );
528 // Setup dummy Title, otherwise OutputPage::redirect will fail
529 $title = Title
::newFromText( NS_MAIN
, 'REDIR' );
530 $this->context
->setTitle( $title );
531 $output = $this->context
->getOutput();
532 // Since we only do this redir to change proto, always send a vary header
533 $output->addVaryHeader( 'X-Forwarded-Proto' );
534 $output->redirect( $redirUrl );
540 if ( $this->config
->get( 'UseFileCache' ) && $title->getNamespace() >= 0 ) {
541 if ( HTMLFileCache
::useFileCache( $this->context
) ) {
542 // Try low-level file cache hit
543 $cache = new HTMLFileCache( $title, $action );
544 if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
545 // Check incoming headers to see if client has this cached
546 $timestamp = $cache->cacheTimestamp();
547 if ( !$this->context
->getOutput()->checkLastModified( $timestamp ) ) {
548 $cache->loadFromFileCache( $this->context
);
550 // Do any stats increment/watchlist stuff
551 // Assume we're viewing the latest revision (this should always be the case with file cache)
552 $this->context
->getWikiPage()->doViewUpdates( $this->context
->getUser() );
553 // Tell OutputPage that output is taken care of
554 $this->context
->getOutput()->disable();
560 // Actually do the work of the request and build up any output
561 $this->performRequest();
563 // Either all DB and deferred updates should happen or none.
564 // The later should not be cancelled due to client disconnect.
565 ignore_user_abort( true );
566 // Now commit any transactions, so that unreported errors after
567 // output() don't roll back the whole DB transaction
568 wfGetLBFactory()->commitMasterChanges();
570 // Output everything!
571 $this->context
->getOutput()->output();
576 * Ends this task peacefully
578 public function restInPeace() {
579 // Ignore things like master queries/connections on GET requests
580 // as long as they are in deferred updates (which catch errors).
581 Profiler
::instance()->getTransactionProfiler()->resetExpectations();
583 // Do any deferred jobs
584 DeferredUpdates
::doUpdates( 'commit' );
586 // Log profiling data, e.g. in the database or UDP
587 wfLogProfilingData();
589 // Commit and close up!
590 $factory = wfGetLBFactory();
591 $factory->commitMasterChanges();
592 $factory->shutdown();
594 wfDebug( "Request ended normally\n" );
598 * Potentially open a socket and sent an HTTP request back to the server
599 * to run a specified number of jobs. This registers a callback to cleanup
600 * the socket once it's done.
602 protected function triggerJobs() {
603 $jobRunRate = $this->config
->get( 'JobRunRate' );
604 if ( $jobRunRate <= 0 ||
wfReadOnly() ) {
606 } elseif ( $this->getTitle()->isSpecial( 'RunJobs' ) ) {
607 return; // recursion guard
610 if ( $jobRunRate < 1 ) {
611 $max = mt_getrandmax();
612 if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
613 return; // the higher the job run rate, the less likely we return here
617 $n = intval( $jobRunRate );
620 $runJobsLogger = MWLoggerFactory
::getInstance( 'runJobs' );
622 if ( !$this->config
->get( 'RunJobsAsync' ) ) {
623 // Fall back to running the job here while the user waits
624 $runner = new JobRunner( $runJobsLogger );
625 $runner->run( array( 'maxJobs' => $n ) );
630 if ( !JobQueueGroup
::singleton()->queuesHaveJobs( JobQueueGroup
::TYPE_DEFAULT
) ) {
631 return; // do not send request if there are probably no jobs
633 } catch ( JobQueueError
$e ) {
634 MWExceptionHandler
::logException( $e );
635 return; // do not make the site unavailable
638 $query = array( 'title' => 'Special:RunJobs',
639 'tasks' => 'jobs', 'maxjobs' => $n, 'sigexpiry' => time() +
5 );
640 $query['signature'] = SpecialRunJobs
::getQuerySignature(
641 $query, $this->config
->get( 'SecretKey' ) );
643 $errno = $errstr = null;
644 $info = wfParseUrl( $this->config
->get( 'Server' ) );
645 wfSuppressWarnings();
648 isset( $info['port'] ) ?
$info['port'] : 80,
651 // If it takes more than 100ms to connect to ourselves there
652 // is a problem elsewhere.
657 $runJobsLogger->error( "Failed to start cron API (socket error $errno): $errstr" );
658 // Fall back to running the job here while the user waits
659 $runner = new JobRunner( $runJobsLogger );
660 $runner->run( array( 'maxJobs' => $n ) );
664 $url = wfAppendQuery( wfScript( 'index' ), $query );
665 $req = "POST $url HTTP/1.1\r\nHost: {$info['host']}\r\nConnection: Close\r\nContent-Length: 0\r\n\r\n";
667 $runJobsLogger->info( "Running $n job(s) via '$url'" );
668 // Send a cron API request to be performed in the background.
669 // Give up if this takes too long to send (which should be rare).
670 stream_set_timeout( $sock, 1 );
671 $bytes = fwrite( $sock, $req );
672 if ( $bytes !== strlen( $req ) ) {
673 $runJobsLogger->error( "Failed to start cron API (socket write error)" );
675 // Do not wait for the response (the script should handle client aborts).
676 // Make sure that we don't close before that script reaches ignore_user_abort().
677 $status = fgets( $sock );
678 if ( !preg_match( '#^HTTP/\d\.\d 202 #', $status ) ) {
679 $runJobsLogger->error( "Failed to start cron API: received '$status'" );