Scripts and data used for generating ZhConversion.php
[lhc/web/wiklou.git] / includes / Article.php
index 0c71859..7dc3727 100644 (file)
@@ -1,7 +1,8 @@
 <?php
-# $Id$
 /**
  * File for articles
+ * @version $Id$
+ * @package MediaWiki
  */
 
 /**
@@ -18,6 +19,9 @@ $wgArticleOldContentFields = false;
  * See design.doc for an overview.
  * Note: edit user interface and cache support functions have been
  * moved to separate EditPage and CacheManager classes.
+ *
+ * @version $Id$
+ * @package MediaWiki
  */
 class Article {
        /**#@+
@@ -34,6 +38,7 @@ class Article {
 
        /**
         * Constructor and clear the article
+        * @param mixed &$title
         */
        function Article( &$title ) {
                $this->mTitle =& $title;
@@ -61,7 +66,7 @@ class Article {
          * @static
          * @param integer $row Id of a row
          * @param string $prefix table prefix (default 'old_')
-         * @return string $text the text requested
+         * @return string $text|false the text requested
        */
        function getRevisionText( $row, $prefix = 'old_' ) {
                # Get data
@@ -95,7 +100,7 @@ class Article {
        /**
         * If $wgCompressRevisions is enabled, we will compress datas
         * @static
-        * @param reference to a text
+        * @param mixed $text reference to a text
         * @return string 'gzip' if it get compressed, '' overwise
         */
        function compressRevisionText( &$text ) {
@@ -114,6 +119,8 @@ class Article {
        /**
         * Returns the text associated with a "link" type old table row
         * @static
+        * @param mixed $link
+        * @return string $text|false
         */
        function followLink( $link ) {
                # Split the link into fields and values
@@ -155,6 +162,8 @@ class Article {
 
        /**
         * @static
+        * @param $location
+        * @param $hash
         */
        function fetchFromLocation( $location, $hash ) {
                global $wgLoadBalancer;
@@ -236,7 +245,8 @@ class Article {
         * Note that getContent/loadContent may follow redirects if
         * not told otherwise, and so may cause a change to mTitle.
         *
-        * Return the text of this revision
+        * @param $noredir
+        * @return Return the text of this revision
        */
        function getContent( $noredir ) {
                global $wgRequest;
@@ -291,7 +301,11 @@ class Article {
         * the first section before any such heading (section 0).
         *
         * If a section contains subsections, these are also returned.
-       */
+        *
+        * @param string $text text to look in
+        * @param integer $section section number
+        * @return string text of the requested section
+        */
        function getSection($text,$section) {
 
                # strip NOWIKI etc. to avoid confusion (true-parameter causes HTML
@@ -352,7 +366,7 @@ class Article {
 
        /**
         * Return an array of the columns of the "cur"-table
-       */
+        */
        function &getCurContentFields() {
                global $wgArticleCurContentFields;
                if ( !$wgArticleCurContentFields ) {
@@ -364,7 +378,7 @@ class Article {
 
        /**
         * Return an array of the columns of the "old"-table
-       */
+        */
        function &getOldContentFields() {
                global $wgArticleOldContentFields;
                if ( !$wgArticleOldContentFields ) {
@@ -378,14 +392,15 @@ class Article {
         * Load the revision (including cur_text) into this object
        */
        function loadContent( $noredir = false ) {
-               global $wgOut, $wgMwRedir, $wgRequest;
+               global $wgOut, $wgRequest;
 
+               if ( $this->mContentLoaded ) return;
+               
                $dbr =& $this->getDB();
                # Query variables :P
                $oldid = $wgRequest->getVal( 'oldid' );
                $redirect = $wgRequest->getVal( 'redirect' );
 
-               if ( $this->mContentLoaded ) return;
                $fname = 'Article::loadContent';
 
                # Pre-fill content with error message so that if something
@@ -480,10 +495,10 @@ class Article {
        /**
         * Gets the article text without using so many damn globals
         * Returns false on error
-       */
+        *
+        * @param integer $oldid
+        */
        function getContentWithoutUsingSoManyDamnGlobals( $oldid = 0, $noredir = false ) {
-               global $wgMwRedir;
-
                if ( $this->mContentLoaded ) {
                        return $this->mContent;
                }
@@ -593,8 +608,8 @@ class Article {
                }
        }
 
-       /*
-        * @todo document function
+       /**
+        * Get the view count for this article
         */
        function getCount() {
                if ( -1 == $this->mCounter ) {
@@ -611,15 +626,28 @@ class Article {
         * suitable for including in the article count)?
         */
        function isCountable( $text ) {
-               global $wgUseCommaCount, $wgMwRedir;
+               global $wgUseCommaCount;
 
                if ( 0 != $this->mTitle->getNamespace() ) { return 0; }
-               if ( $wgMwRedir->matchStart( $text ) ) { return 0; }
+               if ( $this->isRedirect( $text ) ) { return 0; }
                $token = ($wgUseCommaCount ? ',' : '[[' );
                if ( false === strstr( $text, $token ) ) { return 0; }
                return 1;
        }
 
+       /** 
+        * Tests if the article text represents a redirect
+        */
+       function isRedirect( $text = false ) {
+               if ( $text === false ) {
+                       $this->loadContent();
+                       $titleObj = Title::newFromRedirect( $this->mText );
+               } else {
+                       $titleObj = Title::newFromRedirect( $text );
+               }
+               return $titleObj !== NULL;
+       }
+
        /**
         * Loads everything from cur except cur_text
         * This isn't necessary for all uses, so it's only done if needed.
@@ -680,7 +708,7 @@ class Article {
                $dbr =& $this->getDB();
                $oldTable = $dbr->tableName( 'old' );
                $userTable = $dbr->tableName( 'user' );
-               $encDBkey = $dbr->strencode( $title->getDBkey() );
+               $encDBkey = $dbr->addQuotes( $title->getDBkey() );
                $ns = $title->getNamespace();
                $user = $this->getUser();
 
@@ -689,7 +717,7 @@ class Article {
                        WHERE old_namespace = $user
                        AND old_title = $encDBkey
                        AND old_user != $user
-                       GROUP BY old_user
+                       GROUP BY old_user, old_user_text, user_real_name
                        ORDER BY timestamp DESC";
 
                if ($limit > 0) { $sql .= ' LIMIT '.$limit; }
@@ -710,7 +738,7 @@ class Article {
         * the given title.
        */
        function view() {
-               global $wgUser, $wgOut, $wgLang, $wgRequest, $wgMwRedir, $wgOnlySysopsCanPatrol;
+               global $wgUser, $wgOut, $wgRequest, $wgOnlySysopsCanPatrol;
                global $wgLinkCache, $IP, $wgEnableParserCache, $wgStylePath, $wgUseRCPatrol;
                $sk = $wgUser->getSkin();
 
@@ -799,7 +827,7 @@ class Article {
                                $wgOut->addHTML( '<pre>'.htmlspecialchars($this->mContent)."\n</pre>" );
                        } else if ( $rt = Title::newFromRedirect( $text ) ) {
                                # Display redirect
-                               $imageUrl = $wgStylePath.'/images/redirect.png';
+                               $imageUrl = $wgStylePath.'/common/images/redirect.png';
                                $targetUrl = $rt->escapeLocalURL();
                                $titleText = htmlspecialchars( $rt->getPrefixedText() );
                                $link = $sk->makeLinkObj( $rt );
@@ -843,7 +871,7 @@ class Article {
         * @private
         */
        function insertNewArticle( $text, $summary, $isminor, $watchthis ) {
-               global $wgOut, $wgUser, $wgMwRedir;
+               global $wgOut, $wgUser;
                global $wgUseSquid, $wgDeferredUpdateList, $wgInternalServer;
 
                $fname = 'Article::insertNewArticle';
@@ -853,7 +881,7 @@ class Article {
                $ns = $this->mTitle->getNamespace();
                $ttl = $this->mTitle->getDBkey();
                $text = $this->preSaveTransform( $text );
-               if ( $wgMwRedir->matchStart( $text ) ) { $redir = 1; }
+               if ( $this->isRedirect( $text ) ) { $redir = 1; }
                else { $redir = 0; }
 
                $now = wfTimestampNow();
@@ -912,11 +940,24 @@ class Article {
 
 
        /**
-        * Side effects: loads last edit
+        * Side effects: loads last edit if $edittime is NULL
         */
-       function getTextOfLastEditWithSectionReplacedOrAdded($section, $text, $summary = '') {
-               $this->loadLastEdit();
-               $oldtext = $this->getContent( true );
+       function getTextOfLastEditWithSectionReplacedOrAdded($section, $text, $summary = '', $edittime = NULL) {
+               $fname = 'Article::getTextOfLastEditWithSectionReplacedOrAdded';
+               if(is_null($edittime)) {
+                       $this->loadLastEdit();
+                       $oldtext = $this->getContent( true );
+               } else {
+                       $dbw =& wfGetDB( DB_MASTER );
+                       $ns = $this->mTitle->getNamespace();
+                       $title = $this->mTitle->getDBkey();
+                       $obj = $dbw->getArray( 'old', 
+                               array( 'old_text','old_flags'), 
+                               array( 'old_namespace' => $ns, 'old_title' => $title, 
+                                       'old_timestamp' => $dbw->timestamp($edittime)),
+                               $fname );
+                       $oldtext = Article::getRevisionText( $obj );
+               }
                if ($section != '') {
                        if($section=='new') {
                                if($summary) $subject="== {$summary} ==\n\n";
@@ -990,7 +1031,11 @@ class Article {
        }
 
        /**
-        * @todo document this function
+        * Change an existing article. Puts the previous version back into the old table, updates RC 
+        * and all necessary caches, mostly via the deferred update array.
+        *
+        * It is possible to call this function from a command-line script, but note that you should 
+        * first set $wgUser, and clean up $wgDeferredUpdates after each edit.
         */
        function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
                global $wgOut, $wgUser;
@@ -1002,9 +1047,15 @@ class Article {
 
                if ( $this->mMinorEdit ) { $me1 = 1; } else { $me1 = 0; }
                if ( $minor && $wgUser->getID() ) { $me2 = 1; } else { $me2 = 0; }
-               if ( preg_match( "/^((" . $wgMwRedir->getBaseRegex() . ')[^\\n]+)/i', $text, $m ) ) {
-                       $redir = 1;
-                       $text = $m[1] . "\n"; # Remove all content but redirect
+               if ( $this->isRedirect( $text ) ) {
+                       # Remove all content but redirect
+                       # This could be done by reconstructing the redirect from a title given by 
+                       # Title::newFromRedirect(), but then we wouldn't know which synonym the user
+                       # wants to see
+                       if ( preg_match( "/^((" . $wgMwRedir->getBaseRegex() . ')[^\\n]+)/i', $text, $m ) ) {
+                               $redir = 1;
+                               $text = $m[1] . "\n";
+                       }
                }
                else { $redir = 0; }
 
@@ -1132,7 +1183,6 @@ class Article {
         */
        function showArticle( $text, $subtitle , $sectionanchor = '' ) {
                global $wgOut, $wgUser, $wgLinkCache;
-               global $wgMwRedir;
 
                $wgLinkCache = new LinkCache();
                # Select for update
@@ -1149,7 +1199,7 @@ class Article {
                # Look up the links in the DB and add them to the link cache
                $wgOut->transformBuffer( RLH_FOR_UPDATE );
 
-               if( $wgMwRedir->matchStart( $text ) )
+               if( $this->isRedirect( $text ) )
                        $r = 'redirect=no';
                else
                        $r = '';
@@ -1218,7 +1268,7 @@ class Article {
         * Add or remove this page to my watchlist based on value of $add
         */
        function watch( $add = true ) {
-               global $wgUser, $wgOut, $wgLang;
+               global $wgUser, $wgOut;
                global $wgDeferredUpdateList;
 
                if ( 0 == $wgUser->getID() ) {
@@ -1547,7 +1597,7 @@ class Article {
         * Perform a deletion and output success or failure messages
         */
        function doDelete( $reason ) {
-               global $wgOut, $wgUser, $wgLang;
+               global $wgOut, $wgUser, $wgContLang;
                $fname = 'Article::doDelete';
                wfDebug( $fname."\n" );
 
@@ -1558,8 +1608,8 @@ class Article {
                        $wgOut->setRobotpolicy( 'noindex,nofollow' );
 
                        $sk = $wgUser->getSkin();
-                       $loglink = $sk->makeKnownLink( $wgLang->getNsText( NS_PROJECT ) .
-                         ':' . wfMsg( 'dellogpage' ), wfMsg( 'deletionlog' ) );
+                       $loglink = $sk->makeKnownLink( $wgContLang->getNsText( NS_PROJECT ) .
+                         ':' . wfMsgForContent( 'dellogpage' ), wfMsg( 'deletionlog' ) );
 
                        $text = wfMsg( 'deletedtext', $deleted, $loglink );
 
@@ -1576,7 +1626,7 @@ class Article {
         * Returns success
         */
        function doDeleteArticle( $reason ) {
-               global $wgUser, $wgLang;
+               global $wgUser;
                global  $wgUseSquid, $wgDeferredUpdateList, $wgInternalServer;
 
                $fname = 'Article::doDeleteArticle';
@@ -1697,7 +1747,7 @@ class Article {
         * Revert a modification
         */
        function rollback() {
-               global $wgUser, $wgLang, $wgOut, $wgRequest;
+               global $wgUser, $wgOut, $wgRequest;
                $fname = 'Article::rollback';
 
                if ( ! $wgUser->isSysop() ) {
@@ -1809,6 +1859,7 @@ class Article {
         * Do standard deferred updates after page edit.
         * Every 1000th edit, prune the recent changes table.
         * @private
+        * @param string $text
         */
        function editUpdates( $text ) {
                global $wgDeferredUpdateList, $wgDBname, $wgMemc;
@@ -1817,7 +1868,7 @@ class Article {
                wfSeedRandom();
                if ( 0 == mt_rand( 0, 999 ) ) {
                        $dbw =& wfGetDB( DB_MASTER );
-                       $cutoff = wfUnix2Timestamp( time() - ( 7 * 86400 ) );
+                       $cutoff = $dbw->timestamp( time() - ( 7 * 86400 ) );
                        $sql = "DELETE FROM recentchanges WHERE rc_timestamp < '{$cutoff}'";
                        $dbw->query( $sql );
                }
@@ -1861,6 +1912,8 @@ class Article {
        /**
         * This function is called right before saving the wikitext,
         * so we can do things like signatures and links-in-context.
+        *
+        * @param string $text
         */
        function preSaveTransform( $text ) {
                global $wgParser, $wgUser;
@@ -1869,9 +1922,11 @@ class Article {
 
        /* Caching functions */
 
-       # checkLastModified returns true if it has taken care of all
-       # output to the client that is necessary for this request.
-       # (that is, it has sent a cached version of the page)
+       /**
+        * checkLastModified returns true if it has taken care of all
+        * output to the client that is necessary for this request.
+        * (that is, it has sent a cached version of the page)
+        */
        function tryFileCache() {
                static $called = false;
                if( $called ) {
@@ -1900,7 +1955,11 @@ class Article {
                        wfDebug( " tryFileCache() - not cacheable\n" );
                }
        }
-
+       
+       /**
+        * Check if the page can be cached
+        * @return bool
+        */
        function isFileCacheable() {
                global $wgUser, $wgUseFileCache, $wgShowIPinHeader, $wgRequest;
                extract( $wgRequest->getValues( 'action', 'oldid', 'diff', 'redirect', 'printable' ) );
@@ -1919,7 +1978,10 @@ class Article {
                        and (!$this->mRedirectedFrom);
        }
 
-       # Loads cur_touched and returns a value indicating if it should be used
+       /**
+        * Loads cur_touched and returns a value indicating if it should be used
+        *
+        */
        function checkTouched() {
                $fname = 'Article::checkTouched';
                $id = $this->getID();
@@ -1934,9 +1996,15 @@ class Article {
                }
        }
 
-       # Edit an article without doing all that other stuff
+       /**
+        * Edit an article without doing all that other stuff
+        *
+        * @param string $text text submitted
+        * @param string $comment comment submitted
+        * @param integer $minor whereas it's a minor modification
+        */
        function quickEdit( $text, $comment = '', $minor = 0 ) {
-               global $wgUser, $wgMwRedir;
+               global $wgUser;
                $fname = 'Article::quickEdit';
                wfProfileIn( $fname );
 
@@ -1974,7 +2042,7 @@ class Article {
                        'cur_user_text' => $wgUser->getName(),
                        'inverse_timestamp' => wfInvertTimestamp( $timestamp ),
                        'cur_comment' => $comment,
-                       'cur_is_redirect' => $wgMwRedir->matchStart( $text ) ? 1 : 0,
+                       'cur_is_redirect' => $this->isRedirect( $text ) ? 1 : 0,
                        'cur_minor_edit' => intval($minor),
                        'cur_touched' => $dbw->timestamp($timestamp),
                );
@@ -1994,7 +2062,13 @@ class Article {
                wfProfileOut( $fname );
        }
 
-       /* static */ function incViewCount( $id ) {
+       /**
+        * Used to increment the view counter
+        *
+        * @static
+        * @param integer $id article id
+        */
+       function incViewCount( $id ) {
                $id = intval( $id );
                global $wgHitcounterUpdateFreq;
 
@@ -2043,7 +2117,7 @@ class Article {
                $dbw->ignoreErrors( $oldignore );
        }
 
-       /**
+       /**#@+
         * The onArticle*() functions are supposed to be a kind of hooks
         * which should be called whenever any of the specified actions
         * are done.
@@ -2054,6 +2128,7 @@ class Article {
         * @static
         * @param $title_obj a title object
         */
+
        function onArticleCreate($title_obj) {
                global $wgUseSquid, $wgDeferredUpdateList;
 
@@ -2073,26 +2148,19 @@ class Article {
                LinkCache::linksccClearBrokenLinksTo( $title_obj->getPrefixedDBkey() );
        }
 
-       /**
-        * @static
-        */
        function onArticleDelete($title_obj) {
                LinkCache::linksccClearLinksTo( $title_obj->getArticleID() );
        }
-
-       /**
-        * @static
-        */
        function onArticleEdit($title_obj) {
                LinkCache::linksccClearPage( $title_obj->getArticleID() );
        }
-
+       /**#@-*/
 
        /**
         * Info about this page
         */
        function info() {
-               global $wgUser, $wgTitle, $wgOut, $wgLang, $wgAllowPageInfo;
+               global $wgUser, $wgTitle, $wgOut, $wgAllowPageInfo;
                $fname = 'Article::info';
 
                if ( !$wgAllowPageInfo ) {