gnu-social/plugins/Xmpp/lib/queuedxmpp.php

129 lines
3.9 KiB
PHP

<?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
/**
* Queue-mediated proxy class for outgoing XMPP messages.
*
* @category Network
* @package GNUsocial
* @author Brion Vibber <brion@status.net>
* @copyright 2010 StatusNet, Inc.
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
defined('GNUSOCIAL') || die();
use XMPPHP\XMPP;
class QueuedXMPP extends XMPP
{
/**
* Reference to the XmppPlugin object we're hooked up to.
*/
public $plugin;
/**
* Constructor
*
* @param XmppPlugin $plugin
* @param string $host
* @param integer $port
* @param string $user
* @param string $password
* @param string $resource
* @param string $server
* @param boolean $printlog
* @param string $loglevel
*/
public function __construct($plugin, $host, $port, $user, $password, $resource, $server = null, $printlog = false, $loglevel = null)
{
$this->plugin = $plugin;
parent::__construct($host, $port, $user, $password, $resource, $server, $printlog, $loglevel);
// We use $host to connect, but $server to build JIDs if specified.
// This seems to fix an upstream bug where $host was used to build
// $this->basejid, never seen since it isn't actually used in the base
// classes.
if (!$server) {
$server = $this->host;
}
$this->basejid = $this->user . '@' . $server;
// Normally the fulljid is filled out by the server at resource binding
// time, but we need to do it since we're not talking to a real server.
$this->fulljid = "{$this->basejid}/{$this->resource}";
}
/**
* Send a formatted message to the outgoing queue for later forwarding
* to a real XMPP connection.
*
* @param string $msg
* @param null $timeout
*/
public function send(string $msg, ?int $timeout = null)
{
@$this->plugin->enqueueOutgoingRaw($msg);
}
//@{
/**
* Stream i/o functions disabled; only do output
* @param int $timeout
* @param bool $persistent
* @param bool $sendinit
* @throws Exception
*/
public function connect(bool $persistent = false, bool $send_init = true, int $timeout = 30): void
{
// No i18n needed. Test message.
throw new Exception('Cannot connect to server from fake XMPP.');
}
public function disconnect(): void
{
// No i18n needed. Test message.
throw new Exception('Cannot connect to server from fake XMPP.');
}
public function process(): void
{
// No i18n needed. Test message.
throw new Exception('Cannot read stream from fake XMPP.');
}
public function processUntil($event, int $timeout = -1): array
{
// No i18n needed. Test message.
throw new Exception('Cannot read stream from fake XMPP.');
}
public function read(): bool
{
// No i18n needed. Test message.
throw new Exception('Cannot read stream from fake XMPP.');
}
public function readyToProcess(): bool
{
// No i18n needed. Test message.
throw new Exception('Cannot read stream from fake XMPP.');
}
//@}
}