Page History

Данный модуль позволяет отправлять Push уведомления клиентам и администраторам через Web Push платформу.

Возможности модуля

Модуль предназначен для отправки Push уведомлений в мобильное приложение и браузерах. Отправка производится с помощью firebase cloud messaging. Клиент реализован на ServiceWorker, поэтому будет работать только на домене с валидным SSL (HTTPS) сертификатом. 
Для отправки в Chrome нужен ключ Google API Platform Key.( Брать в Google Cloud Console ).
Ключ нужно записать в libexec/config.pl $conf{GOOGLE_API_KEY}.
Пуши в Firefox работают без ключа.После записи ключа создать файл манифеста cgi-bin/manifest.json.. Пуши в Firefox работают без ключа.

Установка модуля

Чтобы Push ратали нужно прописать в config.pl

$conf{PUSH_ENABLED}=1;

Создание проекта firebase

Переходим по ссылке https://console.firebase.google.com/

Image Added

После создания переходим в настройки проекта

Image Added

После этого переходим в настройки Cloud Messaging, а также переходим в настройки API.

Image Added

После перехода в настройки API просто включаем протокол

Image Added

Переходим назад в настройки Cloud Messaging и копируем Server Key и прописываем в config.pl

$conf{FIREBASE_SERVER_KEY}="Ваш ключ";

Image Added

Настройка WebPush

Для настройки Web Push необходимо перейти в настройки Cloud Messaging и создать пару ключей для WebPush

Image Added

После создание копируем публичный ключ и прописасываем в config.pl

$conf{FIREBASE_VAPID_KEY}="Ваш public key";

Image Added

Создаем Web приложение

Image Added

Копируем firebaseConfig и вносим в конфигурации на биллинге

Image Added

В config.pl

$conf{FIREBASE_CONFIG} = {
  apiKey            => "Sample",
  authDomain        => "Sample",
  projectId         => "Sample",
  storageBucket     => "Sample",
  messagingSenderId => "Sample",
  appId             => "Sample",
  measurementId     => "Sample"
};

Копируем файл

cd /usr/abills/cgi-bin/
cp ../misc/gcmfirebase/manifest.json.default manifest.json

firebase-config.js firebase-config.js

Вставляем настройки созданного firebaseConfig

vim manifest.json

Создать таблицы, в которых хранятся клиенты и сообщения.

mysql -D abills < db/Push.sql

После этого можно включить скрипты Push переменной конфигурации $conf{PUSH_ENABLED}.

Администраторы подписываются на Push уведомления на странице «Профиль».

Image Removed

Пользователям предложит подписаться сразу при входе в кабинет.

Image Removed

var firebaseConfig = {
  apiKey: "Sample",
  authDomain: "Sample",
  projectId: "Sample",
  storageBucket: "Sample",
  messagingSenderId: "Sample",
  appId: "Sample",
  measurementId: "Sample"
};

Для разработчиков

Пример использования:

 # Подключаем модуль
  use Abills::Sender::Core;
  my $Sender = Abills::Sender::Core->new($db, $admin, \%conf, {
    SENDER_TYPE => 'Push'
  });

  # Отправляем сообщение
  my $request_sent = $Sender->send_message({
      UID     => 2,
      TITLE   => 'ABillS Push',
      MESSAGE => 'Hello, world sended via Push message'
    });
    
 # $request_sent == 1, если запрос к сервису Push завершился успешно. (но это не гарантирует доставку)

Детали реализации

Сама схема работы WebPush хорошо расписана в документации для разработчиков Google.

В данном случае есть ServiceWorker в браузере, который отвечает за подписку и уведомление сервера о своей подписке.

)

Когда нужно отправить уведомление, модуль Push получает контакт из таблицы и отправляет запрос на Push-уведомление сервису Push. Если запрос завершился удачно, сообщение сохраняется в таблицу push_messages с некоторым TTL (24 часа).

Когда клиент получает Push-уведомление от Push-сервиса, он используя сохранённый contact_id, получает с сервера ABillS сообщение для этого contact_id. После отправки сообщения клиенту, оно удаляется из таблицы.