Skip to content

Commit d655102

Browse files
aarushtoolsaarushtools
committed
feat: add push notifications
1 parent 1888e89 commit d655102

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+2702
-176
lines changed

‎.gitignore

+7
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,10 @@ package-lock.json
5656
# Virtual environments
5757
venv/
5858
.venv/
59+
60+
# Webpush
61+
/keys/webpush/
62+
/keys/
63+
64+
# Keys
65+
*.pem

‎config/docker/initial_setup.sh

+3
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,6 @@ python3 -u manage.py import_sports $(date +%m)
4949

5050
echo -e "${BLUE}${BOLD}Creating CSL apps...${CLEAR}"
5151
python3 -u manage.py dev_create_cslapps
52+
53+
echo -e "${BLUE}${BOLD}Generating vapid keys...${CLEAR}"
54+
python3 create_vapid_keys.py

‎config/scripts/create_vapid_keys.py

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
import base64
2+
import os
3+
4+
from cryptography.hazmat.primitives.serialization import Encoding, PublicFormat
5+
from py_vapid import Vapid
6+
7+
PROJECT_ROOT = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
8+
os.makedirs(os.path.join(PROJECT_ROOT, "keys", "webpush"))
9+
10+
# Generate VAPID key pair
11+
vapid = Vapid()
12+
vapid.generate_keys()
13+
14+
# Get public and private keys for the vapid key pair
15+
vapid.save_public_key(os.path.join(PROJECT_ROOT, "keys", "webpush", "public_key.pem"))
16+
public_key_bytes = vapid.public_key.public_bytes(Encoding.X962, PublicFormat.UncompressedPoint)
17+
18+
vapid.save_key(os.path.join(PROJECT_ROOT, "keys", "webpush", "private_key.pem"))
19+
20+
21+
# Convert the public key to applicationServerKey format
22+
application_server_key = base64.urlsafe_b64encode(public_key_bytes).replace(b"=", b"").decode("utf8")
23+
24+
with open(os.path.join(PROJECT_ROOT, "keys", "webpush", "ApplicationServerKey.key"), "w", encoding="utf-8") as f:
25+
f.write(application_server_key)

‎cron/eighth-absence.sh

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@
44
timestamp=$(date +"%Y-%m-%d-%H%M")
55
cd /usr/local/www/intranet3
66
./cron/env.sh ./manage.py absence_email --silent
7-
echo "Absence email sent at $timestamp." >> /var/log/ion/email.log
7+
./cron/env.sh ./manage.py absence_notify --silent
8+
echo "Absence email and push notification sent at $timestamp." >> /var/log/ion/email.log

‎docs/sourcedoc/intranet.apps.announcements.rst

+96
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,102 @@ intranet.apps.announcements.views module
7676
:undoc-members:
7777
:show-inheritance:
7878

79+
intranet.apps.announcements.views\_BACKUP\_1087 module
80+
------------------------------------------------------
81+
82+
.. automodule:: intranet.apps.announcements.views_BACKUP_1087
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
87+
intranet.apps.announcements.views\_BACKUP\_1114 module
88+
------------------------------------------------------
89+
90+
.. automodule:: intranet.apps.announcements.views_BACKUP_1114
91+
:members:
92+
:undoc-members:
93+
:show-inheritance:
94+
95+
intranet.apps.announcements.views\_BACKUP\_1972 module
96+
------------------------------------------------------
97+
98+
.. automodule:: intranet.apps.announcements.views_BACKUP_1972
99+
:members:
100+
:undoc-members:
101+
:show-inheritance:
102+
103+
intranet.apps.announcements.views\_BASE\_1087 module
104+
----------------------------------------------------
105+
106+
.. automodule:: intranet.apps.announcements.views_BASE_1087
107+
:members:
108+
:undoc-members:
109+
:show-inheritance:
110+
111+
intranet.apps.announcements.views\_BASE\_1114 module
112+
----------------------------------------------------
113+
114+
.. automodule:: intranet.apps.announcements.views_BASE_1114
115+
:members:
116+
:undoc-members:
117+
:show-inheritance:
118+
119+
intranet.apps.announcements.views\_BASE\_1972 module
120+
----------------------------------------------------
121+
122+
.. automodule:: intranet.apps.announcements.views_BASE_1972
123+
:members:
124+
:undoc-members:
125+
:show-inheritance:
126+
127+
intranet.apps.announcements.views\_LOCAL\_1087 module
128+
-----------------------------------------------------
129+
130+
.. automodule:: intranet.apps.announcements.views_LOCAL_1087
131+
:members:
132+
:undoc-members:
133+
:show-inheritance:
134+
135+
intranet.apps.announcements.views\_LOCAL\_1114 module
136+
-----------------------------------------------------
137+
138+
.. automodule:: intranet.apps.announcements.views_LOCAL_1114
139+
:members:
140+
:undoc-members:
141+
:show-inheritance:
142+
143+
intranet.apps.announcements.views\_LOCAL\_1972 module
144+
-----------------------------------------------------
145+
146+
.. automodule:: intranet.apps.announcements.views_LOCAL_1972
147+
:members:
148+
:undoc-members:
149+
:show-inheritance:
150+
151+
intranet.apps.announcements.views\_REMOTE\_1087 module
152+
------------------------------------------------------
153+
154+
.. automodule:: intranet.apps.announcements.views_REMOTE_1087
155+
:members:
156+
:undoc-members:
157+
:show-inheritance:
158+
159+
intranet.apps.announcements.views\_REMOTE\_1114 module
160+
------------------------------------------------------
161+
162+
.. automodule:: intranet.apps.announcements.views_REMOTE_1114
163+
:members:
164+
:undoc-members:
165+
:show-inheritance:
166+
167+
intranet.apps.announcements.views\_REMOTE\_1972 module
168+
------------------------------------------------------
169+
170+
.. automodule:: intranet.apps.announcements.views_REMOTE_1972
171+
:members:
172+
:undoc-members:
173+
:show-inheritance:
174+
79175
Module contents
80176
---------------
81177

‎docs/sourcedoc/intranet.apps.bus.rst

+8
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,14 @@ intranet.apps.bus.urls module
7676
:undoc-members:
7777
:show-inheritance:
7878

79+
intranet.apps.bus.utils module
80+
------------------------------
81+
82+
.. automodule:: intranet.apps.bus.utils
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
7987
intranet.apps.bus.views module
8088
------------------------------
8189

‎docs/sourcedoc/intranet.apps.eighth.management.commands.rst

+8
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ intranet.apps.eighth.management.commands.absence\_email module
1212
:undoc-members:
1313
:show-inheritance:
1414

15+
intranet.apps.eighth.management.commands.absence\_notify module
16+
---------------------------------------------------------------
17+
18+
.. automodule:: intranet.apps.eighth.management.commands.absence_notify
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
1523
intranet.apps.eighth.management.commands.delete\_duplicate\_signups module
1624
--------------------------------------------------------------------------
1725

‎docs/sourcedoc/intranet.apps.notifications.rst

+48
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@ intranet.apps.notifications package
44
Submodules
55
----------
66

7+
intranet.apps.notifications.admin module
8+
----------------------------------------
9+
10+
.. automodule:: intranet.apps.notifications.admin
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
intranet.apps.notifications.api module
16+
--------------------------------------
17+
18+
.. automodule:: intranet.apps.notifications.api
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
723
intranet.apps.notifications.emails module
824
-----------------------------------------
925

@@ -12,6 +28,14 @@ intranet.apps.notifications.emails module
1228
:undoc-members:
1329
:show-inheritance:
1430

31+
intranet.apps.notifications.forms module
32+
----------------------------------------
33+
34+
.. automodule:: intranet.apps.notifications.forms
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
1539
intranet.apps.notifications.models module
1640
-----------------------------------------
1741

@@ -20,6 +44,14 @@ intranet.apps.notifications.models module
2044
:undoc-members:
2145
:show-inheritance:
2246

47+
intranet.apps.notifications.serializers module
48+
----------------------------------------------
49+
50+
.. automodule:: intranet.apps.notifications.serializers
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
2355
intranet.apps.notifications.tasks module
2456
----------------------------------------
2557

@@ -28,6 +60,14 @@ intranet.apps.notifications.tasks module
2860
:undoc-members:
2961
:show-inheritance:
3062

63+
intranet.apps.notifications.tests module
64+
----------------------------------------
65+
66+
.. automodule:: intranet.apps.notifications.tests
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
3171
intranet.apps.notifications.urls module
3272
---------------------------------------
3373

@@ -36,6 +76,14 @@ intranet.apps.notifications.urls module
3676
:undoc-members:
3777
:show-inheritance:
3878

79+
intranet.apps.notifications.utils module
80+
----------------------------------------
81+
82+
.. automodule:: intranet.apps.notifications.utils
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
3987
intranet.apps.notifications.views module
4088
----------------------------------------
4189

‎docs/sourcedoc/intranet.apps.polls.rst

+8
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ intranet.apps.polls.models module
2828
:undoc-members:
2929
:show-inheritance:
3030

31+
intranet.apps.polls.notifications module
32+
----------------------------------------
33+
34+
.. automodule:: intranet.apps.polls.notifications
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
3139
intranet.apps.polls.tests module
3240
--------------------------------
3341

‎intranet/apps/announcements/forms.py

+18-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,12 @@ def __init__(self, *args, **kwargs):
1212
super().__init__(*args, **kwargs)
1313
self.fields["expiration_date"].help_text = "By default, announcements expire after two weeks. To change this, click in the box above."
1414

15-
self.fields["notify_post"].help_text = "If this box is checked, students who have signed up for notifications will receive an email."
15+
self.fields["notify_post"].help_text = (
16+
"If this box is checked, students who have signed up for email "
17+
"notifications will receive an email "
18+
"and those who have signed up for push notifications will receive a "
19+
"push notification."
20+
)
1621

1722
self.fields["notify_email_all"].help_text = (
1823
"This will send an email notification to all of the users who can see this post. This option "
@@ -41,7 +46,12 @@ def __init__(self, *args, **kwargs):
4146
super().__init__(*args, **kwargs)
4247
self.fields["expiration_date"].help_text = "By default, announcements expire after two weeks. To change this, click in the box above."
4348

44-
self.fields["notify_post_resend"].help_text = "If this box is checked, students who have signed up for notifications will receive an email."
49+
self.fields["notify_post_resend"].help_text = (
50+
"If this box is checked, students who have signed up for email "
51+
"notifications will receive an email "
52+
"and those who have signed up for push notifications will "
53+
"receive a push notification."
54+
)
4555

4656
self.fields["notify_email_all_resend"].help_text = (
4757
"This will resend an email notification to all of the users who can see this post. This option "
@@ -105,7 +115,12 @@ class AnnouncementAdminForm(forms.Form):
105115

106116
def __init__(self, *args, **kwargs):
107117
super().__init__(*args, **kwargs)
108-
self.fields["notify_post"].help_text = "If this box is checked, students who have signed up for notifications will receive an email."
118+
self.fields["notify_post"].help_text = (
119+
"If this box is checked, students who have signed up for email "
120+
"notifications will receive an email "
121+
"and those who have signed up for push notifications will receive a "
122+
"push notification."
123+
)
109124
self.fields["notify_email_all"].help_text = (
110125
"This will send an email notification to all of the users who can see this post. This option "
111126
"does NOT take users' email notification preferences into account, so please use with care."

‎intranet/apps/announcements/notifications.py

+32-2
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,18 @@
77
from django.contrib import messages
88
from django.contrib.auth import get_user_model
99
from django.core import exceptions
10+
from django.db.models import Q
1011
from django.urls import reverse
12+
from django.utils.html import strip_tags
13+
from push_notifications.models import WebPushDevice
1114
from requests_oauthlib import OAuth1
1215
from sentry_sdk import capture_exception
1316

1417
from ...utils.date import get_senior_graduation_year
15-
from ..notifications.tasks import email_send_task
18+
from ..notifications.tasks import email_send_task, send_bulk_notification
19+
from ..notifications.utils import truncate_content, truncate_title
20+
from ..users.models import User
21+
from .models import Announcement
1622

1723
logger = logging.getLogger(__name__)
1824

@@ -135,7 +141,7 @@ def announcement_posted_email(request, obj, send_all=False):
135141
emails.append(u.notification_email)
136142
users_send.append(u)
137143

138-
if not settings.PRODUCTION and len(emails) > 3:
144+
if not settings.PRODUCTION and len(emails) > 3 and not settings.FORCE_EMAIL_SEND:
139145
raise exceptions.PermissionDenied("You're about to email a lot of people, and you aren't in production!")
140146

141147
base_url = request.build_absolute_uri(reverse("index"))
@@ -200,3 +206,27 @@ def notify_twitter(status):
200206
req = requests.post(url, data=data, auth=auth, timeout=15)
201207

202208
return req.text
209+
210+
211+
def announcement_posted_push_notification(obj: Announcement) -> None:
212+
"""Send a (Web)push notification to users when an announcement is posted.
213+
214+
obj: The announcement object
215+
216+
"""
217+
218+
if not obj.groups.all():
219+
users = User.objects.filter(push_notification_preferences__announcement_notifications=True)
220+
devices = WebPushDevice.objects.filter(user__in=users)
221+
else:
222+
users = User.objects.filter(Q(groups__in=obj.groups.all()) & Q(push_notification_preferences__announcement_notifications=True))
223+
devices = WebPushDevice.objects.filter(user__in=users)
224+
225+
send_bulk_notification.delay(
226+
filtered_objects=devices,
227+
title=f"Announcement: {truncate_title(obj.title)} ({obj.get_author()})",
228+
body=truncate_content(strip_tags(obj.content_no_links)),
229+
data={
230+
"url": settings.PUSH_NOTIFICATIONS_BASE_URL + reverse("view_announcement", args=[obj.id]),
231+
},
232+
)

‎intranet/apps/announcements/views.py

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
admin_request_announcement_email,
2020
announcement_approved_email,
2121
announcement_posted_email,
22+
announcement_posted_push_notification,
2223
announcement_posted_twitter,
2324
request_announcement_email,
2425
)
@@ -48,6 +49,7 @@ def announcement_posted_hook(request, obj):
4849
"""
4950
if obj.notify_post:
5051
announcement_posted_twitter(request, obj)
52+
announcement_posted_push_notification(obj)
5153
try:
5254
notify_all = obj.notify_email_all
5355
except AttributeError:

0 commit comments

Comments
 (0)