includes/Wiki.php

   1 <?php
   2 /**
   3  * MediaWiki is the to-be base class for this whole project
   4  */
   5
   6 class MediaWiki {
   7
   8         var $GET; /* Stores the $_GET variables at time of creation, can be changed */
   9         var $params = array();
  10
  11         /** Constructor. It just save the $_GET variable */
  12         function __construct() {
  13                 $this->GET = $_GET;
  14         }
  15
  16         /**
  17          * Stores key/value pairs to circumvent global variables
  18          * Note that keys are case-insensitive!
  19          */
  20         function setVal( $key, &$value ) {
  21                 $key = strtolower( $key );
  22                 $this->params[$key] =& $value;
  23         }
  24
  25         /**
  26          * Retrieves key/value pairs to circumvent global variables
  27          * Note that keys are case-insensitive!
  28          */
  29         function getVal( $key, $default = '' ) {
  30                 $key = strtolower( $key );
  31                 if( isset( $this->params[$key] ) ) {
  32                         return $this->params[$key];
  33                 }
  34                 return $default;
  35         }
  36
  37         /**
  38          * Initialization of ... everything
  39          @return Article either the object to become $wgArticle, or NULL
  40          */
  41         function initialize ( &$title, &$output, &$user, $request) {
  42                 wfProfileIn( 'MediaWiki::initialize' );
  43                 $this->preliminaryChecks ( $title, $output, $request ) ;
  44                 $article = NULL;
  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 );
  51                         } else {
  52                                 throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle() returned neither an object nor a URL" );
  53                         }
  54                 }
  55                 wfProfileOut( 'MediaWiki::initialize' );
  56                 return $article;
  57         }
  58
  59         function checkMaxLag( $maxLag ) {
  60                 global $wgLoadBalancer;
  61                 list( $host, $lag ) = $wgLoadBalancer->getMaxLag();
  62                 if ( $lag > $maxLag ) {
  63                         wfMaxlagError( $host, $lag, $maxLag );
  64                         return false;
  65                 } else {
  66                         return true;
  67                 }
  68         }
  69
  70
  71         /**
  72          * Checks some initial queries
  73          * Note that $title here is *not* a Title object, but a string!
  74          */
  75         function checkInitialQueries( $title,$action,&$output,$request, $lang) {
  76                 if ($request->getVal( 'printable' ) == 'yes') {
  77                         $output->setPrintable();
  78                 }
  79
  80                 $ret = NULL ;
  81
  82
  83                 if ( '' == $title && 'delete' != $action ) {
  84                         $ret = Title::newMainPage();
  85                 } elseif ( $curid = $request->getInt( 'curid' ) ) {
  86                         # URLs like this are generated by RC, because rc_title isn't always accurate
  87                         $ret = Title::newFromID( $curid );
  88                 } else {
  89                         $ret = Title::newFromURL( $title );
  90                         /* check variant links so that interwiki links don't have to worry about
  91                            the possible different language variants
  92                         */
  93                         if( count($lang->getVariants()) > 1 && !is_null($ret) && $ret->getArticleID() == 0 )
  94                                 $lang->findVariantLink( $title, $ret );
  95
  96                 }
  97                 if ( ( $oldid = $request->getInt( 'oldid' ) )
  98                         && ( is_null( $ret ) || $ret->getNamespace() != NS_SPECIAL ) ) {
  99                         // Allow oldid to override a changed or missing title.
 100                         $rev = Revision::newFromId( $oldid );
 101                         if( $rev ) {
 102                                 $ret = $rev->getTitle();
 103                         }
 104                 }
 105                 return $ret ;
 106         }
 107
 108         /**
 109          * Checks for search query and anon-cannot-read case
 110          */
 111         function preliminaryChecks ( &$title, &$output, $request ) {
 112
 113                 if( $request->getCheck( 'search' ) ) {
 114                         // Compatibility with old search URLs which didn't use Special:Search
 115                         // Just check for presence here, so blank requests still
 116                         // show the search page when using ugly URLs (bug 8054).
 117
 118                         // Do this above the read whitelist check for security...
 119                         $title = SpecialPage::getTitleFor( 'Search' );
 120                 }
 121
 122                 # If the user is not logged in, the Namespace:title of the article must be in
 123                 # the Read array in order for the user to see it. (We have to check here to
 124                 # catch special pages etc. We check again in Article::view())
 125                 if ( !is_null( $title ) && !$title->userCanRead() ) {
 126                         $output->loginToUse();
 127                         $output->output();
 128                         exit;
 129                 }
 130
 131         }
 132
 133         /**
 134          * Initialize the object to be known as $wgArticle for special cases
 135          */
 136         function initializeSpecialCases ( &$title, &$output, $request ) {
 137                 global $wgRequest;
 138                 wfProfileIn( 'MediaWiki::initializeSpecialCases' );
 139
 140                 $action = $this->getVal('Action');
 141                 if( !$title or $title->getDBkey() == '' ) {
 142                         $title = SpecialPage::getTitleFor( 'Badtitle' );
 143                         # Die now before we mess up $wgArticle and the skin stops working
 144                         throw new ErrorPageError( 'badtitle', 'badtitletext' );
 145                 } else if ( $title->getInterwiki() != '' ) {
 146                         if( $rdfrom = $request->getVal( 'rdfrom' ) ) {
 147                                 $url = $title->getFullURL( 'rdfrom=' . urlencode( $rdfrom ) );
 148                         } else {
 149                                 $url = $title->getFullURL();
 150                         }
 151                         /* Check for a redirect loop */
 152                         if ( !preg_match( '/^' . preg_quote( $this->getVal('Server'), '/' ) . '/', $url ) && $title->isLocal() ) {
 153                                 $output->redirect( $url );
 154                         } else {
 155                                 $title = SpecialPage::getTitleFor( 'Badtitle' );
 156                                 throw new ErrorPageError( 'badtitle', 'badtitletext' );
 157                         }
 158                 } else if ( ( $action == 'view' ) && !$wgRequest->wasPosted() &&
 159                         (!isset( $this->GET['title'] ) || $title->getPrefixedDBKey() != $this->GET['title'] ) &&
 160                         !count( array_diff( array_keys( $this->GET ), array( 'action', 'title' ) ) ) )
 161                 {
 162                         $targetUrl = $title->getFullURL();
 163                         // Redirect to canonical url, make it a 301 to allow caching
 164                         global $wgUsePathInfo;
 165                         if( $targetUrl == $wgRequest->getFullRequestURL() ) {
 166                                 $message = "Redirect loop detected!\n\n" .
 167                                         "This means the wiki got confused about what page was " .
 168                                         "requested; this sometimes happens when moving a wiki " .
 169                                         "to a new server or changing the server configuration.\n\n";
 170
 171                                 if( $wgUsePathInfo ) {
 172                                         $message .= "The wiki is trying to interpret the page " .
 173                                                 "title from the URL path portion (PATH_INFO), which " .
 174                                                 "sometimes fails depending on the web server. Try " .
 175                                                 "setting \"\$wgUsePathInfo = false;\" in your " .
 176                                                 "LocalSettings.php, or check that \$wgArticlePath " .
 177                                                 "is correct.";
 178                                 } else {
 179                                         $message .= "Your web server was detected as possibly not " .
 180                                                 "supporting URL path components (PATH_INFO) correctly; " .
 181                                                 "check your LocalSettings.php for a customized " .
 182                                                 "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
 183                                                 "to true.";
 184                                 }
 185                                 wfHttpError( 500, "Internal error", $message );
 186                                 return false;
 187                         } else {
 188                                 $output->setSquidMaxage( 1200 );
 189                                 $output->redirect( $targetUrl, '301');
 190                         }
 191                 } else if ( NS_SPECIAL == $title->getNamespace() ) {
 192                         /* actions that need to be made when we have a special pages */
 193                         SpecialPage::executePath( $title );
 194                 } else {
 195                         /* No match to special cases */
 196                         wfProfileOut( 'MediaWiki::initializeSpecialCases' );
 197                         return false;
 198                 }
 199                 /* Did match a special case */
 200                 wfProfileOut( 'MediaWiki::initializeSpecialCases' );
 201                 return true;
 202         }
 203
 204         /**
 205          * Create an Article object of the appropriate class for the given page.
 206          * @param Title $title
 207          * @return Article
 208          */
 209         static function articleFromTitle( $title ) {
 210                 $article = null;
 211                 wfRunHooks('ArticleFromTitle', array( &$title, &$article ) );
 212                 if ( $article ) {
 213                         return $article;
 214                 }
 215
 216                 if( NS_MEDIA == $title->getNamespace() ) {
 217                         // FIXME: where should this go?
 218                         $title = Title::makeTitle( NS_IMAGE, $title->getDBkey() );
 219                 }
 220
 221                 switch( $title->getNamespace() ) {
 222                         case NS_IMAGE:
 223                                 $file = RepoGroup::singleton()->findFile( $title->getText() );
 224                                 if( $file && $file->getRedirectedFrom() ) {
 225                                         return new Article( $title );
 226                                 } else {
 227                                         return new ImagePage( $title );
 228                                 }
 229                         case NS_CATEGORY:
 230                                 return new CategoryPage( $title );
 231                         default:
 232                                 return new Article( $title );
 233                 }
 234         }
 235
 236         /**
 237          * Initialize the object to be known as $wgArticle for "standard" actions
 238          * Create an Article object for the page, following redirects if needed.
 239          * @param Title $title
 240          * @param Request $request
 241          * @param string $action
 242          * @return mixed an Article, or a string to redirect to another URL
 243          */
 244         function initializeArticle( $title, $request ) {
 245                 global $wgTitle;
 246                 wfProfileIn( 'MediaWiki::initializeArticle' );
 247
 248                 $action = $this->getVal('Action');
 249                 $article = $this->articleFromTitle( $title );
 250
 251                 // Namespace might change when using redirects
 252                 if( ( $action == 'view' || $action == 'render' ) && !$request->getVal( 'oldid' ) &&
 253                                                 $request->getVal( 'redirect' ) != 'no' ) {
 254
 255                         $dbr = wfGetDB(DB_SLAVE);
 256                         $article->loadPageData($article->pageDataFromTitle($dbr, $title));
 257
 258                         /* Follow redirects only for... redirects */
 259                         if ($article->mIsRedirect) {
 260                                 $target = $article->followRedirect();
 261                                 if( is_string( $target ) ) {
 262                                         global $wgDisableHardRedirects;
 263                                         if( !$wgDisableHardRedirects ) {
 264                                                 // we'll need to redirect
 265                                                 return $target;
 266                                         }
 267                                 }
 268                                 if( is_object( $target ) ) {
 269                                         /* Rewrite environment to redirected article */
 270                                         $rarticle = $this->articleFromTitle($target);
 271                                         $rarticle->loadPageData($rarticle->pageDataFromTitle($dbr,$target));
 272                                         if ($rarticle->mTitle->mArticleID) {
 273                                                 $article = $rarticle;
 274                                                 $wgTitle = $target;
 275                                                 $article->setRedirectedFrom( $title );
 276                                         } else {
 277                                                 $wgTitle = $title;
 278                                         }
 279                                 }
 280                         } else {
 281                                 $wgTitle = $article->mTitle;
 282                         }
 283                 }
 284                 wfProfileOut( 'MediaWiki::initializeArticle' );
 285                 return $article;
 286         }
 287
 288         /**
 289          * Cleaning up by doing deferred updates, calling loadbalancer and doing the output
 290          */
 291         function finalCleanup ( &$deferredUpdates, &$loadBalancer, &$output ) {
 292                 wfProfileIn( 'MediaWiki::finalCleanup' );
 293                 $this->doUpdates( $deferredUpdates );
 294                 $this->doJobs();
 295                 $loadBalancer->saveMasterPos();
 296                 # Now commit any transactions, so that unreported errors after output() don't roll back the whole thing
 297                 $loadBalancer->commitAll();
 298                 $output->output();
 299                 wfProfileOut( 'MediaWiki::finalCleanup' );
 300         }
 301
 302         /**
 303          * Deferred updates aren't really deferred anymore. It's important to report errors to the
 304          * user, and that means doing this before OutputPage::output(). Note that for page saves,
 305          * the client will wait until the script exits anyway before following the redirect.
 306          */
 307         function doUpdates ( &$updates ) {
 308                 wfProfileIn( 'MediaWiki::doUpdates' );
 309                 $dbw = wfGetDB( DB_MASTER );
 310                 foreach( $updates as $up ) {
 311                         $up->doUpdate();
 312
 313                         # Commit after every update to prevent lock contention
 314                         if ( $dbw->trxLevel() ) {
 315                                 $dbw->commit();
 316                         }
 317                 }
 318                 wfProfileOut( 'MediaWiki::doUpdates' );
 319         }
 320
 321         /**
 322          * Do a job from the job queue
 323          */
 324         function doJobs() {
 325                 global $wgJobRunRate;
 326
 327                 if ( $wgJobRunRate <= 0 || wfReadOnly() ) {
 328                         return;
 329                 }
 330                 if ( $wgJobRunRate < 1 ) {
 331                         $max = mt_getrandmax();
 332                         if ( mt_rand( 0, $max ) > $max * $wgJobRunRate ) {
 333                                 return;
 334                         }
 335                         $n = 1;
 336                 } else {
 337                         $n = intval( $wgJobRunRate );
 338                 }
 339
 340                 while ( $n-- && false != ($job = Job::pop())) {
 341                         $output = $job->toString() . "\n";
 342                         $t = -wfTime();
 343                         $success = $job->run();
 344                         $t += wfTime();
 345                         $t = round( $t*1000 );
 346                         if ( !$success ) {
 347                                 $output .= "Error: " . $job->getLastError() . ", Time: $t ms\n";
 348                         } else {
 349                                 $output .= "Success, Time: $t ms\n";
 350                         }
 351                         wfDebugLog( 'jobqueue', $output );
 352                 }
 353         }
 354
 355         /**
 356          * Ends this task peacefully
 357          */
 358         function restInPeace ( &$loadBalancer ) {
 359                 wfLogProfilingData();
 360                 $loadBalancer->closeAll();
 361                 wfDebug( "Request ended normally\n" );
 362         }
 363
 364         /**
 365          * Perform one of the "standard" actions
 366          */
 367         function performAction( &$output, &$article, &$title, &$user, &$request ) {
 368
 369                 wfProfileIn( 'MediaWiki::performAction' );
 370
 371                 if ( !wfRunHooks('MediaWikiPerformAction', array($output, $article, $title, $user, $request)) ) {
 372                         wfProfileOut( 'MediaWiki::performAction' );
 373                         return;
 374                 }
 375
 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';
 380                 }
 381
 382                 switch( $action ) {
 383                         case 'view':
 384                                 $output->setSquidMaxage( $this->getVal( 'SquidMaxage' ) );
 385                                 $article->view();
 386                                 break;
 387                         case 'watch':
 388                         case 'unwatch':
 389                         case 'delete':
 390                         case 'revert':
 391                         case 'rollback':
 392                         case 'protect':
 393                         case 'unprotect':
 394                         case 'info':
 395                         case 'markpatrolled':
 396                         case 'render':
 397                         case 'deletetrackback':
 398                         case 'purge':
 399                                 $article->$action();
 400                                 break;
 401                         case 'print':
 402                                 $article->view();
 403                                 break;
 404                         case 'dublincore':
 405                                 if( !$this->getVal( 'EnableDublinCoreRdf' ) ) {
 406                                         wfHttpError( 403, 'Forbidden', wfMsg( 'nodublincore' ) );
 407                                 } else {
 408                                         require_once( 'includes/Metadata.php' );
 409                                         wfDublinCoreRdf( $article );
 410                                 }
 411                                 break;
 412                         case 'creativecommons':
 413                                 if( !$this->getVal( 'EnableCreativeCommonsRdf' ) ) {
 414                                         wfHttpError( 403, 'Forbidden', wfMsg( 'nocreativecommons' ) );
 415                                 } else {
 416                                         require_once( 'includes/Metadata.php' );
 417                                         wfCreativeCommonsRdf( $article );
 418                                 }
 419                                 break;
 420                         case 'credits':
 421                                 require_once( 'includes/Credits.php' );
 422                                 showCreditsPage( $article );
 423                                 break;
 424                         case 'submit':
 425                                 if( session_id() == '' ) {
 426                                         /* Send a cookie so anons get talk message notifications */
 427                                         wfSetupSession();
 428                                 }
 429                                 /* Continue... */
 430                         case 'edit':
 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 );
 439                                                 $editor->submit();
 440                                         } elseif( $this->getVal( 'UseExternalEditor' ) && ( $external || $user->getOption( 'externaleditor' ) ) ) {
 441                                                 $mode = $request->getVal( 'mode' );
 442                                                 $extedit = new ExternalEdit( $article, $mode );
 443                                                 $extedit->edit();
 444                                         }
 445                                 }
 446                                 break;
 447                         case 'history':
 448                                 global $wgRequest;
 449                                 if( $wgRequest->getFullRequestURL() == $title->getInternalURL( 'action=history' ) ) {
 450                                         $output->setSquidMaxage( $this->getVal( 'SquidMaxage' ) );
 451                                 }
 452                                 $history = new PageHistory( $article );
 453                                 $history->history();
 454                                 break;
 455                         case 'raw':
 456                                 $raw = new RawPage( $article );
 457                                 $raw->view();
 458                                 break;
 459                         default:
 460                                 if( wfRunHooks( 'UnknownAction', array( $action, $article ) ) ) {
 461                                         $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
 462                                 }
 463                 }
 464                 wfProfileOut( 'MediaWiki::performAction' );
 465
 466         }
 467
 468 }; /* End of class MediaWiki */
 469
 470