lib/implugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Superclass for plugins that do instant messaging
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  Plugin
  23  * @package   StatusNet
  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/
  27  */
  28
  29 if (!defined('STATUSNET') && !defined('LACONICA')) {
  30     exit(1);
  31 }
  32
  33 /**
  34  * Superclass for plugins that do authentication
  35  *
  36  * Implementations will likely want to override onStartIoManagerClasses() so that their
  37  *   IO manager is used
  38  *
  39  * @category Plugin
  40  * @package  StatusNet
  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/
  44  */
  45 abstract class ImPlugin extends Plugin
  46 {
  47     //name of this IM transport
  48     public $transport = null;
  49     //list of screennames that should get all public notices
  50     public $public = array();
  51
  52     protected $requires_cli = true;
  53
  54     /**
  55      * normalize a screenname for comparison
  56      *
  57      * @param string $screenname screenname to normalize
  58      *
  59      * @return string an equivalent screenname in normalized form
  60      */
  61     abstract function normalize($screenname);
  62
  63     /**
  64      * validate (ensure the validity of) a screenname
  65      *
  66      * @param string $screenname screenname to validate
  67      *
  68      * @return boolean
  69      */
  70     abstract function validate($screenname);
  71
  72     /**
  73      * get the internationalized/translated display name of this IM service
  74      *
  75      * @return string
  76      */
  77     abstract function getDisplayName();
  78
  79     /**
  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()
  83      *
  84      * @param string $screenname screenname to send to
  85      * @param Notice $notice notice to send
  86      *
  87      * @return boolean success value
  88      */
  89     function sendNotice($screenname, Notice $notice)
  90     {
  91         return $this->sendMessage($screenname, $this->formatNotice($notice));
  92     }
  93
  94     /**
  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()
  98      *
  99      * @param string $screenname screenname to send to
 100      * @param Notice $body text to send
 101      *
 102      * @return boolean success value
 103      */
 104     abstract function sendMessage($screenname, $body);
 105
 106     /**
 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()
 110      *
 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
 114      * completed.
 115      *
 116      * @param object $data raw IM data
 117      *
 118      * @return boolean true if processing completed, false for temporary failures
 119      */
 120     abstract function receiveRawMessage($data);
 121
 122     /**
 123      * get the screenname of the daemon that sends and receives message for this service
 124      *
 125      * @return string screenname of this plugin
 126      */
 127     abstract function daemonScreenname();
 128
 129     /**
 130      * get the microid uri of a given screenname
 131      *
 132      * @param string $screenname screenname
 133      *
 134      * @return string microid uri
 135      */
 136     function microiduri($screenname)
 137     {
 138         return $this->transport . ':' . $screenname;
 139     }
 140     //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - MISC ========================\
 141
 142     /**
 143      * Put raw message data (ready to send) into the outgoing queue
 144      *
 145      * @param object $data
 146      */
 147     function enqueueOutgoingRaw($data)
 148     {
 149         $qm = QueueManager::get();
 150         $qm->enqueue($data, $this->transport . '-out');
 151     }
 152
 153     /**
 154      * Put raw message data (received, ready to be processed) into the incoming queue
 155      *
 156      * @param object $data
 157      */
 158     function enqueueIncomingRaw($data)
 159     {
 160         $qm = QueueManager::get();
 161         $qm->enqueue($data, $this->transport . '-in');
 162     }
 163
 164     /**
 165      * given a screenname, get the corresponding user
 166      *
 167      * @param string $screenname
 168      *
 169      * @return User user
 170      */
 171     function getUser($screenname)
 172     {
 173         $user_im_prefs = $this->getUserImPrefsFromScreenname($screenname);
 174         if($user_im_prefs){
 175             $user = User::getKV('id', $user_im_prefs->user_id);
 176             $user_im_prefs->free();
 177             return $user;
 178         }else{
 179             return false;
 180         }
 181     }
 182
 183     /**
 184      * given a screenname, get the User_im_prefs object for this transport
 185      *
 186      * @param string $screenname
 187      *
 188      * @return User_im_prefs user_im_prefs
 189      */
 190     function getUserImPrefsFromScreenname($screenname)
 191     {
 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;
 197         } else {
 198             return false;
 199         }
 200     }
 201
 202     /**
 203      * given a User, get their screenname
 204      *
 205      * @param User $user
 206      *
 207      * @return string screenname of that user
 208      */
 209     function getScreenname($user)
 210     {
 211         $user_im_prefs = $this->getUserImPrefsFromUser($user);
 212         if ($user_im_prefs) {
 213             return $user_im_prefs->screenname;
 214         } else {
 215             return false;
 216         }
 217     }
 218
 219     /**
 220      * given a User, get their User_im_prefs
 221      *
 222      * @param User $user
 223      *
 224      * @return User_im_prefs user_im_prefs of that user
 225      */
 226     function getUserImPrefsFromUser($user)
 227     {
 228         $user_im_prefs = User_im_prefs::pkeyGet(
 229             array('transport' => $this->transport,
 230                   'user_id' => $user->id));
 231         if ($user_im_prefs){
 232             return $user_im_prefs;
 233         } else {
 234             return false;
 235         }
 236     }
 237     //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - SENDING ========================\
 238     /**
 239      * Send a message to a given screenname from the site
 240      *
 241      * @param string $screenname screenname to send the message to
 242      * @param string $msg message contents to send
 243      *
 244      * @param boolean success
 245      */
 246     protected function sendFromSite($screenname, $msg)
 247     {
 248         $text = '['.common_config('site', 'name') . '] ' . $msg;
 249         $this->sendMessage($screenname, $text);
 250     }
 251
 252     /**
 253      * Send a confirmation code to a user
 254      *
 255      * @param string $screenname screenname sending to
 256      * @param string $code the confirmation code
 257      * @param User $user user sending to
 258      *
 259      * @return boolean success value
 260      */
 261     function sendConfirmationCode($screenname, $code, $user)
 262     {
 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: ' .
 268           '%4$s' .
 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)));
 273
 274         return $this->sendMessage($screenname, $body);
 275     }
 276
 277     /**
 278      * send a notice to all public listeners
 279      *
 280      * For notices that are generated on the local system (by users), we can optionally
 281      * forward them to remote listeners by XMPP.
 282      *
 283      * @param Notice $notice notice to broadcast
 284      *
 285      * @return boolean success flag
 286      */
 287
 288     function publicNotice($notice)
 289     {
 290         // Now, users who want everything
 291
 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
 295
 296         foreach ($this->public as $screenname) {
 297             common_log(LOG_INFO,
 298                        'Sending notice ' . $notice->id .
 299                        ' to public listener ' . $screenname,
 300                        __FILE__);
 301             $this->sendNotice($screenname, $notice);
 302         }
 303
 304         return true;
 305     }
 306
 307     /**
 308      * broadcast a notice to all subscribers and reply recipients
 309      *
 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.
 315      *
 316      * @param Notice $notice The notice to broadcast
 317      *
 318      * @return boolean success flag
 319      */
 320
 321     function broadcastNotice($notice)
 322     {
 323         $ni = $notice->whoGets();
 324
 325         foreach ($ni as $user_id => $reason) {
 326             $user = User::getKV($user_id);
 327             if (empty($user)) {
 328                 // either not a local user, or just not found
 329                 continue;
 330             }
 331             $user_im_prefs = $this->getUserImPrefsFromUser($user);
 332             if(!$user_im_prefs || !$user_im_prefs->notify){
 333                 continue;
 334             }
 335
 336             switch ($reason) {
 337             case NOTICE_INBOX_SOURCE_REPLY:
 338                 if (!$user_im_prefs->replies) {
 339                     continue 2;
 340                 }
 341                 break;
 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) {
 346                     continue 2;
 347                 }
 348                 break;
 349             case NOTICE_INBOX_SOURCE_GROUP:
 350                 break;
 351             default:
 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));
 355             }
 356
 357             common_log(LOG_INFO,
 358                        'Sending notice ' . $notice->id . ' to ' . $user_im_prefs->screenname,
 359                        __FILE__);
 360             $this->sendNotice($user_im_prefs->screenname, $notice);
 361             $user_im_prefs->free();
 362         }
 363
 364         return true;
 365     }
 366
 367     /**
 368      * makes a plain-text formatted version of a notice, suitable for IM distribution
 369      *
 370      * @param Notice  $notice  notice being sent
 371      *
 372      * @return string plain-text version of the notice, with user nickname prefixed
 373      */
 374
 375     protected function formatNotice(Notice $notice)
 376     {
 377         $profile = $notice->getProfile();
 378
 379         try {
 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;
 385         }
 386
 387         return sprintf('%1$s: %2$s [%3$u]', $nicknames, $notice->content, $notice->id);
 388     }
 389     //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - RECEIVING ========================\
 390
 391     /**
 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
 396      */
 397     protected function handleCommand($user, $body)
 398     {
 399         $inter = new CommandInterpreter();
 400         $cmd = $inter->handle_command($user, $body);
 401         if ($cmd) {
 402             $chan = new IMChannel($this);
 403             $cmd->execute($chan);
 404             return true;
 405         }
 406         return false;
 407     }
 408
 409     /**
 410      * Is some text an autoreply message?
 411      * @param string $txt message text
 412      * @return boolean true if autoreply
 413      */
 414     protected function isAutoreply($txt)
 415     {
 416         if (preg_match('/[\[\(]?[Aa]uto[-\s]?[Rr]e(ply|sponse)[\]\)]/', $txt)) {
 417             return true;
 418         } else if (preg_match('/^System: Message wasn\'t delivered. Offline storage size was exceeded.$/', $txt)) {
 419             return true;
 420         } else {
 421             return false;
 422         }
 423     }
 424
 425     /**
 426      * Is some text an OTR message?
 427      * @param string $txt message text
 428      * @return boolean true if OTR
 429      */
 430     protected function isOtr($txt)
 431     {
 432         if (preg_match('/^\?OTR/', $txt)) {
 433             return true;
 434         } else {
 435             return false;
 436         }
 437     }
 438
 439     /**
 440      * Helper for handling incoming messages
 441      * Your incoming message handler will probably want to call this function
 442      *
 443      * @param string $from screenname the message was sent from
 444      * @param string $message message contents
 445      *
 446      * @param boolean success
 447      */
 448     protected function handleIncoming($from, $notice_text)
 449     {
 450         $user = $this->getUser($from);
 451         // For common_current_user to work
 452         global $_cur;
 453         $_cur = $user;
 454
 455         if (!$user) {
 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);
 460             return;
 461         }
 462         if ($this->handleCommand($user, $notice_text)) {
 463             common_log(LOG_INFO, "Command message by $from handled.");
 464             return;
 465         } else if ($this->isAutoreply($notice_text)) {
 466             common_log(LOG_INFO, 'Ignoring auto reply from ' . $from);
 467             return;
 468         } else if ($this->isOtr($notice_text)) {
 469             common_log(LOG_INFO, 'Ignoring OTR from ' . $from);
 470             return;
 471         } else {
 472
 473             common_log(LOG_INFO, 'Posting a notice from ' . $user->nickname);
 474
 475             $this->addNotice($from, $user, $notice_text);
 476         }
 477
 478         $user->free();
 479         unset($user);
 480         unset($_cur);
 481         unset($message);
 482     }
 483
 484     /**
 485      * Helper for handling incoming messages
 486      * Your incoming message handler will probably want to call this function
 487      *
 488      * @param string $from screenname the message was sent from
 489      * @param string $message message contents
 490      *
 491      * @param boolean success
 492      */
 493     protected function addNotice($screenname, $user, $body)
 494     {
 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)));
 506           return;
 507         }
 508
 509         try {
 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());
 514             return;
 515         }
 516
 517         common_log(LOG_INFO,
 518                    'Added notice ' . $notice->id . ' from user ' . $user->nickname);
 519         $notice->free();
 520         unset($notice);
 521     }
 522
 523     //========================EVENT HANDLERS========================\
 524
 525     /**
 526      * Register notice queue handler
 527      *
 528      * @param QueueManager $manager
 529      *
 530      * @return boolean hook return
 531      */
 532     function onEndInitializeQueueManager($manager)
 533     {
 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');
 541         }
 542         return true;
 543     }
 544
 545     function onStartImDaemonIoManagers(&$classes)
 546     {
 547         //$classes[] = new ImManager($this); // handles sending/receiving/pings/reconnects
 548         return true;
 549     }
 550
 551     function onStartEnqueueNotice($notice, &$transports)
 552     {
 553         $profile = Profile::getKV($notice->profile_id);
 554
 555         if (!$profile) {
 556             common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
 557                        'unknown profile ' . common_log_objstring($notice),
 558                        __FILE__);
 559         }else{
 560             $transports[] = $this->transport;
 561         }
 562
 563         return true;
 564     }
 565
 566     function onEndShowHeadElements(Action $action)
 567     {
 568         if ($action instanceof ShownoticeAction) {
 569
 570             $user_im_prefs = new User_im_prefs();
 571             $user_im_prefs->user_id = $action->notice->getProfile()->getID();
 572             $user_im_prefs->transport = $this->transport;
 573
 574             if ($user_im_prefs->find() && $user_im_prefs->fetch() && $user_im_prefs->microid && $action->notice->uri) {
 575                 $id = new Microid($this->microiduri($user_im_prefs->screenname),
 576                                   $action->notice->uri);
 577                 $action->element('meta', array('name' => 'microid',
 578                                              'content' => $id->toString()));
 579             }
 580
 581         } elseif ($action instanceof ShowstreamAction) {
 582
 583             $user_im_prefs = new User_im_prefs();
 584             $user_im_prefs->user_id = $action->getTarget()->getID();
 585             $user_im_prefs->transport = $this->transport;
 586
 587             if ($user_im_prefs->find() && $user_im_prefs->fetch() && $user_im_prefs->microid && $action->getTarget()->getUrl()) {
 588                 $id = new Microid($this->microiduri($user_im_prefs->screenname),
 589                                   $action->selfUrl());
 590                 $action->element('meta', array('name' => 'microid',
 591                                                'content' => $id->toString()));
 592             }
 593         }
 594     }
 595
 596     function onNormalizeImScreenname($transport, &$screenname)
 597     {
 598         if($transport == $this->transport)
 599         {
 600             $screenname = $this->normalize($screenname);
 601             return false;
 602         }
 603     }
 604
 605     function onValidateImScreenname($transport, $screenname, &$valid)
 606     {
 607         if($transport == $this->transport)
 608         {
 609             $valid = $this->validate($screenname);
 610             return false;
 611         }
 612     }
 613
 614     function onGetImTransports(&$transports)
 615     {
 616         $transports[$this->transport] = array(
 617             'display' => $this->getDisplayName(),
 618             'daemonScreenname' => $this->daemonScreenname());
 619     }
 620
 621     function onSendImConfirmationCode($transport, $screenname, $code, $user)
 622     {
 623         if($transport == $this->transport)
 624         {
 625             $this->sendConfirmationCode($screenname, $code, $user);
 626             return false;
 627         }
 628     }
 629
 630     function onUserDeleteRelated($user, &$tables)
 631     {
 632         $tables[] = 'User_im_prefs';
 633         return true;
 634     }
 635
 636     function onHaveImPlugin(&$haveImPlugin) {
 637         $haveImPlugin = true; // set flag true (we're loaded, after all!)
 638         return false; // stop looking
 639     }
 640
 641     function initialize()
 642     {
 643         if( ! common_config('queue', 'enabled'))
 644         {
 645             // TRANS: Server exception thrown trying to initialise an IM plugin without meeting all prerequisites.
 646             throw new ServerException(_('Queueing must be enabled to use IM plugins.'));
 647         }
 648
 649         if(is_null($this->transport)){
 650             // TRANS: Server exception thrown trying to initialise an IM plugin without a transport method.
 651             throw new ServerException(_('Transport cannot be null.'));
 652         }
 653     }
 654 }