actions/apifavoritedestroy.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Remote a notice from 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  * Un-favorites the status specified in the ID parameter as the authenticating user.
  41  * Returns the un-favorited status in the requested format 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 class ApiFavoriteDestroyAction 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     function prepare($args)
  63     {
  64         parent::prepare($args);
  65
  66         $this->user   = $this->auth_user;
  67         $this->notice = Notice::staticGet($this->arg('id'));
  68         if ($this->notice->repeat_of != '' ) {
  69                 common_log(LOG_DEBUG, 'Trying to unFave '.$this->notice->id);
  70                 common_log(LOG_DEBUG, 'Will unFave '.$this->notice->repeat_of.' instead');
  71                 $real_notice_id = $this->notice->repeat_of;
  72                 $this->notice = Notice::staticGet($real_notice_id);
  73         }
  74
  75         return true;
  76     }
  77
  78     /**
  79      * Handle the request
  80      *
  81      * Check the format and show the user info
  82      *
  83      * @param array $args $_REQUEST data (unused)
  84      *
  85      * @return void
  86      */
  87     function handle($args)
  88     {
  89         parent::handle($args);
  90
  91         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  92             $this->clientError(
  93                 // TRANS: Client error. POST is a HTTP command. It should not be translated.
  94                 _('This method requires a POST.'),
  95                 400,
  96                 $this->format
  97             );
  98             return;
  99         }
 100
 101         if (!in_array($this->format, array('xml', 'json'))) {
 102             $this->clientError(
 103                 // TRANS: Client error displayed when coming across a non-supported API method.
 104                 _('API method not found.'),
 105                 404,
 106                 $this->format
 107             );
 108             return;
 109         }
 110
 111         if (empty($this->notice)) {
 112             $this->clientError(
 113                 // TRANS: Client error displayed when trying to remove a favourite with an invalid ID.
 114                 _('No status found with that ID.'),
 115                 404,
 116                 $this->format
 117             );
 118             return;
 119         }
 120
 121         $fave            = new Fave();
 122         $fave->user_id   = $this->user->id;
 123         $fave->notice_id = $this->notice->id;
 124
 125         if (!$fave->find(true)) {
 126             $this->clientError(
 127                 // TRANS: Client error displayed when trying to remove a favourite that was not a favourite.
 128                 _('That status is not a favorite.'),
 129                 403,
 130                 $this->favorite
 131             );
 132             return;
 133         }
 134
 135         $result = $fave->delete();
 136
 137         if (!$result) {
 138             common_log_db_error($fave, 'DELETE', __FILE__);
 139             $this->clientError(
 140                 // TRANS: Client error displayed when removing a favourite has failed.
 141                 _('Could not delete favorite.'),
 142                 404,
 143                 $this->format
 144             );
 145             return;
 146         }
 147
 148         $this->user->blowFavesCache();
 149
 150         if ($this->format == 'xml') {
 151             $this->showSingleXmlStatus($this->notice);
 152         } elseif ($this->format == 'json') {
 153             $this->show_single_json_status($this->notice);
 154         }
 155     }
 156 }