Refactor RC2UDP code some
[lhc/web/wiklou.git] / includes / RecentChange.php
index d1cda39..b1c70d8 100644 (file)
@@ -1,8 +1,4 @@
 <?php
-/**
- *
- * @package MediaWiki
- */
 
 /**
  * Utility class for creating new RC entries
  *     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
+  *    rc_deleted              partial deletion
+ *     rc_logid                the log_id value for this log entry (or zero)
+ *  rc_log_type                the log type (or null)
+ *     rc_log_action   the log action (or null)
+ *  rc_params          log params
  *
  * mExtra:
  *     prefixedDBkey   prefixed db key, used by external app via msg queue
@@ -37,7 +40,6 @@
  *      numberofWatchingusers
  *
  * @todo document functions and variables
- * @package MediaWiki
  */
 class RecentChange
 {
@@ -47,22 +49,65 @@ class RecentChange
 
        # Factory methods
 
-       /* static */ function newFromRow( $row )
+       public static function newFromRow( $row )
        {
                $rc = new RecentChange;
                $rc->loadFromRow( $row );
                return $rc;
        }
 
-       public static function newFromCurRow( $row, $rc_this_oldid = 0 )
+       public static function newFromCurRow( $row )
        {
                $rc = new RecentChange;
-               $rc->loadFromCurRow( $row, $rc_this_oldid );
+               $rc->loadFromCurRow( $row );
                $rc->notificationtimestamp = false;
                $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
 
        function setAttribs( $attribs )
@@ -95,10 +140,10 @@ class RecentChange
        # Writes the data in this object to the database
        function save()
        {
-               global $wgLocalInterwiki, $wgPutIPinRC, $wgRC2UDPAddress, $wgRC2UDPPort, $wgRC2UDPPrefix;
+               global $wgLocalInterwiki, $wgPutIPinRC, $wgRC2UDPAddress, $wgRC2UDPOmitBots;
                $fname = 'RecentChange::save';
 
-               $dbw =& wfGetDB( DB_MASTER );
+               $dbw = wfGetDB( DB_MASTER );
                if ( !is_array($this->mExtra) ) {
                        $this->mExtra = array();
                }
@@ -108,7 +153,7 @@ class RecentChange
                        $this->mAttribs['rc_ip'] = '';
                }
 
-               ## If our database is strict about IP addresses, use NULL instead of an empty string
+               # If our database is strict about IP addresses, use NULL instead of an empty string
                if ( $dbw->strictIPs() and $this->mAttribs['rc_ip'] == '' ) {
                        unset( $this->mAttribs['rc_ip'] );
                }
@@ -164,23 +209,26 @@ class RecentChange
                }
 
                # Notify external application via UDP
-               if ( $wgRC2UDPAddress ) {
-                       $conn = socket_create( AF_INET, SOCK_DGRAM, SOL_UDP );
-                       if ( $conn ) {
-                               $line = $wgRC2UDPPrefix . $this->getIRCLine();
-                               socket_sendto( $conn, $line, strlen($line), 0, $wgRC2UDPAddress, $wgRC2UDPPort );
-                               socket_close( $conn );
-                       }
+               if ( $wgRC2UDPAddress && ( !$this->mAttribs['rc_bot'] || !$wgRC2UDPOmitBots ) ) {
+                       wfRecentChange2UDP( $this->getIRCLine() );
                }
 
                # E-mail notifications
-               global $wgUseEnotif;
-               if( $wgUseEnotif ) {
-                       # this would be better as an extension hook
-                       include_once( "UserMailer.php" );
+               global $wgUseEnotif, $wgShowUpdatedMarker, $wgUser;
+               if( $wgUseEnotif || $wgShowUpdatedMarker ) {
+                       // Users
+                       if( $this->mAttribs['rc_user'] ) {
+                               $editor = ($wgUser->getId() == $this->mAttribs['rc_user']) ? 
+                                       $wgUser : User::newFromID( $this->mAttribs['rc_user'] );
+                       // Anons
+                       } else {
+                               $editor = ($wgUser->getName() == $this->mAttribs['rc_user_text']) ? 
+                                       $wgUser : User::newFromName( $this->mAttribs['rc_user_text'], false );
+                       }
+                       # FIXME: this would be better as an extension hook
                        $enotif = new EmailNotification();
                        $title = Title::makeTitle( $this->mAttribs['rc_namespace'], $this->mAttribs['rc_title'] );
-                       $enotif->notifyOnPageChange( $title,
+                       $enotif->notifyOnPageChange( $editor, $title,
                                $this->mAttribs['rc_timestamp'],
                                $this->mAttribs['rc_comment'],
                                $this->mAttribs['rc_minor'],
@@ -191,31 +239,92 @@ class RecentChange
                wfRunHooks( 'RecentChange_save', array( &$this ) );
        }
 
-       # Marks a certain row as patrolled
-       function markPatrolled( $rcid )
-       {
-               $fname = 'RecentChange::markPatrolled';
+       /**
+        * Mark a given change as patrolled
+        *
+        * @param mixed $change RecentChange or corresponding rc_id
+        * @param bool $auto for automatic patrol
+        * @return See doMarkPatrolled(), or null if $change is not an existing rc_id
+        */
+       public static function markPatrolled( $change, $auto = false ) {
+               $change = $change instanceof RecentChange
+                       ? $change
+                       : RecentChange::newFromId($change);
+               if( !$change instanceof RecentChange ) {
+                       return null;
+               }
+               return $change->doMarkPatrolled( $auto );
+       }
+       
+       /**
+        * Mark this RecentChange as patrolled
+        *
+        * NOTE: Can also return 'rcpatroldisabled', 'hookaborted' and 'markedaspatrollederror-noautopatrol' as errors
+        * @param bool $auto for automatic patrol
+        * @return array of permissions errors, see Title::getUserPermissionsErrors()
+        */
+       public function doMarkPatrolled( $auto = false ) {
+               global $wgUser, $wgUseRCPatrol, $wgUseNPPatrol;
+               $errors = array();
+               // If recentchanges patrol is disabled, only new pages
+               // can be patrolled
+               if ( !$wgUseRCPatrol 
+                       && ( !$wgUseNPPatrol || $this->getAttribute( 'rc_type' ) != RC_NEW ) ) 
+               {
+                       $errors[] = array('rcpatroldisabled');
+               }
+
+               // Automatic patrol needs "autopatrol", ordinary patrol needs "patrol"
+               $right = $auto ? 'autopatrol' : 'patrol';
+               $errors = array_merge( $errors, $this->getTitle()->getUserPermissionsErrors( $right, $wgUser ) );
+               if( !wfRunHooks('MarkPatrolled', array($this->getAttribute('rc_id'), &$wgUser, false)) )
+                       $errors[] = array('hookaborted');
+
+               // Users without the 'autopatrol' right can't patrol their
+               // own revisions
+               if( $wgUser->getName() == $this->getAttribute('rc_user_text') && !$wgUser->isAllowed('autopatrol') )
+                       $errors[] = array('markedaspatrollederror-noautopatrol');
+
+               if( $errors ) {
+                       return $errors;
+               }
+
+               // If the change was patrolled already, do nothing
+               if( $this->getAttribute('rc_patrolled') )
+                       return array();
 
-               $dbw =& wfGetDB( DB_MASTER );
+               // Actually set the 'patrolled' flag in RC
+               $this->reallyMarkPatrolled();
 
-               $dbw->update( 'recentchanges',
-                       array( /* SET */
+               // Log this patrol event
+               PatrolLog::record( $this, $auto );
+               wfRunHooks( 'MarkPatrolledComplete', array($this->getAttribute('rc_id'), &$wgUser, false) );
+               return array();
+       }
+       
+       /**
+        * Mark this RecentChange patrolled, without error checking
+        * @return int Number of affected rows
+        */
+       public function reallyMarkPatrolled() {
+               $dbw = wfGetDB( DB_MASTER );
+               $dbw->update(
+                       'recentchanges',
+                       array(
                                'rc_patrolled' => 1
-                       ), array( /* WHERE */
-                               'rc_id' => $rcid
-                       ), $fname
+                       ),
+                       array(
+                               'rc_id' => $this->getAttribute('rc_id')
+                       ),
+                       __METHOD__
                );
+               return $dbw->affectedRows();
        }
 
        # Makes an entry in the database corresponding to an edit
-       /*static*/ function notifyEdit( $timestamp, &$title, $minor, &$user, $comment,
-               $oldId, $lastTimestamp, $bot = "default", $ip = '', $oldSize = 0, $newSize = 0,
-               $newId = 0)
+       public static function notifyEdit( $timestamp, &$title, $minor, &$user, $comment,
+               $oldId, $lastTimestamp, $bot, $ip = '', $oldSize = 0, $newSize = 0, $newId = 0)
        {
-               if ( $bot === 'default' ) {
-                       $bot = $user->isAllowed( 'bot' );
-               }
-
                if ( !$ip ) {
                        $ip = wfGetIP();
                        if ( !$ip ) {
@@ -232,7 +341,7 @@ class RecentChange
                        'rc_type'       => RC_EDIT,
                        'rc_minor'      => $minor ? 1 : 0,
                        'rc_cur_id'     => $title->getArticleID(),
-                       'rc_user'       => $user->getID(),
+                       'rc_user'       => $user->getId(),
                        'rc_user_text'  => $user->getName(),
                        'rc_comment'    => $comment,
                        'rc_this_oldid' => $newId,
@@ -240,9 +349,16 @@ 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_deleted'    => 0,
+                       'rc_logid'              => 0,
+                       'rc_log_type'   => null,
+                       'rc_log_action' => '',
+                       'rc_params'             => ''
                );
 
                $rc->mExtra =  array(
@@ -252,17 +368,15 @@ class RecentChange
                        'newSize'       => $newSize,
                );
                $rc->save();
-               return( $rc->mAttribs['rc_id'] );
+               return $rc;
        }
 
        /**
         * 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,
          $ip='', $size = 0, $newId = 0 )
        {
                if ( !$ip ) {
@@ -271,9 +385,6 @@ class RecentChange
                                $ip = '';
                        }
                }
-               if ( $bot == 'default' ) {
-                       $bot = $user->isAllowed( 'bot' );
-               }
 
                $rc = new RecentChange;
                $rc->mAttribs = array(
@@ -284,7 +395,7 @@ class RecentChange
                        'rc_type'           => RC_NEW,
                        'rc_minor'          => $minor ? 1 : 0,
                        'rc_cur_id'         => $title->getArticleID(),
-                       'rc_user'           => $user->getID(),
+                       'rc_user'           => $user->getId(),
                        'rc_user_text'      => $user->getName(),
                        'rc_comment'        => $comment,
                        'rc_this_oldid'     => $newId,
@@ -294,7 +405,14 @@ 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_deleted'            => 0,
+                       'rc_logid'                      => 0,
+                       'rc_log_type'           => null,
+                       'rc_log_action'         => '',
+                       'rc_params'                     => ''
                );
 
                $rc->mExtra =  array(
@@ -304,12 +422,14 @@ class RecentChange
                        'newSize' => $size
                );
                $rc->save();
-               return( $rc->mAttribs['rc_id'] );
+               return $rc;     
        }
 
        # 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 )
        {
+               global $wgRequest;
+
                if ( !$ip ) {
                        $ip = wfGetIP();
                        if ( !$ip ) {
@@ -326,17 +446,24 @@ class RecentChange
                        'rc_type'       => $overRedir ? RC_MOVE_OVER_REDIRECT : RC_MOVE,
                        'rc_minor'      => 0,
                        'rc_cur_id'     => $oldTitle->getArticleID(),
-                       'rc_user'       => $user->getID(),
+                       'rc_user'       => $user->getId(),
                        'rc_user_text'  => $user->getName(),
                        'rc_comment'    => $comment,
                        'rc_this_oldid' => 0,
                        'rc_last_oldid' => 0,
-                       'rc_bot'        => $user->isAllowed( 'bot' ) ? 1 : 0,
+                       'rc_bot'        => $user->isAllowed( 'bot' ) ? $wgRequest->getBool( 'bot' , true ) : 0,
                        'rc_moved_to_ns'        => $newTitle->getNamespace(),
                        '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_deleted'    => 0,
+                       'rc_logid'              => 0, # notifyMove not used anymore
+                       'rc_log_type'   => null,
+                       'rc_log_action' => '',
+                       'rc_params'             => ''
                );
 
                $rc->mExtra = array(
@@ -347,19 +474,19 @@ 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='',
-          $type, $action, $target, $logComment, $params )
+       public static function notifyLog( $timestamp, &$title, &$user, $actionComment, $ip='',
+          $type, $action, $target, $logComment, $params, $newId=0 )
        {
+               global $wgRequest;
+
                if ( !$ip ) {
                        $ip = wfGetIP();
                        if ( !$ip ) {
@@ -371,31 +498,34 @@ class RecentChange
                $rc->mAttribs = array(
                        'rc_timestamp'  => $timestamp,
                        'rc_cur_time'   => $timestamp,
-                       'rc_namespace'  => $title->getNamespace(),
-                       'rc_title'      => $title->getDBkey(),
+                       'rc_namespace'  => $target->getNamespace(),
+                       'rc_title'      => $target->getDBkey(),
                        'rc_type'       => RC_LOG,
                        'rc_minor'      => 0,
-                       'rc_cur_id'     => $title->getArticleID(),
-                       'rc_user'       => $user->getID(),
+                       'rc_cur_id'     => $target->getArticleID(),
+                       'rc_user'       => $user->getId(),
                        'rc_user_text'  => $user->getName(),
-                       'rc_comment'    => $comment,
+                       'rc_comment'    => $logComment,
                        'rc_this_oldid' => 0,
                        'rc_last_oldid' => 0,
-                       'rc_bot'        => $user->isAllowed( 'bot' ) ? 1 : 0,
+                       'rc_bot'        => $user->isAllowed( 'bot' ) ? $wgRequest->getBool( 'bot' , true ) : 0,
                        'rc_moved_to_ns'        => 0,
                        '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_deleted'    => 0,
+                       'rc_logid'              => $newId,
+                       'rc_log_type'   => $type,
+                       'rc_log_action' => $action,
+                       'rc_params'             => $params
                );
                $rc->mExtra =  array(
                        'prefixedDBkey' => $title->getPrefixedDBkey(),
                        'lastTimestamp' => 0,
-                       'logType' => $type,
-                       'logAction' => $action,
-                       'logComment' => $logComment,
-                       'logTarget' => $target,
-                       'logParams' => $params
+                       'actionComment' => $actionComment, // the comment appended to the action, passed from LogPage
                );
                $rc->save();
        }
@@ -408,7 +538,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 +560,29 @@ 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,
+                       'rc_params' => isset($row->rc_params) ? $row->rc_params : '',
+                       'rc_log_type' => isset($row->rc_log_type) ? $row->rc_log_type : null,
+                       'rc_log_action' => isset($row->rc_log_action) ? $row->rc_log_action : null,
+                       'rc_log_id' => isset($row->rc_log_id) ? $row->rc_log_id: 0,
+                       // this one REALLY should be set...
+                       'rc_deleted' => isset($row->rc_deleted) ? $row->rc_deleted: 0,
                );
 
                $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,21 +611,18 @@ 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);
 
-               $titleObj =& $this->getTitle();
                if ( $rc_type == RC_LOG ) {
-                       $title = Namespace::getCanonicalName( $titleObj->getNamespace() ) . $titleObj->getText();
+                       $titleObj = Title::newFromText( "Log/$rc_log_type", NS_SPECIAL );
                } else {
-                       $title = $titleObj->getPrefixedText();
+                       $titleObj =& $this->getTitle();
                }
-               $title = $this->cleanupForIRC( $title );
-
-               $bad = array("\n", "\r");
-               $empty = array("", "");
                $title = $titleObj->getPrefixedText();
-               $title = str_replace($bad, $empty, $title);
+               $title = $this->cleanupForIRC( $title );
 
                // FIXME: *HACK* these should be getFullURL(), hacked for SSL madness --brion 2005-12-26
                if ( $rc_type == RC_LOG ) {
@@ -508,12 +652,12 @@ class RecentChange
                $user = $this->cleanupForIRC( $rc_user_text );
 
                if ( $rc_type == RC_LOG ) {
-                       $logTargetText = $logTarget->getPrefixedText();
-                       $comment = $this->cleanupForIRC( str_replace( $logTargetText, "\00302$logTargetText\00310", $rc_comment ) );
-                       $flag = $logAction;
+                       $logTargetText = $this->getTitle()->getPrefixedText();
+                       $comment = $this->cleanupForIRC( str_replace($logTargetText,"\00302$logTargetText\00310",$actionComment) );
+                       $flag = $rc_log_action;
                } else {
                        $comment = $this->cleanupForIRC( $rc_comment );
-                       $flag = ($rc_minor ? "M" : "") . ($rc_new ? "N" : "");
+                       $flag = ($rc_new ? "N" : "") . ($rc_minor ? "M" : "") . ($rc_bot ? "B" : "");
                }
                # see http://www.irssi.org/documentation/formats for some colour codes. prefix is \003,
                # no colour (\003) switches back to the term default
@@ -522,5 +666,36 @@ 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>';
+               }
+       }
 }
-?>