Merge pull request #286 from ctrlh/slack-integration

jabelone · web-flow · commit c718913f02df · 2025-01-11T22:19:32.000+10:00
Thanks!

Add Slack integration
diff --git a/memberportal/access/migrations/0020_accesscontrolleddevice_post_to_slack.py b/memberportal/access/migrations/0020_accesscontrolleddevice_post_to_slack.py
@@ -0,0 +1,20 @@
+# Generated by Django 3.2.25 on 2024-12-07 23:36
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("access", "0019_auto_20240603_2150"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="accesscontrolleddevice",
+            name="post_to_slack",
+            field=models.BooleanField(
+                default=True, verbose_name="Post to slack on swipe"
+            ),
+        ),
+    ]
diff --git a/memberportal/access/models.py b/memberportal/access/models.py
@@ -1,5 +1,14 @@
 import logging
-from services.discord import post_door_swipe_to_discord, post_interlock_swipe_to_discord
+from services.discord import (
+    post_door_swipe_to_discord,
+    post_interlock_swipe_to_discord,
+    post_door_bump_to_discord,
+)
+from services.slack import (
+    post_door_swipe_to_slack,
+    post_door_bump_to_slack,
+    post_interlock_swipe_to_slack,
+)
 from services import sms
 from profile.models import Profile, log_event
 from memberbucks.models import MemberBucks
@@ -67,6 +76,7 @@ class AccessControlledDevice(
     locked_out = models.BooleanField("Maintenance lockout enabled", default=False)
     play_theme = models.BooleanField("Play theme on successful swipe", default=False)
     post_to_discord = models.BooleanField("Post to discord on swipe", default=True)
+    post_to_slack = models.BooleanField("Post to slack on swipe", default=True)
     exempt_signin = models.BooleanField(
         "Exempt this device from requiring a sign in", default=False
     )
@@ -299,6 +309,12 @@ def bump(self, request=None):
             )
 
             if request:
+                # notify messaging apps of bump
+                profile = request.user.profile
+                if self.post_to_slack:
+                    post_door_bump_to_slack(profile.get_full_name(), self.name)
+                if self.post_to_discord:
+                    post_door_bump_to_discord(profile.get_full_name(), self.name)
                 self.log_access(request.user.id)
                 request.user.log_event(
                     f"Bumped the {self.name} {self._meta.verbose_name}.",
@@ -310,6 +326,10 @@ def bump(self, request=None):
                     f"Unknown user (system) bumped the {self.name} {self._meta.verbose_name}.",
                     "admin",
                 )
+                if self.post_to_slack:
+                    post_door_bump_to_slack("unknown", self.name)
+                if self.post_to_discord:
+                    post_door_bump_to_discord("unknown", self.name)
 
             return True
 
@@ -331,14 +351,27 @@ def log_access(self, member_id, success=True):
             metrics.device_access_successes_total.labels(
                 **self.get_metrics_labels()
             ).inc()
+
+            # TODO replace with generic post_to_messengers
             if self.post_to_discord:
                 post_door_swipe_to_discord(profile.get_full_name(), self.name, success)
+            if self.post_to_slack:
+                post_door_swipe_to_slack(profile.get_full_name(), self.name, success)
 
         elif success == "locked_out":
             metrics.device_access_failures_total.labels(
                 **self.get_metrics_labels()
             ).inc()
-            post_door_swipe_to_discord(profile.get_full_name(), self.name, "locked_out")
+
+            # TODO replace with generic post_to_messengers
+            if self.post_to_discord:
+                post_door_swipe_to_discord(
+                    profile.get_full_name(), self.name, "locked_out"
+                )
+            if self.post_to_slack:
+                post_door_swipe_to_slack(
+                    profile.get_full_name(), self.name, "locked_out"
+                )
 
             sms_message = sms.SMS()
             sms_message.send_locked_out_swipe_alert(profile.phone)
@@ -347,10 +380,15 @@ def log_access(self, member_id, success=True):
             metrics.device_access_failures_total.labels(
                 **self.get_metrics_labels()
             ).inc()
+
+            # TODO replace with generic post_to_messengers
             if self.post_to_discord:
                 post_door_swipe_to_discord(
                     profile.get_full_name(), self.name, "rejected"
                 )
+            if self.post_to_slack:
+                post_door_swipe_to_slack(profile.get_full_name(), self.name, "rejected")
+
             sms_message = sms.SMS()
             sms_message.send_inactive_swipe_alert(profile.phone)
 
diff --git a/memberportal/api_access/views.py b/memberportal/api_access/views.py
@@ -255,7 +255,7 @@ def post(self, request, door_id):
         # BUT we still need to check if the API is enabled or it's a user making the request
         if config.ENABLE_DOOR_BUMP_API or request.user.is_authenticated:
             door = Doors.objects.get(pk=door_id)
-            bumped = door.bump()
+            bumped = door.bump(request)
             door.log_force_bump()
             return Response({"success": bumped})
         else:
diff --git a/memberportal/api_admin_tools/views.py b/memberportal/api_admin_tools/views.py
@@ -199,6 +199,7 @@ def get_door(door):
                 "maintenanceLockout": door.locked_out,
                 "playThemeOnSwipe": door.play_theme,
                 "postDiscordOnSwipe": door.post_to_discord,
+                "postSlackOnSwipe": door.post_to_slack,
                 "exemptFromSignin": door.exempt_signin,
                 "hiddenToMembers": door.hidden,
                 "totalSwipes": logs.count(),
@@ -231,6 +232,7 @@ def put(self, request, door_id):
         door.locked_out = data.get("maintenanceLockout")
         door.play_theme = data.get("playThemeOnSwipe")
         door.post_to_discord = data.get("postDiscordOnSwipe")
+        door.post_to_slack = data.get("postSlackOnSwipe")
         door.exempt_signin = data.get("exemptFromSignin")
         door.hidden = data.get("hiddenToMembers")
         door.save()
diff --git a/memberportal/api_general/views.py b/memberportal/api_general/views.py
@@ -17,6 +17,7 @@
 from rest_framework.views import APIView
 from .models import Kiosk, SiteSession, EmailVerificationToken
 from services.discord import post_kiosk_swipe_to_discord
+from services.slack import post_kiosk_swipe_to_slack
 import base64
 from urllib.parse import parse_qs, urlencode
 import hmac
@@ -591,7 +592,8 @@ def put(self, request):
         )
         for session in sessions:
             session.signout()
-        post_kiosk_swipe_to_discord(request.user.profile.get_full_name(), False)
+        if config.ENABLE_DISCORD_INTEGRATION and config.SLACK_DOOR_WEBHOOK:
+            post_kiosk_swipe_to_discord(request.user.profile.get_full_name(), False)
 
         for door in request.user.profile.doors.all():
             door.sync()
diff --git a/memberportal/membermatters/constance_config.py b/memberportal/membermatters/constance_config.py
@@ -339,6 +339,26 @@
         "",
         "The auth token (not an api token) to use for the twilio integration.",
     ),
+    "ENABLE_SLACK_INTEGRATION": (
+        False,
+        "Enable posting a notification to the slack channel on a card swipe.",
+    ),
+    "SLACK_DOOR_WEBHOOK": (
+        "https://hooks.slack.com/services/T00000000/B00000000/<token>",
+        "Slack URL to send webhook notifications to.",
+    ),
+    "SLACK_INTERLOCK_WEBHOOK": (
+        "https://hooks.slack.com/services/T00000000/B00000000/<token>",
+        "Slack URL to send webhook notifications to.",
+    ),
+    "SLACK_MEMBERBUCKS_PURCHASE_WEBHOOK": (
+        "https://hooks.slack.com/services/T00000000/B00000000/<token>",
+        "Slack URL to send webhook notifications to for vending/memberbucks purchases.",
+    ),
+    "SLACK_REPORT_ISSUE_WEBHOOK": (
+        "https://hooks.slack.com/services/T00000000/B00000000/<token>",
+        "Slack URL to send webhook notifications to when reporting issues.",
+    ),
     "SMS_ENABLE": (
         False,
         "If SMS functionality should be enabled (please configure below).",
@@ -396,6 +416,7 @@
                 "ENABLE_MEMBERBUCKS",
                 "ENABLE_DISCOURSE_SSO_PROTOCOL",
                 "ENABLE_DISCORD_INTEGRATION",
+                "ENABLE_SLACK_INTEGRATION",
                 "ENABLE_SPACE_DIRECTORY",
                 "ENABLE_THEME_SWIPE",
                 "ENABLE_PORTAL_SITE_SIGN_IN",
@@ -558,5 +579,14 @@
                 "DISCORD_REPORT_ISSUE_WEBHOOK",
             ),
         ),
+        (
+            "Slack Integration",
+            (
+                "SLACK_DOOR_WEBHOOK",
+                "SLACK_INTERLOCK_WEBHOOK",
+                "SLACK_MEMBERBUCKS_PURCHASE_WEBHOOK",
+                "SLACK_REPORT_ISSUE_WEBHOOK",
+            ),
+        ),
     ]
 )
diff --git a/memberportal/membermatters/settings.py b/memberportal/membermatters/settings.py
@@ -243,6 +243,11 @@
             "level": os.environ.get("MM_LOG_LEVEL_DISCORD", "INFO"),
             "propagate": False,
         },
+        "slack": {
+            "handlers": ["console", "file"],
+            "level": os.environ.get("MM_LOG_LEVEL_SLACK", "INFO"),
+            "propagate": False,
+        },
         "emails": {
             "handlers": ["console", "file"],
             "level": os.environ.get("MM_LOG_LEVEL_EMAILS", "INFO"),
diff --git a/memberportal/services/discord.py b/memberportal/services/discord.py
@@ -214,3 +214,25 @@ def post_reported_issue_to_discord(
             return True
 
     return True
+
+
+def post_door_bump_to_discord(name, door):
+    if config.ENABLE_DISCORD_INTEGRATION and config.DISCORD_DOOR_WEBHOOK:
+        logger.debug("Posting door bump to Discord!")
+
+        url = config.DISCORD_DOOR_WEBHOOK
+
+        json_message = {"description": "", "embeds": []}
+        json_message["embeds"].append(
+            {
+                "description": ":unlock: {} just bumped at {}.".format(name, door),
+                "color": 5025616,
+            }
+        )
+
+        try:
+            requests.post(url, json=json_message, timeout=settings.REQUEST_TIMEOUT)
+        except requests.exceptions.ReadTimeout:
+            return True
+
+    return True
diff --git a/memberportal/services/slack.py b/memberportal/services/slack.py
diff --git a/package-lock.json b/package-lock.json
diff --git a/src-frontend/package-lock.json b/src-frontend/package-lock.json
