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 of the status.
  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'.
  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 require_once INSTALLDIR . '/lib/apiauth.php';
 133 require_once INSTALLDIR . '/lib/mediafile.php';
 134
 135 /**
 136  * Updates the authenticating user's status (posts a notice).
 137  *
 138  * @category API
 139  * @package  StatusNet
 140  * @author   Craig Andrews <candrews@integralblue.com>
 141  * @author   Evan Prodromou <evan@status.net>
 142  * @author   Jeffery To <jeffery.to@gmail.com>
 143  * @author   Tom Blankenship <mac65@mac65.com>
 144  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
 145  * @author   Robin Millette <robin@millette.info>
 146  * @author   Zach Copley <zach@status.net>
 147  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 148  * @link     http://status.net/
 149  */
 150
 151 class ApiStatusesUpdateAction extends ApiAuthAction
 152 {
 153     var $source                = null;
 154     var $status                = null;
 155     var $in_reply_to_status_id = null;
 156     var $lat                   = null;
 157     var $lon                   = null;
 158
 159     /**
 160      * Take arguments for running
 161      *
 162      * @param array $args $_REQUEST args
 163      *
 164      * @return boolean success flag
 165      *
 166      */
 167
 168     function prepare($args)
 169     {
 170         parent::prepare($args);
 171
 172         $this->status = $this->trimmed('status');
 173         $this->lat    = $this->trimmed('lat');
 174         $this->lon    = $this->trimmed('long');
 175
 176         $this->in_reply_to_status_id
 177             = intval($this->trimmed('in_reply_to_status_id'));
 178
 179         return true;
 180     }
 181
 182     /**
 183      * Handle the request
 184      *
 185      * Make a new notice for the update, save it, and show it
 186      *
 187      * @param array $args $_REQUEST data (unused)
 188      *
 189      * @return void
 190      */
 191
 192     function handle($args)
 193     {
 194         parent::handle($args);
 195
 196         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
 197             $this->clientError(
 198                 // TRANS: Client error. POST is a HTTP command. It should not be translated.
 199                 _('This method requires a POST.'),
 200                 400,
 201                 $this->format
 202             );
 203             return;
 204         }
 205
 206         // Workaround for PHP returning empty $_POST and $_FILES when POST
 207         // length > post_max_size in php.ini
 208
 209         if (empty($_FILES)
 210             && empty($_POST)
 211             && ($_SERVER['CONTENT_LENGTH'] > 0)
 212         ) {
 213              $msg = _('The server was unable to handle that much POST ' .
 214                     'data (%s bytes) due to its current configuration.');
 215
 216             $this->clientError(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
 217             return;
 218         }
 219
 220         if (empty($this->status)) {
 221             $this->clientError(
 222                 _('Client must provide a \'status\' parameter with a value.'),
 223                 400,
 224                 $this->format
 225             );
 226             return;
 227         }
 228
 229         if (empty($this->auth_user)) {
 230             $this->clientError(_('No such user.'), 404, $this->format);
 231             return;
 232         }
 233
 234         $status_shortened = common_shorten_links($this->status);
 235
 236         if (Notice::contentTooLong($status_shortened)) {
 237
 238             // Note: Twitter truncates anything over 140, flags the status
 239             // as "truncated."
 240
 241             $this->clientError(
 242                 sprintf(
 243                     _('That\'s too long. Max notice size is %d chars.'),
 244                     Notice::maxContent()
 245                 ),
 246                 406,
 247                 $this->format
 248             );
 249
 250             return;
 251         }
 252
 253         // Check for commands
 254
 255         $inter = new CommandInterpreter();
 256         $cmd = $inter->handle_command($this->auth_user, $status_shortened);
 257
 258         if ($cmd) {
 259
 260             if ($this->supported($cmd)) {
 261                 $cmd->execute(new Channel());
 262             }
 263
 264             // Cmd not supported?  Twitter just returns your latest status.
 265             // And, it returns your last status whether the cmd was successful
 266             // or not!
 267
 268             $this->notice = $this->auth_user->getCurrentNotice();
 269
 270         } else {
 271
 272             $reply_to = null;
 273
 274             if (!empty($this->in_reply_to_status_id)) {
 275
 276                 // Check whether notice actually exists
 277
 278                 $reply = Notice::staticGet($this->in_reply_to_status_id);
 279
 280                 if ($reply) {
 281                     $reply_to = $this->in_reply_to_status_id;
 282                 } else {
 283                     $this->clientError(
 284                         _('Not found.'),
 285                         $code = 404,
 286                         $this->format
 287                     );
 288                     return;
 289                 }
 290             }
 291
 292             $upload = null;
 293
 294             try {
 295                 $upload = MediaFile::fromUpload('media', $this->auth_user);
 296             } catch (Exception $e) {
 297                 $this->clientError($e->getMessage(), $e->getCode(), $this->format);
 298                 return;
 299             }
 300
 301             if (isset($upload)) {
 302                 $status_shortened .= ' ' . $upload->shortUrl();
 303
 304                 if (Notice::contentTooLong($status_shortened)) {
 305                     $upload->delete();
 306                     $msg = _(
 307                         'Max notice size is %d chars, ' .
 308                         'including attachment URL.'
 309                     );
 310                     $this->clientError(
 311                         sprintf($msg, Notice::maxContent()),
 312                         400,
 313                         $this->format
 314                     );
 315                 }
 316             }
 317
 318             $content = html_entity_decode($status_shortened, ENT_NOQUOTES, 'UTF-8');
 319
 320             $options = array('reply_to' => $reply_to);
 321
 322             if ($this->auth_user->shareLocation()) {
 323
 324                 $locOptions = Notice::locationOptions($this->lat,
 325                                                       $this->lon,
 326                                                       null,
 327                                                       null,
 328                                                       $this->auth_user->getProfile());
 329
 330                 $options = array_merge($options, $locOptions);
 331             }
 332
 333             try {
 334                 $this->notice = Notice::saveNew(
 335                     $this->auth_user->id,
 336                     $content,
 337                     $this->source,
 338                     $options
 339                 );
 340             } catch (Exception $e) {
 341                 $this->clientError($e->getMessage(), $e->getCode(), $this->format);
 342                 return;
 343             }
 344
 345             if (isset($upload)) {
 346                 $upload->attachToNotice($this->notice);
 347             }
 348
 349         }
 350
 351         $this->showNotice();
 352     }
 353
 354     /**
 355      * Show the resulting notice
 356      *
 357      * @return void
 358      */
 359
 360     function showNotice()
 361     {
 362         if (!empty($this->notice)) {
 363             if ($this->format == 'xml') {
 364                 $this->showSingleXmlStatus($this->notice);
 365             } elseif ($this->format == 'json') {
 366                 $this->show_single_json_status($this->notice);
 367             }
 368         }
 369     }
 370
 371     /**
 372      * Is this command supported when doing an update from the API?
 373      *
 374      * @param string $cmd the command to check for
 375      *
 376      * @return boolean true or false
 377      */
 378
 379     function supported($cmd)
 380     {
 381         static $cmdlist = array('MessageCommand', 'SubCommand', 'UnsubCommand',
 382             'FavCommand', 'OnCommand', 'OffCommand');
 383
 384         if (in_array(get_class($cmd), $cmdlist)) {
 385             return true;
 386         }
 387
 388         return false;
 389     }
 390
 391 }