<?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 );
- $res = $dbr->select( 'watchlist', 1, array( 'wl_user' => $this->id, 'wl_namespace' => $this->ns,
- 'wl_title' => $this->ti ), $fname );
+
+ $dbr = wfGetDB( DB_SLAVE );
+ $res = $dbr->select( 'watchlist', 1, array( 'wl_user' => $this->id, 'wl_namespace' => $this->ns,
+ 'wl_title' => $this->ti ), __METHOD__ );
$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() {
- $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')),
- array(
- 'wl_user' => $this->id,
- 'wl_namespace' => ($this->ns & ~1),
+ 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' => '0'
- ), $fname );
+ 'wl_notificationtimestamp' => NULL
+ ), __METHOD__, '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_namespace' => MWNamespace::getTalk($this->ns),
'wl_title' => $this->ti,
- 'wl_notificationtimestamp' => '0'
- ), $fname );
+ 'wl_notificationtimestamp' => NULL
+ ), __METHOD__, 'IGNORE' );
- global $wgMemc;
- $wgMemc->set( $this->watchkey(), 1 );
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
return true;
}
- function removeWatch() {
- global $wgMemc;
- $fname = 'WatchedItem::removeWatch';
-
+ /**
+ * Same as addWatch, only the opposite.
+ * @return bool
+ */
+ public function removeWatch() {
$success = false;
- $dbw =& wfGetDB( DB_MASTER );
- $dbw->delete( 'watchlist',
- array(
- 'wl_user' => $this->id,
- 'wl_namespace' => ($this->ns & ~1),
+ $dbw = wfGetDB( DB_MASTER );
+ $dbw->delete( 'watchlist',
+ array(
+ 'wl_user' => $this->id,
+ 'wl_namespace' => MWNamespace::getSubject($this->ns),
'wl_title' => $this->ti
- ), $fname
+ ), __METHOD__
);
if ( $dbw->affectedRows() ) {
$success = true;
$dbw->delete( 'watchlist',
array(
'wl_user' => $this->id,
- 'wl_namespace' => ($this->ns | 1),
+ 'wl_namespace' => MWNamespace::getTalk($this->ns),
'wl_title' => $this->ti
- ), $fname
+ ), __METHOD__
);
-
+
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
+ * @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() );
}
-
+
/**
- * @static
- * @access private
+ * Handle duplicate entries. Backend for duplicateEntries().
*/
- function doDuplicateEntries( $ot, $nt ) {
- $fname = "WatchedItem::duplicateEntries";
- global $wgMemc, $wgDBname;
+ private static function doDuplicateEntries( $ot, $nt ) {
$oldnamespace = $ot->getNamespace();
$newnamespace = $nt->getNamespace();
$oldtitle = $ot->getDBkey();
$newtitle = $nt->getDBkey();
- $dbw =& wfGetDB( DB_MASTER );
- $watchlist = $dbw->tableName( 'watchlist' );
-
- $res = $dbw->select( 'watchlist', 'wl_user',
+ $dbw = wfGetDB( DB_MASTER );
+ $res = $dbw->select( 'watchlist', 'wl_user',
array( 'wl_namespace' => $oldnamespace, 'wl_title' => $oldtitle ),
- $fname, 'FOR UPDATE'
+ __METHOD__, 'FOR UPDATE'
);
# Construct array to replace into the watchlist
$values = array();
);
}
$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 );
+ $dbw->replace( 'watchlist', array( array( 'wl_user', 'wl_namespace', 'wl_title' ) ), $values, __METHOD__ );
return true;
}
-
-
}
-
-?>
scripts.mit.edu / autoinstallsdev / mediawiki.git / blobdiff