/
models.py
1335 lines (1103 loc) · 47.1 KB
/
models.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import hashlib
import itertools
import logging
import os.path
import re
import time
from collections import OrderedDict, defaultdict
from concurrent.futures import ThreadPoolExecutor
from contextlib import contextmanager
from io import BytesIO
from tempfile import SpooledTemporaryFile
from typing import Any, Dict, Iterable, List, Optional, Union
import willow
from django.apps import apps
from django.conf import settings
from django.core import checks
from django.core.cache import DEFAULT_CACHE_ALIAS, InvalidCacheBackendError, caches
from django.core.cache.backends.base import BaseCache
from django.core.files import File
from django.core.files.base import ContentFile
from django.core.files.storage import default_storage
from django.db import models
from django.db.models import Q
from django.forms.utils import flatatt
from django.urls import reverse
from django.utils.functional import cached_property, classproperty
from django.utils.module_loading import import_string
from django.utils.safestring import mark_safe
from django.utils.translation import gettext_lazy as _
from taggit.managers import TaggableManager
from wagtail import hooks
from wagtail.coreutils import string_to_ascii
from wagtail.images.exceptions import (
InvalidFilterSpecError,
UnknownOutputImageFormatError,
)
from wagtail.images.fields import image_format_name_to_content_type
from wagtail.images.image_operations import (
FilterOperation,
FormatOperation,
ImageTransform,
TransformOperation,
)
from wagtail.images.rect import Rect
from wagtail.models import CollectionMember, ReferenceIndex
from wagtail.search import index
from wagtail.search.queryset import SearchableQuerySetMixin
from wagtail.utils.file import hash_filelike
logger = logging.getLogger("wagtail.images")
IMAGE_FORMAT_EXTENSIONS = {
"avif": ".avif",
"jpeg": ".jpg",
"png": ".png",
"gif": ".gif",
"webp": ".webp",
"svg": ".svg",
}
class SourceImageIOError(IOError):
"""
Custom exception to distinguish IOErrors that were thrown while opening the source image
"""
pass
class ImageQuerySet(SearchableQuerySetMixin, models.QuerySet):
def prefetch_renditions(self, *filters):
"""
Prefetches generated renditions for the given filters.
Returns all renditions when no filters are provided.
"""
rendition_model = self.model.get_rendition_model()
queryset = rendition_model.objects.all()
if filters:
# Get a list of filter spec strings. The given value could contain Filter objects
filter_specs = [
filter.spec if isinstance(filter, Filter) else filter
for filter in filters
]
queryset = queryset.filter(filter_spec__in=filter_specs)
return self.prefetch_related(
models.Prefetch(
"renditions",
queryset=queryset,
to_attr="prefetched_renditions",
)
)
def get_upload_to(instance, filename):
"""
Obtain a valid upload path for an image file.
This needs to be a module-level function so that it can be referenced within migrations,
but simply delegates to the `get_upload_to` method of the instance, so that AbstractImage
subclasses can override it.
"""
return instance.get_upload_to(filename)
def get_rendition_upload_to(instance, filename):
"""
Obtain a valid upload path for an image rendition file.
This needs to be a module-level function so that it can be referenced within migrations,
but simply delegates to the `get_upload_to` method of the instance, so that AbstractRendition
subclasses can override it.
"""
return instance.get_upload_to(filename)
def get_rendition_storage():
"""
Obtain the storage object for an image rendition file.
Returns custom storage (if defined), or the default storage.
This needs to be a module-level function, because we do not yet
have an instance when Django loads the models.
"""
storage = getattr(settings, "WAGTAILIMAGES_RENDITION_STORAGE", default_storage)
if isinstance(storage, str):
module = import_string(storage)
storage = module()
return storage
class ImageFileMixin:
def is_stored_locally(self):
"""
Returns True if the image is hosted on the local filesystem
"""
try:
self.file.path
return True
except NotImplementedError:
return False
def get_file_size(self):
if self.file_size is None:
try:
self.file_size = self.file.size
except Exception as e: # noqa: BLE001
# File not found
#
# Have to catch everything, because the exception
# depends on the file subclass, and therefore the
# storage being used.
raise SourceImageIOError(str(e))
self.save(update_fields=["file_size"])
return self.file_size
@contextmanager
def open_file(self):
# Open file if it is closed
close_file = False
try:
image_file = self.file
if self.file.closed:
# Reopen the file
if self.is_stored_locally():
self.file.open("rb")
else:
# Some external storage backends don't allow reopening
# the file. Get a fresh file instance. #1397
storage = self._meta.get_field("file").storage
image_file = storage.open(self.file.name, "rb")
close_file = True
except OSError as e:
# re-throw this as a SourceImageIOError so that calling code can distinguish
# these from IOErrors elsewhere in the process
raise SourceImageIOError(str(e))
# Seek to beginning
image_file.seek(0)
try:
yield image_file
finally:
if close_file:
image_file.close()
@contextmanager
def get_willow_image(self):
with self.open_file() as image_file:
yield willow.Image.open(image_file)
class WagtailImageFieldFile(models.fields.files.ImageFieldFile):
"""
Override the ImageFieldFile in order to use Willow instead
of Pillow.
"""
def _get_image_dimensions(self):
"""
override _get_image_dimensions to call our own get_image_dimensions.
"""
if not hasattr(self, "_dimensions_cache"):
self._dimensions_cache = self.get_image_dimensions()
return self._dimensions_cache
def get_image_dimensions(self):
"""
The upstream ImageFieldFile calls a local function get_image_dimensions. In this implementation we've made get_image_dimensions
a method to make it easier to override for Wagtail developers in the future.
"""
close = self.closed
try:
self.open()
image = willow.Image.open(self)
return image.get_size()
finally:
if close:
self.close()
else:
self.seek(0)
class WagtailImageField(models.ImageField):
"""
Override the attr_class on the Django ImageField Model to inject our ImageFieldFile
with Willow support.
"""
attr_class = WagtailImageFieldFile
class AbstractImage(ImageFileMixin, CollectionMember, index.Indexed, models.Model):
title = models.CharField(max_length=255, verbose_name=_("title"))
""" Use local ImageField with Willow support. """
file = WagtailImageField(
verbose_name=_("file"),
upload_to=get_upload_to,
width_field="width",
height_field="height",
)
width = models.IntegerField(verbose_name=_("width"), editable=False)
height = models.IntegerField(verbose_name=_("height"), editable=False)
created_at = models.DateTimeField(
verbose_name=_("created at"), auto_now_add=True, db_index=True
)
uploaded_by_user = models.ForeignKey(
settings.AUTH_USER_MODEL,
verbose_name=_("uploaded by user"),
null=True,
blank=True,
editable=False,
on_delete=models.SET_NULL,
)
uploaded_by_user.wagtail_reference_index_ignore = True
tags = TaggableManager(help_text=None, blank=True, verbose_name=_("tags"))
focal_point_x = models.PositiveIntegerField(null=True, blank=True)
focal_point_y = models.PositiveIntegerField(null=True, blank=True)
focal_point_width = models.PositiveIntegerField(null=True, blank=True)
focal_point_height = models.PositiveIntegerField(null=True, blank=True)
file_size = models.PositiveIntegerField(null=True, editable=False)
# A SHA-1 hash of the file contents
file_hash = models.CharField(
max_length=40, blank=True, editable=False, db_index=True
)
objects = ImageQuerySet.as_manager()
def _set_file_hash(self):
with self.open_file() as f:
self.file_hash = hash_filelike(f)
def get_file_hash(self):
if self.file_hash == "":
self._set_file_hash()
self.save(update_fields=["file_hash"])
return self.file_hash
def _set_image_file_metadata(self):
self.file.open()
# Set new image file size
self.file_size = self.file.size
# Set new image file hash
self._set_file_hash()
self.file.seek(0)
def get_upload_to(self, filename):
"""
Generates a file path in the "original_images" folder.
Ensuring ASCII characters and limiting length to prevent filesystem issues during uploads.
"""
folder_name = "original_images"
filename = self.file.field.storage.get_valid_name(filename)
# convert the filename to simple ascii characters and then
# replace non-ascii characters in filename with _ , to sidestep issues with filesystem encoding
filename = "".join(
(i if ord(i) < 128 else "_") for i in string_to_ascii(filename)
)
# Truncate filename so it fits in the 100 character limit
# https://code.djangoproject.com/ticket/9893
full_path = os.path.join(folder_name, filename)
if len(full_path) >= 95:
chars_to_trim = len(full_path) - 94
prefix, extension = os.path.splitext(filename)
filename = prefix[:-chars_to_trim] + extension
full_path = os.path.join(folder_name, filename)
return full_path
def get_usage(self):
return ReferenceIndex.get_grouped_references_to(self)
@property
def usage_url(self):
return reverse("wagtailimages:image_usage", args=(self.id,))
search_fields = CollectionMember.search_fields + [
index.SearchField("title", boost=10),
index.AutocompleteField("title"),
index.FilterField("title"),
index.RelatedFields(
"tags",
[
index.SearchField("name", boost=10),
index.AutocompleteField("name"),
],
),
index.FilterField("uploaded_by_user"),
index.FilterField("created_at"),
index.FilterField("id"),
]
def __str__(self):
return self.title
def get_rect(self):
return Rect(0, 0, self.width, self.height)
def get_focal_point(self):
if (
self.focal_point_x is not None
and self.focal_point_y is not None
and self.focal_point_width is not None
and self.focal_point_height is not None
):
return Rect.from_point(
self.focal_point_x,
self.focal_point_y,
self.focal_point_width,
self.focal_point_height,
)
def has_focal_point(self):
return self.get_focal_point() is not None
def set_focal_point(self, rect):
if rect is not None:
self.focal_point_x = rect.centroid_x
self.focal_point_y = rect.centroid_y
self.focal_point_width = rect.width
self.focal_point_height = rect.height
else:
self.focal_point_x = None
self.focal_point_y = None
self.focal_point_width = None
self.focal_point_height = None
def get_suggested_focal_point(self):
if self.is_svg():
# We can't run feature detection on SVGs, and don't provide a
# pathway from SVG -> raster formats, so don't try it.
return None
with self.get_willow_image() as willow:
faces = willow.detect_faces()
if faces:
# Create a bounding box around all faces
left = min(face[0] for face in faces)
top = min(face[1] for face in faces)
right = max(face[2] for face in faces)
bottom = max(face[3] for face in faces)
focal_point = Rect(left, top, right, bottom)
else:
features = willow.detect_features()
if features:
# Create a bounding box around all features
left = min(feature[0] for feature in features)
top = min(feature[1] for feature in features)
right = max(feature[0] for feature in features)
bottom = max(feature[1] for feature in features)
focal_point = Rect(left, top, right, bottom)
else:
return None
# Add 20% to width and height and give it a minimum size
x, y = focal_point.centroid
width, height = focal_point.size
width *= 1.20
height *= 1.20
width = max(width, 100)
height = max(height, 100)
return Rect.from_point(x, y, width, height)
@classmethod
def get_rendition_model(cls):
"""Get the Rendition model for this Image model"""
return cls.renditions.rel.related_model
def _get_prefetched_renditions(self) -> Union[Iterable["AbstractRendition"], None]:
if "renditions" in getattr(self, "_prefetched_objects_cache", {}):
return self.renditions.all()
return getattr(self, "prefetched_renditions", None)
def _add_to_prefetched_renditions(self, rendition: "AbstractRendition") -> None:
# Reuse this rendition if requested again from this object
try:
self._prefetched_objects_cache["renditions"]._result_cache.append(rendition)
except (AttributeError, KeyError):
pass
try:
self.prefetched_renditions.append(rendition)
except AttributeError:
pass
def get_rendition(self, filter: Union["Filter", str]) -> "AbstractRendition":
"""
Returns a ``Rendition`` instance with a ``file`` field value (an
image) reflecting the supplied ``filter`` value and focal point values
from this object.
Note: If using custom image models, an instance of the custom rendition
model will be returned.
"""
Rendition = self.get_rendition_model()
if isinstance(filter, str):
filter = Filter(spec=filter)
try:
rendition = self.find_existing_rendition(filter)
except Rendition.DoesNotExist:
rendition = self.create_rendition(filter)
# Reuse this rendition if requested again from this object
self._add_to_prefetched_renditions(rendition)
cache_key = Rendition.construct_cache_key(
self, filter.get_cache_key(self), filter.spec
)
Rendition.cache_backend.set(cache_key, rendition)
return rendition
def find_existing_rendition(self, filter: "Filter") -> "AbstractRendition":
"""
Returns an existing ``Rendition`` instance with a ``file`` field value
(an image) reflecting the supplied ``filter`` value and focal point
values from this object.
If no such rendition exists, a ``DoesNotExist`` error is raised for the
relevant model.
Note: If using custom image models, an instance of the custom rendition
model will be returned.
"""
Rendition = self.get_rendition_model()
try:
return self.find_existing_renditions(filter)[filter]
except KeyError:
raise Rendition.DoesNotExist
def create_rendition(self, filter: "Filter") -> "AbstractRendition":
"""
Creates and returns a ``Rendition`` instance with a ``file`` field
value (an image) reflecting the supplied ``filter`` value and focal
point values from this object.
This method is usually called by ``Image.get_rendition()``, after first
checking that a suitable rendition does not already exist.
Note: If using custom image models, an instance of the custom rendition
model will be returned.
"""
# Because of unique constraints applied to the model, we use
# get_or_create() to guard against race conditions
rendition, created = self.renditions.get_or_create(
filter_spec=filter.spec,
focal_point_key=filter.get_cache_key(self),
defaults={"file": self.generate_rendition_file(filter)},
)
return rendition
def get_renditions(
self, *filters: Union["Filter", str]
) -> Dict[str, "AbstractRendition"]:
"""
Returns a ``dict`` of ``Rendition`` instances with image files reflecting
the supplied ``filters``, keyed by filter spec patterns.
Note: If using custom image models, instances of the custom rendition
model will be returned.
"""
Rendition = self.get_rendition_model()
# We don’t support providing mixed Filter and string arguments in the same call.
if isinstance(filters[0], str):
filters = [Filter(spec) for spec in dict.fromkeys(filters).keys()]
# Find existing renditions where possible
renditions = self.find_existing_renditions(*filters)
# Create any renditions not found in prefetched values, cache or database
not_found = [f for f in filters if f not in renditions]
for filter, rendition in self.create_renditions(*not_found).items():
self._add_to_prefetched_renditions(rendition)
renditions[filter] = rendition
# Update the cache
cache_additions = {
Rendition.construct_cache_key(
self, filter.get_cache_key(self), filter.spec
): rendition
for filter, rendition in renditions.items()
# prevent writing of cached data back to the cache
if not getattr(rendition, "_from_cache", False)
}
if cache_additions:
Rendition.cache_backend.set_many(cache_additions)
# Make sure key insertion order matches the input order.
return {filter.spec: renditions[filter] for filter in filters}
def find_existing_renditions(
self, *filters: "Filter"
) -> Dict["Filter", "AbstractRendition"]:
"""
Returns a dictionary of existing ``Rendition`` instances with ``file``
values (images) reflecting the supplied ``filters`` and the focal point
values from this object.
Filters for which an existing rendition cannot be found are omitted
from the return value. If none of the requested renditions have been
created before, the return value will be an empty dict.
"""
Rendition = self.get_rendition_model()
filters_by_spec: Dict[str, Filter] = {f.spec: f for f in filters}
found: Dict[Filter, AbstractRendition] = {}
# Interrogate prefetched values first (where available)
prefetched_renditions = self._get_prefetched_renditions()
if prefetched_renditions is not None:
# NOTE: When renditions are prefetched, it's assumed that if the
# requested renditions exist, they will be present in the
# prefetched value, and further cache/database lookups are avoided.
# group renditions by the filters of interest
potential_matches: Dict[Filter, List[AbstractRendition]] = defaultdict(list)
for rendition in prefetched_renditions:
try:
filter = filters_by_spec[rendition.filter_spec]
except KeyError:
continue # this rendition can be ignored
else:
potential_matches[filter].append(rendition)
# For each filter we have renditions for, look for one with a
# 'focal_point_key' value matching filter.get_cache_key()
for filter, renditions in potential_matches.items():
focal_point_key = filter.get_cache_key(self)
for rendition in renditions:
if rendition.focal_point_key == focal_point_key:
# to prevent writing of cached data back to the cache
rendition._from_cache = True
# use this rendition
found[filter] = rendition
# skip to the next filter
break
else:
# Renditions are not prefetched, so attempt to find suitable
# items in the cache or database
# Query the cache first
cache_keys = [
Rendition.construct_cache_key(self, filter.get_cache_key(self), spec)
for spec, filter in filters_by_spec.items()
]
for rendition in Rendition.cache_backend.get_many(cache_keys).values():
filter = filters_by_spec[rendition.filter_spec]
found[filter] = rendition
# For items not found in the cache, look in the database
not_found = [f for f in filters if f not in found]
if not_found:
lookup_q = Q()
for filter in not_found:
lookup_q |= Q(
filter_spec=filter.spec,
focal_point_key=filter.get_cache_key(self),
)
for rendition in self.renditions.filter(lookup_q):
filter = filters_by_spec[rendition.filter_spec]
found[filter] = rendition
return found
def create_renditions(
self, *filters: "Filter"
) -> Dict["Filter", "AbstractRendition"]:
"""
Creates multiple ``Rendition`` instances with image files reflecting the supplied
``filters``, and returns them as a ``dict`` keyed by the relevant ``Filter`` instance.
Where suitable renditions already exist in the database, they will be returned instead,
so as not to create duplicates.
This method is usually called by ``Image.get_renditions()``, after first
checking that a suitable rendition does not already exist.
Note: If using custom image models, an instance of the custom rendition
model will be returned.
"""
Rendition = self.get_rendition_model()
if not filters:
return {}
if len(filters) == 1:
# create_rendition() is better for single renditions, as it can
# utilize QuerySet.get_or_create(), which has better handling of
# race conditions
filter = filters[0]
return {filter: self.create_rendition(filter)}
return_value: Dict[Filter, AbstractRendition] = {}
filter_map: Dict[str, Filter] = {f.spec: f for f in filters}
with self.open_file() as file:
original_image_bytes = file.read()
to_create = []
def _generate_single_rendition(filter):
# Using ContentFile here ensures we generate all renditions. Simply
# passing self.file required several page reloads to generate all
image_file = self.generate_rendition_file(
filter, source=ContentFile(original_image_bytes, name=self.file.name)
)
to_create.append(
Rendition(
image=self,
filter_spec=filter.spec,
focal_point_key=filter.get_cache_key(self),
file=image_file,
)
)
with ThreadPoolExecutor() as executor:
executor.map(_generate_single_rendition, filters)
# Rendition generation can take a while. So, if other processes have created
# identical renditions in the meantime, we should find them to avoid clashes.
# NB: Clashes can still occur, because there is no get_or_create() equivalent
# for multiple objects. However, this will reduce that risk considerably.
files_for_deletion: List[File] = []
# Assemble Q() to identify potential clashes
lookup_q = Q()
for rendition in to_create:
lookup_q |= Q(
filter_spec=rendition.filter_spec,
focal_point_key=rendition.focal_point_key,
)
for existing in self.renditions.filter(lookup_q):
# Include the existing rendition in the return value
filter = filter_map[existing.filter_spec]
return_value[filter] = existing
for new in to_create:
if (
new.filter_spec == existing.filter_spec
and new.focal_point_key == existing.focal_point_key
):
# Avoid creating the new version
to_create.remove(new)
# Mark for deletion later, so as not to hold up creation
files_for_deletion.append(new.file)
for new in Rendition.objects.bulk_create(to_create, ignore_conflicts=True):
filter = filter_map[new.filter_spec]
return_value[filter] = new
# Delete redundant rendition image files
for file in files_for_deletion:
file.delete(save=False)
return return_value
def generate_rendition_file(self, filter: "Filter", *, source: File = None) -> File:
"""
Generates an in-memory image matching the supplied ``filter`` value
and focal point value from this object, wraps it in a ``File`` object
with a suitable filename, and returns it. The return value is used
as the ``file`` field value for rendition objects saved by
``AbstractImage.create_rendition()``.
If the contents of ``self.file`` has already been read into memory, the
``source`` keyword can be used to provide a reference to the in-memory
``File``, bypassing the need to reload the image contents from storage.
NOTE: The responsibility of generating the new image from the original
falls to the supplied ``filter`` object. If you want to do anything
custom with rendition images (for example, to preserve metadata from
the original image), you might want to consider swapping out ``filter``
for an instance of a custom ``Filter`` subclass of your design.
"""
cache_key = filter.get_cache_key(self)
logger.debug(
"Generating '%s' rendition for image %d",
filter.spec,
self.pk,
)
start_time = time.time()
try:
generated_image = filter.run(
self,
SpooledTemporaryFile(max_size=settings.FILE_UPLOAD_MAX_MEMORY_SIZE),
source=source,
)
logger.debug(
"Generated '%s' rendition for image %d in %.1fms",
filter.spec,
self.pk,
(time.time() - start_time) * 1000,
)
except: # noqa:B901,E722
logger.debug(
"Failed to generate '%s' rendition for image %d",
filter.spec,
self.pk,
)
raise
# Generate filename
input_filename = os.path.basename(self.file.name)
input_filename_without_extension, input_extension = os.path.splitext(
input_filename
)
output_extension = (
filter.spec.replace("|", ".")
+ IMAGE_FORMAT_EXTENSIONS[generated_image.format_name]
)
if cache_key:
output_extension = cache_key + "." + output_extension
# Truncate filename to prevent it going over 60 chars
output_filename_without_extension = input_filename_without_extension[
: (59 - len(output_extension))
]
output_filename = output_filename_without_extension + "." + output_extension
return File(generated_image.f, name=output_filename)
def is_portrait(self):
return self.width < self.height
def is_landscape(self):
return self.height < self.width
def is_svg(self):
_, ext = os.path.splitext(self.file.name)
return ext.lower() == ".svg"
@property
def filename(self):
return os.path.basename(self.file.name)
@property
def default_alt_text(self):
# by default the alt text field (used in rich text insertion) is populated
# from the title. Subclasses might provide a separate alt field, and
# override this
return self.title
def is_editable_by_user(self, user):
from wagtail.images.permissions import permission_policy
return permission_policy.user_has_permission_for_instance(user, "change", self)
class Meta:
abstract = True
class Image(AbstractImage):
admin_form_fields = (
"title",
"file",
"collection",
"tags",
"focal_point_x",
"focal_point_y",
"focal_point_width",
"focal_point_height",
)
class Meta(AbstractImage.Meta):
verbose_name = _("image")
verbose_name_plural = _("images")
permissions = [
("choose_image", "Can choose image"),
]
class Filter:
"""
Represents one or more operations that can be applied to an Image to produce a rendition
appropriate for final display on the website. Usually this would be a resize operation,
but could potentially involve colour processing, etc.
"""
spec_pattern = re.compile(r"^[A-Za-z0-9_\-\.]+$")
pipe_spec_pattern = re.compile(r"^[A-Za-z0-9_\-\.\|]+$")
expanding_spec_pattern = re.compile(r"^[A-Za-z0-9_\-\.{},]+$")
pipe_expanding_spec_pattern = re.compile(r"^[A-Za-z0-9_\-\.{},\|]+$")
def __init__(self, spec=None):
# The spec pattern is operation1-var1-var2|operation2-var1
self.spec = spec
@classmethod
def expand_spec(self, spec: Union["str", Iterable["str"]]) -> List["str"]:
"""
Converts a spec pattern with brace-expansions, into a list of spec patterns.
For example, "width-{100,200}" becomes ["width-100", "width-200"].
Supports providing filter specs already split, or pipe or space-separated.
"""
if isinstance(spec, str):
separator = "|" if "|" in spec else " "
spec = spec.split(separator)
expanded_segments = []
for segment in spec:
# Check if segment has braces to expand
if "{" in segment and "}" in segment:
prefix, options_suffixed = segment.split("{")
options_pattern, suffix = options_suffixed.split("}")
options = options_pattern.split(",")
expanded_segments.append(
[prefix + option + suffix for option in options]
)
else:
expanded_segments.append([segment])
# Cartesian product of all expanded segments (equivalent to nested for loops).
combinations = itertools.product(*expanded_segments)
return ["|".join(combination) for combination in combinations]
@cached_property
def operations(self):
# Search for operations
registered_operations = {}
for fn in hooks.get_hooks("register_image_operations"):
registered_operations.update(dict(fn()))
# Build list of operation objects
operations = []
for op_spec in self.spec.split("|"):
op_spec_parts = op_spec.split("-")
if op_spec_parts[0] not in registered_operations:
raise InvalidFilterSpecError(
"Unrecognised operation: %s" % op_spec_parts[0]
)
op_class = registered_operations[op_spec_parts[0]]
operations.append(op_class(*op_spec_parts))
return operations
@property
def transform_operations(self):
return [
operation
for operation in self.operations
if isinstance(operation, TransformOperation)
]
@property
def filter_operations(self):
return [
operation
for operation in self.operations
if isinstance(operation, FilterOperation)
]
def get_transform(self, image, size=None):
"""
Returns an ImageTransform with all the transforms in this filter applied.
The ImageTransform is an object with two attributes:
- .size - The size of the final image
- .matrix - An affine transformation matrix that combines any
transform/scale/rotation operations that need to be applied to the image
"""
if not size:
size = (image.width, image.height)
transform = ImageTransform(size, image_is_svg=image.is_svg())
for operation in self.transform_operations:
transform = operation.run(transform, image)
return transform
@contextmanager
def get_willow_image(self, image: AbstractImage, source: File = None):
if source is not None:
yield willow.Image.open(source)
else:
with image.get_willow_image() as willow_image:
yield willow_image
def run(self, image: AbstractImage, output: BytesIO, source: File = None):
with self.get_willow_image(image, source) as willow:
original_format = willow.format_name
# Fix orientation of image
willow = willow.auto_orient()
# Transform the image
transform = self.get_transform(
image, (willow.image.width, willow.image.height)
)
willow = willow.crop(transform.get_rect().round())
willow = willow.resize(transform.size)
# Apply filters
env = {
"original-format": original_format,
}
for operation in self.filter_operations:
willow = operation.run(willow, image, env) or willow
# Find the output format to use
if "output-format" in env:
# Developer specified an output format
output_format = env["output-format"]
else:
# Convert bmp and webp to png by default
default_conversions = {
"avif": "png",
"bmp": "png",
"webp": "png",
}
# Convert unanimated GIFs to PNG as well
if not willow.has_animation():
default_conversions["gif"] = "png"
# Allow the user to override the conversions
conversion = getattr(settings, "WAGTAILIMAGES_FORMAT_CONVERSIONS", {})
default_conversions.update(conversion)
# Get the converted output format falling back to the original
output_format = default_conversions.get(
original_format, original_format
)
if output_format == "jpeg":
# Allow changing of JPEG compression quality
if "jpeg-quality" in env:
quality = env["jpeg-quality"]
else:
quality = getattr(settings, "WAGTAILIMAGES_JPEG_QUALITY", 85)
# If the image has an alpha channel, give it a white background