WatchedItem.php

Go to the documentation of this file.

<?php
class WatchedItem {
        var $mTitle, $mUser, $id, $ns, $ti;
        private $loaded = false, $watched, $timestamp;

        public static function fromUserTitle( $user, $title ) {
                $wl = new WatchedItem;
                $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;
                $wl->ns = $title->getNamespace();

                $wl->ti = $title->getDBkey();
                return $wl;
        }

        private function dbCond() {
                return array( 'wl_user' => $this->id, 'wl_namespace' => $this->ns, 'wl_title' => $this->ti );
        }

        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.

                $dbr = wfGetDB( DB_SLAVE );
                $row = $dbr->selectRow( 'watchlist', 'wl_notificationtimestamp',
                        $this->dbCond(), __METHOD__ );

                if ( $row === false ) {
                        $this->watched = false;
                } else {
                        $this->watched = true;
                        $this->timestamp = $row->wl_notificationtimestamp;
                }
        }

        public function isWatched() {
                $this->load();
                return $this->watched;
        }

        public function getNotificationTimestamp() {
                $this->load();
                if ( $this->watched ) {
                        return $this->timestamp;
                } else {
                        return false;
                }
        }

        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;
        }

        public function addWatch() {
                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' => MWNamespace::getSubject($this->ns),
                        'wl_title' => $this->ti,
                        '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' => MWNamespace::getTalk($this->ns),
                        'wl_title' => $this->ti,
                        'wl_notificationtimestamp' => null
                  ), __METHOD__, 'IGNORE' );

                $this->watched = true;

                wfProfileOut( __METHOD__ );
                return true;
        }

        public function removeWatch() {
                wfProfileIn( __METHOD__ );

                $success = false;
                $dbw = wfGetDB( DB_MASTER );
                $dbw->delete( 'watchlist',
                        array(
                                'wl_user' => $this->id,
                                'wl_namespace' => MWNamespace::getSubject($this->ns),
                                'wl_title' => $this->ti
                        ), __METHOD__
                );
                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' => MWNamespace::getTalk($this->ns),
                                'wl_title' => $this->ti
                        ), __METHOD__
                );

                if ( $dbw->affectedRows() ) {
                        $success = true;
                }

                $this->watched = false;

                wfProfileOut( __METHOD__ );
                return $success;
        }

        public static function duplicateEntries( $ot, $nt ) {
                WatchedItem::doDuplicateEntries( $ot->getSubjectPage(), $nt->getSubjectPage() );
                WatchedItem::doDuplicateEntries( $ot->getTalkPage(), $nt->getTalkPage() );
        }

        private static function doDuplicateEntries( $ot, $nt ) {
                $oldnamespace = $ot->getNamespace();
                $newnamespace = $nt->getNamespace();
                $oldtitle = $ot->getDBkey();
                $newtitle = $nt->getDBkey();

                $dbw = wfGetDB( DB_MASTER );
                $res = $dbw->select( 'watchlist', 'wl_user',
                        array( 'wl_namespace' => $oldnamespace, 'wl_title' => $oldtitle ),
                        __METHOD__, 'FOR UPDATE'
                );
                # Construct array to replace into the watchlist
                $values = array();
                foreach ( $res as $s ) {
                        $values[] = array(
                                'wl_user' => $s->wl_user,
                                'wl_namespace' => $newnamespace,
                                'wl_title' => $newtitle
                        );
                }

                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, __METHOD__ );
                return true;
        }
}