actions/apifavoritecreate.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Add a notice to a user's list of favorite notices via the API
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  API
  23  * @package   StatusNet
  24  * @author    Craig Andrews <candrews@integralblue.com>
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @author    Zach Copley <zach@status.net>
  27  * @copyright 2009 StatusNet, Inc.
  28  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  29  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  30  * @link      http://status.net/
  31  */
  32
  33 if (!defined('STATUSNET')) {
  34     exit(1);
  35 }
  36
  37 require_once INSTALLDIR . '/lib/apiauth.php';
  38
  39 /**
  40  * Favorites the status specified in the ID parameter as the authenticating user.
  41  * Returns the favorite status when successful.
  42  *
  43  * @category API
  44  * @package  StatusNet
  45  * @author   Craig Andrews <candrews@integralblue.com>
  46  * @author   Evan Prodromou <evan@status.net>
  47  * @author   Zach Copley <zach@status.net>
  48  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  49  * @link     http://status.net/
  50  */
  51 class ApiFavoriteCreateAction extends ApiAuthAction
  52 {
  53     var $notice = null;
  54
  55     /**
  56      * Take arguments for running
  57      *
  58      * @param array $args $_REQUEST args
  59      *
  60      * @return boolean success flag
  61      */
  62     function prepare($args)
  63     {
  64         parent::prepare($args);
  65
  66         $this->user   = $this->auth_user;
  67         $this->notice = Notice::staticGet($this->arg('id'));
  68
  69         return true;
  70     }
  71
  72     /**
  73      * Handle the request
  74      *
  75      * Check the format and show the user info
  76      *
  77      * @param array $args $_REQUEST data (unused)
  78      *
  79      * @return void
  80      */
  81     function handle($args)
  82     {
  83         parent::handle($args);
  84
  85         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  86             $this->clientError(
  87                 // TRANS: Client error. POST is a HTTP command. It should not be translated.
  88                 _('This method requires a POST.'),
  89                 400,
  90                 $this->format
  91             );
  92             return;
  93         }
  94
  95         if (!in_array($this->format, array('xml', 'json'))) {
  96             $this->clientError(
  97                 // TRANS: Client error displayed when coming across a non-supported API method.
  98                 _('API method not found.'),
  99                 404,
 100                 $this->format
 101             );
 102             return;
 103         }
 104
 105         if (empty($this->notice)) {
 106             $this->clientError(
 107                 // TRANS: Client error displayed when requesting a status with a non-existing ID.
 108                 _('No status found with that ID.'),
 109                 404,
 110                 $this->format
 111             );
 112             return;
 113         }
 114
 115         // Note: Twitter lets you fave things repeatedly via API.
 116
 117         if ($this->user->hasFave($this->notice)) {
 118             $this->clientError(
 119                 // TRANS: Client error displayed when trying to mark a notice favourite that already is a favourite.
 120                 _('This status is already a favorite.'),
 121                 403,
 122                 $this->format
 123             );
 124             return;
 125         }
 126
 127         $fave = Fave::addNew($this->user->getProfile(), $this->notice);
 128
 129         if (empty($fave)) {
 130             $this->clientError(
 131                 // TRANS: Client error displayed when marking a notice as favourite fails.
 132                 _('Could not create favorite.'),
 133                 403,
 134                 $this->format
 135             );
 136             return;
 137         }
 138
 139         $this->notify($fave, $this->notice, $this->user);
 140         $this->user->blowFavesCache();
 141
 142         if ($this->format == 'xml') {
 143             $this->showSingleXmlStatus($this->notice);
 144         } elseif ($this->format == 'json') {
 145             $this->show_single_json_status($this->notice);
 146         }
 147     }
 148
 149     /**
 150      * Notify the author of the favorite that the user likes their notice
 151      *
 152      * @param Favorite $fave   the favorite in question
 153      * @param Notice   $notice the notice that's been faved
 154      * @param User     $user   the user doing the favoriting
 155      *
 156      * @return void
 157      */
 158     function notify($fave, $notice, $user)
 159     {
 160         $other = User::staticGet('id', $notice->profile_id);
 161         if ($other && $other->id != $user->id) {
 162             if ($other->email && $other->emailnotifyfav) {
 163                 mail_notify_fave($other, $user, $notice);
 164             }
 165             // XXX: notify by IM
 166             // XXX: notify by SMS
 167         }
 168     }
 169 }