summaryrefslogtreecommitdiff
path: root/includes/actions/WatchAction.php
diff options
context:
space:
mode:
authorPierre Schmitz <pierre@archlinux.de>2011-12-03 13:29:22 +0100
committerPierre Schmitz <pierre@archlinux.de>2011-12-03 13:29:22 +0100
commitca32f08966f1b51fcb19460f0996bb0c4048e6fe (patch)
treeec04cc15b867bc21eedca904cea9af0254531a11 /includes/actions/WatchAction.php
parenta22fbfc60f36f5f7ee10d5ae6fe347340c2ee67c (diff)
Update to MediaWiki 1.18.0
* also update ArchLinux skin to chagnes in MonoBook * Use only css to hide our menu bar when printing
Diffstat (limited to 'includes/actions/WatchAction.php')
-rw-r--r--includes/actions/WatchAction.php183
1 files changed, 183 insertions, 0 deletions
diff --git a/includes/actions/WatchAction.php b/includes/actions/WatchAction.php
new file mode 100644
index 00000000..52e66754
--- /dev/null
+++ b/includes/actions/WatchAction.php
@@ -0,0 +1,183 @@
+<?php
+/**
+ * Performs the watch and unwatch actions on a page
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ *
+ * @file
+ * @ingroup Actions
+ */
+
+class WatchAction extends FormAction {
+
+ public function getName() {
+ return 'watch';
+ }
+
+ public function getRestriction() {
+ return 'read';
+ }
+
+ public function requiresUnblock() {
+ return false;
+ }
+
+ protected function getDescription() {
+ return wfMsg( 'addwatch' );
+ }
+
+ /**
+ * Just get an empty form with a single submit button
+ * @return array
+ */
+ protected function getFormFields() {
+ return array();
+ }
+
+ public function onSubmit( $data ) {
+ wfProfileIn( __METHOD__ );
+ self::doWatch( $this->getTitle(), $this->getUser() );
+ wfProfileOut( __METHOD__ );
+ return true;
+ }
+
+ /**
+ * This can be either formed or formless depending on the session token given
+ */
+ public function show() {
+ $this->setHeaders();
+
+ $user = $this->getUser();
+ // This will throw exceptions if there's a problem
+ $this->checkCanExecute( $user );
+
+ // Must have valid token for this action/title
+ $salt = array( $this->getName(), $this->getTitle()->getDBkey() );
+
+ if ( $user->matchEditToken( $this->getRequest()->getVal( 'token' ), $salt ) ) {
+ $this->onSubmit( array() );
+ $this->onSuccess();
+ } else {
+ $form = $this->getForm();
+ if ( $form->show() ) {
+ $this->onSuccess();
+ }
+ }
+ }
+
+ protected function checkCanExecute( User $user ) {
+ // Must be logged in
+ if ( $user->isAnon() ) {
+ throw new ErrorPageError( 'watchnologin', 'watchnologintext' );
+ }
+
+ return parent::checkCanExecute( $user );
+ }
+
+ public static function doWatch( Title $title, User $user ) {
+ $page = new Article( $title, 0 );
+
+ if ( wfRunHooks( 'WatchArticle', array( &$user, &$page ) ) ) {
+ $user->addWatch( $title );
+ wfRunHooks( 'WatchArticleComplete', array( &$user, &$page ) );
+ }
+ return true;
+ }
+
+ public static function doUnwatch( Title $title, User $user ) {
+ $page = new Article( $title, 0 );
+
+ if ( wfRunHooks( 'UnwatchArticle', array( &$user, &$page ) ) ) {
+ $user->removeWatch( $title );
+ wfRunHooks( 'UnwatchArticleComplete', array( &$user, &$page ) );
+ }
+ return true;
+ }
+
+ /**
+ * Get token to watch (or unwatch) a page for a user
+ *
+ * @param Title $title Title object of page to watch
+ * @param User $title User for whom the action is going to be performed
+ * @param string $action Optionally override the action to 'unwatch'
+ * @return string Token
+ * @since 1.18
+ */
+ public static function getWatchToken( Title $title, User $user, $action = 'watch' ) {
+ if ( $action != 'unwatch' ) {
+ $action = 'watch';
+ }
+ $salt = array( $action, $title->getDBkey() );
+
+ // This token stronger salted and not compatible with ApiWatch
+ // It's title/action specific because index.php is GET and API is POST
+ return $user->editToken( $salt );
+ }
+
+ /**
+ * Get token to unwatch (or watch) a page for a user
+ *
+ * @param Title $title Title object of page to unwatch
+ * @param User $title User for whom the action is going to be performed
+ * @param string $action Optionally override the action to 'watch'
+ * @return string Token
+ * @since 1.18
+ */
+ public static function getUnwatchToken( Title $title, User $user, $action = 'unwatch' ) {
+ return self::getWatchToken( $title, $user, $action );
+ }
+
+ protected function alterForm( HTMLForm $form ) {
+ $form->setSubmitText( wfMsg( 'confirm-watch-button' ) );
+ }
+
+ protected function preText() {
+ return wfMessage( 'confirm-watch-top' )->parse();
+ }
+
+ public function onSuccess() {
+ $this->getOutput()->addWikiMsg( 'addedwatchtext', $this->getTitle()->getPrefixedText() );
+ }
+}
+
+class UnwatchAction extends WatchAction {
+
+ public function getName() {
+ return 'unwatch';
+ }
+
+ protected function getDescription() {
+ return wfMsg( 'removewatch' );
+ }
+
+ public function onSubmit( $data ) {
+ wfProfileIn( __METHOD__ );
+ self::doUnwatch( $this->getTitle(), $this->getUser() );
+ wfProfileOut( __METHOD__ );
+ return true;
+ }
+
+ protected function alterForm( HTMLForm $form ) {
+ $form->setSubmitText( wfMsg( 'confirm-unwatch-button' ) );
+ }
+
+ protected function preText() {
+ return wfMessage( 'confirm-unwatch-top' )->parse();
+ }
+
+ public function onSuccess() {
+ $this->getOutput()->addWikiMsg( 'removedwatchtext', $this->getTitle()->getPrefixedText() );
+ }
+}