Как отправлять веб-push-уведомления с помощью PHP

Web Push API позволяет отправлять push-уведомления в веб-браузеры и API. Хотя большая часть логики происходит в браузере, вам все равно нужен компонент на стороне сервера для генерации ваших уведомлений. Вот как реализовать серверную часть Web Push с помощью PHP.

Предпосылки

Для целей этого руководства мы предполагаем, что вы знакомы с основами создания HTTP API в PHP. Вам нужно будет открыть несколько общедоступных конечных точек, используя вашу веб-инфраструктуру. Они будут вызываться вашим JavaScript в браузере для регистрации и отмены регистрации устройств.

В этой статье не будет затрагиваться код на стороне браузера или то, как он работает. Вам потребуется собрать сервис-воркер, который будет реагировать на входящие push-события и отображать пользователю уведомление.

На высоком уровне поток Web Push выглядит так:

1. Принудительная подписка регистрируется в браузере. Браузер выдает уникальный URL-адрес конечной точки для вашего JavaScript.
2. Ваш JavaScript отправляет данные о подписке на ваш сервер и идентифицирует пользователя, к которому они относятся.
3. Когда серверной части необходимо отправить push-уведомление, создайте полезные данные и отправьте их на URL-адрес конечной точки, указанный в данных подписки.
4. Браузер пользователя получит полезную нагрузку через платформу доставки уведомлений поставщика. Ваш сервис-воркер JavaScript обрабатывает последующее событие и использует API уведомлений браузера, чтобы предупредить пользователя.

Вот как реализовать серверные аспекты шагов с 1 по 3.

Получение настройки

Мы будем использовать пакет Packagist web-push от minishlink. Это абстрагирует взаимодействие с каждой платформой уведомлений браузера, поэтому вам не нужно вручную различать типы конечных точек.

Добавьте пакет в свой проект с помощью Composer:

composer require minishlink/web-push

Чтобы использовать последнюю версию, вам нужен PHP 7.2 или выше с gmp, mbstring, curl и openssl. расширения. Если вы должны использовать более раннюю версию PHP, привяжите пакет к более ранней версии для обеспечения совместимости.

Библиотека предоставляет базовый класс WebPush с методами, позволяющими отправлять уведомления по отдельности или в виде пакетов. Подписки представлены экземплярами класса Subscription.

Предоставление ключей VAPID

Доверие к соответствующей стандартам экосистеме Web Push обеспечивается за счет использования ключей VAPID. Вашему серверу нужна пара ключей VAPID, чтобы он мог аутентифицировать себя в браузерах. Открытый ключ должен быть открыт через конечную точку API.

Вы можете сгенерировать набор ключей VAPID с помощью пакета web-push:

use MinishlinkWebPushVAPID;
 
$keyset = VAPID::createVapidKeys();
 
// public key - this needs to be accessible via an API endpoint
echo $keyset["publicKey"];
 
// private key - never expose this!
echo $keyset["privateKey"];
 
file_put_contents("vapid.json", json_encode($keyset));

use MinishlinkWebPushWebPush;
 
$webPush = new WebPush([
    "VAPID" => [
        "subject" => "https://example.com",
        "publicKey" => "VAPID_Public_Key_Here",
        "privateKey" => "VAPID_Private_Key_Here"
    ]
]);

use MinishlinkWebPushSubscription;
 
// Get user's push data...
// SELECT * FROM push_subscriptions WHERE user_id = 123456
 
$subscription = Subscription::create([
    "endpoint" => "https://fcm.google.com/...",
    "contentEncoding" => "aesgcm",
    "authToken" => "<auth token from JavaScript PushSubscription object>"
    "keys" => [
        "auth" => "<auth token from JavaScript PushSubscription object>",
        "p256dh" => "<p256dh token from JavaScript PushSubscription object>"
    ]
]);

$result = $webPush -> sendOneNotification(
    $subscription,
    json_encode([
        "message" => "Demo notification",
        "foo" => "bar"
    ])
);

if ($result -> isSuccess()) {
    // all good
}
else {
 
    // something went wrong
    error_log($result -> getReason());
 
    // provides raw HTTP response data
    error_log($result -> getResponse());
 
}

$webPush -> queueNotification($subscription, ["msg" => "first"]);
$webPush -> queueNotification($subscription, ["msg" => "second"]);
 
foreach ($webPush -> flush() as $i => $result) {
    echo ("Notification $i was " . ($result -> isSuccess() ? "sent" : "not sent"));
}

$webPush -> flush(100);     // send 100 messages

$webPush = new WebPush(["VAPID" => [...]], ["TTL" => 3600]);