3 * MediaWiki is the to-be base class for this whole project
7 var $GET; /* Stores the $_GET variables at time of creation, can be changed */
10 /** Constructor. It just save the $_GET variable */
11 function __construct() {
16 * Stores key/value pairs to circumvent global variables
17 * Note that keys are case-insensitive!
19 * @param String $key key to store
20 * @param mixed $value value to put for the key
22 function setVal( $key, &$value ) {
23 $key = strtolower( $key );
24 $this->params
[$key] =& $value;
28 * Retrieves key/value pairs to circumvent global variables
29 * Note that keys are case-insensitive!
31 * @param String $key key to get
32 * @param mixed $default default value if if the key doesn't exist
34 function getVal( $key, $default = '' ) {
35 $key = strtolower( $key );
36 if( isset( $this->params
[$key] ) ) {
37 return $this->params
[$key];
43 * Initialization of ... everything
44 * Performs the request too
47 * @param Article $article
48 * @param OutputPage $output
50 * @param WebRequest $request
52 function initialize( &$title, &$article, &$output, &$user, $request ) {
53 wfProfileIn( __METHOD__
);
54 $this->preliminaryChecks( $title, $output, $request ) ;
55 if ( !$this->initializeSpecialCases( $title, $output, $request ) ) {
56 $new_article = $this->initializeArticle( $title, $request );
57 if( is_object( $new_article ) ) {
58 $article = $new_article;
59 $this->performAction( $output, $article, $title, $user, $request );
60 } elseif( is_string( $new_article ) ) {
61 $output->redirect( $new_article );
63 throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle() returned neither an object nor a URL" );
66 wfProfileOut( __METHOD__
);
70 * Check if the maximum lag of database slaves is higher that $maxLag, and
71 * if it's the case, output an error message
73 * @param int $maxLag maximum lag allowed for the request, as supplied by
75 * @return bool true if the request can continue
77 function checkMaxLag( $maxLag ) {
78 list( $host, $lag ) = wfGetLB()->getMaxLag();
79 if ( $lag > $maxLag ) {
80 wfMaxlagError( $host, $lag, $maxLag );
89 * Checks some initial queries
90 * Note that $title here is *not* a Title object, but a string!
92 * @param String $title
93 * @param String $action
94 * @return Title object to be $wgTitle
96 function checkInitialQueries( $title, $action ) {
97 global $wgOut, $wgRequest, $wgContLang;
98 if( $wgRequest->getVal( 'printable' ) == 'yes' ){
99 $wgOut->setPrintable();
104 if ( '' == $title && 'delete' != $action ) {
105 $ret = Title
::newMainPage();
106 } elseif ( $curid = $wgRequest->getInt( 'curid' ) ) {
107 # URLs like this are generated by RC, because rc_title isn't always accurate
108 $ret = Title
::newFromID( $curid );
110 $ret = Title
::newFromURL( $title );
111 // check variant links so that interwiki links don't have to worry
112 // about the possible different language variants
113 if( count( $wgContLang->getVariants() ) > 1 && !is_null( $ret ) && $ret->getArticleID() == 0 )
114 $wgContLang->findVariantLink( $title, $ret );
117 if ( ( $oldid = $wgRequest->getInt( 'oldid' ) )
118 && ( is_null( $ret ) ||
$ret->getNamespace() != NS_SPECIAL
) ) {
119 // Allow oldid to override a changed or missing title.
120 $rev = Revision
::newFromId( $oldid );
122 $ret = $rev->getTitle();
129 * Checks for search query and anon-cannot-read case
131 * @param Title $title
132 * @param OutputPage $output
133 * @param WebRequest $request
135 function preliminaryChecks( &$title, &$output, $request ) {
137 if( $request->getCheck( 'search' ) ) {
138 // Compatibility with old search URLs which didn't use Special:Search
139 // Just check for presence here, so blank requests still
140 // show the search page when using ugly URLs (bug 8054).
142 // Do this above the read whitelist check for security...
143 $title = SpecialPage
::getTitleFor( 'Search' );
146 # If the user is not logged in, the Namespace:title of the article must be in
147 # the Read array in order for the user to see it. (We have to check here to
148 # catch special pages etc. We check again in Article::view())
149 if ( !is_null( $title ) && !$title->userCanRead() ) {
150 $output->loginToUse();
158 * Initialize some special cases:
160 * - local interwiki redirects
164 * @param Title $title
165 * @param OutputPage $output
166 * @param WebRequest $request
167 * @return bool true if the request is already executed
169 function initializeSpecialCases( &$title, &$output, $request ) {
170 wfProfileIn( __METHOD__
);
172 $action = $this->getVal( 'Action' );
173 if( !$title ||
$title->getDBkey() == '' ) {
174 $title = SpecialPage
::getTitleFor( 'Badtitle' );
175 # Die now before we mess up $wgArticle and the skin stops working
176 throw new ErrorPageError( 'badtitle', 'badtitletext' );
177 } else if ( $title->getInterwiki() != '' ) {
178 if( $rdfrom = $request->getVal( 'rdfrom' ) ) {
179 $url = $title->getFullURL( 'rdfrom=' . urlencode( $rdfrom ) );
181 $url = $title->getFullURL();
183 /* Check for a redirect loop */
184 if ( !preg_match( '/^' . preg_quote( $this->getVal('Server'), '/' ) . '/', $url ) && $title->isLocal() ) {
185 $output->redirect( $url );
187 $title = SpecialPage
::getTitleFor( 'Badtitle' );
188 throw new ErrorPageError( 'badtitle', 'badtitletext' );
190 } else if ( ( $action == 'view' ) && !$request->wasPosted() &&
191 (!isset( $this->GET
['title'] ) ||
$title->getPrefixedDBKey() != $this->GET
['title'] ) &&
192 !count( array_diff( array_keys( $this->GET
), array( 'action', 'title' ) ) ) )
194 $targetUrl = $title->getFullURL();
195 // Redirect to canonical url, make it a 301 to allow caching
196 if( $targetUrl == $request->getFullRequestURL() ) {
197 $message = "Redirect loop detected!\n\n" .
198 "This means the wiki got confused about what page was " .
199 "requested; this sometimes happens when moving a wiki " .
200 "to a new server or changing the server configuration.\n\n";
202 if( $this->getVal( 'UsePathInfo' ) ) {
203 $message .= "The wiki is trying to interpret the page " .
204 "title from the URL path portion (PATH_INFO), which " .
205 "sometimes fails depending on the web server. Try " .
206 "setting \"\$wgUsePathInfo = false;\" in your " .
207 "LocalSettings.php, or check that \$wgArticlePath " .
210 $message .= "Your web server was detected as possibly not " .
211 "supporting URL path components (PATH_INFO) correctly; " .
212 "check your LocalSettings.php for a customized " .
213 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
216 wfHttpError( 500, "Internal error", $message );
219 $output->setSquidMaxage( 1200 );
220 $output->redirect( $targetUrl, '301' );
222 } else if ( NS_SPECIAL
== $title->getNamespace() ) {
223 /* actions that need to be made when we have a special pages */
224 SpecialPage
::executePath( $title );
226 /* No match to special cases */
227 wfProfileOut( __METHOD__
);
230 /* Did match a special case */
231 wfProfileOut( __METHOD__
);
236 * Create an Article object of the appropriate class for the given page.
238 * @param Title $title
239 * @return Article object
241 static function articleFromTitle( $title ) {
243 wfRunHooks( 'ArticleFromTitle', array( &$title, &$article ) );
248 if( NS_MEDIA
== $title->getNamespace() ) {
249 // FIXME: where should this go?
250 $title = Title
::makeTitle( NS_IMAGE
, $title->getDBkey() );
253 switch( $title->getNamespace() ) {
255 $file = wfFindFile( $title );
256 if( $file && $file->getRedirected() ) {
257 return new Article( $title );
259 return new ImagePage( $title );
261 return new CategoryPage( $title );
263 return new Article( $title );
268 * Initialize the object to be known as $wgArticle for "standard" actions
269 * Create an Article object for the page, following redirects if needed.
271 * @param Title $title
272 * @param Request $request
273 * @param string $action
274 * @return mixed an Article, or a string to redirect to another URL
276 function initializeArticle( &$title, $request ) {
277 wfProfileIn( __METHOD__
);
279 $action = $this->getVal( 'action' );
280 $article = self
::articleFromTitle( $title );
282 // Namespace might change when using redirects
283 if( ( $action == 'view' ||
$action == 'render' ) && !$request->getVal( 'oldid' ) &&
284 $request->getVal( 'redirect' ) != 'no' &&
285 !( $title->getNamespace() == NS_IMAGE
&& wfFindFile( $title->getText() ) ) ) {
287 $dbr = wfGetDB( DB_SLAVE
);
288 $article->loadPageData( $article->pageDataFromTitle( $dbr, $title ) );
290 // Follow redirects only for... redirects
291 if( $article->mIsRedirect
) {
292 $target = $article->followRedirect();
293 if( is_string( $target ) ) {
294 if( !$this->getVal( 'DisableHardRedirects' ) ) {
295 // we'll need to redirect
299 if( is_object( $target ) ) {
300 // Rewrite environment to redirected article
301 $rarticle = self
::articleFromTitle( $target );
302 $rarticle->loadPageData( $rarticle->pageDataFromTitle( $dbr, $target ) );
303 if ( $rarticle->mTitle
->exists() ) {
304 $rarticle->setRedirectedFrom( $title );
305 $article = $rarticle;
310 $title = $article->mTitle
;
313 wfProfileOut( __METHOD__
);
318 * Cleaning up by doing deferred updates, calling LBFactory and doing the output
320 * @param Array $deferredUpdates array of updates to do
321 * @param OutputPage $output
323 function finalCleanup ( &$deferredUpdates, &$output ) {
324 wfProfileIn( __METHOD__
);
325 $this->doUpdates( $deferredUpdates );
327 # Now commit any transactions, so that unreported errors after output() don't roll back the whole thing
328 $factory = wfGetLBFactory();
329 $factory->shutdown();
331 wfProfileOut( __METHOD__
);
335 * Deferred updates aren't really deferred anymore. It's important to report
336 * errors to the user, and that means doing this before OutputPage::output().
337 * Note that for page saves, the client will wait until the script exits
338 * anyway before following the redirect.
340 * @param Array $updates array of objects that hold an update to do
342 function doUpdates( &$updates ) {
343 wfProfileIn( __METHOD__
);
344 /* No need to get master connections in case of empty updates array */
346 wfProfileOut( __METHOD__
);
350 $dbw = wfGetDB( DB_MASTER
);
351 foreach( $updates as $up ) {
354 # Commit after every update to prevent lock contention
355 if ( $dbw->trxLevel() ) {
359 wfProfileOut( __METHOD__
);
363 * Do a job from the job queue
366 $jobRunRate = $this->getVal( 'JobRunRate' );
368 if ( $jobRunRate <= 0 ||
wfReadOnly() ) {
371 if ( $jobRunRate < 1 ) {
372 $max = mt_getrandmax();
373 if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
378 $n = intval( $jobRunRate );
381 while ( $n-- && false != ( $job = Job
::pop() ) ) {
382 $output = $job->toString() . "\n";
384 $success = $job->run();
386 $t = round( $t*1000 );
388 $output .= "Error: " . $job->getLastError() . ", Time: $t ms\n";
390 $output .= "Success, Time: $t ms\n";
392 wfDebugLog( 'jobqueue', $output );
397 * Ends this task peacefully
399 function restInPeace() {
400 wfLogProfilingData();
401 wfDebug( "Request ended normally\n" );
405 * Perform one of the "standard" actions
407 * @param OutputPage $output
408 * @param Article $article
409 * @param Title $title
411 * @param WebRequest $request
413 function performAction( &$output, &$article, &$title, &$user, &$request ) {
414 wfProfileIn( __METHOD__
);
416 if ( !wfRunHooks( 'MediaWikiPerformAction', array( $output, $article, $title, $user, $request ) ) ) {
417 wfProfileOut( __METHOD__
);
421 $action = $this->getVal( 'Action' );
422 if( in_array( $action, $this->getVal( 'DisabledActions', array() ) ) ) {
423 /* No such action; this will switch to the default case */
424 $action = 'nosuchaction';
429 $output->setSquidMaxage( $this->getVal( 'SquidMaxage' ) );
440 case 'markpatrolled':
442 case 'deletetrackback':
450 if( !$this->getVal( 'EnableDublinCoreRdf' ) ) {
451 wfHttpError( 403, 'Forbidden', wfMsg( 'nodublincore' ) );
453 require_once( 'includes/Metadata.php' );
454 wfDublinCoreRdf( $article );
457 case 'creativecommons':
458 if( !$this->getVal( 'EnableCreativeCommonsRdf' ) ) {
459 wfHttpError( 403, 'Forbidden', wfMsg( 'nocreativecommons' ) );
461 require_once( 'includes/Metadata.php' );
462 wfCreativeCommonsRdf( $article );
466 require_once( 'includes/Credits.php' );
467 showCreditsPage( $article );
470 if( session_id() == '' ) {
471 /* Send a cookie so anons get talk message notifications */
477 if( wfRunHooks( 'CustomEditor', array( $article, $user ) ) ) {
478 $internal = $request->getVal( 'internaledit' );
479 $external = $request->getVal( 'externaledit' );
480 $section = $request->getVal( 'section' );
481 $oldid = $request->getVal( 'oldid' );
482 if( !$this->getVal( 'UseExternalEditor' ) ||
$action=='submit' ||
$internal ||
483 $section ||
$oldid ||
( !$user->getOption( 'externaleditor' ) && !$external ) ) {
484 $editor = new EditPage( $article );
486 } elseif( $this->getVal( 'UseExternalEditor' ) && ( $external ||
$user->getOption( 'externaleditor' ) ) ) {
487 $mode = $request->getVal( 'mode' );
488 $extedit = new ExternalEdit( $article, $mode );
494 if( $request->getFullRequestURL() == $title->getInternalURL( 'action=history' ) ) {
495 $output->setSquidMaxage( $this->getVal( 'SquidMaxage' ) );
497 $history = new PageHistory( $article );
501 $raw = new RawPage( $article );
505 if( wfRunHooks( 'UnknownAction', array( $action, $article ) ) ) {
506 $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
509 wfProfileOut( __METHOD__
);
513 }; /* End of class MediaWiki */