Skip to content

Save auth token #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Save auth token #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33b7499
Add example with payload data
nutella Jun 25, 2024
3bfbccd
Modified to store access token and reuse until expire
nutella Jun 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 32 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ php-fcm-v1 is an PHP implementation of [FCM](https://firebase.google.com/docs/cl
### What is different compared to others FCM Libraries?
Most of other libraries are implementation of FCM's [Legacy HTTP Server Protocol](https://firebase.google.com/docs/cloud-messaging/http-server-ref). It requires a server key from Firebase console (which means you have to copy and paste in your code) ([Docs](https://firebase.google.com/docs/cloud-messaging/auth-server#authorize_legacy_protocol_send_requests))

HTTP v1 API, in contrast, leverages OAuth2 security model. You need to get an access token (which is valid for about an hour) in order to request sending notification with service account's private key file. Although
HTTP v1 API, in contrast, leverages OAuth2 security model. You need to get an access token (which is valid for about an hour) in order to request sending notification with service account's private key file. Although
(See the blog [post](https://firebase.googleblog.com/2017/11/whats-new-with-fcm-customizing-messages.html) about HTTP v1 API)

### References
* [google/node-gtoken](https://github.com/google/node-gtoken)
* [google/google-auth-library-nodejs](https://github.com/google/google-auth-library-nodejs)
* [google/google-auth-library-nodejs](https://github.com/google/google-auth-library-nodejs)
: Above two libraries let me understand how HTTP v1 API works in FCM
* [guzzlehttp/guzzle](https://github.com/guzzle/guzzle) : GuzzleHttp let this library to PSR7 compatible
* [Paragraph1/php-fcm](https://github.com/Paragraph1/php-fcm) : Inspired me how FCM libraries are used in Legacy HTTP Protocol
Expand Down Expand Up @@ -94,6 +94,35 @@ HTTP v1 API, in contrast, leverages OAuth2 security model. You need to get an ac
$client -> fire();
```

* Example with payload data

```php
<?php
require_once __DIR__ . '/vendor/autoload.php';

use phpFCMv1\Client;
use phpFCMv1\Notification;
use phpFCMv1\Recipient;
use phpFCMv1\Data;

$client = new Client('service_account.json');
$recipient = new Recipient();
$notification = new Notification();
$payload = new Data();

// extra payload must be contained in a "data" element
$foo['link'] = 'https://www.github.com';
$foo['id'] = '42';
$bar['data'] = $foo;

$payload->setPayload($bar);

$recipient -> setSingleRecipient('DEVICE_TOKEN');
$notification -> setNotification('NOTIFICATION_TITILE', 'NOTIFICATION_BODY');
$client -> build($recipient, $notification, $payload);
$client -> fire();
```

* Using with *PRIOIRTY* option (for both Android & iOS)

```php
Expand Down Expand Up @@ -125,7 +154,7 @@ HTTP v1 API, in contrast, leverages OAuth2 security model. You need to get an ac
$androidConfig = new Config\AndroidConfig();
$androidConfig -> setPriority(Config\AndroidConfig::PRIORITY_HIGH);
$client -> build($recipient, $notification, null, $androidConfig);

// Option Instance for iOS (which is APNs header)
// Use phpFCMv1\APNsCOnfig Class
$apnsConfig = new APNsConfig();
Expand Down
22 changes: 15 additions & 7 deletions src/Credentials.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ class Credentials {
private $keyFilePath;
private $DATA_TYPE;

// Added to save access_token and use it until expire
private $access_token = '';
private $expire = 0;

/**
* Credentials constructor. Checks whether given path is a valid file.
* @param string $keyFile
Expand All @@ -46,14 +50,18 @@ public function getAccessToken() {
'grant_type' => self::GRANT_TYPE,
'assertion' => $this -> getTokenPayload()
);

$result = $this -> getToken($requestBody);

if (isset($result['error'])) {
throw new \RuntimeException($result['error_description']);
if ( strlen( $this->access_token ) == 0 || ( $this->expire <= time() ) ) {
$result = $this -> getToken($requestBody);
if (isset($result['error'])) {
$this->access_token = '';
$this->expire = 0;
throw new \RuntimeException($result['error_description']);
} else {
$this->access_token = $result['access_token'];
$this->expire = time() + $result['expires_in'];
}
}

return $result['access_token'];
return $this->access_token;
}

/**
Expand Down