3 * StatusNet, the distributed open-source microblogging tool
5 * Post a notice (update your status) through the API
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.
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.
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/>.
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 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
33 * @link http://status.net/
36 /* External API usage documentation. Please update when you change how this method works. */
38 /*! @page statusesupdate statuses/update
41 Updates the authenticating user's status. Requires the status parameter specified below.
42 Request must be a POST.
45 /api/statuses/update.:format
47 @par Formats (:format)
53 @par Requires Authentication
56 @param status (Required) The URL-encoded text of the status update.
57 @param source (Optional) The source of the status.
58 @param in_reply_to_status_id (Optional) The ID of an existing status that the update is in reply to.
59 @param lat (Optional) The latitude the status refers to.
60 @param long (Optional) The longitude the status refers to.
61 @param media (Optional) a media upload, such as an image or movie file.
63 @sa @ref authentication
66 @subsection usagenotes Usage notes
68 @li The URL pattern is relative to the @ref apiroot.
69 @li If the @e source parameter is not supplied the source of the status will default to 'api'.
70 @li The XML response uses <a href="http://georss.org/Main_Page">GeoRSS</a>
71 to encode the latitude and longitude (see example response below <georss:point>).
72 @li Data uploaded via the @e media parameter should be multipart/form-data encoded.
74 @subsection exampleusage Example usage
77 curl -u username:password http://example.com/api/statuses/update.xml -d status='Howdy!' -d lat='30.468' -d long='-94.743'
80 @subsection exampleresponse Example response
83 <?xml version="1.0" encoding="UTF-8"?>
86 <truncated>false</truncated>
87 <created_at>Tue Mar 30 23:28:05 +0000 2010</created_at>
88 <in_reply_to_status_id/>
91 <in_reply_to_user_id/>
92 <in_reply_to_screen_name/>
93 <geo xmlns:georss="http://www.georss.org/georss">
94 <georss:point>30.468 -94.743</georss:point>
96 <favorited>false</favorited>
99 <name>Jed Sanders</name>
100 <screen_name>jedsanders</screen_name>
101 <location>Hoop and Holler, Texas</location>
102 <description>I like to think of myself as America's Favorite.</description>
103 <profile_image_url>http://avatar.example.com/25803-48-20080924200604.png</profile_image_url>
104 <url>http://jedsanders.net</url>
105 <protected>false</protected>
106 <followers_count>5</followers_count>
107 <profile_background_color/>
108 <profile_text_color/>
109 <profile_link_color/>
110 <profile_sidebar_fill_color/>
111 <profile_sidebar_border_color/>
112 <friends_count>2</friends_count>
113 <created_at>Wed Sep 24 20:04:00 +0000 2008</created_at>
114 <favourites_count>0</favourites_count>
115 <utc_offset>0</utc_offset>
116 <time_zone>UTC</time_zone>
117 <profile_background_image_url/>
118 <profile_background_tile>false</profile_background_tile>
119 <statuses_count>70</statuses_count>
120 <following>true</following>
121 <notifications>true</notifications>
127 if (!defined('STATUSNET')) {
131 require_once INSTALLDIR . '/lib/apiauth.php';
132 require_once INSTALLDIR . '/lib/mediafile.php';
135 * Updates the authenticating user's status (posts a notice).
139 * @author Craig Andrews <candrews@integralblue.com>
140 * @author Evan Prodromou <evan@status.net>
141 * @author Jeffery To <jeffery.to@gmail.com>
142 * @author Tom Blankenship <mac65@mac65.com>
143 * @author Mike Cochrane <mikec@mikenz.geek.nz>
144 * @author Robin Millette <robin@millette.info>
145 * @author Zach Copley <zach@status.net>
146 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
147 * @link http://status.net/
150 class ApiStatusesUpdateAction extends ApiAuthAction
154 var $in_reply_to_status_id = null;
159 * Take arguments for running
161 * @param array $args $_REQUEST args
163 * @return boolean success flag
167 function prepare($args)
169 parent::prepare($args);
171 $this->status = $this->trimmed('status');
172 $this->lat = $this->trimmed('lat');
173 $this->lon = $this->trimmed('long');
175 $this->in_reply_to_status_id
176 = intval($this->trimmed('in_reply_to_status_id'));
184 * Make a new notice for the update, save it, and show it
186 * @param array $args $_REQUEST data (unused)
191 function handle($args)
193 parent::handle($args);
195 if ($_SERVER['REQUEST_METHOD'] != 'POST') {
197 _('This method requires a POST.'),
203 // Workaround for PHP returning empty $_POST and $_FILES when POST
204 // length > post_max_size in php.ini
208 && ($_SERVER['CONTENT_LENGTH'] > 0)
210 $msg = _('The server was unable to handle that much POST ' .
211 'data (%s bytes) due to its current configuration.');
213 $this->clientError(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
217 if (empty($this->status)) {
219 'Client must provide a \'status\' parameter with a value.',
226 if (empty($this->auth_user)) {
227 $this->clientError(_('No such user.'), 404, $this->format);
231 $status_shortened = common_shorten_links($this->status);
233 if (Notice::contentTooLong($status_shortened)) {
235 // Note: Twitter truncates anything over 140, flags the status
240 _('That\'s too long. Max notice size is %d chars.'),
250 // Check for commands
252 $inter = new CommandInterpreter();
253 $cmd = $inter->handle_command($this->auth_user, $status_shortened);
257 if ($this->supported($cmd)) {
258 $cmd->execute(new Channel());
261 // Cmd not supported? Twitter just returns your latest status.
262 // And, it returns your last status whether the cmd was successful
265 $this->notice = $this->auth_user->getCurrentNotice();
271 if (!empty($this->in_reply_to_status_id)) {
273 // Check whether notice actually exists
275 $reply = Notice::staticGet($this->in_reply_to_status_id);
278 $reply_to = $this->in_reply_to_status_id;
292 $upload = MediaFile::fromUpload('media', $this->auth_user);
293 } catch (ClientException $ce) {
294 $this->clientError($ce->getMessage());
298 if (isset($upload)) {
299 $status_shortened .= ' ' . $upload->shortUrl();
301 if (Notice::contentTooLong($status_shortened)) {
304 'Max notice size is %d chars, ' .
305 'including attachment URL.'
307 $this->clientError(sprintf($msg, Notice::maxContent()));
311 $content = html_entity_decode($status_shortened, ENT_NOQUOTES, 'UTF-8');
313 $options = array('reply_to' => $reply_to);
315 if ($this->auth_user->shareLocation()) {
317 $locOptions = Notice::locationOptions($this->lat,
321 $this->auth_user->getProfile());
323 $options = array_merge($options, $locOptions);
327 $this->notice = Notice::saveNew(
328 $this->auth_user->id,
333 } catch (Exception $e) {
334 $this->clientError($e->getMessage());
338 if (isset($upload)) {
339 $upload->attachToNotice($this->notice);
348 * Show the resulting notice
353 function showNotice()
355 if (!empty($this->notice)) {
356 if ($this->format == 'xml') {
357 $this->showSingleXmlStatus($this->notice);
358 } elseif ($this->format == 'json') {
359 $this->show_single_json_status($this->notice);
365 * Is this command supported when doing an update from the API?
367 * @param string $cmd the command to check for
369 * @return boolean true or false
372 function supported($cmd)
374 static $cmdlist = array('MessageCommand', 'SubCommand', 'UnsubCommand',
375 'FavCommand', 'OnCommand', 'OffCommand');
377 if (in_array(get_class($cmd), $cmdlist)) {