3 * StatusNet, the distributed open-source microblogging tool
5 * Settings for Jabber/XMPP integration
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 Evan Prodromou <evan@status.net>
25 * @copyright 2008-2009 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
35 * Settings for Jabber/XMPP integration
39 * @author Evan Prodromou <evan@status.net>
40 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
41 * @link http://status.net/
46 class ImsettingsAction extends SettingsAction
51 * @return string Title of the page
55 // TRANS: Title for Instant Messaging settings.
56 return _('IM settings');
60 * Instructions for use
62 * @return instructions for use
64 function getInstructions()
66 // TRANS: Instant messaging settings page instructions.
67 // TRANS: [instant messages] is link text, "(%%doc.im%%)" is the link.
68 // TRANS: the order and formatting of link text and link should remain unchanged.
69 return _('You can send and receive notices through '.
70 '[instant messaging](%%doc.im%%). '.
71 'Configure your addresses and settings below.');
75 * Content area of the page
77 * We make different sections of the form for the different kinds of
78 * functions, and have submit buttons with different names. These
79 * are muxed by handlePost() to see what the user really wants to do.
83 function showContent()
85 $transports = array();
86 Event::handle('GetImTransports', array(&$transports));
88 $this->element('div', array('class' => 'error'),
89 // TRANS: Message given in the IM settings if IM is not enabled on the site.
90 _('IM is not available.'));
94 $user = common_current_user();
96 $user_im_prefs_by_transport = array();
98 foreach($transports as $transport=>$transport_info)
100 $this->elementStart('form', array('method' => 'post',
101 'id' => 'form_settings_im',
102 'class' => 'form_settings',
104 common_local_url('imsettings')));
105 $this->elementStart('fieldset', array('id' => 'settings_im_address'));
106 // TRANS: Form legend for IM settings form.
107 $this->element('legend', null, $transport_info['display']);
108 $this->hidden('token', common_session_token());
109 $this->hidden('transport', $transport);
111 if ($user_im_prefs = User_im_prefs::pkeyGet( array('transport' => $transport, 'user_id' => $user->id) )) {
112 $user_im_prefs_by_transport[$transport] = $user_im_prefs;
113 $this->element('p', 'form_confirmed', $user_im_prefs->screenname);
114 $this->element('p', 'form_note',
115 // TRANS: Form note in IM settings form. %s is the type of IM address that was confirmed.
116 sprintf(_('Current confirmed %s address.'),$transport_info['display']));
117 $this->hidden('screenname', $user_im_prefs->screenname);
118 // TRANS: Button label to remove a confirmed IM address.
119 $this->submit('remove', _m('BUTTON','Remove'));
121 $confirm = $this->getConfirmation($transport);
123 $this->element('p', 'form_unconfirmed', $confirm->address);
124 // TRANS: Form note in IM settings form.
125 $this->element('p', 'form_note',
126 // TRANS: Form note in IM settings form.
127 // TRANS: %s is the IM service name, %2$s is the IM address set.
128 sprintf(_('Awaiting confirmation on this address. '.
129 'Check your %1$s account for a '.
130 'message with further instructions. '.
131 '(Did you add %2$s to your buddy list?)'),
132 $transport_info['display'],
133 $transport_info['daemonScreenname']));
134 $this->hidden('screenname', $confirm->address);
135 // TRANS: Button label to cancel an IM address confirmation procedure.
136 $this->submit('cancel', _m('BUTTON','Cancel'));
138 $this->elementStart('ul', 'form_data');
139 $this->elementStart('li');
140 // TRANS: Field label for IM address.
141 $this->input('screenname', _('IM address'),
142 ($this->arg('screenname')) ? $this->arg('screenname') : null,
143 // TRANS: Field title for IM address. %s is the IM service name.
144 sprintf(_('%s screenname.'),
145 $transport_info['display']));
146 $this->elementEnd('li');
147 $this->elementEnd('ul');
148 // TRANS: Button label for adding an IM address in IM settings form.
149 $this->submit('add', _m('BUTTON','Add'));
152 $this->elementEnd('fieldset');
153 $this->elementEnd('form');
156 if($user_im_prefs_by_transport)
158 $this->elementStart('form', array('method' => 'post',
159 'id' => 'form_settings_im',
160 'class' => 'form_settings',
162 common_local_url('imsettings')));
163 $this->elementStart('fieldset', array('id' => 'settings_im_preferences'));
164 // TRANS: Header for IM preferences form.
165 $this->element('legend', null, _('IM Preferences'));
166 $this->hidden('token', common_session_token());
167 $this->elementStart('table');
168 $this->elementStart('tr');
169 foreach($user_im_prefs_by_transport as $transport=>$user_im_prefs)
171 $this->element('th', null, $transports[$transport]['display']);
173 $this->elementEnd('tr');
174 $preferences = array(
175 // TRANS: Checkbox label in IM preferences form.
176 array('name'=>'notify', 'description'=>_('Send me notices')),
177 // TRANS: Checkbox label in IM preferences form.
178 array('name'=>'updatefrompresence', 'description'=>_('Post a notice when my status changes.')),
179 // TRANS: Checkbox label in IM preferences form.
180 array('name'=>'replies', 'description'=>_('Send me replies '.
181 'from people I\'m not subscribed to.')),
183 foreach($preferences as $preference)
185 $this->elementStart('tr');
186 foreach($user_im_prefs_by_transport as $transport=>$user_im_prefs)
188 $preference_name = $preference['name'];
189 $this->elementStart('td');
190 $this->checkbox($transport . '_' . $preference['name'],
191 $preference['description'],
192 $user_im_prefs->$preference_name);
193 $this->elementEnd('td');
195 $this->elementEnd('tr');
197 $this->elementEnd('table');
198 // TRANS: Button label to save IM preferences.
199 $this->submit('save', _m('BUTTON','Save'));
200 $this->elementEnd('fieldset');
201 $this->elementEnd('form');
206 * Get a confirmation code for this user
208 * @return Confirm_address address object for this user
210 function getConfirmation($transport)
212 $user = common_current_user();
214 $confirm = new Confirm_address();
216 $confirm->user_id = $user->id;
217 $confirm->address_type = $transport;
219 if ($confirm->find(true)) {
227 * Handle posts to this form
229 * Based on the button that was pressed, muxes out to other functions
230 * to do the actual task requested.
232 * All sub-functions reload the form with a message -- success or failure.
236 function handlePost()
239 $token = $this->trimmed('token');
240 if (!$token || $token != common_session_token()) {
241 // TRANS: Client error displayed when the session token does not match or is not given.
242 $this->showForm(_('There was a problem with your session token. '.
243 'Try again, please.'));
247 if ($this->arg('save')) {
248 $this->savePreferences();
249 } else if ($this->arg('add')) {
251 } else if ($this->arg('cancel')) {
252 $this->cancelConfirmation();
253 } else if ($this->arg('remove')) {
254 $this->removeAddress();
256 // TRANS: Message given submitting a form with an unknown action in Instant Messaging settings.
257 $this->showForm(_('Unexpected form submission.'));
262 * Save user's Jabber preferences
264 * These are the checkboxes at the bottom of the page. They're used to
265 * set different settings
269 function savePreferences()
271 $user = common_current_user();
273 $user_im_prefs = new User_im_prefs();
274 $user_im_prefs->query('BEGIN');
275 $user_im_prefs->user_id = $user->id;
276 if($user_im_prefs->find() && $user_im_prefs->fetch())
278 $preferences = array('notify', 'updatefrompresence', 'replies');
281 $original = clone($user_im_prefs);
282 $new = clone($user_im_prefs);
283 foreach($preferences as $preference)
285 $new->$preference = $this->boolean($new->transport . '_' . $preference);
287 $result = $new->update($original);
289 if ($result === false) {
290 common_log_db_error($user, 'UPDATE', __FILE__);
291 // TRANS: Server error thrown on database error updating IM preferences.
292 $this->serverError(_('Could not update IM preferences.'));
294 }while($user_im_prefs->fetch());
296 $user_im_prefs->query('COMMIT');
297 // TRANS: Confirmation message for successful IM preferences save.
298 $this->showForm(_('Preferences saved.'), true);
302 * Sends a confirmation to the address given
304 * Stores a confirmation record and sends out a
305 * message with the confirmation info.
309 function addAddress()
311 $user = common_current_user();
313 $screenname = $this->trimmed('screenname');
314 $transport = $this->trimmed('transport');
319 // TRANS: Message given saving IM address without having provided one.
320 $this->showForm(_('No screenname.'));
325 // TRANS: Form validation error when no transport is available setting an IM address.
326 $this->showForm(_('No transport.'));
330 Event::handle('NormalizeImScreenname', array($transport, &$screenname));
333 // TRANS: Message given saving IM address that cannot be normalised.
334 $this->showForm(_('Cannot normalize that screenname.'));
338 Event::handle('ValidateImScreenname', array($transport, $screenname, &$valid));
340 // TRANS: Message given saving IM address that not valid.
341 $this->showForm(_('Not a valid screenname.'));
343 } else if ($this->screennameExists($transport, $screenname)) {
344 // TRANS: Message given saving IM address that is already set for another user.
345 $this->showForm(_('Screenname already belongs to another user.'));
349 $confirm = new Confirm_address();
351 $confirm->address = $screenname;
352 $confirm->address_type = $transport;
353 $confirm->user_id = $user->id;
354 $confirm->code = common_confirmation_code(64);
355 $confirm->sent = common_sql_now();
356 $confirm->claimed = common_sql_now();
358 $result = $confirm->insert();
360 if ($result === false) {
361 common_log_db_error($confirm, 'INSERT', __FILE__);
362 // TRANS: Server error thrown on database error adding Instant Messaging confirmation code.
363 $this->serverError(_('Could not insert confirmation code.'));
366 Event::handle('SendImConfirmationCode', array($transport, $screenname, $confirm->code, $user));
368 // TRANS: Message given saving valid IM address that is to be confirmed.
369 $msg = _('A confirmation code was sent '.
370 'to the IM address you added.');
372 $this->showForm($msg, true);
376 * Cancel a confirmation
378 * If a confirmation exists, cancel it.
382 function cancelConfirmation()
384 $screenname = $this->trimmed('screenname');
385 $transport = $this->trimmed('transport');
387 $confirm = $this->getConfirmation($transport);
390 // TRANS: Message given canceling Instant Messaging address confirmation that is not pending.
391 $this->showForm(_('No pending confirmation to cancel.'));
394 if ($confirm->address != $screenname) {
395 // TRANS: Message given canceling IM address confirmation for the wrong IM address.
396 $this->showForm(_('That is the wrong IM address.'));
400 $result = $confirm->delete();
403 common_log_db_error($confirm, 'DELETE', __FILE__);
404 // TRANS: Server error thrown on database error canceling IM address confirmation.
405 $this->serverError(_('Could not delete confirmation.'));
408 // TRANS: Message given after successfully canceling IM address confirmation.
409 $this->showForm(_('IM confirmation cancelled.'), true);
415 * If the user has a confirmed address, remove it.
419 function removeAddress()
421 $user = common_current_user();
423 $screenname = $this->trimmed('screenname');
424 $transport = $this->trimmed('transport');
426 // Maybe an old tab open...?
428 $user_im_prefs = new User_im_prefs();
429 $user_im_prefs->user_id = $user->id;
430 if(! ($user_im_prefs->find() && $user_im_prefs->fetch())) {
431 // TRANS: Message given trying to remove an IM address that is not
432 // TRANS: registered for the active user.
433 $this->showForm(_('That is not your screenname.'));
437 $result = $user_im_prefs->delete();
440 common_log_db_error($user, 'UPDATE', __FILE__);
441 // TRANS: Server error thrown on database error removing a registered IM address.
442 $this->serverError(_('Could not update user IM preferences.'));
445 // XXX: unsubscribe to the old address
447 // TRANS: Message given after successfully removing a registered Instant Messaging address.
448 $this->showForm(_('The IM address was removed.'), true);
452 * Does this screenname exist?
454 * Checks if we already have another user with this address.
456 * @param string $transport Transport to check
457 * @param string $screenname Screenname to check
459 * @return boolean whether the screenname exists
462 function screennameExists($transport, $screenname)
464 $user = common_current_user();
466 $user_im_prefs = new User_im_prefs();
467 $user_im_prefs->transport = $transport;
468 $user_im_prefs->screenname = $screenname;
469 if($user_im_prefs->find() && $user_im_prefs->fetch()){