mirror of
https://github.com/bookwyrm-social/bookwyrm.git
synced 2024-05-20 01:08:07 +00:00
298 lines
10 KiB
Python
298 lines
10 KiB
Python
""" access the activity streams stored in redis """
|
|
from abc import ABC
|
|
from django.dispatch import receiver
|
|
from django.db.models import signals, Q
|
|
import redis
|
|
|
|
from bookwyrm import models, settings
|
|
from bookwyrm.views.helpers import privacy_filter
|
|
|
|
r = redis.Redis(
|
|
host=settings.REDIS_ACTIVITY_HOST, port=settings.REDIS_ACTIVITY_PORT, db=0
|
|
)
|
|
|
|
|
|
class ActivityStream(ABC):
|
|
""" a category of activity stream (like home, local, federated) """
|
|
|
|
def stream_id(self, user):
|
|
""" the redis key for this user's instance of this stream """
|
|
return "{}-{}".format(user.id, self.key)
|
|
|
|
def unread_id(self, user):
|
|
""" the redis key for this user's unread count for this stream """
|
|
return "{}-unread".format(self.stream_id(user))
|
|
|
|
def get_value(self, status): # pylint: disable=no-self-use
|
|
""" the status id and the rank (ie, published date) """
|
|
return {status.id: status.published_date.timestamp()}
|
|
|
|
def add_status(self, status):
|
|
""" add a status to users' feeds """
|
|
value = self.get_value(status)
|
|
# we want to do this as a bulk operation, hence "pipeline"
|
|
pipeline = r.pipeline()
|
|
for user in self.stream_users(status):
|
|
# add the status to the feed
|
|
pipeline.zadd(self.stream_id(user), value)
|
|
pipeline.zremrangebyrank(
|
|
self.stream_id(user), 0, -1 * settings.MAX_STREAM_LENGTH
|
|
)
|
|
# add to the unread status count
|
|
pipeline.incr(self.unread_id(user))
|
|
# and go!
|
|
pipeline.execute()
|
|
|
|
def remove_status(self, status):
|
|
""" remove a status from all feeds """
|
|
pipeline = r.pipeline()
|
|
for user in self.stream_users(status):
|
|
pipeline.zrem(self.stream_id(user), -1, status.id)
|
|
pipeline.execute()
|
|
|
|
def add_user_statuses(self, viewer, user):
|
|
""" add a user's statuses to another user's feed """
|
|
pipeline = r.pipeline()
|
|
statuses = user.status_set.all()[: settings.MAX_STREAM_LENGTH]
|
|
for status in statuses:
|
|
pipeline.zadd(self.stream_id(viewer), self.get_value(status))
|
|
if statuses:
|
|
pipeline.zremrangebyrank(
|
|
self.stream_id(user), 0, -1 * settings.MAX_STREAM_LENGTH
|
|
)
|
|
pipeline.execute()
|
|
|
|
def remove_user_statuses(self, viewer, user):
|
|
""" remove a user's status from another user's feed """
|
|
pipeline = r.pipeline()
|
|
for status in user.status_set.all()[: settings.MAX_STREAM_LENGTH]:
|
|
pipeline.lrem(self.stream_id(viewer), -1, status.id)
|
|
pipeline.execute()
|
|
|
|
def get_activity_stream(self, user):
|
|
""" load the ids for statuses to be displayed """
|
|
# clear unreads for this feed
|
|
r.set(self.unread_id(user), 0)
|
|
|
|
statuses = r.zrevrange(self.stream_id(user), 0, -1)
|
|
return (
|
|
models.Status.objects.select_subclasses()
|
|
.filter(id__in=statuses)
|
|
.order_by("-published_date")
|
|
)
|
|
|
|
def get_unread_count(self, user):
|
|
""" get the unread status count for this user's feed """
|
|
return int(r.get(self.unread_id(user)) or 0)
|
|
|
|
def populate_stream(self, user):
|
|
""" go from zero to a timeline """
|
|
pipeline = r.pipeline()
|
|
statuses = self.stream_statuses(user)
|
|
|
|
stream_id = self.stream_id(user)
|
|
for status in statuses.all()[: settings.MAX_STREAM_LENGTH]:
|
|
pipeline.zadd(stream_id, self.get_value(status))
|
|
|
|
# only trim the stream if statuses were added
|
|
if statuses.exists():
|
|
pipeline.zremrangebyrank(
|
|
self.stream_id(user), 0, -1 * settings.MAX_STREAM_LENGTH
|
|
)
|
|
pipeline.execute()
|
|
|
|
def stream_users(self, status): # pylint: disable=no-self-use
|
|
""" given a status, what users should see it """
|
|
# direct messages don't appeard in feeds, direct comments/reviews/etc do
|
|
if status.privacy == "direct" and status.status_type == "Note":
|
|
return []
|
|
|
|
# everybody who could plausibly see this status
|
|
audience = models.User.objects.filter(
|
|
is_active=True,
|
|
local=True, # we only create feeds for users of this instance
|
|
).exclude(
|
|
Q(id__in=status.user.blocks.all()) | Q(blocks=status.user) # not blocked
|
|
)
|
|
|
|
# only visible to the poster and mentioned users
|
|
if status.privacy == "direct":
|
|
audience = audience.filter(
|
|
Q(id=status.user.id) # if the user is the post's author
|
|
| Q(id__in=status.mention_users.all()) # if the user is mentioned
|
|
)
|
|
# only visible to the poster's followers and tagged users
|
|
elif status.privacy == "followers":
|
|
audience = audience.filter(
|
|
Q(id=status.user.id) # if the user is the post's author
|
|
| Q(following=status.user) # if the user is following the author
|
|
)
|
|
return audience.distinct()
|
|
|
|
def stream_statuses(self, user): # pylint: disable=no-self-use
|
|
""" given a user, what statuses should they see on this stream """
|
|
return privacy_filter(
|
|
user,
|
|
models.Status.objects.select_subclasses(),
|
|
privacy_levels=["public", "unlisted", "followers"],
|
|
)
|
|
|
|
|
|
class HomeStream(ActivityStream):
|
|
""" users you follow """
|
|
|
|
key = "home"
|
|
|
|
def stream_users(self, status):
|
|
audience = super().stream_users(status)
|
|
if not audience:
|
|
return []
|
|
return audience.filter(
|
|
Q(id=status.user.id) # if the user is the post's author
|
|
| Q(following=status.user) # if the user is following the author
|
|
).distinct()
|
|
|
|
def stream_statuses(self, user):
|
|
return privacy_filter(
|
|
user,
|
|
models.Status.objects.select_subclasses(),
|
|
privacy_levels=["public", "unlisted", "followers"],
|
|
following_only=True,
|
|
)
|
|
|
|
|
|
class LocalStream(ActivityStream):
|
|
""" users you follow """
|
|
|
|
key = "local"
|
|
|
|
def stream_users(self, status):
|
|
# this stream wants no part in non-public statuses
|
|
if status.privacy != "public" or not status.user.local:
|
|
return []
|
|
return super().stream_users(status)
|
|
|
|
def stream_statuses(self, user):
|
|
# all public statuses by a local user
|
|
return privacy_filter(
|
|
user,
|
|
models.Status.objects.select_subclasses().filter(user__local=True),
|
|
privacy_levels=["public"],
|
|
)
|
|
|
|
|
|
class FederatedStream(ActivityStream):
|
|
""" users you follow """
|
|
|
|
key = "federated"
|
|
|
|
def stream_users(self, status):
|
|
# this stream wants no part in non-public statuses
|
|
if status.privacy != "public":
|
|
return []
|
|
return super().stream_users(status)
|
|
|
|
def stream_statuses(self, user):
|
|
return privacy_filter(
|
|
user,
|
|
models.Status.objects.select_subclasses(),
|
|
privacy_levels=["public"],
|
|
)
|
|
|
|
|
|
streams = {
|
|
"home": HomeStream(),
|
|
"local": LocalStream(),
|
|
"federated": FederatedStream(),
|
|
}
|
|
|
|
|
|
@receiver(signals.post_save)
|
|
# pylint: disable=unused-argument
|
|
def add_status_on_create(sender, instance, created, *args, **kwargs):
|
|
""" add newly created statuses to activity feeds """
|
|
# we're only interested in new statuses
|
|
if not issubclass(sender, models.Status):
|
|
return
|
|
|
|
if instance.deleted:
|
|
for stream in streams.values():
|
|
stream.remove_status(instance)
|
|
return
|
|
|
|
if not created:
|
|
return
|
|
|
|
# iterates through Home, Local, Federated
|
|
for stream in streams.values():
|
|
stream.add_status(instance)
|
|
|
|
|
|
@receiver(signals.post_delete, sender=models.Boost)
|
|
# pylint: disable=unused-argument
|
|
def remove_boost_on_delete(sender, instance, *args, **kwargs):
|
|
""" boosts are deleted """
|
|
# we're only interested in new statuses
|
|
for stream in streams.values():
|
|
stream.remove_status(instance)
|
|
|
|
|
|
@receiver(signals.post_save, sender=models.UserFollows)
|
|
# pylint: disable=unused-argument
|
|
def add_statuses_on_follow(sender, instance, created, *args, **kwargs):
|
|
""" add a newly followed user's statuses to feeds """
|
|
if not created or not instance.user_subject.local:
|
|
return
|
|
HomeStream().add_user_statuses(instance.user_subject, instance.user_object)
|
|
|
|
|
|
@receiver(signals.post_delete, sender=models.UserFollows)
|
|
# pylint: disable=unused-argument
|
|
def remove_statuses_on_unfollow(sender, instance, *args, **kwargs):
|
|
""" remove statuses from a feed on unfollow """
|
|
if not instance.user_subject.local:
|
|
return
|
|
HomeStream().remove_user_statuses(instance.user_subject, instance.user_object)
|
|
|
|
|
|
@receiver(signals.post_save, sender=models.UserBlocks)
|
|
# pylint: disable=unused-argument
|
|
def remove_statuses_on_block(sender, instance, *args, **kwargs):
|
|
""" remove statuses from all feeds on block """
|
|
# blocks apply ot all feeds
|
|
if instance.user_subject.local:
|
|
for stream in streams.values():
|
|
stream.remove_user_statuses(instance.user_subject, instance.user_object)
|
|
|
|
# and in both directions
|
|
if instance.user_object.local:
|
|
for stream in streams.values():
|
|
stream.remove_user_statuses(instance.user_object, instance.user_subject)
|
|
|
|
|
|
@receiver(signals.post_delete, sender=models.UserBlocks)
|
|
# pylint: disable=unused-argument
|
|
def add_statuses_on_unblock(sender, instance, *args, **kwargs):
|
|
""" remove statuses from all feeds on block """
|
|
public_streams = [LocalStream(), FederatedStream()]
|
|
# add statuses back to streams with statuses from anyone
|
|
if instance.user_subject.local:
|
|
for stream in public_streams:
|
|
stream.add_user_statuses(instance.user_subject, instance.user_object)
|
|
|
|
# add statuses back to streams with statuses from anyone
|
|
if instance.user_object.local:
|
|
for stream in public_streams:
|
|
stream.add_user_statuses(instance.user_object, instance.user_subject)
|
|
|
|
|
|
@receiver(signals.post_save, sender=models.User)
|
|
# pylint: disable=unused-argument
|
|
def populate_streams_on_account_create(sender, instance, created, *args, **kwargs):
|
|
""" build a user's feeds when they join """
|
|
if not created or not instance.local:
|
|
return
|
|
|
|
for stream in streams.values():
|
|
stream.populate_stream(instance)
|