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    Zach Copley <zach@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/lib/apiauth.php';
  35
  36 /**
  37  * Favorites the status specified in the ID parameter as the authenticating user.
  38  * Returns the favorite status when successful.
  39  *
  40  * @category API
  41  * @package  StatusNet
  42  * @author   Zach Copley <zach@status.net>
  43  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  44  * @link     http://status.net/
  45  */
  46
  47 class ApiFavoriteCreateAction extends ApiAuthAction
  48 {
  49     var $notice = null;
  50
  51     /**
  52      * Take arguments for running
  53      *
  54      * @param array $args $_REQUEST args
  55      *
  56      * @return boolean success flag
  57      *
  58      */
  59
  60     function prepare($args)
  61     {
  62         parent::prepare($args);
  63
  64         $this->user   = $this->auth_user;
  65         $this->notice = Notice::staticGet($this->arg('id'));
  66
  67         return true;
  68     }
  69
  70     /**
  71      * Handle the request
  72      *
  73      * Check the format and show the user info
  74      *
  75      * @param array $args $_REQUEST data (unused)
  76      *
  77      * @return void
  78      */
  79
  80     function handle($args)
  81     {
  82         parent::handle($args);
  83
  84         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  85             $this->clientError(
  86                 _('This method requires a POST.'),
  87                 400,
  88                 $this->format
  89             );
  90             return;
  91         }
  92
  93         if (!in_array($this->format, array('xml', 'json'))) {
  94             $this->clientError(
  95                 _('API method not found!'),
  96                 404,
  97                 $this->format
  98             );
  99             return;
 100         }
 101
 102         if (empty($this->notice)) {
 103             $this->clientError(
 104                 _('No status found with that ID.'),
 105                 404,
 106                 $this->format
 107             );
 108             return;
 109         }
 110
 111         // Note: Twitter lets you fave things repeatedly via API.
 112
 113         if ($this->user->hasFave($this->notice)) {
 114             $this->clientError(
 115                 _('This status is already a favorite!'),
 116                 403,
 117                 $this->format
 118             );
 119             return;
 120         }
 121
 122         $fave = Fave::addNew($this->user, $this->notice);
 123
 124         if (empty($fave)) {
 125             $this->clientError(
 126                 _('Could not create favorite.')
 127                 403,
 128                 $this->format
 129             );
 130             return;
 131         }
 132
 133         $this->notify($fave, $this->notice, $this->user);
 134         $this->user->blowFavesCache();
 135
 136         if ($this->format == 'xml') {
 137             $this->showSingleXmlStatus($this->notice);
 138         } elseif ($this->format == 'json') {
 139             $this->show_single_json_status($this->notice);
 140         }
 141     }
 142
 143     /**
 144      * Notify the author of the favorite that the user likes their notice
 145      *
 146      * @param Favorite $fave   the favorite in question
 147      * @param Notice   $notice the notice that's been faved
 148      * @param User     $user   the user doing the favoriting
 149      *
 150      * @return void
 151      */
 152     function notify($fave, $notice, $user)
 153     {
 154         $other = User::staticGet('id', $notice->profile_id);
 155         if ($other && $other->id != $user->id) {
 156             if ($other->email && $other->emailnotifyfav) {
 157                 mail_notify_fave($other, $user, $notice);
 158             }
 159             // XXX: notify by IM
 160             // XXX: notify by SMS
 161         }
 162     }
 163
 164 }