check that $wgArticle is an instance of the Article class in Skin::pageStats() per...
[lhc/web/wiklou.git] / includes / WatchedItem.php
index 2b01a31..2d2d34f 100644 (file)
 <?php
 /**
- *
- * @package MediaWiki
+ * @file
+ * @ingroup Watchlist
  */
 
 /**
- *
- * @package MediaWiki
+ * @ingroup Watchlist
  */
 class WatchedItem {
-       var $mTitle, $mUser;
+       var $mTitle, $mUser, $id, $ns, $ti;
 
        /**
         * Create a WatchedItem object with the given user and title
-        * @todo document
-        * @private
+        * @param $user User: the user to use for (un)watching
+        * @param $title Title: the title we're going to (un)watch
+        * @return WatchedItem object
         */
-       function &fromUserTitle( &$user, &$title ) {
+       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();
-# 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;
+               # 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();
                return $wl;
        }
 
-       /**
-        * Returns the memcached key for this item
-        */
-       function watchKey() {
-               global $wgDBname;
-               return "$wgDBname:watchlist:user:$this->id:page:$this->ns:$this->ti";
-       }
-
        /**
         * Is mTitle being watched by mUser?
+        * @return bool
         */
-       function isWatched() {
+       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;
                $fname = 'WatchedItem::isWatched';
 
-               $key = $this->watchKey();
-               $iswatched = $wgMemc->get( $key );
-               if( is_integer( $iswatched ) ) return $iswatched;
-
-               $dbr =& wfGetDB( DB_SLAVE );
+               $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;
-               $wgMemc->set( $key, $iswatched );
                return $iswatched;
        }
 
        /**
-        * @todo document
+        * Given a title and user (assumes the object is setup), add the watch to the
+        * database.
+        * @return bool (always true)
         */
-       function addWatch() {
+       public function addWatch() {
                $fname = 'WatchedItem::addWatch';
                wfProfileIn( $fname );
-               # REPLACE instead of INSERT because occasionally someone
-               # accidentally reloads a watch-add operation.
-               $dbw =& wfGetDB( DB_MASTER );
-               $dbw->replace( 'watchlist', array(array('wl_user', 'wl_namespace', 'wl_title', 'wl_notificationtimestamp')),
+
+               // 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_title' => $this->ti,
                        'wl_notificationtimestamp' => NULL
-                 ), $fname );
+                 ), $fname, 'IGNORE' );
 
-               # 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 need separate entries: create them
-               $dbw->replace( 'watchlist', array(array('wl_user', 'wl_namespace', 'wl_title', 'wl_notificationtimestamp')),
+               // 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 );
+                 ), $fname, 'IGNORE' );
 
-               global $wgMemc;
-               $wgMemc->set( $this->watchkey(), 1 );
                wfProfileOut( $fname );
                return true;
        }
 
-       function removeWatch() {
-               global $wgMemc;
+       /**
+        * Same as addWatch, only the opposite.
+        * @return bool
+        */
+       public function removeWatch() {
                $fname = 'WatchedItem::removeWatch';
 
                $success = false;
-               $dbw =& wfGetDB( DB_MASTER );
+               $dbw = wfGetDB( DB_MASTER );
                $dbw->delete( 'watchlist',
                        array(
                                'wl_user' => $this->id,
@@ -126,26 +116,32 @@ class WatchedItem {
                if ( $dbw->affectedRows() ) {
                        $success = true;
                }
-               if ( $success ) {
-                       $wgMemc->set( $this->watchkey(), 0 );
-               }
                return $success;
        }
 
        /**
-        * @static
+        * 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
         */
-       function duplicateEntries( $ot, $nt ) {
+       public static function duplicateEntries( $ot, $nt ) {
+               WatchedItem::doDuplicateEntries( $ot->getSubjectPage(), $nt->getSubjectPage() );
+               WatchedItem::doDuplicateEntries( $ot->getTalkPage(), $nt->getTalkPage() );
+       }
+
+       /**
+        * 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();
 
-               $dbw =& wfGetDB( DB_MASTER );
-               $watchlist = $dbw->tableName( 'watchlist' );
-
+               $dbw = wfGetDB( DB_MASTER );
                $res = $dbw->select( 'watchlist', 'wl_user',
                        array( 'wl_namespace' => $oldnamespace, 'wl_title' => $oldtitle ),
                        $fname, 'FOR UPDATE'
@@ -160,7 +156,7 @@ class WatchedItem {
                        );
                }
                $dbw->freeResult( $res );
-               
+
                if( empty( $values ) ) {
                        // Nothing to do
                        return true;
@@ -172,8 +168,4 @@ class WatchedItem {
                $dbw->replace( 'watchlist', array(array( 'wl_user', 'wl_namespace', 'wl_title')), $values, $fname );
                return true;
        }
-
-
 }
-
-?>