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