Add posts likes

dev-docs/plugins/hooks/build-user-category-permissions-hook.md

@@ -46,7 +46,7 @@ A function implemented by a plugin that can be registered in this hook.
 
 #### `action: BuildUserCategoryPermissionsHookAction`
 
-Misago function used to build user category permissions or the next filter function from another plugin.
+Next function registered in this hook, either a custom function or Misago's standard one.
 
 See the [action](#action) section for details.
 

dev-docs/plugins/hooks/build-user-permissions-hook.md

@@ -28,7 +28,7 @@ A function implemented by a plugin that can be registered in this hook.
 
 #### `action: BuildUserPermissionsHookAction`
 
-Misago function used to build user permissions from their groups or the next filter function from another plugin.
+Next function registered in this hook, either a custom function or Misago's standard one.
 
 See the [action](#action) section for details.
 

dev-docs/plugins/hooks/can-see-post-likes-count-hook.md

@@ -0,0 +1,131 @@
+# `can_see_post_likes_count_hook`
+
+This hook wraps a standard Misago function used to check if a user has permission to see a post’s likes count. Returns `True` if they can and `False` if they can't.
+
+
+## Location
+
+This hook can be imported from `misago.permissions.hooks`:
+
+```python
+from misago.permissions.hooks import can_see_post_likes_count_hook
+```
+
+
+## Filter
+
+```python
+def custom_can_see_post_likes_count_filter(
+    action: CanSeePostsLikesCountHookAction,
+    permissions: 'UserPermissionsProxy',
+    category: Category,
+    thread: Thread,
+    post: Post,
+) -> bool:
+    ...
+```
+
+A function implemented by a plugin that can be registered in this hook.
+
+
+### Arguments
+
+#### `action: CanSeePostsLikesCountHookAction`
+
+Next function registered in this hook, either a custom function or Misago's standard one.
+
+See the [action](#action) section for details.
+
+
+#### `users: UserPermissionsProxy`
+
+A proxy object with the current user's permissions.
+
+
+#### `category: Category`
+
+A category to check permissions for.
+
+
+#### `thread: Thread`
+
+A thread to check permissions for.
+
+
+#### `post: Post`
+
+A post to check permissions for.
+
+
+### Return value
+
+A `bool` with `True` if user can see post's likes count, and `False` if they can't.
+
+
+## Action
+
+```python
+def can_see_post_likes_count_action(
+    permissions: 'UserPermissionsProxy',
+    category: Category,
+    thread: Thread,
+    post: Post,
+) -> bool:
+    ...
+```
+
+Misago function used to check if a user has permission to see a post’s likes count. Returns `True` if they can and `False` if they can't.
+
+
+### Arguments
+
+#### `users: UserPermissionsProxy`
+
+A proxy object with the current user's permissions.
+
+
+#### `category: Category`
+
+A category to check permissions for.
+
+
+#### `thread: Thread`
+
+A thread to check permissions for.
+
+
+#### `post: Post`
+
+A post to check permissions for.
+
+
+### Return value
+
+A `bool` with `True` if user can see post's likes count, and `False` if they can't.
+
+
+## Example
+
+The code below implements a custom filter function that blocks a user from seeing a specific post's likes count if it has a flag.
+
+```python
+from django.core.exceptions import PermissionDenied
+from django.utils.translation import pgettext
+from misago.categories.models import Category
+from misago.permissions.hooks import can_see_post_likes_count_hook
+from misago.permissions.proxy import UserPermissionsProxy
+from misago.threads.models import Post, Thread
+
+@can_see_post_likes_count_hook.append_filter
+def check_user_can_see_post_likes(
+    action,
+    permissions: UserPermissionsProxy,
+    category: Category,
+    thread: Thread,
+    post: Post,
+) -> bool:
+    if post.plugin_data.get("hide_likes"):
+        return False
+
+    return action(permissions, category, thread, post)
+```

dev-docs/plugins/hooks/can-upload-private-threads-attachments-hook.md

@@ -29,7 +29,7 @@ A function implemented by a plugin that can be registered in this hook.
 
 #### `action: CanUploadPrivateThreadsAttachmentsHookAction`
 
-Misago function that checks whether a user has permission to upload attachments in private threads.
+Next function registered in this hook, either a custom function or Misago's standard one.
 
 See the [action](#action) section for details.
 

dev-docs/plugins/hooks/can-upload-threads-attachments-hook.md

@@ -30,7 +30,7 @@ A function implemented by a plugin that can be registered in this hook.
 
 #### `action: CanUploadThreadsAttachmentsHookAction`
 
-Misago function that checks if a user has permission to upload attachments in a category.
+Next function registered in this hook, either a custom function or Misago's standard one.
 
 See the [action](#action) section for details.
 

dev-docs/plugins/hooks/check-access-category-permission-hook.md

@@ -30,7 +30,7 @@ A function implemented by a plugin that can be registered in this hook.
 
 #### `action: CheckAccessCategoryPermissionHookAction`
 
-Misago function used to check if a user has permission to access a category of unknown type (threads, private threads, or plugin-defined). Raises Django’s `Http404` or `PermissionDenied` if they can't.
+Next function registered in this hook, either a custom function or Misago's standard one.
 
 See the [action](#action) section for details.
 

dev-docs/plugins/hooks/check-access-post-permission-hook.md

@@ -32,7 +32,7 @@ A function implemented by a plugin that can be registered in this hook.
 
 #### `action: CheckAccessPostPermissionHookAction`
 
-Misago function used to check if a user has permission to access a post of unknown type (threads, private threads, or plugin-defined). Raises Django’s `Http404` or `PermissionDenied` if they can't.
+Next function registered in this hook, either a custom function or Misago's standard one.
 
 See the [action](#action) section for details.
 

dev-docs/plugins/hooks/check-access-thread-permission-hook.md

@@ -31,7 +31,7 @@ A function implemented by a plugin that can be registered in this hook.
 
 #### `action: CheckAccessThreadPermissionHookAction`
 
-Misago function used to check if a user has permission to access a thread of unknown type (threads, private threads, or plugin-defined). Raises Django’s `Http404` or `PermissionDenied` if they can't.
+Next function registered in this hook, either a custom function or Misago's standard one.
 
 See the [action](#action) section for details.
 

dev-docs/plugins/hooks/check-browse-category-permission-hook.md

@@ -31,7 +31,7 @@ A function implemented by a plugin that can be registered in this hook.
 
 #### `action: CheckBrowseCategoryPermissionHookAction`
 
-Misago function used to check if the user has permission to browse a category. It also checks if the user can see the category. It raises Django's `Http404` if they can't see it or `PermissionDenied` with an error message if they can't browse it.
+Next function registered in this hook, either a custom function or Misago's standard one.
 
 See the [action](#action) section for details.
 

dev-docs/plugins/hooks/check-delete-attachment-permission-hook.md

@@ -33,7 +33,7 @@ A function implemented by a plugin that can be registered in this hook.
 
 #### `action: CheckDeleteAttachmentPermissionHookAction`
 
-Misago function used to check if a user has permission to delete an attachment. It raises `PermissionDenied` if they are not allowed to delete it.
+Next function registered in this hook, either a custom function or Misago's standard one.
 
 See the [action](#action) section for details.
 

dev-docs/plugins/hooks/check-download-attachment-permission-hook.md

@@ -33,7 +33,7 @@ A function implemented by a plugin that can be registered in this hook.
 
 #### `action: CheckDownloadAttachmentPermissionHookAction`
 
-Misago function used to check if a user has permission to download an attachment. It raises Django's `Http404` if the user cannot see the attachment or `PermissionDenied` if they are not allowed to download it.
+Next function registered in this hook, either a custom function or Misago's standard one.
 
 See the [action](#action) section for details.
 

dev-docs/plugins/hooks/check-edit-private-thread-permission-hook.md

@@ -30,7 +30,7 @@ A function implemented by a plugin that can be registered in this hook.
 
 #### `action: CheckEditPrivateThreadPermissionHookAction`
 
-Misago function used to check if the user has permission to edit a private thread. It raises Django's `PermissionDenied` with an error message if they can't edit it.
+Next function registered in this hook, either a custom function or Misago's standard one.
 
 See the [action](#action) section for details.
 

dev-docs/plugins/hooks/check-edit-private-thread-post-permission-hook.md

@@ -31,7 +31,7 @@ A function implemented by a plugin that can be registered in this hook.
 
 #### `action: CheckEditPrivateThreadPostPermissionHookAction`
 
-Misago function used to check if the user has permission to edit a post in a private thread. It raises Django's `PermissionDenied` with an error message if they can't.
+Next function registered in this hook, either a custom function or Misago's standard one.
 
 See the [action](#action) section for details.
 

dev-docs/plugins/hooks/check-edit-thread-permission-hook.md

@@ -31,7 +31,7 @@ A function implemented by a plugin that can be registered in this hook.
 
 #### `action: CheckEditThreadPermissionHookAction`
 
-Misago function used to check if the user has permission to edit a thread. It raises Django's `PermissionDenied` with an error message if they can't edit it.
+Next function registered in this hook, either a custom function or Misago's standard one.
 
 See the [action](#action) section for details.
 

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

@@ -32,7 +32,7 @@ A function implemented by a plugin that can be registered in this hook.
 
 #### `action: CheckEditThreadPostPermissionHookAction`
 
-Misago function used to check if the user has permission to edit a post in a thread. It raises Django's `PermissionDenied` with an error message if they can't.
+Next function registered in this hook, either a custom function or Misago's standard one.
 
 See the [action](#action) section for details.
 

dev-docs/plugins/hooks/check-like-post-permission-hook.md

@@ -0,0 +1,127 @@
+# `check_like_post_permission_hook`
+
+This hook wraps a standard Misago function used to check if a user has permission to like a post. Raises Django’s `PermissionDenied` if they can't.
+
+
+## Location
+
+This hook can be imported from `misago.permissions.hooks`:
+
+```python
+from misago.permissions.hooks import check_like_post_permission_hook
+```
+
+
+## Filter
+
+```python
+def custom_check_like_post_permission_filter(
+    action: CheckLikePostPermissionHookAction,
+    permissions: 'UserPermissionsProxy',
+    category: Category,
+    thread: Thread,
+    post: Post,
+) -> None:
+    ...
+```
+
+A function implemented by a plugin that can be registered in this hook.
+
+
+### Arguments
+
+#### `action: CheckLikePostPermissionHookAction`
+
+Next function registered in this hook, either a custom function or Misago's standard one.
+
+See the [action](#action) section for details.
+
+
+#### `user_permissions: UserPermissionsProxy`
+
+A proxy object with the current user's permissions.
+
+
+#### `category: Category`
+
+A category to check permissions for.
+
+
+#### `thread: Thread`
+
+A thread to check permissions for.
+
+
+#### `post: Post`
+
+A post to check permissions for.
+
+
+## Action
+
+```python
+def check_like_post_permission_action(
+    permissions: 'UserPermissionsProxy',
+    category: Category,
+    thread: Thread,
+    post: Post,
+) -> None:
+    ...
+```
+
+Misago function used to check if a user has permission to like a post. Raises Django’s `PermissionDenied` if they can't.
+
+
+### Arguments
+
+#### `user_permissions: UserPermissionsProxy`
+
+A proxy object with the current user's permissions.
+
+
+#### `category: Category`
+
+A category to check permissions for.
+
+
+#### `thread: Thread`
+
+A thread to check permissions for.
+
+
+#### `post: Post`
+
+A post to check permissions for.
+
+
+## Example
+
+The code below implements a custom filter function that blocks a user from liking a specific post if there is a custom flag set on it.
+
+```python
+from django.core.exceptions import PermissionDenied
+from django.utils.translation import pgettext
+from misago.categories.models import Category
+from misago.permissions.hooks import check_like_post_permission_hook
+from misago.permissions.proxy import UserPermissionsProxy
+from misago.threads.models import Post, Thread
+
+@check_like_post_permission_hook.append_filter
+def check_user_can_like_post(
+    action,
+    permissions: UserPermissionsProxy,
+    category: Category,
+    thread: Thread,
+    post: Post,
+) -> None:
+    # Run standard permission checks
+    action(permissions, category, thread, post)
+
+    if post.plugin_data.get("disable_likes"):
+        raise PermissionDenied(
+            pgettext(
+                "post permission error",
+                "You can't like this post."
+            )
+        )
+```

dev-docs/plugins/hooks/check-private-threads-permission-hook.md

@@ -29,7 +29,7 @@ A function implemented by a plugin that can be registered in this hook.
 
 #### `action: CheckPrivateThreadsPermissionHookAction`
 
-Misago function used to check if the user has a permission to access private threads feature. Raises Django's `PermissionDenied` with an error message if they don't.
+Next function registered in this hook, either a custom function or Misago's standard one.
 
 See the [action](#action) section for details.