3 * StatusNet, the distributed open-source microblogging tool
5 * Send a direct message via 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 Adrian Lang <mail@adrianlang.de>
25 * @author Evan Prodromou <evan@status.net>
26 * @author Robin Millette <robin@millette.info>
27 * @author Zach Copley <zach@status.net>
28 * @copyright 2009 StatusNet, Inc.
29 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
30 * @link http://status.net/
33 if (!defined('STATUSNET')) {
38 * Creates a new direct message from the authenticating user to
39 * the user specified by id.
43 * @author Adrian Lang <mail@adrianlang.de>
44 * @author Evan Prodromou <evan@status.net>
45 * @author Robin Millette <robin@millette.info>
46 * @author Zach Copley <zach@status.net>
47 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
48 * @link http://status.net/
50 class ApiDirectMessageNewAction extends ApiAuthAction
56 * Take arguments for running
58 * @param array $args $_REQUEST args
60 * @return boolean success flag
62 function prepare($args)
64 parent::prepare($args);
66 $this->user = $this->auth_user;
68 if (empty($this->user)) {
69 // TRANS: Client error when user not found for an API direct message action.
70 $this->clientError(_('No such user.'), 404, $this->format);
74 $this->content = $this->trimmed('text');
76 $this->user = $this->auth_user;
78 $user_param = $this->trimmed('user');
79 $user_id = $this->arg('user_id');
80 $screen_name = $this->trimmed('screen_name');
82 if (isset($user_param) || isset($user_id) || isset($screen_name)) {
83 $this->other = $this->getTargetUser($user_param);
92 * Save the new message
94 * @param array $args $_REQUEST data (unused)
98 function handle($args)
100 parent::handle($args);
102 if ($_SERVER['REQUEST_METHOD'] != 'POST') {
104 // TRANS: Client error. POST is a HTTP command. It should not be translated.
105 _('This method requires a POST.'),
112 if (empty($this->content)) {
114 // TRANS: Client error displayed when no message text was submitted (406).
115 _('No message text!'),
120 $content_shortened = $this->auth_user->shortenLinks($this->content);
121 if (Message::contentTooLong($content_shortened)) {
123 // TRANS: Client error displayed when message content is too long.
124 // TRANS: %d is the maximum number of characters for a message.
125 sprintf(_m('That\'s too long. Maximum message size is %d character.', 'That\'s too long. Maximum message size is %d characters.', Message::maxContent()),
126 Message::maxContent()
135 if (empty($this->other)) {
136 // TRANS: Client error displayed if a recipient user could not be found (403).
137 $this->clientError(_('Recipient user not found.'), 403, $this->format);
139 } else if (!$this->user->mutuallySubscribed($this->other)) {
141 // TRANS: Client error displayed trying to direct message another user who's not a friend (403).
142 _('Cannot send direct messages to users who aren\'t your friend.'),
147 } else if ($this->user->id == $this->other->id) {
149 // Note: sending msgs to yourself is allowed by Twitter
151 // TRANS: Client error displayed trying to direct message self (403).
152 $this->clientError(_('Do not send a message to yourself; ' .
153 'just say it to yourself quietly instead.'), 403, $this->format);
157 $message = Message::saveNew(
160 html_entity_decode($this->content, ENT_NOQUOTES, 'UTF-8'),
166 if ($this->format == 'xml') {
167 $this->showSingleXmlDirectMessage($message);
168 } elseif ($this->format == 'json') {
169 $this->showSingleJsondirectMessage($message);