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    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  * Un-favorites the status specified in the ID parameter as the authenticating user.
  38  * Returns the un-favorited status in the requested format 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 ApiFavoriteDestroyAction extends ApiAuthAction
  48 {
  49
  50     var $user   = null;
  51     var $notice = null;
  52
  53     /**
  54      * Take arguments for running
  55      *
  56      * @param array $args $_REQUEST args
  57      *
  58      * @return boolean success flag
  59      *
  60      */
  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
  69         return true;
  70     }
  71
  72     /**
  73      * Handle the request
  74      *
  75      * Check the format and show the user info
  76      *
  77      * @param array $args $_REQUEST data (unused)
  78      *
  79      * @return void
  80      */
  81
  82     function handle($args)
  83     {
  84         parent::handle($args);
  85
  86         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  87             $this->clientError(
  88                 _('This method requires a POST.'),
  89                 400,
  90                 $this->format
  91             );
  92             return;
  93         }
  94
  95         if (!in_array($this->format, array('xml', 'json'))) {
  96             $this->clientError(
  97                 _('API method not found!'),
  98                 404,
  99                 $this->format
 100             );
 101             return;
 102         }
 103
 104         if (empty($this->notice)) {
 105             $this->clientError(
 106                 _('No status found with that ID.'),
 107                 404,
 108                 $this->format
 109             );
 110             return;
 111         }
 112
 113         $fave            = new Fave();
 114         $fave->user_id   = $this->user->id;
 115         $fave->notice_id = $this->notice->id;
 116
 117         if (!$fave->find(true)) {
 118             $this->clientError(
 119                 _('That status is not a favorite!'),
 120                 403,
 121                 $this->favorite
 122             );
 123             return;
 124         }
 125
 126         $result = $fave->delete();
 127
 128         if (!$result) {
 129             common_log_db_error($fave, 'DELETE', __FILE__);
 130             $this->clientError(
 131                 _('Could not delete favorite.'),
 132                 404,
 133                 $this->format
 134             );
 135             return;
 136         }
 137
 138         $this->user->blowFavesCache();
 139
 140         if ($this->format == 'xml') {
 141             $this->show_single_xml_status($this->notice);
 142         } elseif ($this->format == 'json') {
 143             $this->show_single_json_status($this->notice);
 144         }
 145     }
 146
 147 }