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();
52 protected $requires_cli = true;
55 * normalize a screenname for comparison
57 * @param string $screenname screenname to normalize
59 * @return string an equivalent screenname in normalized form
61 abstract function normalize($screenname);
64 * validate (ensure the validity of) a screenname
66 * @param string $screenname screenname to validate
70 abstract function validate($screenname);
73 * get the internationalized/translated display name of this IM service
77 abstract function getDisplayName();
80 * send a single notice to a given screenname
81 * The implementation should put raw data, ready to send, into the outgoing
82 * queue using enqueueOutgoingRaw()
84 * @param string $screenname screenname to send to
85 * @param Notice $notice notice to send
87 * @return boolean success value
89 function sendNotice($screenname, Notice $notice)
91 return $this->sendMessage($screenname, $this->formatNotice($notice));
95 * send a message (text) to a given screenname
96 * The implementation should put raw data, ready to send, into the outgoing
97 * queue using enqueueOutgoingRaw()
99 * @param string $screenname screenname to send to
100 * @param Notice $body text to send
102 * @return boolean success value
104 abstract function sendMessage($screenname, $body);
107 * receive a raw message
108 * Raw IM data is taken from the incoming queue, and passed to this function.
109 * It should parse the raw message and call handleIncoming()
111 * Returning false may CAUSE REPROCESSING OF THE QUEUE ITEM, and should
112 * be used for temporary failures only. For permanent failures such as
113 * unrecognized addresses, return true to indicate your processing has
116 * @param object $data raw IM data
118 * @return boolean true if processing completed, false for temporary failures
120 abstract function receiveRawMessage($data);
123 * get the screenname of the daemon that sends and receives message for this service
125 * @return string screenname of this plugin
127 abstract function daemonScreenname();
130 * get the microid uri of a given screenname
132 * @param string $screenname screenname
134 * @return string microid uri
136 function microiduri($screenname)
138 return $this->transport . ':' . $screenname;
140 //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - MISC ========================\
143 * Put raw message data (ready to send) into the outgoing queue
145 * @param object $data
147 function enqueueOutgoingRaw($data)
149 $qm = QueueManager::get();
150 $qm->enqueue($data, $this->transport . '-out');
154 * Put raw message data (received, ready to be processed) into the incoming queue
156 * @param object $data
158 function enqueueIncomingRaw($data)
160 $qm = QueueManager::get();
161 $qm->enqueue($data, $this->transport . '-in');
165 * given a screenname, get the corresponding user
167 * @param string $screenname
171 function getUser($screenname)
173 $user_im_prefs = $this->getUserImPrefsFromScreenname($screenname);
175 $user = User::getKV('id', $user_im_prefs->user_id);
176 $user_im_prefs->free();
184 * given a screenname, get the User_im_prefs object for this transport
186 * @param string $screenname
188 * @return User_im_prefs user_im_prefs
190 function getUserImPrefsFromScreenname($screenname)
192 $user_im_prefs = User_im_prefs::pkeyGet(
193 array('transport' => $this->transport,
194 'screenname' => $this->normalize($screenname)));
195 if ($user_im_prefs) {
196 return $user_im_prefs;
203 * given a User, get their screenname
207 * @return string screenname of that user
209 function getScreenname($user)
211 $user_im_prefs = $this->getUserImPrefsFromUser($user);
212 if ($user_im_prefs) {
213 return $user_im_prefs->screenname;
220 * given a User, get their User_im_prefs
224 * @return User_im_prefs user_im_prefs of that user
226 function getUserImPrefsFromUser($user)
228 $user_im_prefs = User_im_prefs::pkeyGet(
229 array('transport' => $this->transport,
230 'user_id' => $user->id));
232 return $user_im_prefs;
237 //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - SENDING ========================\
239 * Send a message to a given screenname from the site
241 * @param string $screenname screenname to send the message to
242 * @param string $msg message contents to send
244 * @param boolean success
246 protected function sendFromSite($screenname, $msg)
248 $text = '['.common_config('site', 'name') . '] ' . $msg;
249 $this->sendMessage($screenname, $text);
253 * Send a confirmation code to a user
255 * @param string $screenname screenname sending to
256 * @param string $code the confirmation code
257 * @param User $user user sending to
259 * @return boolean success value
261 function sendConfirmationCode($screenname, $code, $user)
263 // TRANS: Body text for confirmation code e-mail.
264 // TRANS: %1$s is a user nickname, %2$s is the StatusNet sitename,
265 // TRANS: %3$s is the display name of an IM plugin.
266 $body = sprintf(_('User "%1$s" on %2$s has said that your %3$s screenname belongs to them. ' .
267 'If that is true, you can confirm by clicking on this URL: ' .
269 ' . (If you cannot click it, copy-and-paste it into the ' .
270 'address bar of your browser). If that user is not you, ' .
271 'or if you did not request this confirmation, just ignore this message.'),
272 $user->nickname, common_config('site', 'name'), $this->getDisplayName(), common_local_url('confirmaddress', null, array('code' => $code)));
274 return $this->sendMessage($screenname, $body);
278 * send a notice to all public listeners
280 * For notices that are generated on the local system (by users), we can optionally
281 * forward them to remote listeners by XMPP.
283 * @param Notice $notice notice to broadcast
285 * @return boolean success flag
288 function publicNotice($notice)
290 // Now, users who want everything
292 // FIXME PRIV don't send out private messages here
293 // XXX: should we send out non-local messages if public,localonly
294 // = false? I think not
296 foreach ($this->public as $screenname) {
298 'Sending notice ' . $notice->id .
299 ' to public listener ' . $screenname,
301 $this->sendNotice($screenname, $notice);
308 * broadcast a notice to all subscribers and reply recipients
310 * This function will send a notice to all subscribers on the local server
311 * who have IM addresses, and have IM notification enabled, and
312 * have this subscription enabled for IM. It also sends the notice to
313 * all recipients of @-replies who have IM addresses and IM notification
314 * enabled. This is really the heart of IM distribution in StatusNet.
316 * @param Notice $notice The notice to broadcast
318 * @return boolean success flag
321 function broadcastNotice($notice)
323 $ni = $notice->whoGets();
325 foreach ($ni as $user_id => $reason) {
326 $user = User::getKV($user_id);
328 // either not a local user, or just not found
331 $user_im_prefs = $this->getUserImPrefsFromUser($user);
332 if(!$user_im_prefs || !$user_im_prefs->notify){
337 case NOTICE_INBOX_SOURCE_REPLY:
338 if (!$user_im_prefs->replies) {
342 case NOTICE_INBOX_SOURCE_SUB:
343 $sub = Subscription::pkeyGet(array('subscriber' => $user->id,
344 'subscribed' => $notice->profile_id));
345 if (empty($sub) || !$sub->jabber) {
349 case NOTICE_INBOX_SOURCE_GROUP:
352 // TRANS: Exception thrown when trying to deliver a notice to an unknown inbox.
353 // TRANS: %d is the unknown inbox ID (number).
354 throw new Exception(sprintf(_('Unknown inbox source %d.'), $reason));
358 'Sending notice ' . $notice->id . ' to ' . $user_im_prefs->screenname,
360 $this->sendNotice($user_im_prefs->screenname, $notice);
361 $user_im_prefs->free();
368 * makes a plain-text formatted version of a notice, suitable for IM distribution
370 * @param Notice $notice notice being sent
372 * @return string plain-text version of the notice, with user nickname prefixed
375 protected function formatNotice(Notice $notice)
377 $profile = $notice->getProfile();
380 $parent = $notice->getParent();
381 $orig_profile = $parent->getProfile();
382 $nicknames = sprintf('%1$s => %2$s', $profile->nickname, $orig_profile->nickname);
383 } catch (NoParentNoticeException $e) {
384 $nicknames = $profile->nickname;
387 return sprintf('%1$s: %2$s [%3$u]', $nicknames, $notice->content, $notice->id);
389 //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - RECEIVING ========================\
392 * Attempt to handle a message as a command
393 * @param User $user user the message is from
394 * @param string $body message text
395 * @return boolean true if the message was a command and was executed, false if it was not a command
397 protected function handleCommand($user, $body)
399 $inter = new CommandInterpreter();
400 $cmd = $inter->handle_command($user, $body);
402 $chan = new IMChannel($this);
403 $cmd->execute($chan);
410 * Is some text an autoreply message?
411 * @param string $txt message text
412 * @return boolean true if autoreply
414 protected function isAutoreply($txt)
416 if (preg_match('/[\[\(]?[Aa]uto[-\s]?[Rr]e(ply|sponse)[\]\)]/', $txt)) {
418 } else if (preg_match('/^System: Message wasn\'t delivered. Offline storage size was exceeded.$/', $txt)) {
426 * Is some text an OTR message?
427 * @param string $txt message text
428 * @return boolean true if OTR
430 protected function isOtr($txt)
432 if (preg_match('/^\?OTR/', $txt)) {
440 * Helper for handling incoming messages
441 * Your incoming message handler will probably want to call this function
443 * @param string $from screenname the message was sent from
444 * @param string $message message contents
446 * @param boolean success
448 protected function handleIncoming($from, $notice_text)
450 $user = $this->getUser($from);
451 // For common_current_user to work
456 $this->sendFromSite($from, 'Unknown user; go to ' .
457 common_local_url('imsettings') .
458 ' to add your address to your account');
459 common_log(LOG_WARNING, 'Message from unknown user ' . $from);
462 if ($this->handleCommand($user, $notice_text)) {
463 common_log(LOG_INFO, "Command message by $from handled.");
465 } else if ($this->isAutoreply($notice_text)) {
466 common_log(LOG_INFO, 'Ignoring auto reply from ' . $from);
468 } else if ($this->isOtr($notice_text)) {
469 common_log(LOG_INFO, 'Ignoring OTR from ' . $from);
473 common_log(LOG_INFO, 'Posting a notice from ' . $user->nickname);
475 $this->addNotice($from, $user, $notice_text);
485 * Helper for handling incoming messages
486 * Your incoming message handler will probably want to call this function
488 * @param string $from screenname the message was sent from
489 * @param string $message message contents
491 * @param boolean success
493 protected function addNotice($screenname, $user, $body)
495 $body = trim(strip_tags($body));
496 $content_shortened = common_shorten_links($body);
497 if (Notice::contentTooLong($content_shortened)) {
498 $this->sendFromSite($screenname,
499 // TRANS: Message given when a status is too long. %1$s is the maximum number of characters,
500 // TRANS: %2$s is the number of characters sent (used for plural).
501 sprintf(_m('Message too long - maximum is %1$d character, you sent %2$d.',
502 'Message too long - maximum is %1$d characters, you sent %2$d.',
503 Notice::maxContent()),
504 Notice::maxContent(),
505 mb_strlen($content_shortened)));
510 $notice = Notice::saveNew($user->id, $content_shortened, $this->transport);
511 } catch (Exception $e) {
512 common_log(LOG_ERR, $e->getMessage());
513 $this->sendFromSite($from, $e->getMessage());
518 'Added notice ' . $notice->id . ' from user ' . $user->nickname);
523 //========================EVENT HANDLERS========================\
526 * Register notice queue handler
528 * @param QueueManager $manager
530 * @return boolean hook return
532 function onEndInitializeQueueManager($manager)
534 // If we don't require CLI mode, or if we do and GNUSOCIAL_CLI _is_ set, then connect the transports
535 // This check is made mostly because some IM plugins can't deliver to transports unless they
536 // have continously running daemons (such as XMPP) and we can't have that over HTTP requests.
537 if (!$this->requires_cli || defined('GNUSOCIAL_CLI')) {
538 $manager->connect($this->transport . '-in', new ImReceiverQueueHandler($this), 'im');
539 $manager->connect($this->transport, new ImQueueHandler($this));
540 $manager->connect($this->transport . '-out', new ImSenderQueueHandler($this), 'im');
545 function onStartImDaemonIoManagers(&$classes)
547 //$classes[] = new ImManager($this); // handles sending/receiving/pings/reconnects
551 function onStartEnqueueNotice($notice, &$transports)
553 $profile = Profile::getKV($notice->profile_id);
556 common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
557 'unknown profile ' . common_log_objstring($notice),
560 $transports[] = $this->transport;
566 function onEndShowHeadElements($action)
568 $aname = $action->trimmed('action');
570 if ($aname == 'shownotice') {
572 $user_im_prefs = new User_im_prefs();
573 $user_im_prefs->user_id = $action->profile->id;
574 $user_im_prefs->transport = $this->transport;
576 if ($user_im_prefs->find() && $user_im_prefs->fetch() && $user_im_prefs->microid && $action->notice->uri) {
577 $id = new Microid($this->microiduri($user_im_prefs->screenname),
578 $action->notice->uri);
579 $action->element('meta', array('name' => 'microid',
580 'content' => $id->toString()));
583 } else if ($aname == 'showstream') {
585 $user_im_prefs = new User_im_prefs();
586 $user_im_prefs->user_id = $action->user->id;
587 $user_im_prefs->transport = $this->transport;
589 if ($user_im_prefs->find() && $user_im_prefs->fetch() && $user_im_prefs->microid && $action->profile->profileurl) {
590 $id = new Microid($this->microiduri($user_im_prefs->screenname),
592 $action->element('meta', array('name' => 'microid',
593 'content' => $id->toString()));
598 function onNormalizeImScreenname($transport, &$screenname)
600 if($transport == $this->transport)
602 $screenname = $this->normalize($screenname);
607 function onValidateImScreenname($transport, $screenname, &$valid)
609 if($transport == $this->transport)
611 $valid = $this->validate($screenname);
616 function onGetImTransports(&$transports)
618 $transports[$this->transport] = array(
619 'display' => $this->getDisplayName(),
620 'daemonScreenname' => $this->daemonScreenname());
623 function onSendImConfirmationCode($transport, $screenname, $code, $user)
625 if($transport == $this->transport)
627 $this->sendConfirmationCode($screenname, $code, $user);
632 function onUserDeleteRelated($user, &$tables)
634 $tables[] = 'User_im_prefs';
638 function onHaveImPlugin(&$haveImPlugin) {
639 $haveImPlugin = true; // set flag true (we're loaded, after all!)
640 return false; // stop looking
643 function initialize()
645 if( ! common_config('queue', 'enabled'))
647 // TRANS: Server exception thrown trying to initialise an IM plugin without meeting all prerequisites.
648 throw new ServerException(_('Queueing must be enabled to use IM plugins.'));
651 if(is_null($this->transport)){
652 // TRANS: Server exception thrown trying to initialise an IM plugin without a transport method.
653 throw new ServerException(_('Transport cannot be null.'));