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  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  29  * @link      http://status.net/
  30  */
  31
  32 if (!defined('STATUSNET')) {
  33     exit(1);
  34 }
  35
  36 require_once INSTALLDIR . '/lib/apiauth.php';
  37
  38 /**
  39  * Favorites the status specified in the ID parameter as the authenticating user.
  40  * Returns the favorite status when successful.
  41  *
  42  * @category API
  43  * @package  StatusNet
  44  * @author   Craig Andrews <candrews@integralblue.com>
  45  * @author   Evan Prodromou <evan@status.net>
  46  * @author   Zach Copley <zach@status.net>
  47  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  48  * @link     http://status.net/
  49  */
  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      */
  63
  64     function prepare($args)
  65     {
  66         parent::prepare($args);
  67
  68         $this->user   = $this->auth_user;
  69         $this->notice = Notice::staticGet($this->arg('id'));
  70
  71         return true;
  72     }
  73
  74     /**
  75      * Handle the request
  76      *
  77      * Check the format and show the user info
  78      *
  79      * @param array $args $_REQUEST data (unused)
  80      *
  81      * @return void
  82      */
  83
  84     function handle($args)
  85     {
  86         parent::handle($args);
  87
  88         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  89             $this->clientError(
  90                 _('This method requires a POST.'),
  91                 400,
  92                 $this->format
  93             );
  94             return;
  95         }
  96
  97         if (!in_array($this->format, array('xml', 'json'))) {
  98             $this->clientError(
  99                 _('API method not found.'),
 100                 404,
 101                 $this->format
 102             );
 103             return;
 104         }
 105
 106         if (empty($this->notice)) {
 107             $this->clientError(
 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                 _('This status is already a favorite.'),
 120                 403,
 121                 $this->format
 122             );
 123             return;
 124         }
 125
 126         $fave = Fave::addNew($this->user, $this->notice);
 127
 128         if (empty($fave)) {
 129             $this->clientError(
 130                 _('Could not create favorite.'),
 131                 403,
 132                 $this->format
 133             );
 134             return;
 135         }
 136
 137         $this->notify($fave, $this->notice, $this->user);
 138         $this->user->blowFavesCache();
 139
 140         if ($this->format == 'xml') {
 141             $this->showSingleXmlStatus($this->notice);
 142         } elseif ($this->format == 'json') {
 143             $this->show_single_json_status($this->notice);
 144         }
 145     }
 146
 147     /**
 148      * Notify the author of the favorite that the user likes their notice
 149      *
 150      * @param Favorite $fave   the favorite in question
 151      * @param Notice   $notice the notice that's been faved
 152      * @param User     $user   the user doing the favoriting
 153      *
 154      * @return void
 155      */
 156     function notify($fave, $notice, $user)
 157     {
 158         $other = User::staticGet('id', $notice->profile_id);
 159         if ($other && $other->id != $user->id) {
 160             if ($other->email && $other->emailnotifyfav) {
 161                 mail_notify_fave($other, $user, $notice);
 162             }
 163             // XXX: notify by IM
 164             // XXX: notify by SMS
 165         }
 166     }
 167
 168 }