git.gnu.io has moved to IP address 209.51.188.249 -- please double check where you are logging in.

implugin.php 19.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Superclass for plugins that do instant messaging
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Plugin
 * @package   StatusNet
 * @author    Craig Andrews <candrews@integralblue.com>
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET') && !defined('LACONICA')) {
    exit(1);
}

/**
 * Superclass for plugins that do authentication
 *
 * Implementations will likely want to override onStartIoManagerClasses() so that their
 *   IO manager is used
 *
 * @category Plugin
 * @package  StatusNet
 * @author   Craig Andrews <candrews@integralblue.com>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */

abstract class ImPlugin extends Plugin
{
    //name of this IM transport
    public $transport = null;
    //list of screennames that should get all public notices
    public $public = array();

    /**
     * normalize a screenname for comparison
     *
     * @param string $screenname screenname to normalize
     *
     * @return string an equivalent screenname in normalized form
     */
    abstract function normalize($screenname);


    /**
     * validate (ensure the validity of) a screenname
     *
     * @param string $screenname screenname to validate
     *
     * @return boolean
     */
    abstract function validate($screenname);

    /**
     * get the internationalized/translated display name of this IM service
     *
     * @return string
     */
    abstract function getDisplayName();

    /**
     * send a single notice to a given screenname
     * The implementation should put raw data, ready to send, into the outgoing
82
     *   queue using enqueueOutgoingRaw()
83 84 85 86 87 88
     *
     * @param string $screenname screenname to send to
     * @param Notice $notice notice to send
     *
     * @return boolean success value
     */
89
    function sendNotice($screenname, $notice)
90
    {
91
        return $this->sendMessage($screenname, $this->formatNotice($notice));
92 93 94 95 96
    }

    /**
     * send a message (text) to a given screenname
     * The implementation should put raw data, ready to send, into the outgoing
97
     *   queue using enqueueOutgoingRaw()
98 99 100 101 102 103
     *
     * @param string $screenname screenname to send to
     * @param Notice $body text to send
     *
     * @return boolean success value
     */
104
    abstract function sendMessage($screenname, $body);
105 106 107 108

    /**
     * receive a raw message
     * 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 112 113 114
     * 
     * Returning false may CAUSE REPROCESSING OF THE QUEUE ITEM, and should
     * be used for temporary failures only. For permanent failures such as
     * unrecognized addresses, return true to indicate your processing has
     * completed.
115 116 117
     *
     * @param object $data raw IM data
     *
118
     * @return boolean true if processing completed, false for temporary failures
119
     */
120
    abstract function receiveRawMessage($data);
121 122 123 124 125 126

    /**
     * get the screenname of the daemon that sends and receives message for this service
     *
     * @return string screenname of this plugin
     */
127
    abstract function daemonScreenname();
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146

    /**
     * get the microid uri of a given screenname
     *
     * @param string $screenname screenname
     *
     * @return string microid uri
     */
    function microiduri($screenname)
    {
        return $this->transport . ':' . $screenname;    
    }
    //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - MISC ========================\

    /**
     * Put raw message data (ready to send) into the outgoing queue
     *
     * @param object $data
     */
147
    function enqueueOutgoingRaw($data)
148 149 150 151 152 153 154 155 156 157
    {
        $qm = QueueManager::get();
        $qm->enqueue($data, $this->transport . '-out');
    }

    /**
     * Put raw message data (received, ready to be processed) into the incoming queue
     *
     * @param object $data
     */
158
    function enqueueIncomingRaw($data)
159 160 161 162 163 164 165 166 167 168 169 170 171 172
    {
        $qm = QueueManager::get();
        $qm->enqueue($data, $this->transport . '-in');
    }

    /**
     * given a screenname, get the corresponding user
     *
     * @param string $screenname
     *
     * @return User user
     */
    function get_user($screenname)
    {
173
        $user_im_prefs = $this->getUserImPrefsFromScreenname($screenname);
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
        if($user_im_prefs){
            $user = User::staticGet('id', $user_im_prefs->user_id);
            $user_im_prefs->free();
            return $user;
        }else{
            return false;
        }
    }


    /**
     * given a screenname, get the User_im_prefs object for this transport
     *
     * @param string $screenname
     *
     * @return User_im_prefs user_im_prefs
     */
191
    function getUserImPrefsFromScreenname($screenname)
192
    {
193 194 195 196
        $user_im_prefs = User_im_prefs::pkeyGet(
            array('transport' => $this->transport,
                  'screenname' => $this->normalize($screenname)));
        if ($user_im_prefs) {
197
            return $user_im_prefs;
198
        } else {
199 200 201 202 203 204 205 206 207 208 209 210 211 212
            return false;
        }
    }


    /**
     * given a User, get their screenname
     *
     * @param User $user
     *
     * @return string screenname of that user
     */
    function get_screenname($user)
    {
213
        $user_im_prefs = $this->getUserImPrefsFromUser($user);
214
        if ($user_im_prefs) {
215
            return $user_im_prefs->screenname;
216
        } else {
217 218 219 220 221 222 223 224 225 226 227 228
            return false;
        }
    }


    /**
     * given a User, get their User_im_prefs
     *
     * @param User $user
     *
     * @return User_im_prefs user_im_prefs of that user
     */
229
    function getUserImPrefsFromUser($user)
230
    {
231 232 233 234
        $user_im_prefs = User_im_prefs::pkeyGet(
            array('transport' => $this->transport,
                  'user_id' => $user->id));
        if ($user_im_prefs){
235
            return $user_im_prefs;
236
        } else {
237 238 239 240 241 242 243 244 245 246 247 248
            return false;
        }
    }
    //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - SENDING ========================\
    /**
     * Send a message to a given screenname from the site
     *
     * @param string $screenname screenname to send the message to
     * @param string $msg message contents to send
     *
     * @param boolean success
     */
249
    protected function sendFromSite($screenname, $msg)
250 251
    {
        $text = '['.common_config('site', 'name') . '] ' . $msg;
252
        $this->sendMessage($screenname, $text);
253 254 255 256 257 258 259 260 261 262 263
    }

    /**
     * send a confirmation code to a user
     *
     * @param string $screenname screenname sending to
     * @param string $code the confirmation code
     * @param User $user user sending to
     *
     * @return boolean success value
     */
264
    function sendConfirmationCode($screenname, $code, $user)
265 266 267 268 269 270 271 272 273
    {
        $body = sprintf(_('User "%s" on %s has said that your %s screenname belongs to them. ' .
          'If that\'s true, you can confirm by clicking on this URL: ' .
          '%s' .
          ' . (If you cannot click it, copy-and-paste it into the ' .
          'address bar of your browser). If that user isn\'t you, ' .
          'or if you didn\'t request this confirmation, just ignore this message.'),
          $user->nickname, common_config('site', 'name'), $this->getDisplayName(), common_local_url('confirmaddress', array('code' => $code)));

274
        return $this->sendMessage($screenname, $body);
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
    }

    /**
     * send a notice to all public listeners
     *
     * For notices that are generated on the local system (by users), we can optionally
     * forward them to remote listeners by XMPP.
     *
     * @param Notice $notice notice to broadcast
     *
     * @return boolean success flag
     */

    function public_notice($notice)
    {
        // Now, users who want everything

        // FIXME PRIV don't send out private messages here
        // XXX: should we send out non-local messages if public,localonly
        // = false? I think not

        foreach ($this->public as $screenname) {
            common_log(LOG_INFO,
                       'Sending notice ' . $notice->id .
                       ' to public listener ' . $screenname,
                       __FILE__);
301
            $this->sendNotice($screenname, $notice);
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
        }

        return true;
    }

    /**
     * broadcast a notice to all subscribers and reply recipients
     *
     * This function will send a notice to all subscribers on the local server
     * who have IM addresses, and have IM notification enabled, and
     * have this subscription enabled for IM. It also sends the notice to
     * all recipients of @-replies who have IM addresses and IM notification
     * enabled. This is really the heart of IM distribution in StatusNet.
     *
     * @param Notice $notice The notice to broadcast
     *
     * @return boolean success flag
     */

    function broadcast_notice($notice)
    {

        $ni = $notice->whoGets();

        foreach ($ni as $user_id => $reason) {
            $user = User::staticGet($user_id);
            if (empty($user)) {
                // either not a local user, or just not found
                continue;
            }
332
            $user_im_prefs = $this->getUserImPrefsFromUser($user);
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
            if(!$user_im_prefs || !$user_im_prefs->notify){
                continue;
            }

            switch ($reason) {
            case NOTICE_INBOX_SOURCE_REPLY:
                if (!$user_im_prefs->replies) {
                    continue 2;
                }
                break;
            case NOTICE_INBOX_SOURCE_SUB:
                $sub = Subscription::pkeyGet(array('subscriber' => $user->id,
                                                   'subscribed' => $notice->profile_id));
                if (empty($sub) || !$sub->jabber) {
                    continue 2;
                }
                break;
            case NOTICE_INBOX_SOURCE_GROUP:
                break;
            default:
                throw new Exception(sprintf(_("Unknown inbox source %d."), $reason));
            }

            common_log(LOG_INFO,
                       'Sending notice ' . $notice->id . ' to ' . $user_im_prefs->screenname,
                       __FILE__);
359
            $this->sendNotice($user_im_prefs->screenname, $notice);
360 361 362 363 364 365 366 367 368 369 370 371 372 373
            $user_im_prefs->free();
        }

        return true;
    }

    /**
     * makes a plain-text formatted version of a notice, suitable for IM distribution
     *
     * @param Notice  $notice  notice being sent
     *
     * @return string plain-text version of the notice, with user nickname prefixed
     */

374
    function formatNotice($notice)
375 376 377 378 379 380 381 382 383 384 385 386
    {
        $profile = $notice->getProfile();
        return $profile->nickname . ': ' . $notice->content . ' [' . $notice->id . ']';
    }
    //========================UTILITY FUNCTIONS USEFUL TO IMPLEMENTATIONS - RECEIVING ========================\

    /**
     * Attempt to handle a message as a command
     * @param User $user user the message is from
     * @param string $body message text
     * @return boolean true if the message was a command and was executed, false if it was not a command
     */
387
    protected function handleCommand($user, $body)
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
    {
        $inter = new CommandInterpreter();
        $cmd = $inter->handle_command($user, $body);
        if ($cmd) {
            $chan = new IMChannel($this);
            $cmd->execute($chan);
            return true;
        } else {
            return false;
        }
    }

    /**
     * Is some text an autoreply message?
     * @param string $txt message text
     * @return boolean true if autoreply
     */
    protected function is_autoreply($txt)
    {
        if (preg_match('/[\[\(]?[Aa]uto[-\s]?[Rr]e(ply|sponse)[\]\)]/', $txt)) {
            return true;
        } else if (preg_match('/^System: Message wasn\'t delivered. Offline storage size was exceeded.$/', $txt)) {
            return true;
        } else {
            return false;
        }
    }

    /**
     * Is some text an OTR message?
     * @param string $txt message text
     * @return boolean true if OTR
     */
    protected function is_otr($txt)
    {
        if (preg_match('/^\?OTR/', $txt)) {
            return true;
        } else {
            return false;
        }
    }

    /**
     * Helper for handling incoming messages
     * Your incoming message handler will probably want to call this function
     *
     * @param string $from screenname the message was sent from
     * @param string $message message contents
     *
     * @param boolean success
     */
439
    protected function handleIncoming($from, $notice_text)
440 441 442 443 444 445 446
    {
        $user = $this->get_user($from);
        // For common_current_user to work
        global $_cur;
        $_cur = $user;

        if (!$user) {
447
            $this->sendFromSite($from, 'Unknown user; go to ' .
448 449 450 451 452
                             common_local_url('imsettings') .
                             ' to add your address to your account');
            common_log(LOG_WARNING, 'Message from unknown user ' . $from);
            return;
        }
453
        if ($this->handleCommand($user, $notice_text)) {
454 455 456 457 458 459 460 461 462 463 464 465
            common_log(LOG_INFO, "Command message by $from handled.");
            return;
        } else if ($this->is_autoreply($notice_text)) {
            common_log(LOG_INFO, 'Ignoring auto reply from ' . $from);
            return;
        } else if ($this->is_otr($notice_text)) {
            common_log(LOG_INFO, 'Ignoring OTR from ' . $from);
            return;
        } else {

            common_log(LOG_INFO, 'Posting a notice from ' . $user->nickname);

Craig Andrews's avatar
Craig Andrews committed
466
            $this->addNotice($from, $user, $notice_text);
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
        }

        $user->free();
        unset($user);
        unset($_cur);
        unset($message);
    }

    /**
     * Helper for handling incoming messages
     * Your incoming message handler will probably want to call this function
     *
     * @param string $from screenname the message was sent from
     * @param string $message message contents
     *
     * @param boolean success
     */
Craig Andrews's avatar
Craig Andrews committed
484
    protected function addNotice($screenname, $user, $body)
485 486 487 488
    {
        $body = trim(strip_tags($body));
        $content_shortened = common_shorten_links($body);
        if (Notice::contentTooLong($content_shortened)) {
489
          $this->sendFromSite($screenname, sprintf(_('Message too long - maximum is %1$d characters, you sent %2$d.'),
490 491 492 493 494 495 496 497 498
                                          Notice::maxContent(),
                                          mb_strlen($content_shortened)));
          return;
        }

        try {
            $notice = Notice::saveNew($user->id, $content_shortened, $this->transport);
        } catch (Exception $e) {
            common_log(LOG_ERR, $e->getMessage());
499
            $this->sendFromSite($from, $e->getMessage());
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
            return;
        }

        common_broadcast_notice($notice);
        common_log(LOG_INFO,
                   'Added notice ' . $notice->id . ' from user ' . $user->nickname);
        $notice->free();
        unset($notice);
    }

    //========================EVENT HANDLERS========================\
    
    /**
     * Register notice queue handler
     *
     * @param QueueManager $manager
     *
     * @return boolean hook return
     */
    function onEndInitializeQueueManager($manager)
    {
521
        $manager->connect($this->transport . '-in', new ImReceiverQueueHandler($this), 'im');
522
        $manager->connect($this->transport, new ImQueueHandler($this));
523
        $manager->connect($this->transport . '-out', new ImSenderQueueHandler($this), 'im');
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
        return true;
    }

    function onStartImDaemonIoManagers(&$classes)
    {
        //$classes[] = new ImManager($this); // handles sending/receiving/pings/reconnects
        return true;
    }

    function onStartEnqueueNotice($notice, &$transports)
    {
        $profile = Profile::staticGet($notice->profile_id);

        if (!$profile) {
            common_log(LOG_WARNING, 'Refusing to broadcast notice with ' .
                       'unknown profile ' . common_log_objstring($notice),
                       __FILE__);
        }else{
            $transports[] = $this->transport;
        }

        return true;
    }

    function onEndShowHeadElements($action)
    {
        $aname = $action->trimmed('action');

        if ($aname == 'shownotice') {

            $user_im_prefs = new User_im_prefs();
            $user_im_prefs->user_id = $action->profile->id;
            $user_im_prefs->transport = $this->transport;

            if ($user_im_prefs->find() && $user_im_prefs->fetch() && $user_im_prefs->microid && $action->notice->uri) {
                $id = new Microid($this->microiduri($user_im_prefs->screenname),
                                  $action->notice->uri);
                $action->element('meta', array('name' => 'microid',
                                             'content' => $id->toString()));
            }

        } else if ($aname == 'showstream') {

            $user_im_prefs = new User_im_prefs();
            $user_im_prefs->user_id = $action->user->id;
            $user_im_prefs->transport = $this->transport;

            if ($user_im_prefs->find() && $user_im_prefs->fetch() && $user_im_prefs->microid && $action->profile->profileurl) {
                $id = new Microid($this->microiduri($user_im_prefs->screenname),
                                  $action->selfUrl());
                $action->element('meta', array('name' => 'microid',
                                               'content' => $id->toString()));
            }
        }
    }

    function onNormalizeImScreenname($transport, &$screenname)
    {
        if($transport == $this->transport)
        {
            $screenname = $this->normalize($screenname);
            return false;
        }
    }

    function onValidateImScreenname($transport, $screenname, &$valid)
    {
        if($transport == $this->transport)
        {
            $valid = $this->validate($screenname);
            return false;
        }
    }

    function onGetImTransports(&$transports)
    {
600 601
        $transports[$this->transport] = array(
            'display' => $this->getDisplayName(),
602
            'daemonScreenname' => $this->daemonScreenname());
603 604 605 606 607 608
    }

    function onSendImConfirmationCode($transport, $screenname, $code, $user)
    {
        if($transport == $this->transport)
        {
609
            $this->sendConfirmationCode($screenname, $code, $user);
610 611 612 613 614 615 616 617 618 619 620 621
            return false;
        }
    }

    function onUserDeleteRelated($user, &$tables)
    {
        $tables[] = 'User_im_prefs';
        return true;
    }

    function initialize()
    {
622 623 624 625 626
        if( ! common_config('queue', 'enabled'))
        {
            throw new ServerException("Queueing must be enabled to use IM plugins");
        }

627
        if(is_null($this->transport)){
628
            throw new ServerException('transport cannot be null');
629 630 631
        }
    }
}