3 * MediaWiki is the to-be base class for this whole project
8 var $GET; /* Stores the $_GET variables at time of creation, can be changed */
11 /** Constructor. It just save the $_GET variable */
12 function __construct() {
17 * Stores key/value pairs to circumvent global variables
18 * Note that keys are case-insensitive!
20 function setVal( $key, &$value ) {
21 $key = strtolower( $key );
22 $this->params
[$key] =& $value;
26 * Retrieves key/value pairs to circumvent global variables
27 * Note that keys are case-insensitive!
29 function getVal( $key, $default = '' ) {
30 $key = strtolower( $key );
31 if( isset( $this->params
[$key] ) ) {
32 return $this->params
[$key];
38 * Initialization of ... everything
39 @return Article either the object to become $wgArticle, or NULL
41 function initialize ( &$title, &$output, &$user, $request) {
42 wfProfileIn( 'MediaWiki::initialize' );
43 $this->preliminaryChecks ( $title, $output, $request ) ;
45 if ( !$this->initializeSpecialCases( $title, $output, $request ) ) {
46 $article = $this->initializeArticle( $title, $request );
47 if( is_object( $article ) ) {
48 $this->performAction( $output, $article, $title, $user, $request );
49 } elseif( is_string( $article ) ) {
50 $output->redirect( $article );
52 throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle() returned neither an object nor a URL" );
55 wfProfileOut( 'MediaWiki::initialize' );
59 function checkMaxLag( $maxLag ) {
60 global $wgLoadBalancer;
61 list( $host, $lag ) = $wgLoadBalancer->getMaxLag();
62 if ( $lag > $maxLag ) {
63 header( 'HTTP/1.1 503 Service Unavailable' );
64 header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
65 header( 'X-Database-Lag: ' . intval( $lag ) );
66 header( 'Content-Type: text/plain' );
67 echo "Waiting for $host: $lag seconds lagged\n";
76 * Checks some initial queries
77 * Note that $title here is *not* a Title object, but a string!
79 function checkInitialQueries( $title,$action,&$output,$request, $lang) {
80 if ($request->getVal( 'printable' ) == 'yes') {
81 $output->setPrintable();
87 if ( '' == $title && 'delete' != $action ) {
88 $ret = Title
::newMainPage();
89 } elseif ( $curid = $request->getInt( 'curid' ) ) {
90 # URLs like this are generated by RC, because rc_title isn't always accurate
91 $ret = Title
::newFromID( $curid );
93 $ret = Title
::newFromURL( $title );
94 /* check variant links so that interwiki links don't have to worry about
95 the possible different language variants
97 if( count($lang->getVariants()) > 1 && !is_null($ret) && $ret->getArticleID() == 0 )
98 $lang->findVariantLink( $title, $ret );
101 if ( $oldid = $request->getInt( 'oldid' ) ) {
102 // Allow oldid to override a changed or missing title.
103 $rev = Revision
::newFromId( $oldid );
105 $ret = $rev->getTitle();
112 * Checks for search query and anon-cannot-read case
114 function preliminaryChecks ( &$title, &$output, $request ) {
116 # Debug statement for user levels
119 $search = $request->getText( 'search' );
120 if( !is_null( $search ) && $search !== '' ) {
121 // Compatibility with old search URLs which didn't use Special:Search
122 // Do this above the read whitelist check for security...
123 $title = SpecialPage
::getTitleFor( 'Search' );
125 $this->setVal( 'Search', $search );
127 # If the user is not logged in, the Namespace:title of the article must be in
128 # the Read array in order for the user to see it. (We have to check here to
129 # catch special pages etc. We check again in Article::view())
130 if ( !is_null( $title ) && !$title->userCanRead() ) {
131 $output->loginToUse();
139 * Initialize the object to be known as $wgArticle for special cases
141 function initializeSpecialCases ( &$title, &$output, $request ) {
143 wfProfileIn( 'MediaWiki::initializeSpecialCases' );
145 $search = $this->getVal('Search');
146 $action = $this->getVal('Action');
147 if( !$this->getVal('DisableInternalSearch') && !is_null( $search ) && $search !== '' ) {
148 require_once( 'includes/SpecialSearch.php' );
149 $title = SpecialPage
::getTitleFor( 'Search' );
151 } else if( !$title or $title->getDBkey() == '' ) {
152 $title = SpecialPage
::getTitleFor( 'Badtitle' );
153 # Die now before we mess up $wgArticle and the skin stops working
154 throw new ErrorPageError( 'badtitle', 'badtitletext' );
155 } else if ( $title->getInterwiki() != '' ) {
156 if( $rdfrom = $request->getVal( 'rdfrom' ) ) {
157 $url = $title->getFullURL( 'rdfrom=' . urlencode( $rdfrom ) );
159 $url = $title->getFullURL();
161 /* Check for a redirect loop */
162 if ( !preg_match( '/^' . preg_quote( $this->getVal('Server'), '/' ) . '/', $url ) && $title->isLocal() ) {
163 $output->redirect( $url );
165 $title = SpecialPage
::getTitleFor( 'Badtitle' );
166 throw new ErrorPageError( 'badtitle', 'badtitletext' );
168 } else if ( ( $action == 'view' ) && !$wgRequest->wasPosted() &&
169 (!isset( $this->GET
['title'] ) ||
$title->getPrefixedDBKey() != $this->GET
['title'] ) &&
170 !count( array_diff( array_keys( $this->GET
), array( 'action', 'title' ) ) ) )
172 $targetUrl = $title->getFullURL();
173 // Redirect to canonical url, make it a 301 to allow caching
174 global $wgUsePathInfo;
175 if( $targetUrl == $wgRequest->getFullRequestURL() ) {
176 $message = "Redirect loop detected!\n\n" .
177 "This means the wiki got confused about what page was " .
178 "requested; this sometimes happens when moving a wiki " .
179 "to a new server or changing the server configuration.\n\n";
181 if( $wgUsePathInfo ) {
182 $message .= "The wiki is trying to interpret the page " .
183 "title from the URL path portion (PATH_INFO), which " .
184 "sometimes fails depending on the web server. Try " .
185 "setting \"\$wgUsePathInfo = false;\" in your " .
186 "LocalSettings.php, or check that \$wgArticlePath " .
189 $message .= "Your web server was detected as possibly not " .
190 "supporting URL path components (PATH_INFO) correctly; " .
191 "check your LocalSettings.php for a customized " .
192 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
195 wfHttpError( 500, "Internal error", $message );
198 $output->setSquidMaxage( 1200 );
199 $output->redirect( $targetUrl, '301');
201 } else if ( NS_SPECIAL
== $title->getNamespace() ) {
202 /* actions that need to be made when we have a special pages */
203 SpecialPage
::executePath( $title );
205 /* No match to special cases */
206 wfProfileOut( 'MediaWiki::initializeSpecialCases' );
209 /* Did match a special case */
210 wfProfileOut( 'MediaWiki::initializeSpecialCases' );
215 * Create an Article object of the appropriate class for the given page.
216 * @param Title $title
219 function articleFromTitle( $title ) {
221 wfRunHooks('ArticleFromTitle', array( &$title, &$article ) );
226 if( NS_MEDIA
== $title->getNamespace() ) {
227 // FIXME: where should this go?
228 $title = Title
::makeTitle( NS_IMAGE
, $title->getDBkey() );
231 switch( $title->getNamespace() ) {
233 return new ImagePage( $title );
235 return new CategoryPage( $title );
237 return new Article( $title );
242 * Initialize the object to be known as $wgArticle for "standard" actions
243 * Create an Article object for the page, following redirects if needed.
244 * @param Title $title
245 * @param Request $request
246 * @param string $action
247 * @return mixed an Article, or a string to redirect to another URL
249 function initializeArticle( $title, $request ) {
251 wfProfileIn( 'MediaWiki::initializeArticle' );
253 $action = $this->getVal('Action');
254 $article = $this->articleFromTitle( $title );
256 // Namespace might change when using redirects
257 if( $action == 'view' && !$request->getVal( 'oldid' ) &&
258 $request->getVal( 'redirect' ) != 'no' ) {
260 $dbr = wfGetDB(DB_SLAVE
);
261 $article->loadPageData($article->pageDataFromTitle($dbr, $title));
263 /* Follow redirects only for... redirects */
264 if ($article->mIsRedirect
) {
265 $target = $article->followRedirect();
266 if( is_string( $target ) ) {
267 global $wgDisableHardRedirects;
268 if( !$wgDisableHardRedirects ) {
269 // we'll need to redirect
273 if( is_object( $target ) ) {
274 /* Rewrite environment to redirected article */
275 $rarticle = $this->articleFromTitle($target);
276 $rarticle->loadPageData($rarticle->pageDataFromTitle($dbr,$target));
277 if ($rarticle->mTitle
->mArticleID
) {
278 $article = $rarticle;
280 $article->setRedirectedFrom( $title );
286 $wgTitle = $article->mTitle
;
289 wfProfileOut( 'MediaWiki::initializeArticle' );
294 * Cleaning up by doing deferred updates, calling loadbalancer and doing the output
296 function finalCleanup ( &$deferredUpdates, &$loadBalancer, &$output ) {
297 wfProfileIn( 'MediaWiki::finalCleanup' );
298 $this->doUpdates( $deferredUpdates );
300 $loadBalancer->saveMasterPos();
301 # Now commit any transactions, so that unreported errors after output() don't roll back the whole thing
302 $loadBalancer->commitAll();
304 wfProfileOut( 'MediaWiki::finalCleanup' );
308 * Deferred updates aren't really deferred anymore. It's important to report errors to the
309 * user, and that means doing this before OutputPage::output(). Note that for page saves,
310 * the client will wait until the script exits anyway before following the redirect.
312 function doUpdates ( &$updates ) {
313 wfProfileIn( 'MediaWiki::doUpdates' );
314 $dbw = wfGetDB( DB_MASTER
);
315 foreach( $updates as $up ) {
318 # Commit after every update to prevent lock contention
319 if ( $dbw->trxLevel() ) {
323 wfProfileOut( 'MediaWiki::doUpdates' );
327 * Do a job from the job queue
330 global $wgJobRunRate;
332 if ( $wgJobRunRate <= 0 ||
wfReadOnly() ) {
335 if ( $wgJobRunRate < 1 ) {
336 $max = mt_getrandmax();
337 if ( mt_rand( 0, $max ) > $max * $wgJobRunRate ) {
342 $n = intval( $wgJobRunRate );
345 while ( $n-- && false != ($job = Job
::pop())) {
346 $output = $job->toString() . "\n";
348 $success = $job->run();
350 $t = round( $t*1000 );
352 $output .= "Error: " . $job->getLastError() . ", Time: $t ms\n";
354 $output .= "Success, Time: $t ms\n";
356 wfDebugLog( 'jobqueue', $output );
361 * Ends this task peacefully
363 function restInPeace ( &$loadBalancer ) {
364 wfLogProfilingData();
365 $loadBalancer->closeAll();
366 wfDebug( "Request ended normally\n" );
370 * Perform one of the "standard" actions
372 function performAction( &$output, &$article, &$title, &$user, &$request ) {
374 wfProfileIn( 'MediaWiki::performAction' );
376 $action = $this->getVal('Action');
377 if( in_array( $action, $this->getVal('DisabledActions',array()) ) ) {
378 /* No such action; this will switch to the default case */
379 $action = 'nosuchaction';
384 $output->setSquidMaxage( $this->getVal( 'SquidMaxage' ) );
395 case 'markpatrolled':
397 case 'deletetrackback':
405 if( !$this->getVal( 'EnableDublinCoreRdf' ) ) {
406 wfHttpError( 403, 'Forbidden', wfMsg( 'nodublincore' ) );
408 require_once( 'includes/Metadata.php' );
409 wfDublinCoreRdf( $article );
412 case 'creativecommons':
413 if( !$this->getVal( 'EnableCreativeCommonsRdf' ) ) {
414 wfHttpError( 403, 'Forbidden', wfMsg( 'nocreativecommons' ) );
416 require_once( 'includes/Metadata.php' );
417 wfCreativeCommonsRdf( $article );
421 require_once( 'includes/Credits.php' );
422 showCreditsPage( $article );
425 if( session_id() == '' ) {
426 /* Send a cookie so anons get talk message notifications */
431 if( wfRunHooks( 'CustomEditor', array( $article, $user ) ) ) {
432 $internal = $request->getVal( 'internaledit' );
433 $external = $request->getVal( 'externaledit' );
434 $section = $request->getVal( 'section' );
435 $oldid = $request->getVal( 'oldid' );
436 if( !$this->getVal( 'UseExternalEditor' ) ||
$action=='submit' ||
$internal ||
437 $section ||
$oldid ||
( !$user->getOption( 'externaleditor' ) && !$external ) ) {
438 $editor = new EditPage( $article );
440 } elseif( $this->getVal( 'UseExternalEditor' ) && ( $external ||
$user->getOption( 'externaleditor' ) ) ) {
441 $mode = $request->getVal( 'mode' );
442 $extedit = new ExternalEdit( $article, $mode );
449 if( $wgRequest->getFullRequestURL() == $title->getInternalURL( 'action=history' ) ) {
450 $output->setSquidMaxage( $this->getVal( 'SquidMaxage' ) );
452 $history = new PageHistory( $article );
456 $raw = new RawPage( $article );
460 if( wfRunHooks( 'UnknownAction', array( $action, $article ) ) ) {
461 $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
464 wfProfileOut( 'MediaWiki::performAction' );
468 }; /* End of class MediaWiki */