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         if ($this->requiresAuth()) {
  67             if ($this->checkBasicAuthUser() == false) {
  68                 return;
  69             }
  70         }
  71
  72         $this->user   = $this->auth_user;
  73         $this->notice = Notice::staticGet($this->arg('id'));
  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
  88     function handle($args)
  89     {
  90         parent::handle($args);
  91
  92         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  93             $this->clientError(
  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                 _('API method not found!'),
 104                 404,
 105                 $this->format
 106             );
 107             return;
 108         }
 109
 110         if (empty($this->notice)) {
 111             $this->clientError(
 112                 _('No status found with that ID.'),
 113                 404,
 114                 $this->format
 115             );
 116             return;
 117         }
 118
 119         $fave            = new Fave();
 120         $fave->user_id   = $this->user->id;
 121         $fave->notice_id = $this->notice->id;
 122
 123         if (!$fave->find(true)) {
 124             $this->clientError(
 125                 _('That status is not a favorite!'),
 126                 403,
 127                 $this->favorite
 128             );
 129             return;
 130         }
 131
 132         $result = $fave->delete();
 133
 134         if (!$result) {
 135             common_log_db_error($fave, 'DELETE', __FILE__);
 136             $this->clientError(
 137                 _('Could not delete favorite.'),
 138                 404,
 139                 $this->format
 140             );
 141             return;
 142         }
 143
 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 }