Uh, also I shouldn't introduce syntax errors while fixing regressions.
[lhc/web/wiklou.git] / includes / Wiki.php
index 996a5cf..fa49290 100644 (file)
 /**
  * MediaWiki is the to-be base class for this whole project
  */
-
 class MediaWiki {
 
        var $GET; /* Stores the $_GET variables at time of creation, can be changed */
        var $params = array();
-       
-       /**
-        * Constructor
-        */
-       function MediaWiki () {
+
+       /** Constructor. It just save the $_GET variable */
+       function __construct() {
                $this->GET = $_GET;
        }
-       
+
        /**
         * Stores key/value pairs to circumvent global variables
         * Note that keys are case-insensitive!
+        *
+        * @param $key String: key to store
+        * @param $value Mixed: value to put for the key
         */
        function setVal( $key, &$value ) {
                $key = strtolower( $key );
                $this->params[$key] =& $value;
        }
-       
+
        /**
-        * Retieves key/value pairs to circumvent global variables
+        * Retrieves key/value pairs to circumvent global variables
         * Note that keys are case-insensitive!
+        *
+        * @param $key String: key to get
+        * @param $default Mixed: default value if if the key doesn't exist
         */
-       function getVal( $key, $default = "" ) {
+       function getVal( $key, $default = '' ) {
                $key = strtolower( $key );
                if( isset( $this->params[$key] ) ) {
                        return $this->params[$key];
                }
                return $default;
        }
-       
+
        /**
         * Initialization of ... everything
-        @return Article either the object to become $wgArticle, or NULL
+        * Performs the request too
+        *
+        * @param $title Title ($wgTitle)
+        * @param $article Article
+        * @param $output OutputPage
+        * @param $user User
+        * @param $request WebRequest
         */
-       function initialize ( &$title, &$output, &$user, $request) {
-               wfProfileIn( 'MediaWiki::initialize' );
-               $this->preliminaryChecks ( $title, $output, $request ) ;
-               $article = NULL;
+       function initialize( &$title, &$article, &$output, &$user, $request ) {
+               wfProfileIn( __METHOD__ );
+               $this->preliminaryChecks( $title, $output, $request ) ;
                if ( !$this->initializeSpecialCases( $title, $output, $request ) ) {
-                       $article = $this->initializeArticle( $title, $request );
-                       if( is_object( $article ) ) {
+                       $new_article = $this->initializeArticle( $title, $request );
+                       if( is_object( $new_article ) ) {
+                               $article = $new_article;
                                $this->performAction( $output, $article, $title, $user, $request );
-                       } elseif( is_string( $article ) ) {
-                               $output->redirect( $article );
+                       } elseif( is_string( $new_article ) ) {
+                               $output->redirect( $new_article );
                        } else {
-                               wfDebugDieBacktrace( "Shouldn't happen: MediaWiki::initializeArticle() returned neither an object nor a URL" );
+                               throw new MWException( "Shouldn't happen: MediaWiki::initializeArticle() returned neither an object nor a URL" );
                        }
                }
-               wfProfileOut( 'MediaWiki::initialize' );
-               return $article;
+               wfProfileOut( __METHOD__ );
+       }
+
+       /**
+        * Check if the maximum lag of database slaves is higher that $maxLag, and
+        * if it's the case, output an error message
+        *
+        * @param $maxLag int: maximum lag allowed for the request, as supplied by
+        *                the client
+        * @return bool true if the request can continue
+        */
+       function checkMaxLag( $maxLag ) {
+               list( $host, $lag ) = wfGetLB()->getMaxLag();
+               if ( $lag > $maxLag ) {
+                       wfMaxlagError( $host, $lag, $maxLag );
+                       return false;
+               } else {
+                       return true;
+               }
        }
-       
+
+
        /**
         * Checks some initial queries
         * Note that $title here is *not* a Title object, but a string!
+        *
+        * @param $title String
+        * @param $action String
+        * @return Title object to be $wgTitle
         */
-       function checkInitialQueries( $title,$action,&$output,$request, $lang) {
-               if ($request->getVal( 'printable' ) == 'yes') {
-                       $output->setPrintable();
+       function checkInitialQueries( $title, $action ) {
+               global $wgOut, $wgRequest, $wgContLang;
+               if( $wgRequest->getVal( 'printable' ) == 'yes' ){
+                       $wgOut->setPrintable();
                }
-               
-               $ret = NULL ;
-               
-               
+
+               $ret = NULL;
+
                if ( '' == $title && 'delete' != $action ) {
-                       $ret = Title::newFromText( wfMsgForContent( 'mainpage' ) );
-               } elseif ( $curid = $request->getInt( 'curid' ) ) {
+                       $ret = Title::newMainPage();
+               } elseif ( $curid = $wgRequest->getInt( 'curid' ) ) {
                        # URLs like this are generated by RC, because rc_title isn't always accurate
                        $ret = Title::newFromID( $curid );
                } else {
                        $ret = Title::newFromURL( $title );
-                       /* check variant links so that interwiki links don't have to worry about
-                          the possible different language variants
-                       */
-                       if( count($lang->getVariants()) > 1 && !is_null($ret) && $ret->getArticleID() == 0 )
-                               $lang->findVariantLink( $title, $ret );
-               
+                       // check variant links so that interwiki links don't have to worry
+                       // about the possible different language variants
+                       if( count( $wgContLang->getVariants() ) > 1 && !is_null( $ret ) && $ret->getArticleID() == 0 )
+                               $wgContLang->findVariantLink( $title, $ret );
+
+               }
+               if ( ( $oldid = $wgRequest->getInt( 'oldid' ) )
+                       && ( is_null( $ret ) || $ret->getNamespace() != NS_SPECIAL ) ) {
+                       // Allow oldid to override a changed or missing title.
+                       $rev = Revision::newFromId( $oldid );
+                       if( $rev ) {
+                               $ret = $rev->getTitle();
+                       }
                }
-               return $ret ;
+               return $ret;
        }
-       
+
        /**
         * Checks for search query and anon-cannot-read case
+        *
+        * @param $title Title
+        * @param $output OutputPage
+        * @param $request WebRequest
         */
-       function preliminaryChecks ( &$title, &$output, $request ) {
-       
-               # Debug statement for user levels
-               // print_r($wgUser);
-               
-               $search = $request->getText( 'search' );
-               if( !is_null( $search ) && $search !== '' ) {
+       function preliminaryChecks( &$title, &$output, $request ) {
+
+               if( $request->getCheck( 'search' ) ) {
                        // Compatibility with old search URLs which didn't use Special:Search
+                       // Just check for presence here, so blank requests still
+                       // show the search page when using ugly URLs (bug 8054).
+
                        // Do this above the read whitelist check for security...
-                       $title = Title::makeTitle( NS_SPECIAL, 'Search' );
+                       $title = SpecialPage::getTitleFor( 'Search' );
                }
-               $this->setVal( "Search", $search );
 
                # If the user is not logged in, the Namespace:title of the article must be in
                # the Read array in order for the user to see it. (We have to check here to
@@ -111,25 +151,29 @@ class MediaWiki {
                        $output->output();
                        exit;
                }
-               
+
        }
-       
+
        /**
-        * Initialize the object to be known as $wgArticle for special cases
+        * Initialize some special cases:
+        * - bad titles
+        * - local interwiki redirects
+        * - redirect loop
+        * - special pages
+        *
+        * @param $title Title
+        * @param $output OutputPage
+        * @param $request WebRequest
+        * @return bool true if the request is already executed
         */
-       function initializeSpecialCases ( &$title, &$output, $request ) {
+       function initializeSpecialCases( &$title, &$output, $request ) {
+               wfProfileIn( __METHOD__ );
 
-               wfProfileIn( 'MediaWiki::initializeSpecialCases' );
-               
-               $search = $this->getVal('Search');
-               $action = $this->getVal('Action');
-               if( !$this->getVal('DisableInternalSearch') && !is_null( $search ) && $search !== '' ) {
-                       require_once( 'includes/SpecialSearch.php' );
-                       $title = Title::makeTitle( NS_SPECIAL, 'Search' );
-                       wfSpecialSearch();
-               } else if( !$title or $title->getDBkey() == '' ) {
-                       $title = Title::newFromText( wfMsgForContent( 'badtitle' ) );
-                       $output->errorpage( 'badtitle', 'badtitletext' );
+               $action = $this->getVal( 'Action' );
+               if( !$title || $title->getDBkey() == '' ) {
+                       $title = SpecialPage::getTitleFor( 'Badtitle' );
+                       # Die now before we mess up $wgArticle and the skin stops working
+                       throw new ErrorPageError( 'badtitle', 'badtitletext' );
                } else if ( $title->getInterwiki() != '' ) {
                        if( $rdfrom = $request->getVal( 'rdfrom' ) ) {
                                $url = $title->getFullURL( 'rdfrom=' . urlencode( $rdfrom ) );
@@ -140,136 +184,251 @@ class MediaWiki {
                        if ( !preg_match( '/^' . preg_quote( $this->getVal('Server'), '/' ) . '/', $url ) && $title->isLocal() ) {
                                $output->redirect( $url );
                        } else {
-                               $title = Title::newFromText( wfMsgForContent( 'badtitle' ) );
-                               $output->errorpage( 'badtitle', 'badtitletext' );
+                               $title = SpecialPage::getTitleFor( 'Badtitle' );
+                               throw new ErrorPageError( 'badtitle', 'badtitletext' );
                        }
-               } else if ( ( $action == 'view' ) &&
+               } else if ( ( $action == 'view' ) && !$request->wasPosted() &&
                        (!isset( $this->GET['title'] ) || $title->getPrefixedDBKey() != $this->GET['title'] ) &&
                        !count( array_diff( array_keys( $this->GET ), array( 'action', 'title' ) ) ) )
                {
-                       /* Redirect to canonical url, make it a 301 to allow caching */
-                       $output->setSquidMaxage( 1200 );
-                       $output->redirect( $title->getFullURL(), '301');
+                       $targetUrl = $title->getFullURL();
+                       // Redirect to canonical url, make it a 301 to allow caching
+                       if( $targetUrl == $request->getFullRequestURL() ) {
+                               $message = "Redirect loop detected!\n\n" .
+                                       "This means the wiki got confused about what page was " .
+                                       "requested; this sometimes happens when moving a wiki " .
+                                       "to a new server or changing the server configuration.\n\n";
+
+                               if( $this->getVal( 'UsePathInfo' ) ) {
+                                       $message .= "The wiki is trying to interpret the page " .
+                                               "title from the URL path portion (PATH_INFO), which " .
+                                               "sometimes fails depending on the web server. Try " .
+                                               "setting \"\$wgUsePathInfo = false;\" in your " .
+                                               "LocalSettings.php, or check that \$wgArticlePath " .
+                                               "is correct.";
+                               } else {
+                                       $message .= "Your web server was detected as possibly not " .
+                                               "supporting URL path components (PATH_INFO) correctly; " .
+                                               "check your LocalSettings.php for a customized " .
+                                               "\$wgArticlePath setting and/or toggle \$wgUsePathInfo " .
+                                               "to true.";
+                               }
+                               wfHttpError( 500, "Internal error", $message );
+                               return false;
+                       } else {
+                               $output->setSquidMaxage( 1200 );
+                               $output->redirect( $targetUrl, '301' );
+                       }
                } else if ( NS_SPECIAL == $title->getNamespace() ) {
                        /* actions that need to be made when we have a special pages */
                        SpecialPage::executePath( $title );
                } else {
                        /* No match to special cases */
-                       wfProfileOut( 'MediaWiki::initializeSpecialCases' );
+                       wfProfileOut( __METHOD__ );
                        return false;
                }
                /* Did match a special case */
-               wfProfileOut( 'MediaWiki::initializeSpecialCases' );
+               wfProfileOut( __METHOD__ );
                return true;
        }
 
        /**
         * Create an Article object of the appropriate class for the given page.
-        * @param Title $title
-        * @return Article
+        *
+        * @param $title Title
+        * @return Article object
         */
-       function articleFromTitle( $title ) {
+       static function articleFromTitle( &$title ) {
                if( NS_MEDIA == $title->getNamespace() ) {
                        // FIXME: where should this go?
                        $title = Title::makeTitle( NS_IMAGE, $title->getDBkey() );
                }
-       
+
+               $article = null;
+               wfRunHooks( 'ArticleFromTitle', array( &$title, &$article ) );
+               if( $article ) {
+                       return $article;
+               }
+
                switch( $title->getNamespace() ) {
                case NS_IMAGE:
-                       require_once( 'includes/ImagePage.php' );
                        return new ImagePage( $title );
                case NS_CATEGORY:
-                       require_once( 'includes/CategoryPage.php' );
                        return new CategoryPage( $title );
                default:
                        return new Article( $title );
                }
        }
-       
+
        /**
         * Initialize the object to be known as $wgArticle for "standard" actions
         * Create an Article object for the page, following redirects if needed.
-        * @param Title $title
-        * @param Request $request
-        * @param string $action
+        *
+        * @param $title Title ($wgTitle)
+        * @param $request WebRequest
         * @return mixed an Article, or a string to redirect to another URL
         */
-       function initializeArticle( $title, $request ) {
-               wfProfileIn( 'MediaWiki::initializeArticle' );
+       function initializeArticle( &$title, $request ) {
+               wfProfileIn( __METHOD__ );
+
+               $action = $this->getVal( 'action' );
+               $article = self::articleFromTitle( $title );
                
-               $action = $this->getVal('Action');
-               $article = $this->articleFromTitle( $title );
+               wfDebug("Article: ".$title->getPrefixedText()."\n");
                
                // Namespace might change when using redirects
-               if( $action == 'view' && !$request->getVal( 'oldid' ) && $request->getVal( 'redirect' ) != 'no' ) {
-                       $target = $article->followRedirect();
-                       if( is_string( $target ) ) {
-                               global $wgDisableHardRedirects;
-                               if( !$wgDisableHardRedirects ) {
-                                       // we'll need to redirect
-                                       return $target;
+               // Check for redirects ...
+               $file = $title->getNamespace() == NS_IMAGE ? $article->getFile() : null;
+               if( ( $action == 'view' || $action == 'render' )        // ... for actions that show content
+                                       && !$request->getVal( 'oldid' ) &&    // ... and are not old revisions
+                                       $request->getVal( 'redirect' ) != 'no' &&       // ... unless explicitly told not to
+                                       // ... and the article is not a non-redirect image page with associated file
+                                       !( is_object( $file ) && $file->exists() && !$file->getRedirected() ) ) {
+
+                       # Give extensions a change to ignore/handle redirects as needed
+                       $ignoreRedirect = $target = false;
+                       wfRunHooks( 'InitializeArticleMaybeRedirect', array( &$title, &$request, &$ignoreRedirect, &$target ) );
+
+                       $dbr = wfGetDB( DB_SLAVE );
+                       $article->loadPageData( $article->pageDataFromTitle( $dbr, $title ) );
+
+                       // Follow redirects only for... redirects
+                       if( !$ignoreRedirect && $article->isRedirect() ) {
+                               # Is the target already set by an extension?
+                               $target = $target ? $target : $article->followRedirect();
+                               if( is_string( $target ) ) {
+                                       if( !$this->getVal( 'DisableHardRedirects' ) ) {
+                                               // we'll need to redirect
+                                               return $target;
+                                       }
                                }
-                       }
-                       if( is_object( $target ) ) {
-                               // evil globals hack!
-                               global $wgTitle;
-                               $wgTitle = $target;
                                
-                               $article = $this->articleFromTitle( $target );
-                               $article->setRedirectedFrom( $title );
+                               if( is_object( $target ) ) {
+                                       // Rewrite environment to redirected article
+                                       $rarticle = self::articleFromTitle( $target );
+                                       $rarticle->loadPageData( $rarticle->pageDataFromTitle( $dbr, $target ) );
+                                       if ( $rarticle->exists() || ( is_object( $file ) && !$file->isLocal() ) ) {
+                                               $rarticle->setRedirectedFrom( $title );
+                                               $article = $rarticle;
+                                               $title = $target;
+                                       }
+                               }
+                       } else {
+                               $title = $article->getTitle();
                        }
                }
-               wfProfileOut( 'MediaWiki::initializeArticle' );
+               wfProfileOut( __METHOD__ );
                return $article;
        }
 
        /**
-        * Cleaning up by doing deferred updates, calling loadbalancer and doing the output
+        * Cleaning up by doing deferred updates, calling LBFactory and doing the output
+        *
+        * @param $deferredUpdates array of updates to do
+        * @param $output OutputPage
         */
-       function finalCleanup ( &$deferredUpdates, &$loadBalancer, &$output ) {
-               wfProfileIn( 'MediaWiki::finalCleanup' );
+       function finalCleanup ( &$deferredUpdates, &$output ) {
+               wfProfileIn( __METHOD__ );
                $this->doUpdates( $deferredUpdates );
-               $loadBalancer->saveMasterPos();
+               $this->doJobs();
                # Now commit any transactions, so that unreported errors after output() don't roll back the whole thing
-               $loadBalancer->commitAll();
+               $factory = wfGetLBFactory();
+               $factory->shutdown();
                $output->output();
-               wfProfileOut( 'MediaWiki::finalCleanup' );
+               wfProfileOut( __METHOD__ );
        }
 
        /**
-        * Deferred updates aren't really deferred anymore. It's important to report errors to the
-        * user, and that means doing this before OutputPage::output(). Note that for page saves,
-        * the client will wait until the script exits anyway before following the redirect.
+        * Deferred updates aren't really deferred anymore. It's important to report
+        * errors to the user, and that means doing this before OutputPage::output().
+        * Note that for page saves, the client will wait until the script exits
+        * anyway before following the redirect.
+        *
+        * @param $updates array of objects that hold an update to do
         */
-       function doUpdates ( &$updates ) {
-               wfProfileIn( 'MediaWiki::doUpdates' );
+       function doUpdates( &$updates ) {
+               wfProfileIn( __METHOD__ );
+               /* No need to get master connections in case of empty updates array */
+               if (!$updates) {
+                       wfProfileOut( __METHOD__ );
+                       return;
+               }
+
+               $dbw = wfGetDB( DB_MASTER );
                foreach( $updates as $up ) {
                        $up->doUpdate();
+
+                       # Commit after every update to prevent lock contention
+                       if ( $dbw->trxLevel() ) {
+                               $dbw->commit();
+                       }
                }
-               wfProfileOut( 'MediaWiki::doUpdates' );         
+               wfProfileOut( __METHOD__ );
        }
-       
+
+       /**
+        * Do a job from the job queue
+        */
+       function doJobs() {
+               $jobRunRate = $this->getVal( 'JobRunRate' );
+
+               if ( $jobRunRate <= 0 || wfReadOnly() ) {
+                       return;
+               }
+               if ( $jobRunRate < 1 ) {
+                       $max = mt_getrandmax();
+                       if ( mt_rand( 0, $max ) > $max * $jobRunRate ) {
+                               return;
+                       }
+                       $n = 1;
+               } else {
+                       $n = intval( $jobRunRate );
+               }
+
+               while ( $n-- && false != ( $job = Job::pop() ) ) {
+                       $output = $job->toString() . "\n";
+                       $t = -wfTime();
+                       $success = $job->run();
+                       $t += wfTime();
+                       $t = round( $t*1000 );
+                       if ( !$success ) {
+                               $output .= "Error: " . $job->getLastError() . ", Time: $t ms\n";
+                       } else {
+                               $output .= "Success, Time: $t ms\n";
+                       }
+                       wfDebugLog( 'jobqueue', $output );
+               }
+       }
+
        /**
         * Ends this task peacefully
         */
-       function restInPeace ( &$loadBalancer ) {
-               wfProfileClose();
-               logProfilingData();
-               $loadBalancer->closeAll();
+       function restInPeace() {
+               wfLogProfilingData();
                wfDebug( "Request ended normally\n" );
        }
 
        /**
         * Perform one of the "standard" actions
+        *
+        * @param $output OutputPage
+        * @param $article Article
+        * @param $title Title
+        * @param $user User
+        * @param $request WebRequest
         */
        function performAction( &$output, &$article, &$title, &$user, &$request ) {
+               wfProfileIn( __METHOD__ );
 
-               wfProfileIn( 'MediaWiki::performAction' );
+               if ( !wfRunHooks( 'MediaWikiPerformAction', array( $output, $article, $title, $user, $request, $this ) ) ) {
+                       wfProfileOut( __METHOD__ );
+                       return;
+               }
 
-               $action = $this->getVal('Action');
-               if( in_array( $action, $this->getVal('DisabledActions',array()) ) ) {
+               $action = $this->getVal( 'Action' );
+               if( in_array( $action, $this->getVal( 'DisabledActions', array() ) ) ) {
                        /* No such action; this will switch to the default case */
-                       $action = "nosuchaction"; 
+                       $action = 'nosuchaction';
                }
 
                switch( $action ) {
@@ -286,7 +445,6 @@ class MediaWiki {
                        case 'unprotect':
                        case 'info':
                        case 'markpatrolled':
-                       case 'validate':
                        case 'render':
                        case 'deletetrackback':
                        case 'purge':
@@ -316,51 +474,47 @@ class MediaWiki {
                                showCreditsPage( $article );
                                break;
                        case 'submit':
-                               if( !$this->getVal( 'CommandLineMode' ) && !$request->checkSessionCookie() ) {
+                               if( session_id() == '' ) {
                                        /* Send a cookie so anons get talk message notifications */
-                                       User::SetupSession();
+                                       wfSetupSession();
                                }
                                /* Continue... */
                        case 'edit':
-                               $internal = $request->getVal( 'internaledit' );
-                               $external = $request->getVal( 'externaledit' );
-                               $section = $request->getVal( 'section' );
-                               $oldid = $request->getVal( 'oldid' );
-                               if( !$this->getVal( 'UseExternalEditor' ) || $action=='submit' || $internal ||
-                                  $section || $oldid || ( !$user->getOption( 'externaleditor' ) && !$external ) ) {
-                                       require_once( 'includes/EditPage.php' );
-                                       $editor = new EditPage( $article );
-                                       $editor->submit();
-                               } elseif( $this->getVal( 'UseExternalEditor' ) && ( $external || $user->getOption( 'externaleditor' ) ) ) {
-                                       require_once( 'includes/ExternalEdit.php' );
-                                       $mode = $request->getVal( 'mode' );
-                                       $extedit = new ExternalEdit( $article, $mode );
-                                       $extedit->edit();
+                       case 'editredlink':
+                               if( wfRunHooks( 'CustomEditor', array( $article, $user ) ) ) {
+                                       $internal = $request->getVal( 'internaledit' );
+                                       $external = $request->getVal( 'externaledit' );
+                                       $section = $request->getVal( 'section' );
+                                       $oldid = $request->getVal( 'oldid' );
+                                       if( !$this->getVal( 'UseExternalEditor' ) || $action=='submit' || $internal ||
+                                          $section || $oldid || ( !$user->getOption( 'externaleditor' ) && !$external ) ) {
+                                               $editor = new EditPage( $article );
+                                               $editor->submit();
+                                       } elseif( $this->getVal( 'UseExternalEditor' ) && ( $external || $user->getOption( 'externaleditor' ) ) ) {
+                                               $mode = $request->getVal( 'mode' );
+                                               $extedit = new ExternalEdit( $article, $mode );
+                                               $extedit->edit();
+                                       }
                                }
                                break;
                        case 'history':
-                               if( $_SERVER['REQUEST_URI'] == $title->getInternalURL( 'action=history' ) ) {
+                               if( $request->getFullRequestURL() == $title->getInternalURL( 'action=history' ) ) {
                                        $output->setSquidMaxage( $this->getVal( 'SquidMaxage' ) );
                                }
-                               require_once( 'includes/PageHistory.php' );
                                $history = new PageHistory( $article );
                                $history->history();
                                break;
                        case 'raw':
-                               require_once( 'includes/RawPage.php' );
                                $raw = new RawPage( $article );
                                $raw->view();
                                break;
                        default:
                                if( wfRunHooks( 'UnknownAction', array( $action, $article ) ) ) {
-                                       $output->errorpage( 'nosuchaction', 'nosuchactiontext' );
+                                       $output->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
                                }
-               wfProfileOut( 'MediaWiki::performAction' );
-       }
+               }
+               wfProfileOut( __METHOD__ );
 
-       
        }
 
 }; /* End of class MediaWiki */
-
-?>
\ No newline at end of file