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 $user   = null;
  50     var $notice = null;
  51
  52     /**
  53      * Take arguments for running
  54      *
  55      * @param array $args $_REQUEST args
  56      *
  57      * @return boolean success flag
  58      *
  59      */
  60
  61     function prepare($args)
  62     {
  63         parent::prepare($args);
  64
  65         $this->user   = $this->auth_user;
  66         $this->notice = Notice::staticGet($this->arg('id'));
  67
  68         return true;
  69     }
  70
  71     /**
  72      * Handle the request
  73      *
  74      * Check the format and show the user info
  75      *
  76      * @param array $args $_REQUEST data (unused)
  77      *
  78      * @return void
  79      */
  80
  81     function handle($args)
  82     {
  83         parent::handle($args);
  84
  85         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  86             $this->clientError(
  87                 _('This method requires a POST.'),
  88                 400,
  89                 $this->format
  90             );
  91             return;
  92         }
  93
  94         if (!in_array($this->format, array('xml', 'json'))) {
  95             $this->clientError(
  96                 _('API method not found!'),
  97                 404,
  98                 $this->format
  99             );
 100             return;
 101         }
 102
 103         if (empty($this->notice)) {
 104             $this->clientError(
 105                 _('No status found with that ID.'),
 106                 404,
 107                 $this->format
 108             );
 109             return;
 110         }
 111
 112         // Note: Twitter lets you fave things repeatedly via API.
 113
 114         if ($this->user->hasFave($this->notice)) {
 115             $this->clientError(
 116                 _('This status is already a favorite!'),
 117                 403,
 118                 $this->format
 119             );
 120             return;
 121         }
 122
 123         $fave = Fave::addNew($this->user, $this->notice);
 124
 125         if (empty($fave)) {
 126             $this->clientError(
 127                 _('Could not create favorite.')
 128                 403,
 129                 $this->format
 130             );
 131             return;
 132         }
 133
 134         $this->notify($fave, $this->notice, $this->user);
 135         $this->user->blowFavesCache();
 136
 137         if ($this->format == 'xml') {
 138             $this->showSingleXmlStatus($this->notice);
 139         } elseif ($this->format == 'json') {
 140             $this->show_single_json_status($this->notice);
 141         }
 142     }
 143
 144
 145     /**
 146      * Notify the author of the favorite that the user likes their notice
 147      *
 148      * @param Favorite $fave   the favorite in question
 149      * @param Notice   $notice the notice that's been faved
 150      * @param User     $user   the user doing the favoriting
 151      *
 152      * @return void
 153      */
 154     function notify($fave, $notice, $user)
 155     {
 156         $other = User::staticGet('id', $notice->profile_id);
 157         if ($other && $other->id != $user->id) {
 158             if ($other->email && $other->emailnotifyfav) {
 159                 mail_notify_fave($other, $user, $notice);
 160             }
 161             // XXX: notify by IM
 162             // XXX: notify by SMS
 163         }
 164     }
 165
 166 }