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