Page move undo feature
[lhc/web/wiklou.git] / includes / RecentChange.php
index 8cce2b6..6502d1f 100644 (file)
@@ -1,71 +1,88 @@
 <?php
-# Utility class for creating new RC entries
-
-define( "RC_EDIT", 0);
-define( "RC_NEW", 1);
-define( "RC_MOVE", 2);
-define( "RC_LOG", 3);
-define( "RC_MOVE_OVER_REDIRECT", 4);
-
-
-/*
-mAttributes:
-       rc_timestamp    time the entry was made
-       rc_cur_time     timestamp on the cur row
-       rc_namespace    namespace #
-       rc_title        non-prefixed db key
-       rc_type          is new entry, used to determine whether updating is necessary
-       rc_minor        is minor
-       rc_cur_id       id of associated cur entry
-       rc_user         user id who made the entry
-       rc_user_text    user name who made the entry
-       rc_comment      edit summary
-       rc_this_oldid   old_id associated with this entry (or zero)
-       rc_last_oldid   old_id associated with the entry before this one (or zero)
-       rc_bot          is bot, hidden
-       rc_ip           IP address of the user in dotted quad notation
-       rc_new          obsolete, use rc_type==RC_NEW
-
-mExtra:
-       prefixedDBkey   prefixed db key, used by external app via msg queue
-       lastTimestamp   timestamp of previous entry, used in WHERE clause during update
-       lang            the interwiki prefix, automatically set in save()
-*/
+/**
+ *
+ * @package MediaWiki
+ */
 
+/**
+ * Various globals
+ */
+define( 'RC_EDIT', 0);
+define( 'RC_NEW', 1);
+define( 'RC_MOVE', 2);
+define( 'RC_LOG', 3);
+define( 'RC_MOVE_OVER_REDIRECT', 4);
+
+
+/**
+ * Utility class for creating new RC entries
+ * mAttributes:
+ *     rc_id           id of the row in the recentchanges table
+ *     rc_timestamp    time the entry was made
+ *     rc_cur_time     timestamp on the cur row
+ *     rc_namespace    namespace #
+ *     rc_title        non-prefixed db key
+ *     rc_type         is new entry, used to determine whether updating is necessary
+ *     rc_minor        is minor
+ *     rc_cur_id       page_id of associated page entry
+ *     rc_user         user id who made the entry
+ *     rc_user_text    user name who made the entry
+ *     rc_comment      edit summary
+ *     rc_this_oldid   rev_id associated with this entry (or zero)
+ *     rc_last_oldid   rev_id associated with the entry before this one (or zero)
+ *     rc_bot          is bot, hidden
+ *     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
+ * 
+ * mExtra:
+ *     prefixedDBkey   prefixed db key, used by external app via msg queue
+ *     lastTimestamp   timestamp of previous entry, used in WHERE clause during update
+ *     lang            the interwiki prefix, automatically set in save()
+ * 
+ * temporary:          not stored in the database
+ *      notificationtimestamp
+ *      numberofWatchingusers
+ *
+ * @todo document functions and variables
+ * @package MediaWiki
+ */
 class RecentChange
 {
        var $mAttribs = array(), $mExtra = array();
        var $mTitle = false, $mMovedToTitle = false;
 
        # Factory methods
-       
-       /* static */ function newFromRow( $row ) 
+
+       /* static */ function newFromRow( $row )
        {
                $rc = new RecentChange;
                $rc->loadFromRow( $row );
                return $rc;
        }
-       
+
        /* static */ function newFromCurRow( $row )
        {
                $rc = new RecentChange;
                $rc->loadFromCurRow( $row );
+               $rc->notificationtimestamp = false;
+               $rc->numberofWatchingusers = false;
                return $rc;
        }
 
        # Accessors
-       
-       function setAttribs( $attribs ) 
+
+       function setAttribs( $attribs )
        {
                $this->mAttribs = $attribs;
        }
-       
+
        function setExtra( $extra )
        {
                $this->mExtra = $extra;
        }
-       
-       function getTitle()
+
+       function &getTitle()
        {
                if ( $this->mTitle === false ) {
                        $this->mTitle = Title::makeTitle( $this->mAttribs['rc_namespace'], $this->mAttribs['rc_title'] );
@@ -76,66 +93,98 @@ class RecentChange
        function getMovedToTitle()
        {
                if ( $this->mMovedToTitle === false ) {
-                       $this->mMovedToTitle = Title::makeTitle( $this->mAttribs['rc_moved_to_ns'], 
+                       $this->mMovedToTitle = Title::makeTitle( $this->mAttribs['rc_moved_to_ns'],
                                $this->mAttribs['rc_moved_to_title'] );
                }
                return $this->mMovedToTitle;
        }
 
        # Writes the data in this object to the database
-       function save() 
+       function save()
        {
                global $wgUseRCQueue, $wgRCQueueID, $wgLocalInterwiki, $wgPutIPinRC;
-               $fname = "RecentChange::save";
-               
+               $fname = 'RecentChange::save';
+
+               $dbw =& wfGetDB( DB_MASTER );
                if ( !is_array($this->mExtra) ) {
                        $this->mExtra = array();
                }
                $this->mExtra['lang'] = $wgLocalInterwiki;
-               
+
                if ( !$wgPutIPinRC ) {
                        $this->mAttribs['rc_ip'] = '';
                }
-               
+
+               # Fixup database timestamps
+               $this->mAttribs['rc_timestamp']=$dbw->timestamp($this->mAttribs['rc_timestamp']);
+               $this->mAttribs['rc_cur_time']=$dbw->timestamp($this->mAttribs['rc_cur_time']);
+
                # Insert new row
-               wfInsertArray( "recentchanges", $this->mAttribs, $fname );
-               
+               $dbw->insert( 'recentchanges', $this->mAttribs, $fname );
+
                # Update old rows, if necessary
                if ( $this->mAttribs['rc_type'] == RC_EDIT ) {
                        $oldid = $this->mAttribs['rc_last_oldid'];
                        $ns = $this->mAttribs['rc_namespace'];
-                       $title = wfStrencode($this->mAttribs['rc_title']);
+                       $title = $this->mAttribs['rc_title'];
                        $lastTime = $this->mExtra['lastTimestamp'];
                        $now = $this->mAttribs['rc_timestamp'];
                        $curId = $this->mAttribs['rc_cur_id'];
-                       
-                       # Update rc_this_oldid for the entries which were current
-                       $sql = "UPDATE recentchanges SET rc_this_oldid={$oldid} " .
-                               "WHERE rc_namespace=$ns AND rc_title='$title' AND rc_timestamp='$lastTime'";
-                       wfQuery( $sql, DB_WRITE, $fname );
+
+                       # Don't bother looking for entries that have probably
+                       # been purged, it just locks up the indexes needlessly.
+                       global $wgRCMaxAge;
+                       $age = time() - wfTimestamp( TS_UNIX, $lastTime );
+                       if( $age < $wgRCMaxAge ) {
+                               # Update rc_this_oldid for the entries which were current
+                               $dbw->update( 'recentchanges',
+                                       array( /* SET */
+                                               'rc_this_oldid' => $oldid
+                                       ), array( /* WHERE */
+                                               'rc_namespace' => $ns,
+                                               'rc_title' => $title,
+                                               'rc_timestamp' => $dbw->timestamp( $lastTime )
+                                       ), $fname
+                               );
+                       }
 
                        # Update rc_cur_time
-                       $sql = "UPDATE recentchanges SET rc_cur_time='{$now}' " .
-                         "WHERE rc_cur_id=" . $curId;
-                       wfQuery( $sql, DB_WRITE, $fname );
+                       $dbw->update( 'recentchanges', array( 'rc_cur_time' => $now ),
+                               array( 'rc_cur_id' => $curId ), $fname );
                }
-               
+
                # Notify external application
                if ( $wgUseRCQueue ) {
                        $queue = msg_get_queue( $wgRCQueueID );
-                       if (!msg_send( $queue, array_merge( $this->mAttribs, 1, $this->mExtra ), 
-                               true, false, $error )) 
+                       if (!msg_send( $queue, array_merge( $this->mAttribs, 1, $this->mExtra ),
+                               true, false, $error ))
                        {
                                wfDebug( "Error sending message to RC queue, code $error\n" );
                        }
                }
        }
-       
+
+       # Marks a certain row as patrolled
+       function markPatrolled( $rcid )
+       {
+               $fname = 'RecentChange::markPatrolled';
+
+               $dbw =& wfGetDB( DB_MASTER );
+
+               $dbw->update( 'recentchanges',
+                       array( /* SET */
+                               'rc_patrolled' => 1
+                       ), array( /* WHERE */
+                               'rc_id' => $rcid
+                       ), $fname
+               );
+       }
+
        # Makes an entry in the database corresponding to an edit
-       /*static*/ function notifyEdit( $timestamp, &$title, $minor, &$user, $comment, 
-               $oldId, $lastTimestamp, $bot = "default", $ip = '' ) 
+       /*static*/ function notifyEdit( $timestamp, &$title, $minor, &$user, $comment,
+               $oldId, $lastTimestamp, $bot = "default", $ip = '' )
        {
-               if ( $bot == "default " ) {
+               if ( $bot == 'default ' ) {
                        $bot = $user->isBot();
                }
 
@@ -143,7 +192,7 @@ class RecentChange
                        global $wgIP;
                        $ip = empty( $wgIP ) ? '' : $wgIP;
                }
-               
+
                $rc = new RecentChange;
                $rc->mAttribs = array(
                        'rc_timestamp'  => $timestamp,
@@ -162,16 +211,17 @@ class RecentChange
                        'rc_moved_to_ns'        => 0,
                        'rc_moved_to_title'     => '',
                        'rc_ip' => $ip,
+                       'rc_patrolled' => 0,
                        'rc_new'        => 0 # obsolete
                );
-               
+
                $rc->mExtra =  array(
                        'prefixedDBkey' => $title->getPrefixedDBkey(),
                        'lastTimestamp' => $lastTimestamp
                );
                $rc->save();
        }
-       
+
        # Makes an entry in the database corresponding to page creation
        # Note: the title object must be loaded with the new id using resetArticleID()
        /*static*/ function notifyNew( $timestamp, &$title, $minor, &$user, $comment, $bot = "default", $ip='' )
@@ -180,7 +230,7 @@ class RecentChange
                        global $wgIP;
                        $ip = empty( $wgIP ) ? '' : $wgIP;
                }
-               if ( $bot == "default" ) {
+               if ( $bot == 'default' ) {
                        $bot = $user->isBot();
                }
 
@@ -202,16 +252,17 @@ class RecentChange
                        'rc_moved_to_ns'    => 0,
                        'rc_moved_to_title' => '',
                        'rc_ip'             => $ip,
+                       'rc_patrolled'      => 0,
                        'rc_new'        => 1 # obsolete
                );
-               
+
                $rc->mExtra =  array(
                        'prefixedDBkey' => $title->getPrefixedDBkey(),
                        'lastTimestamp' => 0
                );
                $rc->save();
        }
-       
+
        # Makes an entry in the database corresponding to a rename
        /*static*/ function notifyMove( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='', $overRedir = false )
        {
@@ -237,9 +288,10 @@ class RecentChange
                        'rc_moved_to_ns'        => $newTitle->getNamespace(),
                        'rc_moved_to_title'     => $newTitle->getDBkey(),
                        'rc_ip'         => $ip,
-                       'rc_new'        => 0 # obsolete
+                       'rc_new'        => 0, # obsolete
+                       'rc_patrolled' => 1
                );
-               
+
                $rc->mExtra = array(
                        'prefixedDBkey' => $oldTitle->getPrefixedDBkey(),
                        'lastTimestamp' => 0,
@@ -247,16 +299,16 @@ class RecentChange
                );
                $rc->save();
        }
-       
+
        /* static */ function notifyMoveToNew( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
-               RecentChange::notifyMove( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip, false );
+               RecentChange::notifyMove( $timestamp, $oldTitle, $newTitle, $user, $comment, $ip, false );
        }
 
        /* static */ function notifyMoveOverRedirect( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
-               RecentChange::notifyMove( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='', true );
+               RecentChange::notifyMove( $timestamp, $oldTitle, $newTitle, $user, $comment, $ip='', true );
        }
 
-       # A log entry is different to an edit in that previous revisions are 
+       # A log entry is different to an edit in that previous revisions are
        # not kept
        /*static*/ function notifyLog( $timestamp, &$title, &$user, $comment, $ip='' )
        {
@@ -282,6 +334,7 @@ class RecentChange
                        'rc_moved_to_ns'        => 0,
                        'rc_moved_to_title'     => '',
                        'rc_ip' => $ip,
+                       'rc_patrolled' => 1,
                        'rc_new'        => 0 # obsolete
                );
                $rc->mExtra =  array(
@@ -297,48 +350,52 @@ class RecentChange
                $this->mAttribs = get_object_vars( $row );
                $this->mExtra = array();
        }
-       
+
        # Makes a pseudo-RC entry from a cur row, for watchlists and things
        function loadFromCurRow( $row )
        {
                $this->mAttribs = array(
-                       "rc_timestamp" => $row->cur_timestamp,
-                       "rc_cur_time" => $row->cur_timestamp,
-                       "rc_user" => $row->cur_user,
-                       "rc_user_text" => $row->cur_user_text,
-                       "rc_namespace" => $row->cur_namespace,
-                       "rc_title" => $row->cur_title,
-                       "rc_comment" => $row->cur_comment,
-                       "rc_minor" => !!$row->cur_minor_edit,
-                       "rc_type" => $row->cur_is_new ? RC_NEW : RC_EDIT,
-                       "rc_cur_id" => $row->cur_id,
+                       'rc_timestamp' => $row->rev_timestamp,
+                       'rc_cur_time' => $row->rev_timestamp,
+                       'rc_user' => $row->rev_user,
+                       'rc_user_text' => $row->rev_user_text,
+                       'rc_namespace' => $row->page_namespace,
+                       'rc_title' => $row->page_title,
+                       'rc_comment' => $row->rev_comment,
+                       'rc_minor' => !!$row->rev_minor_edit,
+                       'rc_type' => $row->page_is_new ? RC_NEW : RC_EDIT,
+                       'rc_cur_id' => $row->page_id,
                        'rc_this_oldid' => 0,
                        'rc_last_oldid' => 0,
                        'rc_bot'        => 0,
                        'rc_moved_to_ns'        => 0,
                        'rc_moved_to_title'     => '',
                        'rc_ip' => '',
-                       'rc_new' => $row->cur_is_new # obsolete
+                       'rc_patrolled' => '1',  # we can't support patrolling on the Watchlist
+                                               # currently because it uses cur, not recentchanges
+                       'rc_new' => $row->page_is_new # obsolete
                );
 
                $this->mExtra = array();
        }
 
 
-       # Gets the end part of the diff URL assoicated with this object
-       # Blank if no diff link should be displayed
+       /**
+        * Gets the end part of the diff URL assoicated with this object
+        * Blank if no diff link should be displayed
+        */
        function diffLinkTrail( $forceCur )
        {
                if ( $this->mAttribs['rc_type'] == RC_EDIT ) {
                        $trail = "curid=" . (int)($this->mAttribs['rc_cur_id']) .
                                "&oldid=" . (int)($this->mAttribs['rc_last_oldid']);
                        if ( $forceCur ) {
-                               $trail .= "&diff=0" ;
+                               $trail .= '&diff=0' ;
                        } else {
-                               $trail .= "&diff=" . (int)($this->mAttribs['rc_this_oldid']);
+                               $trail .= '&diff=' . (int)($this->mAttribs['rc_this_oldid']);
                        }
                } else {
-                       $trail = "";
+                       $trail = '';
                }
                return $trail;
        }