* Add/update translator documentation.

[quix0rs-gnu-social.git] / actions / favor.php

diff --git a/actions/favor.php b/actions/favor.php
index afda93cff29ae109c81a6e287ad797934f7d7814..bcefcd26e70c21f7ce22f4c91651e035e557f4eb 100644 (file)
--- a/actions/favor.php
+++ b/actions/favor.php
@@ -1,7 +1,18 @@
 <?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
@@ -17,81 +28,101 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+    exit(1);
+}
 
-require_once(INSTALLDIR.'/lib/mail.php');
+require_once INSTALLDIR.'/lib/mail.php';
+require_once INSTALLDIR.'/lib/disfavorform.php';
 
+/**
+ * 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)));
+            common_redirect(common_local_url('showfavorites',
+                array('nickname' => $user->nickname)));
             return;
         }
-
-        $id = $this->trimmed('notice');
-
+        $id     = $this->trimmed('notice');
         $notice = Notice::staticGet($id);
-
-        # CSRF protection
-
-        $token = $this->trimmed('token-'.$notice->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."));
+            $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, $notice);
-
+        $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($fave, $notice, $user);
+        $this->notify($notice, $user);
         $user->blowFavesCache();
-        
         if ($this->boolean('ajax')) {
-            $this->startHTML('text/xml;charset=utf-8', true);
+            $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');
-            common_disfavor_form($notice);
+            $disfavor = new DisFavorForm($this, $notice);
+            $disfavor->show();
             $this->elementEnd('body');
             $this->elementEnd('html');
         } else {
             common_redirect(common_local_url('showfavorites',
-                                             array('nickname' => $user->nickname)));
+                                             array('nickname' => $user->nickname)),
+                            303);
         }
     }
 
-    function notify($fave, $notice, $user)
+    /**
+     * 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
+            // XXX: notify by IM
+            // XXX: notify by SMS
         }
     }
-
 }