merge HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK into HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE

docs/settings.rst

@@ -87,17 +87,13 @@ Options that change ticket updates
 ----------------------------------
 
 - **HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE** Allow non-staff users to interact with tickets?
-
+  Set to True to allow any authenticated user to manage tickets.
-  **Default:** ``HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE = False``
+  You can also apply a custom authorisation logic for identifying helpdesk staff members, by setting this to a callable.
-
+  In that case, the value should be a function accepting the active user as a parameter and returning True if the user is considered helpdesk staff, e.g.
-- **HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK** Apply a custom authorisation logic for identifying helpdesk staff members.
-  If set, `HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE` will be ignored when determining staff access.
-  The value should be a function accepting the active user as a parameter and returning True if the user is considered helpdesk
-  staff, e.g.
 
     lambda u: u.is_authenticated() and u.is_active and u.groups.filter(name='helpdesk_staff').exists()))
 
-  **Default:** ``HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE = None``
+  **Default:** ``HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE = False``
 
 - **HELPDESK_SHOW_EDIT_BUTTON_FOLLOW_UP** Show edit buttons in ticket follow ups?
 

helpdesk/decorators.py

@@ -2,9 +2,9 @@
 from django.contrib.auth.decorators import user_passes_test
 from helpdesk import settings
 
-if settings.HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK:
+if callable(settings.HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE):
     # apply a custom user validation condition
-    is_helpdesk_staff = settings.HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK
+    is_helpdesk_staff = settings.HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE
 elif settings.HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE:
     # treat 'normal' users like 'staff'
     is_helpdesk_staff = lambda u: u.is_authenticated() and u.is_active

helpdesk/settings.py

@@ -61,18 +61,11 @@ HELPDESK_SUBMIT_A_TICKET_PUBLIC = getattr(settings, 'HELPDESK_SUBMIT_A_TICKET_PU
 
 
 ''' options for update_ticket views '''
-# allow non-staff users to interact with tickets? this will also change how 'helpdesk_staff_member_required'
+# allow non-staff users to interact with tickets?
-# in staff.py will be defined.
+# can be True/False or a callable accepting the active user and returning True if they must be considered helpdesk staff
 HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE = getattr(settings, 'HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE', False)
-
+if not (HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE in (True, False) or callable(HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE)):
-# apply a custom authorisation logic when defining 'helpdesk_staff_member_required' in staff.py.
+    warnings.warn("HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE should be set to either True/False or a callable.", RuntimeWarning)
-HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK = getattr(settings, 'HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK', None)
-if not (HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK is None or callable(HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK)):
-    raise ImproperlyConfigured("HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK must be a callable or None")
-if HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK and HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE:
-    warnings.warn(
-        "The HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE and HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK settings cannot be both defined. "
-        "Only HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK will be considered in determining staff access.", RuntimeWarning)
 
 # show edit buttons in ticket follow ups.
 HELPDESK_SHOW_EDIT_BUTTON_FOLLOW_UP = getattr(settings, 'HELPDESK_SHOW_EDIT_BUTTON_FOLLOW_UP', True)

helpdesk/tests/navigation.py

@@ -39,16 +39,14 @@ class KBDisabledTestCase(TestCase):
 
 class StaffUserTestCaseMixin(object):
     HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE = False
-    HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK = None
 
     def setUp(self):
-        self.old_settings = settings.HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE, settings.HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK
+        self.original_setting = settings.HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE
         settings.HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE = self.HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE
-        settings.HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK = self.HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK
         self.reload_views()
 
     def tearDown(self):
-        settings.HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE, settings.HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK = self.old_settings
+        settings.HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE = self.original_setting
         self.reload_views()
 
     def reload_views(self):
@@ -67,7 +65,6 @@ class StaffUserTestCaseMixin(object):
 
 class NonStaffUsersAllowedTestCase(StaffUserTestCaseMixin, TestCase):
     HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE = True
-    HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK = None
 
     def test_non_staff_allowed(self):
         """If HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE is True,
@@ -88,7 +85,6 @@ class NonStaffUsersAllowedTestCase(StaffUserTestCaseMixin, TestCase):
 class StaffUsersOnlyTestCase(StaffUserTestCaseMixin, TestCase):
     # Use default values
     HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE = False
-    HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK = None
 
     def test_non_staff(self):
         """Non-staff users are correctly identified"""
@@ -114,15 +110,15 @@ class StaffUsersOnlyTestCase(StaffUserTestCaseMixin, TestCase):
 
 
 class CustomStaffUserTestCase(StaffUserTestCaseMixin, TestCase):
-    HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE = False
-
     @staticmethod
-    def HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK(user):
+    def custom_staff_filter(user):
         """Arbitrary user validation function"""
         return user.is_authenticated() and user.is_active and user.username.lower().endswith('wensleydale')
 
+    HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE = custom_staff_filter
+
     def test_custom_staff_pass(self):
-        """If HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK is not None,
+        """If HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE is callable,
         a custom access rule is applied.
         """
         from helpdesk.decorators import is_helpdesk_staff
@@ -168,16 +164,15 @@ class HomePageAnonymousUserTestCase(TestCase):
 
 class HomePageTestCase(TestCase):
     def setUp(self):
-        self.previous = settings.HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE, settings.HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK
+        self.original_setting = settings.HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE
         settings.HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE = False
-        settings.HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK = None
         try:
             reload(sys.modules['helpdesk.views.public'])
         except KeyError:
             pass
 
     def tearDown(self):
-        settings.HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE, settings.HELPDESK_CUSTOM_STAFF_FILTER_CALLBACK = self.previous
+        settings.HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE = self.original_setting
         reload(sys.modules['helpdesk.views.public'])
 
     def assertUserRedirectedToView(self, user, view_name):