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