filter-thread-updates-queryset-hook.md

filter_thread_updates_queryset_hook

This hook wraps the standard function that Misago uses set filters on thread's updates queryset to limit it only to updates that the user can see.

Location

This hook can be imported from misago.permissions.hooks:

from misago.permissions.hooks import filter_thread_updates_queryset_hook

Filter

def custom_thread_updates_queryset_filter(
    action: FilterThreadUpdatesQuerysetHookAction,
    permissions: 'UserPermissionsProxy',
    thread: Thread,
    queryset: QuerySet,
) -> QuerySet:
    ...

A function implemented by a plugin that can be registered in this hook.

Arguments

action: FilterThreadUpdatesQuerysetHookAction

Next function registered in this hook, either a custom function or Misago's standard one.

See the action section for details.

user_permissions: UserPermissionsProxy

A proxy object with the current user's permissions.

thread: Thread

A thread instance which's updates are retrieved.

queryset: Queryset

A queryset returning thread's updates.

Return value

A queryset filtered to show only thread updates that the user can see.

Action

def filter_thread_updates_queryset_action(
    permissions: 'UserPermissionsProxy',
    thread: Thread,
    queryset: QuerySet,
) -> QuerySet:
    ...

Misago function used to set filters on a queryset used to retrieve specified thread's updates that user can see.

Arguments

user_permissions: UserPermissionsProxy

A proxy object with the current user's permissions.

thread: Thread

A thread instance which's updates are retrieved.

queryset: Queryset

A queryset returning thread's updates.

Return value

A queryset filtered to show only thread updates that the user can see.

Example

The code below implements a custom filter function hides all updates from anonymous user.

from misago.permissions.hooks import filter_thread_updates_queryset_hook
from misago.permissions.proxy import UserPermissionsProxy

@filter_thread_updates_queryset_hook.append_filter
def exclude_old_private_threads_queryset_hook(
    action,
    permissions: UserPermissionsProxy,
    thread,
    queryset,
) -> None:
    queryset = action(permissions, thread, queryset)

    if permissions.user.is_anonymous:
        return queryset.none()

    return queryset