-
Notifications
You must be signed in to change notification settings - Fork 40
/
models.py
517 lines (419 loc) · 16.2 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
from __future__ import annotations
import copy
from decimal import Decimal
from secrets import token_urlsafe
from typing import TYPE_CHECKING, Any
from django.conf import settings
from django.contrib.contenttypes.fields import GenericForeignKey
from django.contrib.contenttypes.models import ContentType
from django.db import models, transaction
from django.http import HttpRequest
from django.utils.functional import cached_property, classproperty
from django.utils.text import Truncator
from django.utils.translation import gettext_lazy as _
from salesman.basket.models import BaseBasket, BaseBasketItem
from salesman.conf import app_settings
from salesman.core.typing import Product
from salesman.core.utils import get_salesman_model
from salesman.orders.status import BaseOrderStatus
from .signals import status_changed
if TYPE_CHECKING: # pragma: no cover
from salesman.checkout.payment import PaymentMethod
try:
# Add support for Wagtail admin.
from modelcluster.fields import ParentalKey
from modelcluster.models import ClusterableModel
except ImportError: # pragma: no cover
ClusterableModel = models.Model
ParentalKey = models.ForeignKey
class ParentalForeignKey(ParentalKey):
"""
Use this foreign key to add support for Wagtail
in case modelcluster is installed.
"""
class OrderManager(models.Manager):
def create_from_request(self, request: HttpRequest, **kwargs: Any) -> BaseOrder:
"""
Create new order with reference. Items are still in basket and should
be added using ``order.populate_from_basket(basket, request)`` method.
Returns:
Order: Order instance
"""
kwargs["ref"] = app_settings.SALESMAN_ORDER_REFERENCE_GENERATOR(request)
order: BaseOrder = super().create(**kwargs)
return order
def create_from_basket(
self,
basket: BaseBasket,
request: HttpRequest,
**kwargs: Any,
) -> BaseOrder:
"""
Create and populate new order from basket.
Returns:
Order: Order instance
"""
kwargs["ref"] = app_settings.SALESMAN_ORDER_REFERENCE_GENERATOR(request)
order: BaseOrder = self.model(**kwargs)
order.populate_from_basket(basket, request)
return order
class BaseOrder(ClusterableModel):
user = models.ForeignKey(
settings.AUTH_USER_MODEL,
on_delete=models.SET_NULL,
null=True,
verbose_name=_("User"),
)
# A unique reference to this order, could be used as order number.
ref = models.CharField(
_("Reference"),
max_length=128,
unique=True,
help_text=_("A unique order reference."),
)
# Current order status.
status = models.CharField(
_("Status"),
max_length=128,
default="NEW",
help_text=_("Changing order status might trigger a notification to customer."),
)
# A unique token to allow non-authenticated user access to order.
token = models.CharField(
_("Token"),
max_length=128,
unique=True,
default=token_urlsafe,
help_text=_(
"Allow non-authenticated customer to access the order with token. "
"To access order suply a '?token={token}' in url querystring."
),
)
# Customer contact info.
email = models.EmailField(_("Email"), blank=True)
shipping_address = models.TextField(_("Shipping address"), blank=True)
billing_address = models.TextField(_("Billing address"), blank=True)
subtotal = models.DecimalField(
_("Subtotal"), max_digits=18, decimal_places=2, default=Decimal(0)
)
total = models.DecimalField(
_("Total"), max_digits=18, decimal_places=2, default=Decimal(0)
)
_extra = models.JSONField(_("Extra"), blank=True, default=dict)
date_created = models.DateTimeField(_("Date created"), auto_now_add=True)
date_updated = models.DateTimeField(_("Date updated"), auto_now=True)
objects = OrderManager()
# Separate rows from `_extra` to `extra_rows`.
extra: dict[str, Any] | None = None
extra_rows: list[Any] | None = None
_current_status: str | None = None
_cached_items: list[BaseOrderItem] | None = None
class Meta:
abstract = True
verbose_name = _("Order")
verbose_name_plural = _("Orders")
ordering = ["-date_created"]
def __init__(self, *args: Any, **kwargs: Any) -> None:
super().__init__(*args, **kwargs)
extra = copy.deepcopy(self._extra)
self.extra_rows = extra.pop("rows", [])
self.extra = extra
self._current_status = self.status
def __str__(self) -> str:
return self.ref
def save(self, *args: Any, **kwargs: Any) -> None:
self._extra = dict(self.extra or {}, rows=self.extra_rows)
if "extra" in kwargs.get("update_fields", []):
kwargs["update_fields"].remove("extra")
kwargs["update_fields"].append("_extra")
new_status, old_status = self.status, self._current_status
super().save(*args, **kwargs)
# Send signal if status changed.
if new_status != old_status:
status_changed.send(
get_salesman_model("Order"),
order=self,
new_status=new_status,
old_status=old_status,
)
def pay(
self,
amount: Decimal,
transaction_id: str,
payment_method: str = "",
) -> BaseOrderPayment:
"""
Create a new payment for order.
Args:
amount (Decimal): Amount to add
transaction_id (str): ID of transaction
payment_method (str, optional): Payment method identifier. Defaults to ''.
Returns:
OrderPayment: New order payment instance
"""
OrderPayment = get_salesman_model("OrderPayment")
payment: BaseOrderPayment = OrderPayment.objects.create(
order=self,
amount=amount,
transaction_id=transaction_id,
payment_method=payment_method,
)
return payment
@transaction.atomic
def populate_from_basket(
self,
basket: BaseBasket,
request: HttpRequest,
**kwargs: Any,
) -> None:
"""
Populate order with items from basket.
Args:
basket (Basket): Basket instance
request (HttpRequest): Django request
"""
from salesman.basket.serializers import ExtraRowsField
if not hasattr(basket, "total"):
basket.update(request)
self.user = basket.user
self.email = basket.extra.pop("email", "")
self.shipping_address = basket.extra.pop("shipping_address", "")
self.billing_address = basket.extra.pop("billing_address", "")
self.subtotal = basket.subtotal
self.total = basket.total
self.extra = basket.extra
self.extra_rows = ExtraRowsField().to_representation(basket.extra_rows)
if self.status == self.Status.NEW:
self.status = self.Status.CREATED
for attr, value in kwargs.items():
setattr(self, attr, value)
self.save()
OrderItem = get_salesman_model("OrderItem")
for item in basket.get_items():
obj = OrderItem(order=self)
obj.populate_from_basket_item(item, request)
obj.save()
def get_items(self) -> list[BaseOrderItem]:
"""
Returns items from cache or stores new ones.
"""
if self._cached_items is None:
self._cached_items = list(self.items.all())
return self._cached_items
@classproperty
def Status(cls) -> type[BaseOrderStatus]:
"""
Return order status enum from settings.
"""
return app_settings.SALESMAN_ORDER_STATUS
@property
def status_display(self) -> str:
"""
Returns display label for current status.
"""
return str(dict(self.Status.choices).get(self.status, self.status))
status_display.fget.short_description = _("Status") # type: ignore
status_display.fget.admin_order_field = "status" # type: ignore
@cached_property
def amount_paid(self) -> Decimal:
"""
Returns amount already paid for this order.
"""
return Decimal(sum([x.amount for x in self.payments.all()]))
@property
def amount_outstanding(self) -> Decimal:
"""
Returns amount still needed for order to be paid.
"""
return Decimal(self.total - self.amount_paid)
@property
def is_paid(self) -> bool:
"""
Returns if order is paid in full.
"""
return self.amount_paid >= self.total
@classmethod
def get_wagtail_admin_attribute(cls, name: str) -> Any | None:
"""
Return attribute from Wagtail order admin mixin.
Args:
name (str): Attribute name
Returns:
Optional[Any]: Attribute value
"""
if (
"salesman.admin" in settings.INSTALLED_APPS
and "wagtail.admin" in settings.INSTALLED_APPS
and "wagtail.contrib.modeladmin" in settings.INSTALLED_APPS
):
from salesman.admin.wagtail.mixins import WagtailOrderAdminMixin
return getattr(WagtailOrderAdminMixin, name, None)
return None
@classproperty
def default_panels(cls) -> list[Any] | None:
return cls.get_wagtail_admin_attribute("default_panels")
@classproperty
def default_items_panels(cls) -> list[Any] | None:
return cls.get_wagtail_admin_attribute("default_items_panels")
@classproperty
def default_payments_panels(cls) -> list[Any] | None:
return cls.get_wagtail_admin_attribute("default_payments_panels")
@classproperty
def default_notes_panels(cls) -> list[Any] | None:
return cls.get_wagtail_admin_attribute("default_notes_panels")
@classproperty
def default_edit_handler(cls) -> Any | None:
return cls.get_wagtail_admin_attribute("default_edit_handler")
class Order(BaseOrder):
"""
Model that can be swapped by overriding `SALESMAN_ORDER_MODEL` setting.
"""
class Meta(BaseOrder.Meta):
swappable = "SALESMAN_ORDER_MODEL"
class BaseOrderItem(models.Model):
order = ParentalForeignKey(
app_settings.SALESMAN_ORDER_MODEL,
on_delete=models.CASCADE,
related_name="items",
verbose_name=_("Order"),
)
product_type = models.CharField(_("Product type"), max_length=128)
# Generic relation to product (optional).
product_content_type = models.ForeignKey(ContentType, models.SET_NULL, null=True)
product_id = models.PositiveIntegerField(_("Product id"), null=True)
product = GenericForeignKey("product_content_type", "product_id")
# Stored product serializer data at the moment of purchase.
product_data = models.JSONField(_("Product data"), blank=True, default=dict)
unit_price = models.DecimalField(_("Unit price"), max_digits=18, decimal_places=2)
subtotal = models.DecimalField(_("Subtotal"), max_digits=18, decimal_places=2)
total = models.DecimalField(_("Total"), max_digits=18, decimal_places=2)
quantity = models.PositiveIntegerField(_("Quantity"))
_extra = models.JSONField(_("Extra"), blank=True, default=dict)
# Separate rows from `_extra` to `extra_rows`.
extra: dict[str, Any] | None = None
extra_rows: list[Any] | None = None
class Meta:
abstract = True
verbose_name = _("Item")
verbose_name_plural = _("Items")
def __init__(self, *args: Any, **kwargs: Any) -> None:
super().__init__(*args, **kwargs)
extra = copy.deepcopy(self._extra)
self.extra_rows = extra.pop("rows", [])
self.extra = extra
def __str__(self) -> str:
return f"{self.quantity}x {self.name} ({self.code})"
def save(self, *args: Any, **kwargs: Any) -> None:
self._extra = dict(self.extra or {}, rows=self.extra_rows)
if "extra" in kwargs.get("update_fields", []):
kwargs["update_fields"].remove("extra")
kwargs["update_fields"].append("_extra")
super().save(*args, **kwargs)
def populate_from_basket_item(
self,
item: BaseBasketItem,
request: HttpRequest,
) -> None:
"""
Populate order with items from basket.
Args:
item (BasketItem): Basket item instance
request (HttpRequest): Django request
"""
from salesman.basket.serializers import ExtraRowsField, ProductField
product: Product = item.product
self.product_type = product._meta.label
self.product_content_type = item.product_content_type
self.product_id = item.product_id
# Store serialized product with `name` and `code`.
product_field = ProductField()
setattr(product_field, "_context", {"request": request})
product_data = product_field.to_representation(product)
product_data.update({"name": product.name, "code": product.code})
self.product_data = product_data
self.unit_price = item.unit_price
self.subtotal = item.subtotal
self.total = item.total
self.quantity = item.quantity
self.extra = item.extra
self.extra_rows = ExtraRowsField().to_representation(item.extra_rows)
@property
def name(self) -> str:
"""
Returns product `name` from stored data.
"""
return str(self.product_data.get("name", "(no name)"))
@property
def code(self) -> str:
"""
Returns product `name` from stored data.
"""
return str(self.product_data.get("code", "(no code)"))
class OrderItem(BaseOrderItem):
"""
Model that can be swapped by overriding `SALESMAN_ORDER_ITEM_MODEL` setting.
"""
class Meta(BaseOrderItem.Meta):
swappable = "SALESMAN_ORDER_ITEM_MODEL"
class BaseOrderPayment(models.Model):
order = ParentalForeignKey(
app_settings.SALESMAN_ORDER_MODEL,
on_delete=models.CASCADE,
related_name="payments",
verbose_name=_("Order"),
)
amount = models.DecimalField(_("Amount"), max_digits=18, decimal_places=2)
transaction_id = models.CharField(_("Transaction ID"), max_length=128)
payment_method = models.CharField(_("Payment method"), max_length=128, blank=True)
date_created = models.DateTimeField(_("Date created"), auto_now_add=True)
class Meta:
abstract = True
verbose_name = _("Payment")
verbose_name_plural = _("Payments")
unique_together = ("order", "transaction_id")
def __str__(self) -> str:
return f"{self.amount} ({self.transaction_id})"
def get_payment_method(self) -> PaymentMethod | None:
"""
Returns payment method instance.
"""
from salesman.checkout.payment import payment_methods_pool
return payment_methods_pool.get_payment(self.payment_method)
@property
def payment_method_display(self) -> str:
"""
Returns display label for payment method.
"""
payment = self.get_payment_method()
return payment.label if payment else self.payment_method
payment_method_display.fget.short_description = _("Payment method") # type: ignore
class OrderPayment(BaseOrderPayment):
"""
Model that can be swapped by overriding `SALESMAN_ORDER_PAYMENT_MODEL` setting.
"""
class Meta(BaseOrderPayment.Meta):
swappable = "SALESMAN_ORDER_PAYMENT_MODEL"
class BaseOrderNote(models.Model):
order = ParentalForeignKey(
app_settings.SALESMAN_ORDER_MODEL,
on_delete=models.CASCADE,
related_name="notes",
verbose_name=_("Order"),
)
message = models.TextField(_("Message"))
public = models.BooleanField(
_("Public"), default=False, help_text=_("Is accessible to the customer?")
)
date_created = models.DateTimeField(_("Date created"), auto_now_add=True)
class Meta:
abstract = True
verbose_name = _("Note")
verbose_name_plural = _("Notes")
def __str__(self) -> str:
return Truncator(self.message).words(3)
class OrderNote(BaseOrderNote):
"""
Model that can be swapped by overriding `SALESMAN_ORDER_NOTE_MODEL` setting.
"""
class Meta(BaseOrderNote.Meta):
swappable = "SALESMAN_ORDER_NOTE_MODEL"