3 * StatusNet, the distributed open-source microblogging tool
5 * Update the authenticating user notification channels
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 Siebrand Mazeland <s.mazeland@xs4all.nl>
25 * @author Zach Copley <zach@status.net>
26 * @copyright 2009 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
35 require_once INSTALLDIR . '/lib/apiauth.php';
38 * Sets which channel (device) StatusNet delivers updates to for
39 * the authenticating user. Sending none as the device parameter
40 * will disable IM and/or SMS updates.
44 * @author Zach Copley <zach@status.net>
45 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
46 * @link http://status.net/
48 class ApiAccountUpdateDeliveryDeviceAction extends ApiAuthAction
51 * Take arguments for running
53 * @param array $args $_REQUEST args
55 * @return boolean success flag
58 function prepare($args)
60 parent::prepare($args);
62 $this->user = $this->auth_user;
63 $this->device = $this->trimmed('device');
71 * See which request params have been set, and update the user settings
73 * @param array $args $_REQUEST data (unused)
77 function handle($args)
79 parent::handle($args);
81 if ($_SERVER['REQUEST_METHOD'] != 'POST') {
83 // TRANS: Client error message. POST is a HTTP command. It should not be translated.
84 _('This method requires a POST.'),
90 if (!in_array($this->format, array('xml', 'json'))) {
92 // TRANS: Client error displayed handling a non-existing API method.
93 _('API method not found.'),
100 // Note: Twitter no longer supports IM
102 if (!in_array(strtolower($this->device), array('sms', 'im', 'none'))) {
103 // TRANS: Client error displayed when no valid device parameter is provided for a user's delivery device setting.
104 $this->clientError(_( 'You must specify a parameter named ' .
105 '\'device\' with a value of one of: sms, im, none.' ));
109 if (empty($this->user)) {
110 // TRANS: Client error displayed when no existing user is provided for a user's delivery device setting.
111 $this->clientError(_('No such user.'), 404, $this->format);
115 $original = clone($this->user);
117 if (strtolower($this->device) == 'sms') {
118 $this->user->smsnotify = true;
119 } elseif (strtolower($this->device) == 'im') {
120 //TODO IM is pluginized now, so what should we do?
121 //Enable notifications for all IM plugins?
122 //For now, don't do anything
123 //$this->user->jabbernotify = true;
124 } elseif (strtolower($this->device == 'none')) {
125 $this->user->smsnotify = false;
126 //TODO IM is pluginized now, so what should we do?
127 //Disable notifications for all IM plugins?
128 //For now, don't do anything
129 //$this->user->jabbernotify = false;
132 $result = $this->user->update($original);
134 if ($result === false) {
135 common_log_db_error($this->user, 'UPDATE', __FILE__);
136 // TRANS: Server error displayed when a user's delivery device cannot be updated.
137 $this->serverError(_('Could not update user.'));
141 $profile = $this->user->getProfile();
143 $twitter_user = $this->twitterUserArray($profile, true);
145 // Note: this Twitter API method is retarded because it doesn't give
146 // any success/failure information. Twitter's docs claim that the
147 // notification field will change to reflect notification choice,
148 // but that's not true; notification> is used to indicate
149 // whether the auth user is following the user in question.
151 if ($this->format == 'xml') {
152 $this->initDocument('xml');
153 $this->showTwitterXmlUser($twitter_user);
154 $this->endDocument('xml');
155 } elseif ($this->format == 'json') {
156 $this->initDocument('json');
157 $this->showJsonObjects($twitter_user);
158 $this->endDocument('json');