<?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * Favor action.
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
+ * @author Robin Millette <millette@status.net>
+ * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link http://status.net/
+ *
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2008, 2009, StatusNet, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-if (!defined('LACONICA')) { exit(1); }
-
-require_once(INSTALLDIR.'/lib/mail.php');
-
-class FavorAction extends Action {
-
- function handle($args) {
- parent::handle($args);
-
- if (!common_logged_in()) {
- common_user_error(_('Not logged in.'));
- return;
- }
-
- $user = common_current_user();
-
- if ($_SERVER['REQUEST_METHOD'] != 'POST') {
- common_redirect(common_local_url('showfavorites', array('nickname' => $user->nickname)));
- return;
- }
-
- # CSRF protection
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+ exit(1);
+}
- $token = $this->trimmed('token');
- if (!$token || $token != common_session_token()) {
- $this->client_error(_('There was a problem with your session token. Try again, please.'));
- return;
- }
- $id = $this->trimmed('notice');
+require_once INSTALLDIR.'/lib/mail.php';
+require_once INSTALLDIR.'/lib/disfavorform.php';
- $notice = Notice::staticGet($id);
-
- if ($user->hasFave($notice)) {
- $this->client_error(_('This notice is already a favorite!'));
- return;
- }
-
- $fave = Fave::addNew($user, $notice);
-
- if (!$fave) {
- $this->server_error(_('Could not create favorite.'));
- return;
- }
-
- $this->notify($fave, $notice, $user);
-
- if ($this->boolean('ajax')) {
- common_start_html('text/xml');
- common_element_start('head');
- common_element('title', _('Disfavor'));
- common_element_end('head');
- common_element_start('body');
- common_disfavor_form($notice);
- common_element_end('body');
- common_element_end('html');
- } else {
- common_redirect(common_local_url('showfavorites',
- array('nickname' => $user->nickname)));
- }
- }
-
- function notify($fave, $notice, $user) {
- $other = User::staticGet('id', $notice->profile_id);
- if ($other) {
- if ($other->email && $other->emailnotifyfav) {
- $this->notify_mail($other, $user, $notice);
- }
- # XXX: notify by IM
- # XXX: notify by SMS
- }
- }
-
- function notify_mail($other, $user, $notice) {
- $profile = $user->getProfile();
- $bestname = $profile->getBestName();
- $subject = sprintf(_('%s added your notice as a favorite'), $bestname);
- $body = sprintf(_('%1$s just added your notice from %2$s as one of their favorites.\n\n' .
- 'In case you forgot, you can see the text of your notice here:\n\n' .
- '%3$s\n\n' .
- 'You can see the list of %1$s\'s favorites here:\n\n' .
- '%4$s\n\n' .
- 'Faithfully yours,\n' .
- '%5$s\n'),
- $bestname,
- common_exact_date($notice->created),
- common_local_url('shownotice', array('notice' => $notice->id)),
- common_local_url('showfavorites', array('nickname' => $user->nickname)),
- common_config('site', 'name'));
-
- mail_to_user($other, $subject, $body);
- }
-}
\ No newline at end of file
+/**
+ * Favor class.
+ *
+ * @category Action
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
+ * @author Robin Millette <millette@status.net>
+ * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link http://status.net/
+ */
+class FavorAction extends Action
+{
+ /**
+ * Class handler.
+ *
+ * @param array $args query arguments
+ *
+ * @return void
+ */
+ function handle($args)
+ {
+ parent::handle($args);
+ if (!common_logged_in()) {
+ // TRANS: Client error displayed when trying to mark a notice as favorite without being logged in.
+ $this->clientError(_('Not logged in.'));
+ return;
+ }
+ $user = common_current_user();
+ if ($_SERVER['REQUEST_METHOD'] != 'POST') {
+ common_redirect(common_local_url('showfavorites',
+ array('nickname' => $user->nickname)));
+ return;
+ }
+ $id = $this->trimmed('notice');
+ $notice = Notice::staticGet($id);
+ $token = $this->trimmed('token-'.$notice->id);
+ if (!$token || $token != common_session_token()) {
+ $this->clientError(_('There was a problem with your session token. Try again, please.'));
+ return;
+ }
+ if ($user->hasFave($notice)) {
+ // TRANS: Client error displayed when trying to mark a notice as favorite that already is a favorite.
+ $this->clientError(_('This notice is already a favorite!'));
+ return;
+ }
+ $fave = Fave::addNew($user->getProfile(), $notice);
+ if (!$fave) {
+ // TRANS: Server error displayed when trying to mark a notice as favorite fails in the database.
+ $this->serverError(_('Could not create favorite.'));
+ return;
+ }
+ $this->notify($notice, $user);
+ $user->blowFavesCache();
+ if ($this->boolean('ajax')) {
+ $this->startHTML('text/xml;charset=utf-8');
+ $this->elementStart('head');
+ // TRANS: Page title for page on which favorite notices can be unfavourited.
+ $this->element('title', null, _('Disfavor favorite'));
+ $this->elementEnd('head');
+ $this->elementStart('body');
+ $disfavor = new DisFavorForm($this, $notice);
+ $disfavor->show();
+ $this->elementEnd('body');
+ $this->elementEnd('html');
+ } else {
+ common_redirect(common_local_url('showfavorites',
+ array('nickname' => $user->nickname)),
+ 303);
+ }
+ }
+
+ /**
+ * Notifies a user when their notice is favorited.
+ *
+ * @param class $notice favorited notice
+ * @param class $user user declaring a favorite
+ *
+ * @return void
+ */
+ function notify($notice, $user)
+ {
+ $other = User::staticGet('id', $notice->profile_id);
+ if ($other && $other->id != $user->id) {
+ if ($other->email && $other->emailnotifyfav) {
+ mail_notify_fave($other, $user, $notice);
+ }
+ // XXX: notify by IM
+ // XXX: notify by SMS
+ }
+ }
+}