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         if ($this->notice->repeat_of != '' ) {
  69                 common_log(LOG_DEBUG, 'Trying to Fave '.$this->notice->id.', repeat of '.$this->notice->repeat_of);
  70                 common_log(LOG_DEBUG, 'Will Fave '.$this->notice->repeat_of.' instead');
  71                 $real_notice_id = $this->notice->repeat_of;
  72                 $this->notice = Notice::staticGet($real_notice_id);
  73         }
  74
  75         return true;
  76     }
  77
  78     /**
  79      * Handle the request
  80      *
  81      * Check the format and show the user info
  82      *
  83      * @param array $args $_REQUEST data (unused)
  84      *
  85      * @return void
  86      */
  87     function handle($args)
  88     {
  89         parent::handle($args);
  90
  91         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  92             $this->clientError(
  93                 // TRANS: Client error. POST is a HTTP command. It should not be translated.
  94                 _('This method requires a POST.'),
  95                 400,
  96                 $this->format
  97             );
  98             return;
  99         }
 100
 101         if (!in_array($this->format, array('xml', 'json'))) {
 102             $this->clientError(
 103                 // TRANS: Client error displayed when coming across a non-supported API method.
 104                 _('API method not found.'),
 105                 404,
 106                 $this->format
 107             );
 108             return;
 109         }
 110
 111         if (empty($this->notice)) {
 112             $this->clientError(
 113                 // TRANS: Client error displayed when requesting a status with a non-existing ID.
 114                 _('No status found with that ID.'),
 115                 404,
 116                 $this->format
 117             );
 118             return;
 119         }
 120
 121         // Note: Twitter lets you fave things repeatedly via API.
 122
 123         if ($this->user->hasFave($this->notice)) {
 124             $this->clientError(
 125                 // TRANS: Client error displayed when trying to mark a notice favourite that already is a favourite.
 126                 _('This status is already a favorite.'),
 127                 403,
 128                 $this->format
 129             );
 130             return;
 131         }
 132
 133         $fave = Fave::addNew($this->user->getProfile(), $this->notice);
 134
 135         if (empty($fave)) {
 136             $this->clientError(
 137                 // TRANS: Client error displayed when marking a notice as favourite fails.
 138                 _('Could not create favorite.'),
 139                 403,
 140                 $this->format
 141             );
 142             return;
 143         }
 144
 145         $this->notify($fave, $this->notice, $this->user);
 146         $this->user->blowFavesCache();
 147
 148         if ($this->format == 'xml') {
 149             $this->showSingleXmlStatus($this->notice);
 150         } elseif ($this->format == 'json') {
 151             $this->show_single_json_status($this->notice);
 152         }
 153     }
 154
 155     /**
 156      * Notify the author of the favorite that the user likes their notice
 157      *
 158      * @param Favorite $fave   the favorite in question
 159      * @param Notice   $notice the notice that's been faved
 160      * @param User     $user   the user doing the favoriting
 161      *
 162      * @return void
 163      */
 164     function notify($fave, $notice, $user)
 165     {
 166         $other = User::staticGet('id', $notice->profile_id);
 167         if ($other && $other->id != $user->id) {
 168             if ($other->email && $other->emailnotifyfav) {
 169                 mail_notify_fave($other, $user, $notice);
 170             }
 171             // XXX: notify by IM
 172             // XXX: notify by SMS
 173         }
 174     }
 175 }