forked from django-oscar/django-oscar
/
abstract_models.py
1427 lines (1211 loc) · 50.2 KB
/
abstract_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 logging
import os
from datetime import date, datetime
from django.conf import settings
from django.contrib.contenttypes.fields import GenericForeignKey
from django.contrib.contenttypes.models import ContentType
from django.contrib.staticfiles.finders import find
from django.core.cache import cache
from django.core.exceptions import ImproperlyConfigured, ValidationError
from django.core.files.base import File
from django.core.validators import RegexValidator
from django.db import models
from django.db.models import Count, Exists, OuterRef, Sum
from django.db.models.fields import Field
from django.db.models.lookups import StartsWith
from django.template.defaultfilters import striptags
from django.urls import reverse
from django.utils.functional import cached_property
from django.utils.html import strip_tags
from django.utils.safestring import mark_safe
from django.utils.translation import get_language
from django.utils.translation import gettext_lazy as _
from django.utils.translation import pgettext_lazy
from treebeard.mp_tree import MP_Node
from oscar.core.loading import get_class, get_classes, get_model
from oscar.core.utils import slugify
from oscar.core.validators import non_python_keyword
from oscar.models.fields import AutoSlugField, NullCharField
from oscar.models.fields.slugfield import SlugField
from oscar.utils.models import get_image_upload_path
CategoryQuerySet, ProductQuerySet = get_classes(
'catalogue.managers', ['CategoryQuerySet', 'ProductQuerySet'])
ProductAttributesContainer = get_class(
'catalogue.product_attributes', 'ProductAttributesContainer')
class ReverseStartsWith(StartsWith):
"""
Adds a new lookup method to the django query language, that allows the
following syntax::
henk__rstartswith="koe"
The regular version of startswith::
henk__startswith="koe"
Would be about the same as the python statement::
henk.startswith("koe")
ReverseStartsWith will flip the right and left hand side of the expression,
effectively making this the same query as::
"koe".startswith(henk)
"""
def process_rhs(self, compiler, connection):
return super().process_lhs(compiler, connection)
def process_lhs(self, compiler, connection, lhs=None):
if lhs is not None:
raise Exception("Flipped process_lhs does not accept lhs argument")
return super().process_rhs(compiler, connection)
Field.register_lookup(ReverseStartsWith, "rstartswith")
class AbstractProductClass(models.Model):
"""
Used for defining options and attributes for a subset of products.
E.g. Books, DVDs and Toys. A product can only belong to one product class.
At least one product class must be created when setting up a new
Oscar deployment.
Not necessarily equivalent to top-level categories but usually will be.
"""
name = models.CharField(_('Name'), max_length=128)
slug = AutoSlugField(_('Slug'), max_length=128, unique=True,
populate_from='name')
#: Some product type don't require shipping (e.g. digital products) - we use
#: this field to take some shortcuts in the checkout.
requires_shipping = models.BooleanField(_("Requires shipping?"),
default=True)
#: Digital products generally don't require their stock levels to be
#: tracked.
track_stock = models.BooleanField(_("Track stock levels?"), default=True)
#: These are the options (set by the user when they add to basket) for this
#: item class. For instance, a product class of "SMS message" would always
#: require a message to be specified before it could be bought.
#: Note that you can also set options on a per-product level.
options = models.ManyToManyField(
'catalogue.Option', blank=True, verbose_name=_("Options"))
class Meta:
abstract = True
app_label = 'catalogue'
ordering = ['name']
verbose_name = _("Product class")
verbose_name_plural = _("Product classes")
def __str__(self):
return self.name
@property
def has_attributes(self):
return self.attributes.exists()
class AbstractCategory(MP_Node):
"""
A product category. Merely used for navigational purposes; has no
effects on business logic.
Uses :py:mod:`django-treebeard`.
"""
#: Allow comparison of categories on a limited number of fields by ranges.
#: When the Category model is overwritten to provide CMS content, defining
#: this avoids fetching a lot of unneeded extra data from the database.
COMPARISON_FIELDS = ('pk', 'path', 'depth')
name = models.CharField(_('Name'), max_length=255, db_index=True)
description = models.TextField(_('Description'), blank=True)
meta_title = models.CharField(_('Meta title'), max_length=255, blank=True, null=True)
meta_description = models.TextField(_('Meta description'), blank=True, null=True)
image = models.ImageField(_('Image'), upload_to='categories', blank=True,
null=True, max_length=255)
slug = SlugField(_('Slug'), max_length=255, db_index=True)
is_public = models.BooleanField(
_('Is public'),
default=True,
db_index=True,
help_text=_("Show this category in search results and catalogue listings."))
ancestors_are_public = models.BooleanField(
_('Ancestor categories are public'),
default=True,
db_index=True,
help_text=_("The ancestors of this category are public"))
_slug_separator = '/'
_full_name_separator = ' > '
objects = CategoryQuerySet.as_manager()
def __str__(self):
return self.full_name
@property
def full_name(self):
"""
Returns a string representation of the category and it's ancestors,
e.g. 'Books > Non-fiction > Essential programming'.
It's rarely used in Oscar, but used to be stored as a CharField and is
hence kept for backwards compatibility. It's also sufficiently useful
to keep around.
"""
names = [category.name for category in self.get_ancestors_and_self()]
return self._full_name_separator.join(names)
def get_full_slug(self, parent_slug=None):
if self.is_root():
return self.slug
cache_key = self.get_url_cache_key()
full_slug = cache.get(cache_key)
if full_slug is None:
parent_slug = parent_slug if parent_slug is not None else self.get_parent().full_slug
full_slug = "%s%s%s" % (parent_slug, self._slug_separator, self.slug)
cache.set(cache_key, full_slug)
return full_slug
@property
def full_slug(self):
"""
Returns a string of this category's slug concatenated with the slugs
of it's ancestors, e.g. 'books/non-fiction/essential-programming'.
Oscar used to store this as in the 'slug' model field, but this field
has been re-purposed to only store this category's slug and to not
include it's ancestors' slugs.
"""
return self.get_full_slug()
def generate_slug(self):
"""
Generates a slug for a category. This makes no attempt at generating
a unique slug.
"""
return slugify(self.name)
def save(self, *args, **kwargs):
"""
Oscar traditionally auto-generated slugs from names. As that is
often convenient, we still do so if a slug is not supplied through
other means. If you want to control slug creation, just create
instances with a slug already set, or expose a field on the
appropriate forms.
"""
if not self.slug:
self.slug = self.generate_slug()
super().save(*args, **kwargs)
def set_ancestors_are_public(self):
# Update ancestors_are_public for the sub tree.
# note: This doesn't trigger a new save for each instance, rather
# just a SQL update.
included_in_non_public_subtree = self.__class__.objects.filter(
is_public=False, path__rstartswith=OuterRef("path"), depth__lt=OuterRef("depth")
)
self.get_descendants_and_self().update(
ancestors_are_public=Exists(
included_in_non_public_subtree.values("id"), negated=True))
# Correctly populate ancestors_are_public
self.refresh_from_db()
@classmethod
def fix_tree(cls, destructive=False):
super().fix_tree(destructive)
for node in cls.get_root_nodes():
# ancestors_are_public *must* be True for root nodes, or all trees
# will become non-public
if not node.ancestors_are_public:
node.ancestors_are_public = True
node.save()
else:
node.set_ancestors_are_public()
def get_meta_title(self):
return self.meta_title or self.name
def get_meta_description(self):
return self.meta_description or striptags(self.description)
def get_ancestors_and_self(self):
"""
Gets ancestors and includes itself. Use treebeard's get_ancestors
if you don't want to include the category itself. It's a separate
function as it's commonly used in templates.
"""
if self.is_root():
return [self]
return list(self.get_ancestors()) + [self]
def get_descendants_and_self(self):
"""
Gets descendants and includes itself. Use treebeard's get_descendants
if you don't want to include the category itself. It's a separate
function as it's commonly used in templates.
"""
return self.get_tree(self)
def get_url_cache_key(self):
current_locale = get_language()
cache_key = 'CATEGORY_URL_%s_%s' % (current_locale, self.pk)
return cache_key
def _get_absolute_url(self, parent_slug=None):
"""
Our URL scheme means we have to look up the category's ancestors. As
that is a bit more expensive, we cache the generated URL. That is
safe even for a stale cache, as the default implementation of
ProductCategoryView does the lookup via primary key anyway. But if
you change that logic, you'll have to reconsider the caching
approach.
"""
return reverse('catalogue:category', kwargs={
'category_slug': self.get_full_slug(parent_slug=parent_slug), 'pk': self.pk
})
def get_absolute_url(self):
return self._get_absolute_url()
class Meta:
abstract = True
app_label = 'catalogue'
ordering = ['path']
verbose_name = _('Category')
verbose_name_plural = _('Categories')
def has_children(self):
return self.get_num_children() > 0
def get_num_children(self):
return self.get_children().count()
class AbstractProductCategory(models.Model):
"""
Joining model between products and categories. Exists to allow customising.
"""
product = models.ForeignKey(
'catalogue.Product',
on_delete=models.CASCADE,
verbose_name=_("Product"))
category = models.ForeignKey(
'catalogue.Category',
on_delete=models.CASCADE,
verbose_name=_("Category"))
class Meta:
abstract = True
app_label = 'catalogue'
ordering = ['product', 'category']
unique_together = ('product', 'category')
verbose_name = _('Product category')
verbose_name_plural = _('Product categories')
def __str__(self):
return "<productcategory for product '%s'>" % self.product
class AbstractProduct(models.Model):
"""
The base product object
There's three kinds of products; they're distinguished by the structure
field.
- A stand alone product. Regular product that lives by itself.
- A child product. All child products have a parent product. They're a
specific version of the parent.
- A parent product. It essentially represents a set of products.
An example could be a yoga course, which is a parent product. The different
times/locations of the courses would be associated with the child products.
"""
STANDALONE, PARENT, CHILD = 'standalone', 'parent', 'child'
STRUCTURE_CHOICES = (
(STANDALONE, _('Stand-alone product')),
(PARENT, _('Parent product')),
(CHILD, _('Child product'))
)
structure = models.CharField(
_("Product structure"), max_length=10, choices=STRUCTURE_CHOICES,
default=STANDALONE)
is_public = models.BooleanField(
_('Is public'),
default=True,
db_index=True,
help_text=_("Show this product in search results and catalogue listings."))
upc = NullCharField(
_("UPC"), max_length=64, blank=True, null=True, unique=True,
help_text=_("Universal Product Code (UPC) is an identifier for "
"a product which is not specific to a particular "
" supplier. Eg an ISBN for a book."))
parent = models.ForeignKey(
'self',
blank=True,
null=True,
on_delete=models.CASCADE,
related_name='children',
verbose_name=_("Parent product"),
help_text=_("Only choose a parent product if you're creating a child "
"product. For example if this is a size "
"4 of a particular t-shirt. Leave blank if this is a "
"stand-alone product (i.e. there is only one version of"
" this product)."))
# Title is mandatory for canonical products but optional for child products
title = models.CharField(pgettext_lazy('Product title', 'Title'),
max_length=255, blank=True)
slug = SlugField(_('Slug'), max_length=255, unique=False)
description = models.TextField(_('Description'), blank=True)
meta_title = models.CharField(_('Meta title'), max_length=255, blank=True, null=True)
meta_description = models.TextField(_('Meta description'), blank=True, null=True)
#: "Kind" of product, e.g. T-Shirt, Book, etc.
#: None for child products, they inherit their parent's product class
product_class = models.ForeignKey(
'catalogue.ProductClass',
null=True,
blank=True,
on_delete=models.PROTECT,
verbose_name=_('Product type'), related_name="products",
help_text=_("Choose what type of product this is"))
attributes = models.ManyToManyField(
'catalogue.ProductAttribute',
through='ProductAttributeValue',
verbose_name=_("Attributes"),
help_text=_("A product attribute is something that this product may "
"have, such as a size, as specified by its class"))
#: It's possible to have options product class-wide, and per product.
product_options = models.ManyToManyField(
'catalogue.Option', blank=True, verbose_name=_("Product options"),
help_text=_("Options are values that can be associated with a item "
"when it is added to a customer's basket. This could be "
"something like a personalised message to be printed on "
"a T-shirt."))
recommended_products = models.ManyToManyField(
'catalogue.Product', through='ProductRecommendation', blank=True,
verbose_name=_("Recommended products"),
help_text=_("These are products that are recommended to accompany the "
"main product."))
# Denormalised product rating - used by reviews app.
# Product has no ratings if rating is None
rating = models.FloatField(_('Rating'), null=True, editable=False)
date_created = models.DateTimeField(
_("Date created"), auto_now_add=True, db_index=True)
# This field is used by Haystack to reindex search
date_updated = models.DateTimeField(
_("Date updated"), auto_now=True, db_index=True)
categories = models.ManyToManyField(
'catalogue.Category', through='ProductCategory',
verbose_name=_("Categories"))
#: Determines if a product may be used in an offer. It is illegal to
#: discount some types of product (e.g. ebooks) and this field helps
#: merchants from avoiding discounting such products
#: Note that this flag is ignored for child products; they inherit from
#: the parent product.
is_discountable = models.BooleanField(
_("Is discountable?"), default=True, help_text=_(
"This flag indicates if this product can be used in an offer "
"or not"))
objects = ProductQuerySet.as_manager()
class Meta:
abstract = True
app_label = 'catalogue'
ordering = ['-date_created']
verbose_name = _('Product')
verbose_name_plural = _('Products')
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.attr = ProductAttributesContainer(product=self)
def __str__(self):
if self.title:
return self.title
if self.attribute_summary:
return "%s (%s)" % (self.get_title(), self.attribute_summary)
else:
return self.get_title()
def get_absolute_url(self):
"""
Return a product's absolute URL
"""
return reverse('catalogue:detail',
kwargs={'product_slug': self.slug, 'pk': self.id})
def clean(self):
"""
Validate a product. Those are the rules:
+---------------+-------------+--------------+--------------+
| | stand alone | parent | child |
+---------------+-------------+--------------+--------------+
| title | required | required | optional |
+---------------+-------------+--------------+--------------+
| product class | required | required | must be None |
+---------------+-------------+--------------+--------------+
| parent | forbidden | forbidden | required |
+---------------+-------------+--------------+--------------+
| stockrecords | 0 or more | forbidden | 0 or more |
+---------------+-------------+--------------+--------------+
| categories | 1 or more | 1 or more | forbidden |
+---------------+-------------+--------------+--------------+
| attributes | optional | optional | optional |
+---------------+-------------+--------------+--------------+
| rec. products | optional | optional | unsupported |
+---------------+-------------+--------------+--------------+
| options | optional | optional | forbidden |
+---------------+-------------+--------------+--------------+
Because the validation logic is quite complex, validation is delegated
to the sub method appropriate for the product's structure.
"""
getattr(self, '_clean_%s' % self.structure)()
if not self.is_parent:
self.attr.validate_attributes()
def _clean_standalone(self):
"""
Validates a stand-alone product
"""
if not self.title:
raise ValidationError(_("Your product must have a title."))
if not self.product_class:
raise ValidationError(_("Your product must have a product class."))
if self.parent_id:
raise ValidationError(_("Only child products can have a parent."))
def _clean_child(self):
"""
Validates a child product
"""
if not self.parent_id:
raise ValidationError(_("A child product needs a parent."))
if self.parent_id and not self.parent.is_parent:
raise ValidationError(
_("You can only assign child products to parent products."))
if self.product_class:
raise ValidationError(
_("A child product can't have a product class."))
if self.pk and self.categories.exists():
raise ValidationError(
_("A child product can't have a category assigned."))
# Note that we only forbid options on product level
if self.pk and self.product_options.exists():
raise ValidationError(
_("A child product can't have options."))
def _clean_parent(self):
"""
Validates a parent product.
"""
self._clean_standalone()
if self.has_stockrecords:
raise ValidationError(
_("A parent product can't have stockrecords."))
def save(self, *args, **kwargs):
if not self.slug:
self.slug = slugify(self.get_title())
super().save(*args, **kwargs)
self.attr.save()
# Properties
@property
def is_standalone(self):
return self.structure == self.STANDALONE
@property
def is_parent(self):
return self.structure == self.PARENT
@property
def is_child(self):
return self.structure == self.CHILD
def can_be_parent(self, give_reason=False):
"""
Helps decide if a the product can be turned into a parent product.
"""
reason = None
if self.is_child:
reason = _('The specified parent product is a child product.')
if self.has_stockrecords:
reason = _(
"One can't add a child product to a product with stock"
" records.")
is_valid = reason is None
if give_reason:
return is_valid, reason
else:
return is_valid
@property
def options(self):
"""
Returns a set of all valid options for this product.
It's possible to have options product class-wide, and per product.
"""
pclass_options = self.get_product_class().options.all()
return pclass_options | self.product_options.all()
@cached_property
def has_options(self):
# Extracting annotated value with number of product class options
# from product list queryset.
has_product_class_options = getattr(self, 'has_product_class_options', None)
has_product_options = getattr(self, 'has_product_options', None)
if has_product_class_options is not None and has_product_options is not None:
return has_product_class_options or has_product_options
return self.options.exists()
@property
def is_shipping_required(self):
return self.get_product_class().requires_shipping
@property
def has_stockrecords(self):
"""
Test if this product has any stockrecords
"""
return self.stockrecords.exists()
@property
def num_stockrecords(self):
return self.stockrecords.count()
@property
def attribute_summary(self):
"""
Return a string of all of a product's attributes
"""
attributes = self.get_attribute_values()
pairs = [attribute.summary() for attribute in attributes]
return ", ".join(pairs)
def get_title(self):
"""
Return a product's title or it's parent's title if it has no title
"""
title = self.title
if not title and self.parent_id:
title = self.parent.title
return title
get_title.short_description = pgettext_lazy("Product title", "Title")
def get_meta_title(self):
title = self.meta_title
if not title and self.is_child:
title = self.parent.meta_title
return title or self.get_title()
get_meta_title.short_description = pgettext_lazy("Product meta title", "Meta title")
def get_meta_description(self):
meta_description = self.meta_description
if not meta_description and self.is_child:
meta_description = self.parent.meta_description
return meta_description or striptags(self.description)
get_meta_description.short_description = pgettext_lazy("Product meta description", "Meta description")
def get_product_class(self):
"""
Return a product's item class. Child products inherit their parent's.
"""
if self.is_child:
return self.parent.product_class
else:
return self.product_class
get_product_class.short_description = _("Product class")
def get_is_discountable(self):
"""
At the moment, :py:attr:`.is_discountable` can't be set individually for child
products; they inherit it from their parent.
"""
if self.is_child:
return self.parent.is_discountable
else:
return self.is_discountable
def get_categories(self):
"""
Return a product's public categories or parent's if there is a parent product.
"""
if self.is_child:
return self.parent.categories.browsable()
else:
return self.categories.browsable()
get_categories.short_description = _("Categories")
def get_attribute_values(self):
attribute_values = self.attribute_values.all()
if self.is_child:
parent_attribute_values = self.parent.attribute_values.exclude(
attribute__code__in=attribute_values.values("attribute__code")
)
return attribute_values | parent_attribute_values
return attribute_values
# Images
def get_missing_image(self):
"""
Returns a missing image object.
"""
# This class should have a 'name' property so it mimics the Django file
# field.
return MissingProductImage()
def get_all_images(self):
if self.is_child and not self.images.exists() and self.parent_id is not None:
return self.parent.images.all()
return self.images.all()
def primary_image(self):
"""
Returns the primary image for a product. Usually used when one can
only display one product image, e.g. in a list of products.
"""
images = self.get_all_images()
ordering = self.images.model.Meta.ordering
if not ordering or ordering[0] != 'display_order':
# Only apply order_by() if a custom model doesn't use default
# ordering. Applying order_by() busts the prefetch cache of
# the ProductManager
images = images.order_by('display_order')
try:
return images[0]
except IndexError:
# We return a dict with fields that mirror the key properties of
# the ProductImage class so this missing image can be used
# interchangeably in templates. Strategy pattern ftw!
missing_image = self.get_missing_image()
return {
'original': missing_image.name,
'caption': '',
'is_missing': True}
# Updating methods
def update_rating(self):
"""
Recalculate rating field
"""
self.rating = self.calculate_rating()
self.save()
update_rating.alters_data = True
def calculate_rating(self):
"""
Calculate rating value
"""
result = self.reviews.filter(
status=self.reviews.model.APPROVED
).aggregate(
sum=Sum('score'), count=Count('id'))
reviews_sum = result['sum'] or 0
reviews_count = result['count'] or 0
rating = None
if reviews_count > 0:
rating = float(reviews_sum) / reviews_count
return rating
def has_review_by(self, user):
if user.is_anonymous:
return False
return self.reviews.filter(user=user).exists()
def is_review_permitted(self, user):
"""
Determines whether a user may add a review on this product.
Default implementation respects OSCAR_ALLOW_ANON_REVIEWS and only
allows leaving one review per user and product.
Override this if you want to alter the default behaviour; e.g. enforce
that a user purchased the product to be allowed to leave a review.
"""
if user.is_authenticated or settings.OSCAR_ALLOW_ANON_REVIEWS:
return not self.has_review_by(user)
else:
return False
@cached_property
def num_approved_reviews(self):
return self.reviews.approved().count()
@property
def sorted_recommended_products(self):
"""Keeping order by recommendation ranking."""
return [r.recommendation for r in self.primary_recommendations
.select_related('recommendation').all()]
class AbstractProductRecommendation(models.Model):
"""
'Through' model for product recommendations
"""
primary = models.ForeignKey(
'catalogue.Product',
on_delete=models.CASCADE,
related_name='primary_recommendations',
verbose_name=_("Primary product"))
recommendation = models.ForeignKey(
'catalogue.Product',
on_delete=models.CASCADE,
verbose_name=_("Recommended product"))
ranking = models.PositiveSmallIntegerField(
_('Ranking'), default=0, db_index=True,
help_text=_('Determines order of the products. A product with a higher'
' value will appear before one with a lower ranking.'))
class Meta:
abstract = True
app_label = 'catalogue'
ordering = ['primary', '-ranking']
unique_together = ('primary', 'recommendation')
verbose_name = _('Product recommendation')
verbose_name_plural = _('Product recomendations')
class AbstractProductAttribute(models.Model):
"""
Defines an attribute for a product class. (For example, number_of_pages for
a 'book' class)
"""
product_class = models.ForeignKey(
'catalogue.ProductClass',
blank=True,
on_delete=models.CASCADE,
related_name='attributes',
null=True,
verbose_name=_("Product type"))
name = models.CharField(_('Name'), max_length=128)
code = models.SlugField(
_('Code'), max_length=128,
validators=[
RegexValidator(
regex=r'^[a-zA-Z_][0-9a-zA-Z_]*$',
message=_(
"Code can only contain the letters a-z, A-Z, digits, "
"and underscores, and can't start with a digit.")),
non_python_keyword
])
# Attribute types
TEXT = "text"
INTEGER = "integer"
BOOLEAN = "boolean"
FLOAT = "float"
RICHTEXT = "richtext"
DATE = "date"
DATETIME = "datetime"
OPTION = "option"
MULTI_OPTION = "multi_option"
ENTITY = "entity"
FILE = "file"
IMAGE = "image"
TYPE_CHOICES = (
(TEXT, _("Text")),
(INTEGER, _("Integer")),
(BOOLEAN, _("True / False")),
(FLOAT, _("Float")),
(RICHTEXT, _("Rich Text")),
(DATE, _("Date")),
(DATETIME, _("Datetime")),
(OPTION, _("Option")),
(MULTI_OPTION, _("Multi Option")),
(ENTITY, _("Entity")),
(FILE, _("File")),
(IMAGE, _("Image")),
)
type = models.CharField(
choices=TYPE_CHOICES, default=TYPE_CHOICES[0][0],
max_length=20, verbose_name=_("Type"))
option_group = models.ForeignKey(
'catalogue.AttributeOptionGroup',
blank=True,
null=True,
on_delete=models.CASCADE,
related_name='product_attributes',
verbose_name=_("Option Group"),
help_text=_('Select an option group if using type "Option" or "Multi Option"'))
required = models.BooleanField(_('Required'), default=False)
class Meta:
abstract = True
app_label = 'catalogue'
ordering = ['code']
verbose_name = _('Product attribute')
verbose_name_plural = _('Product attributes')
unique_together = ('code', 'product_class')
@property
def is_option(self):
return self.type == self.OPTION
@property
def is_multi_option(self):
return self.type == self.MULTI_OPTION
@property
def is_file(self):
return self.type in [self.FILE, self.IMAGE]
def __str__(self):
return self.name
def clean(self):
if self.type == self.BOOLEAN and self.required:
raise ValidationError(_("Boolean attribute should not be required."))
def _save_file(self, value_obj, value):
# File fields in Django are treated differently, see
# django.db.models.fields.FileField and method save_form_data
if value is None:
# No change
return
elif value is False:
# Delete file
value_obj.delete()
else:
# New uploaded file
value_obj.value = value
value_obj.save()
def _save_multi_option(self, value_obj, value):
# ManyToMany fields are handled separately
if value is None:
value_obj.delete()
return
try:
count = value.count()
except (AttributeError, TypeError):
count = len(value)
if count == 0:
value_obj.delete()
else:
value_obj.value = value
value_obj.save()
def _save_value(self, value_obj, value):
if value is None or value == '':
value_obj.delete()
return
if value != value_obj.value:
value_obj.value = value
value_obj.save()
def save_value(self, product, value): # noqa: C901 too complex
ProductAttributeValue = get_model('catalogue', 'ProductAttributeValue')
try:
value_obj = product.attribute_values.get(attribute=self)
except ProductAttributeValue.DoesNotExist:
# FileField uses False for announcing deletion of the file
# not creating a new value
delete_file = self.is_file and value is False
if value is None or value == '' or delete_file:
return
value_obj = ProductAttributeValue.objects.create(
product=product, attribute=self)
if self.is_file:
self._save_file(value_obj, value)
elif self.is_multi_option:
self._save_multi_option(value_obj, value)
else:
self._save_value(value_obj, value)
def validate_value(self, value):
validator = getattr(self, '_validate_%s' % self.type)
validator(value)
# Validators
def _validate_text(self, value):
if not isinstance(value, str):
raise ValidationError(_("Must be str"))
_validate_richtext = _validate_text
def _validate_float(self, value):
try:
float(value)
except ValueError:
raise ValidationError(_("Must be a float"))
def _validate_integer(self, value):
try:
int(value)
except ValueError:
raise ValidationError(_("Must be an integer"))
def _validate_date(self, value):
if not (isinstance(value, datetime) or isinstance(value, date)):
raise ValidationError(_("Must be a date or datetime"))
def _validate_datetime(self, value):
if not isinstance(value, datetime):
raise ValidationError(_("Must be a datetime"))
def _validate_boolean(self, value):
if not type(value) == bool:
raise ValidationError(_("Must be a boolean"))
def _validate_entity(self, value):
if not isinstance(value, models.Model):
raise ValidationError(_("Must be a model instance"))
def _validate_multi_option(self, value):
try:
values = iter(value)
except TypeError:
raise ValidationError(
_("Must be a list or AttributeOption queryset"))
# Validate each value as if it were an option
# Pass in valid_values so that the DB isn't hit multiple times per iteration
valid_values = self.option_group.options.values_list(
'option', flat=True)
for value in values: