SKien\PNServer\PNServer

Complexity

Total Complexity

56

Size/Duplication

Total Lines	433
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	1

17 Methods

Rating	Name	Duplication	Size	Complexity
A	setAutoRemove()	0	3	1
A	reset()	0	7	1
A	__construct()	0	5	1
A	getSubscriptionCount()	0	3	1
A	loadSubscriptions()	0	26	4
A	getDP()	0	3	1
A	getPayload()	0	3	1
A	setVapid()	0	3	1
A	setPayload()	0	4	3
A	addSubscription()	0	6	3
A	getLog()	0	3	1
A	getPushServiceResponseText()	0	15	2
A	getError()	0	3	1
A	getSummary()	0	21	4
A	checkAutoRemove()	0	4	2
D	push()	0	101	21
B	pushSingle()	0	54	8

<?php
declare(strict_types=1);

namespace SKien\PNServer;

use Psr\Log\LoggerAwareTrait;
use Psr\Log\NullLogger;

/**
 * main class of the package to create push notifications.
 * 
 * #### History
 * - *2020-04-12*   initial version
 * - *2020-08-03*   PHP 7.4 type hint
 * 
 * @package SKien/PNServer
 * @version 1.1.0
 * @author Stefanius <s.kien@online.de>
 * @copyright MIT License - see the LICENSE file for details
*/
class PNServer
{
    use LoggerAwareTrait;
    use PNServerHelper;
    
    /** @var PNDataProvider dataprovider         */
    protected ?PNDataProvider $oDP = null;
    /** @var bool set when data has been loaded from DB         */
    protected bool $bFromDB = false;
    /** @var bool auto remove invalid/expired subscriptions     */
    protected bool $bAutoRemove = true;
    /** @var PNVapid        */
    protected ?PNVapid $oVapid = null;
    /** @var string         */
    protected string $strPayload = '';
    /** @var array          */
    protected array $aSubscription = [];
    /** @var array          */
    protected array $aLog = [];
    /** @var int $iAutoRemoved count of items autoremoved in loadSubscriptions */
    protected int $iAutoRemoved = 0;
    /** @var int $iExpired count of expired items */
    protected int $iExpired = 0;
    /** @var string last error msg  */
    protected string $strError = '';
    
    /**
     * create instance.
     * if $oDP specified, subscriptions can be loaded direct from data Source
     * and invalid or expired subscriptions will be removed automatically in
     * case rejection from the push service.
     *    
     * @param PNDataProvider $oDP
     */
    public function __construct(?PNDataProvider $oDP = null)
    {
        $this->oDP = $oDP;
        $this->reset();
        $this->logger = new NullLogger();
    }
    
    /**
     * @return PNDataProvider
     */
    public function getDP() : ?PNDataProvider
    {
        return $this->oDP;
    }

    /**
     * reset ll to begin new push notification.
     */
    public function reset() : void
    {
        $this->bFromDB = false;
        $this->strPayload = '';
        $this->oVapid = null;
        $this->aSubscription = [];
        $this->aLog = [];
    }
        
    /**
     * set VAPID subject and keys.
     * @param PNVapid $oVapid
     */
    public function setVapid(PNVapid $oVapid) : void 
    {
        $this->oVapid = $oVapid;
    }
    
    /**
     * set payload used for all push notifications.
     * @param mixed $payload    string or PNPayload object
     */
    public function setPayload($payload) : void 
    {
        if (is_string($payload) || self::className($payload) == 'PNPayload') {
            $this->strPayload = (string) $payload;
        }
    }
    
    /**
     * @return string
     */
    public function getPayload() : string
    {
        return $this->strPayload;
    }
    
    /**
     * add subscription to the notification list.
     * @param PNSubscription $oSubscription
     */
    public function addSubscription(PNSubscription $oSubscription) : void
    {
        if ($oSubscription->isValid()) {
            $this->aSubscription[] = $oSubscription;
        }
        $this->logger->info(__CLASS__ . ': ' . 'added {state} Subscription.', ['state' => $oSubscription->isValid() ? 'valid' : 'invalid']);
    }
    
    /**
     * Get the count of valid subscriptions set.
     * @return int
     */
    public function getSubscriptionCount() : int
    {
        return count($this->aSubscription);
    }
    
    /**
     * Load subscriptions from internal DataProvider.
     * if $this->bAutoRemove set (default: true), expired subscriptions will
     * be automatically removed from the data source.
     * @return bool
     */
    public function loadSubscriptions() : bool
    {
        $bSucceeded = false;
        $this->aSubscription = [];
        $this->iAutoRemoved = 0;
        $this->iExpired = 0;
        if ($this->oDP) {
            $iBefore = $this->oDP->count();
            if (($bSucceeded = $this->oDP->init($this->bAutoRemove)) !== false) {
                $this->bFromDB = true;
                $this->iAutoRemoved = $iBefore - $this->oDP->count();
                while (($strJsonSub = $this->oDP->fetch()) !== false) {
                    $this->addSubscription(PNSubscription::fromJSON((string) $strJsonSub));
                }
                // if $bAutoRemove is false, $this->iExpired may differs from $this->iAutoRemoved
                $this->iExpired = $iBefore - count($this->aSubscription);
                $this->logger->info(__CLASS__ . ': ' . 'added {count} Subscriptions from DB.', ['count' => count($this->aSubscription)]);
            } else {
                $this->strError = $this->oDP->getError();
                $this->logger->error(__CLASS__ . ': ' . $this->strError);
            }
        } else {
            $this->strError = 'missing dataprovider!';
            $this->logger->error(__CLASS__ . ': ' . $this->strError);
        }
        return $bSucceeded;
    }

    /**
     * auto remove invalid/expired subscriptions.
     * has only affect, if data loaded through DataProvider 
     * @param bool $bAutoRemove
     */
    public function setAutoRemove(bool $bAutoRemove = true) : void 
    {
        $this->bAutoRemove = $bAutoRemove;
    }
    
    /**
     * push all notifications.
     * 
     * Since a large number is expected when sending PUSH notifications, the 
     * POST requests are generated asynchronously via a cURL multi handle.
     * The response codes are then assigned to the respective end point and a 
     * transmission log is generated.
     * If the subscriptions comes from the internal data provider, all 
     * subscriptions that are no longer valid or that are no longer available 
     * with the push service will be removed from the database.
     * @return bool
     */
    public function push() : bool
    {
        if (!$this->oVapid) {
            $this->strError = 'no VAPID-keys set!';
            $this->logger->error(__CLASS__ . ': ' . $this->strError);
        } elseif (!$this->oVapid->isValid()) {
            $this->strError = 'VAPID error: ' . $this->oVapid->getError();
            $this->logger->error(__CLASS__ . ': ' . $this->strError);
        } elseif (count($this->aSubscription) == 0) {
            $this->strError = 'no valid Subscriptions set!';
            $this->logger->warning(__CLASS__ . ': ' . $this->strError);
        } else {
            // create multi requests...
            $mcurl = curl_multi_init();
            if ($mcurl !== false) {
                $aRequests = array();
                
                foreach ($this->aSubscription as $oSub) {
                    $aLog = ['msg' => '', 'curl_response' => '', 'curl_response_code' => -1];
                    // payload must be encrypted every time although it does not change, since 
                    // each subscription has at least his public key and authentication token of its own ...
                    $oEncrypt = new PNEncryption($oSub->getPublicKey(), $oSub->getAuth(), $oSub->getEncoding()); 
                    if (($strContent = $oEncrypt->encrypt($this->strPayload)) !== false) {
                        // merge headers from encryption and VAPID (maybe both containing 'Crypto-Key')
                        if (($aVapidHeaders = $this->oVapid->getHeaders($oSub->getEndpoint())) !== false) {
                            $aHeaders = $oEncrypt->getHeaders($aVapidHeaders);
                            $aHeaders['Content-Length'] = mb_strlen($strContent, '8bit');
                            $aHeaders['TTL'] = 2419200;
                
                            // build Http - Headers
                            $aHttpHeader = array();
                            foreach ($aHeaders as $strName => $strValue) {
                                $aHttpHeader[] = $strName . ': ' . $strValue; 
                            }
                            
                            // and send request with curl
                            $curl = curl_init($oSub->getEndpoint());
                            
                            if ($curl !== false) {
                                curl_setopt($curl, CURLOPT_POST, true);
                                curl_setopt($curl, CURLOPT_POSTFIELDS, $strContent);
                                curl_setopt($curl, CURLOPT_HTTPHEADER, $aHttpHeader);
                                curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
                            
                                curl_multi_add_handle($mcurl, $curl);
                            
                                $aRequests[$oSub->getEndpoint()] = $curl;
                            }
                        } else {
                            $aLog['msg'] = 'VAPID error: ' . $this->oVapid->getError();
                        }
                    } else {
                        $aLog['msg'] = 'Payload encryption error: ' . $oEncrypt->getError();
                    }
                    if (strlen($aLog['msg']) > 0) {
                        $this->aLog[$oSub->getEndpoint()] = $aLog;
                    }
                }
                    
                if (count($aRequests) > 0) {
                    // now performing multi request...
                    $iRunning = null;
                    do {
                        $iMState = curl_multi_exec($mcurl, $iRunning);
                    } while ($iRunning && $iMState == CURLM_OK);
                    
                    if ($iMState == CURLM_OK) {
                        // ...and get response of each request
                        foreach ($aRequests as $strEndPoint => $curl) {
                            $aLog = array();
                            $iRescode = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
                            
                            $aLog['msg'] = $this->getPushServiceResponseText($iRescode);
                            $aLog['curl_response'] = curl_multi_getcontent($curl);
                            $aLog['curl_response_code'] = $iRescode;
                            $this->aLog[$strEndPoint] = $aLog;
                            // remove handle from multi and close
                            curl_multi_remove_handle($mcurl, $curl);
                            curl_close($curl);
                        }
                        
                    } else {
                        $this->strError = 'curl_multi_exec() Erroro: ' . curl_multi_strerror($iMState);
                        $this->logger->error(__CLASS__ . ': ' . $this->strError);
                    }
                    // ... close the door
                    curl_multi_close($mcurl);
                }
                if ($this->oDP != null && $this->bFromDB && $this->bAutoRemove) {
                    foreach ($this->aLog as $strEndPoint => $aLogItem) {
                        if ($this->checkAutoRemove($aLogItem['curl_response_code'])) {
                            // just remove subscription from DB
                            $aLogItem['msg'] .= ' Subscription removed from DB!';
                            $this->oDP->removeSubscription($strEndPoint);
                        }
                    }
                }
            }
        }
        $this->logger->info(__CLASS__ . ': ' . 'notifications pushed', $this->getSummary());
        return (strlen($this->strError) == 0);
    }

    /**
     * Push one single subscription.
     * @param PNSubscription $oSub
     * @return bool
     */
    public function pushSingle(PNSubscription $oSub) : bool
    {
        if (!$this->oVapid) {
            $this->strError = 'no VAPID-keys set!';
            $this->logger->error(__CLASS__ . ': ' . $this->strError);
        } elseif (!$this->oVapid->isValid()) {
            $this->strError = 'VAPID error: ' . $this->oVapid->getError();
            $this->logger->error(__CLASS__ . ': ' . $this->strError);
        } else {
            $aLog = ['msg' => '', 'curl_response' => '', 'curl_response_code' => -1];
            // payload must be encrypted every time although it does not change, since
            // each subscription has at least his public key and authentication token of its own ...
            $oEncrypt = new PNEncryption($oSub->getPublicKey(), $oSub->getAuth(), $oSub->getEncoding());
            if (($strContent = $oEncrypt->encrypt($this->strPayload)) !== false) {
                // merge headers from encryption and VAPID (maybe both containing 'Crypto-Key')
                if (($aVapidHeaders = $this->oVapid->getHeaders($oSub->getEndpoint())) !== false) {

The condition $aVapidHeaders = $this->oVapid->getHeaders($oSub->getEndpoint()) !== false is always true.

                    $aHeaders = $oEncrypt->getHeaders($aVapidHeaders);
                    $aHeaders['Content-Length'] = mb_strlen($strContent, '8bit');
                    $aHeaders['TTL'] = 2419200;
                    
                    // build Http - Headers
                    $aHttpHeader = array();
                    foreach ($aHeaders as $strName => $strValue) {
                        $aHttpHeader[] = $strName . ': ' . $strValue;
                    }
                    
                    // and send request with curl
                    $curl = curl_init($oSub->getEndpoint());
                    
                    if ($curl !== false) {
                        curl_setopt($curl, CURLOPT_POST, true);
                        curl_setopt($curl, CURLOPT_POSTFIELDS, $strContent);
                        curl_setopt($curl, CURLOPT_HTTPHEADER, $aHttpHeader);
                        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
                        
                        if (($strResponse = curl_exec($curl)) !== false) {
                            $iRescode = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
                            
                            $aLog['msg'] = $this->getPushServiceResponseText($iRescode);
                            $aLog['curl_response'] = $strResponse;
                            $aLog['curl_response_code'] = $iRescode;
                            curl_close($curl);
                        }
                    }
                } else {
                    $aLog['msg'] = 'VAPID error: ' . $this->oVapid->getError();
                }
            } else {
                $aLog['msg'] = 'Payload encryption error: ' . $oEncrypt->getError();
            }
            $this->aLog[$oSub->getEndpoint()] = $aLog;
        }
        $this->logger->info(__CLASS__ . ': ' . 'single notifications pushed.');
        return (strlen($this->strError) == 0);
    }
    
    /**
     * @return array
     */
    public function getLog() : array
    {
        return $this->aLog;
    }
    
    /**
     * Build summary for the log of the last push operation.
     * - total count of subscriptions processed<br/>
     * - count of successfull pushed messages<br/>
     * - count of failed messages (subscriptions couldn't be pushed of any reason)<br/>
     * - count of expired subscriptions<br/>
     * - count of removed subscriptions (expired, gone, not found, invalid)<br/>
     * The count of expired entries removed in the loadSubscriptions() is added to
     * the count of responsecode caused removed items.
     * The count of failed and removed messages may differ even if $bAutoRemove is set
     * if there are transferns with responsecode 413 or 429    
     * @return array
     */
    public function getSummary() : array
    {
        $aSummary = [
            'total' => $this->iExpired, 
            'pushed' => 0, 
            'failed' => 0, 
            'expired' => $this->iExpired, 
            'removed' => $this->iAutoRemoved,
        ];
        foreach ($this->aLog as $aLogItem) {
            $aSummary['total']++;
            if ($aLogItem['curl_response_code'] == 201) {
                $aSummary['pushed']++;
            } else {
                $aSummary['failed']++;
                if ($this->checkAutoRemove($aLogItem['curl_response_code'])) {
                    $aSummary['removed']++;
                }
            }
        }
        return $aSummary;
    }

    /**
     * @return string last error
     */
    public function getError() : string
    {
        return $this->strError;
    }
    
    /**
     * Check if item should be removed.
     * We remove items with responsecode<br/>
     * -> 0: unknown responsecode (usually unknown/invalid endpoint origin)<br/>
     * -> -1: Payload encryption error<br/>
     * -> 400: Invalid request<br/>
     * -> 404: Not Found<br/>
     * -> 410: Gone<br/>
     * 
     * @param int $iRescode
     * @return bool
     */
    protected function checkAutoRemove(int $iRescode) : bool
    {
        $aRemove = $this->bAutoRemove ? [-1, 0, 400, 404, 410] : [];
        return in_array($iRescode, $aRemove);
    }
    
    /**
     * get text according to given push service responsecode
     *
     * push service response codes
     * 201:     The request to send a push message was received and accepted.
     * 400:     Invalid request. This generally means one of your headers is invalid or improperly formatted.
     * 404:     Not Found. This is an indication that the subscription is expired and can't be used. In this case
     *          you should delete the PushSubscription and wait for the client to resubscribe the user.
     * 410:     Gone. The subscription is no longer valid and should be removed from application server. This can
     *          be reproduced by calling `unsubscribe()` on a `PushSubscription`.
     * 413:     Payload size too large. The minimum size payload a push service must support is 4096 bytes (or 4kb).
     * 429:     Too many requests. Meaning your application server has reached a rate limit with a push service.
     *          The push service should include a 'Retry-After' header to indicate how long before another request
     *          can be made.
     * 
     * @param int $iRescode
     * @return string
     */
    protected function getPushServiceResponseText(int $iRescode) : string 
    {
        $strText = 'unknwown Rescode from push service: ' . $iRescode;
        $aText = array(
            201 => "The request to send a push message was received and accepted.",
            400 => "Invalid request. Invalid headers or improperly formatted.",
            404 => "Not Found. Subscription is expired and can't be used anymore.",
            410 => "Gone. Subscription is no longer valid.", // This can be reproduced by calling 'unsubscribe()' on a 'PushSubscription'.
            413 => "Payload size too large.",
            429 => "Too many requests. Your application server has reached a rate limit with a push service."
        );
        if (isset($aText[$iRescode])) {
            $strText = $aText[$iRescode];
        }
        return $strText;
    }
}