jazzband/django-push-notifications

django-push-notifications

.. image:: https://jazzband.co/static/img/badge.svg :target: https://jazzband.co/ :alt: Jazzband

.. image:: https://github.com/jazzband/django-push-notifications/workflows/Test/badge.svg :target: https://github.com/jazzband/django-push-notifications/actions :alt: GitHub Actions

.. image:: https://codecov.io/gh/jazzband/django-push-notifications/branch/master/graph/badge.svg?token=PcC594rhI4 :target: https://codecov.io/gh/jazzband/django-push-notifications :alt: Code coverage

A minimal Django app that implements Device models that can send messages through APNS, FCM/GCM, WNS and WebPush.

The app implements four models: GCMDevice, APNSDevice, WNSDevice and WebPushDevice. Those models share the same attributes:

• name (optional): A name for the device.
• active (default True): A boolean that determines whether the device will be sent notifications.
• user (optional): A foreign key to auth.User, if you wish to link the device to a specific user.
• device_id (optional): A UUID for the device obtained from Android/iOS/Windows APIs, if you wish to uniquely identify it.
• registration_id (required): The FCM/GCM registration id or the APNS token for the device.

The app also implements an admin panel, through which you can test single and bulk notifications. Select one or more FCM/GCM, APNS, WNS or WebPush devices and in the action dropdown, select "Send test message" or "Send test message in bulk", accordingly. Note that sending a non-bulk test message to more than one device will just iterate over the devices and send multiple single messages. UPDATE_ON_DUPLICATE_REG_ID: Transform create of an existing Device (based on registration id) into a update. See below Update of device with duplicate registration ID for more details.

Dependencies

• Python 3.7+
• Django 2.2+
• For the API module, Django REST Framework 3.7+ is required.
• For WebPush (WP), pywebpush 1.3.0+ is required (optional). py-vapid 1.3.0+ is required for generating the WebPush private key; however this step does not need to occur on the application server.
• For Apple Push (APNS), apns2 0.3+ is required (optional).
• For Apple Push (apns-async) using async, aioapns 3.1+ is required (optional). Installed aioapns overrides apns2 which does not support python 3.10+.
• For FCM, firebase-admin 6.2+ is required (optional).

Setup

You can install the library directly from pypi using pip:

.. code-block:: shell

$ pip install django-push-notifications[WP,apns-async,FCM]

Edit your settings.py file:

.. code-block:: python

INSTALLED_APPS = (
	...
	"push_notifications"
)

# Import the firebase service
from firebase_admin import auth

# Initialize the default app (either use `GOOGLE_APPLICATION_CREDENTIALS` environment variable, or pass a firebase_admin.credentials.Certificate instance)
# You can also pass options. One of them is httpTimeout: This sets the timeout (in seconds) for outgoing HTTP connections initiated by the SDK.
default_app = firebase_admin.initialize_app()

PUSH_NOTIFICATIONS_SETTINGS = {
	"APNS_CERTIFICATE": "/path/to/your/certificate.pem",
	"APNS_TOPIC": "com.example.push_test",
	"WNS_PACKAGE_SECURITY_ID": "[your package security id, e.g: 'ms-app://e-3-4-6234...']",
	"WNS_SECRET_KEY": "[your app secret key, e.g.: 'KDiejnLKDUWodsjmewuSZkk']",
	"WP_PRIVATE_KEY": "/path/to/your/private.pem",
	"WP_CLAIMS": {'sub': "mailto:[email protected]"}
}

.. note:: To migrate from legacy FCM APIs to HTTP v1, see docs/FCM <https://github.com/jazzband/django-push-notifications/blob/master/docs/FCM.rst>_.

.. note:: If you need to support multiple mobile applications from a single Django application, see Multiple Application Support <https://github.com/jazzband/django-push-notifications/wiki/Multiple-Application-Support>_ for details.

.. note:: If you are planning on running your project with APNS_USE_SANDBOX=True, then make sure you have set the development certificate as your APNS_CERTIFICATE. Otherwise the app will not be able to connect to the correct host. See settings_ for details.

For more information about how to generate certificates, see docs/APNS <https://github.com/jazzband/django-push-notifications/blob/master/docs/APNS.rst>_.

You can learn more about APNS certificates here <https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/APNSOverview.html>_.

Native Django migrations are in use. manage.py migrate will install and migrate all models.

.. _settings:

Settings list

All settings are contained in a PUSH_NOTIFICATIONS_SETTINGS dict.

For APNS, you are required to include APNS_CERTIFICATE. For WNS, you need both the WNS_PACKAGE_SECURITY_KEY and the WNS_SECRET_KEY.

General settings

• USER_MODEL: Your user model of choice. Eg. myapp.User. Defaults to settings.AUTH_USER_MODEL.
• UPDATE_ON_DUPLICATE_REG_ID: Transform create of an existing Device (based on registration id) into a update. See below Update of device with duplicate registration ID_ for more details.
• UNIQUE_REG_ID: Forces the registration_id field on all device models to be unique. NOTE: There is a current MYSQL bug that prevents the use of this setting. See: https://code.djangoproject.com/ticket/2495 and https://docs.djangoproject.com/en/2.2/ref/databases/#textfield-limitations

APNS settings

• APNS_CERTIFICATE: Absolute path to your APNS certificate file. Certificates with passphrases are not supported. If iOS application was build with "Release" flag, you need to use production certificate, otherwise debug. Read more about Generation of an APNS PEM file <https://github.com/jazzband/django-push-notifications/blob/master/docs/APNS.rst>_.
• APNS_AUTH_KEY_PATH: Absolute path to your APNS signing key file for Token-Based Authentication <https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/establishing_a_token-based_connection_to_apns>_ . Use this instead of APNS_CERTIFICATE if you are using .p8 signing key certificate.
• APNS_AUTH_KEY_ID: The 10-character Key ID you obtained from your Apple developer account
• APNS_TEAM_ID: 10-character Team ID you use for developing your company’s apps for iOS.
• APNS_TOPIC: The topic of the remote notification, which is typically the bundle ID for your app. If you omit this header and your APNs certificate does not specify multiple topics, the APNs server uses the certificate’s Subject as the default topic.
• APNS_USE_ALTERNATIVE_PORT: Use port 2197 for APNS, instead of default port 443.
• APNS_USE_SANDBOX: Use 'api.development.push.apple.com', instead of default host 'api.push.apple.com'. Default value depends on DEBUG setting of your environment: if DEBUG is True and you use production certificate, you should explicitly set APNS_USE_SANDBOX to False.

FCM/GCM settings

• FIREBASE_APP: Firebase app instance that is used to send the push notification. If not provided, the app will be using the default app instance that you've instantiated with firebase_admin.initialize_app().
• FCM_MAX_RECIPIENTS: The maximum amount of recipients that can be contained per bulk message. If the registration_ids list is larger than that number, multiple bulk messages will be sent. Defaults to 1000 (the maximum amount supported by FCM).

WNS settings

• WNS_PACKAGE_SECURITY_KEY: TODO
• WNS_SECRET_KEY: TODO

WP settings

• WP_PRIVATE_KEY: Absolute path to your private certificate file: os.path.join(BASE_DIR, "private_key.pem")
• WP_CLAIMS: Dictionary with default value for the sub, (subject), sent to the webpush service, This would be used by the service if they needed to reach out to you (the sender). Could be a url or mailto e.g. {'sub': "mailto:[email protected]"}.
• WP_ERROR_TIMEOUT: The timeout on WebPush POSTs. (Optional, default value is 1 second)

For more information about how to configure WebPush, see docs/WebPush <https://github.com/jazzband/django-push-notifications/blob/master/docs/WebPush.rst>_.

Sending messages

FCM/GCM and APNS services have slightly different semantics. The app tries to offer a common interface for both when using the models.

.. code-block:: python

from push_notifications.models import APNSDevice, GCMDevice

device = GCMDevice.objects.get(registration_id=gcm_reg_id)
# The first argument will be sent as "message" to the intent extras Bundle
# Retrieve it with intent.getExtras().getString("message")
device.send_message("You've got mail")
# If you want to customize, send an extra dict and a None message.
# the extras dict will be mapped into the intent extras Bundle.
# For dicts where all values are keys this will be sent as url parameters,
# but for more complex nested collections the extras dict will be sent via
# the bulk message api.
device.send_message(None, extra={"foo": "bar"})
device.send_message(None, extra={"foo": "bar"}, use_fcm_notifications=False) # Silent message with custom data.

You may also pass a Firebase message object.

device.send_message(messaging.Message(
	notification=messaging.Notification(
		title='Hello World',
		body='What a beautiful day.'
	),
))
# If you want to use gcm.send_message directly, you will have to use messaging.Message.

device = APNSDevice.objects.get(registration_id=apns_token)
device.send_message("You've got mail") # Alert message may only be sent as text.
device.send_message(None, badge=5) # No alerts but with badge.
device.send_message(None, content_available=1, extra={"foo": "bar"}) # Silent message with custom data.
# alert with title and body.
device.send_message(message={"title" : "Game Request", "body" : "Bob wants to play poker"}, extra={"foo": "bar"})
device.send_message("Hello again", thread_id="123", extra={"foo": "bar"}) # set thread-id to allow iOS to merge notifications

.. note:: APNS does not support sending payloads that exceed 2048 bytes (increased from 256 in 2014). The message is only one part of the payload, if once constructed the payload exceeds the maximum size, an APNSError exception will be raised before anything is sent. Reference: Apple Payload Documentation <https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CreatingtheNotificationPayload.html#//apple_ref/doc/uid/TP40008194-CH10-SW1>_

Web Push accepts only one variable (message), which is passed directly to pywebpush. This message can be a simple string, which will be used as your notification's body, or it can be contain any data supported by pywebpush<https://github.com/web-push-libs/pywebpush>.

Simple example:

.. code-block:: python

from push_notifications.models import WebPushDevice

device = WebPushDevice.objects.get(registration_id=wp_reg_id)

device.send_message("You've got mail")

.. note:: To customize the notification title using this method, edit the "TITLE DEFAULT" string in your navigatorPush.service.js file.

JSON example:

.. code-block:: python

import json
from push_notifications.models import WebPushDevice

device = WebPushDevice.objects.get(registration_id=wp_reg_id)

title = "Message Received"
message = "You've got mail"
data = json.dumps({"title": title, "message": message})

device.send_message(data)

Web Push accepts only one variable (message), which is passed directly to pywebpush. This message can be a simple string, which will be used as your notification's body, or it can be contain any data supported by pywebpush<https://github.com/web-push-libs/pywebpush>.

Simple example:

.. code-block:: python

from push_notifications.models import WebPushDevice

device = WebPushDevice.objects.get(registration_id=wp_reg_id)

device.send_message("You've got mail")

.. note:: To customize the notification title using this method, edit the "TITLE DEFAULT" string in your navigatorPush.service.js file.

JSON example:

.. code-block:: python

import json
from push_notifications.models import WebPushDevice

device = WebPushDevice.objects.get(registration_id=wp_reg_id)

title = "Message Received"
message = "You've got mail"
data = json.dumps({"title": title, "message": message})

device.send_message(data)

Sending messages in bulk

.. code-block:: python

from push_notifications.models import APNSDevice, GCMDevice

devices = GCMDevice.objects.filter(user__first_name="James")
devices.send_message("Happy name day!")

Sending messages in bulk makes use of the bulk mechanics offered by GCM and APNS. It is almost always preferable to send bulk notifications instead of single ones.

It's also possible to pass badge parameter as a function which accepts token parameter in order to set different badge value per user. Assuming User model has a method get_badge returning badge count for a user:

.. code-block:: python

devices.send_message(
	"Happy name day!",
	badge=lambda token: APNSDevice.objects.get(registration_id=token).user.get_badge()
)

Firebase

django-push-notifications supports Firebase Cloud Messaging v1.

When using FCM, django-push-notifications will automatically use the notification and data messages format <https://firebase.google.com/docs/cloud-messaging/concept-options#notifications_and_data_messages>_ to be conveniently handled by Firebase devices. You may want to check the payload to see if it matches your needs, and review your notification statuses in FCM Diagnostic console <https://support.google.com/googleplay/android-developer/answer/2663268?hl=en>_.

.. code-block:: python

# Create a FCM device
fcm_device = GCMDevice.objects.create(registration_id="token", user=the_user)

# Send a notification message
fcm_device.send_message("This is a message")

# Send a notification message with additional payload
fcm_device.send_message("This is a enriched message", extra={"title": "Notification title", "icon": "icon_ressource"})

# Send a notification message with additionnal payload (alternative syntax)
fcm_device.send_message("This is a enriched message", title="Notification title", badge=6)

# Send a silent notification message with badge - *only working with iOS*:
fcm_device.send_message(
	messaging.Message(
		apns=messaging.APNSConfig(
			payload=messaging.APNSPayload(aps=messaging.Aps(badge=5))
		)
	)
)

# Send a notification with badge for iOS and android:
fcm_device.send_message(
	messaging.Message(
		notification=messaging.Notification(title="otification title", body="This is a enriched message"),
		apns=messaging.APNSConfig(payload=messaging.APNSPayload(aps=messaging.Aps(badge=6))), # ios
	),
	badge=6, # android
)

# Send a notification message with extra data
fcm_device.send_message("This is a message with data", extra={"other": "content", "misc": "data"})

# Send a notification message with options
fcm_device.send_message("This is a message", time_to_live=3600)

# Send a data message only
fcm_device.send_message(None, extra={"other": "content", "misc": "data"})

Behind the scenes, a Firebase Message <https://firebase.google.com/docs/reference/admin/dotnet/class/firebase-admin/messaging/message>_ will be created. You can also create this yourself and pass it to the send_message method instead.

Sending FCM/GCM messages to topic members

FCM/GCM topic messaging allows your app server to send a message to multiple devices that have opted in to a particular topic. Based on the publish/subscribe model, topic messaging supports unlimited subscriptions per app. Developers can choose any topic name that matches the regular expression, "/topics/[a-zA-Z0-9-_.~%]+". Note: gcm_send_bulk_message must be used when sending messages to topic subscribers, and setting the first param to any value other than None will result in a 400 Http error.

.. code-block:: python

from push_notifications.gcm import send_message, dict_to_fcm_message

# Create message object from dictonary. You can also directly create a messaging.Message object.
message = dict_to_fcm_message({"body": "Hello members of my_topic!"})
# First param is "None" because no Registration_id is needed, the message will be sent to all devices subscribed to the topic.
send_message(None, message, to="/topics/my_topic")

Reference: FCM Documentation <https://firebase.google.com/docs/cloud-messaging/android/topic-messaging>_

Exceptions

• NotificationError(Exception): Base exception for all notification-related errors.
• apns.APNSError(NotificationError): Something went wrong upon sending APNS notifications.

Django REST Framework (DRF) support

ViewSets are available for both APNS and GCM devices in two permission flavors:

• APNSDeviceViewSet and GCMDeviceViewSet

  • Permissions as specified in settings (AllowAny by default, which is not recommended)
  • A device may be registered without associating it with a user

• APNSDeviceAuthorizedViewSet and GCMDeviceAuthorizedViewSet

  • Permissions are IsAuthenticated and custom permission IsOwner, which will only allow the request.user to get and update devices that belong to that user
  • Requires a user to be authenticated, so all devices will be associated with a user

When creating an APNSDevice, the registration_id is validated to be a 64-character or 200-character hexadecimal string. Since 2016, device tokens are to be increased from 32 bytes to 100 bytes.

Routes can be added one of two ways:

• Routers_ (include all views)

.. _Routers: http://www.django-rest-framework.org/tutorial/6-viewsets-and-routers#using-routers

::

from push_notifications.api.rest_framework import APNSDeviceAuthorizedViewSet, GCMDeviceAuthorizedViewSet
from rest_framework.routers import DefaultRouter

router = DefaultRouter()
router.register(r'device/apns', APNSDeviceAuthorizedViewSet)
router.register(r'device/gcm', GCMDeviceAuthorizedViewSet)

urlpatterns = patterns('',
	# URLs will show up at <api_root>/device/apns
	url(r'^', include(router.urls)),
	# ...
)

• Using as_view_ (specify which views to include)

.. _as_view: http://www.django-rest-framework.org/tutorial/6-viewsets-and-routers#binding-viewsets-to-urls-explicitly

::

from push_notifications.api.rest_framework import APNSDeviceAuthorizedViewSet

urlpatterns = patterns('',
	# Only allow creation of devices by authenticated users
	url(r'^device/apns/?$', APNSDeviceAuthorizedViewSet.as_view({'post': 'create'}), name='create_apns_device'),
	# ...
)

Update of device with duplicate registration ID

The DRF viewset enforces the uniqueness of the registration ID. In some use cases it may cause issues: If an already registered mobile device application changes its user and attempts to re-register, it will fail to register because the registration ID already exists.

When option UPDATE_ON_DUPLICATE_REG_ID is set to True, then any creation of device with an already existing registration ID will be transformed into an update.

The UPDATE_ON_DUPLICATE_REG_ID only works with DRF.

.. [1] Any devices which are not selected, but are not receiving notifications will not be deactivated on a subsequent call to "prune devices" unless another attempt to send a message to the device fails after the call to the feedback service.