bug 36087: PostgresUpdater fails on 8.3.14
[lhc/web/wiklou.git] / includes / WatchedItem.php
index 2d2d34f..ecff5b5 100644 (file)
@@ -9,6 +9,7 @@
  */
 class WatchedItem {
        var $mTitle, $mUser, $id, $ns, $ti;
+       private $loaded = false, $watched, $timestamp;
 
        /**
         * Create a WatchedItem object with the given user and title
@@ -32,19 +33,83 @@ class WatchedItem {
        }
 
        /**
-        * Is mTitle being watched by mUser?
-        * @return bool
+        * Return an array of conditions to select or update the appropriate database
+        * row.
+        *
+        * @return array
         */
-       public function isWatched() {
+       private function dbCond() {
+               return array( 'wl_user' => $this->id, 'wl_namespace' => $this->ns, 'wl_title' => $this->ti );
+       }
+
+       /**
+        * Load the object from the database
+        */
+       private function load() {
+               if ( $this->loaded ) {
+                       return;
+               }
+               $this->loaded = true;
+
                # Pages and their talk pages are considered equivalent for watching;
                # remember that talk namespaces are numbered as page namespace+1.
-               $fname = 'WatchedItem::isWatched';
 
                $dbr = wfGetDB( DB_SLAVE );
-               $res = $dbr->select( 'watchlist', 1, array( 'wl_user' => $this->id, 'wl_namespace' => $this->ns,
-                       'wl_title' => $this->ti ), $fname );
-               $iswatched = ($dbr->numRows( $res ) > 0) ? 1 : 0;
-               return $iswatched;
+               $row = $dbr->selectRow( 'watchlist', 'wl_notificationtimestamp',
+                       $this->dbCond(), __METHOD__ );
+
+               if ( $row === false ) {
+                       $this->watched = false;
+               } else {
+                       $this->watched = true;
+                       $this->timestamp = $row->wl_notificationtimestamp;
+               }
+       }
+
+       /**
+        * Is mTitle being watched by mUser?
+        * @return bool
+        */
+       public function isWatched() {
+               $this->load();
+               return $this->watched;
+       }
+
+       /**
+        * Get the notification timestamp of this entry.
+        *
+        * @return false|null|string: false if the page is not watched, the value of
+        *         the wl_notificationtimestamp field otherwise
+        */
+       public function getNotificationTimestamp() {
+               $this->load();
+               if ( $this->watched ) {
+                       return $this->timestamp;
+               } else {
+                       return false;
+               }
+       }
+
+       /**
+        * Reset the notification timestamp of this entry
+        *
+        * @param $force Whether to force the write query to be executed even if the
+        *        page is not watched or the notification timestamp is already NULL.
+        */
+       public function resetNotificationTimestamp( $force = '' ) {
+               if ( $force != 'force' ) {
+                       $this->load();
+                       if ( !$this->watched || $this->timestamp === null ) {
+                               return;
+                       }
+               }
+
+               // If the page is watched by the user (or may be watched), update the timestamp on any
+               // any matching rows
+               $dbw = wfGetDB( DB_MASTER );
+               $dbw->update( 'watchlist', array( 'wl_notificationtimestamp' => null ),
+                       $this->dbCond(), __METHOD__ );
+               $this->timestamp = null;
        }
 
        /**
@@ -53,31 +118,32 @@ class WatchedItem {
         * @return bool (always true)
         */
        public function addWatch() {
-               $fname = 'WatchedItem::addWatch';
-               wfProfileIn( $fname );
+               wfProfileIn( __METHOD__ );
 
                // Use INSERT IGNORE to avoid overwriting the notification timestamp
                // if there's already an entry for this page
                $dbw = wfGetDB( DB_MASTER );
                $dbw->insert( 'watchlist',
                  array(
-                   'wl_user' => $this->id,
-                       'wl_namespace' => ($this->ns & ~1),
+                       'wl_user' => $this->id,
+                       'wl_namespace' => MWNamespace::getSubject($this->ns),
                        'wl_title' => $this->ti,
-                       'wl_notificationtimestamp' => NULL
-                 ), $fname, 'IGNORE' );
+                       'wl_notificationtimestamp' => null
+                 ), __METHOD__, 'IGNORE' );
 
                // Every single watched page needs now to be listed in watchlist;
                // namespace:page and namespace_talk:page need separate entries:
                $dbw->insert( 'watchlist',
                  array(
                        'wl_user' => $this->id,
-                       'wl_namespace' => ($this->ns | 1 ),
+                       'wl_namespace' => MWNamespace::getTalk($this->ns),
                        'wl_title' => $this->ti,
-                       'wl_notificationtimestamp' => NULL
-                 ), $fname, 'IGNORE' );
+                       'wl_notificationtimestamp' => null
+                 ), __METHOD__, 'IGNORE' );
 
-               wfProfileOut( $fname );
+               $this->watched = true;
+
+               wfProfileOut( __METHOD__ );
                return true;
        }
 
@@ -86,16 +152,16 @@ class WatchedItem {
         * @return bool
         */
        public function removeWatch() {
-               $fname = 'WatchedItem::removeWatch';
+               wfProfileIn( __METHOD__ );
 
                $success = false;
                $dbw = wfGetDB( DB_MASTER );
                $dbw->delete( 'watchlist',
                        array(
                                'wl_user' => $this->id,
-                               'wl_namespace' => ($this->ns & ~1),
+                               'wl_namespace' => MWNamespace::getSubject($this->ns),
                                'wl_title' => $this->ti
-                       ), $fname
+                       ), __METHOD__
                );
                if ( $dbw->affectedRows() ) {
                        $success = true;
@@ -108,14 +174,18 @@ class WatchedItem {
                $dbw->delete( 'watchlist',
                        array(
                                'wl_user' => $this->id,
-                               'wl_namespace' => ($this->ns | 1),
+                               'wl_namespace' => MWNamespace::getTalk($this->ns),
                                'wl_title' => $this->ti
-                       ), $fname
+                       ), __METHOD__
                );
 
                if ( $dbw->affectedRows() ) {
                        $success = true;
                }
+
+               $this->watched = false;
+
+               wfProfileOut( __METHOD__ );
                return $success;
        }
 
@@ -133,9 +203,13 @@ class WatchedItem {
 
        /**
         * Handle duplicate entries. Backend for duplicateEntries().
+        *
+        * @param $ot Title
+        * @param $nt Title
+        *
+        * @return bool
         */
        private static function doDuplicateEntries( $ot, $nt ) {
-               $fname = "WatchedItem::duplicateEntries";
                $oldnamespace = $ot->getNamespace();
                $newnamespace = $nt->getNamespace();
                $oldtitle = $ot->getDBkey();
@@ -144,18 +218,17 @@ class WatchedItem {
                $dbw = wfGetDB( DB_MASTER );
                $res = $dbw->select( 'watchlist', 'wl_user',
                        array( 'wl_namespace' => $oldnamespace, 'wl_title' => $oldtitle ),
-                       $fname, 'FOR UPDATE'
+                       __METHOD__, 'FOR UPDATE'
                );
                # Construct array to replace into the watchlist
                $values = array();
-               while ( $s = $dbw->fetchObject( $res ) ) {
+               foreach ( $res as $s ) {
                        $values[] = array(
                                'wl_user' => $s->wl_user,
                                'wl_namespace' => $newnamespace,
                                'wl_title' => $newtitle
                        );
                }
-               $dbw->freeResult( $res );
 
                if( empty( $values ) ) {
                        // Nothing to do
@@ -165,7 +238,7 @@ class WatchedItem {
                # Perform replace
                # Note that multi-row replace is very efficient for MySQL but may be inefficient for
                # some other DBMSes, mostly due to poor simulation by us
-               $dbw->replace( 'watchlist', array(array( 'wl_user', 'wl_namespace', 'wl_title')), $values, $fname );
+               $dbw->replace( 'watchlist', array( array( 'wl_user', 'wl_namespace', 'wl_title' ) ), $values, __METHOD__ );
                return true;
        }
 }