lib/queued_xmpp.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Queue-mediated proxy class for outgoing XMPP messages.
   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  Network
  23  * @package   StatusNet
  24  * @author    Brion Vibber <brion@status.net>
  25  * @copyright 2010 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/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR . '/lib/jabber.php';
  35
  36 class Queued_XMPP extends XMPPHP_XMPP
  37 {
  38         /**
  39          * Constructor
  40          *
  41          * @param string  $host
  42          * @param integer $port
  43          * @param string  $user
  44          * @param string  $password
  45          * @param string  $resource
  46          * @param string  $server
  47          * @param boolean $printlog
  48          * @param string  $loglevel
  49          */
  50         public function __construct($host, $port, $user, $password, $resource, $server = null, $printlog = false, $loglevel = null)
  51         {
  52         parent::__construct($host, $port, $user, $password, $resource, $server, $printlog, $loglevel);
  53
  54         // We use $host to connect, but $server to build JIDs if specified.
  55         // This seems to fix an upstream bug where $host was used to build
  56         // $this->basejid, never seen since it isn't actually used in the base
  57         // classes.
  58         if (!$server) {
  59             $server = $this->host;
  60         }
  61         $this->basejid = $this->user . '@' . $server;
  62
  63         // Normally the fulljid is filled out by the server at resource binding
  64         // time, but we need to do it since we're not talking to a real server.
  65         $this->fulljid = "{$this->basejid}/{$this->resource}";
  66     }
  67
  68     /**
  69      * Send a formatted message to the outgoing queue for later forwarding
  70      * to a real XMPP connection.
  71      *
  72      * @param string $msg
  73      */
  74     public function send($msg, $timeout=NULL)
  75     {
  76         $qm = QueueManager::get('xmppout');
  77         $qm->enqueue(strval($msg), 'xmppout');
  78     }
  79
  80     /**
  81      * Since we'll be getting input through a queue system's run loop,
  82      * we'll process one standalone message at a time rather than our
  83      * own XMPP message pump.
  84      *
  85      * @param string $message
  86      */
  87     public function processMessage($message) {
  88        $frame = array_shift($this->frames);
  89        xml_parse($this->parser, $frame->body, false);
  90     }
  91
  92     //@{
  93     /**
  94      * Stream i/o functions disabled; push input through processMessage()
  95      */
  96     public function connect($timeout = 30, $persistent = false, $sendinit = true)
  97     {
  98         throw new Exception("Can't connect to server from XMPP queue proxy.");
  99     }
 100
 101     public function disconnect()
 102     {
 103         throw new Exception("Can't connect to server from XMPP queue proxy.");
 104     }
 105
 106     public function process()
 107     {
 108         throw new Exception("Can't read stream from XMPP queue proxy.");
 109     }
 110
 111     public function processUntil($event, $timeout=-1)
 112     {
 113         throw new Exception("Can't read stream from XMPP queue proxy.");
 114     }
 115
 116     public function read()
 117     {
 118         throw new Exception("Can't read stream from XMPP queue proxy.");
 119     }
 120
 121     public function readyToProcess()
 122     {
 123         throw new Exception("Can't read stream from XMPP queue proxy.");
 124     }
 125     //@}
 126 }
 127