3 * MediaWiki is the to-be base class for this whole project
5 * @internal documentation reviewed 15 Mar 2010
10 * TODO: fold $output, etc, into this
15 public function request( WebRequest
$x = null ){
16 return wfSetVar( $this->context
->request
, $x );
19 public function output( OutputPage
$x = null ){
20 return wfSetVar( $this->context
->output
, $x );
23 public function __construct( RequestContext
$context ){
24 $this->context
= $context;
25 $this->context
->setTitle( $this->parseTitle() );
29 * Initialization of ... everything
30 * Performs the request too
32 * @param $article Article
34 public function performRequestForTitle( &$article ) {
35 wfProfileIn( __METHOD__
);
37 if ( $this->context
->request
->getVal( 'printable' ) === 'yes' ) {
38 $this->context
->output
->setPrintable();
41 wfRunHooks( 'BeforeInitialize', array(
42 &$this->context
->title
,
44 &$this->context
->output
,
45 &$this->context
->user
,
46 $this->context
->request
,
50 // If the user is not logged in, the Namespace:title of the article must be in
51 // the Read array in order for the user to see it. (We have to check here to
52 // catch special pages etc. We check again in Article::view())
53 if ( !is_null( $this->context
->title
) && !$this->context
->title
->userCanRead() ) {
54 $this->context
->output
->loginToUse();
55 $this->finalCleanup();
56 $this->context
->output
->disable();
57 wfProfileOut( __METHOD__
);
61 // Call handleSpecialCases() to deal with all special requests...
62 if ( !$this->handleSpecialCases() ) {
63 // ...otherwise treat it as an article view. The article
64 // may be a redirect to another article or URL.
65 $new_article = $this->initializeArticle();
66 if ( is_object( $new_article ) ) {
67 $article = $new_article;
68 $this->performAction( $article );
69 } elseif ( is_string( $new_article ) ) {
70 $this->context
->output
->redirect( $new_article );
72 wfProfileOut( __METHOD__
);
73 throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle() returned neither an object nor a URL" );
76 wfProfileOut( __METHOD__
);
80 * Parse $request to get the Title object
82 * @return Title object to be $wgTitle
84 private function parseTitle() {
87 $curid = $this->context
->request
->getInt( 'curid' );
88 $title = $this->context
->request
->getVal( 'title' );
90 if ( $this->context
->request
->getCheck( 'search' ) ) {
91 // Compatibility with old search URLs which didn't use Special:Search
92 // Just check for presence here, so blank requests still
93 // show the search page when using ugly URLs (bug 8054).
94 $ret = SpecialPage
::getTitleFor( 'Search' );
96 // URLs like this are generated by RC, because rc_title isn't always accurate
97 $ret = Title
::newFromID( $curid );
98 } elseif ( $title == '' && $this->getAction() != 'delete' ) {
99 $ret = Title
::newMainPage();
101 $ret = Title
::newFromURL( $title );
102 // check variant links so that interwiki links don't have to worry
103 // about the possible different language variants
104 if ( count( $wgContLang->getVariants() ) > 1 && !is_null( $ret ) && $ret->getArticleID() == 0 ){
105 $wgContLang->findVariantLink( $title, $ret );
108 // For non-special titles, check for implicit titles
109 if ( is_null( $ret ) ||
$ret->getNamespace() != NS_SPECIAL
) {
110 // We can have urls with just ?diff=,?oldid= or even just ?diff=
111 $oldid = $this->context
->request
->getInt( 'oldid' );
112 $oldid = $oldid ?
$oldid : $this->context
->request
->getInt( 'diff' );
113 // Allow oldid to override a changed or missing title
115 $rev = Revision
::newFromId( $oldid );
116 $ret = $rev ?
$rev->getTitle() : $ret;
120 if( $ret === null ||
( $ret->getDBkey() == '' && $ret->getInterwiki() == '' ) ){
127 * Get the Title object that we'll be acting on, as specified in the WebRequest
130 public function getTitle(){
131 if( $this->context
->title
=== null ){
132 $this->context
->title
= $this->parseTitle();
134 return $this->context
->title
;
138 * Initialize some special cases:
140 * - local interwiki redirects
144 * @return bool true if the request is already executed
146 private function handleSpecialCases() {
147 global $wgServer, $wgUsePathInfo;
149 wfProfileIn( __METHOD__
);
151 // Invalid titles. Bug 21776: The interwikis must redirect even if the page name is empty.
152 if ( $this->context
->title
instanceof BadTitle
) {
153 throw new ErrorPageError( 'badtitle', 'badtitletext' );
155 // Interwiki redirects
156 } else if ( $this->context
->title
->getInterwiki() != '' ) {
157 $rdfrom = $this->context
->request
->getVal( 'rdfrom' );
159 $url = $this->context
->title
->getFullURL( 'rdfrom=' . urlencode( $rdfrom ) );
161 $query = $this->context
->request
->getValues();
162 unset( $query['title'] );
163 $url = $this->context
->title
->getFullURL( $query );
165 // Check for a redirect loop
166 if ( !preg_match( '/^' . preg_quote( $wgServer, '/' ) . '/', $url ) && $this->context
->title
->isLocal() ) {
167 // 301 so google et al report the target as the actual url.
168 $this->context
->output
->redirect( $url, 301 );
170 $this->context
->title
= new BadTitle
;
171 wfProfileOut( __METHOD__
);
172 throw new ErrorPageError( 'badtitle', 'badtitletext' );
174 // Redirect loops, no title in URL, $wgUsePathInfo URLs, and URLs with a variant
175 } else if ( $this->context
->request
->getVal( 'action', 'view' ) == 'view' && !$this->context
->request
->wasPosted()
176 && ( $this->context
->request
->getVal( 'title' ) === null ||
$this->context
->title
->getPrefixedDBKey() != $this->context
->request
->getVal( 'title' ) )
177 && !count( array_diff( array_keys( $this->context
->request
->getValues() ), array( 'action', 'title' ) ) ) )
179 if ( $this->context
->title
->getNamespace() == NS_SPECIAL
) {
180 list( $name, $subpage ) = SpecialPageFactory
::resolveAlias( $this->context
->title
->getDBkey() );
182 $this->context
->title
= SpecialPage
::getTitleFor( $name, $subpage );
185 $targetUrl = $this->context
->title
->getFullURL();
186 // Redirect to canonical url, make it a 301 to allow caching
187 if ( $targetUrl == $this->context
->request
->getFullRequestURL() ) {
188 $message = "Redirect loop detected!\n\n" .
189 "This means the wiki got confused about what page was " .
190 "requested; this sometimes happens when moving a wiki " .
191 "to a new server or changing the server configuration.\n\n";
193 if ( $wgUsePathInfo ) {
194 $message .= "The wiki is trying to interpret the page " .
195 "title from the URL path portion (PATH_INFO), which " .
196 "sometimes fails depending on the web server. Try " .
197 "setting \"\$wgUsePathInfo = false;\" in your " .
198 "LocalSettings.php, or check that \$wgArticlePath " .
201 $message .= "Your web server was detected as possibly not " .
202 "supporting URL path components (PATH_INFO) correctly; " .
203 "check your LocalSettings.php for a customized " .
204 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
207 wfHttpError( 500, "Internal error", $message );
208 wfProfileOut( __METHOD__
);
211 $this->context
->output
->setSquidMaxage( 1200 );
212 $this->context
->output
->redirect( $targetUrl, '301' );
215 } else if ( NS_SPECIAL
== $this->context
->title
->getNamespace() ) {
216 // actions that need to be made when we have a special pages
217 SpecialPageFactory
::executePath( $this->context
->title
, $this->context
);
219 // No match to special cases
220 wfProfileOut( __METHOD__
);
223 // Did match a special case
224 wfProfileOut( __METHOD__
);
229 * Create an Article object of the appropriate class for the given page.
231 * @param $title Title
232 * @param $context RequestContext
233 * @return Article object
235 public static function articleFromTitle( $title, RequestContext
$context ) {
236 if ( NS_MEDIA
== $title->getNamespace() ) {
237 // @todo FIXME: Where should this go?
238 $title = Title
::makeTitle( NS_FILE
, $title->getDBkey() );
242 wfRunHooks( 'ArticleFromTitle', array( &$title, &$article ) );
247 switch( $title->getNamespace() ) {
249 $page = new ImagePage( $title );
252 $page = new CategoryPage( $title );
255 $page = new Article( $title );
257 $page->setContext( $context );
262 * Returns the action that will be executed, not necesserly the one passed
263 * passed through the "action" parameter. Actions disabled in
264 * $wgDisabledActions will be replaced by "nosuchaction"
266 * @return String: action
268 public function getAction() {
269 global $wgDisabledActions;
271 $action = $this->context
->request
->getVal( 'action', 'view' );
273 // Check for disabled actions
274 if ( in_array( $action, $wgDisabledActions ) ) {
275 return 'nosuchaction';
278 // Workaround for bug #20966: inability of IE to provide an action dependent
279 // on which submit button is clicked.
280 if ( $action === 'historysubmit' ) {
281 if ( $this->context
->request
->getBool( 'revisiondelete' ) ) {
282 return 'revisiondelete';
286 } elseif ( $action == 'editredlink' ) {
294 * Initialize the main Article object for "standard" actions (view, etc)
295 * Create an Article object for the page, following redirects if needed.
297 * @return mixed an Article, or a string to redirect to another URL
299 private function initializeArticle() {
300 global $wgDisableHardRedirects;
302 wfProfileIn( __METHOD__
);
304 $action = $this->context
->request
->getVal( 'action', 'view' );
305 $article = self
::articleFromTitle( $this->context
->title
, $this->context
);
306 // NS_MEDIAWIKI has no redirects.
307 // It is also used for CSS/JS, so performance matters here...
308 if ( $this->context
->title
->getNamespace() == NS_MEDIAWIKI
) {
309 wfProfileOut( __METHOD__
);
312 // Namespace might change when using redirects
313 // Check for redirects ...
314 $file = ( $this->context
->title
->getNamespace() == NS_FILE
) ?
$article->getFile() : null;
315 if ( ( $action == 'view' ||
$action == 'render' ) // ... for actions that show content
316 && !$this->context
->request
->getVal( 'oldid' ) && // ... and are not old revisions
317 !$this->context
->request
->getVal( 'diff' ) && // ... and not when showing diff
318 $this->context
->request
->getVal( 'redirect' ) != 'no' && // ... unless explicitly told not to
319 // ... and the article is not a non-redirect image page with associated file
320 !( is_object( $file ) && $file->exists() && !$file->getRedirected() ) )
322 // Give extensions a change to ignore/handle redirects as needed
323 $ignoreRedirect = $target = false;
325 wfRunHooks( 'InitializeArticleMaybeRedirect',
326 array( &$this->context
->title
, &$this->context
->request
, &$ignoreRedirect, &$target, &$article ) );
328 // Follow redirects only for... redirects.
329 // If $target is set, then a hook wanted to redirect.
330 if ( !$ignoreRedirect && ( $target ||
$article->isRedirect() ) ) {
331 // Is the target already set by an extension?
332 $target = $target ?
$target : $article->followRedirect();
333 if ( is_string( $target ) ) {
334 if ( !$wgDisableHardRedirects ) {
335 // we'll need to redirect
336 wfProfileOut( __METHOD__
);
340 if ( is_object( $target ) ) {
341 // Rewrite environment to redirected article
342 $rarticle = self
::articleFromTitle( $target, $this->context
);
343 $rarticle->loadPageData();
344 if ( $rarticle->exists() ||
( is_object( $file ) && !$file->isLocal() ) ) {
345 $rarticle->setRedirectedFrom( $this->context
->title
);
346 $article = $rarticle;
347 $this->context
->title
= $target;
351 $this->context
->title
= $article->getTitle();
354 wfProfileOut( __METHOD__
);
359 * Cleaning up request by doing deferred updates, DB transaction, and the output
361 public function finalCleanup() {
362 wfProfileIn( __METHOD__
);
363 // Now commit any transactions, so that unreported errors after
364 // output() don't roll back the whole DB transaction
365 $factory = wfGetLBFactory();
366 $factory->commitMasterChanges();
367 // Output everything!
368 $this->context
->output
->output();
369 // Do any deferred jobs
370 wfDoUpdates( 'commit' );
371 // Close the session so that jobs don't access the current session
372 session_write_close();
374 wfProfileOut( __METHOD__
);
378 * Do a job from the job queue
380 private function doJobs() {
381 global $wgJobRunRate;
383 if ( $wgJobRunRate <= 0 ||
wfReadOnly() ) {
386 if ( $wgJobRunRate < 1 ) {
387 $max = mt_getrandmax();
388 if ( mt_rand( 0, $max ) > $max * $wgJobRunRate ) {
393 $n = intval( $wgJobRunRate );
396 while ( $n-- && false != ( $job = Job
::pop() ) ) {
397 $output = $job->toString() . "\n";
399 $success = $job->run();
401 $t = round( $t * 1000 );
403 $output .= "Error: " . $job->getLastError() . ", Time: $t ms\n";
405 $output .= "Success, Time: $t ms\n";
407 wfDebugLog( 'jobqueue', $output );
412 * Ends this task peacefully
414 public function restInPeace() {
415 MessageCache
::logMessages();
416 wfLogProfilingData();
417 // Commit and close up!
418 $factory = wfGetLBFactory();
419 $factory->commitMasterChanges();
420 $factory->shutdown();
421 wfDebug( "Request ended normally\n" );
425 * Perform one of the "standard" actions
427 * @param $article Article
429 private function performAction( $article ) {
430 global $wgSquidMaxage, $wgUseExternalEditor,
431 $wgEnableDublinCoreRdf, $wgEnableCreativeCommonsRdf;
433 wfProfileIn( __METHOD__
);
435 if ( !wfRunHooks( 'MediaWikiPerformAction', array(
436 $this->context
->output
, $article, $this->context
->title
,
437 $this->context
->user
, $this->context
->request
, $this ) ) )
439 wfProfileOut( __METHOD__
);
443 $act = $this->getAction();
445 $action = Action
::factory( $this->getAction(), $article );
446 if( $action instanceof Action
){
448 wfProfileOut( __METHOD__
);
454 $this->context
->output
->setSquidMaxage( $wgSquidMaxage );
457 case 'raw': // includes JS/CSS
458 wfProfileIn( __METHOD__
. '-raw' );
459 $raw = new RawPage( $article );
461 wfProfileOut( __METHOD__
. '-raw' );
469 case 'markpatrolled':
471 case 'deletetrackback':
475 if ( !$wgEnableDublinCoreRdf ) {
476 wfHttpError( 403, 'Forbidden', wfMsg( 'nodublincore' ) );
478 $rdf = new DublinCoreRdf( $article );
482 case 'creativecommons':
483 if ( !$wgEnableCreativeCommonsRdf ) {
484 wfHttpError( 403, 'Forbidden', wfMsg( 'nocreativecommons' ) );
486 $rdf = new CreativeCommonsRdf( $article );
491 if ( session_id() == '' ) {
492 // Send a cookie so anons get talk message notifications
497 if ( wfRunHooks( 'CustomEditor', array( $article, $this->context
->user
) ) ) {
498 $internal = $this->context
->request
->getVal( 'internaledit' );
499 $external = $this->context
->request
->getVal( 'externaledit' );
500 $section = $this->context
->request
->getVal( 'section' );
501 $oldid = $this->context
->request
->getVal( 'oldid' );
502 if ( !$wgUseExternalEditor ||
$act == 'submit' ||
$internal ||
503 $section ||
$oldid ||
( !$this->context
->user
->getOption( 'externaleditor' ) && !$external ) ) {
504 $editor = new EditPage( $article );
506 } elseif ( $wgUseExternalEditor && ( $external ||
$this->context
->user
->getOption( 'externaleditor' ) ) ) {
507 $mode = $this->context
->request
->getVal( 'mode' );
508 $extedit = new ExternalEdit( $article, $mode );
514 if ( $this->context
->request
->getFullRequestURL() == $this->context
->title
->getInternalURL( 'action=history' ) ) {
515 $this->context
->output
->setSquidMaxage( $wgSquidMaxage );
517 $history = new HistoryPage( $article );
520 case 'revisiondelete':
521 // For show/hide submission from history page
522 $special = SpecialPageFactory
::getPage( 'Revisiondelete' );
523 $special->execute( '' );
526 if ( wfRunHooks( 'UnknownAction', array( $act, $article ) ) ) {
527 $this->context
->output
->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
530 wfProfileOut( __METHOD__
);