Rename closed category/thread permission checks

dev-docs/plugins/hooks/check-post-in-closed-category-permission-hook.md

@@ -1,4 +1,4 @@
-# `check_post_in_closed_category_permission_hook`
+# `check_locked_category_permission_hook`
 
 This hook wraps the standard function that Misago uses to check if the user has permission to post in a closed category. It raises Django's `PermissionDenied` with an error message if category is closed and they can't post in it.
 
@@ -8,14 +8,14 @@ This hook wraps the standard function that Misago uses to check if the user has
 This hook can be imported from `misago.permissions.hooks`:
 
 ```python
-from misago.permissions.hooks import check_post_in_closed_category_permission_hook
+from misago.permissions.hooks import check_locked_category_permission_hook
 ```
 
 
 ## Filter
 
 ```python
-def custom_check_post_in_closed_category_permission_filter(
+def custom_check_locked_category_permission_filter(
     action: CheckPostInClosedCategoryPermissionHookAction,
     permissions: 'UserPermissionsProxy',
     category: Category,
@@ -48,7 +48,7 @@ A category to check permissions for.
 ## Action
 
 ```python
-def check_post_in_closed_category_permission_action(
+def check_locked_category_permission_action(
     permissions: 'UserPermissionsProxy', category: Category
 ) -> None:
     ...
@@ -75,10 +75,10 @@ The code below implements a custom filter function that permits a user to post i
 
 ```python
 from misago.categories.models import Category
-from misago.permissions.hooks import check_post_in_closed_category_permission_hook
+from misago.permissions.hooks import check_locked_category_permission_hook
 from misago.permissions.proxy import UserPermissionsProxy
 
-@check_post_in_closed_category_permission_hook.append_filter
+@check_locked_category_permission_hook.append_filter
 def check_user_can_post_in_closed_category(
     action,
     permissions: UserPermissionsProxy,

dev-docs/plugins/hooks/check-post-in-closed-thread-permission-hook.md

@@ -1,4 +1,4 @@
-# `check_post_in_closed_thread_permission_hook`
+# `check_locked_thread_permission_hook`
 
 This hook wraps the standard function that Misago uses to check if the user has permission to post in a closed thread. It raises Django's `PermissionDenied` with an error message if thread is closed and they can't post in it.
 
@@ -8,14 +8,14 @@ This hook wraps the standard function that Misago uses to check if the user has
 This hook can be imported from `misago.permissions.hooks`:
 
 ```python
-from misago.permissions.hooks import check_post_in_closed_thread_permission_hook
+from misago.permissions.hooks import check_locked_thread_permission_hook
 ```
 
 
 ## Filter
 
 ```python
-def custom_check_post_in_closed_thread_permission_filter(
+def custom_check_locked_thread_permission_filter(
     action: CheckPostInClosedThreadPermissionHookAction,
     permissions: 'UserPermissionsProxy',
     thread: Thread,
@@ -48,7 +48,7 @@ A thread to check permissions for.
 ## Action
 
 ```python
-def check_post_in_closed_thread_permission_action(
+def check_locked_thread_permission_action(
     permissions: 'UserPermissionsProxy', thread: Thread
 ) -> None:
     ...
@@ -74,11 +74,11 @@ A thread to check permissions for.
 The code below implements a custom filter function that permits a user to post in the specific thread if they have a custom flag set on their account.
 
 ```python
-from misago.permissions.hooks import check_post_in_closed_thread_permission_hook
+from misago.permissions.hooks import check_locked_thread_permission_hook
 from misago.permissions.proxy import UserPermissionsProxy
 from misago.threads.models import Thread
 
-@check_post_in_closed_thread_permission_hook.append_filter
+@check_locked_thread_permission_hook.append_filter
 def check_user_can_post_in_closed_thread(
     action,
     permissions: UserPermissionsProxy,

dev-docs/plugins/hooks/reference.md

@@ -85,8 +85,8 @@ Hooks instances are importable from the following Python modules:
 - [`check_edit_thread_poll_permission_hook`](./check-edit-thread-poll-permission-hook.md)
 - [`check_edit_thread_post_permission_hook`](./check-edit-thread-post-permission-hook.md)
 - [`check_open_thread_poll_permission_hook`](./check-open-thread-poll-permission-hook.md)
-- [`check_post_in_closed_category_permission_hook`](./check-post-in-closed-category-permission-hook.md)
-- [`check_post_in_closed_thread_permission_hook`](./check-post-in-closed-thread-permission-hook.md)
+- [`check_locked_category_permission_hook`](./check-post-in-closed-category-permission-hook.md)
+- [`check_locked_thread_permission_hook`](./check-post-in-closed-thread-permission-hook.md)
 - [`check_private_threads_permission_hook`](./check-private-threads-permission-hook.md)
 - [`check_reply_private_thread_permission_hook`](./check-reply-private-thread-permission-hook.md)
 - [`check_reply_thread_permission_hook`](./check-reply-thread-permission-hook.md)

misago/permissions/hooks/__init__.py

@@ -28,11 +28,11 @@
 from .check_edit_thread_poll_permission import check_edit_thread_poll_permission_hook
 from .check_edit_thread_post_permission import check_edit_thread_post_permission_hook
 from .check_open_thread_poll_permission import check_open_thread_poll_permission_hook
-from .check_post_in_closed_category_permission import (
-    check_post_in_closed_category_permission_hook,
+from .check_locked_category_permission import (
+    check_locked_category_permission_hook,
 )
-from .check_post_in_closed_thread_permission import (
-    check_post_in_closed_thread_permission_hook,
+from .check_locked_thread_permission import (
+    check_locked_thread_permission_hook,
 )
 from .check_private_threads_permission import check_private_threads_permission_hook
 from .check_reply_private_thread_permission import (
@@ -103,8 +103,8 @@
     "check_edit_thread_poll_permission_hook",
     "check_edit_thread_post_permission_hook",
     "check_open_thread_poll_permission_hook",
-    "check_post_in_closed_category_permission_hook",
-    "check_post_in_closed_thread_permission_hook",
+    "check_locked_category_permission_hook",
+    "check_locked_thread_permission_hook",
     "check_private_threads_permission_hook",
     "check_reply_private_thread_permission_hook",
     "check_reply_thread_permission_hook",

misago/permissions/hooks/check_post_in_closed_category_permission.py → misago/permissions/hooks/check_locked_category_permission.py

@@ -80,10 +80,10 @@ class CheckPostInClosedCategoryPermissionHook(
 
     ```python
     from misago.categories.models import Category
-    from misago.permissions.hooks import check_post_in_closed_category_permission_hook
+    from misago.permissions.hooks import check_locked_category_permission_hook
     from misago.permissions.proxy import UserPermissionsProxy
 
-    @check_post_in_closed_category_permission_hook.append_filter
+    @check_locked_category_permission_hook.append_filter
     def check_user_can_post_in_closed_category(
         action,
         permissions: UserPermissionsProxy,
@@ -116,6 +116,6 @@ def __call__(
         return super().__call__(action, permissions, category)
 
 
-check_post_in_closed_category_permission_hook = (
+check_locked_category_permission_hook = (
     CheckPostInClosedCategoryPermissionHook()
 )

misago/permissions/hooks/check_post_in_closed_thread_permission.py → misago/permissions/hooks/check_locked_thread_permission.py

@@ -79,11 +79,11 @@ class CheckPostInClosedThreadPermissionHook(
     post in the specific thread if they have a custom flag set on their account.
 
     ```python
-    from misago.permissions.hooks import check_post_in_closed_thread_permission_hook
+    from misago.permissions.hooks import check_locked_thread_permission_hook
     from misago.permissions.proxy import UserPermissionsProxy
     from misago.threads.models import Thread
 
-    @check_post_in_closed_thread_permission_hook.append_filter
+    @check_locked_thread_permission_hook.append_filter
     def check_user_can_post_in_closed_thread(
         action,
         permissions: UserPermissionsProxy,
@@ -116,4 +116,4 @@ def __call__(
         return super().__call__(action, permissions, thread)
 
 
-check_post_in_closed_thread_permission_hook = CheckPostInClosedThreadPermissionHook()
+check_locked_thread_permission_hook = CheckPostInClosedThreadPermissionHook()

misago/permissions/polls.py

@@ -18,8 +18,8 @@
 )
 from .proxy import UserPermissionsProxy
 from .threads import (
-    check_post_in_closed_category_permission,
-    check_post_in_closed_thread_permission,
+    check_locked_category_permission,
+    check_locked_thread_permission,
 )
 
 
@@ -60,8 +60,8 @@ def _check_start_thread_poll_permission_action(
     category: Category,
     thread: Thread,
 ):
-    check_post_in_closed_category_permission(permissions, category)
-    check_post_in_closed_thread_permission(permissions, thread)
+    check_locked_category_permission(permissions, category)
+    check_locked_thread_permission(permissions, thread)
 
     if thread.has_poll:
         raise PermissionDenied(
@@ -97,8 +97,8 @@ def check_edit_thread_poll_permission(
 def _check_edit_thread_poll_permission_action(
     permissions: UserPermissionsProxy, category: Category, thread: Thread, poll: Poll
 ):
-    check_post_in_closed_category_permission(permissions, category)
-    check_post_in_closed_thread_permission(permissions, thread)
+    check_locked_category_permission(permissions, category)
+    check_locked_thread_permission(permissions, thread)
 
     if permissions.is_category_moderator(thread.category_id):
         return
@@ -194,8 +194,8 @@ def check_close_thread_poll_permission(
 def _check_close_thread_poll_permission_action(
     permissions: UserPermissionsProxy, category: Category, thread: Thread, poll: Poll
 ):
-    check_post_in_closed_category_permission(permissions, category)
-    check_post_in_closed_thread_permission(permissions, thread)
+    check_locked_category_permission(permissions, category)
+    check_locked_thread_permission(permissions, thread)
 
     if permissions.is_category_moderator(thread.category_id):
         return

misago/permissions/tests/test_threads_permissions.py

@@ -8,8 +8,8 @@
 from ..threads import (
     check_edit_thread_post_permission,
     check_edit_thread_permission,
-    check_post_in_closed_category_permission,
-    check_post_in_closed_thread_permission,
+    check_locked_category_permission,
+    check_locked_thread_permission,
     check_reply_thread_permission,
     check_see_thread_post_permission,
     check_see_thread_permission,
@@ -459,24 +459,24 @@ def test_check_edit_thread_permission_passes_for_category_moderator_if_out_of_ti
     check_edit_thread_permission(permissions, default_category, thread)
 
 
-def test_check_post_in_closed_category_permission_passes_if_category_is_open(
+def test_check_locked_category_permission_passes_if_category_is_open(
     user, cache_versions, default_category
 ):
     permissions = UserPermissionsProxy(user, cache_versions)
-    check_post_in_closed_category_permission(permissions, default_category)
+    check_locked_category_permission(permissions, default_category)
 
 
-def test_check_post_in_closed_category_permission_passes_if_user_is_global_moderator(
+def test_check_locked_category_permission_passes_if_user_is_global_moderator(
     moderator, cache_versions, default_category
 ):
     default_category.is_closed = True
     default_category.save()
 
     permissions = UserPermissionsProxy(moderator, cache_versions)
-    check_post_in_closed_category_permission(permissions, default_category)
+    check_locked_category_permission(permissions, default_category)
 
 
-def test_check_post_in_closed_category_permission_passes_if_user_is_category_moderator(
+def test_check_locked_category_permission_passes_if_user_is_category_moderator(
     user, cache_versions, default_category
 ):
     default_category.is_closed = True
@@ -489,10 +489,10 @@ def test_check_post_in_closed_category_permission_passes_if_user_is_category_mod
     )
 
     permissions = UserPermissionsProxy(user, cache_versions)
-    check_post_in_closed_category_permission(permissions, default_category)
+    check_locked_category_permission(permissions, default_category)
 
 
-def test_check_post_in_closed_category_permission_fails_if_user_is_not_moderator(
+def test_check_locked_category_permission_fails_if_user_is_not_moderator(
     user, cache_versions, default_category
 ):
     default_category.is_closed = True
@@ -501,10 +501,10 @@ def test_check_post_in_closed_category_permission_fails_if_user_is_not_moderator
     permissions = UserPermissionsProxy(user, cache_versions)
 
     with pytest.raises(PermissionDenied):
-        check_post_in_closed_category_permission(permissions, default_category)
+        check_locked_category_permission(permissions, default_category)
 
 
-def test_check_post_in_closed_category_permission_fails_if_user_is_anonymous(
+def test_check_locked_category_permission_fails_if_user_is_anonymous(
     anonymous_user, cache_versions, default_category
 ):
     default_category.is_closed = True
@@ -513,27 +513,27 @@ def test_check_post_in_closed_category_permission_fails_if_user_is_anonymous(
     permissions = UserPermissionsProxy(anonymous_user, cache_versions)
 
     with pytest.raises(PermissionDenied):
-        check_post_in_closed_category_permission(permissions, default_category)
+        check_locked_category_permission(permissions, default_category)
 
 
-def test_check_post_in_closed_thread_permission_passes_if_thread_is_open(
+def test_check_locked_thread_permission_passes_if_thread_is_open(
     user, cache_versions, thread
 ):
     permissions = UserPermissionsProxy(user, cache_versions)
-    check_post_in_closed_thread_permission(permissions, thread)
+    check_locked_thread_permission(permissions, thread)
 
 
-def test_check_post_in_closed_thread_permission_passes_if_user_is_global_moderator(
+def test_check_locked_thread_permission_passes_if_user_is_global_moderator(
     moderator, cache_versions, thread
 ):
     thread.is_closed = True
     thread.save()
 
     permissions = UserPermissionsProxy(moderator, cache_versions)
-    check_post_in_closed_thread_permission(permissions, thread)
+    check_locked_thread_permission(permissions, thread)
 
 
-def test_check_post_in_closed_thread_permission_passes_if_user_is_category_moderator(
+def test_check_locked_thread_permission_passes_if_user_is_category_moderator(
     user, cache_versions, thread
 ):
     thread.is_closed = True
@@ -546,10 +546,10 @@ def test_check_post_in_closed_thread_permission_passes_if_user_is_category_moder
     )
 
     permissions = UserPermissionsProxy(user, cache_versions)
-    check_post_in_closed_thread_permission(permissions, thread)
+    check_locked_thread_permission(permissions, thread)
 
 
-def test_check_post_in_closed_thread_permission_fails_if_user_is_not_moderator(
+def test_check_locked_thread_permission_fails_if_user_is_not_moderator(
     user, cache_versions, thread
 ):
     thread.is_closed = True
@@ -558,10 +558,10 @@ def test_check_post_in_closed_thread_permission_fails_if_user_is_not_moderator(
     permissions = UserPermissionsProxy(user, cache_versions)
 
     with pytest.raises(PermissionDenied):
-        check_post_in_closed_thread_permission(permissions, thread)
+        check_locked_thread_permission(permissions, thread)
 
 
-def test_check_post_in_closed_thread_permission_fails_if_user_is_anonymous(
+def test_check_locked_thread_permission_fails_if_user_is_anonymous(
     anonymous_user, cache_versions, thread
 ):
     thread.is_closed = True
@@ -570,7 +570,7 @@ def test_check_post_in_closed_thread_permission_fails_if_user_is_anonymous(
     permissions = UserPermissionsProxy(anonymous_user, cache_versions)
 
     with pytest.raises(PermissionDenied):
-        check_post_in_closed_thread_permission(permissions, thread)
+        check_locked_thread_permission(permissions, thread)
 
 
 def test_check_reply_thread_permission_passes_if_user_has_permission(

misago/permissions/threads/__init__.py

@@ -1,8 +1,8 @@
 from .checks import (
     check_edit_thread_post_permission,
     check_edit_thread_permission,
-    check_post_in_closed_category_permission,
-    check_post_in_closed_thread_permission,
+    check_locked_category_permission,
+    check_locked_thread_permission,
     check_reply_thread_permission,
     check_see_thread_permission,
     check_see_thread_post_permission,
@@ -22,8 +22,8 @@
     "can_upload_thread_attachments",
     "check_edit_thread_post_permission",
     "check_edit_thread_permission",
-    "check_post_in_closed_category_permission",
-    "check_post_in_closed_thread_permission",
+    "check_locked_category_permission",
+    "check_locked_thread_permission",
     "check_reply_thread_permission",
     "check_see_thread_permission",
     "check_see_thread_post_permission",