actions/apistatusesshow.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show a notice (as a Twitter-style status)
   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  * Returns the notice specified by id as a Twitter-style status and inline user
  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 ApiStatusesShowAction extends ApiPrivateAuthAction
  55 {
  56     var $notice_id = null;
  57     var $notice    = null;
  58
  59     /**
  60      * Take arguments for running
  61      *
  62      * @param array $args $_REQUEST args
  63      *
  64      * @return boolean success flag
  65      */
  66     protected function prepare(array $args=array())
  67     {
  68         parent::prepare($args);
  69
  70         // 'id' is an undocumented parameter in Twitter's API. Several
  71         // clients make use of it, so we support it too.
  72
  73         // show.json?id=12345 takes precedence over /show/12345.json
  74
  75         $this->notice_id = (int)$this->trimmed('id');
  76
  77         $this->notice = Notice::getKV($this->notice_id);
  78         if (!$this->notice->inScope($this->scoped)) {
  79             // TRANS: Client exception thrown when trying a view a notice the user has no access to.
  80             throw new ClientException(_('Access restricted.'), 403);
  81         }
  82
  83         return true;
  84     }
  85
  86     /**
  87      * Handle the request
  88      *
  89      * Check the format and show the notice
  90      *
  91      * @return void
  92      */
  93     protected function handle()
  94     {
  95         parent::handle();
  96
  97         if (!in_array($this->format, array('xml', 'json', 'atom'))) {
  98             // TRANS: Client error displayed when coming across a non-supported API method.
  99             $this->clientError(_('API method not found.'), 404);
 100         }
 101
 102         switch ($_SERVER['REQUEST_METHOD']) {
 103         case 'GET':
 104             $this->showNotice();
 105             break;
 106         case 'DELETE':
 107             $this->deleteNotice();
 108             break;
 109         default:
 110             // TRANS: Client error displayed calling an unsupported HTTP error in API status show.
 111             $this->clientError(_('HTTP method not supported.'), 405);
 112         }
 113     }
 114
 115     /**
 116      * Show the notice
 117      *
 118      * @return void
 119      */
 120     function showNotice()
 121     {
 122         if (!empty($this->notice)) {
 123             switch ($this->format) {
 124             case 'xml':
 125                 $this->showSingleXmlStatus($this->notice);
 126                 break;
 127             case 'json':
 128                 $this->show_single_json_status($this->notice);
 129                 break;
 130             case 'atom':
 131                 $this->showSingleAtomStatus($this->notice);
 132                 break;
 133             default:
 134                 // TRANS: Exception thrown requesting an unsupported notice output format.
 135                 // TRANS: %s is the requested output format.
 136                 throw new Exception(sprintf(_("Unsupported format: %s."), $this->format));
 137             }
 138         } else {
 139             // XXX: Twitter just sets a 404 header and doens't bother
 140             // to return an err msg
 141
 142             $deleted = Deleted_notice::getKV($this->notice_id);
 143
 144             if (!empty($deleted)) {
 145                 $this->clientError(
 146                     // TRANS: Client error displayed requesting a deleted status.
 147                     _('Status deleted.'),
 148                     410,
 149                     $this->format
 150                 );
 151             } else {
 152                 $this->clientError(
 153                     // TRANS: Client error displayed requesting a status with an invalid ID.
 154                     _('No status with that ID found.'),
 155                     404,
 156                     $this->format
 157                 );
 158             }
 159         }
 160     }
 161
 162     /**
 163      * We expose AtomPub here, so non-GET/HEAD reqs must be read/write.
 164      *
 165      * @param array $args other arguments
 166      *
 167      * @return boolean true
 168      */
 169
 170     function isReadOnly($args)
 171     {
 172         return ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD');
 173     }
 174
 175     /**
 176      * When was this notice last modified?
 177      *
 178      * @return string datestamp of the latest notice in the stream
 179      */
 180     function lastModified()
 181     {
 182         if (!empty($this->notice)) {
 183             return strtotime($this->notice->created);
 184         }
 185
 186         return null;
 187     }
 188
 189     /**
 190      * An entity tag for this notice
 191      *
 192      * Returns an Etag based on the action name, language, and
 193      * timestamps of the notice
 194      *
 195      * @return string etag
 196      */
 197     function etag()
 198     {
 199         if (!empty($this->notice)) {
 200
 201             return '"' . implode(
 202                 ':',
 203                 array($this->arg('action'),
 204                       common_user_cache_hash($this->auth_user),
 205                       common_language(),
 206                       $this->notice->id,
 207                       strtotime($this->notice->created))
 208             )
 209             . '"';
 210         }
 211
 212         return null;
 213     }
 214
 215     function deleteNotice()
 216     {
 217         if ($this->format != 'atom') {
 218             // TRANS: Client error displayed when trying to delete a notice not using the Atom format.
 219             $this->clientError(_('Can only delete using the Atom format.'));
 220         }
 221
 222         if (empty($this->auth_user) ||
 223             ($this->notice->profile_id != $this->auth_user->id &&
 224              !$this->auth_user->hasRight(Right::DELETEOTHERSNOTICE))) {
 225             // TRANS: Client error displayed when a user has no rights to delete notices of other users.
 226             $this->clientError(_('Cannot delete this notice.'), 403);
 227         }
 228
 229         if (Event::handle('StartDeleteOwnNotice', array($this->auth_user, $this->notice))) {
 230             $this->notice->delete();
 231             Event::handle('EndDeleteOwnNotice', array($this->auth_user, $this->notice));
 232         }
 233
 234         // @fixme is there better output we could do here?
 235
 236         header('HTTP/1.1 200 OK');
 237         header('Content-Type: text/plain');
 238         // TRANS: Confirmation of notice deletion in API. %d is the ID (number) of the deleted notice.
 239         print(sprintf(_('Deleted notice %d'), $this->notice->id));
 240         print("\n");
 241     }
 242 }