Handle exception of decrypting unencrypted message

examples/cli/hist.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+set_time_limit(0);
+
+require('../../vendor/autoload.php');
+
+use PubNub\PubNub;
+use PubNub\PNConfiguration;
+use PubNub\CryptoModule;
+
+$pnUuid = 'pn-610da4553bb079.92567429'; //uniqid('pn-', true);
+
+$pnConfig = new PNConfiguration();
+$pnConfig->setPublishKey(getenv('PN_KEY_PUBLISH'));
+$pnConfig->setSubscribeKey(getenv('PN_KEY_SUBSCRIBE'));
+// $pnConfig->setSecretKey('sec-c-YjZiZWQzZWItMmZlNS00NjBlLTkyNTUtOGFhZjZiY2E1ZDc1');
+$pnConfig->setUuid($pnUuid);
+if (array_key_exists(2, $argv)) {
+    $pnConfig->setCrypto(CryptoModule::aesCbcCryptor($argv[2], true));
+}
+
+$pubnub = new PubNub($pnConfig);
+
+$ts = $pubnub->time()->sync();
+
+$channelName = $argv[1];
+$history = $pubnub->history()
+    ->channel($channelName)
+    ->reverse(false)
+    ->end((int)($ts->getTimetoken() - 3000000000))
+    ->count(50)
+    ->sync();
+
+foreach ($history->getMessages() as $key => $message) {
+    print($message);
+}

examples/cli/pub.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+set_time_limit(0);
+
+require('../../vendor/autoload.php');
+
+
+use PubNub\PubNub;
+use PubNub\PNConfiguration;
+use PubNub\CryptoModule;
+
+$pnUuid = $argv[1] . '-pn-610da4553bb079.92567429';
+
+$pnConfig = new PNConfiguration();
+$pnConfig->setPublishKey(getenv('PN_KEY_PUBLISH'));
+$pnConfig->setSubscribeKey(getenv('PN_KEY_SUBSCRIBE'));
+$pnConfig->setUuid($pnUuid);
+if (array_key_exists(4, $argv)) {
+    $pnConfig->setCrypto(CryptoModule::aesCbcCryptor($argv[4], true));
+}
+
+$pubnub = new PubNub($pnConfig);
+
+$pubResult = $pubnub->publish()->channel($argv[2])->message($argv[3])->sync();

examples/cli/sub.php

@@ -0,0 +1,104 @@
+<?php
+
+declare(strict_types=1);
+
+error_reporting(E_ALL ^ E_NOTICE ^ E_DEPRECATED);
+
+set_time_limit(0);
+
+require('../../vendor/autoload.php');
+
+use PubNub\Callbacks\SubscribeCallback;
+use PubNub\Exceptions\PubNubException;
+use PubNub\Models\Consumer\PubSub\PNMessageResult;
+use PubNub\Models\Consumer\PubSub\PNPresenceEventResult;
+use PubNub\Models\ResponseHelpers\PNStatus;
+use PubNub\PubNub;
+use PubNub\PNConfiguration;
+use PubNub\CryptoModule;
+
+
+$pnUuid = 'pn-610da4553bb079.92567429';
+
+$pnConfig = new PNConfiguration();
+$pnConfig->setPublishKey(getenv('PN_KEY_PUBLISH'));
+$pnConfig->setSubscribeKey(getenv('PN_KEY_SUBSCRIBE'));
+if (array_key_exists(2, $argv)) {
+    $pnConfig->setCrypto(CryptoModule::aesCbcCryptor($argv[2], true));
+}
+$pnConfig->setUuid($pnUuid);
+
+$pubnub = new PubNub($pnConfig);
+
+$channelName = $argv[1];
+
+// phpcs:ignore
+class MySubscribeCallback extends SubscribeCallback
+{
+    /**
+     * @param PubNub $pubnub
+     * @param PNStatus $status
+     * @return void
+     * @throws PubNubException
+     */
+    public function status($pubnub, $status)
+    {
+        printf(
+            "Category: %s\nPublisher user_id: %s",
+            $status->getCategory(),
+            $status->getUuid()
+        );
+    }
+
+    /**
+     * @param PubNub $pubnub
+     * @param PNMessageResult $messageResult
+     * @return void
+     */
+    public function message($pubnub, $messageResult)
+    {
+        printf(
+            "\nMessage %s\n Channel: %s\n Timetoken: %s\n Publisher: %s\n",
+            $messageResult->getMessage(),
+            $messageResult->getChannel(),
+            $messageResult->getTimetoken(),
+            $messageResult->getPublisher(),
+        );
+        if ($messageResult->isError()) {
+            printf('\nError occured during parsing the message: %s', $messageResult->getError()->getMessage());
+        }
+    }
+
+    /**
+     * @param PubNub $pubnub
+     * @param PNPresenceEventResult $presence
+     * @return void
+     */
+    public function presence($pubnub, $presence)
+    {
+        print("{$presence->getEvent()}: {$presence->getUuid()}");
+    }
+
+    /**
+     * @param PubNub $pubnub
+     * @param PNSignalMessageResult $signal
+     * @return void
+     */
+    public function signal($pubnub, $signal)
+    {
+    }
+}
+
+$subscribeCallback = new MySubscribeCallback();
+
+$pubnub->addListener($subscribeCallback);
+
+echo "subscribing to: $channelName\n";
+
+$subResult = $pubnub->subscribe()
+    ->channels($channelName)
+    ->withTimetoken(true)
+    ->withPresence(true)
+    ->execute();
+
+echo "done.\n";

src/PubNub/Managers/SubscriptionManager.php

@@ -2,7 +2,6 @@
 
 namespace PubNub\Managers;
 
-
 use PubNub\Exceptions\PubNubResponseParsingException;
 use PubNub\Models\Consumer\PubSub\PNPresenceEventResult;
 use PubNub\Builders\DTO\SubscribeOperation;
@@ -24,7 +23,6 @@
 use PubNub\PubNub;
 use PubNub\PubNubUtil;
 
-
 class SubscriptionManager
 {
     /** @var  PubNub */
@@ -251,17 +249,21 @@ protected function processIncomingPayload($message)
             );
 
             $this->listenerManager->announcePresence($pnPresenceResult);
-
         } else {
-            $extractedMessage = $this->processMessage($message->getPayload());
+            $messageError = null;
+            try {
+                $extractedMessage = $this->processMessage($message->getPayload());
+            } catch (PubNubResponseParsingException $exception) {
+                $extractedMessage = $message->getPayload();
+                $messageError = $exception;
+            }
             $publisher = $message->getIssuingClientId();
 
             if ($extractedMessage === null) {
                 $this->pubnub->getLogger()->debug("unable to parse payload on #processIncomingMessages");
             }
 
             if (MessageType::SIGNAL == $message->getMessageType()) {
-
                 $pnSignalResult = new PNSignalMessageResult(
                     $extractedMessage,
                     $channel,
@@ -272,13 +274,13 @@ protected function processIncomingPayload($message)
 
                 $this->listenerManager->announceSignal($pnSignalResult);
             } else {
-
                 $pnMessageResult = new PNMessageResult(
                     $extractedMessage,
                     $channel,
                     $subscriptionMatch,
                     $publishMetadata->getPublishTimetoken(),
-                    $publisher
+                    $publisher,
+                    $messageError
                 );
 
                 $this->listenerManager->announceMessage($pnMessageResult);

src/PubNub/Models/Consumer/History/PNHistoryItemResult.php

@@ -4,7 +4,6 @@
 
 use PubNub\PubNubCryptoCore;
 
-
 class PNHistoryItemResult
 {
     /** @var  any */
@@ -16,6 +15,8 @@ class PNHistoryItemResult
     /** @var  int */
     private $timetoken;
 
+    private $error = null;
+
     /**
      * PNHistoryItemResult constructor.
      * @param string $entry
@@ -36,10 +37,14 @@ public function __toString()
 
     public function decrypt()
     {
-        if (is_string($this->entry)) {
-            $this->entry = $this->crypto->decrypt($this->entry);
-        } elseif (is_array($this->entry) and key_exists('pn_other', $this->entry)) {
-            $this->entry['pn_other'] = $this->crypto->decrypt($this->entry['pn_other']);
+        try {
+            if (is_string($this->entry)) {
+                $this->entry = $this->crypto->decrypt($this->entry);
+            } elseif (is_array($this->entry) and key_exists('pn_other', $this->entry)) {
+                $this->entry['pn_other'] = $this->crypto->decrypt($this->entry['pn_other']);
+            }
+        } catch (\Exception $error) {
+            $this->error = $error;
         }
     }
 
@@ -58,4 +63,4 @@ public function getTimetoken()
     {
         return $this->timetoken;
     }
-}
+}

src/PubNub/Models/Consumer/PubSub/PNMessageResult.php

@@ -2,7 +2,6 @@
 
 namespace PubNub\Models\Consumer\PubSub;
 
-
 class PNMessageResult
 {
     /** @var  array */
@@ -20,6 +19,8 @@ class PNMessageResult
     /** @var  string */
     private $publisher;
 
+    private $error;
+
     /**
      * PNMessageResult constructor.
      * @param array $message
@@ -28,13 +29,14 @@ class PNMessageResult
      * @param int $timetoken
      * @param string $publisher
      */
-    public function __construct($message, $channel, $subscription, $timetoken, $publisher)
+    public function __construct($message, $channel, $subscription, $timetoken, $publisher, $error = null)
     {
         $this->message = $message;
         $this->channel = $channel;
         $this->subscription = $subscription;
         $this->timetoken = $timetoken;
         $this->publisher = $publisher;
+        $this->error = $error;
     }
 
     /**
@@ -76,4 +78,14 @@ public function getPublisher()
     {
         return $this->publisher;
     }
+
+    public function isError(): bool
+    {
+        return !is_null($this->error);
+    }
+
+    public function getError()
+    {
+        return $this->error;
+    }
 }