From: Mikael Nordfeldth <mmn@hethane.se>
Date: Sun, 9 Jul 2017 21:09:03 +0000 (+0200)
Subject: PEAR Net_Socket updated to 1.2.2
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=f025671b8aa47c2d750d1ede8a171e00b3f42a7b;p=quix0rs-gnu-social.git

PEAR Net_Socket updated to 1.2.2

Source: https://pear.php.net/package/Net_Socket
Release date: 2017-04-13
---

diff --git a/extlib/Net/Socket.php b/extlib/Net/Socket.php
index bf1d1bbcd1..5a057cf78b 100644
--- a/extlib/Net/Socket.php
+++ b/extlib/Net/Socket.php
@@ -2,27 +2,41 @@
 /**
  * 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,
- * that is bundled with this package in the file LICENSE, and is
- * 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.
+ * Copyright (c) 1997-2017 The PHP Group
+ * All rights reserved.
  *
- * Authors: Stig Bakken <ssb@php.net>
- *          Chuck Hagenbuch <chuck@horde.org>
+ * Redistribution and use in source and binary forms, with or without
+ * 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
  * @package   Net_Socket
  * @author    Stig Bakken <ssb@php.net>
  * @author    Chuck Hagenbuch <chuck@horde.org>
- * @copyright 1997-2003 The PHP Group
- * @license   http://www.php.net/license/2_02.txt PHP 2.02
+ * @copyright 1997-2017 The PHP Group
+ * @license   http://opensource.org/licenses/bsd-license.php BSD-2-Clause
  * @link      http://pear.php.net/packages/Net_Socket
  */
 
@@ -39,8 +53,8 @@ define('NET_SOCKET_ERROR', 4);
  * @package   Net_Socket
  * @author    Stig Bakken <ssb@php.net>
  * @author    Chuck Hagenbuch <chuck@horde.org>
- * @copyright 1997-2003 The PHP Group
- * @license   http://www.php.net/license/2_02.txt PHP 2.02
+ * @copyright 1997-2017 The PHP Group
+ * @license   http://opensource.org/licenses/bsd-license.php BSD-2-Clause
  * @link      http://pear.php.net/packages/Net_Socket
  */
 class Net_Socket extends PEAR
@@ -49,71 +63,75 @@ class Net_Socket extends PEAR
      * Socket file pointer.
      * @var resource $fp
      */
-    var $fp = null;
+    public $fp = null;
 
     /**
      * Whether the socket is blocking. Defaults to true.
      * @var boolean $blocking
      */
-    var $blocking = true;
+    public $blocking = true;
 
     /**
      * Whether the socket is persistent. Defaults to false.
      * @var boolean $persistent
      */
-    var $persistent = false;
+    public $persistent = false;
 
     /**
      * The IP address to connect to.
      * @var string $addr
      */
-    var $addr = '';
+    public $addr = '';
 
     /**
      * The port number to connect to.
      * @var integer $port
      */
-    var $port = 0;
+    public $port = 0;
 
     /**
      * Number of seconds to wait on socket operations before assuming
      * there's no more data. Defaults to no timeout.
      * @var integer|float $timeout
      */
-    var $timeout = null;
+    public $timeout = null;
 
     /**
      * Number of bytes to read at a time in readLine() and
      * readAll(). Defaults to 2048.
      * @var integer $lineLength
      */
-    var $lineLength = 2048;
+    public $lineLength = 2048;
 
     /**
      * The string to use as a newline terminator. Usually "\r\n" or "\n".
      * @var string $newline
      */
-    var $newline = "\r\n";
+    public $newline = "\r\n";
 
     /**
      * Connect to the specified port. If called when the socket is
      * already connected, it disconnects and connects again.
      *
-     * @param string  $addr       IP address or host name (may be with protocol prefix).
-     * @param integer $port       TCP port number.
+     * @param string $addr IP address or host name (may be with protocol prefix).
+     * @param integer $port TCP port number.
      * @param boolean $persistent (optional) Whether the connection is
      *                            persistent (kept open between requests
      *                            by the web server).
-     * @param integer $timeout    (optional) Connection socket timeout.
-     * @param array   $options    See options for stream_context_create.
+     * @param integer $timeout (optional) Connection socket timeout.
+     * @param array $options See options for stream_context_create.
      *
      * @access public
      *
      * @return boolean|PEAR_Error  True on success or a PEAR_Error on failure.
      */
-    function connect($addr, $port = 0, $persistent = null,
-                     $timeout = null, $options = null)
-    {
+    public function connect(
+        $addr,
+        $port = 0,
+        $persistent = null,
+        $timeout = null,
+        $options = null
+    ) {
         if (is_resource($this->fp)) {
             @fclose($this->fp);
             $this->fp = null;
@@ -121,10 +139,12 @@ class Net_Socket extends PEAR
 
         if (!$addr) {
             return $this->raiseError('$addr cannot be empty');
-        } else if (strspn($addr, ':.0123456789') == strlen($addr)) {
-            $this->addr = strpos($addr, ':') !== false ? '['.$addr.']' : $addr;
         } else {
-            $this->addr = $addr;
+            if (strspn($addr, ':.0123456789') === strlen($addr)) {
+                $this->addr = strpos($addr, ':') !== false ? '[' . $addr . ']' : $addr;
+            } else {
+                $this->addr = $addr;
+            }
         }
 
         $this->port = $port % 65536;
@@ -134,10 +154,14 @@ class Net_Socket extends PEAR
         }
 
         $openfunc = $this->persistent ? 'pfsockopen' : 'fsockopen';
-        $errno    = 0;
-        $errstr   = '';
+        $errno = 0;
+        $errstr = '';
 
-        $old_track_errors = @ini_set('track_errors', 1);
+        if (function_exists('error_clear_last')) {
+            error_clear_last();
+        } else {
+            $old_track_errors = @ini_set('track_errors', 1);
+        }
 
         if ($timeout <= 0) {
             $timeout = @ini_get('default_socket_timeout');
@@ -155,27 +179,40 @@ class Net_Socket extends PEAR
                 }
 
                 $addr = $this->addr . ':' . $this->port;
-                $fp   = stream_socket_client($addr, $errno, $errstr,
-                                             $timeout, $flags, $context);
+                $fp = @stream_socket_client($addr, $errno, $errstr,
+                    $timeout, $flags, $context);
             } else {
                 $fp = @$openfunc($this->addr, $this->port, $errno,
-                                 $errstr, $timeout, $context);
+                    $errstr, $timeout, $context);
             }
         } else {
             $fp = @$openfunc($this->addr, $this->port, $errno, $errstr, $timeout);
         }
 
         if (!$fp) {
-            if ($errno == 0 && !strlen($errstr) && isset($php_errormsg)) {
-                $errstr = $php_errormsg;
+            if ($errno === 0 && !strlen($errstr)) {
+                $errstr = '';
+                if (isset($old_track_errors)) {
+                    $errstr = $php_errormsg ?: '';  
+                    @ini_set('track_errors', $old_track_errors);
+                } else {
+                    $lastError = error_get_last();
+                    if (isset($lastError['message'])) {
+                        $errstr = $lastError['message'];
+                    }
+                }
             }
-            @ini_set('track_errors', $old_track_errors);
+
             return $this->raiseError($errstr, $errno);
         }
 
-        @ini_set('track_errors', $old_track_errors);
+        if (isset($old_track_errors)) {
+            @ini_set('track_errors', $old_track_errors);
+        }
+
         $this->fp = $fp;
         $this->setTimeout();
+
         return $this->setBlocking($this->blocking);
     }
 
@@ -185,7 +222,7 @@ class Net_Socket extends PEAR
      * @access public
      * @return mixed true on success or a PEAR_Error instance otherwise
      */
-    function disconnect()
+    public function disconnect()
     {
         if (!is_resource($this->fp)) {
             return $this->raiseError('not connected');
@@ -193,18 +230,20 @@ class Net_Socket extends PEAR
 
         @fclose($this->fp);
         $this->fp = null;
+
         return true;
     }
 
     /**
      * Set the newline character/sequence to use.
      *
-     * @param string $newline  Newline character(s)
+     * @param string $newline Newline character(s)
      * @return boolean True
      */
-    function setNewline($newline)
+    public function setNewline($newline)
     {
         $this->newline = $newline;
+
         return true;
     }
 
@@ -214,7 +253,7 @@ class Net_Socket extends PEAR
      * @access public
      * @return boolean  The current blocking mode.
      */
-    function isBlocking()
+    public function isBlocking()
     {
         return $this->blocking;
     }
@@ -230,7 +269,7 @@ class Net_Socket extends PEAR
      * @access public
      * @return mixed true on success or a PEAR_Error instance otherwise
      */
-    function setBlocking($mode)
+    public function setBlocking($mode)
     {
         if (!is_resource($this->fp)) {
             return $this->raiseError('not connected');
@@ -238,6 +277,7 @@ class Net_Socket extends PEAR
 
         $this->blocking = $mode;
         stream_set_blocking($this->fp, (int)$this->blocking);
+
         return true;
     }
 
@@ -245,30 +285,29 @@ class Net_Socket extends PEAR
      * Sets the timeout value on socket descriptor,
      * expressed in the sum of seconds and microseconds
      *
-     * @param integer $seconds      Seconds.
+     * @param integer $seconds Seconds.
      * @param integer $microseconds Microseconds, optional.
      *
      * @access public
      * @return mixed True on success or false on failure or
      *               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)) {
             return $this->raiseError('not connected');
         }
 
         if ($seconds === null && $microseconds === null) {
-            $seconds      = (int) $this->timeout;
-            $microseconds = (int) (($this->timeout - $seconds) * 1000000);
+            $seconds = (int)$this->timeout;
+            $microseconds = (int)(($this->timeout - $seconds) * 1000000);
         } else {
-            $this->timeout = $seconds + $microseconds/1000000;
+            $this->timeout = $seconds + $microseconds / 1000000;
         }
 
         if ($this->timeout > 0) {
-            return stream_set_timeout($this->fp, (int) $seconds, (int) $microseconds);
-        }
-        else {
+            return stream_set_timeout($this->fp, (int)$seconds, (int)$microseconds);
+        } else {
             return false;
         }
     }
@@ -282,16 +321,17 @@ class Net_Socket extends PEAR
      * @access public
      * @return mixed on success or an PEAR_Error object otherwise
      */
-    function setWriteBuffer($size)
+    public function setWriteBuffer($size)
     {
         if (!is_resource($this->fp)) {
             return $this->raiseError('not connected');
         }
 
         $returned = stream_set_write_buffer($this->fp, $size);
-        if ($returned == 0) {
+        if ($returned === 0) {
             return true;
         }
+
         return $this->raiseError('Cannot set write buffer.');
     }
 
@@ -310,7 +350,7 @@ class Net_Socket extends PEAR
      * @return mixed Array containing information about existing socket
      *               resource or a PEAR_Error instance otherwise
      */
-    function getStatus()
+    public function getStatus()
     {
         if (!is_resource($this->fp)) {
             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
      *         not connected. If an error occurs, FALSE is returned.
      */
-    function gets($size = null)
+    public function gets($size = null)
     {
         if (!is_resource($this->fp)) {
             return $this->raiseError('not connected');
         }
 
-        if (is_null($size)) {
+        if (null === $size) {
             return @fgets($this->fp);
         } else {
             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.
      *
      * @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.
      */
-    function read($size)
+    public function read($size)
     {
         if (!is_resource($this->fp)) {
             return $this->raiseError('not connected');
@@ -368,7 +408,7 @@ class Net_Socket extends PEAR
     /**
      * Write a specified amount of data.
      *
-     * @param string  $data      Data to write.
+     * @param string $data Data to write.
      * @param integer $blocksize Amount of data to write at once.
      *                           NULL means all at once.
      *
@@ -379,17 +419,17 @@ class Net_Socket extends PEAR
      *               If the write fails, returns false.
      *               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)) {
             return $this->raiseError('not connected');
         }
 
-        if (is_null($blocksize) && !OS_WINDOWS) {
+        if (null === $blocksize && !OS_WINDOWS) {
             $written = @fwrite($this->fp, $data);
 
             // Check for timeout or lost connection
-            if (!$written) {
+            if ($written === false) {
                 $meta_data = $this->getStatus();
 
                 if (!is_array($meta_data)) {
@@ -403,17 +443,17 @@ class Net_Socket extends PEAR
 
             return $written;
         } else {
-            if (is_null($blocksize)) {
+            if (null === $blocksize) {
                 $blocksize = 1024;
             }
 
-            $pos  = 0;
+            $pos = 0;
             $size = strlen($data);
             while ($pos < $size) {
                 $written = @fwrite($this->fp, substr($data, $pos, $blocksize));
 
                 // Check for timeout or lost connection
-                if (!$written) {
+                if ($written === false) {
                     $meta_data = $this->getStatus();
 
                     if (!is_array($meta_data)) {
@@ -442,7 +482,7 @@ class Net_Socket extends PEAR
      * @access public
      * @return mixed fwrite() result, or PEAR_Error when not connected
      */
-    function writeLine($data)
+    public function writeLine($data)
     {
         if (!is_resource($this->fp)) {
             return $this->raiseError('not connected');
@@ -459,7 +499,7 @@ class Net_Socket extends PEAR
      * @access public
      * @return bool
      */
-    function eof()
+    public function eof()
     {
         return (!is_resource($this->fp) || feof($this->fp));
     }
@@ -468,10 +508,10 @@ class Net_Socket extends PEAR
      * Reads a byte of data
      *
      * @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.
      */
-    function readByte()
+    public function readByte()
     {
         if (!is_resource($this->fp)) {
             return $this->raiseError('not connected');
@@ -484,16 +524,17 @@ class Net_Socket extends PEAR
      * Reads a word of data
      *
      * @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.
      */
-    function readWord()
+    public function readWord()
     {
         if (!is_resource($this->fp)) {
             return $this->raiseError('not connected');
         }
 
         $buf = @fread($this->fp, 2);
+
         return (ord($buf[0]) + (ord($buf[1]) << 8));
     }
 
@@ -504,15 +545,16 @@ class Net_Socket extends PEAR
      * @return integer  1 int of data from the socket, or a PEAR_Error if
      *                  not connected.
      */
-    function readInt()
+    public function readInt()
     {
         if (!is_resource($this->fp)) {
             return $this->raiseError('not connected');
         }
 
         $buf = @fread($this->fp, 4);
+
         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
      *         not connected.
      */
-    function readString()
+    public function readString()
     {
         if (!is_resource($this->fp)) {
             return $this->raiseError('not connected');
         }
 
         $string = '';
-        while (($char = @fread($this->fp, 1)) != "\x00") {
+        while (($char = @fread($this->fp, 1)) !== "\x00") {
             $string .= $char;
         }
+
         return $string;
     }
 
@@ -539,18 +582,19 @@ class Net_Socket extends PEAR
      * Reads an IP Address and returns it in a dot formatted string
      *
      * @access public
-     * @return Dot formatted string, or a PEAR_Error if
+     * @return string Dot formatted string, or a PEAR_Error if
      *         not connected.
      */
-    function readIPAddress()
+    public function readIPAddress()
     {
         if (!is_resource($this->fp)) {
             return $this->raiseError('not connected');
         }
 
         $buf = @fread($this->fp, 4);
+
         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.
      *
      * @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
      *         not connected.
      */
-    function readLine()
+    public function readLine()
     {
         if (!is_resource($this->fp)) {
             return $this->raiseError('not connected');
@@ -578,6 +622,7 @@ class Net_Socket extends PEAR
                 return rtrim($line, $this->newline);
             }
         }
+
         return $line;
     }
 
@@ -594,16 +639,19 @@ class Net_Socket extends PEAR
      * @return string  All data until the socket closes, or a PEAR_Error if
      *                 not connected.
      */
-    function readAll()
+    public function readAll()
     {
         if (!is_resource($this->fp)) {
             return $this->raiseError('not connected');
         }
 
         $data = '';
-        while (!feof($this->fp)) {
+        $timeout = time() + $this->timeout;
+
+        while (!feof($this->fp) && (!$this->timeout || time() < $timeout)) {
             $data .= @fread($this->fp, $this->lineLength);
         }
+
         return $data;
     }
 
@@ -611,22 +659,22 @@ class Net_Socket extends PEAR
      * Runs the equivalent of the select() system call on the socket
      * with a timeout specified by tv_sec and tv_usec.
      *
-     * @param integer $state   Which of read/write/error to check for.
-     * @param integer $tv_sec  Number of seconds for timeout.
+     * @param integer $state Which of read/write/error to check for.
+     * @param integer $tv_sec Number of seconds for timeout.
      * @param integer $tv_usec Number of microseconds for timeout.
      *
      * @access public
      * @return False if select fails, integer describing which of read/write/error
      *         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)) {
             return $this->raiseError('not connected');
         }
 
-        $read   = null;
-        $write  = null;
+        $read = null;
+        $write = null;
         $except = null;
         if ($state & NET_SOCKET_READ) {
             $read[] = $this->fp;
@@ -638,7 +686,8 @@ class Net_Socket extends PEAR
             $except[] = $this->fp;
         }
         if (false === ($sr = stream_select($read, $write, $except,
-                                          $tv_sec, $tv_usec))) {
+                $tv_sec, $tv_usec))
+        ) {
             return false;
         }
 
@@ -652,15 +701,16 @@ class Net_Socket extends PEAR
         if (count($except)) {
             $result |= NET_SOCKET_ERROR;
         }
+
         return $result;
     }
 
     /**
      * Turns encryption on/off on a connected socket.
      *
-     * @param bool    $enabled Set this parameter to true to enable encryption
+     * @param bool $enabled Set this parameter to true to enable encryption
      *                         and false to disable encryption.
-     * @param integer $type    Type of encryption. See stream_socket_enable_crypto()
+     * @param integer $type Type of encryption. See stream_socket_enable_crypto()
      *                         for values.
      *
      * @see    http://se.php.net/manual/en/function.stream-socket-enable-crypto.php
@@ -670,15 +720,17 @@ class Net_Socket extends PEAR
      *         A PEAR_Error object is returned if the socket is not
      *         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)) {
                 return $this->raiseError('not connected');
             }
+
             return @stream_socket_enable_crypto($this->fp, $enabled, $type);
         } else {
             $msg = 'Net_Socket::enableCrypto() requires php version >= 5.1.0';
+
             return $this->raiseError($msg);
         }
     }