Tiqr_Message_APNS2::send()

Complexity

Conditions	13
Paths	47

Size

Total Lines	117
Code Lines	73

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	182

Importance

Changes	6
Bugs	0	Features	0

<?php
    public function send()
    {
        $curl_options = array();
        $options = $this->getOptions();
        if (isset($options['apns.proxy_host_url'])) {
            // Override CURL options to connect to a HTTP/1.1 to HTTP/2 proxy
            $curl_options[CURLOPT_URL] = $options['apns.proxy_host_url'] . '/3/device/' . $this->getAddress();
            $curl_options[CURLOPT_PORT] = $options['apns.proxy_host_port'] ?? 443;
            // Use HTTP/1.1 instead of HTTP/2
            $curl_options[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_1_1;
            $this->logger->notice(sprintf('Using HTTP/1.1 CURL Proxy URL: "%s" and port "%s"',  $curl_options[CURLOPT_URL], $curl_options[CURLOPT_URL]));
        }
        else {
            $version_info = curl_version();
            if ($version_info['features'] & CURL_VERSION_HTTP2 == 0) {
                throw new RuntimeException('APNS2 requires HTTP/2 support in curl');
            }
        }

        // Get the UID from the client certificate we use for authentication, this
        // is set to the bundle ID.
        $options=$this->getOptions();
        $cert_filename = $options['apns.certificate'];
        if (strlen($cert_filename) == 0) {
            throw new RuntimeException('apns.certificate option not set');
        }
        $cert_file_contents = file_get_contents($cert_filename);
        if (false === $cert_file_contents) {
            throw new RuntimeException(
                sprintf('Error reading APNS client certificate file: "%s"', $cert_filename)
            );
        }

        $cert=openssl_x509_parse( $cert_file_contents );
        if (false === $cert) {
            // Log openssl error information
            while ($msg = openssl_error_string()) {
                $this->logger->error('openssl_x509_parse(): ' . $msg);
            }
            throw new RuntimeException('Error parsing APNS client certificate');
        }
        $bundle_id = $cert['subject']['UID'] ?? NULL;
        if (NULL === $bundle_id) {
            throw new RuntimeException('No uid found in the certificate subject');
        }
        $this->logger->info(sprintf('Setting bundle_id to "%s" based on UID from certificate', $bundle_id));
        $this->logger->info(
            sprintf('Authenticating using certificate with subject "%s" valid until "%s"',
                $cert['name'],
                date(DATE_RFC2822, $cert['validTo_time_t'])
            )
        );

        $authProviderOptions = [
            'app_bundle_id' => $bundle_id, // The bundle ID for app obtained from Apple developer account
            'certificate_path' => $cert_filename,
            'certificate_secret' => null // Private key secret
        ];

        $authProvider = AuthProvider\Certificate::create($authProviderOptions);

        // Create the push message
        $alert=Alert::create();
        $alert->setBody($this->getText());
        // Note: It is possible to specify a title and a subtitle: $alert->setTitle() && $alert->setSubtitle()
        //       The tiqr service currently does not implement this.
        $payload=Payload::create()->setAlert($alert);
        $payload->setSound('default');
        foreach ($this->getCustomProperties() as $name => $value) {
            $payload->setCustomValue($name, $value);
        }
        // set "mutable-content": 1 in the notification. This will call the Tiqr app when the notification arrives so
        // that the app can read it (and also modify it). This allows the app to be notified of the arrival of the notification
        // without the user interacting with it.
        $payload->setMutableContent(true);

        $this->logger->debug(sprintf('JSON Payload: %s', $payload->toJson()));
        $notification=new Notification($payload, $this->getAddress());
        // Set expiration to 30 seconds from now, same as Message_APNS
        $now = new DateTime();
        $expirationInstant=$now->add(new DateInterval('PT30S'));
        $notification->setExpirationAt($expirationInstant);

        // Send the push message
        $client = new Client($authProvider, $options['apns.environment'] == 'production', $curl_options);
        $client->addNotification($notification);
        $responses=$client->push();
        if ( sizeof($responses) != 1) {
            $this->logger->warning(sprintf('Unexpected number responses. Expected 1, got %d', sizeof($responses)) );
            if (sizeof($responses) == 0) {
                $this->logger->warning('Could not determine whether the notification was sent');
                return;
            }
        }
        /** @var \Pushok\Response $response */
        $response = reset($responses);  // Get first response from the array
        $deviceToken=$response->getDeviceToken() ?? '';
        // A canonical UUID that is the unique ID for the notification. E.g. 123e4567-e89b-12d3-a456-4266554400a0
        $apnsId=$response->getApnsId() ?? '';
        // Status code. E.g. 200 (Success), 410 (The device token is no longer active for the topic.)
        $statusCode=$response->getStatusCode();
        $this->logger->info(sprintf('Got response with ApnsId "%s", status %s for deviceToken "%s"', $apnsId, $statusCode, $deviceToken));
        if ( strcasecmp($deviceToken, $this->getAddress()) ) {
        $this->logger->warning(sprintf('Unexpected deviceToken in response. Expected: "%s"; got: "%s"', $this->getAddress(), $deviceToken));
        }
        if ($statusCode == 200) {
            $this->logger->notice(sprintf('Successfully sent APNS2 push notification. APNS ID: "%s"; deviceToken: "%s"', $apnsId, $deviceToken));
            return;
        }

        $reasonPhrase=$response->getReasonPhrase(); // E.g. The device token is no longer active for the topic.
        $errorReason=$response->getErrorReason(); // E.g. Unregistered
        $errorDescription=$response->getErrorDescription(); // E.g. The device token is inactive for the specified topic.

        $this->logger->error(sprintf('Error sending APNS2 push notification. APNS ID: "%s"; deviceToken: "%s"; Error: "%s" "%s" "%s"', $apnsId, $deviceToken, $reasonPhrase, $errorReason, $errorDescription));
        throw new RuntimeException(
            sprintf('Error sending APNS2 push notification. Status: %s. Error: "%s" "%s" "%s"', $statusCode, $reasonPhrase, $errorReason, $errorDescription)
        );