diff options
Diffstat (limited to 'includes/WatchedItem.php')
| -rw-r--r-- | includes/WatchedItem.php | 190 |
1 files changed, 190 insertions, 0 deletions
diff --git a/includes/WatchedItem.php b/includes/WatchedItem.php new file mode 100644 index 00000000..3885bb98 --- /dev/null +++ b/includes/WatchedItem.php @@ -0,0 +1,190 @@ +<?php +/** + * + * @package MediaWiki + */ + +/** + * + * @package MediaWiki + */ +class WatchedItem { + var $mTitle, $mUser; + + /** + * Create a WatchedItem object with the given user and title + * @todo document + * @access private + */ + 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; + } + + /** + * 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? + */ + 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 ); + $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 + */ + 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 & ~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() { + global $wgMemc; + $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; + } + if ( $success ) { + $wgMemc->set( $this->watchkey(), 0 ); + } + 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 Title $ot Page title to duplicate entries from, if present + * @param Title $nt Page title to add watches on + * @static + */ + function duplicateEntries( $ot, $nt ) { + WatchedItem::doDuplicateEntries( $ot->getSubjectPage(), $nt->getSubjectPage() ); + WatchedItem::doDuplicateEntries( $ot->getTalkPage(), $nt->getTalkPage() ); + } + + /** + * @static + * @access private + */ + function doDuplicateEntries( $ot, $nt ) { + $fname = "WatchedItem::duplicateEntries"; + $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 ), + $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 + ); + } + $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; + } + + +} + +?> |