wamo/gnu-social
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

PEAR Net_Socket updated to 1.2.2

Browse Source 
Source: https://pear.php.net/package/Net_Socket
Release date: 2017-04-13
This commit is contained in:
Mikael Nordfeldth 2017-07-09 23:09:03 +02:00
parent 489099ca91
commit f025671b8a
1 changed files with 149 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

190
extlib/Net/Socket.php
View File

@ -2,27 +2,41 @@
/** /**
* Net_Socket * Net_Socket
* *
* PHP Version 4 * PHP Version 5
* *
* Copyright (c) 1997-2013 The PHP Group * LICENSE:
* *
* This source file is subject to version 2.0 of the PHP license, * Copyright (c) 1997-2017 The PHP Group
* that is bundled with this package in the file LICENSE, and is * All rights reserved.
* available at through the world-wide-web at
* http://www.php.net/license/2_02.txt.
* If you did not receive a copy of the PHP license and are unable to
* obtain it through the world-wide-web, please send a note to
* license@php.net so we can mail you a copy immediately.
* *
* Authors: Stig Bakken <ssb@php.net> * Redistribution and use in source and binary forms, with or without
* Chuck Hagenbuch <chuck@horde.org> * modification, are permitted provided that the following conditions
* are met:
*
* o Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* o Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* *
* @category Net * @category Net
* @package Net_Socket * @package Net_Socket
* @author Stig Bakken <ssb@php.net> * @author Stig Bakken <ssb@php.net>
* @author Chuck Hagenbuch <chuck@horde.org> * @author Chuck Hagenbuch <chuck@horde.org>
* @copyright 1997-2003 The PHP Group * @copyright 1997-2017 The PHP Group
* @license http://www.php.net/license/2_02.txt PHP 2.02 * @license http://opensource.org/licenses/bsd-license.php BSD-2-Clause
* @link http://pear.php.net/packages/Net_Socket * @link http://pear.php.net/packages/Net_Socket
*/ */
@ -39,8 +53,8 @@ define('NET_SOCKET_ERROR', 4);
* @package Net_Socket * @package Net_Socket
* @author Stig Bakken <ssb@php.net> * @author Stig Bakken <ssb@php.net>
* @author Chuck Hagenbuch <chuck@horde.org> * @author Chuck Hagenbuch <chuck@horde.org>
* @copyright 1997-2003 The PHP Group * @copyright 1997-2017 The PHP Group
* @license http://www.php.net/license/2_02.txt PHP 2.02 * @license http://opensource.org/licenses/bsd-license.php BSD-2-Clause
* @link http://pear.php.net/packages/Net_Socket * @link http://pear.php.net/packages/Net_Socket
*/ */
class Net_Socket extends PEAR class Net_Socket extends PEAR
@ -49,51 +63,51 @@ class Net_Socket extends PEAR
* Socket file pointer. * Socket file pointer.
* @var resource $fp * @var resource $fp
*/ */
var $fp = null; public $fp = null;
/** /**
* Whether the socket is blocking. Defaults to true. * Whether the socket is blocking. Defaults to true.
* @var boolean $blocking * @var boolean $blocking
*/ */
var $blocking = true; public $blocking = true;
/** /**
* Whether the socket is persistent. Defaults to false. * Whether the socket is persistent. Defaults to false.
* @var boolean $persistent * @var boolean $persistent
*/ */
var $persistent = false; public $persistent = false;
/** /**
* The IP address to connect to. * The IP address to connect to.
* @var string $addr * @var string $addr
*/ */
var $addr = ''; public $addr = '';
/** /**
* The port number to connect to. * The port number to connect to.
* @var integer $port * @var integer $port
*/ */
var $port = 0; public $port = 0;
/** /**
* Number of seconds to wait on socket operations before assuming * Number of seconds to wait on socket operations before assuming
* there's no more data. Defaults to no timeout. * there's no more data. Defaults to no timeout.
* @var integer|float $timeout * @var integer|float $timeout
*/ */
var $timeout = null; public $timeout = null;
/** /**
* Number of bytes to read at a time in readLine() and * Number of bytes to read at a time in readLine() and
* readAll(). Defaults to 2048. * readAll(). Defaults to 2048.
* @var integer $lineLength * @var integer $lineLength
*/ */
var $lineLength = 2048; public $lineLength = 2048;
/** /**
* The string to use as a newline terminator. Usually "\r\n" or "\n". * The string to use as a newline terminator. Usually "\r\n" or "\n".
* @var string $newline * @var string $newline
*/ */
var $newline = "\r\n"; public $newline = "\r\n";
/** /**
* Connect to the specified port. If called when the socket is * Connect to the specified port. If called when the socket is
@ -111,9 +125,13 @@ class Net_Socket extends PEAR
* *
* @return boolean|PEAR_Error True on success or a PEAR_Error on failure. * @return boolean|PEAR_Error True on success or a PEAR_Error on failure.
*/ */
function connect($addr, $port = 0, $persistent = null, public function connect(
$timeout = null, $options = null) $addr,
{ $port = 0,
$persistent = null,
$timeout = null,
$options = null
) {
if (is_resource($this->fp)) { if (is_resource($this->fp)) {
@fclose($this->fp); @fclose($this->fp);
$this->fp = null; $this->fp = null;
@ -121,11 +139,13 @@ class Net_Socket extends PEAR
if (!$addr) { if (!$addr) {
return $this->raiseError('$addr cannot be empty'); return $this->raiseError('$addr cannot be empty');
} else if (strspn($addr, ':.0123456789') == strlen($addr)) { } else {
if (strspn($addr, ':.0123456789') === strlen($addr)) {
$this->addr = strpos($addr, ':') !== false ? '[' . $addr . ']' : $addr; $this->addr = strpos($addr, ':') !== false ? '[' . $addr . ']' : $addr;
} else { } else {
$this->addr = $addr; $this->addr = $addr;
} }
}
$this->port = $port % 65536; $this->port = $port % 65536;
@ -137,7 +157,11 @@ class Net_Socket extends PEAR
$errno = 0; $errno = 0;
$errstr = ''; $errstr = '';
if (function_exists('error_clear_last')) {
error_clear_last();
} else {
$old_track_errors = @ini_set('track_errors', 1); $old_track_errors = @ini_set('track_errors', 1);
}
if ($timeout <= 0) { if ($timeout <= 0) {
$timeout = @ini_get('default_socket_timeout'); $timeout = @ini_get('default_socket_timeout');
@ -155,7 +179,7 @@ class Net_Socket extends PEAR
} }
$addr = $this->addr . ':' . $this->port; $addr = $this->addr . ':' . $this->port;
$fp = stream_socket_client($addr, $errno, $errstr, $fp = @stream_socket_client($addr, $errno, $errstr,
$timeout, $flags, $context); $timeout, $flags, $context);
} else { } else {
$fp = @$openfunc($this->addr, $this->port, $errno, $fp = @$openfunc($this->addr, $this->port, $errno,
@ -166,16 +190,29 @@ class Net_Socket extends PEAR
} }
if (!$fp) { if (!$fp) {
if ($errno == 0 && !strlen($errstr) && isset($php_errormsg)) { if ($errno === 0 && !strlen($errstr)) {
$errstr = $php_errormsg; $errstr = '';
} if (isset($old_track_errors)) {
$errstr = $php_errormsg ?: '';
@ini_set('track_errors', $old_track_errors); @ini_set('track_errors', $old_track_errors);
} else {
$lastError = error_get_last();
if (isset($lastError['message'])) {
$errstr = $lastError['message'];
}
}
}
return $this->raiseError($errstr, $errno); return $this->raiseError($errstr, $errno);
} }
if (isset($old_track_errors)) {
@ini_set('track_errors', $old_track_errors); @ini_set('track_errors', $old_track_errors);
}
$this->fp = $fp; $this->fp = $fp;
$this->setTimeout(); $this->setTimeout();
return $this->setBlocking($this->blocking); return $this->setBlocking($this->blocking);
} }
@ -185,7 +222,7 @@ class Net_Socket extends PEAR
* @access public * @access public
* @return mixed true on success or a PEAR_Error instance otherwise * @return mixed true on success or a PEAR_Error instance otherwise
*/ */
function disconnect() public function disconnect()
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
@ -193,6 +230,7 @@ class Net_Socket extends PEAR
@fclose($this->fp); @fclose($this->fp);
$this->fp = null; $this->fp = null;
return true; return true;
} }
@ -202,9 +240,10 @@ class Net_Socket extends PEAR
* @param string $newline Newline character(s) * @param string $newline Newline character(s)
* @return boolean True * @return boolean True
*/ */
function setNewline($newline) public function setNewline($newline)
{ {
$this->newline = $newline; $this->newline = $newline;
return true; return true;
} }
@ -214,7 +253,7 @@ class Net_Socket extends PEAR
* @access public * @access public
* @return boolean The current blocking mode. * @return boolean The current blocking mode.
*/ */
function isBlocking() public function isBlocking()
{ {
return $this->blocking; return $this->blocking;
} }
@ -230,7 +269,7 @@ class Net_Socket extends PEAR
* @access public * @access public
* @return mixed true on success or a PEAR_Error instance otherwise * @return mixed true on success or a PEAR_Error instance otherwise
*/ */
function setBlocking($mode) public function setBlocking($mode)
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
@ -238,6 +277,7 @@ class Net_Socket extends PEAR
$this->blocking = $mode; $this->blocking = $mode;
stream_set_blocking($this->fp, (int)$this->blocking); stream_set_blocking($this->fp, (int)$this->blocking);
return true; return true;
} }
@ -252,7 +292,7 @@ class Net_Socket extends PEAR
* @return mixed True on success or false on failure or * @return mixed True on success or false on failure or
* a PEAR_Error instance when not connected * a PEAR_Error instance when not connected
*/ */
function setTimeout($seconds = null, $microseconds = null) public function setTimeout($seconds = null, $microseconds = null)
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
@ -267,8 +307,7 @@ class Net_Socket extends PEAR
if ($this->timeout > 0) { if ($this->timeout > 0) {
return stream_set_timeout($this->fp, (int)$seconds, (int)$microseconds); return stream_set_timeout($this->fp, (int)$seconds, (int)$microseconds);
} } else {
else {
return false; return false;
} }
} }
@ -282,16 +321,17 @@ class Net_Socket extends PEAR
* @access public * @access public
* @return mixed on success or an PEAR_Error object otherwise * @return mixed on success or an PEAR_Error object otherwise
*/ */
function setWriteBuffer($size) public function setWriteBuffer($size)
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
} }
$returned = stream_set_write_buffer($this->fp, $size); $returned = stream_set_write_buffer($this->fp, $size);
if ($returned == 0) { if ($returned === 0) {
return true; return true;
} }
return $this->raiseError('Cannot set write buffer.'); return $this->raiseError('Cannot set write buffer.');
} }
@ -310,7 +350,7 @@ class Net_Socket extends PEAR
* @return mixed Array containing information about existing socket * @return mixed Array containing information about existing socket
* resource or a PEAR_Error instance otherwise * resource or a PEAR_Error instance otherwise
*/ */
function getStatus() public function getStatus()
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
@ -331,13 +371,13 @@ class Net_Socket extends PEAR
* @return mixed $size bytes of data from the socket, or a PEAR_Error if * @return mixed $size bytes of data from the socket, or a PEAR_Error if
* not connected. If an error occurs, FALSE is returned. * not connected. If an error occurs, FALSE is returned.
*/ */
function gets($size = null) public function gets($size = null)
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
} }
if (is_null($size)) { if (null === $size) {
return @fgets($this->fp); return @fgets($this->fp);
} else { } else {
return @fgets($this->fp, $size); return @fgets($this->fp, $size);
@ -353,10 +393,10 @@ class Net_Socket extends PEAR
* @param integer $size The number of bytes to read from the socket. * @param integer $size The number of bytes to read from the socket.
* *
* @access public * @access public
* @return $size bytes of data from the socket, or a PEAR_Error if * @return string $size bytes of data from the socket, or a PEAR_Error if
* not connected. * not connected.
*/ */
function read($size) public function read($size)
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
@ -379,17 +419,17 @@ class Net_Socket extends PEAR
* If the write fails, returns false. * If the write fails, returns false.
* If the socket times out, returns an instance of PEAR_Error. * If the socket times out, returns an instance of PEAR_Error.
*/ */
function write($data, $blocksize = null) public function write($data, $blocksize = null)
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
} }
if (is_null($blocksize) && !OS_WINDOWS) { if (null === $blocksize && !OS_WINDOWS) {
$written = @fwrite($this->fp, $data); $written = @fwrite($this->fp, $data);
// Check for timeout or lost connection // Check for timeout or lost connection
if (!$written) { if ($written === false) {
$meta_data = $this->getStatus(); $meta_data = $this->getStatus();
if (!is_array($meta_data)) { if (!is_array($meta_data)) {
@ -403,7 +443,7 @@ class Net_Socket extends PEAR
return $written; return $written;
} else { } else {
if (is_null($blocksize)) { if (null === $blocksize) {
$blocksize = 1024; $blocksize = 1024;
} }
@ -413,7 +453,7 @@ class Net_Socket extends PEAR
$written = @fwrite($this->fp, substr($data, $pos, $blocksize)); $written = @fwrite($this->fp, substr($data, $pos, $blocksize));
// Check for timeout or lost connection // Check for timeout or lost connection
if (!$written) { if ($written === false) {
$meta_data = $this->getStatus(); $meta_data = $this->getStatus();
if (!is_array($meta_data)) { if (!is_array($meta_data)) {
@ -442,7 +482,7 @@ class Net_Socket extends PEAR
* @access public * @access public
* @return mixed fwrite() result, or PEAR_Error when not connected * @return mixed fwrite() result, or PEAR_Error when not connected
*/ */
function writeLine($data) public function writeLine($data)
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
@ -459,7 +499,7 @@ class Net_Socket extends PEAR
* @access public * @access public
* @return bool * @return bool
*/ */
function eof() public function eof()
{ {
return (!is_resource($this->fp) || feof($this->fp)); return (!is_resource($this->fp) || feof($this->fp));
} }
@ -468,10 +508,10 @@ class Net_Socket extends PEAR
* Reads a byte of data * Reads a byte of data
* *
* @access public * @access public
* @return 1 byte of data from the socket, or a PEAR_Error if * @return integer 1 byte of data from the socket, or a PEAR_Error if
* not connected. * not connected.
*/ */
function readByte() public function readByte()
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
@ -484,16 +524,17 @@ class Net_Socket extends PEAR
* Reads a word of data * Reads a word of data
* *
* @access public * @access public
* @return 1 word of data from the socket, or a PEAR_Error if * @return integer 1 word of data from the socket, or a PEAR_Error if
* not connected. * not connected.
*/ */
function readWord() public function readWord()
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
} }
$buf = @fread($this->fp, 2); $buf = @fread($this->fp, 2);
return (ord($buf[0]) + (ord($buf[1]) << 8)); return (ord($buf[0]) + (ord($buf[1]) << 8));
} }
@ -504,13 +545,14 @@ class Net_Socket extends PEAR
* @return integer 1 int of data from the socket, or a PEAR_Error if * @return integer 1 int of data from the socket, or a PEAR_Error if
* not connected. * not connected.
*/ */
function readInt() public function readInt()
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
} }
$buf = @fread($this->fp, 4); $buf = @fread($this->fp, 4);
return (ord($buf[0]) + (ord($buf[1]) << 8) + return (ord($buf[0]) + (ord($buf[1]) << 8) +
(ord($buf[2]) << 16) + (ord($buf[3]) << 24)); (ord($buf[2]) << 16) + (ord($buf[3]) << 24));
} }
@ -522,16 +564,17 @@ class Net_Socket extends PEAR
* @return string, or a PEAR_Error if * @return string, or a PEAR_Error if
* not connected. * not connected.
*/ */
function readString() public function readString()
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
} }
$string = ''; $string = '';
while (($char = @fread($this->fp, 1)) != "\x00") { while (($char = @fread($this->fp, 1)) !== "\x00") {
$string .= $char; $string .= $char;
} }
return $string; return $string;
} }
@ -539,16 +582,17 @@ class Net_Socket extends PEAR
* Reads an IP Address and returns it in a dot formatted string * Reads an IP Address and returns it in a dot formatted string
* *
* @access public * @access public
* @return Dot formatted string, or a PEAR_Error if * @return string Dot formatted string, or a PEAR_Error if
* not connected. * not connected.
*/ */
function readIPAddress() public function readIPAddress()
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
} }
$buf = @fread($this->fp, 4); $buf = @fread($this->fp, 4);
return sprintf('%d.%d.%d.%d', ord($buf[0]), ord($buf[1]), return sprintf('%d.%d.%d.%d', ord($buf[0]), ord($buf[1]),
ord($buf[2]), ord($buf[3])); ord($buf[2]), ord($buf[3]));
} }
@ -558,11 +602,11 @@ class Net_Socket extends PEAR
* comes first. Strips the trailing newline from the returned data. * comes first. Strips the trailing newline from the returned data.
* *
* @access public * @access public
* @return All available data up to a newline, without that * @return string All available data up to a newline, without that
* newline, or until the end of the socket, or a PEAR_Error if * newline, or until the end of the socket, or a PEAR_Error if
* not connected. * not connected.
*/ */
function readLine() public function readLine()
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
@ -578,6 +622,7 @@ class Net_Socket extends PEAR
return rtrim($line, $this->newline); return rtrim($line, $this->newline);
} }
} }
return $line; return $line;
} }
@ -594,16 +639,19 @@ class Net_Socket extends PEAR
* @return string All data until the socket closes, or a PEAR_Error if * @return string All data until the socket closes, or a PEAR_Error if
* not connected. * not connected.
*/ */
function readAll() public function readAll()
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
} }
$data = ''; $data = '';
while (!feof($this->fp)) { $timeout = time() + $this->timeout;
while (!feof($this->fp) && (!$this->timeout || time() < $timeout)) {
$data .= @fread($this->fp, $this->lineLength); $data .= @fread($this->fp, $this->lineLength);
} }
return $data; return $data;
} }
@ -619,7 +667,7 @@ class Net_Socket extends PEAR
* @return False if select fails, integer describing which of read/write/error * @return False if select fails, integer describing which of read/write/error
* are ready, or PEAR_Error if not connected. * are ready, or PEAR_Error if not connected.
*/ */
function select($state, $tv_sec, $tv_usec = 0) public function select($state, $tv_sec, $tv_usec = 0)
{ {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
@ -638,7 +686,8 @@ class Net_Socket extends PEAR
$except[] = $this->fp; $except[] = $this->fp;
} }
if (false === ($sr = stream_select($read, $write, $except, if (false === ($sr = stream_select($read, $write, $except,
$tv_sec, $tv_usec))) { $tv_sec, $tv_usec))
) {
return false; return false;
} }
@ -652,6 +701,7 @@ class Net_Socket extends PEAR
if (count($except)) { if (count($except)) {
$result |= NET_SOCKET_ERROR; $result |= NET_SOCKET_ERROR;
} }
return $result; return $result;
} }
@ -670,15 +720,17 @@ class Net_Socket extends PEAR
* A PEAR_Error object is returned if the socket is not * A PEAR_Error object is returned if the socket is not
* connected * connected
*/ */
function enableCrypto($enabled, $type) public function enableCrypto($enabled, $type)
{ {
if (version_compare(phpversion(), "5.1.0", ">=")) { if (version_compare(phpversion(), '5.1.0', '>=')) {
if (!is_resource($this->fp)) { if (!is_resource($this->fp)) {
return $this->raiseError('not connected'); return $this->raiseError('not connected');
} }
return @stream_socket_enable_crypto($this->fp, $enabled, $type); return @stream_socket_enable_crypto($this->fp, $enabled, $type);
} else { } else {
$msg = 'Net_Socket::enableCrypto() requires php version >= 5.1.0'; $msg = 'Net_Socket::enableCrypto() requires php version >= 5.1.0';
return $this->raiseError($msg); return $this->raiseError($msg);
} }
} }