mirror of
https://github.com/bookwyrm-social/bookwyrm.git
synced 2024-09-26 13:30:13 +00:00
Merge pull request #2522 from joachimesque/disable-remote-users-preview-images
Disable remote users preview images generation
This commit is contained in:
commit
fe29d30ab5
8 changed files with 164 additions and 38 deletions
|
@ -0,0 +1,40 @@
|
||||||
|
""" Remove preview images for remote users """
|
||||||
|
from django.core.management.base import BaseCommand
|
||||||
|
from django.db.models import Q
|
||||||
|
|
||||||
|
from bookwyrm import models, preview_images
|
||||||
|
|
||||||
|
|
||||||
|
# pylint: disable=line-too-long
|
||||||
|
class Command(BaseCommand):
|
||||||
|
"""Remove preview images for remote users"""
|
||||||
|
|
||||||
|
help = "Remove preview images for remote users"
|
||||||
|
|
||||||
|
# pylint: disable=no-self-use,unused-argument
|
||||||
|
def handle(self, *args, **options):
|
||||||
|
"""generate preview images"""
|
||||||
|
self.stdout.write(
|
||||||
|
" | Hello! I will be removing preview images from remote users."
|
||||||
|
)
|
||||||
|
self.stdout.write(
|
||||||
|
"🧑🚒 ⎨ This might take quite long if your instance has a lot of remote users."
|
||||||
|
)
|
||||||
|
self.stdout.write(" | ✧ Thank you for your patience ✧")
|
||||||
|
|
||||||
|
users = models.User.objects.filter(local=False).exclude(
|
||||||
|
Q(preview_image="") | Q(preview_image=None)
|
||||||
|
)
|
||||||
|
|
||||||
|
if len(users) > 0:
|
||||||
|
self.stdout.write(
|
||||||
|
f" → Remote user preview images ({len(users)}): ", ending=""
|
||||||
|
)
|
||||||
|
for user in users:
|
||||||
|
preview_images.remove_user_preview_image_task.delay(user.id)
|
||||||
|
self.stdout.write(".", ending="")
|
||||||
|
self.stdout.write(" OK 🖼")
|
||||||
|
else:
|
||||||
|
self.stdout.write(f" | There was no remote users with preview images.")
|
||||||
|
|
||||||
|
self.stdout.write("🧑🚒 ⎨ I’m all done! ✧ Enjoy ✧")
|
|
@ -526,6 +526,11 @@ def preview_image(instance, *args, **kwargs):
|
||||||
"""create preview images when user is updated"""
|
"""create preview images when user is updated"""
|
||||||
if not ENABLE_PREVIEW_IMAGES:
|
if not ENABLE_PREVIEW_IMAGES:
|
||||||
return
|
return
|
||||||
|
|
||||||
|
# don't call the task for remote users
|
||||||
|
if not instance.local:
|
||||||
|
return
|
||||||
|
|
||||||
changed_fields = instance.field_tracker.changed()
|
changed_fields = instance.field_tracker.changed()
|
||||||
|
|
||||||
if len(changed_fields) > 0:
|
if len(changed_fields) > 0:
|
||||||
|
|
|
@ -472,12 +472,15 @@ def generate_edition_preview_image_task(book_id):
|
||||||
|
|
||||||
@app.task(queue=LOW)
|
@app.task(queue=LOW)
|
||||||
def generate_user_preview_image_task(user_id):
|
def generate_user_preview_image_task(user_id):
|
||||||
"""generate preview_image for a book"""
|
"""generate preview_image for a user"""
|
||||||
if not settings.ENABLE_PREVIEW_IMAGES:
|
if not settings.ENABLE_PREVIEW_IMAGES:
|
||||||
return
|
return
|
||||||
|
|
||||||
user = models.User.objects.get(id=user_id)
|
user = models.User.objects.get(id=user_id)
|
||||||
|
|
||||||
|
if not user.local:
|
||||||
|
return
|
||||||
|
|
||||||
texts = {
|
texts = {
|
||||||
"text_one": user.display_name,
|
"text_one": user.display_name,
|
||||||
"text_three": f"@{user.localname}@{settings.DOMAIN}",
|
"text_three": f"@{user.localname}@{settings.DOMAIN}",
|
||||||
|
@ -491,3 +494,25 @@ def generate_user_preview_image_task(user_id):
|
||||||
image = generate_preview_image(texts=texts, picture=avatar)
|
image = generate_preview_image(texts=texts, picture=avatar)
|
||||||
|
|
||||||
save_and_cleanup(image, instance=user)
|
save_and_cleanup(image, instance=user)
|
||||||
|
|
||||||
|
|
||||||
|
@app.task(queue=LOW)
|
||||||
|
def remove_user_preview_image_task(user_id):
|
||||||
|
"""remove preview_image for a user"""
|
||||||
|
if not settings.ENABLE_PREVIEW_IMAGES:
|
||||||
|
return
|
||||||
|
|
||||||
|
user = models.User.objects.get(id=user_id)
|
||||||
|
|
||||||
|
try:
|
||||||
|
file_name = user.preview_image.name
|
||||||
|
except ValueError:
|
||||||
|
file_name = None
|
||||||
|
|
||||||
|
# Delete image in model
|
||||||
|
user.preview_image.delete(save=False)
|
||||||
|
user.save(broadcast=False, update_fields=["preview_image"])
|
||||||
|
|
||||||
|
# Delete image file
|
||||||
|
if file_name and default_storage.exists(file_name):
|
||||||
|
default_storage.delete(file_name)
|
||||||
|
|
|
@ -14,6 +14,7 @@ from bookwyrm.preview_images import (
|
||||||
generate_edition_preview_image_task,
|
generate_edition_preview_image_task,
|
||||||
generate_user_preview_image_task,
|
generate_user_preview_image_task,
|
||||||
generate_preview_image,
|
generate_preview_image,
|
||||||
|
remove_user_preview_image_task,
|
||||||
save_and_cleanup,
|
save_and_cleanup,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -46,6 +47,37 @@ class PreviewImages(TestCase):
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
with patch("bookwyrm.suggested_users.rerank_suggestions_task.delay"), patch(
|
||||||
|
"bookwyrm.activitystreams.populate_stream_task.delay"
|
||||||
|
), patch("bookwyrm.lists_stream.populate_lists_task.delay"):
|
||||||
|
self.remote_user = models.User.objects.create_user(
|
||||||
|
"rat",
|
||||||
|
"rat@rat.com",
|
||||||
|
"ratword",
|
||||||
|
local=False,
|
||||||
|
remote_id="https://example.com/users/rat",
|
||||||
|
inbox="https://example.com/users/rat/inbox",
|
||||||
|
outbox="https://example.com/users/rat/outbox",
|
||||||
|
)
|
||||||
|
|
||||||
|
with patch("bookwyrm.suggested_users.rerank_suggestions_task.delay"), patch(
|
||||||
|
"bookwyrm.activitystreams.populate_stream_task.delay"
|
||||||
|
), patch("bookwyrm.lists_stream.populate_lists_task.delay"):
|
||||||
|
self.remote_user_with_preview = models.User.objects.create_user(
|
||||||
|
"badger@your.domain.here",
|
||||||
|
"badger@badger.com",
|
||||||
|
"badgeword",
|
||||||
|
local=False,
|
||||||
|
remote_id="https://example.com/users/badger",
|
||||||
|
inbox="https://example.com/users/badger/inbox",
|
||||||
|
outbox="https://example.com/users/badger/outbox",
|
||||||
|
avatar=SimpleUploadedFile(
|
||||||
|
avatar_file,
|
||||||
|
open(avatar_file, "rb").read(),
|
||||||
|
content_type="image/jpeg",
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
self.work = models.Work.objects.create(title="Test Work")
|
self.work = models.Work.objects.create(title="Test Work")
|
||||||
self.edition = models.Edition.objects.create(
|
self.edition = models.Edition.objects.create(
|
||||||
title="Example Edition",
|
title="Example Edition",
|
||||||
|
@ -122,6 +154,14 @@ class PreviewImages(TestCase):
|
||||||
self.local_user.preview_image.height, settings.PREVIEW_IMG_HEIGHT
|
self.local_user.preview_image.height, settings.PREVIEW_IMG_HEIGHT
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def test_remote_user_preview(self, *args, **kwargs):
|
||||||
|
"""a remote user doesn’t get a user preview"""
|
||||||
|
generate_user_preview_image_task(self.remote_user.id)
|
||||||
|
|
||||||
|
self.remote_user.refresh_from_db()
|
||||||
|
|
||||||
|
self.assertFalse(self.remote_user.preview_image)
|
||||||
|
|
||||||
def test_generate_user_preview_images_task(self, *args, **kwargs):
|
def test_generate_user_preview_images_task(self, *args, **kwargs):
|
||||||
"""test task's external calls"""
|
"""test task's external calls"""
|
||||||
with patch("bookwyrm.preview_images.generate_preview_image") as generate_mock:
|
with patch("bookwyrm.preview_images.generate_preview_image") as generate_mock:
|
||||||
|
@ -129,3 +169,11 @@ class PreviewImages(TestCase):
|
||||||
args = generate_mock.call_args.kwargs
|
args = generate_mock.call_args.kwargs
|
||||||
self.assertEqual(args["texts"]["text_one"], "possum")
|
self.assertEqual(args["texts"]["text_one"], "possum")
|
||||||
self.assertEqual(args["texts"]["text_three"], f"@possum@{settings.DOMAIN}")
|
self.assertEqual(args["texts"]["text_three"], f"@possum@{settings.DOMAIN}")
|
||||||
|
|
||||||
|
def test_remove_user_preview_image_task(self, *args, **kwargs):
|
||||||
|
"""you can delete the preview image for a (remote) user"""
|
||||||
|
remove_user_preview_image_task(self.remote_user_with_preview.id)
|
||||||
|
|
||||||
|
self.remote_user_with_preview.refresh_from_db()
|
||||||
|
|
||||||
|
self.assertFalse(self.remote_user_with_preview.preview_image)
|
||||||
|
|
4
bw-dev
4
bw-dev
|
@ -228,6 +228,9 @@ case "$CMD" in
|
||||||
generate_preview_images)
|
generate_preview_images)
|
||||||
runweb python manage.py generate_preview_images "$@"
|
runweb python manage.py generate_preview_images "$@"
|
||||||
;;
|
;;
|
||||||
|
remove_remote_user_preview_images)
|
||||||
|
runweb python manage.py remove_remote_user_preview_images
|
||||||
|
;;
|
||||||
copy_media_to_s3)
|
copy_media_to_s3)
|
||||||
awscommand "bookwyrm_media_volume:/images"\
|
awscommand "bookwyrm_media_volume:/images"\
|
||||||
"s3 cp /images s3://${AWS_STORAGE_BUCKET_NAME}/images\
|
"s3 cp /images s3://${AWS_STORAGE_BUCKET_NAME}/images\
|
||||||
|
@ -307,6 +310,7 @@ case "$CMD" in
|
||||||
echo " populate_suggestions"
|
echo " populate_suggestions"
|
||||||
echo " generate_thumbnails"
|
echo " generate_thumbnails"
|
||||||
echo " generate_preview_images [--all]"
|
echo " generate_preview_images [--all]"
|
||||||
|
echo " remove_remote_user_preview_images"
|
||||||
echo " copy_media_to_s3"
|
echo " copy_media_to_s3"
|
||||||
echo " sync_media_to_s3"
|
echo " sync_media_to_s3"
|
||||||
echo " set_cors_to_s3 [cors file]"
|
echo " set_cors_to_s3 [cors file]"
|
||||||
|
|
|
@ -32,6 +32,7 @@ populate_lists_streams \
|
||||||
populate_suggestions \
|
populate_suggestions \
|
||||||
generate_thumbnails \
|
generate_thumbnails \
|
||||||
generate_preview_images \
|
generate_preview_images \
|
||||||
|
remove_remote_user_preview_images \
|
||||||
copy_media_to_s3 \
|
copy_media_to_s3 \
|
||||||
set_cors_to_s3 \
|
set_cors_to_s3 \
|
||||||
setup \
|
setup \
|
||||||
|
@ -71,7 +72,8 @@ __bw_complete "$commands" "populate_streams" "populate the main streams"
|
||||||
__bw_complete "$commands" "populate_lists_streams" "populate streams for book lists"
|
__bw_complete "$commands" "populate_lists_streams" "populate streams for book lists"
|
||||||
__bw_complete "$commands" "populate_suggestions" "populate book suggestions"
|
__bw_complete "$commands" "populate_suggestions" "populate book suggestions"
|
||||||
__bw_complete "$commands" "generate_thumbnails" "generate book thumbnails"
|
__bw_complete "$commands" "generate_thumbnails" "generate book thumbnails"
|
||||||
__bw_complete "$commands" "generate_preview_images" "generate book preview images"
|
__bw_complete "$commands" "generate_preview_images" "generate site/book/user preview images"
|
||||||
|
__bw_complete "$commands" "remove_remote_user_preview_images" "remove preview images for remote users"
|
||||||
__bw_complete "$commands" "collectstatic_watch" "watch filesystem and copy changed static files"
|
__bw_complete "$commands" "collectstatic_watch" "watch filesystem and copy changed static files"
|
||||||
__bw_complete "$commands" "copy_media_to_s3" "run the `s3 cp` command to copy media to a bucket on S3"
|
__bw_complete "$commands" "copy_media_to_s3" "run the `s3 cp` command to copy media to a bucket on S3"
|
||||||
__bw_complete "$commands" "sync_media_to_s3" "run the `s3 sync` command to sync media with a bucket on S3"
|
__bw_complete "$commands" "sync_media_to_s3" "run the `s3 sync` command to sync media with a bucket on S3"
|
||||||
|
|
|
@ -29,6 +29,7 @@ populate_lists_streams
|
||||||
populate_suggestions
|
populate_suggestions
|
||||||
generate_thumbnails
|
generate_thumbnails
|
||||||
generate_preview_images
|
generate_preview_images
|
||||||
|
remove_remote_user_preview_images
|
||||||
copy_media_to_s3
|
copy_media_to_s3
|
||||||
set_cors_to_s3
|
set_cors_to_s3
|
||||||
setup
|
setup
|
||||||
|
|
|
@ -31,6 +31,7 @@ populate_lists_streams
|
||||||
populate_suggestions
|
populate_suggestions
|
||||||
generate_thumbnails
|
generate_thumbnails
|
||||||
generate_preview_images
|
generate_preview_images
|
||||||
|
remove_remote_user_preview_images
|
||||||
copy_media_to_s3
|
copy_media_to_s3
|
||||||
set_cors_to_s3
|
set_cors_to_s3
|
||||||
setup
|
setup
|
||||||
|
|
Loading…
Reference in a new issue