includes/Wiki.php

   1 <?php
   2 /**
   3  * MediaWiki is the to-be base class for this whole project
   4  *
   5  * @internal documentation reviewed 15 Mar 2010
   6  */
   7 class MediaWiki {
   8
   9         /**
  10          * Array of options which may or may not be used
  11          * FIXME: this seems currently to be a messy halfway-house between globals
  12          *     and a config object.  Pick one and run with it
  13          * @var array
  14          */
  15         private $params = array();
  16
  17         /**
  18          * TODO: fold $output, etc, into this
  19          * @var RequestContext
  20          */
  21         private $context;
  22
  23         /**
  24          * Stores key/value pairs to circumvent global variables
  25          * Note that keys are case-insensitive!
  26          *
  27          * @param $key String: key to store
  28          * @param $value Mixed: value to put for the key
  29          */
  30         public function setVal( $key, &$value ) {
  31                 $key = strtolower( $key );
  32                 $this->params[$key] =& $value;
  33         }
  34
  35         /**
  36          * Retrieves key/value pairs to circumvent global variables
  37          * Note that keys are case-insensitive!
  38          *
  39          * @param $key String: key to get
  40          * @param $default string default value, defaults to empty string
  41          * @return $default Mixed: default value if if the key doesn't exist
  42          */
  43         public function getVal( $key, $default = '' ) {
  44                 $key = strtolower( $key );
  45                 if ( isset( $this->params[$key] ) ) {
  46                         return $this->params[$key];
  47                 }
  48                 return $default;
  49         }
  50
  51         public function request( WebRequest &$x = null ){
  52                 return wfSetVar( $this->context->request, $x );
  53         }
  54
  55         public function output( OutputPage &$x = null ){
  56                 return wfSetVar( $this->context->output, $x );
  57         }
  58
  59         public function __construct( RequestContext $context ){
  60                 $this->context = $context;
  61                 $this->context->setTitle( $this->parseTitle() );
  62         }
  63
  64         /**
  65          * Initialization of ... everything
  66          * Performs the request too
  67          *
  68          * @param $article Article
  69          */
  70         public function performRequestForTitle( &$article ) {
  71                 wfProfileIn( __METHOD__ );
  72
  73                 if ( $this->context->request->getVal( 'printable' ) === 'yes' ) {
  74                         $this->context->output->setPrintable();
  75                 }
  76
  77                 wfRunHooks( 'BeforeInitialize', array(
  78                         &$this->context->title,
  79                         &$article,
  80                         &$this->context->output,
  81                         &$this->context->user,
  82                         $this->context->request,
  83                         $this
  84                 ) );
  85
  86                 // If the user is not logged in, the Namespace:title of the article must be in
  87                 // the Read array in order for the user to see it. (We have to check here to
  88                 // catch special pages etc. We check again in Article::view())
  89                 if ( !is_null( $this->context->title ) && !$this->context->title->userCanRead() ) {
  90                         $this->context->output->loginToUse();
  91                         $this->finalCleanup();
  92                         $this->context->output->disable();
  93                         wfProfileOut( __METHOD__ );
  94                         return false;
  95                 }
  96
  97                 // Call handleSpecialCases() to deal with all special requests...
  98                 if ( !$this->handleSpecialCases() ) {
  99                         // ...otherwise treat it as an article view. The article
 100                         // may be a redirect to another article or URL.
 101                         $new_article = $this->initializeArticle();
 102                         if ( is_object( $new_article ) ) {
 103                                 $article = $new_article;
 104                                 $this->performAction( $article );
 105                         } elseif ( is_string( $new_article ) ) {
 106                                 $this->context->output->redirect( $new_article );
 107                         } else {
 108                                 wfProfileOut( __METHOD__ );
 109                                 throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle() returned neither an object nor a URL" );
 110                         }
 111                 }
 112                 wfProfileOut( __METHOD__ );
 113         }
 114
 115         /**
 116          * Parse $request to get the Title object
 117          *
 118          * @return Title object to be $wgTitle
 119          */
 120         private function parseTitle() {
 121                 global $wgContLang;
 122
 123                 $curid = $this->context->request->getInt( 'curid' );
 124                 $title = $this->context->request->getVal( 'title' );
 125
 126                 if ( $this->context->request->getCheck( 'search' ) ) {
 127                         // Compatibility with old search URLs which didn't use Special:Search
 128                         // Just check for presence here, so blank requests still
 129                         // show the search page when using ugly URLs (bug 8054).
 130                         $ret = SpecialPage::getTitleFor( 'Search' );
 131                 } elseif ( $curid ) {
 132                         // URLs like this are generated by RC, because rc_title isn't always accurate
 133                         $ret = Title::newFromID( $curid );
 134                 } elseif ( $title == '' && $this->getAction() != 'delete' ) {
 135                         $ret = Title::newMainPage();
 136                 } else {
 137                         $ret = Title::newFromURL( $title );
 138                         // check variant links so that interwiki links don't have to worry
 139                         // about the possible different language variants
 140                         if ( count( $wgContLang->getVariants() ) > 1 && !is_null( $ret ) && $ret->getArticleID() == 0 ){
 141                                 $wgContLang->findVariantLink( $title, $ret );
 142                         }
 143                 }
 144                 // For non-special titles, check for implicit titles
 145                 if ( is_null( $ret ) || $ret->getNamespace() != NS_SPECIAL ) {
 146                         // We can have urls with just ?diff=,?oldid= or even just ?diff=
 147                         $oldid = $this->context->request->getInt( 'oldid' );
 148                         $oldid = $oldid ? $oldid : $this->context->request->getInt( 'diff' );
 149                         // Allow oldid to override a changed or missing title
 150                         if ( $oldid ) {
 151                                 $rev = Revision::newFromId( $oldid );
 152                                 $ret = $rev ? $rev->getTitle() : $ret;
 153                         }
 154                 }
 155
 156                 if( $ret === null || ( $ret->getDBkey() == '' && $ret->getInterwiki() == '' ) ){
 157                         $ret = new BadTitle;
 158                 }
 159                 return $ret;
 160         }
 161
 162         /**
 163          * Get the Title object that we'll be acting on, as specified in the WebRequest
 164          * @return Title
 165          */
 166         public function getTitle(){
 167                 if( $this->context->title === null ){
 168                         $this->context->title = $this->parseTitle();
 169                 }
 170                 return $this->context->title;
 171         }
 172
 173         /**
 174          * Initialize some special cases:
 175          * - bad titles
 176          * - local interwiki redirects
 177          * - redirect loop
 178          * - special pages
 179          *
 180          * @return bool true if the request is already executed
 181          */
 182         private function handleSpecialCases() {
 183                 wfProfileIn( __METHOD__ );
 184
 185                 // Invalid titles. Bug 21776: The interwikis must redirect even if the page name is empty.
 186                 if ( $this->context->title instanceof BadTitle ) {
 187                         // Die now before we mess up $wgArticle and the skin stops working
 188                         throw new ErrorPageError( 'badtitle', 'badtitletext' );
 189
 190                 // Interwiki redirects
 191                 } else if ( $this->context->title->getInterwiki() != '' ) {
 192                         $rdfrom = $this->context->request->getVal( 'rdfrom' );
 193                         if ( $rdfrom ) {
 194                                 $url = $this->context->title->getFullURL( 'rdfrom=' . urlencode( $rdfrom ) );
 195                         } else {
 196                                 $query = $this->context->request->getValues();
 197                                 unset( $query['title'] );
 198                                 $url = $this->context->title->getFullURL( $query );
 199                         }
 200                         // Check for a redirect loop
 201                         if ( !preg_match( '/^' . preg_quote( $this->getVal( 'Server' ), '/' ) . '/', $url ) && $this->context->title->isLocal() ) {
 202                                 // 301 so google et al report the target as the actual url.
 203                                 $this->context->output->redirect( $url, 301 );
 204                         } else {
 205                                 $this->context->title = new BadTitle;
 206                                 wfProfileOut( __METHOD__ );
 207                                 throw new ErrorPageError( 'badtitle', 'badtitletext' );
 208                         }
 209                 // Redirect loops, no title in URL, $wgUsePathInfo URLs, and URLs with a variant
 210                 } else if ( $this->context->request->getVal( 'action', 'view' ) == 'view' && !$this->context->request->wasPosted()
 211                         && ( $this->context->request->getVal( 'title' ) === null || $this->context->title->getPrefixedDBKey() != $this->context->request->getVal( 'title' ) )
 212                         && !count( array_diff( array_keys( $this->context->request->getValues() ), array( 'action', 'title' ) ) ) )
 213                 {
 214                         if ( $this->context->title->getNamespace() == NS_SPECIAL ) {
 215                                 list( $name, $subpage ) = SpecialPage::resolveAliasWithSubpage( $this->context->title->getDBkey() );
 216                                 if ( $name ) {
 217                                         $this->context->title = SpecialPage::getTitleFor( $name, $subpage );
 218                                 }
 219                         }
 220                         $targetUrl = $this->context->title->getFullURL();
 221                         // Redirect to canonical url, make it a 301 to allow caching
 222                         if ( $targetUrl == $this->context->request->getFullRequestURL() ) {
 223                                 $message = "Redirect loop detected!\n\n" .
 224                                         "This means the wiki got confused about what page was " .
 225                                         "requested; this sometimes happens when moving a wiki " .
 226                                         "to a new server or changing the server configuration.\n\n";
 227
 228                                 if ( $this->getVal( 'UsePathInfo' ) ) {
 229                                         $message .= "The wiki is trying to interpret the page " .
 230                                                 "title from the URL path portion (PATH_INFO), which " .
 231                                                 "sometimes fails depending on the web server. Try " .
 232                                                 "setting \"\$wgUsePathInfo = false;\" in your " .
 233                                                 "LocalSettings.php, or check that \$wgArticlePath " .
 234                                                 "is correct.";
 235                                 } else {
 236                                         $message .= "Your web server was detected as possibly not " .
 237                                                 "supporting URL path components (PATH_INFO) correctly; " .
 238                                                 "check your LocalSettings.php for a customized " .
 239                                                 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
 240                                                 "to true.";
 241                                 }
 242                                 wfHttpError( 500, "Internal error", $message );
 243                                 wfProfileOut( __METHOD__ );
 244                                 return false;
 245                         } else {
 246                                 $this->context->output->setSquidMaxage( 1200 );
 247                                 $this->context->output->redirect( $targetUrl, '301' );
 248                         }
 249                 // Special pages
 250                 } else if ( NS_SPECIAL == $this->context->title->getNamespace() ) {
 251                         // actions that need to be made when we have a special pages
 252                         SpecialPage::executePath( $this->context->title, $this->context );
 253                 } else {
 254                         // No match to special cases
 255                         wfProfileOut( __METHOD__ );
 256                         return false;
 257                 }
 258                 // Did match a special case
 259                 wfProfileOut( __METHOD__ );
 260                 return true;
 261         }
 262
 263         /**
 264          * Create an Article object of the appropriate class for the given page.
 265          *
 266          * @param $title Title
 267          * @return Article object
 268          */
 269         public static function articleFromTitle( &$title ) {
 270                 if ( NS_MEDIA == $title->getNamespace() ) {
 271                         // FIXME: where should this go?
 272                         $title = Title::makeTitle( NS_FILE, $title->getDBkey() );
 273                 }
 274
 275                 $article = null;
 276                 wfRunHooks( 'ArticleFromTitle', array( &$title, &$article ) );
 277                 if ( $article ) {
 278                         return $article;
 279                 }
 280
 281                 switch( $title->getNamespace() ) {
 282                         case NS_FILE:
 283                                 return new ImagePage( $title );
 284                         case NS_CATEGORY:
 285                                 return new CategoryPage( $title );
 286                         default:
 287                                 return new Article( $title );
 288                 }
 289         }
 290
 291         /**
 292          * Returns the action that will be executed, not necesserly the one passed
 293          * passed through the "action" parameter. Actions disabled in
 294          * $wgDisabledActions will be replaced by "nosuchaction"
 295          *
 296          * @return String: action
 297          */
 298         public function getAction() {
 299                 global $wgDisabledActions;
 300
 301                 $action = $this->context->request->getVal( 'action', 'view' );
 302
 303                 // Check for disabled actions
 304                 if ( in_array( $action, $wgDisabledActions ) ) {
 305                         return 'nosuchaction';
 306                 }
 307
 308                 // Workaround for bug #20966: inability of IE to provide an action dependent
 309                 // on which submit button is clicked.
 310                 if ( $action === 'historysubmit' ) {
 311                         if ( $this->context->request->getBool( 'revisiondelete' ) ) {
 312                                 return 'revisiondelete';
 313                         } elseif ( $this->context->request->getBool( 'revisionmove' ) ) {
 314                                 return 'revisionmove';
 315                         } else {
 316                                 return 'view';
 317                         }
 318                 } elseif ( $action == 'editredlink' ) {
 319                         return 'edit';
 320                 }
 321
 322                 return $action;
 323         }
 324
 325         /**
 326          * Initialize the object to be known as $wgArticle for "standard" actions
 327          * Create an Article object for the page, following redirects if needed.
 328          *
 329          * @return mixed an Article, or a string to redirect to another URL
 330          */
 331         private function initializeArticle() {
 332                 wfProfileIn( __METHOD__ );
 333
 334                 $action = $this->context->request->getVal( 'action', 'view' );
 335                 $article = self::articleFromTitle( $this->context->title );
 336                 // NS_MEDIAWIKI has no redirects.
 337                 // It is also used for CSS/JS, so performance matters here...
 338                 if ( $this->context->title->getNamespace() == NS_MEDIAWIKI ) {
 339                         wfProfileOut( __METHOD__ );
 340                         return $article;
 341                 }
 342                 // Namespace might change when using redirects
 343                 // Check for redirects ...
 344                 $file = ( $this->context->title->getNamespace() == NS_FILE ) ? $article->getFile() : null;
 345                 if ( ( $action == 'view' || $action == 'render' )       // ... for actions that show content
 346                         && !$this->context->request->getVal( 'oldid' ) &&    // ... and are not old revisions
 347                         !$this->context->request->getVal( 'diff' ) &&    // ... and not when showing diff
 348                         $this->context->request->getVal( 'redirect' ) != 'no' &&        // ... unless explicitly told not to
 349                         // ... and the article is not a non-redirect image page with associated file
 350                         !( is_object( $file ) && $file->exists() && !$file->getRedirected() ) )
 351                 {
 352                         // Give extensions a change to ignore/handle redirects as needed
 353                         $ignoreRedirect = $target = false;
 354
 355                         wfRunHooks( 'InitializeArticleMaybeRedirect',
 356                                 array( &$this->context->title, &$this->context->request, &$ignoreRedirect, &$target, &$article ) );
 357
 358                         // Follow redirects only for... redirects.
 359                         // If $target is set, then a hook wanted to redirect.
 360                         if ( !$ignoreRedirect && ( $target || $article->isRedirect() ) ) {
 361                                 // Is the target already set by an extension?
 362                                 $target = $target ? $target : $article->followRedirect();
 363                                 if ( is_string( $target ) ) {
 364                                         if ( !$this->getVal( 'DisableHardRedirects' ) ) {
 365                                                 // we'll need to redirect
 366                                                 wfProfileOut( __METHOD__ );
 367                                                 return $target;
 368                                         }
 369                                 }
 370                                 if ( is_object( $target ) ) {
 371                                         // Rewrite environment to redirected article
 372                                         $rarticle = self::articleFromTitle( $target );
 373                                         $rarticle->loadPageData();
 374                                         if ( $rarticle->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
 375                                                 $rarticle->setRedirectedFrom( $this->context->title );
 376                                                 $article = $rarticle;
 377                                                 $this->context->title = $target;
 378                                         }
 379                                 }
 380                         } else {
 381                                 $this->context->title = $article->getTitle();
 382                         }
 383                 }
 384                 wfProfileOut( __METHOD__ );
 385                 return $article;
 386         }
 387
 388         /**
 389          * Cleaning up request by doing deferred updates, DB transaction, and the output
 390          */
 391         public function finalCleanup() {
 392                 wfProfileIn( __METHOD__ );
 393                 // Now commit any transactions, so that unreported errors after
 394                 // output() don't roll back the whole DB transaction
 395                 $factory = wfGetLBFactory();
 396                 $factory->commitMasterChanges();
 397                 // Output everything!
 398                 $this->context->output->output();
 399                 // Do any deferred jobs
 400                 wfDoUpdates( 'commit' );
 401                 // Close the session so that jobs don't access the current session
 402                 session_write_close();
 403                 $this->doJobs();
 404                 wfProfileOut( __METHOD__ );
 405         }
 406
 407         /**
 408          * Do a job from the job queue
 409          */
 410         private function doJobs() {
 411                 global $wgJobRunRate;
 412
 413                 if ( $wgJobRunRate <= 0 || wfReadOnly() ) {
 414                         return;
 415                 }
 416                 if ( $wgJobRunRate < 1 ) {
 417                         $max = mt_getrandmax();
 418                         if ( mt_rand( 0, $max ) > $max * $wgJobRunRate ) {
 419                                 return;
 420                         }
 421                         $n = 1;
 422                 } else {
 423                         $n = intval( $wgJobRunRate );
 424                 }
 425
 426                 while ( $n-- && false != ( $job = Job::pop() ) ) {
 427                         $output = $job->toString() . "\n";
 428                         $t = -wfTime();
 429                         $success = $job->run();
 430                         $t += wfTime();
 431                         $t = round( $t * 1000 );
 432                         if ( !$success ) {
 433                                 $output .= "Error: " . $job->getLastError() . ", Time: $t ms\n";
 434                         } else {
 435                                 $output .= "Success, Time: $t ms\n";
 436                         }
 437                         wfDebugLog( 'jobqueue', $output );
 438                 }
 439         }
 440
 441         /**
 442          * Ends this task peacefully
 443          */
 444         public function restInPeace() {
 445                 MessageCache::logMessages();
 446                 wfLogProfilingData();
 447                 // Commit and close up!
 448                 $factory = wfGetLBFactory();
 449                 $factory->commitMasterChanges();
 450                 $factory->shutdown();
 451                 wfDebug( "Request ended normally\n" );
 452         }
 453
 454         /**
 455          * Perform one of the "standard" actions
 456          *
 457          * @param $article Article
 458          */
 459         private function performAction( &$article ) {
 460                 wfProfileIn( __METHOD__ );
 461
 462                 if ( !wfRunHooks( 'MediaWikiPerformAction', array(
 463                                 $this->context->output, $article, $this->context->title,
 464                                 $this->context->user, $this->context->request, $this ) ) )
 465                 {
 466                         wfProfileOut( __METHOD__ );
 467                         return;
 468                 }
 469
 470                 $action = $this->getAction();
 471
 472                 switch( $action ) {
 473                         case 'view':
 474                                 $this->context->output->setSquidMaxage( $this->getVal( 'SquidMaxage' ) );
 475                                 $article->view();
 476                                 break;
 477                         case 'raw': // includes JS/CSS
 478                                 wfProfileIn( __METHOD__ . '-raw' );
 479                                 $raw = new RawPage( $article );
 480                                 $raw->view();
 481                                 wfProfileOut( __METHOD__ . '-raw' );
 482                                 break;
 483                         case 'watch':
 484                         case 'unwatch':
 485                         case 'delete':
 486                         case 'revert':
 487                         case 'rollback':
 488                         case 'protect':
 489                         case 'unprotect':
 490                         case 'info':
 491                         case 'markpatrolled':
 492                         case 'render':
 493                         case 'deletetrackback':
 494                         case 'purge':
 495                                 $article->$action();
 496                                 break;
 497                         case 'print':
 498                                 $article->view();
 499                                 break;
 500                         case 'dublincore':
 501                                 if ( !$this->getVal( 'EnableDublinCoreRdf' ) ) {
 502                                         wfHttpError( 403, 'Forbidden', wfMsg( 'nodublincore' ) );
 503                                 } else {
 504                                         $rdf = new DublinCoreRdf( $article );
 505                                         $rdf->show();
 506                                 }
 507                                 break;
 508                         case 'creativecommons':
 509                                 if ( !$this->getVal( 'EnableCreativeCommonsRdf' ) ) {
 510                                         wfHttpError( 403, 'Forbidden', wfMsg( 'nocreativecommons' ) );
 511                                 } else {
 512                                         $rdf = new CreativeCommonsRdf( $article );
 513                                         $rdf->show();
 514                                 }
 515                                 break;
 516                         case 'credits':
 517                                 Credits::showPage( $article );
 518                                 break;
 519                         case 'submit':
 520                                 if ( session_id() == '' ) {
 521                                         // Send a cookie so anons get talk message notifications
 522                                         wfSetupSession();
 523                                 }
 524                                 // Continue...
 525                         case 'edit':
 526                                 if ( wfRunHooks( 'CustomEditor', array( $article, $this->context->user ) ) ) {
 527                                         $internal = $this->context->request->getVal( 'internaledit' );
 528                                         $external = $this->context->request->getVal( 'externaledit' );
 529                                         $section = $this->context->request->getVal( 'section' );
 530                                         $oldid = $this->context->request->getVal( 'oldid' );
 531                                         if ( !$this->getVal( 'UseExternalEditor' ) || $action == 'submit' || $internal ||
 532                                            $section || $oldid || ( !$this->context->user->getOption( 'externaleditor' ) && !$external ) ) {
 533                                                 $editor = new EditPage( $article );
 534                                                 $editor->submit();
 535                                         } elseif ( $this->getVal( 'UseExternalEditor' ) && ( $external || $this->context->user->getOption( 'externaleditor' ) ) ) {
 536                                                 $mode = $this->context->request->getVal( 'mode' );
 537                                                 $extedit = new ExternalEdit( $article, $mode );
 538                                                 $extedit->edit();
 539                                         }
 540                                 }
 541                                 break;
 542                         case 'history':
 543                                 if ( $this->context->request->getFullRequestURL() == $this->context->title->getInternalURL( 'action=history' ) ) {
 544                                         $this->context->output->setSquidMaxage( $this->getVal( 'SquidMaxage' ) );
 545                                 }
 546                                 $history = new HistoryPage( $article );
 547                                 $history->history();
 548                                 break;
 549                         case 'revisiondelete':
 550                                 // For show/hide submission from history page
 551                                 $special = SpecialPage::getPage( 'Revisiondelete' );
 552                                 $special->execute( '' );
 553                                 break;
 554                         case 'revisionmove':
 555                                 // For revision move submission from history page
 556                                 $special = SpecialPage::getPage( 'RevisionMove' );
 557                                 $special->execute( '' );
 558                                 break;
 559                         default:
 560                                 if ( wfRunHooks( 'UnknownAction', array( $action, $article ) ) ) {
 561                                         $this->context->output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
 562                                 }
 563                 }
 564                 wfProfileOut( __METHOD__ );
 565         }
 566 }