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
  52 class ApiFavoriteDestroyAction extends ApiAuthAction
  53 {
  54
  55     var $notice = null;
  56
  57     /**
  58      * Take arguments for running
  59      *
  60      * @param array $args $_REQUEST args
  61      *
  62      * @return boolean success flag
  63      *
  64      */
  65
  66     function prepare($args)
  67     {
  68         parent::prepare($args);
  69
  70         $this->user   = $this->auth_user;
  71         $this->notice = Notice::staticGet($this->arg('id'));
  72
  73         return true;
  74     }
  75
  76     /**
  77      * Handle the request
  78      *
  79      * Check the format and show the user info
  80      *
  81      * @param array $args $_REQUEST data (unused)
  82      *
  83      * @return void
  84      */
  85
  86     function handle($args)
  87     {
  88         parent::handle($args);
  89
  90         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  91             $this->clientError(
  92                 // TRANS: Client error. POST is a HTTP command. It should not be translated.
  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         $fave            = new Fave();
 119         $fave->user_id   = $this->user->id;
 120         $fave->notice_id = $this->notice->id;
 121
 122         if (!$fave->find(true)) {
 123             $this->clientError(
 124                 _('That status is not a favorite.'),
 125                 403,
 126                 $this->favorite
 127             );
 128             return;
 129         }
 130
 131         $result = $fave->delete();
 132
 133         if (!$result) {
 134             common_log_db_error($fave, 'DELETE', __FILE__);
 135             $this->clientError(
 136                 _('Could not delete favorite.'),
 137                 404,
 138                 $this->format
 139             );
 140             return;
 141         }
 142
 143         $this->user->blowFavesCache();
 144
 145         if ($this->format == 'xml') {
 146             $this->showSingleXmlStatus($this->notice);
 147         } elseif ($this->format == 'json') {
 148             $this->show_single_json_status($this->notice);
 149         }
 150     }
 151
 152 }