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 $format = null;
  51     var $user   = null;
  52     var $notice = null;
  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->format = $this->arg('format');
  73         $this->user   = $this->auth_user;
  74         $this->notice = Notice::staticGet($this->arg('id'));
  75
  76         return true;
  77     }
  78
  79     /**
  80      * Handle the request
  81      *
  82      * Check the format and show the user info
  83      *
  84      * @param array $args $_REQUEST data (unused)
  85      *
  86      * @return void
  87      */
  88
  89     function handle($args)
  90     {
  91         parent::handle($args);
  92
  93         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  94             $this->clientError(
  95                 _('This method requires a POST.'),
  96                 400,
  97                 $this->format
  98             );
  99             return;
 100         }
 101
 102         if (!in_array($this->format, array('xml', 'json'))) {
 103             $this->clientError(
 104                 _('API method not found!'),
 105                 404,
 106                 $this->format
 107             );
 108             return;
 109         }
 110
 111         if (empty($this->notice)) {
 112             $this->clientError(
 113                 _('No status found with that ID.'),
 114                 404,
 115                 $this->format
 116             );
 117             return;
 118         }
 119
 120         $fave            = new Fave();
 121         $fave->user_id   = $this->user->id;
 122         $fave->notice_id = $this->notice->id;
 123
 124         if (!$fave->find(true)) {
 125             $this->clientError(
 126                 _('That status is not a favorite!'),
 127                 403,
 128                 $this->favorite
 129             );
 130             return;
 131         }
 132
 133         $result = $fave->delete();
 134
 135         if (!$result) {
 136             common_log_db_error($fave, 'DELETE', __FILE__);
 137             $this->clientError(
 138                 _('Could not delete favorite.'),
 139                 404,
 140                 $this->format
 141             );
 142             return;
 143         }
 144
 145         $this->user->blowFavesCache();
 146
 147         if ($this->format == 'xml') {
 148             $this->show_single_xml_status($this->notice);
 149         } elseif ($this->format == 'json') {
 150             $this->show_single_json_status($this->notice);
 151         }
 152     }
 153
 154 }