actions/apistatusesdestroy.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Destroy a notice through 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    Jeffery To <jeffery.to@gmail.com>
  27  * @author    Tom Blankenship <mac65@mac65.com>
  28  * @author    Mike Cochrane <mikec@mikenz.geek.nz>
  29  * @author    Robin Millette <robin@millette.info>
  30  * @author    Zach Copley <zach@status.net>
  31  * @copyright 2009 StatusNet, Inc.
  32  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  33  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  34  * @link      http://status.net/
  35  */
  36
  37 if (!defined('GNUSOCIAL')) { exit(1); }
  38
  39 /**
  40  * Deletes one of the authenticating user's statuses (notices).
  41  *
  42  * @category API
  43  * @package  StatusNet
  44  * @author   Craig Andrews <candrews@integralblue.com>
  45  * @author   Evan Prodromou <evan@status.net>
  46  * @author   Jeffery To <jeffery.to@gmail.com>
  47  * @author   Tom Blankenship <mac65@mac65.com>
  48  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
  49  * @author   Robin Millette <robin@millette.info>
  50  * @author   Zach Copley <zach@status.net>
  51  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  52  * @link     http://status.net/
  53  */
  54 class ApiStatusesDestroyAction extends ApiAuthAction
  55 {
  56     protected function prepare(array $args=array())
  57     {
  58         parent::prepare($args);
  59
  60         if (!in_array($_SERVER['REQUEST_METHOD'], array('POST', 'DELETE'))) {
  61             // TRANS: Client error displayed trying to delete a status not using POST or DELETE.
  62             // TRANS: POST and DELETE should not be translated.
  63             throw new ClientException(_('This method requires a POST or DELETE.'));
  64         }
  65
  66         // FIXME: Return with a Not Acceptable status code?
  67         if (!in_array($this->format, array('xml', 'json'))) {
  68             // TRANS: Client error displayed when coming across a non-supported API method.
  69             throw new ClientException(_('API method not found.'), 404);
  70         }
  71
  72         try {
  73             $this->notice = Notice::getByID($this->trimmed('id'));
  74         } catch (NoResultException $e) {
  75             // TRANS: Client error displayed trying to delete a status with an invalid ID.
  76             throw new ClientException(_('No status found with that ID.'), 404);
  77         }
  78
  79         return true;
  80      }
  81
  82     protected function handle()
  83     {
  84         parent::handle();
  85
  86         if (!$this->scoped->sameAs($this->notice->getProfile()) && !$this->scoped->hasRight(Right::DELETEOTHERSNOTICE)) {
  87             // TRANS: Client error displayed trying to delete a status of another user.
  88             throw new AuthorizationException(_('You may not delete another user\'s status.'));
  89         }
  90
  91         if (Event::handle('StartDeleteOwnNotice', array($this->scoped->getUser(), $this->notice))) {
  92             $this->notice->deleteAs($this->scoped);
  93             Event::handle('EndDeleteOwnNotice', array($this->scoped->getUser(), $this->notice));
  94         }
  95         $this->showNotice();
  96     }
  97
  98     /**
  99      * Show the deleted notice
 100      *
 101      * @return void
 102      */
 103     function showNotice()
 104     {
 105         if (!empty($this->notice)) {
 106             if ($this->format == 'xml') {
 107                 $this->showSingleXmlStatus($this->notice);
 108             } elseif ($this->format == 'json') {
 109                 $this->show_single_json_status($this->notice);
 110             }
 111         }
 112     }
 113 }