3 * StatusNet, the distributed open-source microblogging tool
5 * Superclass for plugins that do instant messaging
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 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
26 * @link http://status.net/
29 if (!defined('STATUSNET') && !defined('LACONICA')) {
34 * Superclass for plugins that do authentication
36 * Implementations will likely want to override onStartIoManagerClasses() so that their
41 * @author Craig Andrews <candrews@integralblue.com>
42 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
43 * @link http://status.net/
45 abstract class ImPlugin extends Plugin
47 //name of this IM transport
48 public $transport = null;
49 //list of screennames that should get all public notices
50 public $public = array();
53 * normalize a screenname for comparison
55 * @param string $screenname screenname to normalize
57 * @return string an equivalent screenname in normalized form
59 abstract function normalize($screenname);
62 * validate (ensure the validity of) a screenname
64 * @param string $screenname screenname to validate
68 abstract function validate($screenname);
71 * get the internationalized/translated display name of this IM service
75 abstract function getDisplayName();
78 * send a single notice to a given screenname
79 * The implementation should put raw data, ready to send, into the outgoing
80 * queue using enqueueOutgoingRaw()
82 * @param string $screenname screenname to send to
83 * @param Notice $notice notice to send
85 * @return boolean success value
87 function sendNotice($screenname, $notice)
89 return $this->sendMessage($screenname, $this->formatNotice($notice));
93 * send a message (text) to a given screenname
94 * The implementation should put raw data, ready to send, into the outgoing
95 * queue using enqueueOutgoingRaw()
97 * @param string $screenname screenname to send to
98 * @param Notice $body text to send
100 * @return boolean success value
102 abstract function sendMessage($screenname, $body);
105 * receive a raw message
106 * Raw IM data is taken from the incoming queue, and passed to this function.
107 * It should parse the raw message and call handleIncoming()
109 * Returning false may CAUSE REPROCESSING OF THE QUEUE ITEM, and should
110 * be used for temporary failures only. For permanent failures such as
111 * unrecognized addresses, return true to indicate your processing has
114 * @param object $data raw IM data
116 * @return boolean true if processing completed, false for temporary failures
118 abstract function receiveRawMessage($data);
121 * get the screenname of the daemon that sends and receives message for this service
123 * @return string screenname of this plugin
125 abstract function daemonScreenname();
128 * get the microid uri of a given screenname
130 * @param string $screenname screenname
132 * @return string microid uri
134 function microiduri($screenname)
136 return $this->transport . ':' . $screenname;
138 //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - MISC ========================\
141 * Put raw message data (ready to send) into the outgoing queue
143 * @param object $data
145 function enqueueOutgoingRaw($data)
147 $qm = QueueManager::get();
148 $qm->enqueue($data, $this->transport . '-out');
152 * Put raw message data (received, ready to be processed) into the incoming queue
154 * @param object $data
156 function enqueueIncomingRaw($data)
158 $qm = QueueManager::get();
159 $qm->enqueue($data, $this->transport . '-in');
163 * given a screenname, get the corresponding user
165 * @param string $screenname
169 function getUser($screenname)
171 $user_im_prefs = $this->getUserImPrefsFromScreenname($screenname);
173 $user = User::staticGet('id', $user_im_prefs->user_id);
174 $user_im_prefs->free();
182 * given a screenname, get the User_im_prefs object for this transport
184 * @param string $screenname
186 * @return User_im_prefs user_im_prefs
188 function getUserImPrefsFromScreenname($screenname)
190 $user_im_prefs = User_im_prefs::pkeyGet(
191 array('transport' => $this->transport,
192 'screenname' => $this->normalize($screenname)));
193 if ($user_im_prefs) {
194 return $user_im_prefs;
201 * given a User, get their screenname
205 * @return string screenname of that user
207 function getScreenname($user)
209 $user_im_prefs = $this->getUserImPrefsFromUser($user);
210 if ($user_im_prefs) {
211 return $user_im_prefs->screenname;
218 * given a User, get their User_im_prefs
222 * @return User_im_prefs user_im_prefs of that user
224 function getUserImPrefsFromUser($user)
226 $user_im_prefs = User_im_prefs::pkeyGet(
227 array('transport' => $this->transport,
228 'user_id' => $user->id));
230 return $user_im_prefs;
235 //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - SENDING ========================\
237 * Send a message to a given screenname from the site
239 * @param string $screenname screenname to send the message to
240 * @param string $msg message contents to send
242 * @param boolean success
244 protected function sendFromSite($screenname, $msg)
246 $text = '['.common_config('site', 'name') . '] ' . $msg;
247 $this->sendMessage($screenname, $text);
251 * Send a confirmation code to a user
253 * @param string $screenname screenname sending to
254 * @param string $code the confirmation code
255 * @param User $user user sending to
257 * @return boolean success value
259 function sendConfirmationCode($screenname, $code, $user)
261 // TRANS: Body text for confirmation code e-mail.
262 // TRANS: %1$s is a user nickname, %2$s is the StatusNet sitename,
263 // TRANS: %3$s is the display name of an IM plugin.
264 $body = sprintf(_('User "%1$s" on %2$s has said that your %3$s screenname belongs to them. ' .
265 'If that is true, you can confirm by clicking on this URL: ' .
267 ' . (If you cannot click it, copy-and-paste it into the ' .
268 'address bar of your browser). If that user is not you, ' .
269 'or if you did not request this confirmation, just ignore this message.'),
270 $user->nickname, common_config('site', 'name'), $this->getDisplayName(), common_local_url('confirmaddress', null, array('code' => $code)));
272 return $this->sendMessage($screenname, $body);
276 * send a notice to all public listeners
278 * For notices that are generated on the local system (by users), we can optionally
279 * forward them to remote listeners by XMPP.
281 * @param Notice $notice notice to broadcast
283 * @return boolean success flag
286 function publicNotice($notice)
288 // Now, users who want everything
290 // FIXME PRIV don't send out private messages here
291 // XXX: should we send out non-local messages if public,localonly
292 // = false? I think not
294 foreach ($this->public as $screenname) {
296 'Sending notice ' . $notice->id .
297 ' to public listener ' . $screenname,
299 $this->sendNotice($screenname, $notice);
306 * broadcast a notice to all subscribers and reply recipients
308 * This function will send a notice to all subscribers on the local server
309 * who have IM addresses, and have IM notification enabled, and
310 * have this subscription enabled for IM. It also sends the notice to
311 * all recipients of @-replies who have IM addresses and IM notification
312 * enabled. This is really the heart of IM distribution in StatusNet.
314 * @param Notice $notice The notice to broadcast
316 * @return boolean success flag
319 function broadcastNotice($notice)
321 $ni = $notice->whoGets();
323 foreach ($ni as $user_id => $reason) {
324 $user = User::staticGet($user_id);
326 // either not a local user, or just not found
329 $user_im_prefs = $this->getUserImPrefsFromUser($user);
330 if(!$user_im_prefs || !$user_im_prefs->notify){
335 case NOTICE_INBOX_SOURCE_REPLY:
336 if (!$user_im_prefs->replies) {
340 case NOTICE_INBOX_SOURCE_SUB:
341 $sub = Subscription::pkeyGet(array('subscriber' => $user->id,
342 'subscribed' => $notice->profile_id));
343 if (empty($sub) || !$sub->jabber) {
347 case NOTICE_INBOX_SOURCE_GROUP:
350 // TRANS: Exception thrown when trying to deliver a notice to an unknown inbox.
351 // TRANS: %d is the unknown inbox ID (number).
352 throw new Exception(sprintf(_('Unknown inbox source %d.'), $reason));
356 'Sending notice ' . $notice->id . ' to ' . $user_im_prefs->screenname,
358 $this->sendNotice($user_im_prefs->screenname, $notice);
359 $user_im_prefs->free();
366 * makes a plain-text formatted version of a notice, suitable for IM distribution
368 * @param Notice $notice notice being sent
370 * @return string plain-text version of the notice, with user nickname prefixed
373 function formatNotice($notice)
375 $profile = $notice->getProfile();
376 return $profile->nickname . ': ' . $notice->content . ' [' . $notice->id . ']';
378 //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - RECEIVING ========================\
381 * Attempt to handle a message as a command
382 * @param User $user user the message is from
383 * @param string $body message text
384 * @return boolean true if the message was a command and was executed, false if it was not a command
386 protected function handleCommand($user, $body)
388 $inter = new CommandInterpreter();
389 $cmd = $inter->handle_command($user, $body);
391 $chan = new IMChannel($this);
392 $cmd->execute($chan);
400 * Is some text an autoreply message?
401 * @param string $txt message text
402 * @return boolean true if autoreply
404 protected function isAutoreply($txt)
406 if (preg_match('/[\[\(]?[Aa]uto[-\s]?[Rr]e(ply|sponse)[\]\)]/', $txt)) {
408 } else if (preg_match('/^System: Message wasn\'t delivered. Offline storage size was exceeded.$/', $txt)) {
416 * Is some text an OTR message?
417 * @param string $txt message text
418 * @return boolean true if OTR
420 protected function isOtr($txt)
422 if (preg_match('/^\?OTR/', $txt)) {
430 * Helper for handling incoming messages
431 * Your incoming message handler will probably want to call this function
433 * @param string $from screenname the message was sent from
434 * @param string $message message contents
436 * @param boolean success
438 protected function handleIncoming($from, $notice_text)
440 $user = $this->getUser($from);
441 // For common_current_user to work
446 $this->sendFromSite($from, 'Unknown user; go to ' .
447 common_local_url('imsettings') .
448 ' to add your address to your account');
449 common_log(LOG_WARNING, 'Message from unknown user ' . $from);
452 if ($this->handleCommand($user, $notice_text)) {
453 common_log(LOG_INFO, "Command message by $from handled.");
455 } else if ($this->isAutoreply($notice_text)) {
456 common_log(LOG_INFO, 'Ignoring auto reply from ' . $from);
458 } else if ($this->isOtr($notice_text)) {
459 common_log(LOG_INFO, 'Ignoring OTR from ' . $from);
463 common_log(LOG_INFO, 'Posting a notice from ' . $user->nickname);
465 $this->addNotice($from, $user, $notice_text);
475 * Helper for handling incoming messages
476 * Your incoming message handler will probably want to call this function
478 * @param string $from screenname the message was sent from
479 * @param string $message message contents
481 * @param boolean success
483 protected function addNotice($screenname, $user, $body)
485 $body = trim(strip_tags($body));
486 $content_shortened = common_shorten_links($body);
487 if (Notice::contentTooLong($content_shortened)) {
488 $this->sendFromSite($screenname,
489 // TRANS: Message given when a status is too long. %1$s is the maximum number of characters,
490 // TRANS: %2$s is the number of characters sent (used for plural).
491 sprintf(_m('Message too long - maximum is %1$d character, you sent %2$d.',
492 'Message too long - maximum is %1$d characters, you sent %2$d.',
493 Notice::maxContent()),
494 Notice::maxContent(),
495 mb_strlen($content_shortened)));
500 $notice = Notice::saveNew($user->id, $content_shortened, $this->transport);
501 } catch (Exception $e) {
502 common_log(LOG_ERR, $e->getMessage());
503 $this->sendFromSite($from, $e->getMessage());
508 'Added notice ' . $notice->id . ' from user ' . $user->nickname);
513 //========================EVENT HANDLERS========================\
516 * Register notice queue handler
518 * @param QueueManager $manager
520 * @return boolean hook return
522 function onEndInitializeQueueManager($manager)
524 $manager->connect($this->transport . '-in', new ImReceiverQueueHandler($this), 'im');
525 $manager->connect($this->transport, new ImQueueHandler($this));
526 $manager->connect($this->transport . '-out', new ImSenderQueueHandler($this), 'im');
530 function onStartImDaemonIoManagers(&$classes)
532 //$classes[] = new ImManager($this); // handles sending/receiving/pings/reconnects
536 function onStartEnqueueNotice($notice, &$transports)
538 $profile = Profile::staticGet($notice->profile_id);
541 common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
542 'unknown profile ' . common_log_objstring($notice),
545 $transports[] = $this->transport;
551 function onEndShowHeadElements($action)
553 $aname = $action->trimmed('action');
555 if ($aname == 'shownotice') {
557 $user_im_prefs = new User_im_prefs();
558 $user_im_prefs->user_id = $action->profile->id;
559 $user_im_prefs->transport = $this->transport;
561 if ($user_im_prefs->find() && $user_im_prefs->fetch() && $user_im_prefs->microid && $action->notice->uri) {
562 $id = new Microid($this->microiduri($user_im_prefs->screenname),
563 $action->notice->uri);
564 $action->element('meta', array('name' => 'microid',
565 'content' => $id->toString()));
568 } else if ($aname == 'showstream') {
570 $user_im_prefs = new User_im_prefs();
571 $user_im_prefs->user_id = $action->user->id;
572 $user_im_prefs->transport = $this->transport;
574 if ($user_im_prefs->find() && $user_im_prefs->fetch() && $user_im_prefs->microid && $action->profile->profileurl) {
575 $id = new Microid($this->microiduri($user_im_prefs->screenname),
577 $action->element('meta', array('name' => 'microid',
578 'content' => $id->toString()));
583 function onNormalizeImScreenname($transport, &$screenname)
585 if($transport == $this->transport)
587 $screenname = $this->normalize($screenname);
592 function onValidateImScreenname($transport, $screenname, &$valid)
594 if($transport == $this->transport)
596 $valid = $this->validate($screenname);
601 function onGetImTransports(&$transports)
603 $transports[$this->transport] = array(
604 'display' => $this->getDisplayName(),
605 'daemonScreenname' => $this->daemonScreenname());
608 function onSendImConfirmationCode($transport, $screenname, $code, $user)
610 if($transport == $this->transport)
612 $this->sendConfirmationCode($screenname, $code, $user);
617 function onUserDeleteRelated($user, &$tables)
619 $tables[] = 'User_im_prefs';
623 function onHaveImPlugin(&$haveImPlugin) {
624 $haveImPlugin = true; // set flag true (we're loaded, after all!)
625 return false; // stop looking
628 function initialize()
630 if( ! common_config('queue', 'enabled'))
632 // TRANS: Server exception thrown trying to initialise an IM plugin without meeting all prerequisites.
633 throw new ServerException(_('Queueing must be enabled to use IM plugins.'));
636 if(is_null($this->transport)){
637 // TRANS: Server exception thrown trying to initialise an IM plugin without a transport method.
638 throw new ServerException(_('Transport cannot be null.'));