actions/apistatusesupdate.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Post a notice (update your status) 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-2010 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 /* External API usage documentation. Please update when you change how this method works. */
  38
  39 /*! @page statusesupdate statuses/update
  40
  41     @section Description
  42     Updates the authenticating user's status. Requires the status parameter specified below.
  43     Request must be a POST.
  44
  45     @par URL pattern
  46     /api/statuses/update.:format
  47
  48     @par Formats (:format)
  49     xml, json
  50
  51     @par HTTP Method(s)
  52     POST
  53
  54     @par Requires Authentication
  55     Yes
  56
  57     @param status (Required) The URL-encoded text of the status update.
  58     @param source (Optional) The source application name, if using HTTP authentication or an anonymous OAuth consumer.
  59     @param in_reply_to_status_id (Optional) The ID of an existing status that the update is in reply to.
  60     @param lat (Optional) The latitude the status refers to.
  61     @param long (Optional) The longitude the status refers to.
  62     @param media (Optional) a media upload, such as an image or movie file.
  63
  64     @sa @ref authentication
  65     @sa @ref apiroot
  66
  67     @subsection usagenotes Usage notes
  68
  69     @li The URL pattern is relative to the @ref apiroot.
  70     @li If the @e source parameter is not supplied the source of the status will default to 'api'. When authenticated via a registered OAuth application, the application's registered name and URL will always override the source parameter.
  71     @li The XML response uses <a href="http://georss.org/Main_Page">GeoRSS</a>
  72     to encode the latitude and longitude (see example response below <georss:point>).
  73     @li Data uploaded via the @e media parameter should be multipart/form-data encoded.
  74
  75     @subsection exampleusage Example usage
  76
  77     @verbatim
  78     curl -u username:password http://example.com/api/statuses/update.xml -d status='Howdy!' -d lat='30.468' -d long='-94.743'
  79     @endverbatim
  80
  81     @subsection exampleresponse Example response
  82
  83     @verbatim
  84     <?xml version="1.0" encoding="UTF-8"?>
  85     <status>
  86       <text>Howdy!</text>
  87       <truncated>false</truncated>
  88       <created_at>Tue Mar 30 23:28:05 +0000 2010</created_at>
  89       <in_reply_to_status_id/>
  90       <source>api</source>
  91       <id>26668724</id>
  92       <in_reply_to_user_id/>
  93       <in_reply_to_screen_name/>
  94       <geo xmlns:georss="http://www.georss.org/georss">
  95         <georss:point>30.468 -94.743</georss:point>
  96       </geo>
  97       <favorited>false</favorited>
  98       <user>
  99         <id>25803</id>
 100         <name>Jed Sanders</name>
 101         <screen_name>jedsanders</screen_name>
 102         <location>Hoop and Holler, Texas</location>
 103         <description>I like to think of myself as America's Favorite.</description>
 104         <profile_image_url>http://avatar.example.com/25803-48-20080924200604.png</profile_image_url>
 105         <url>http://jedsanders.net</url>
 106         <protected>false</protected>
 107         <followers_count>5</followers_count>
 108         <profile_background_color/>
 109         <profile_text_color/>
 110         <profile_link_color/>
 111         <profile_sidebar_fill_color/>
 112         <profile_sidebar_border_color/>
 113         <friends_count>2</friends_count>
 114         <created_at>Wed Sep 24 20:04:00 +0000 2008</created_at>
 115         <favourites_count>0</favourites_count>
 116         <utc_offset>0</utc_offset>
 117         <time_zone>UTC</time_zone>
 118         <profile_background_image_url/>
 119         <profile_background_tile>false</profile_background_tile>
 120         <statuses_count>70</statuses_count>
 121         <following>true</following>
 122         <notifications>true</notifications>
 123       </user>
 124     </status>
 125     @endverbatim
 126 */
 127
 128 if (!defined('STATUSNET')) {
 129     exit(1);
 130 }
 131
 132 /**
 133  * Updates the authenticating user's status (posts a notice).
 134  *
 135  * @category API
 136  * @package  StatusNet
 137  * @author   Craig Andrews <candrews@integralblue.com>
 138  * @author   Evan Prodromou <evan@status.net>
 139  * @author   Jeffery To <jeffery.to@gmail.com>
 140  * @author   Tom Blankenship <mac65@mac65.com>
 141  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
 142  * @author   Robin Millette <robin@millette.info>
 143  * @author   Zach Copley <zach@status.net>
 144  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 145  * @link     http://status.net/
 146  */
 147 class ApiStatusesUpdateAction extends ApiAuthAction
 148 {
 149     var $status                = null;
 150     var $in_reply_to_status_id = null;
 151     var $lat                   = null;
 152     var $lon                   = null;
 153
 154     /**
 155      * Take arguments for running
 156      *
 157      * @param array $args $_REQUEST args
 158      *
 159      * @return boolean success flag
 160      */
 161     function prepare($args)
 162     {
 163         parent::prepare($args);
 164
 165         $this->status = $this->trimmed('status');
 166         $this->lat    = $this->trimmed('lat');
 167         $this->lon    = $this->trimmed('long');
 168
 169         $this->in_reply_to_status_id
 170             = intval($this->trimmed('in_reply_to_status_id'));
 171
 172         return true;
 173     }
 174
 175     /**
 176      * Handle the request
 177      *
 178      * Make a new notice for the update, save it, and show it
 179      *
 180      * @param array $args $_REQUEST data (unused)
 181      *
 182      * @return void
 183      */
 184     function handle($args)
 185     {
 186         parent::handle($args);
 187
 188         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
 189             $this->clientError(
 190                 // TRANS: Client error. POST is a HTTP command. It should not be translated.
 191                 _('This method requires a POST.'),
 192                 400,
 193                 $this->format
 194             );
 195             return;
 196         }
 197
 198         // Workaround for PHP returning empty $_POST and $_FILES when POST
 199         // length > post_max_size in php.ini
 200
 201         if (empty($_FILES)
 202             && empty($_POST)
 203             && ($_SERVER['CONTENT_LENGTH'] > 0)
 204         ) {
 205              // TRANS: Client error displayed when the number of bytes in a POST request exceeds a limit.
 206              // TRANS: %s is the number of bytes of the CONTENT_LENGTH.
 207              $msg = _m('The server was unable to handle that much POST data (%s byte) due to its current configuration.',
 208                       'The server was unable to handle that much POST data (%s bytes) due to its current configuration.',
 209                       intval($_SERVER['CONTENT_LENGTH']));
 210
 211             $this->clientError(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
 212             return;
 213         }
 214
 215         if (empty($this->status)) {
 216             $this->clientError(
 217                 // TRANS: Client error displayed when the parameter "status" is missing.
 218                 _('Client must provide a \'status\' parameter with a value.'),
 219                 400,
 220                 $this->format
 221             );
 222             return;
 223         }
 224
 225         if (empty($this->auth_user)) {
 226             // TRANS: Client error displayed when updating a status for a non-existing user.
 227             $this->clientError(_('No such user.'), 404, $this->format);
 228             return;
 229         }
 230
 231         /* Do not call shortenlinks until the whole notice has been build */
 232
 233         // Check for commands
 234
 235         $inter = new CommandInterpreter();
 236         $cmd = $inter->handle_command($this->auth_user, $this->status);
 237
 238         if ($cmd) {
 239             if ($this->supported($cmd)) {
 240                 $cmd->execute(new Channel());
 241             }
 242
 243             // Cmd not supported?  Twitter just returns your latest status.
 244             // And, it returns your last status whether the cmd was successful
 245             // or not!
 246
 247             $this->notice = $this->auth_user->getCurrentNotice();
 248         } else {
 249             $reply_to = null;
 250
 251             if (!empty($this->in_reply_to_status_id)) {
 252                 // Check whether notice actually exists
 253
 254                 $reply = Notice::getKV($this->in_reply_to_status_id);
 255
 256                 if ($reply) {
 257                     $reply_to = $this->in_reply_to_status_id;
 258                 } else {
 259                     $this->clientError(
 260                         // TRANS: Client error displayed when replying to a non-existing notice.
 261                         _('Parent notice not found.'),
 262                         $code = 404,
 263                         $this->format
 264                     );
 265                     return;
 266                 }
 267             }
 268
 269             $upload = null;
 270
 271             try {
 272                 $upload = MediaFile::fromUpload('media', $this->auth_user);
 273             } catch (Exception $e) {
 274                 $this->clientError($e->getMessage(), $e->getCode(), $this->format);
 275                 return;
 276             }
 277
 278             if (isset($upload)) {
 279                 $this->status .= ' ' . $upload->shortUrl();
 280
 281                 /* Do not call shortenlinks until the whole notice has been build */
 282             }
 283
 284             /* Do call shortenlinks here & check notice length since notice is about to be saved & sent */
 285             $status_shortened = $this->auth_user->shortenlinks($this->status);
 286
 287             if (Notice::contentTooLong($status_shortened)) {
 288                 if (isset($upload)) {
 289                     $upload->delete();
 290                 }
 291                 // TRANS: Client error displayed exceeding the maximum notice length.
 292                 // TRANS: %d is the maximum lenth for a notice.
 293                 $msg = _m('Maximum notice size is %d character, including attachment URL.',
 294                           'Maximum notice size is %d characters, including attachment URL.',
 295                           Notice::maxContent());
 296                 /* Use HTTP 413 error code (Request Entity Too Large)
 297                  * instead of basic 400 for better understanding
 298                  */
 299                 $this->clientError(sprintf($msg, Notice::maxContent()),
 300                                    413,
 301                                    $this->format);
 302             }
 303
 304
 305             $content = html_entity_decode($status_shortened, ENT_NOQUOTES, 'UTF-8');
 306
 307             $options = array('reply_to' => $reply_to);
 308
 309             if ($this->auth_user->shareLocation()) {
 310
 311                 $locOptions = Notice::locationOptions($this->lat,
 312                                                       $this->lon,
 313                                                       null,
 314                                                       null,
 315                                                       $this->auth_user->getProfile());
 316
 317                 $options = array_merge($options, $locOptions);
 318             }
 319
 320             try {
 321                 $this->notice = Notice::saveNew(
 322                     $this->auth_user->id,
 323                     $content,
 324                     $this->source,
 325                     $options
 326                 );
 327             } catch (Exception $e) {
 328                 $this->clientError($e->getMessage(), $e->getCode(), $this->format);
 329                 return;
 330             }
 331
 332             if (isset($upload)) {
 333                 $upload->attachToNotice($this->notice);
 334             }
 335         }
 336
 337         $this->showNotice();
 338     }
 339
 340     /**
 341      * Show the resulting notice
 342      *
 343      * @return void
 344      */
 345     function showNotice()
 346     {
 347         if (!empty($this->notice)) {
 348             if ($this->format == 'xml') {
 349                 $this->showSingleXmlStatus($this->notice);
 350             } elseif ($this->format == 'json') {
 351                 $this->show_single_json_status($this->notice);
 352             }
 353         }
 354     }
 355
 356     /**
 357      * Is this command supported when doing an update from the API?
 358      *
 359      * @param string $cmd the command to check for
 360      *
 361      * @return boolean true or false
 362      */
 363     function supported($cmd)
 364     {
 365         static $cmdlist = array('MessageCommand', 'SubCommand', 'UnsubCommand',
 366             'FavCommand', 'OnCommand', 'OffCommand', 'JoinCommand', 'LeaveCommand');
 367
 368         if (in_array(get_class($cmd), $cmdlist)) {
 369             return true;
 370         }
 371
 372         return false;
 373     }
 374 }