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')) {
36 * Sets which channel (device) StatusNet delivers updates to for
37 * the authenticating user. Sending none as the device parameter
38 * will disable IM and/or SMS updates.
42 * @author Zach Copley <zach@status.net>
43 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
44 * @link http://status.net/
46 class ApiAccountUpdateDeliveryDeviceAction extends ApiAuthAction
48 protected $needPost = true;
51 * Take arguments for running
53 * @param array $args $_REQUEST args
55 * @return boolean success flag
57 function prepare(array $args = array())
59 parent::prepare($args);
61 $this->user = $this->auth_user;
62 $this->device = $this->trimmed('device');
70 * See which request params have been set, and update the user settings
72 * @param array $args $_REQUEST data (unused)
80 if (!in_array($this->format, array('xml', 'json'))) {
82 // TRANS: Client error displayed when coming across a non-supported API method.
83 _('API method not found.'),
89 // Note: Twitter no longer supports IM
91 if (!in_array(strtolower($this->device), array('sms', 'im', 'none'))) {
92 // TRANS: Client error displayed when no valid device parameter is provided for a user's delivery device setting.
93 $this->clientError(_( 'You must specify a parameter named ' .
94 '\'device\' with a value of one of: sms, im, none.' ));
97 if (empty($this->user)) {
98 // TRANS: Client error displayed when no existing user is provided for a user's delivery device setting.
99 $this->clientError(_('No such user.'), 404);
102 $original = clone($this->user);
104 if (strtolower($this->device) == 'sms') {
105 $this->user->smsnotify = true;
106 } elseif (strtolower($this->device) == 'im') {
107 //TODO IM is pluginized now, so what should we do?
108 //Enable notifications for all IM plugins?
109 //For now, don't do anything
110 //$this->user->jabbernotify = true;
111 } elseif (strtolower($this->device == 'none')) {
112 $this->user->smsnotify = false;
113 //TODO IM is pluginized now, so what should we do?
114 //Disable notifications for all IM plugins?
115 //For now, don't do anything
116 //$this->user->jabbernotify = false;
119 $result = $this->user->update($original);
121 if ($result === false) {
122 common_log_db_error($this->user, 'UPDATE', __FILE__);
123 // TRANS: Server error displayed when a user's delivery device cannot be updated.
124 $this->serverError(_('Could not update user.'));
127 $profile = $this->user->getProfile();
129 $twitter_user = $this->twitterUserArray($profile, true);
131 // Note: this Twitter API method is retarded because it doesn't give
132 // any success/failure information. Twitter's docs claim that the
133 // notification field will change to reflect notification choice,
134 // but that's not true; notification> is used to indicate
135 // whether the auth user is following the user in question.
137 if ($this->format == 'xml') {
138 $this->initDocument('xml');
139 $this->showTwitterXmlUser($twitter_user, 'user', true);
140 $this->endDocument('xml');
141 } elseif ($this->format == 'json') {
142 $this->initDocument('json');
143 $this->showJsonObjects($twitter_user);
144 $this->endDocument('json');