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('STATUSNET')) {
  38     exit(1);
  39 }
  40
  41 require_once INSTALLDIR . '/lib/apiprivateauth.php';
  42
  43 /**
  44  * Returns the notice specified by id as a Twitter-style status and inline user
  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
  59 class ApiStatusesShowAction extends ApiPrivateAuthAction
  60 {
  61
  62     var $notice_id = null;
  63     var $notice    = null;
  64
  65     /**
  66      * Take arguments for running
  67      *
  68      * @param array $args $_REQUEST args
  69      *
  70      * @return boolean success flag
  71      *
  72      */
  73
  74     function prepare($args)
  75     {
  76         parent::prepare($args);
  77
  78         // 'id' is an undocumented parameter in Twitter's API. Several
  79         // clients make use of it, so we support it too.
  80
  81         // show.json?id=12345 takes precedence over /show/12345.json
  82
  83         $this->notice_id = (int)$this->trimmed('id');
  84
  85         if (empty($notice_id)) {
  86             $this->notice_id = (int)$this->arg('id');
  87         }
  88
  89         $this->notice = Notice::staticGet((int)$this->notice_id);
  90
  91         return true;
  92     }
  93
  94     /**
  95      * Handle the request
  96      *
  97      * Check the format and show the notice
  98      *
  99      * @param array $args $_REQUEST data (unused)
 100      *
 101      * @return void
 102      */
 103
 104     function handle($args)
 105     {
 106         parent::handle($args);
 107
 108         if (!in_array($this->format, array('xml', 'json', 'atom'))) {
 109             $this->clientError(_('API method not found.'), 404);
 110             return;
 111         }
 112
 113         $this->showNotice();
 114     }
 115
 116     /**
 117      * Show the notice
 118      *
 119      * @return void
 120      */
 121
 122     function showNotice()
 123     {
 124         if (!empty($this->notice)) {
 125             switch ($this->format) {
 126             case 'xml':
 127                 $this->showSingleXmlStatus($this->notice);
 128                 break;
 129             case 'json':
 130                 $this->show_single_json_status($this->notice);
 131                 break;
 132             case 'atom':
 133                 $this->showSingleAtomStatus($this->notice);
 134                 break;
 135             default:
 136                 throw new Exception(sprintf(_("Unsupported format: %s"), $this->format));
 137             }
 138         } else {
 139
 140             // XXX: Twitter just sets a 404 header and doens't bother
 141             // to return an err msg
 142
 143             $deleted = Deleted_notice::staticGet($this->notice_id);
 144
 145             if (!empty($deleted)) {
 146                 $this->clientError(
 147                     _('Status deleted.'),
 148                     410,
 149                     $this->format
 150                 );
 151             } else {
 152                 $this->clientError(
 153                     _('No status with that ID found.'),
 154                     404,
 155                     $this->format
 156                 );
 157             }
 158         }
 159     }
 160
 161     /**
 162      * Is this action read only?
 163      *
 164      * @param array $args other arguments
 165      *
 166      * @return boolean true
 167      */
 168
 169     function isReadOnly($args)
 170     {
 171         return true;
 172     }
 173
 174     /**
 175      * When was this notice last modified?
 176      *
 177      * @return string datestamp of the latest notice in the stream
 178      */
 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
 198     function etag()
 199     {
 200         if (!empty($this->notice)) {
 201
 202             return '"' . implode(
 203                 ':',
 204                 array($this->arg('action'),
 205                       common_user_cache_hash($this->auth_user),
 206                       common_language(),
 207                       $this->notice->id,
 208                       strtotime($this->notice->created))
 209             )
 210             . '"';
 211         }
 212
 213         return null;
 214     }
 215
 216 }