includes/Wiki.php

   1 <?php
   2 /**
   3  * Helper class for the index.php entry point.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * The MediaWiki class is the helper class for the index.php entry point.
  25  *
  26  * @internal documentation reviewed 15 Mar 2010
  27  */
  28 class MediaWiki {
  29
  30         /**
  31          * TODO: fold $output, etc, into this
  32          * @var IContextSource
  33          */
  34         private $context;
  35
  36         public function request( WebRequest $x = null ){
  37                 $old = $this->context->getRequest();
  38                 $this->context->setRequest( $x );
  39                 return $old;
  40         }
  41
  42         public function output( OutputPage $x = null ){
  43                 $old = $this->context->getOutput();
  44                 $this->context->setOutput( $x );
  45                 return $old;
  46         }
  47
  48         public function __construct( IContextSource $context = null ) {
  49                 if ( !$context ) {
  50                         $context = RequestContext::getMain();
  51                 }
  52
  53                 $this->context = $context;
  54                 $this->context->setTitle( $this->parseTitle() );
  55         }
  56
  57         /**
  58          * Parse the request to get the Title object
  59          *
  60          * @return Title object to be $wgTitle
  61          */
  62         private function parseTitle() {
  63                 global $wgContLang;
  64
  65                 $request = $this->context->getRequest();
  66                 $curid = $request->getInt( 'curid' );
  67                 $title = $request->getVal( 'title' );
  68
  69                 if ( $request->getCheck( 'search' ) ) {
  70                         // Compatibility with old search URLs which didn't use Special:Search
  71                         // Just check for presence here, so blank requests still
  72                         // show the search page when using ugly URLs (bug 8054).
  73                         $ret = SpecialPage::getTitleFor( 'Search' );
  74                 } elseif ( $curid ) {
  75                         // URLs like this are generated by RC, because rc_title isn't always accurate
  76                         $ret = Title::newFromID( $curid );
  77                 } elseif ( $title == '' && $this->getAction() != 'delete' ) {
  78                         $ret = Title::newMainPage();
  79                 } else {
  80                         $ret = Title::newFromURL( $title );
  81                         // Alias NS_MEDIA page URLs to NS_FILE...we only use NS_MEDIA
  82                         // in wikitext links to tell Parser to make a direct file link
  83                         if ( !is_null( $ret ) && $ret->getNamespace() == NS_MEDIA ) {
  84                                 $ret = Title::makeTitle( NS_FILE, $ret->getDBkey() );
  85                         }
  86                         // Check variant links so that interwiki links don't have to worry
  87                         // about the possible different language variants
  88                         if ( count( $wgContLang->getVariants() ) > 1
  89                                 && !is_null( $ret ) && $ret->getArticleID() == 0 )
  90                         {
  91                                 $wgContLang->findVariantLink( $title, $ret );
  92                         }
  93                 }
  94                 // For non-special titles, check for implicit titles
  95                 if ( is_null( $ret ) || !$ret->isSpecialPage() ) {
  96                         // We can have urls with just ?diff=,?oldid= or even just ?diff=
  97                         $oldid = $request->getInt( 'oldid' );
  98                         $oldid = $oldid ? $oldid : $request->getInt( 'diff' );
  99                         // Allow oldid to override a changed or missing title
 100                         if ( $oldid ) {
 101                                 $rev = Revision::newFromId( $oldid );
 102                                 $ret = $rev ? $rev->getTitle() : $ret;
 103                         }
 104                 }
 105
 106                 if ( $ret === null || ( $ret->getDBkey() == '' && $ret->getInterwiki() == '' ) ) {
 107                         $ret = SpecialPage::getTitleFor( 'Badtitle' );
 108                 }
 109
 110                 return $ret;
 111         }
 112
 113         /**
 114          * Get the Title object that we'll be acting on, as specified in the WebRequest
 115          * @return Title
 116          */
 117         public function getTitle(){
 118                 if( $this->context->getTitle() === null ){
 119                         $this->context->setTitle( $this->parseTitle() );
 120                 }
 121                 return $this->context->getTitle();
 122         }
 123
 124         /**
 125          * Performs the request.
 126          * - bad titles
 127          * - read restriction
 128          * - local interwiki redirects
 129          * - redirect loop
 130          * - special pages
 131          * - normal pages
 132          *
 133          * @return void
 134          */
 135         private function performRequest() {
 136                 global $wgServer, $wgUsePathInfo;
 137
 138                 wfProfileIn( __METHOD__ );
 139
 140                 $request = $this->context->getRequest();
 141                 $title = $this->context->getTitle();
 142                 $output = $this->context->getOutput();
 143                 $user = $this->context->getUser();
 144
 145                 if ( $request->getVal( 'printable' ) === 'yes' ) {
 146                         $output->setPrintable();
 147                 }
 148
 149                 wfRunHooks( 'BeforeInitialize',
 150                         array( &$title, null, &$output, &$user, $request, $this ) );
 151
 152                 // Invalid titles. Bug 21776: The interwikis must redirect even if the page name is empty.
 153                 if ( is_null( $title ) || ( $title->getDBkey() == '' && $title->getInterwiki() == '' ) ||
 154                         $title->isSpecial( 'Badtitle' ) )
 155                 {
 156                         $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
 157                         wfProfileOut( __METHOD__ );
 158                         throw new ErrorPageError( 'badtitle', 'badtitletext' );
 159                 }
 160
 161                 // Check user's permissions to read this page.
 162                 // We have to check here to catch special pages etc.
 163                 // We will check again in Article::view().
 164                 $permErrors = $title->getUserPermissionsErrors( 'read', $user );
 165                 if ( count( $permErrors ) ) {
 166                         wfProfileOut( __METHOD__ );
 167                         throw new PermissionsError( 'read', $permErrors );
 168                 }
 169
 170                 $pageView = false; // was an article or special page viewed?
 171
 172                 // Interwiki redirects
 173                 if ( $title->getInterwiki() != '' ) {
 174                         $rdfrom = $request->getVal( 'rdfrom' );
 175                         if ( $rdfrom ) {
 176                                 $url = $title->getFullURL( 'rdfrom=' . urlencode( $rdfrom ) );
 177                         } else {
 178                                 $query = $request->getValues();
 179                                 unset( $query['title'] );
 180                                 $url = $title->getFullURL( $query );
 181                         }
 182                         // Check for a redirect loop
 183                         if ( !preg_match( '/^' . preg_quote( $wgServer, '/' ) . '/', $url )
 184                                 && $title->isLocal() )
 185                         {
 186                                 // 301 so google et al report the target as the actual url.
 187                                 $output->redirect( $url, 301 );
 188                         } else {
 189                                 $this->context->setTitle( SpecialPage::getTitleFor( 'Badtitle' ) );
 190                                 wfProfileOut( __METHOD__ );
 191                                 throw new ErrorPageError( 'badtitle', 'badtitletext' );
 192                         }
 193                 // Redirect loops, no title in URL, $wgUsePathInfo URLs, and URLs with a variant
 194                 } elseif ( $request->getVal( 'action', 'view' ) == 'view' && !$request->wasPosted()
 195                         && ( $request->getVal( 'title' ) === null ||
 196                                 $title->getPrefixedDBKey() != $request->getVal( 'title' ) )
 197                         && !count( $request->getValueNames( array( 'action', 'title' ) ) )
 198                         && wfRunHooks( 'TestCanonicalRedirect', array( $request, $title, $output ) ) )
 199                 {
 200                         if ( $title->isSpecialPage() ) {
 201                                 list( $name, $subpage ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
 202                                 if ( $name ) {
 203                                         $title = SpecialPage::getTitleFor( $name, $subpage );
 204                                 }
 205                         }
 206                         $targetUrl = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
 207                         // Redirect to canonical url, make it a 301 to allow caching
 208                         if ( $targetUrl == $request->getFullRequestURL() ) {
 209                                 $message = "Redirect loop detected!\n\n" .
 210                                         "This means the wiki got confused about what page was " .
 211                                         "requested; this sometimes happens when moving a wiki " .
 212                                         "to a new server or changing the server configuration.\n\n";
 213
 214                                 if ( $wgUsePathInfo ) {
 215                                         $message .= "The wiki is trying to interpret the page " .
 216                                                 "title from the URL path portion (PATH_INFO), which " .
 217                                                 "sometimes fails depending on the web server. Try " .
 218                                                 "setting \"\$wgUsePathInfo = false;\" in your " .
 219                                                 "LocalSettings.php, or check that \$wgArticlePath " .
 220                                                 "is correct.";
 221                                 } else {
 222                                         $message .= "Your web server was detected as possibly not " .
 223                                                 "supporting URL path components (PATH_INFO) correctly; " .
 224                                                 "check your LocalSettings.php for a customized " .
 225                                                 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
 226                                                 "to true.";
 227                                 }
 228                                 throw new HttpError( 500, $message );
 229                         } else {
 230                                 $output->setSquidMaxage( 1200 );
 231                                 $output->redirect( $targetUrl, '301' );
 232                         }
 233                 // Special pages
 234                 } elseif ( NS_SPECIAL == $title->getNamespace() ) {
 235                         $pageView = true;
 236                         // Actions that need to be made when we have a special pages
 237                         SpecialPageFactory::executePath( $title, $this->context );
 238                 } else {
 239                         // ...otherwise treat it as an article view. The article
 240                         // may be a redirect to another article or URL.
 241                         $article = $this->initializeArticle();
 242                         if ( is_object( $article ) ) {
 243                                 $pageView = true;
 244                                 /**
 245                                  * $wgArticle is deprecated, do not use it. This will possibly be removed
 246                                  * entirely in 1.20 or 1.21
 247                                  * @deprecated since 1.18
 248                                  */
 249                                 global $wgArticle;
 250                                 $wgArticle = $article;
 251
 252                                 $this->performAction( $article );
 253                         } elseif ( is_string( $article ) ) {
 254                                 $output->redirect( $article );
 255                         } else {
 256                                 wfProfileOut( __METHOD__ );
 257                                 throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle() returned neither an object nor a URL" );
 258                         }
 259                 }
 260
 261                 if ( $pageView ) {
 262                         // Promote user to any groups they meet the criteria for
 263                         $user->addAutopromoteOnceGroups( 'onView' );
 264                 }
 265
 266                 wfProfileOut( __METHOD__ );
 267         }
 268
 269         /**
 270          * Create an Article object of the appropriate class for the given page.
 271          *
 272          * @deprecated in 1.18; use Article::newFromTitle() instead
 273          * @param $title Title
 274          * @param $context IContextSource
 275          * @return Article object
 276          */
 277         public static function articleFromTitle( $title, IContextSource $context ) {
 278                 return Article::newFromTitle( $title, $context );
 279         }
 280
 281         /**
 282          * Returns the action that will be executed, not necessarily the one passed
 283          * passed through the "action" parameter. Actions disabled in
 284          * $wgDisabledActions will be replaced by "nosuchaction"
 285          *
 286          * @return String: action
 287          */
 288         public function getAction() {
 289                 global $wgDisabledActions;
 290
 291                 $request = $this->context->getRequest();
 292                 $action = $request->getVal( 'action', 'view' );
 293
 294                 // Check for disabled actions
 295                 if ( in_array( $action, $wgDisabledActions ) ) {
 296                         return 'nosuchaction';
 297                 }
 298
 299                 // Workaround for bug #20966: inability of IE to provide an action dependent
 300                 // on which submit button is clicked.
 301                 if ( $action === 'historysubmit' ) {
 302                         if ( $request->getBool( 'revisiondelete' ) ) {
 303                                 return 'revisiondelete';
 304                         } else {
 305                                 return 'view';
 306                         }
 307                 } elseif ( $action == 'editredlink' ) {
 308                         return 'edit';
 309                 }
 310
 311                 return $action;
 312         }
 313
 314         /**
 315          * Initialize the main Article object for "standard" actions (view, etc)
 316          * Create an Article object for the page, following redirects if needed.
 317          *
 318          * @return mixed an Article, or a string to redirect to another URL
 319          */
 320         private function initializeArticle() {
 321                 global $wgDisableHardRedirects;
 322
 323                 wfProfileIn( __METHOD__ );
 324
 325                 $request = $this->context->getRequest();
 326                 $title = $this->context->getTitle();
 327
 328                 $action = $request->getVal( 'action', 'view' );
 329                 $article = Article::newFromTitle( $title, $this->context );
 330                 // NS_MEDIAWIKI has no redirects.
 331                 // It is also used for CSS/JS, so performance matters here...
 332                 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
 333                         wfProfileOut( __METHOD__ );
 334                         return $article;
 335                 }
 336                 // Namespace might change when using redirects
 337                 // Check for redirects ...
 338                 $file = ( $title->getNamespace() == NS_FILE ) ? $article->getFile() : null;
 339                 if ( ( $action == 'view' || $action == 'render' )       // ... for actions that show content
 340                         && !$request->getVal( 'oldid' ) &&    // ... and are not old revisions
 341                         !$request->getVal( 'diff' ) &&    // ... and not when showing diff
 342                         $request->getVal( 'redirect' ) != 'no' &&       // ... unless explicitly told not to
 343                         // ... and the article is not a non-redirect image page with associated file
 344                         !( is_object( $file ) && $file->exists() && !$file->getRedirected() ) )
 345                 {
 346                         // Give extensions a change to ignore/handle redirects as needed
 347                         $ignoreRedirect = $target = false;
 348
 349                         wfRunHooks( 'InitializeArticleMaybeRedirect',
 350                                 array( &$title, &$request, &$ignoreRedirect, &$target, &$article ) );
 351
 352                         // Follow redirects only for... redirects.
 353                         // If $target is set, then a hook wanted to redirect.
 354                         if ( !$ignoreRedirect && ( $target || $article->isRedirect() ) ) {
 355                                 // Is the target already set by an extension?
 356                                 $target = $target ? $target : $article->followRedirect();
 357                                 if ( is_string( $target ) ) {
 358                                         if ( !$wgDisableHardRedirects ) {
 359                                                 // we'll need to redirect
 360                                                 wfProfileOut( __METHOD__ );
 361                                                 return $target;
 362                                         }
 363                                 }
 364                                 if ( is_object( $target ) ) {
 365                                         // Rewrite environment to redirected article
 366                                         $rarticle = Article::newFromTitle( $target, $this->context );
 367                                         $rarticle->loadPageData();
 368                                         if ( $rarticle->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
 369                                                 $rarticle->setRedirectedFrom( $title );
 370                                                 $article = $rarticle;
 371                                                 $this->context->setTitle( $target );
 372                                         }
 373                                 }
 374                         } else {
 375                                 $this->context->setTitle( $article->getTitle() );
 376                         }
 377                 }
 378
 379                 wfProfileOut( __METHOD__ );
 380                 return $article;
 381         }
 382
 383         /**
 384          * Cleaning up request by doing deferred updates, DB transaction, and the output
 385          */
 386         public function finalCleanup() {
 387                 wfProfileIn( __METHOD__ );
 388                 // Now commit any transactions, so that unreported errors after
 389                 // output() don't roll back the whole DB transaction
 390                 $factory = wfGetLBFactory();
 391                 $factory->commitMasterChanges();
 392                 // Output everything!
 393                 $this->context->getOutput()->output();
 394                 // Do any deferred jobs
 395                 DeferredUpdates::doUpdates( 'commit' );
 396                 $this->doJobs();
 397                 wfProfileOut( __METHOD__ );
 398         }
 399
 400         /**
 401          * Do a job from the job queue
 402          */
 403         private function doJobs() {
 404                 global $wgJobRunRate;
 405
 406                 if ( $wgJobRunRate <= 0 || wfReadOnly() ) {
 407                         return;
 408                 }
 409                 if ( $wgJobRunRate < 1 ) {
 410                         $max = mt_getrandmax();
 411                         if ( mt_rand( 0, $max ) > $max * $wgJobRunRate ) {
 412                                 return;
 413                         }
 414                         $n = 1;
 415                 } else {
 416                         $n = intval( $wgJobRunRate );
 417                 }
 418
 419                 while ( $n-- && false != ( $job = Job::pop() ) ) {
 420                         $output = $job->toString() . "\n";
 421                         $t = -wfTime();
 422                         $success = $job->run();
 423                         $t += wfTime();
 424                         $t = round( $t * 1000 );
 425                         if ( !$success ) {
 426                                 $output .= "Error: " . $job->getLastError() . ", Time: $t ms\n";
 427                         } else {
 428                                 $output .= "Success, Time: $t ms\n";
 429                         }
 430                         wfDebugLog( 'jobqueue', $output );
 431                 }
 432         }
 433
 434         /**
 435          * Ends this task peacefully
 436          */
 437         public function restInPeace() {
 438                 MessageCache::logMessages();
 439                 wfLogProfilingData();
 440                 // Commit and close up!
 441                 $factory = wfGetLBFactory();
 442                 $factory->commitMasterChanges();
 443                 $factory->shutdown();
 444                 wfDebug( "Request ended normally\n" );
 445         }
 446
 447         /**
 448          * Perform one of the "standard" actions
 449          *
 450          * @param $article Article
 451          */
 452         private function performAction( Page $article ) {
 453                 global $wgSquidMaxage;
 454
 455                 wfProfileIn( __METHOD__ );
 456
 457                 $request = $this->context->getRequest();
 458                 $output = $this->context->getOutput();
 459                 $title = $this->context->getTitle();
 460                 $user = $this->context->getUser();
 461
 462                 if ( !wfRunHooks( 'MediaWikiPerformAction',
 463                         array( $output, $article, $title, $user, $request, $this ) ) )
 464                 {
 465                         wfProfileOut( __METHOD__ );
 466                         return;
 467                 }
 468
 469                 $act = $this->getAction();
 470
 471                 $action = Action::factory( $act, $article );
 472                 if ( $action instanceof Action ) {
 473                         $action->show();
 474                         wfProfileOut( __METHOD__ );
 475                         return;
 476                 }
 477
 478                 switch( $act ) {
 479                         case 'view':
 480                                 $output->setSquidMaxage( $wgSquidMaxage );
 481                                 $article->view();
 482                                 break;
 483                         case 'delete':
 484                         case 'protect':
 485                         case 'unprotect':
 486                         case 'render':
 487                                 $article->$act();
 488                                 break;
 489                         case 'submit':
 490                                 if ( session_id() == '' ) {
 491                                         // Send a cookie so anons get talk message notifications
 492                                         wfSetupSession();
 493                                 }
 494                                 // Continue...
 495                         case 'edit':
 496                                 if ( wfRunHooks( 'CustomEditor', array( $article, $user ) ) ) {
 497                                         if ( ExternalEdit::useExternalEngine( $this->context, 'edit' )
 498                                                 && $act == 'edit' && !$request->getVal( 'section' )
 499                                                 && !$request->getVal( 'oldid' ) )
 500                                         {
 501                                                 $extedit = new ExternalEdit( $this->context );
 502                                                 $extedit->execute();
 503                                         } else {
 504                                                 $editor = new EditPage( $article );
 505                                                 $editor->edit();
 506                                         }
 507                                 }
 508                                 break;
 509                         default:
 510                                 if ( wfRunHooks( 'UnknownAction', array( $act, $article ) ) ) {
 511                                         $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
 512                                 }
 513                 }
 514                 wfProfileOut( __METHOD__ );
 515         }
 516
 517         /**
 518          * Run the current MediaWiki instance
 519          * index.php just calls this
 520          */
 521         public function run() {
 522                 try {
 523                         $this->checkMaxLag();
 524                         $this->main();
 525                         $this->restInPeace();
 526                 } catch ( Exception $e ) {
 527                         MWExceptionHandler::handle( $e );
 528                 }
 529         }
 530
 531         /**
 532          * Checks if the request should abort due to a lagged server,
 533          * for given maxlag parameter.
 534          */
 535         private function checkMaxLag() {
 536                 global $wgShowHostnames;
 537
 538                 wfProfileIn( __METHOD__ );
 539                 $maxLag = $this->context->getRequest()->getVal( 'maxlag' );
 540                 if ( !is_null( $maxLag ) ) {
 541                         list( $host, $lag ) = wfGetLB()->getMaxLag();
 542                         if ( $lag > $maxLag ) {
 543                                 $resp = $this->context->getRequest()->response();
 544                                 $resp->header( 'HTTP/1.1 503 Service Unavailable' );
 545                                 $resp->header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) );
 546                                 $resp->header( 'X-Database-Lag: ' . intval( $lag ) );
 547                                 $resp->header( 'Content-Type: text/plain' );
 548                                 if( $wgShowHostnames ) {
 549                                         echo "Waiting for $host: $lag seconds lagged\n";
 550                                 } else {
 551                                         echo "Waiting for a database server: $lag seconds lagged\n";
 552                                 }
 553
 554                                 wfProfileOut( __METHOD__ );
 555
 556                                 exit;
 557                         }
 558                 }
 559                 wfProfileOut( __METHOD__ );
 560                 return true;
 561         }
 562
 563         private function main() {
 564                 global $wgUseFileCache, $wgTitle, $wgUseAjax;
 565
 566                 wfProfileIn( __METHOD__ );
 567
 568                 # Set title from request parameters
 569                 $wgTitle = $this->getTitle();
 570                 $action = $this->getAction();
 571                 $user = $this->context->getUser();
 572
 573                 # Send Ajax requests to the Ajax dispatcher.
 574                 if ( $wgUseAjax && $action == 'ajax' ) {
 575                         $dispatcher = new AjaxDispatcher();
 576                         $dispatcher->performAction();
 577                         wfProfileOut( __METHOD__ );
 578                         return;
 579                 }
 580
 581                 if ( $wgUseFileCache && $wgTitle->getNamespace() >= 0 ) {
 582                         wfProfileIn( 'main-try-filecache' );
 583                         if ( HTMLFileCache::useFileCache( $this->context ) ) {
 584                                 /* Try low-level file cache hit */
 585                                 $cache = HTMLFileCache::newFromTitle( $wgTitle, $action );
 586                                 if ( $cache->isCacheGood( /* Assume up to date */ ) ) {
 587                                         /* Check incoming headers to see if client has this cached */
 588                                         $timestamp = $cache->cacheTimestamp();
 589                                         if ( !$this->context->getOutput()->checkLastModified( $timestamp ) ) {
 590                                                 $cache->loadFromFileCache( $this->context );
 591                                         }
 592                                         # Do any stats increment/watchlist stuff
 593                                         $article = WikiPage::factory( $wgTitle );
 594                                         $article->doViewUpdates( $user );
 595                                         # Tell OutputPage that output is taken care of
 596                                         $this->context->getOutput()->disable();
 597                                         wfProfileOut( 'main-try-filecache' );
 598                                         wfProfileOut( __METHOD__ );
 599                                         return;
 600                                 }
 601                         }
 602                         wfProfileOut( 'main-try-filecache' );
 603                 }
 604
 605                 $this->performRequest();
 606                 $this->finalCleanup();
 607
 608                 wfProfileOut( __METHOD__ );
 609         }
 610 }