3 * StatusNet, the distributed open-source microblogging tool
5 * Queue-mediated proxy class for outgoing XMPP messages.
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 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/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
34 require_once INSTALLDIR . '/lib/jabber.php';
36 class Queued_XMPP extends XMPPHP_XMPP
42 * @param integer $port
44 * @param string $password
45 * @param string $resource
46 * @param string $server
47 * @param boolean $printlog
48 * @param string $loglevel
50 public function __construct($host, $port, $user, $password, $resource, $server = null, $printlog = false, $loglevel = null)
52 parent::__construct($host, $port, $user, $password, $resource, $server, $printlog, $loglevel);
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
59 $server = $this->host;
61 $this->basejid = $this->user . '@' . $server;
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}";
69 * Send a formatted message to the outgoing queue for later forwarding
70 * to a real XMPP connection.
74 public function send($msg, $timeout=NULL)
76 $qm = QueueManager::get('xmppout');
77 $qm->enqueue(strval($msg), 'xmppout');
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.
85 * @param string $message
87 public function processMessage($message) {
88 $frame = array_shift($this->frames);
89 xml_parse($this->parser, $frame->body, false);
94 * Stream i/o functions disabled; push input through processMessage()
96 public function connect($timeout = 30, $persistent = false, $sendinit = true)
98 throw new Exception("Can't connect to server from XMPP queue proxy.");
101 public function disconnect()
103 throw new Exception("Can't connect to server from XMPP queue proxy.");
106 public function process()
108 throw new Exception("Can't read stream from XMPP queue proxy.");
111 public function processUntil($event, $timeout=-1)
113 throw new Exception("Can't read stream from XMPP queue proxy.");
116 public function read()
118 throw new Exception("Can't read stream from XMPP queue proxy.");
121 public function readyToProcess()
123 throw new Exception("Can't read stream from XMPP queue proxy.");