Merge pull request #69 from WarriorXK/hotfix/3.1.1

[WIP] Hotfix/3.1.1
WarriorXK · Jul 7, 2021 · adef40d · adef40d
2 parents 3bb00d5 + 4469bb6
commit adef40d
Show file tree

Hide file tree

Showing 21 changed files with 92 additions and 33 deletions.
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-3.1.0
+3.1.1
diff --git a/src/PHPWebSockets.php b/src/PHPWebSockets.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/PHPWebSockets/AConnection.php b/src/PHPWebSockets/AConnection.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -131,7 +131,7 @@ abstract class AConnection implements IStreamContainer, LoggerAwareInterface, IT
     /**
      * The timestamp since when this connection has been opened
      *
-     * @var int
+     * @var float|null
      */
     protected $_openedTimestamp = NULL;
 
@@ -215,7 +215,7 @@ abstract class AConnection implements IStreamContainer, LoggerAwareInterface, IT
     /**
      * The resource stream
      *
-     * @var resource
+     * @var resource|null
      */
     protected $_stream = NULL;
 
@@ -478,9 +478,10 @@ protected function _handlePacket(string $newData) : \Generator {
 
                             if ($res === FALSE) {
 
-                                $this->close();
                                 yield new Update\Error(Update\Error::C_WRITE_INVALID_TARGET_STREAM, $this);
 
+                                $this->close();
+
                             }
 
                         } else {
@@ -540,10 +541,10 @@ protected function _handlePacket(string $newData) : \Generator {
 
                             $this->_isClosed = TRUE;
 
-                            $this->close();
-
                             yield new Update\Read(Update\Read::C_SOCK_DISCONNECT, $this);
 
+                            $this->close();
+
                         } elseif (!$this->_weSentDisconnect) {
 
                             $this->_log(LogLevel::DEBUG, '  Remote initiated the disconnect, echo disconnect');
@@ -717,7 +718,18 @@ public function writeMultiFramed(string $data, int $opcode = \PHPWebSockets::OPC
             throw new \LogicException('FrameSize should be at least 1');
         }
 
-        $frames = str_split($data, $frameSize);
+        $dataLen = strlen($data);
+        if (strlen($data) > $frameSize) {
+
+            $frames = str_split($data, $frameSize);
+            if ($frames === FALSE) {
+                throw new \UnexpectedValueException('Unable to split ' . $dataLen . ' bytes into frames of ' . $frameSize . ' bytes');
+            }
+
+        } else {
+            $frames = [$data];
+        }
+
         end($frames);
         $lastKey = key($frames);
 
@@ -757,6 +769,10 @@ protected function _getStreamForNewMessage(array $headers) {
      */
     public function writeRaw(string $data, bool $priority) : void {
 
+        if (!$this->isOpen()) {
+            throw new \LogicException('Unable to write: Connection is closed');
+        }
+
         if ($priority) {
             $this->_priorityFramesBuffer[] = $data;
         } else {
@@ -859,7 +875,7 @@ public function setNewMessageStreamCallback(callable $callable = NULL) : void {
     /**
      * Returns the stream object for this connection
      *
-     * @return resource
+     * @return resource|null
      */
     public function getStream() {
         return $this->_stream;
@@ -960,10 +976,31 @@ public function close() : void {
         $this->_isClosed = TRUE;
 
         if (is_resource($this->_stream)) {
-            fclose($this->_stream);
+
+            $stream = $this->_stream;
             $this->_stream = NULL;
+
+            fclose($stream);
+
         }
 
+        // To prevent the warning that there was still data to write
+        $this->_clearBuffers();
+        $this->_resetFrameData();
+
+    }
+
+    /**
+     * Clears all buffers
+     */
+    private function _clearBuffers() : void {
+
+        $this->_currentFrameRemainingBytes = 0;
+        $this->_priorityFramesBuffer = [];
+        $this->_framesBuffer = [];
+        $this->_writeBuffer = NULL;
+        $this->_readBuffer = NULL;
+
     }
 
     /**

diff --git a/src/PHPWebSockets/AUpdate.php b/src/PHPWebSockets/AUpdate.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/PHPWebSockets/BasicLogger.php b/src/PHPWebSockets/BasicLogger.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/PHPWebSockets/Client.php b/src/PHPWebSockets/Client.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/PHPWebSockets/Framer.php b/src/PHPWebSockets/Framer.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/PHPWebSockets/IStreamContainer.php b/src/PHPWebSockets/IStreamContainer.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -76,7 +76,7 @@ public function handleRead() : \Generator;
     /**
      * Returns the stream object for this connection
      *
-     * @return resource
+     * @return resource|null
      */
     public function getStream();
 

diff --git a/src/PHPWebSockets/ITaggable.php b/src/PHPWebSockets/ITaggable.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/PHPWebSockets/Server.php b/src/PHPWebSockets/Server.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/PHPWebSockets/Server/AcceptingConnection.php b/src/PHPWebSockets/Server/AcceptingConnection.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/PHPWebSockets/Server/Connection.php b/src/PHPWebSockets/Server/Connection.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/PHPWebSockets/TLogAware.php b/src/PHPWebSockets/TLogAware.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/PHPWebSockets/TStreamContainerDefaults.php b/src/PHPWebSockets/TStreamContainerDefaults.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/PHPWebSockets/Update/Error.php b/src/PHPWebSockets/Update/Error.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/PHPWebSockets/Update/Read.php b/src/PHPWebSockets/Update/Read.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/PHPWebSockets/UpdatesWrapper.php b/src/PHPWebSockets/UpdatesWrapper.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -535,7 +535,6 @@ private function _onInvalidPayload(Update\Error $update) : void {
         $source = $update->getSourceConnection();
 
         $this->_triggerErrorHandler($source, $update->getCode());
-        $this->_triggerDisconnectHandler($source, FALSE, NULL);
 
         $this->_handledDisconnects[$source->getResourceIndex()] = TRUE;
 
@@ -561,7 +560,6 @@ private function _onProtocolError(Update\Error $update) : void {
         $source = $update->getSourceConnection();
 
         $this->_triggerErrorHandler($source, $update->getCode());
-        $this->_triggerDisconnectHandler($source, FALSE, NULL);
 
         $this->_handledDisconnects[$source->getResourceIndex()] = TRUE;
 
@@ -572,7 +570,6 @@ private function _onInvalidRSVBit(Update\Error $update) : void {
         $source = $update->getSourceConnection();
 
         $this->_triggerErrorHandler($source, $update->getCode());
-        $this->_triggerDisconnectHandler($source, FALSE, NULL);
 
         $this->_handledDisconnects[$source->getResourceIndex()] = TRUE;
 
@@ -587,7 +584,6 @@ private function _acceptTimeoutPassed(Update\Error $update) : void {
         $source = $update->getSourceConnection();
 
         $this->_triggerErrorHandler($source, $update->getCode());
-        $this->_triggerDisconnectHandler($source, FALSE, NULL);
 
         $this->_handledDisconnects[$source->getResourceIndex()] = TRUE;
 

diff --git a/tests/ClientTest.php b/tests/ClientTest.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/tests/Helpers/client.php b/tests/Helpers/client.php
@@ -3,6 +3,32 @@
 
 declare(strict_types = 1);
 
+/*
+ * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Kevin Meijer
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ * - - - - - - - - - - - - - - END LICENSE BLOCK - - - - - - - - - - - - -
+ */
+
 require_once __DIR__ . '/../../vendor/autoload.php';
 
 $cliArgs = [

diff --git a/tests/ServerTest.php b/tests/ServerTest.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/tests/UpdatesWrapperTest.php b/tests/UpdatesWrapperTest.php
@@ -6,7 +6,7 @@
  * - - - - - - - - - - - - - BEGIN LICENSE BLOCK - - - - - - - - - - - - -
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 Kevin Meijer
+ * Copyright (c) 2021 Kevin Meijer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal