mirror of
https://github.com/NNTmux/newznab-tmux.git
synced 2026-08-28 22:01:33 +00:00
DariusIII
1394 lines
52 KiB
PHP
1394 lines
52 KiB
PHP
<?php
|
||
|
||
namespace App\Services\NNTP;
|
||
|
||
use App\Models\Settings;
|
||
use App\Services\Tmux\Tmux;
|
||
use App\Services\YencService;
|
||
|
||
/*
|
||
* Response codes not defined in Net_NNTP
|
||
*/
|
||
defined('NET_NNTP_PROTOCOL_RESPONSECODE_DISCONNECTING_FORCED') || define('NET_NNTP_PROTOCOL_RESPONSECODE_DISCONNECTING_FORCED', 400);
|
||
defined('NET_NNTP_PROTOCOL_RESPONSECODE_XGTITLE_GROUPS_UNAVAILABLE') || define('NET_NNTP_PROTOCOL_RESPONSECODE_XGTITLE_GROUPS_UNAVAILABLE', 481);
|
||
defined('NET_NNTP_PROTOCOL_RESPONSECODE_TLS_FAILED_NEGOTIATION') || define('NET_NNTP_PROTOCOL_RESPONSECODE_TLS_FAILED_NEGOTIATION', 580);
|
||
|
||
/**
|
||
* NNTP Service for connecting to usenet, retrieving articles and article headers,
|
||
* decoding yEnc articles, and decompressing article headers.
|
||
*
|
||
* This service wraps the Net_NNTP_Client class with enhanced functionality
|
||
* and Laravel-friendly dependency injection.
|
||
*/
|
||
class NNTPService extends \Net_NNTP_Client
|
||
{
|
||
protected bool $_debugBool;
|
||
|
||
protected bool $_echo;
|
||
|
||
/**
|
||
* Does the server support XFeature GZip header compression?
|
||
*/
|
||
protected bool $_compressionSupported = true;
|
||
|
||
/**
|
||
* Is header compression enabled for the session?
|
||
*/
|
||
protected bool $_compressionEnabled = false;
|
||
|
||
/**
|
||
* Currently selected group.
|
||
*/
|
||
protected string $_currentGroup = '';
|
||
|
||
protected string $_currentPort = 'NNTP_PORT';
|
||
|
||
/**
|
||
* Address of the current NNTP server.
|
||
*/
|
||
protected string $_currentServer = 'NNTP_SERVER';
|
||
|
||
/**
|
||
* Are we allowed to post to usenet?
|
||
*/
|
||
protected bool $_postingAllowed = false;
|
||
|
||
/**
|
||
* How many times should we try to reconnect to the NNTP server?
|
||
*/
|
||
protected int $_nntpRetries;
|
||
|
||
/**
|
||
* How many connections should we use on primary NNTP server.
|
||
*/
|
||
protected string $_primaryNntpConnections;
|
||
|
||
/**
|
||
* How many connections should we use on alternate NNTP server.
|
||
*/
|
||
protected string $_alternateNntpConnections;
|
||
|
||
/**
|
||
* How many connections do we use on primary NNTP server.
|
||
*/
|
||
protected int $_primaryCurrentNntpConnections;
|
||
|
||
/**
|
||
* How many connections do we use on alternate NNTP server.
|
||
*/
|
||
protected int $_alternateCurrentNntpConnections;
|
||
|
||
/**
|
||
* Seconds to wait for the blocking socket to timeout.
|
||
*/
|
||
protected int $_socketTimeout = 120;
|
||
|
||
protected Tmux $_tmux;
|
||
|
||
/**
|
||
* @var resource|null
|
||
*/
|
||
protected $_socket = null;
|
||
|
||
/**
|
||
* Cached config values for performance.
|
||
*/
|
||
protected string $_configServer;
|
||
|
||
protected string $_configAlternateServer;
|
||
|
||
protected int $_configPort;
|
||
|
||
protected int $_configAlternatePort;
|
||
|
||
protected bool $_configSsl;
|
||
|
||
protected bool $_configAlternateSsl;
|
||
|
||
protected string $_configUsername;
|
||
|
||
protected string $_configPassword;
|
||
|
||
protected string $_configAlternateUsername;
|
||
|
||
protected string $_configAlternatePassword;
|
||
|
||
protected int $_configSocketTimeout;
|
||
|
||
protected int $_configAlternateSocketTimeout;
|
||
|
||
protected bool $_configCompressedHeaders;
|
||
|
||
/**
|
||
* If on unix, hide yydecode CLI output.
|
||
*/
|
||
protected string $_yEncSilence;
|
||
|
||
/**
|
||
* Path to temp yEnc input storage file.
|
||
*/
|
||
protected string $_yEncTempInput;
|
||
|
||
/**
|
||
* Path to temp yEnc output storage file.
|
||
*/
|
||
protected string $_yEncTempOutput;
|
||
|
||
/**
|
||
* YEnc encoding/decoding service.
|
||
*/
|
||
protected YencService $_yencService;
|
||
|
||
/**
|
||
* Create a new NNTP service instance.
|
||
*/
|
||
public function __construct(?Tmux $tmux = null, ?YencService $yencService = null)
|
||
{
|
||
parent::__construct();
|
||
|
||
$this->_echo = config('nntmux.echocli');
|
||
$this->_tmux = $tmux ?? new Tmux;
|
||
$this->_yencService = $yencService ?? app(YencService::class);
|
||
$this->_nntpRetries = Settings::settingValue('nntpretries') !== '' ? (int) Settings::settingValue('nntpretries') : 0 + 1;
|
||
|
||
$this->initializeConfig();
|
||
}
|
||
|
||
/**
|
||
* Initialize configuration values from Laravel config.
|
||
*/
|
||
protected function initializeConfig(): void
|
||
{
|
||
$this->_configServer = config('nntmux_nntp.server');
|
||
$this->_configAlternateServer = config('nntmux_nntp.alternate_server');
|
||
$this->_configPort = (int) config('nntmux_nntp.port');
|
||
$this->_configAlternatePort = (int) config('nntmux_nntp.alternate_server_port');
|
||
$this->_configSsl = (bool) config('nntmux_nntp.ssl');
|
||
$this->_configAlternateSsl = (bool) config('nntmux_nntp.alternate_server_ssl');
|
||
$this->_configUsername = config('nntmux_nntp.username') ?? '';
|
||
$this->_configPassword = config('nntmux_nntp.password') ?? '';
|
||
$this->_configAlternateUsername = config('nntmux_nntp.alternate_server_username') ?? '';
|
||
$this->_configAlternatePassword = config('nntmux_nntp.alternate_server_password') ?? '';
|
||
$this->_configSocketTimeout = (int) (config('nntmux_nntp.socket_timeout') ?: $this->_socketTimeout);
|
||
$this->_configAlternateSocketTimeout = (int) (config('nntmux_nntp.alternate_server_socket_timeout') ?: $this->_socketTimeout);
|
||
$this->_configCompressedHeaders = (bool) config('nntmux_nntp.compressed_headers');
|
||
|
||
$this->_currentPort = $this->_configPort;
|
||
$this->_currentServer = $this->_configServer;
|
||
$this->_primaryNntpConnections = config('nntmux_nntp.main_nntp_connections');
|
||
$this->_alternateNntpConnections = config('nntmux_nntp.alternate_nntp_connections');
|
||
$this->_selectedGroupSummary = null;
|
||
$this->_overviewFormatCache = null;
|
||
}
|
||
|
||
/**
|
||
* Destruct.
|
||
* Close the NNTP connection if still connected.
|
||
*/
|
||
public function __destruct()
|
||
{
|
||
$this->doQuit();
|
||
}
|
||
|
||
/**
|
||
* Connect to a usenet server.
|
||
*
|
||
* @param bool $compression Should we attempt to enable XFeature Gzip compression on this connection?
|
||
* @param bool $alternate Use the alternate NNTP connection.
|
||
* @return mixed On success = (bool) Did we successfully connect to the usenet?
|
||
*
|
||
* @throws \Exception
|
||
* On failure = (object) PEAR_Error.
|
||
*/
|
||
public function doConnect(bool $compression = true, bool $alternate = false): mixed
|
||
{
|
||
$primaryUSP = [
|
||
'ip' => gethostbyname($this->_configServer),
|
||
'port' => $this->_configPort,
|
||
];
|
||
$alternateUSP = [
|
||
'ip_a' => gethostbyname($this->_configAlternateServer),
|
||
'port_a' => $this->_configAlternatePort,
|
||
];
|
||
$primaryConnections = $this->_tmux->getUSPConnections('primary', $primaryUSP);
|
||
$alternateConnections = $this->_tmux->getUSPConnections('alternate', $alternateUSP);
|
||
if ($this->_isConnected() && (($alternate && $this->_currentServer === $this->_configAlternateServer && ($this->_primaryNntpConnections < $alternateConnections['alternate']['active'])) || (! $alternate && $this->_currentServer === $this->_configServer && ($this->_primaryNntpConnections < $primaryConnections['primary']['active'])))) {
|
||
return true;
|
||
}
|
||
|
||
$this->doQuit();
|
||
|
||
$ret = $connected = $cError = $aError = false;
|
||
|
||
// Set variables to connect based on if we are using the alternate provider or not.
|
||
if (! $alternate) {
|
||
$sslEnabled = $this->_configSsl;
|
||
$this->_currentServer = $this->_configServer;
|
||
$this->_currentPort = $this->_configPort;
|
||
$userName = $this->_configUsername;
|
||
$password = $this->_configPassword;
|
||
$socketTimeout = $this->_configSocketTimeout;
|
||
} else {
|
||
$sslEnabled = $this->_configAlternateSsl;
|
||
$this->_currentServer = $this->_configAlternateServer;
|
||
$this->_currentPort = $this->_configAlternatePort;
|
||
$userName = $this->_configAlternateUsername;
|
||
$password = $this->_configAlternatePassword;
|
||
$socketTimeout = $this->_configAlternateSocketTimeout;
|
||
}
|
||
|
||
$enc = ($sslEnabled ? ' (ssl)' : ' (non-ssl)');
|
||
$sslEnabled = ($sslEnabled ? 'tls' : false);
|
||
|
||
// Try to connect until we run of out tries.
|
||
$retries = $this->_nntpRetries;
|
||
while (true) {
|
||
$retries--;
|
||
$authenticated = false;
|
||
|
||
// If we are not connected, try to connect.
|
||
if (! $connected) {
|
||
$ret = $this->connect($this->_currentServer, $sslEnabled, $this->_currentPort, 5, $socketTimeout);
|
||
}
|
||
// Check if we got an error while connecting.
|
||
$cErr = self::isError($ret);
|
||
|
||
// If no error, we are connected.
|
||
if (! $cErr) {
|
||
// Say that we are connected so we don't retry.
|
||
$connected = true;
|
||
// When there is no error it returns bool if we are allowed to post or not.
|
||
$this->_postingAllowed = $ret;
|
||
} elseif (! $cError) {
|
||
$cError = $ret->getMessage();
|
||
}
|
||
|
||
// If error, try to connect again.
|
||
if ($cErr && $retries > 0) {
|
||
continue;
|
||
}
|
||
|
||
// If we have no more retries and could not connect, return an error.
|
||
if ($retries === 0 && ! $connected) {
|
||
$message =
|
||
'Cannot connect to server '.
|
||
$this->_currentServer.
|
||
$enc.
|
||
': '.
|
||
$cError;
|
||
|
||
return $this->throwError(cli()->error($message));
|
||
}
|
||
|
||
// If we are connected, try to authenticate.
|
||
if ($connected) {
|
||
// If the username is empty it probably means the server does not require a username.
|
||
if ($userName === '') {
|
||
$authenticated = true;
|
||
|
||
// Try to authenticate to usenet.
|
||
} else {
|
||
$ret2 = $this->authenticate($userName, $password);
|
||
|
||
// Check if there was an error authenticating.
|
||
$aErr = self::isError($ret2);
|
||
|
||
// If there was no error, then we are authenticated.
|
||
if (! $aErr) {
|
||
$authenticated = true;
|
||
} elseif (! $aError) {
|
||
$aError = $ret2->getMessage();
|
||
}
|
||
|
||
// If error, try to authenticate again.
|
||
if ($aErr && $retries > 0) {
|
||
continue;
|
||
}
|
||
|
||
// If we ran out of retries, return an error.
|
||
if ($retries === 0 && ! $authenticated) {
|
||
$message =
|
||
'Cannot authenticate to server '.
|
||
$this->_currentServer.
|
||
$enc.
|
||
' - '.
|
||
$userName.
|
||
' ('.$aError.')';
|
||
|
||
return $this->throwError(cli()->error($message));
|
||
}
|
||
}
|
||
}
|
||
// If we are connected and authenticated, try enabling compression if we have it enabled.
|
||
if ($connected && $authenticated) {
|
||
// Check if we should use compression on the connection.
|
||
if (! $compression || ! $this->_configCompressedHeaders) {
|
||
$this->_compressionSupported = false;
|
||
}
|
||
|
||
return true;
|
||
}
|
||
// If we reached this point and have not connected after all retries, break out of the loop.
|
||
if ($retries === 0) {
|
||
break;
|
||
}
|
||
|
||
// Sleep .4 seconds between retries.
|
||
usleep(400000);
|
||
}
|
||
// If we somehow got out of the loop, return an error.
|
||
$message = 'Unable to connect to '.$this->_currentServer.$enc;
|
||
|
||
return $this->throwError(cli()->error($message));
|
||
}
|
||
|
||
/**
|
||
* Disconnect from the current NNTP server.
|
||
*
|
||
* @param bool $force Force quit even if not connected?
|
||
* @return mixed On success : (bool) Did we successfully disconnect from usenet?
|
||
* On Failure : (object) PEAR_Error.
|
||
*/
|
||
public function doQuit(bool $force = false): mixed
|
||
{
|
||
$this->_resetProperties();
|
||
|
||
// Check if we are connected to usenet.
|
||
if ($force || $this->_isConnected(false)) {
|
||
// Disconnect from usenet.
|
||
return $this->disconnect();
|
||
}
|
||
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* Reset some properties when disconnecting from usenet.
|
||
*/
|
||
protected function _resetProperties(): void
|
||
{
|
||
$this->_compressionEnabled = false;
|
||
$this->_compressionSupported = true;
|
||
$this->_currentGroup = '';
|
||
$this->_postingAllowed = false;
|
||
$this->_selectedGroupSummary = null;
|
||
$this->_overviewFormatCache = null;
|
||
$this->_socket = null;
|
||
}
|
||
|
||
/**
|
||
* Attempt to enable compression if the admin enabled the site setting.
|
||
*
|
||
* @note This can be used to enable compression if the server was connected without compression.
|
||
*
|
||
* @throws \Exception
|
||
*/
|
||
public function enableCompression(): void
|
||
{
|
||
if (! $this->_configCompressedHeaders) {
|
||
return;
|
||
}
|
||
$this->_enableCompression();
|
||
}
|
||
|
||
/**
|
||
* @param string $group Name of the group to select.
|
||
* @param mixed $articles (optional) experimental! When true the article numbers is returned in 'articles'.
|
||
* @param bool $force Force a refresh to get updated data from the usenet server.
|
||
* @return mixed On success : (array) Group information.
|
||
*
|
||
* @throws \Exception
|
||
* On failure : (object) PEAR_Error.
|
||
*/
|
||
public function selectGroup(string $group, mixed $articles = false, bool $force = false): mixed
|
||
{
|
||
$connected = $this->_checkConnection(false);
|
||
if ($connected !== true) {
|
||
return $connected;
|
||
}
|
||
|
||
// Check if the current selected group is the same, or if we have not selected a group or if a fresh summary is wanted.
|
||
if ($force || $this->_currentGroup !== $group || $this->_selectedGroupSummary === null) {
|
||
$this->_currentGroup = $group;
|
||
|
||
return parent::selectGroup($group, $articles);
|
||
}
|
||
|
||
return $this->_selectedGroupSummary;
|
||
}
|
||
|
||
/**
|
||
* Fetch an overview of article(s) in the currently selected group.
|
||
*
|
||
* @return mixed On success : (array) Multidimensional array with article headers.
|
||
*
|
||
* @throws \Exception
|
||
* On failure : (object) PEAR_Error.
|
||
*/
|
||
public function getOverview($range = null, $names = true, $forceNames = true): mixed
|
||
{
|
||
$connected = $this->_checkConnection();
|
||
if ($connected !== true) {
|
||
return $connected;
|
||
}
|
||
|
||
// Enabled header compression if not enabled.
|
||
$this->_enableCompression();
|
||
|
||
return parent::getOverview($range, $names, $forceNames);
|
||
}
|
||
|
||
/**
|
||
* Pass a XOVER command to the NNTP provider, return array of articles using the overview format as array keys.
|
||
*
|
||
* @note This is a faster implementation of getOverview.
|
||
*
|
||
* Example successful return:
|
||
* array(9) {
|
||
* 'Number' => string(9) "679871775"
|
||
* 'Subject' => string(18) "This is an example"
|
||
* 'From' => string(19) "Example@example.com"
|
||
* 'Date' => string(24) "26 Jun 2014 13:08:22 GMT"
|
||
* 'Message-ID' => string(57) "<part1of1.uS*yYxQvtAYt$5t&wmE%UejhjkCKXBJ!@example.local>"
|
||
* 'References' => string(0) ""
|
||
* 'Bytes' => string(3) "123"
|
||
* 'Lines' => string(1) "9"
|
||
* 'Xref' => string(66) "e alt.test:679871775"
|
||
* }
|
||
*
|
||
* @param string $range Range of articles to get the overview for. Examples follow:
|
||
* Single article number: "679871775"
|
||
* Range of article numbers: "679871775-679999999"
|
||
* All newer than article number: "679871775-"
|
||
* All older than article number: "-679871775"
|
||
* Message-ID: "<part1of1.uS*yYxQvtAYt$5t&wmE%UejhjkCKXBJ!@example.local>"
|
||
* @return array|string|NNTPService Multi-dimensional Array of headers on success, PEAR object on failure.
|
||
*
|
||
* @throws \Exception
|
||
*/
|
||
public function getXOVER(string $range): array|string|NNTPService
|
||
{
|
||
// Check if we are still connected.
|
||
$connected = $this->_checkConnection();
|
||
if ($connected !== true) {
|
||
return $connected;
|
||
}
|
||
|
||
// Enabled header compression if not enabled.
|
||
$this->_enableCompression();
|
||
|
||
// Send XOVER command to NNTP with wanted articles.
|
||
$response = $this->_sendCommand('XOVER '.$range);
|
||
if (self::isError($response)) {
|
||
return $response;
|
||
}
|
||
|
||
// Verify the NNTP server got the right command, get the headers data.
|
||
if ($response === NET_NNTP_PROTOCOL_RESPONSECODE_OVERVIEW_FOLLOWS) {
|
||
$data = $this->_getTextResponse();
|
||
if (self::isError($data)) {
|
||
return $data;
|
||
}
|
||
} else {
|
||
return $this->_handleErrorResponse($response);
|
||
}
|
||
|
||
// Fetch the header overview format (for setting the array keys on the return array).
|
||
if ($this->_overviewFormatCache !== null && isset($this->_overviewFormatCache['Xref'])) {
|
||
$overview = $this->_overviewFormatCache;
|
||
} else {
|
||
$overview = $this->getOverviewFormat(false, true);
|
||
if (self::isError($overview)) {
|
||
return $overview;
|
||
}
|
||
$this->_overviewFormatCache = $overview;
|
||
}
|
||
|
||
// Pre-compute keys array and Xref position for faster processing
|
||
$keys = array_merge(['Number'], array_keys($overview));
|
||
$keyCount = \count($keys);
|
||
$xrefIndex = array_search('Xref', $keys, true);
|
||
|
||
// Loop over strings of headers.
|
||
foreach ($data as $key => $header) {
|
||
// Split the individual headers by tab.
|
||
$parts = explode("\t", $header);
|
||
|
||
// Make sure it's not empty.
|
||
if ($parts === false || empty($parts)) {
|
||
continue;
|
||
}
|
||
|
||
// Build header array using pre-computed keys
|
||
$headerArray = [];
|
||
$partCount = \count($parts);
|
||
|
||
for ($i = 0; $i < $keyCount && $i < $partCount; $i++) {
|
||
$value = $parts[$i];
|
||
// Strip "Xref: " prefix if this is the Xref field
|
||
if ($i === $xrefIndex && isset($value[5])) {
|
||
$value = substr($value, 6);
|
||
}
|
||
$headerArray[$keys[$i]] = $value;
|
||
}
|
||
|
||
// Add the individual header array back to the return array.
|
||
$data[$key] = $headerArray;
|
||
}
|
||
|
||
// Return the array of headers.
|
||
return $data;
|
||
}
|
||
|
||
/**
|
||
* Fetch valid groups.
|
||
*
|
||
* Returns a list of valid groups (that the client is permitted to select) and associated information.
|
||
*
|
||
* @param mixed $wildMat (optional) http://tools.ietf.org/html/rfc3977#section-4
|
||
* @return array|string Pear error on failure, array with groups on success.
|
||
*
|
||
* @throws \Exception
|
||
*/
|
||
public function getGroups(mixed $wildMat = null): mixed
|
||
{
|
||
// Enabled header compression if not enabled.
|
||
$this->_enableCompression();
|
||
|
||
return parent::getGroups($wildMat);
|
||
}
|
||
|
||
/**
|
||
* Download multiple article bodies and string them together.
|
||
*
|
||
* @param string $groupName The name of the group the articles are in.
|
||
* @param mixed $identifiers (string) Message-ID.
|
||
* (int) Article number.
|
||
* (array) Article numbers or Message-ID's (can contain both in the same array)
|
||
* @param bool $alternate Use the alternate NNTP provider?
|
||
* @return mixed On success : (string) The article bodies.
|
||
*
|
||
* @throws \Exception
|
||
* On failure : (object) PEAR_Error.
|
||
*/
|
||
public function getMessages(string $groupName, mixed $identifiers, bool $alternate = false): mixed
|
||
{
|
||
$connected = $this->_checkConnection();
|
||
if ($connected !== true) {
|
||
return $connected;
|
||
}
|
||
|
||
// String to hold all the bodies.
|
||
$body = '';
|
||
|
||
$aConnected = false;
|
||
$nntp = ($alternate ? new self : null);
|
||
|
||
// Check if the msgIds are in an array.
|
||
if (\is_array($identifiers)) {
|
||
$loops = $messageSize = 0;
|
||
|
||
// Loop over the message-ID's or article numbers.
|
||
foreach ($identifiers as $wanted) {
|
||
/* This is to attempt to prevent string size overflow.
|
||
* We get the size of 1 body in bytes, we increment the loop on every loop,
|
||
* then we multiply the # of loops by the first size we got and check if it
|
||
* exceeds 1.7 billion bytes (less than 2GB to give us headroom).
|
||
* If we exceed, return the data.
|
||
* If we don't do this, these errors are fatal.
|
||
*/
|
||
if ((++$loops * $messageSize) >= 1700000000) {
|
||
return $body;
|
||
}
|
||
|
||
// Download the body.
|
||
$message = $this->_getMessage($groupName, $wanted);
|
||
|
||
// Append the body to $body.
|
||
if (! self::isError($message)) {
|
||
$body .= $message;
|
||
|
||
if ($messageSize === 0) {
|
||
$messageSize = \strlen($message);
|
||
}
|
||
|
||
// If there is an error try the alternate provider or return the PEAR error.
|
||
} elseif ($alternate) {
|
||
if (! $aConnected) {
|
||
// Check if the current connected server is the alternate or not.
|
||
$aConnected = $this->_currentServer === $this->_configServer
|
||
? $nntp->doConnect($this->_configCompressedHeaders, true)
|
||
: $nntp->doConnect();
|
||
}
|
||
// If we connected successfully to usenet try to download the article body.
|
||
if ($aConnected === true) {
|
||
$newBody = $nntp->_getMessage($groupName, $wanted);
|
||
// Check if we got an error.
|
||
if ($nntp->isError($newBody)) {
|
||
if ($aConnected) {
|
||
$nntp->doQuit();
|
||
}
|
||
// If we got some data, return it.
|
||
if ($body !== '') {
|
||
return $body;
|
||
}
|
||
|
||
// Return the error.
|
||
return $newBody;
|
||
}
|
||
// Append the alternate body to the main body.
|
||
$body .= $newBody;
|
||
}
|
||
} else {
|
||
// If we got some data, return it.
|
||
if ($body !== '') {
|
||
return $body;
|
||
}
|
||
|
||
return $message;
|
||
}
|
||
}
|
||
|
||
// If it's a string check if it's a valid message-ID.
|
||
} elseif (\is_string($identifiers) || is_numeric($identifiers)) {
|
||
$body = $this->_getMessage($groupName, $identifiers);
|
||
if ($alternate && self::isError($body)) {
|
||
$nntp->doConnect($this->_configCompressedHeaders, true);
|
||
$body = $nntp->_getMessage($groupName, $identifiers);
|
||
$aConnected = true;
|
||
}
|
||
|
||
// Else return an error.
|
||
} else {
|
||
$message = 'Wrong Identifier type, array, int or string accepted. This type of var was passed: '.gettype($identifiers);
|
||
|
||
return $this->throwError(cli()->error($message));
|
||
}
|
||
|
||
if ($aConnected === true) {
|
||
$nntp->doQuit();
|
||
}
|
||
|
||
return $body;
|
||
}
|
||
|
||
/**
|
||
* Download multiple article bodies by Message-ID only (no group selection), concatenating them.
|
||
* Falls back to alternate provider if enabled. Message-IDs are yEnc decoded.
|
||
*
|
||
* @param mixed $identifiers string|array Message-ID(s) (with or without < >)
|
||
* @param bool $alternate Use alternate NNTP server if primary fails for any ID.
|
||
* @return mixed string concatenated bodies on success, PEAR_Error object on total failure.
|
||
*
|
||
* @throws \Exception
|
||
*/
|
||
public function getMessagesByMessageID(mixed $identifiers, bool $alternate = false): mixed
|
||
{
|
||
$connected = $this->_checkConnection(false); // no need to reselect group
|
||
if ($connected !== true) {
|
||
return $connected; // PEAR error passthrough
|
||
}
|
||
|
||
$body = '';
|
||
$aConnected = false;
|
||
$alt = ($alternate ? new self : null);
|
||
|
||
// Normalise to array for loop processing
|
||
$ids = is_array($identifiers) ? $identifiers : [$identifiers];
|
||
|
||
$loops = 0;
|
||
$messageSize = 0;
|
||
foreach ($ids as $id) {
|
||
if ((++$loops * $messageSize) >= 1700000000) { // prevent huge string growth
|
||
return $body;
|
||
}
|
||
$msg = $this->_getMessageByMessageID($id);
|
||
if (! self::isError($msg)) {
|
||
$body .= $msg;
|
||
if ($messageSize === 0) {
|
||
$messageSize = strlen($msg);
|
||
}
|
||
|
||
continue;
|
||
}
|
||
// Primary failed, try alternate if requested
|
||
if ($alternate) {
|
||
if (! $aConnected) {
|
||
$aConnected = $this->_currentServer === $this->_configServer
|
||
? $alt->doConnect($this->_configCompressedHeaders, true)
|
||
: $alt->doConnect();
|
||
}
|
||
if ($aConnected === true) {
|
||
$altMsg = $alt->_getMessageByMessageID($id);
|
||
if ($alt->isError($altMsg)) {
|
||
if ($aConnected) {
|
||
$alt->doQuit();
|
||
}
|
||
|
||
return $body !== '' ? $body : $altMsg; // return what we have or error
|
||
}
|
||
$body .= $altMsg;
|
||
} else { // alternate connect failed
|
||
return $body !== '' ? $body : $msg; // return collected or original error
|
||
}
|
||
} else { // no alternate
|
||
return $body !== '' ? $body : $msg;
|
||
}
|
||
}
|
||
|
||
if ($aConnected === true) {
|
||
$alt->doQuit();
|
||
}
|
||
|
||
return $body;
|
||
}
|
||
|
||
/**
|
||
* Internal: fetch single article body by Message-ID (yEnc decoded) without selecting a group.
|
||
* Accepts article numbers but these require a group; will return error if numeric passed.
|
||
*
|
||
* @param mixed $identifier Message-ID or article number.
|
||
* @return mixed string body on success, PEAR_Error on failure.
|
||
*
|
||
* @throws \Exception
|
||
*/
|
||
protected function _getMessageByMessageID(mixed $identifier): mixed
|
||
{
|
||
// If numeric we cannot safely fetch without group context – delegate to existing path via error.
|
||
if (is_numeric($identifier)) {
|
||
return $this->throwError('Numeric article number requires group selection');
|
||
}
|
||
$id = $this->_formatMessageID($identifier);
|
||
$response = $this->_sendCommand('BODY '.$id);
|
||
if (self::isError($response)) {
|
||
return $response;
|
||
}
|
||
if ($response !== NET_NNTP_PROTOCOL_RESPONSECODE_BODY_FOLLOWS) {
|
||
return $this->_handleErrorResponse($response);
|
||
}
|
||
|
||
// Use array to accumulate lines (faster than string concatenation)
|
||
$bodyParts = [];
|
||
$socket = $this->_socket;
|
||
|
||
while (! feof($socket)) {
|
||
$line = fgets($socket, 8192);
|
||
if ($line === false) {
|
||
return $this->throwError('Failed to read line from socket.', null);
|
||
}
|
||
if ($line === ".\r\n") {
|
||
$body = implode('', $bodyParts);
|
||
|
||
return $this->_yencService->decodeIgnore($body);
|
||
}
|
||
if ($line[0] === '.' && isset($line[1]) && $line[1] === '.') {
|
||
$line = substr($line, 1);
|
||
}
|
||
$bodyParts[] = $line;
|
||
}
|
||
|
||
return $this->throwError('End of stream! Connection lost?', null);
|
||
}
|
||
|
||
/**
|
||
* Restart the NNTP connection if an error occurs in the selectGroup
|
||
* function, if it does not restart display the error.
|
||
*
|
||
* @param NNTPService $nntp Instance of class NNTPService.
|
||
* @param string $group Name of the group.
|
||
* @param bool $comp Use compression or not?
|
||
* @return mixed On success : (array) The group summary.
|
||
*
|
||
* @throws \Exception
|
||
* On Failure : (object) PEAR_Error.
|
||
*/
|
||
public function dataError(NNTPService $nntp, string $group, bool $comp = true): mixed
|
||
{
|
||
// Disconnect.
|
||
$nntp->doQuit();
|
||
// Try reconnecting. This uses another round of max retries.
|
||
if ($nntp->doConnect($comp) !== true) {
|
||
return $this->throwError('Unable to reconnect to usenet!');
|
||
}
|
||
|
||
// Try re-selecting the group.
|
||
$data = $nntp->selectGroup($group);
|
||
if (self::isError($data)) {
|
||
$message = "Code {$data->code}: {$data->message}\nSkipping group: {$group}";
|
||
|
||
if ($this->_echo) {
|
||
cli()->error($message);
|
||
}
|
||
$nntp->doQuit();
|
||
}
|
||
|
||
return $data;
|
||
}
|
||
|
||
/**
|
||
* Split a string into lines of 510 chars ending with \r\n.
|
||
* Usenet limits lines to 512 chars, with \r\n that leaves us 510.
|
||
*
|
||
* @param string $string The string to split.
|
||
* @param bool $compress Compress the string with gzip?
|
||
* @return string The split string.
|
||
*/
|
||
protected function _splitLines(string $string, bool $compress = false): string
|
||
{
|
||
// Check if the length is longer than 510 chars.
|
||
if (\strlen($string) > 510) {
|
||
// If it is, split it @ 510 and terminate with \r\n.
|
||
$string = chunk_split($string, 510, "\r\n");
|
||
}
|
||
|
||
// Compress the string if requested.
|
||
return $compress ? gzdeflate($string, 4) : $string;
|
||
}
|
||
|
||
/**
|
||
* Try to see if the NNTP server implements XFeature GZip Compression,
|
||
* change the compression bool object if so.
|
||
*
|
||
* @param bool $secondTry This is only used if enabling compression fails, the function will call itself to retry.
|
||
* @return mixed On success : (bool) True: The server understood and compression is enabled.
|
||
* (bool) False: The server did not understand, compression is not enabled.
|
||
* On failure : (object) PEAR_Error.
|
||
*
|
||
* @throws \Exception
|
||
*/
|
||
protected function _enableCompression(bool $secondTry = false): mixed
|
||
{
|
||
if ($this->_compressionEnabled) {
|
||
return true;
|
||
}
|
||
if (! $this->_compressionSupported) {
|
||
return false;
|
||
}
|
||
|
||
// Send this command to the usenet server.
|
||
$response = $this->_sendCommand('XFEATURE COMPRESS GZIP');
|
||
|
||
// Check if it's good.
|
||
if (self::isError($response)) {
|
||
$this->_compressionSupported = false;
|
||
|
||
return $response;
|
||
}
|
||
if ($response !== 290) {
|
||
if (! $secondTry) {
|
||
// Retry.
|
||
$this->cmdQuit();
|
||
if ($this->_checkConnection()) {
|
||
return $this->_enableCompression(true);
|
||
}
|
||
}
|
||
$msg = "Sent 'XFEATURE COMPRESS GZIP' to server, got '$response: ".$this->_currentStatusResponse()."'";
|
||
|
||
$this->_compressionSupported = false;
|
||
|
||
return false;
|
||
}
|
||
|
||
$this->_compressionEnabled = true;
|
||
$this->_compressionSupported = true;
|
||
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* Override PEAR NNTP's function to use our _getXFeatureTextResponse instead
|
||
* of their _getTextResponse function since it is incompatible at decoding
|
||
* headers when XFeature GZip compression is enabled server side.
|
||
*
|
||
* @return \App\Services\NNTP\NNTPService|array|string Our overridden function when compression is enabled.
|
||
* parent Parent function when no compression.
|
||
*/
|
||
public function _getTextResponse(): NNTPService|array|string
|
||
{
|
||
if ($this->_compressionEnabled &&
|
||
isset($this->_currentStatusResponse[1]) &&
|
||
stripos($this->_currentStatusResponse[1], 'COMPRESS=GZIP') !== false) {
|
||
return $this->_getXFeatureTextResponse();
|
||
}
|
||
|
||
return parent::_getTextResponse();
|
||
}
|
||
|
||
/**
|
||
* Loop over the compressed data when XFeature GZip Compress is turned on,
|
||
* string the data until we find a indicator
|
||
* (period, carriage feed, line return ;; .\r\n), decompress the data,
|
||
* split the data (bunch of headers in a string) into an array, finally
|
||
* return the array.
|
||
*
|
||
* Have we failed to decompress the data, was there a
|
||
* problem downloading the data, etc..
|
||
*
|
||
* @return array|string On success : (array) The headers.
|
||
* On failure : (object) PEAR_Error.
|
||
* On decompress failure: (string) error message
|
||
*/
|
||
protected function &_getXFeatureTextResponse(): array|string
|
||
{
|
||
$possibleTerm = false;
|
||
// Use array accumulation for better performance with large data
|
||
$dataParts = [];
|
||
$socket = $this->_socket;
|
||
|
||
while (! feof($socket)) {
|
||
// Did we find a possible ending ? (.\r\n)
|
||
if ($possibleTerm) {
|
||
// Use stream_select for more efficient socket polling
|
||
$read = [$socket];
|
||
$write = $except = null;
|
||
|
||
// Check if data is available with a short timeout (5ms)
|
||
$ready = @stream_select($read, $write, $except, 0, 5000);
|
||
|
||
if ($ready > 0) {
|
||
// Data available, read it
|
||
stream_set_blocking($socket, false);
|
||
$buffer = fgets($socket, 16384);
|
||
stream_set_blocking($socket, true);
|
||
} else {
|
||
$buffer = '';
|
||
}
|
||
|
||
// If the buffer was really empty, then we know $possibleTerm was the real ending.
|
||
if ($buffer === '' || $buffer === false) {
|
||
// Join all parts and remove .\r\n from end, decompress data.
|
||
$data = implode('', $dataParts);
|
||
$deComp = @gzuncompress(substr($data, 0, -3));
|
||
|
||
if (! empty($deComp)) {
|
||
$bytesReceived = \strlen($data);
|
||
if ($this->_echo && $bytesReceived > 10240) {
|
||
cli()->primaryOver(
|
||
'Received '.round($bytesReceived / 1024).
|
||
'KB from group ('.$this->group().').'
|
||
);
|
||
}
|
||
|
||
// Split the string of headers into an array of individual headers, then return it.
|
||
$deComp = explode("\r\n", trim($deComp));
|
||
|
||
return $deComp;
|
||
}
|
||
$message = 'Decompression of OVER headers failed.';
|
||
|
||
return $this->throwError(cli()->error($message), 1000);
|
||
}
|
||
// The buffer was not empty, so we know this was not the real ending, so reset $possibleTerm.
|
||
$possibleTerm = false;
|
||
$dataParts[] = $buffer;
|
||
} else {
|
||
// Get data from the stream with larger buffer.
|
||
$buffer = fgets($socket, 16384);
|
||
}
|
||
|
||
// If we got no data at all try one more time to pull data.
|
||
if (empty($buffer)) {
|
||
usleep(5000);
|
||
$buffer = fgets($socket, 16384);
|
||
|
||
// If we got nothing again, return error.
|
||
if (empty($buffer)) {
|
||
$message = 'Error fetching data from usenet server while downloading OVER headers.';
|
||
|
||
return $this->throwError(cli()->error($message), 1000);
|
||
}
|
||
}
|
||
|
||
// Append current buffer to parts array.
|
||
$dataParts[] = $buffer;
|
||
|
||
// Check if we have the ending (.\r\n) - check last 3 chars directly
|
||
$bufLen = \strlen($buffer);
|
||
if ($bufLen >= 3 && $buffer[$bufLen - 3] === '.' && $buffer[$bufLen - 2] === "\r" && $buffer[$bufLen - 1] === "\n") {
|
||
// We have a possible ending, next loop check if it is.
|
||
$possibleTerm = true;
|
||
}
|
||
}
|
||
|
||
$message = 'Unspecified error while downloading OVER headers.';
|
||
|
||
return $this->throwError(cli()->error($message), 1000);
|
||
}
|
||
|
||
/**
|
||
* Check if the Message-ID has the required opening and closing brackets.
|
||
*
|
||
* @param string $messageID The Message-ID with or without brackets.
|
||
* @return string|false Message-ID with brackets or false if empty.
|
||
*/
|
||
protected function _formatMessageID(string $messageID): string|false
|
||
{
|
||
$messageID = (string) $messageID;
|
||
if ($messageID === '') {
|
||
return false;
|
||
}
|
||
|
||
// Check if the first char is <, if not add it.
|
||
if ($messageID[0] !== '<') {
|
||
$messageID = ('<'.$messageID);
|
||
}
|
||
|
||
// Check if the last char is >, if not add it.
|
||
if (! str_ends_with($messageID, '>')) {
|
||
$messageID .= '>';
|
||
}
|
||
|
||
return $messageID;
|
||
}
|
||
|
||
/**
|
||
* Download an article body (an article without the header).
|
||
*
|
||
* @return mixed|object|string
|
||
*
|
||
* @throws \Exception
|
||
*/
|
||
protected function _getMessage(string $groupName, mixed $identifier): mixed
|
||
{
|
||
// Make sure the requested group is already selected, if not select it.
|
||
if ($this->group() !== $groupName) {
|
||
// Select the group.
|
||
$summary = $this->selectGroup($groupName);
|
||
// If there was an error selecting the group, return a PEAR error object.
|
||
if (self::isError($summary)) {
|
||
return $summary;
|
||
}
|
||
}
|
||
|
||
// Check if this is an article number or message-id.
|
||
if (! is_numeric($identifier)) {
|
||
// It's a message-id so check if it has the triangular brackets.
|
||
$identifier = $this->_formatMessageID($identifier);
|
||
}
|
||
|
||
// Tell the news server we want the body of an article.
|
||
$response = $this->_sendCommand('BODY '.$identifier);
|
||
if (self::isError($response)) {
|
||
return $response;
|
||
}
|
||
|
||
if ($response === NET_NNTP_PROTOCOL_RESPONSECODE_BODY_FOLLOWS) {
|
||
// Use array to accumulate lines (faster than string concatenation for many appends)
|
||
$bodyParts = [];
|
||
$socket = $this->_socket;
|
||
|
||
// Continue until connection is lost
|
||
while (! feof($socket)) {
|
||
// Retrieve and append up to 8192 characters from the server (larger buffer = fewer syscalls)
|
||
$line = fgets($socket, 8192);
|
||
|
||
// If the socket is empty/ an error occurs, false is returned.
|
||
if ($line === false) {
|
||
return $this->throwError('Failed to read line from socket.', null);
|
||
}
|
||
|
||
// Check if the line terminates the text response.
|
||
if ($line === ".\r\n") {
|
||
// Join all parts and attempt to yEnc decode
|
||
$body = implode('', $bodyParts);
|
||
|
||
return $this->_yencService->decodeIgnore($body);
|
||
}
|
||
|
||
// Check for line that starts with double period, remove one.
|
||
if ($line[0] === '.' && isset($line[1]) && $line[1] === '.') {
|
||
$line = substr($line, 1);
|
||
}
|
||
|
||
// Add the line to the array
|
||
$bodyParts[] = $line;
|
||
}
|
||
|
||
return $this->throwError('End of stream! Connection lost?', null);
|
||
}
|
||
|
||
return $this->_handleErrorResponse($response);
|
||
}
|
||
|
||
/**
|
||
* Check if we are still connected. Reconnect if not.
|
||
*
|
||
* @param bool $reSelectGroup Select back the group after connecting?
|
||
* @return mixed On success: (bool) True;
|
||
*
|
||
* @throws \Exception
|
||
* On failure: (object) PEAR_Error
|
||
*/
|
||
protected function _checkConnection(bool $reSelectGroup = true): mixed
|
||
{
|
||
$currentGroup = $this->_currentGroup;
|
||
// Check if we are connected.
|
||
if (parent::_isConnected()) {
|
||
$retVal = true;
|
||
} else {
|
||
switch ($this->_currentServer) {
|
||
case $this->_configServer:
|
||
if (\is_resource($this->_socket)) {
|
||
$this->doQuit(true);
|
||
}
|
||
$retVal = $this->doConnect();
|
||
break;
|
||
case $this->_configAlternateServer:
|
||
if (\is_resource($this->_socket)) {
|
||
$this->doQuit(true);
|
||
}
|
||
$retVal = $this->doConnect(true, true);
|
||
break;
|
||
default:
|
||
$retVal = $this->throwError('Wrong server constant used in NNTP checkConnection()!');
|
||
}
|
||
|
||
if ($retVal === true && $reSelectGroup) {
|
||
$group = $this->selectGroup($currentGroup);
|
||
if (self::isError($group)) {
|
||
$retVal = $group;
|
||
}
|
||
}
|
||
}
|
||
|
||
return $retVal;
|
||
}
|
||
|
||
/**
|
||
* Verify NNTP error code and return PEAR error.
|
||
*
|
||
* @param int $response NET_NNTP Response code
|
||
* @return object PEAR error
|
||
*/
|
||
protected function _handleErrorResponse(int $response): object
|
||
{
|
||
switch ($response) {
|
||
// 381, RFC2980: 'More authentication information required'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_AUTHENTICATION_CONTINUE:
|
||
return $this->throwError('More authentication information required', $response, $this->_currentStatusResponse());
|
||
// 400, RFC977: 'Service discontinued'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_DISCONNECTING_FORCED:
|
||
return $this->throwError('Server refused connection', $response, $this->_currentStatusResponse());
|
||
// 411, RFC977: 'no such news group'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_NO_SUCH_GROUP:
|
||
return $this->throwError('No such news group on server', $response, $this->_currentStatusResponse());
|
||
// 412, RFC2980: 'No news group current selected'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_NO_GROUP_SELECTED:
|
||
return $this->throwError('No news group current selected', $response, $this->_currentStatusResponse());
|
||
// 420, RFC2980: 'Current article number is invalid'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_NO_ARTICLE_SELECTED:
|
||
return $this->throwError('Current article number is invalid', $response, $this->_currentStatusResponse());
|
||
// 421, RFC977: 'no next article in this group'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_NO_NEXT_ARTICLE:
|
||
return $this->throwError('No next article in this group', $response, $this->_currentStatusResponse());
|
||
// 422, RFC977: 'no previous article in this group'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_NO_PREVIOUS_ARTICLE:
|
||
return $this->throwError('No previous article in this group', $response, $this->_currentStatusResponse());
|
||
// 423, RFC977: 'No such article number in this group'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_NO_SUCH_ARTICLE_NUMBER:
|
||
return $this->throwError('No such article number in this group', $response, $this->_currentStatusResponse());
|
||
// 430, RFC977: 'No such article found'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_NO_SUCH_ARTICLE_ID:
|
||
return $this->throwError('No such article found', $response, $this->_currentStatusResponse());
|
||
// 435, RFC977: 'Article not wanted'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_TRANSFER_UNWANTED:
|
||
return $this->throwError('Article not wanted', $response, $this->_currentStatusResponse());
|
||
// 436, RFC977: 'Transfer failed - try again later'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_TRANSFER_FAILURE:
|
||
return $this->throwError('Transfer failed - try again later', $response, $this->_currentStatusResponse());
|
||
// 437, RFC977: 'Article rejected - do not try again'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_TRANSFER_REJECTED:
|
||
return $this->throwError('Article rejected - do not try again', $response, $this->_currentStatusResponse());
|
||
// 440, RFC977: 'posting not allowed'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_POSTING_PROHIBITED:
|
||
return $this->throwError('Posting not allowed', $response, $this->_currentStatusResponse());
|
||
// 441, RFC977: 'posting failed'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_POSTING_FAILURE:
|
||
return $this->throwError('Posting failed', $response, $this->_currentStatusResponse());
|
||
// 481, RFC2980: 'Groups and descriptions unavailable'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_XGTITLE_GROUPS_UNAVAILABLE:
|
||
return $this->throwError('Groups and descriptions unavailable', $response, $this->_currentStatusResponse());
|
||
// 482, RFC2980: 'Authentication rejected'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_AUTHENTICATION_REJECTED:
|
||
return $this->throwError('Authentication rejected', $response, $this->_currentStatusResponse());
|
||
// 500, RFC977: 'Command not recognized'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_UNKNOWN_COMMAND:
|
||
return $this->throwError('Command not recognized', $response, $this->_currentStatusResponse());
|
||
// 501, RFC977: 'Command syntax error'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_SYNTAX_ERROR:
|
||
return $this->throwError('Command syntax error', $response, $this->_currentStatusResponse());
|
||
// 502, RFC2980: 'No permission'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_NOT_PERMITTED:
|
||
return $this->throwError('No permission', $response, $this->_currentStatusResponse());
|
||
// 503, RFC2980: 'Program fault - command not performed'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_NOT_SUPPORTED:
|
||
return $this->throwError('Internal server error, function not performed', $response, $this->_currentStatusResponse());
|
||
// RFC4642: 'Can not initiate TLS negotiation'
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_TLS_FAILED_NEGOTIATION:
|
||
return $this->throwError('Can not initiate TLS negotiation', $response, $this->_currentStatusResponse());
|
||
default:
|
||
$text = $this->_currentStatusResponse();
|
||
|
||
return $this->throwError("Unexpected response: '$text'", $response, $text);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Connect to a NNTP server.
|
||
*
|
||
* @param string|null $host (optional) The address of the NNTP-server to connect to, defaults to 'localhost'.
|
||
* @param mixed|null $encryption (optional) Use TLS/SSL on the connection?
|
||
* (string) 'tcp' => Use no encryption.
|
||
* 'ssl', 'sslv3', 'tls' => Use encryption.
|
||
* (null)|(false) Use no encryption.
|
||
* @param int|null $port (optional) The port number to connect to, defaults to 119.
|
||
* @param int|null $timeout (optional) How many seconds to wait before giving up when connecting.
|
||
* @param int $socketTimeout (optional) How many seconds to wait before timing out the (blocked) socket.
|
||
* @return mixed (bool) On success: True when posting allowed, otherwise false.
|
||
* (object) On failure: pear_error
|
||
*/
|
||
public function connect(?string $host = null, mixed $encryption = null, ?int $port = null, ?int $timeout = 15, int $socketTimeout = 120): mixed
|
||
{
|
||
if ($this->_isConnected()) {
|
||
return $this->throwError('Already connected, disconnect first!', null);
|
||
}
|
||
// v1.0.x API
|
||
if (is_int($encryption)) {
|
||
trigger_error('You are using deprecated API v1.0 in Net_NNTP_Protocol_Client: connect() !', E_USER_NOTICE);
|
||
$port = $encryption;
|
||
$encryption = false;
|
||
}
|
||
if ($host === null) {
|
||
$host = 'localhost';
|
||
}
|
||
// Choose transport based on encryption, and if no port is given, use default for that encryption.
|
||
switch ($encryption) {
|
||
case null:
|
||
case 'tcp':
|
||
$transport = 'tcp';
|
||
$port = $port ?? 119;
|
||
break;
|
||
case 'ssl':
|
||
case 'tls':
|
||
$transport = $encryption;
|
||
$port = $port ?? 563;
|
||
break;
|
||
default:
|
||
$message = '$encryption parameter must be either tcp, tls, ssl.';
|
||
trigger_error($message, E_USER_ERROR);
|
||
}
|
||
// Attempt to connect to usenet.
|
||
// Only create SSL context if using TLS/SSL transport
|
||
$context = preg_match('/tls|ssl/', $transport)
|
||
? stream_context_create(streamSslContextOptions())
|
||
: null;
|
||
|
||
$socket = stream_socket_client(
|
||
$transport.'://'.$host.':'.$port,
|
||
$errorNumber,
|
||
$errorString,
|
||
$timeout,
|
||
STREAM_CLIENT_CONNECT,
|
||
$context
|
||
);
|
||
if ($socket === false) {
|
||
$message = "Connection to $transport://$host:$port failed.";
|
||
if (preg_match('/tls|ssl/', $transport)) {
|
||
$message .= ' Try disabling SSL/TLS, and/or try a different port.';
|
||
}
|
||
$message .= ' [ERROR '.$errorNumber.': '.$errorString.']';
|
||
|
||
return $this->throwError($message);
|
||
}
|
||
// Store the socket resource as property.
|
||
$this->_socket = $socket;
|
||
$this->_socketTimeout = $socketTimeout ?: $this->_socketTimeout;
|
||
// Set the socket timeout.
|
||
stream_set_timeout($this->_socket, $this->_socketTimeout);
|
||
// Retrieve the server's initial response.
|
||
$response = $this->_getStatusResponse();
|
||
if (self::isError($response)) {
|
||
return $response;
|
||
}
|
||
switch ($response) {
|
||
// 200, Posting allowed
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_READY_POSTING_ALLOWED:
|
||
return true;
|
||
// 201, Posting NOT allowed
|
||
case NET_NNTP_PROTOCOL_RESPONSECODE_READY_POSTING_PROHIBITED:
|
||
|
||
return false;
|
||
default:
|
||
return $this->_handleErrorResponse($response);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Test whether we are connected or not.
|
||
*
|
||
* @param bool $feOf Check for the end of file pointer.
|
||
* @return bool true or false
|
||
*/
|
||
public function _isConnected(bool $feOf = true): bool
|
||
{
|
||
return is_resource($this->_socket) && (! $feOf || ! feof($this->_socket));
|
||
}
|
||
|
||
/**
|
||
* Check if we are connected to the usenet server.
|
||
*/
|
||
public function isConnected(): bool
|
||
{
|
||
return $this->_isConnected();
|
||
}
|
||
|
||
/**
|
||
* Get the current server address.
|
||
*/
|
||
public function getCurrentServer(): string
|
||
{
|
||
return $this->_currentServer;
|
||
}
|
||
|
||
/**
|
||
* Get the current port.
|
||
*/
|
||
public function getCurrentPort(): int|string
|
||
{
|
||
return $this->_currentPort;
|
||
}
|
||
|
||
/**
|
||
* Check if posting is allowed on the current connection.
|
||
*/
|
||
public function isPostingAllowed(): bool
|
||
{
|
||
return $this->_postingAllowed;
|
||
}
|
||
|
||
/**
|
||
* Get the currently selected group.
|
||
*/
|
||
public function getCurrentGroup(): string
|
||
{
|
||
return $this->_currentGroup;
|
||
}
|
||
|
||
/**
|
||
* Check if compression is enabled.
|
||
*/
|
||
public function isCompressionEnabled(): bool
|
||
{
|
||
return $this->_compressionEnabled;
|
||
}
|
||
|
||
/**
|
||
* Check if compression is supported.
|
||
*/
|
||
public function isCompressionSupported(): bool
|
||
{
|
||
return $this->_compressionSupported;
|
||
}
|
||
}
|
||
|