Merge branch 'master' of gitlab.com:allianceauth/allianceauth into v4.x

allianceauth/services/hooks.py

@@ -1,15 +1,18 @@
-from django.urls import include
-from django.urls import re_path
+from django.urls import include, re_path
+from string import Formatter
+from typing import Iterable, Optional
+
+from django.conf import settings
 from django.core.exceptions import ObjectDoesNotExist
 from django.template.loader import render_to_string
+from django.urls import include, re_path
 from django.utils.functional import cached_property
-from django.conf import settings
-from string import Formatter
 
 from allianceauth.hooks import get_hooks
 
 from .models import NameFormatConfig
 
+
 def get_extension_logger(name):
     """
     Takes the name of a plugin/extension and generates a child logger of the extensions logger
@@ -156,8 +159,32 @@ class MenuItemHook:
 
 
 class UrlHook:
-    def __init__(self, urls, namespace, base_url):
+    """A hook for registering the URLs of a Django app.
+
+    Args:
+        - urls: The urls module to include
+        - namespace: The URL namespace to apply. This is usually just the app name.
+        - base_url: The URL prefix to match against in regex form.
+            Example ``r'^app_name/'``.
+            This prefix will be applied in front of all URL patterns included.
+            It is possible to use the same prefix as existing apps (or no prefix at all),
+            but standard URL resolution ordering applies
+            (hook URLs are the last ones registered).
+        - excluded_views: Optional list of views to be excluded
+            from auto-decorating them with the
+            default ``main_character_required`` decorator, e.g. to make them public.
+            Views must be specified by their qualified name,
+            e.g. ``["example.views.my_public_view"]``
+    """
+    def __init__(
+            self,
+            urls,
+            namespace: str,
+            base_url: str,
+            excluded_views : Optional[Iterable[str]] = None
+    ):
         self.include_pattern = re_path(base_url, include(urls, namespace=namespace))
+        self.excluded_views = set(excluded_views or [])
 
 
 class NameFormatter:

allianceauth/services/modules/discord/discord_client/client.py

@@ -588,16 +588,17 @@ class DiscordClient:
             return None  # User is no longer a member
         guild_roles = RolesSet(self.guild_roles(guild_id=guild_id))
         logger.debug('Current guild roles: %s', guild_roles.ids())
+        _roles = set(member_info.roles)
         if not guild_roles.has_roles(member_info.roles):
             guild_roles = RolesSet(
                 self.guild_roles(guild_id=guild_id, use_cache=False)
             )
             if not guild_roles.has_roles(member_info.roles):
                 role_ids = set(member_info.roles).difference(guild_roles.ids())
-                raise RuntimeError(
-                    f'Discord user {user_id} has unknown roles: {role_ids}'
-                )
-        return guild_roles.subset(member_info.roles)
+                logger.warning(f'Discord user {user_id} has unknown roles: {role_ids}')
+                for _r in role_ids:
+                    _roles.remove(_r)
+        return guild_roles.subset(_roles)
 
     @classmethod
     def _is_member_unknown_error(cls, r: requests.Response) -> bool:

allianceauth/services/modules/discord/discord_client/tests/test_client.py

@@ -899,8 +899,8 @@ class TestGuildMemberRoles(NoSocketsTestCase):
         mock_guild_roles.return_value = {role_a, role_b}
         client = DiscordClientStub(TEST_BOT_TOKEN, mock_redis)
         # when/then
-        with self.assertRaises(RuntimeError):
-            client.guild_member_roles(TEST_GUILD_ID, TEST_USER_ID)
+        roles = client.guild_member_roles(TEST_GUILD_ID, TEST_USER_ID)
+        self.assertEqual(roles, RolesSet([role_a]))
 
     # TODO: Re-enable after adding Discord general error handling
     # def test_should_raise_exception_if_member_info_is_invalid(

allianceauth/services/modules/discord/urls.py

@@ -1,5 +1,4 @@
-from django.urls import include
-from django.urls import path
+from django.urls import include, path
 
 from . import views
 

allianceauth/services/modules/discourse/tasks.py

@@ -49,7 +49,7 @@ class DiscourseTasks:
             DiscourseManager.update_groups(user)
         except Exception as e:
             logger.exception(e)
-            logger.warn("Discourse group sync failed for %s, retrying in 10 mins" % user)
+            logger.warning("Discourse group sync failed for %s, retrying in 10 mins" % user)
             raise self.retry(countdown=60 * 10)
         logger.debug("Updated user %s discourse groups." % user)
 

allianceauth/services/modules/example/urls.py

@@ -1,5 +1,4 @@
-from django.urls import include
-from django.urls import path
+from django.urls import include, path
 
 app_name = 'example'
 

allianceauth/services/modules/ips4/urls.py

@@ -1,5 +1,4 @@
-from django.urls import include
-from django.urls import path
+from django.urls import include, path
 
 from . import views
 

allianceauth/services/modules/mumble/urls.py

@@ -1,5 +1,4 @@
-from django.urls import include
-from django.urls import path
+from django.urls import include, path
 
 from . import views
 

allianceauth/services/modules/openfire/urls.py

@@ -1,5 +1,4 @@
-from django.urls import include
-from django.urls import path
+from django.urls import include, path
 
 from . import views
 

allianceauth/services/modules/phpbb3/manager.py

@@ -176,7 +176,7 @@ class Phpbb3Manager:
         logger.debug(f"Proceeding to add phpbb user {username_clean} and pwhash starting with {pwhash[0:5]}")
         # check if the username was simply revoked
         if Phpbb3Manager.check_user(username_clean):
-            logger.warn("Unable to add phpbb user with username %s - already exists. Updating user instead." % username)
+            logger.warning("Unable to add phpbb user with username %s - already exists. Updating user instead." % username)
             Phpbb3Manager.__update_user_info(username_clean, email, pwhash)
         else:
             try:

allianceauth/services/modules/phpbb3/urls.py

@@ -1,5 +1,4 @@
-from django.urls import include
-from django.urls import path
+from django.urls import include, path
 
 from . import views
 

allianceauth/services/modules/smf/urls.py

@@ -1,5 +1,4 @@
-from django.urls import include
-from django.urls import path
+from django.urls import include, path
 
 from . import views
 

allianceauth/services/modules/teamspeak3/urls.py

@@ -1,5 +1,4 @@
-from django.urls import include
-from django.urls import path
+from django.urls import include, path
 
 from . import views
 

allianceauth/services/modules/teamspeak3/views.py

@@ -44,7 +44,7 @@ def activate_teamspeak3(request):
 def verify_teamspeak3(request):
     logger.debug("verify_teamspeak3 called by user %s" % request.user)
     if not Teamspeak3Tasks.has_account(request.user):
-        logger.warn("Unable to validate user %s teamspeak: no teamspeak data" % request.user)
+        logger.warning("Unable to validate user %s teamspeak: no teamspeak data" % request.user)
         return redirect("services:services")
     if request.method == "POST":
         form = TeamspeakJoinForm(request.POST)

allianceauth/services/modules/xenforo/urls.py

@@ -1,5 +1,4 @@
-from django.urls import include
-from django.urls import path
+from django.urls import include, path
 
 from . import views
 

allianceauth/services/tests/test_hooks.py

@@ -0,0 +1,30 @@
+from unittest import TestCase
+
+from allianceauth.services.hooks import UrlHook
+from allianceauth.groupmanagement import urls
+
+
+class TestUrlHook(TestCase):
+    def test_can_create_simple_hook(self):
+        # when
+        obj = UrlHook(urls, "groupmanagement", r"^groupmanagement/")
+        # then
+        self.assertEqual(obj.include_pattern.app_name, "groupmanagement")
+        self.assertFalse(obj.excluded_views)
+
+    def test_can_create_hook_with_excluded_views(self):
+        # when
+        obj = UrlHook(
+            urls,
+            "groupmanagement",
+            r"^groupmanagement/",
+            ["groupmanagement.views.group_management"],
+        )
+        # then
+        self.assertEqual(obj.include_pattern.app_name, "groupmanagement")
+        self.assertIn("groupmanagement.views.group_management", obj.excluded_views)
+
+    def test_should_raise_error_when_called_with_invalid_excluded_views(self):
+        # when/then
+        with self.assertRaises(TypeError):
+            UrlHook(urls, "groupmanagement", r"^groupmanagement/", 99)