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          * Retieves 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                                 wfDebugDieBacktrace( "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 = Title::makeTitle( NS_SPECIAL, '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 = Title::makeTitle( NS_SPECIAL, 'Search' );
 129                         wfSpecialSearch();
 130                 } else if( !$title or $title->getDBkey() == '' ) {
 131                         $title = Title::newFromText( wfMsgForContent( 'badtitle' ) );
 132                         $output->errorpage( 'badtitle', 'badtitletext' );
 133                 } else if ( $title->getInterwiki() != '' ) {
 134                         if( $rdfrom = $request->getVal( 'rdfrom' ) ) {
 135                                 $url = $title->getFullURL( 'rdfrom=' . urlencode( $rdfrom ) );
 136                         } else {
 137                                 $url = $title->getFullURL();
 138                         }
 139                         /* Check for a redirect loop */
 140                         if ( !preg_match( '/^' . preg_quote( $this->getVal('Server'), '/' ) . '/', $url ) && $title->isLocal() ) {
 141                                 $output->redirect( $url );
 142                         } else {
 143                                 $title = Title::newFromText( wfMsgForContent( 'badtitle' ) );
 144                                 $output->errorpage( 'badtitle', 'badtitletext' );
 145                         }
 146                 } else if ( ( $action == 'view' ) &&
 147                         (!isset( $this->GET['title'] ) || $title->getPrefixedDBKey() != $this->GET['title'] ) &&
 148                         !count( array_diff( array_keys( $this->GET ), array( 'action', 'title' ) ) ) )
 149                 {
 150                         /* Redirect to canonical url, make it a 301 to allow caching */
 151                         $output->setSquidMaxage( 1200 );
 152                         $output->redirect( $title->getFullURL(), '301');
 153                 } else if ( NS_SPECIAL == $title->getNamespace() ) {
 154                         /* actions that need to be made when we have a special pages */
 155                         SpecialPage::executePath( $title );
 156                 } else {
 157                         /* No match to special cases */
 158                         wfProfileOut( 'MediaWiki::initializeSpecialCases' );
 159                         return false;
 160                 }
 161                 /* Did match a special case */
 162                 wfProfileOut( 'MediaWiki::initializeSpecialCases' );
 163                 return true;
 164         }
 165
 166         /**
 167          * Create an Article object of the appropriate class for the given page.
 168          * @param Title $title
 169          * @return Article
 170          */
 171         function articleFromTitle( $title ) {
 172                 if( NS_MEDIA == $title->getNamespace() ) {
 173                         // FIXME: where should this go?
 174                         $title = Title::makeTitle( NS_IMAGE, $title->getDBkey() );
 175                 }
 176
 177                 switch( $title->getNamespace() ) {
 178                 case NS_IMAGE:
 179                         require_once( 'includes/ImagePage.php' );
 180                         return new ImagePage( $title );
 181                 case NS_CATEGORY:
 182                         require_once( 'includes/CategoryPage.php' );
 183                         return new CategoryPage( $title );
 184                 default:
 185                         return new Article( $title );
 186                 }
 187         }
 188
 189         /**
 190          * Initialize the object to be known as $wgArticle for "standard" actions
 191          * Create an Article object for the page, following redirects if needed.
 192          * @param Title $title
 193          * @param Request $request
 194          * @param string $action
 195          * @return mixed an Article, or a string to redirect to another URL
 196          */
 197         function initializeArticle( $title, $request ) {
 198                 global $wgTitle;
 199                 wfProfileIn( 'MediaWiki::initializeArticle' );
 200
 201                 $action = $this->getVal('Action');
 202                 $article = $this->articleFromTitle( $title );
 203
 204                 // Namespace might change when using redirects
 205                 if( $action == 'view' && !$request->getVal( 'oldid' ) &&
 206                                                 $request->getVal( 'redirect' ) != 'no' ) {
 207
 208                         $dbr =& wfGetDB(DB_SLAVE);
 209                         $article->loadPageData($article->pageDataFromTitle($dbr, $title));
 210
 211                         /* Follow redirects only for... redirects */
 212                         if ($article->mIsRedirect) {
 213                                 $target = $article->followRedirect();
 214                                 if( is_string( $target ) ) {
 215                                         global $wgDisableHardRedirects;
 216                                         if( !$wgDisableHardRedirects ) {
 217                                                 // we'll need to redirect
 218                                                 return $target;
 219                                         }
 220                                 }
 221                                 if( is_object( $target ) ) {
 222                                         /* Rewrite environment to redirected article */
 223                                         $rarticle = $this->articleFromTitle($target);
 224                                         $rarticle->loadPageData($rarticle->pageDataFromTitle($dbr,$target));
 225                                         if ($rarticle->mTitle->mArticleID) {
 226                                                 $article = $rarticle;
 227                                                 $wgTitle = $target;
 228                                                 $article->setRedirectedFrom( $title );
 229                                         } else {
 230                                                 $wgTitle = $title;
 231                                         }
 232                                 }
 233                         } else {
 234                                 $wgTitle = $article->mTitle;
 235                         }
 236                 }
 237                 wfProfileOut( 'MediaWiki::initializeArticle' );
 238                 return $article;
 239         }
 240
 241         /**
 242          * Cleaning up by doing deferred updates, calling loadbalancer and doing the output
 243          */
 244         function finalCleanup ( &$deferredUpdates, &$loadBalancer, &$output ) {
 245                 wfProfileIn( 'MediaWiki::finalCleanup' );
 246                 $this->doUpdates( $deferredUpdates );
 247                 $this->doJobs();
 248                 $loadBalancer->saveMasterPos();
 249                 # Now commit any transactions, so that unreported errors after output() don't roll back the whole thing
 250                 $loadBalancer->commitAll();
 251                 $output->output();
 252                 wfProfileOut( 'MediaWiki::finalCleanup' );
 253         }
 254
 255         /**
 256          * Deferred updates aren't really deferred anymore. It's important to report errors to the
 257          * user, and that means doing this before OutputPage::output(). Note that for page saves,
 258          * the client will wait until the script exits anyway before following the redirect.
 259          */
 260         function doUpdates ( &$updates ) {
 261                 wfProfileIn( 'MediaWiki::doUpdates' );
 262                 foreach( $updates as $up ) {
 263                         $up->doUpdate();
 264                 }
 265                 wfProfileOut( 'MediaWiki::doUpdates' );
 266         }
 267
 268         /**
 269          * Do a job from the job queue
 270          */
 271         function doJobs() {
 272                 global $wgJobLogFile, $wgJobRunRate;
 273
 274                 if ( $wgJobRunRate <= 0 ) {
 275                         return;
 276                 }
 277                 if ( $wgJobRunRate < 1 ) {
 278                         $max = mt_getrandmax();
 279                         if ( mt_rand( 0, $max ) > $max * $wgJobRunRate ) {
 280                                 return;
 281                         }
 282                         $n = 1;
 283                 } else {
 284                         $n = intval( $wgJobRunRate );
 285                 }
 286
 287                 require_once( 'JobQueue.php' );
 288
 289                 while ( $n-- && false != ($job = Job::pop())) {
 290                         $output = $job->toString() . "\n";
 291                         if ( !$job->run() ) {
 292                                 $output .= "Error: " . $job->getLastError() . "\n";
 293                         }
 294                         if ( $wgJobLogFile ) {
 295                                 error_log( $output, 3, $wgJobLogFile );
 296                         }
 297                 }
 298         }
 299
 300         /**
 301          * Ends this task peacefully
 302          */
 303         function restInPeace ( &$loadBalancer ) {
 304                 wfProfileClose();
 305                 logProfilingData();
 306                 $loadBalancer->closeAll();
 307                 wfDebug( "Request ended normally\n" );
 308         }
 309
 310         /**
 311          * Perform one of the "standard" actions
 312          */
 313         function performAction( &$output, &$article, &$title, &$user, &$request ) {
 314
 315                 wfProfileIn( 'MediaWiki::performAction' );
 316
 317                 $action = $this->getVal('Action');
 318                 if( in_array( $action, $this->getVal('DisabledActions',array()) ) ) {
 319                         /* No such action; this will switch to the default case */
 320                         $action = 'nosuchaction';
 321                 }
 322
 323                 switch( $action ) {
 324                         case 'view':
 325                                 $output->setSquidMaxage( $this->getVal( 'SquidMaxage' ) );
 326                                 $article->view();
 327                                 break;
 328                         case 'watch':
 329                         case 'unwatch':
 330                         case 'delete':
 331                         case 'revert':
 332                         case 'rollback':
 333                         case 'protect':
 334                         case 'unprotect':
 335                         case 'info':
 336                         case 'markpatrolled':
 337                         case 'render':
 338                         case 'deletetrackback':
 339                         case 'purge':
 340                                 $article->$action();
 341                                 break;
 342                         case 'print':
 343                                 $article->view();
 344                                 break;
 345                         case 'dublincore':
 346                                 if( !$this->getVal( 'EnableDublinCoreRdf' ) ) {
 347                                         wfHttpError( 403, 'Forbidden', wfMsg( 'nodublincore' ) );
 348                                 } else {
 349                                         require_once( 'includes/Metadata.php' );
 350                                         wfDublinCoreRdf( $article );
 351                                 }
 352                                 break;
 353                         case 'creativecommons':
 354                                 if( !$this->getVal( 'EnableCreativeCommonsRdf' ) ) {
 355                                         wfHttpError( 403, 'Forbidden', wfMsg( 'nocreativecommons' ) );
 356                                 } else {
 357                                         require_once( 'includes/Metadata.php' );
 358                                         wfCreativeCommonsRdf( $article );
 359                                 }
 360                                 break;
 361                         case 'credits':
 362                                 require_once( 'includes/Credits.php' );
 363                                 showCreditsPage( $article );
 364                                 break;
 365                         case 'submit':
 366                                 if( !$this->getVal( 'CommandLineMode' ) && !$request->checkSessionCookie() ) {
 367                                         /* Send a cookie so anons get talk message notifications */
 368                                         User::SetupSession();
 369                                 }
 370                                 /* Continue... */
 371                         case 'edit':
 372                                 $internal = $request->getVal( 'internaledit' );
 373                                 $external = $request->getVal( 'externaledit' );
 374                                 $section = $request->getVal( 'section' );
 375                                 $oldid = $request->getVal( 'oldid' );
 376                                 if( !$this->getVal( 'UseExternalEditor' ) || $action=='submit' || $internal ||
 377                                    $section || $oldid || ( !$user->getOption( 'externaleditor' ) && !$external ) ) {
 378                                         require_once( 'includes/EditPage.php' );
 379                                         $editor = new EditPage( $article );
 380                                         $editor->submit();
 381                                 } elseif( $this->getVal( 'UseExternalEditor' ) && ( $external || $user->getOption( 'externaleditor' ) ) ) {
 382                                         require_once( 'includes/ExternalEdit.php' );
 383                                         $mode = $request->getVal( 'mode' );
 384                                         $extedit = new ExternalEdit( $article, $mode );
 385                                         $extedit->edit();
 386                                 }
 387                                 break;
 388                         case 'history':
 389                                 if( $_SERVER['REQUEST_URI'] == $title->getInternalURL( 'action=history' ) ) {
 390                                         $output->setSquidMaxage( $this->getVal( 'SquidMaxage' ) );
 391                                 }
 392                                 require_once( 'includes/PageHistory.php' );
 393                                 $history = new PageHistory( $article );
 394                                 $history->history();
 395                                 break;
 396                         case 'raw':
 397                                 require_once( 'includes/RawPage.php' );
 398                                 $raw = new RawPage( $article );
 399                                 $raw->view();
 400                                 break;
 401                         default:
 402                                 if( wfRunHooks( 'UnknownAction', array( $action, $article ) ) ) {
 403                                         $output->errorpage( 'nosuchaction', 'nosuchactiontext' );
 404                                 }
 405                 }
 406                 wfProfileOut( 'MediaWiki::performAction' );
 407
 408
 409         }
 410
 411 }; /* End of class MediaWiki */
 412
 413 ?>