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