APIEDIT BRANCH MERGE:
[lhc/web/wiklou.git] / includes / RecentChange.php
index ebd4b33..41af45a 100644 (file)
@@ -1,7 +1,6 @@
 <?php
 /**
  *
- * @package MediaWiki
  */
 
 /**
@@ -24,6 +23,8 @@
  *     rc_ip           IP address of the user in dotted quad notation
  *     rc_new          obsolete, use rc_type==RC_NEW
  *     rc_patrolled    boolean whether or not someone has marked this edit as patrolled
+ *     rc_old_len      integer byte length of the text before the edit
+ *     rc_new_len      the same after the edit
  *
  * mExtra:
  *     prefixedDBkey   prefixed db key, used by external app via msg queue
@@ -37,7 +38,6 @@
  *      numberofWatchingusers
  *
  * @todo document functions and variables
- * @package MediaWiki
  */
 class RecentChange
 {
@@ -47,14 +47,14 @@ class RecentChange
 
        # Factory methods
 
-       /* static */ function newFromRow( $row )
+       public static function newFromRow( $row )
        {
                $rc = new RecentChange;
                $rc->loadFromRow( $row );
                return $rc;
        }
 
-       /* static */ function newFromCurRow( $row, $rc_this_oldid = 0 )
+       public static function newFromCurRow( $row, $rc_this_oldid = 0 )
        {
                $rc = new RecentChange;
                $rc->loadFromCurRow( $row, $rc_this_oldid );
@@ -62,6 +62,49 @@ class RecentChange
                $rc->numberofWatchingusers = false;
                return $rc;
        }
+       
+       /**
+        * Obtain the recent change with a given rc_id value
+        *
+        * @param $rcid rc_id value to retrieve
+        * @return RecentChange
+        */
+       public static function newFromId( $rcid ) {
+               $dbr = wfGetDB( DB_SLAVE );
+               $res = $dbr->select( 'recentchanges', '*', array( 'rc_id' => $rcid ), __METHOD__ );
+               if( $res && $dbr->numRows( $res ) > 0 ) {
+                       $row = $dbr->fetchObject( $res );
+                       $dbr->freeResult( $res );
+                       return self::newFromRow( $row );
+               } else {
+                       return NULL;
+               }
+       }
+       
+       /**
+        * Find the first recent change matching some specific conditions
+        *
+        * @param array $conds Array of conditions
+        * @param mixed $fname Override the method name in profiling/logs
+        * @return RecentChange
+        */
+       public static function newFromConds( $conds, $fname = false ) {
+               if( $fname === false )
+                       $fname = __METHOD__;
+               $dbr = wfGetDB( DB_SLAVE );
+               $res = $dbr->select(
+                       'recentchanges',
+                       '*',
+                       $conds,
+                       $fname
+               );
+               if( $res instanceof ResultWrapper && $res->numRows() > 0 ) {
+                       $row = $res->fetchObject();
+                       $res->free();
+                       return self::newFromRow( $row );
+               }
+               return null;
+       }
 
        # Accessors
 
@@ -95,10 +138,10 @@ class RecentChange
        # Writes the data in this object to the database
        function save()
        {
-               global $wgLocalInterwiki, $wgPutIPinRC, $wgRC2UDPAddress, $wgRC2UDPPort, $wgRC2UDPPrefix, $wgUseRCPatrol;
+               global $wgLocalInterwiki, $wgPutIPinRC, $wgRC2UDPAddress, $wgRC2UDPPort, $wgRC2UDPPrefix;
                $fname = 'RecentChange::save';
 
-               $dbw =& wfGetDB( DB_MASTER );
+               $dbw = wfGetDB( DB_MASTER );
                if ( !is_array($this->mExtra) ) {
                        $this->mExtra = array();
                }
@@ -177,10 +220,10 @@ class RecentChange
                global $wgUseEnotif;
                if( $wgUseEnotif ) {
                        # this would be better as an extension hook
-                       include_once( "UserMailer.php" );
-                       $enotif = new EmailNotification();
+                       global $wgUser;
+                       $enotif = new EmailNotification;
                        $title = Title::makeTitle( $this->mAttribs['rc_namespace'], $this->mAttribs['rc_title'] );
-                       $enotif->notifyOnPageChange( $title,
+                       $enotif->notifyOnPageChange( $wgUser, $title,
                                $this->mAttribs['rc_timestamp'],
                                $this->mAttribs['rc_comment'],
                                $this->mAttribs['rc_minor'],
@@ -191,27 +234,34 @@ class RecentChange
                wfRunHooks( 'RecentChange_save', array( &$this ) );
        }
 
-       # Marks a certain row as patrolled
-       function markPatrolled( $rcid )
-       {
-               $fname = 'RecentChange::markPatrolled';
-
-               $dbw =& wfGetDB( DB_MASTER );
-
-               $dbw->update( 'recentchanges',
-                       array( /* SET */
+       /**
+        * Mark a given change as patrolled
+        *
+        * @param mixed $change RecentChange or corresponding rc_id
+        */
+       public static function markPatrolled( $change ) {
+               $rcid = $change instanceof RecentChange
+                       ? $change->mAttribs['rc_id']
+                       : $change;
+               $dbw = wfGetDB( DB_MASTER );
+               $dbw->update(
+                       'recentchanges',
+                       array(
                                'rc_patrolled' => 1
-                       ), array( /* WHERE */
+                       ),
+                       array(
                                'rc_id' => $rcid
-                       ), $fname
+                       ),
+                       __METHOD__
                );
        }
 
        # Makes an entry in the database corresponding to an edit
-       /*static*/ function notifyEdit( $timestamp, &$title, $minor, &$user, $comment,
+       public static function notifyEdit( $timestamp, &$title, $minor, &$user, $comment,
                $oldId, $lastTimestamp, $bot = "default", $ip = '', $oldSize = 0, $newSize = 0,
                $newId = 0)
        {
+
                if ( $bot === 'default' ) {
                        $bot = $user->isAllowed( 'bot' );
                }
@@ -240,9 +290,11 @@ class RecentChange
                        'rc_bot'        => $bot ? 1 : 0,
                        'rc_moved_to_ns'        => 0,
                        'rc_moved_to_title'     => '',
-                       'rc_ip' => $ip,
-                       'rc_patrolled' => 0,
-                       'rc_new'        => 0 # obsolete
+                       'rc_ip'         => $ip,
+                       'rc_patrolled'  => 0,
+                       'rc_new'        => 0,  # obsolete
+                       'rc_old_len'    => $oldSize,
+                       'rc_new_len'    => $newSize
                );
 
                $rc->mExtra =  array(
@@ -259,10 +311,8 @@ class RecentChange
         * Makes an entry in the database corresponding to page creation
         * Note: the title object must be loaded with the new id using resetArticleID()
         * @todo Document parameters and return
-        * @public
-        * @static
         */
-       public static function notifyNew( $timestamp, &$title, $minor, &$user, $comment, $bot = "default",
+       public static function notifyNew( $timestamp, &$title, $minor, &$user, $comment, $bot = 'default',
          $ip='', $size = 0, $newId = 0 )
        {
                if ( !$ip ) {
@@ -271,7 +321,7 @@ class RecentChange
                                $ip = '';
                        }
                }
-               if ( $bot == 'default' ) {
+               if ( $bot === 'default' ) {
                        $bot = $user->isAllowed( 'bot' );
                }
 
@@ -294,7 +344,9 @@ class RecentChange
                        'rc_moved_to_title' => '',
                        'rc_ip'             => $ip,
                        'rc_patrolled'      => 0,
-                       'rc_new'        => 1 # obsolete
+                       'rc_new'            => 1, # obsolete
+                       'rc_old_len'        => 0,
+                       'rc_new_len'        => $size
                );
 
                $rc->mExtra =  array(
@@ -308,7 +360,7 @@ class RecentChange
        }
 
        # Makes an entry in the database corresponding to a rename
-       /*static*/ function notifyMove( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='', $overRedir = false )
+       public static function notifyMove( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='', $overRedir = false )
        {
                if ( !$ip ) {
                        $ip = wfGetIP();
@@ -336,7 +388,9 @@ class RecentChange
                        'rc_moved_to_title'     => $newTitle->getDBkey(),
                        'rc_ip'         => $ip,
                        'rc_new'        => 0, # obsolete
-                       'rc_patrolled' => 1
+                       'rc_patrolled'  => 1,
+                       'rc_old_len'    => NULL,
+                       'rc_new_len'    => NULL,
                );
 
                $rc->mExtra = array(
@@ -347,17 +401,17 @@ class RecentChange
                $rc->save();
        }
 
-       /* static */ function notifyMoveToNew( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
+       public static function notifyMoveToNew( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
                RecentChange::notifyMove( $timestamp, $oldTitle, $newTitle, $user, $comment, $ip, false );
        }
 
-       /* static */ function notifyMoveOverRedirect( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
+       public static function notifyMoveOverRedirect( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
                RecentChange::notifyMove( $timestamp, $oldTitle, $newTitle, $user, $comment, $ip, true );
        }
 
        # A log entry is different to an edit in that previous revisions are
        # not kept
-       /*static*/ function notifyLog( $timestamp, &$title, &$user, $comment, $ip='',
+       public static function notifyLog( $timestamp, &$title, &$user, $comment, $ip='',
           $type, $action, $target, $logComment, $params )
        {
                if ( !$ip ) {
@@ -386,7 +440,9 @@ class RecentChange
                        'rc_moved_to_title'     => '',
                        'rc_ip' => $ip,
                        'rc_patrolled' => 1,
-                       'rc_new'        => 0 # obsolete
+                       'rc_new'        => 0, # obsolete
+                       'rc_old_len'    => NULL,
+                       'rc_new_len'    => NULL,
                );
                $rc->mExtra =  array(
                        'prefixedDBkey' => $title->getPrefixedDBkey(),
@@ -408,7 +464,7 @@ class RecentChange
                $this->mExtra = array();
        }
 
-       # Makes a pseudo-RC entry from a cur row, for watchlists and things
+       # Makes a pseudo-RC entry from a cur row
        function loadFromCurRow( $row )
        {
                $this->mAttribs = array(
@@ -430,12 +486,23 @@ class RecentChange
                        'rc_ip' => '',
                        'rc_id' => $row->rc_id,
                        'rc_patrolled' => $row->rc_patrolled,
-                       'rc_new' => $row->page_is_new # obsolete
+                       'rc_new' => $row->page_is_new, # obsolete
+                       'rc_old_len' => $row->rc_old_len,
+                       'rc_new_len' => $row->rc_new_len,
                );
 
                $this->mExtra = array();
        }
 
+       /**
+        * Get an attribute value
+        *
+        * @param $name Attribute name
+        * @return mixed
+        */
+       public function getAttribute( $name ) {
+               return isset( $this->mAttribs[$name] ) ? $this->mAttribs[$name] : NULL;
+       }
 
        /**
         * Gets the end part of the diff URL associated with this object
@@ -464,6 +531,8 @@ class RecentChange
        function getIRCLine() {
                global $wgUseRCPatrol;
 
+               // FIXME: Would be good to replace these 2 extract() calls with something more explicit
+               // e.g. list ($rc_type, $rc_id) = array_values ($this->mAttribs); [or something like that]
                extract($this->mAttribs);
                extract($this->mExtra);
 
@@ -522,5 +591,38 @@ class RecentChange
                return $fullString;
        }
 
+       /**
+        * Returns the change size (HTML).
+        * The lengths can be given optionally.
+        */
+       function getCharacterDifference( $old = 0, $new = 0 ) {
+               global $wgRCChangedSizeThreshold, $wgLang;
+
+               if( $old === 0 ) {
+                       $old = $this->mAttribs['rc_old_len'];
+               }
+               if( $new === 0 ) {
+                       $new = $this->mAttribs['rc_new_len'];
+               }
+
+               if( $old === NULL || $new === NULL ) {
+                       return '';
+               }
+
+               $szdiff = $new - $old;
+               $formatedSize = wfMsgExt( 'rc-change-size', array( 'parsemag', 'escape'),
+                       $wgLang->formatNum($szdiff) );
+
+               if( $szdiff < $wgRCChangedSizeThreshold ) {
+                       return '<strong class=\'mw-plusminus-neg\'>(' . $formatedSize . ')</strong>';
+               } elseif( $szdiff === 0 ) {
+                       return '<span class=\'mw-plusminus-null\'>(' . $formatedSize . ')</span>';
+               } elseif( $szdiff > 0 ) {
+                       return '<span class=\'mw-plusminus-pos\'>(+' . $formatedSize . ')</span>';
+               } else {
+                       return '<span class=\'mw-plusminus-neg\'>(' . $formatedSize . ')</span>';
+               }
+       }
 }
-?>
+
+