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