check that $wgArticle is an instance of the Article class in Skin::pageStats() per...
[lhc/web/wiklou.git] / includes / WatchedItem.php
index e2d9506..2d2d34f 100644 (file)
 <?php
+/**
+ * @file
+ * @ingroup Watchlist
+ */
 
+/**
+ * @ingroup Watchlist
+ */
 class WatchedItem {
+       var $mTitle, $mUser, $id, $ns, $ti;
 
-       /* static */ function &fromUserTitle( &$user, &$title ) {
+       /**
+        * Create a WatchedItem object with the given user and title
+        * @param $user User: the user to use for (un)watching
+        * @param $title Title: the title we're going to (un)watch
+        * @return WatchedItem object
+        */
+       public static function fromUserTitle( $user, $title ) {
                $wl = new WatchedItem;
-               $wl->mUser =& $user;
-               $wl->mTitle =& $title;
+               $wl->mUser = $user;
+               $wl->mTitle = $title;
                $wl->id = $user->getId();
-               $wl->ns = $title->getNamespace() & ~1;
+               # Patch (also) for email notification on page changes T.Gries/M.Arndt 11.09.2004
+               # TG patch: here we do not consider pages and their talk pages equivalent - why should we ?
+               # The change results in talk-pages not automatically included in watchlists, when their parent page is included
+               # $wl->ns = $title->getNamespace() & ~1;
+               $wl->ns = $title->getNamespace();
+
                $wl->ti = $title->getDBkey();
-               $wl->eti = wfStrencode( $wl->ti );
                return $wl;
        }
 
-       function watchKey() {
-               global $wgDBname;
-               return "$wgDBname:watchlist:user:$this->id:page:$this->ns:$this->ti";
-       }
-       
-       function isWatched()
-       {
+       /**
+        * Is mTitle being watched by mUser?
+        * @return bool
+        */
+       public function isWatched() {
                # Pages and their talk pages are considered equivalent for watching;
                # remember that talk namespaces are numbered as page namespace+1.
-               global $wgMemc;
-               $key = $this->watchKey();
-               $iswatched = $wgMemc->get( $key );
-               if( is_integer( $iswatched ) ) return $iswatched;
-               
-               $sql = "SELECT 1 FROM watchlist WHERE wl_user=$this->id AND wl_namespace=$this->ns AND wl_title='$this->eti'";
-               $res = wfQuery( $sql, DB_READ );
-               $iswatched = (wfNumRows( $res ) > 0) ? 1 : 0;
-               $wgMemc->set( $key, $iswatched );
+               $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;
        }
 
-       function addWatch()
-       {
-               $fname = "WatchedItem::addWatch";
-               # REPLACE instead of INSERT because occasionally someone
-               # accidentally reloads a watch-add operation.
-               $dbw =& wfGetDB( DB_WRITE );
-               $dbw->replace( 'watchlist', array(array('wl_user', 'wl_namespace', 'wl_title')),
-                 array( 
+       /**
+        * Given a title and user (assumes the object is setup), add the watch to the
+        * database.
+        * @return bool (always true)
+        */
+       public function addWatch() {
+               $fname = 'WatchedItem::addWatch';
+               wfProfileIn( $fname );
+
+               // 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,
-                       'wl_title' => $this->eti,
-                 ), $fname );
+                       'wl_namespace' => ($this->ns & ~1),
+                       'wl_title' => $this->ti,
+                       'wl_notificationtimestamp' => NULL
+                 ), $fname, '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_title' => $this->ti,
+                       'wl_notificationtimestamp' => NULL
+                 ), $fname, 'IGNORE' );
 
-               global $wgMemc;
-               $wgMemc->set( $this->watchkey(), 1 );
+               wfProfileOut( $fname );
                return true;
        }
 
-       function removeWatch()
-       {
-               $sql = "DELETE FROM watchlist WHERE wl_user=$this->id AND wl_namespace=$this->ns AND wl_title='$this->eti'";
-               $res = wfQuery( $sql, DB_WRITE );
-               if( $res === false ) return false;
-               
-               global $wgMemc;
-               $wgMemc->set( $this->watchkey(), 0 );
-               return true;
+       /**
+        * Same as addWatch, only the opposite.
+        * @return bool
+        */
+       public function removeWatch() {
+               $fname = 'WatchedItem::removeWatch';
+
+               $success = false;
+               $dbw = wfGetDB( DB_MASTER );
+               $dbw->delete( 'watchlist',
+                       array(
+                               'wl_user' => $this->id,
+                               'wl_namespace' => ($this->ns & ~1),
+                               'wl_title' => $this->ti
+                       ), $fname
+               );
+               if ( $dbw->affectedRows() ) {
+                       $success = true;
+               }
+
+               # the following code compensates the new behaviour, introduced by the
+               # enotif patch, that every single watched page needs now to be listed
+               # in watchlist namespace:page and namespace_talk:page had separate
+               # entries: clear them
+               $dbw->delete( 'watchlist',
+                       array(
+                               'wl_user' => $this->id,
+                               'wl_namespace' => ($this->ns | 1),
+                               'wl_title' => $this->ti
+                       ), $fname
+               );
+
+               if ( $dbw->affectedRows() ) {
+                       $success = true;
+               }
+               return $success;
+       }
+
+       /**
+        * Check if the given title already is watched by the user, and if so
+        * add watches on a new title. To be used for page renames and such.
+        *
+        * @param $ot Title: page title to duplicate entries from, if present
+        * @param $nt Title: page title to add watches on
+        */
+       public static function duplicateEntries( $ot, $nt ) {
+               WatchedItem::doDuplicateEntries( $ot->getSubjectPage(), $nt->getSubjectPage() );
+               WatchedItem::doDuplicateEntries( $ot->getTalkPage(), $nt->getTalkPage() );
        }
 
-       /* static */ function duplicateEntries( $ot, $nt ) {
+       /**
+        * Handle duplicate entries. Backend for duplicateEntries().
+        */
+       private static function doDuplicateEntries( $ot, $nt ) {
                $fname = "WatchedItem::duplicateEntries";
-               global $wgMemc, $wgDBname;
-               $oldnamespace = $ot->getNamespace() & ~1;
-               $newnamespace = $nt->getNamespace() & ~1;
+               $oldnamespace = $ot->getNamespace();
+               $newnamespace = $nt->getNamespace();
                $oldtitle = $ot->getDBkey();
                $newtitle = $nt->getDBkey();
-               $eoldtitle = wfStrencode( $oldtitle );
-               $enewtitle = wfStrencode( $newtitle );
-
-               $sql = "SELECT wl_user FROM watchlist
-                       WHERE wl_namespace={$oldnamespace} AND wl_title='{$eoldtitle}'";
-               $res = wfQuery( $sql, DB_READ, $fname );
-               if( $s = wfFetchObject( $res ) ) {
-                       $sql = "REPLACE INTO watchlist (wl_user,wl_namespace,wl_title)
-                               VALUES ({$s->wl_user},{$newnamespace},'{$enewtitle}')";
-                       $key = "$wgDBname:watchlist:user:$s->wl_user:page:$newnamespace:$newtitle";
-                       $wgMemc->set( $key, 1 );
-                       while( $s = wfFetchObject( $res ) ) {
-                               $sql .= ",({$s->wl_user},{$newnamespace},'{$enewtitle}')";
-                               $key = "$wgDBname:watchlist:user:$s->wl_user:page:$newnamespace:$newtitle";
-                               $wgMemc->set( $key, 1 );
-                       }
-                       $res = wfQuery( $sql, DB_WRITE, $fname );
-                       if( $res === false ) return false; # db error?
+
+               $dbw = wfGetDB( DB_MASTER );
+               $res = $dbw->select( 'watchlist', 'wl_user',
+                       array( 'wl_namespace' => $oldnamespace, 'wl_title' => $oldtitle ),
+                       $fname, 'FOR UPDATE'
+               );
+               # Construct array to replace into the watchlist
+               $values = array();
+               while ( $s = $dbw->fetchObject( $res ) ) {
+                       $values[] = array(
+                               'wl_user' => $s->wl_user,
+                               'wl_namespace' => $newnamespace,
+                               'wl_title' => $newtitle
+                       );
                }
-               return true;
-       }
+               $dbw->freeResult( $res );
 
+               if( empty( $values ) ) {
+                       // Nothing to do
+                       return true;
+               }
 
+               # 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 );
+               return true;
+       }
 }
-
-?>