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 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 if (!defined('STATUSNET')) {
40 require_once INSTALLDIR . '/lib/apiauth.php';
41 require_once INSTALLDIR . '/lib/mediafile.php';
44 * Updates the authenticating user's status (posts a notice).
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/
59 class ApiStatusesUpdateAction extends ApiAuthAction
63 var $in_reply_to_status_id = null;
67 static $reserved_sources = array('web', 'omb', 'mail', 'xmpp', 'api');
70 * Take arguments for running
72 * @param array $args $_REQUEST args
74 * @return boolean success flag
78 function prepare($args)
80 parent::prepare($args);
82 $this->user = $this->auth_user;
83 $this->status = $this->trimmed('status');
84 $this->source = $this->trimmed('source');
85 $this->lat = $this->trimmed('lat');
86 $this->lon = $this->trimmed('long');
88 // try to set the source attr from OAuth app
89 if (empty($this->source)) {
90 $this->source = $this->oauth_source;
93 if (empty($this->source) || in_array($this->source, self::$reserved_sources)) {
94 $this->source = 'api';
97 $this->in_reply_to_status_id
98 = intval($this->trimmed('in_reply_to_status_id'));
106 * Make a new notice for the update, save it, and show it
108 * @param array $args $_REQUEST data (unused)
113 function handle($args)
115 parent::handle($args);
117 if ($_SERVER['REQUEST_METHOD'] != 'POST') {
119 _('This method requires a POST.'),
125 // Workaround for PHP returning empty $_POST and $_FILES when POST
126 // length > post_max_size in php.ini
130 && ($_SERVER['CONTENT_LENGTH'] > 0)
132 $msg = _('The server was unable to handle that much POST ' .
133 'data (%s bytes) due to its current configuration.');
135 $this->clientError(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
139 if (empty($this->status)) {
141 'Client must provide a \'status\' parameter with a value.',
148 if (empty($this->user)) {
149 $this->clientError(_('No such user.'), 404, $this->format);
153 $status_shortened = common_shorten_links($this->status);
155 if (Notice::contentTooLong($status_shortened)) {
157 // Note: Twitter truncates anything over 140, flags the status
162 _('That\'s too long. Max notice size is %d chars.'),
172 // Check for commands
174 $inter = new CommandInterpreter();
175 $cmd = $inter->handle_command($this->user, $status_shortened);
179 if ($this->supported($cmd)) {
180 $cmd->execute(new Channel());
183 // Cmd not supported? Twitter just returns your latest status.
184 // And, it returns your last status whether the cmd was successful
187 $this->notice = $this->user->getCurrentNotice();
193 if (!empty($this->in_reply_to_status_id)) {
195 // Check whether notice actually exists
197 $reply = Notice::staticGet($this->in_reply_to_status_id);
200 $reply_to = $this->in_reply_to_status_id;
214 $upload = MediaFile::fromUpload('media', $this->user);
215 } catch (ClientException $ce) {
216 $this->clientError($ce->getMessage());
220 if (isset($upload)) {
221 $status_shortened .= ' ' . $upload->shortUrl();
223 if (Notice::contentTooLong($status_shortened)) {
226 'Max notice size is %d chars, ' .
227 'including attachment URL.'
229 $this->clientError(sprintf($msg, Notice::maxContent()));
233 $content = html_entity_decode($status_shortened, ENT_NOQUOTES, 'UTF-8');
235 $options = array('reply_to' => $reply_to);
237 if ($this->user->shareLocation()) {
239 $locOptions = Notice::locationOptions($this->lat,
243 $this->user->getProfile());
245 $options = array_merge($options, $locOptions);
249 Notice::saveNew($this->user->id,
254 if (isset($upload)) {
255 $upload->attachToNotice($this->notice);
258 common_broadcast_notice($this->notice);
265 * Show the resulting notice
270 function showNotice()
272 if (!empty($this->notice)) {
273 if ($this->format == 'xml') {
274 $this->showSingleXmlStatus($this->notice);
275 } elseif ($this->format == 'json') {
276 $this->show_single_json_status($this->notice);
282 * Is this command supported when doing an update from the API?
284 * @param string $cmd the command to check for
286 * @return boolean true or false
289 function supported($cmd)
291 static $cmdlist = array('MessageCommand', 'SubCommand', 'UnsubCommand',
292 'FavCommand', 'OnCommand', 'OffCommand');
294 if (in_array(get_class($cmd), $cmdlist)) {