WatchedItem.php

Go to the documentation of this file.

<?php
class WatchedItem {
    const IGNORE_USER_RIGHTS = 0;

    const CHECK_USER_RIGHTS = 1;

    var $mTitle, $mUser, $mCheckRights;
    private $loaded = false, $watched, $timestamp;

    public static function fromUserTitle( $user, $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) {
        $wl = new WatchedItem;
        $wl->mUser = $user;
        $wl->mTitle = $title;
        $wl->mCheckRights = $checkRights;

        return $wl;
    }

    protected function getTitle() {
        return $this->mTitle;
    }

    protected function getTitleNs() {
        return $this->getTitle()->getNamespace();
    }

    protected function getTitleDBkey() {
        return $this->getTitle()->getDBkey();
    }

    protected function getUserId() {
        return $this->mUser->getId();
    }

    private function dbCond() {
        return array(
            'wl_user' => $this->getUserId(),
            'wl_namespace' => $this->getTitleNs(),
            'wl_title' => $this->getTitleDBkey(),
        );
    }

    private function load() {
        if ( $this->loaded ) {
            return;
        }
        $this->loaded = true;

        // Only loggedin user can have a watchlist
        if ( $this->mUser->isAnon() ) {
            $this->watched = false;
            return;
        }

        // some pages cannot be watched
        if ( !$this->getTitle()->isWatchable() ) {
            $this->watched = false;
            return;
        }

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

    private function isAllowed( $what ) {
        return !$this->mCheckRights || $this->mUser->isAllowed( $what );
    }

    public function isWatched() {
        if ( !$this->isAllowed( 'viewmywatchlist' ) ) {
            return false;
        }

        $this->load();
        return $this->watched;
    }

    public function getNotificationTimestamp() {
        if ( !$this->isAllowed( 'viewmywatchlist' ) ) {
            return false;
        }

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

    public function resetNotificationTimestamp( $force = '', $oldid = 0 ) {
        // Only loggedin user can have a watchlist
        if ( wfReadOnly() || $this->mUser->isAnon() || !$this->isAllowed( 'editmywatchlist' ) ) {
            return;
        }

        if ( $force != 'force' ) {
            $this->load();
            if ( !$this->watched || $this->timestamp === null ) {
                return;
            }
        }

        $title = $this->getTitle();
        if ( !$oldid ) {
            // No oldid given, assuming latest revision; clear the timestamp.
            $notificationTimestamp = null;
        } elseif ( !$title->getNextRevisionID( $oldid ) ) {
            // Oldid given and is the latest revision for this title; clear the timestamp.
            $notificationTimestamp = null;
        } else {
            // See if the version marked as read is more recent than the one we're viewing.
            // Call load() if it wasn't called before due to $force.
            $this->load();

            if ( $this->timestamp === null ) {
                // This can only happen if $force is enabled.
                $notificationTimestamp = null;
            } else {
                // Oldid given and isn't the latest; update the timestamp.
                // This will result in no further notification emails being sent!
                $dbr = wfGetDB( DB_SLAVE );
                $notificationTimestamp = $dbr->selectField(
                    'revision', 'rev_timestamp',
                    array( 'rev_page' => $title->getArticleID(), 'rev_id' => $oldid )
                );
                // We need to go one second to the future because of various strict comparisons
                // throughout the codebase
                $ts = new MWTimestamp( $notificationTimestamp );
                $ts->timestamp->add( new DateInterval( 'PT1S' ) );
                $notificationTimestamp = $ts->getTimestamp( TS_MW );

                if ( $notificationTimestamp < $this->timestamp ) {
                    if ( $force != 'force' ) {
                        return;
                    } else {
                        // This is a little silly…
                        $notificationTimestamp = $this->timestamp;
                    }
                }
            }
        }

        // 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' => $notificationTimestamp ),
            $this->dbCond(), __METHOD__ );
        $this->timestamp = null;
    }

    public function addWatch() {
        wfProfileIn( __METHOD__ );

        // Only loggedin user can have a watchlist
        if ( wfReadOnly() || $this->mUser->isAnon() || !$this->isAllowed( 'editmywatchlist' ) ) {
            wfProfileOut( __METHOD__ );
            return false;
        }

        // 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->getUserId(),
                'wl_namespace' => MWNamespace::getSubject( $this->getTitleNs() ),
                'wl_title' => $this->getTitleDBkey(),
                '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->getUserId(),
                'wl_namespace' => MWNamespace::getTalk( $this->getTitleNs() ),
                'wl_title' => $this->getTitleDBkey(),
                'wl_notificationtimestamp' => null
            ), __METHOD__, 'IGNORE' );

        $this->watched = true;

        wfProfileOut( __METHOD__ );
        return true;
    }

    public function removeWatch() {
        wfProfileIn( __METHOD__ );

        // Only loggedin user can have a watchlist
        if ( wfReadOnly() || $this->mUser->isAnon() || !$this->isAllowed( 'editmywatchlist' ) ) {
            wfProfileOut( __METHOD__ );
            return false;
        }

        $success = false;
        $dbw = wfGetDB( DB_MASTER );
        $dbw->delete( 'watchlist',
            array(
                'wl_user' => $this->getUserId(),
                'wl_namespace' => MWNamespace::getSubject( $this->getTitleNs() ),
                'wl_title' => $this->getTitleDBkey(),
            ), __METHOD__
        );
        if ( $dbw->affectedRows() ) {
            $success = true;
        }

        # the following code compensates the new behavior, 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->getUserId(),
                'wl_namespace' => MWNamespace::getTalk( $this->getTitleNs() ),
                'wl_title' => $this->getTitleDBkey(),
            ), __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;
    }
}