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 class ApiStatusesShowAction extends ApiPrivateAuthAction
  59 {
  60     var $notice_id = null;
  61     var $notice    = null;
  62
  63     /**
  64      * Take arguments for running
  65      *
  66      * @param array $args $_REQUEST args
  67      *
  68      * @return boolean success flag
  69      */
  70     function prepare($args)
  71     {
  72         parent::prepare($args);
  73
  74         // 'id' is an undocumented parameter in Twitter's API. Several
  75         // clients make use of it, so we support it too.
  76
  77         // show.json?id=12345 takes precedence over /show/12345.json
  78
  79         $this->notice_id = (int)$this->trimmed('id');
  80
  81         if (empty($notice_id)) {
  82             $this->notice_id = (int)$this->arg('id');
  83         }
  84
  85         $this->notice = Notice::staticGet((int)$this->notice_id);
  86
  87         return true;
  88     }
  89
  90     /**
  91      * Handle the request
  92      *
  93      * Check the format and show the notice
  94      *
  95      * @param array $args $_REQUEST data (unused)
  96      *
  97      * @return void
  98      */
  99     function handle($args)
 100     {
 101         parent::handle($args);
 102
 103         if (!in_array($this->format, array('xml', 'json'))) {
 104             // TRANS: Client error displayed when trying to handle an unknown API method.
 105             $this->clientError(_('API method not found.'), $code = 404);
 106             return;
 107         }
 108
 109         $this->showNotice();
 110     }
 111
 112     /**
 113      * Show the notice
 114      *
 115      * @return void
 116      */
 117     function showNotice()
 118     {
 119         if (!empty($this->notice)) {
 120             if ($this->format == 'xml') {
 121                 $this->showSingleXmlStatus($this->notice);
 122             } elseif ($this->format == 'json') {
 123                 $this->show_single_json_status($this->notice);
 124             }
 125         } else {
 126             // XXX: Twitter just sets a 404 header and doens't bother
 127             // to return an err msg
 128
 129             $deleted = Deleted_notice::staticGet($this->notice_id);
 130
 131             if (!empty($deleted)) {
 132                 $this->clientError(
 133                     // TRANS: Client error displayed requesting a deleted status.
 134                     _('Status deleted.'),
 135                     410,
 136                     $this->format
 137                 );
 138             } else {
 139                 $this->clientError(
 140                     // TRANS: Client error displayed requesting a status with an invalid ID.
 141                     _('No status with that ID found.'),
 142                     404,
 143                     $this->format
 144                 );
 145             }
 146         }
 147     }
 148
 149     /**
 150      * Is this action read only?
 151      *
 152      * @param array $args other arguments
 153      *
 154      * @return boolean true
 155      */
 156     function isReadOnly($args)
 157     {
 158         return true;
 159     }
 160
 161     /**
 162      * When was this notice last modified?
 163      *
 164      * @return string datestamp of the latest notice in the stream
 165      */
 166     function lastModified()
 167     {
 168         if (!empty($this->notice)) {
 169             return strtotime($this->notice->created);
 170         }
 171
 172         return null;
 173     }
 174
 175     /**
 176      * An entity tag for this notice
 177      *
 178      * Returns an Etag based on the action name, language, and
 179      * timestamps of the notice
 180      *
 181      * @return string etag
 182      */
 183     function etag()
 184     {
 185         if (!empty($this->notice)) {
 186
 187             return '"' . implode(
 188                 ':',
 189                 array($this->arg('action'),
 190                       common_user_cache_hash($this->auth_user),
 191                       common_language(),
 192                       $this->notice->id,
 193                       strtotime($this->notice->created))
 194             )
 195             . '"';
 196         }
 197
 198         return null;
 199     }
 200 }