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('STATUSNET')) {
  38     exit(1);
  39 }
  40
  41 require_once INSTALLDIR . '/lib/apiauth.php';
  42
  43 /**
  44  * Deletes one of the authenticating user's statuses (notices).
  45  *
  46  * @category API
  47  * @package  StatusNet
  48  * @author   Craig Andrews <candrews@integralblue.com>
  49  * @author   Evan Prodromou <evan@status.net>
  50  * @author   Jeffery To <jeffery.to@gmail.com>
  51  * @author   Tom Blankenship <mac65@mac65.com>
  52  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
  53  * @author   Robin Millette <robin@millette.info>
  54  * @author   Zach Copley <zach@status.net>
  55  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  56  * @link     http://status.net/
  57  */
  58 class ApiStatusesDestroyAction extends ApiAuthAction
  59 {
  60     var $status = null;
  61
  62     /**
  63      * Take arguments for running
  64      *
  65      * @param array $args $_REQUEST args
  66      *
  67      * @return boolean success flag
  68      */
  69     function prepare($args)
  70     {
  71         parent::prepare($args);
  72
  73         $this->user = $this->auth_user;
  74         $this->notice_id = (int)$this->trimmed('id');
  75
  76         if (empty($notice_id)) {
  77             $this->notice_id = (int)$this->arg('id');
  78         }
  79
  80         $this->notice = Notice::staticGet((int)$this->notice_id);
  81
  82         return true;
  83      }
  84
  85     /**
  86      * Handle the request
  87      *
  88      * Delete the notice and all related replies
  89      *
  90      * @param array $args $_REQUEST data (unused)
  91      *
  92      * @return void
  93      */
  94     function handle($args)
  95     {
  96         parent::handle($args);
  97
  98         if (!in_array($this->format, array('xml', 'json'))) {
  99             $this->clientError(
 100                 // TRANS: Client error displayed when coming across a non-supported API method.
 101                 _('API method not found.'),
 102                 404
 103             );
 104             return;
 105         }
 106
 107         if (!in_array($_SERVER['REQUEST_METHOD'], array('POST', 'DELETE'))) {
 108             $this->clientError(
 109                 // TRANS: Client error displayed trying to delete a status not using POST or DELETE.
 110                 // TRANS: POST and DELETE should not be translated.
 111                 _('This method requires a POST or DELETE.'),
 112                 400,
 113                 $this->format
 114             );
 115             return;
 116         }
 117
 118         if (empty($this->notice)) {
 119             $this->clientError(
 120                 // TRANS: Client error displayed trying to delete a status with an invalid ID.
 121                 _('No status found with that ID.'),
 122                 404, $this->format
 123             );
 124             return;
 125         }
 126
 127         if ($this->user->id == $this->notice->profile_id) {
 128             if (Event::handle('StartDeleteOwnNotice', array($this->user, $this->notice))) {
 129                 $this->notice->delete();
 130                 Event::handle('EndDeleteOwnNotice', array($this->user, $this->notice));
 131             }
 132                 $this->showNotice();
 133         } else {
 134             $this->clientError(
 135                 // TRANS: Client error displayed trying to delete a status of another user.
 136                 _('You may not delete another user\'s status.'),
 137                 403,
 138                 $this->format
 139             );
 140         }
 141     }
 142
 143     /**
 144      * Show the deleted notice
 145      *
 146      * @return void
 147      */
 148     function showNotice()
 149     {
 150         if (!empty($this->notice)) {
 151             if ($this->format == 'xml') {
 152                 $this->showSingleXmlStatus($this->notice);
 153             } elseif ($this->format == 'json') {
 154                 $this->show_single_json_status($this->notice);
 155             }
 156         }
 157     }
 158 }