-
Notifications
You must be signed in to change notification settings - Fork 170
Expand file tree
/
Copy pathmodels.py
More file actions
1670 lines (1406 loc) · 54.9 KB
/
models.py
File metadata and controls
1670 lines (1406 loc) · 54.9 KB
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
from django.apps import apps
from django.conf import settings
from django.core.validators import (
DecimalValidator,
MaxValueValidator,
MinValueValidator,
)
from django.db import models
from django.db.models import (
CheckConstraint,
Count,
F,
IntegerField,
Max,
Prefetch,
Q,
UniqueConstraint,
Window,
)
from django.db.models.functions import Cast, RowNumber
from django.utils import timezone
from model_utils import FieldTracker
from model_utils.fields import MonitorField
from simple_history.models import HistoricalRecords
from simple_history.utils import bulk_create_with_history, bulk_update_with_history
import app
import events
import users
from app import providers
from app.mixins import CalendarTriggerMixin
logger = logging.getLogger(__name__)
class Sources(models.TextChoices):
"""Choices for the source of the item."""
TMDB = "tmdb", "The Movie Database"
MAL = "mal", "MyAnimeList"
MANGAUPDATES = "mangaupdates", "MangaUpdates"
IGDB = "igdb", "Internet Game Database"
OPENLIBRARY = "openlibrary", "Open Library"
HARDCOVER = "hardcover", "Hardcover"
COMICVINE = "comicvine", "Comic Vine"
BGG = "bgg", "BoardGameGeek"
MANUAL = "manual", "Manual"
class MediaTypes(models.TextChoices):
"""Choices for the media type of the item."""
TV = "tv", "TV Show"
SEASON = "season", "TV Season"
EPISODE = "episode", "Episode"
MOVIE = "movie", "Movie"
ANIME = "anime", "Anime"
MANGA = "manga", "Manga"
GAME = "game", "Game"
BOOK = "book", "Book"
COMIC = "comic", "Comic"
BOARDGAME = "boardgame", "Boardgame"
class Item(CalendarTriggerMixin, models.Model):
"""Model to store basic information about media items."""
media_id = models.CharField(max_length=20)
source = models.CharField(
max_length=20,
choices=Sources,
)
media_type = models.CharField(
max_length=10,
choices=MediaTypes,
default=MediaTypes.MOVIE.value,
)
title = models.TextField()
image = models.URLField() # if add default, custom media entry will show the value
season_number = models.PositiveIntegerField(null=True, blank=True)
episode_number = models.PositiveIntegerField(null=True, blank=True)
class Meta:
"""Meta options for the model."""
constraints = [
# Ensures items without season/episode numbers are unique
UniqueConstraint(
fields=["media_id", "source", "media_type"],
condition=Q(season_number__isnull=True, episode_number__isnull=True),
name="unique_item_without_season_episode",
),
# Ensures seasons are unique within a show
UniqueConstraint(
fields=["media_id", "source", "media_type", "season_number"],
condition=Q(season_number__isnull=False, episode_number__isnull=True),
name="unique_item_with_season",
),
# Ensures episodes are unique within a season
UniqueConstraint(
fields=[
"media_id",
"source",
"media_type",
"season_number",
"episode_number",
],
condition=Q(season_number__isnull=False, episode_number__isnull=False),
name="unique_item_with_season_episode",
),
# Enforces that season items must have a season number but no episode number
CheckConstraint(
condition=Q(
media_type=MediaTypes.SEASON.value,
season_number__isnull=False,
episode_number__isnull=True,
)
| ~Q(media_type=MediaTypes.SEASON.value),
name="season_number_required_for_season",
),
# Enforces that episode items must have both season and episode numbers
CheckConstraint(
condition=Q(
media_type=MediaTypes.EPISODE.value,
season_number__isnull=False,
episode_number__isnull=False,
)
| ~Q(media_type=MediaTypes.EPISODE.value),
name="season_and_episode_required_for_episode",
),
# Prevents season/episode numbers from being set on non-TV media types
CheckConstraint(
condition=Q(
~Q(
media_type__in=[
MediaTypes.SEASON.value,
MediaTypes.EPISODE.value,
],
),
season_number__isnull=True,
episode_number__isnull=True,
)
| Q(media_type__in=[MediaTypes.SEASON.value, MediaTypes.EPISODE.value]),
name="no_season_episode_for_other_types",
),
# Validate source choices
CheckConstraint(
condition=Q(source__in=Sources.values),
name="%(app_label)s_%(class)s_source_valid",
),
# Validate media_type choices
CheckConstraint(
condition=Q(media_type__in=MediaTypes.values),
name="%(app_label)s_%(class)s_media_type_valid",
),
]
ordering = ["media_id"]
def __str__(self):
"""Return the name of the item."""
name = self.title
if self.season_number is not None:
name += f" S{self.season_number}"
if self.episode_number is not None:
name += f"E{self.episode_number}"
return name
@classmethod
def generate_manual_id(cls, media_type):
"""Generate a new ID for manual items."""
latest_item = (
cls.objects.filter(source=Sources.MANUAL.value, media_type=media_type)
.annotate(
media_id_int=Cast("media_id", IntegerField()),
)
.order_by("-media_id_int")
.first()
)
if latest_item is None:
return "1"
return str(int(latest_item.media_id) + 1)
def fetch_releases(self, delay):
"""Fetch releases for the item."""
if self._disable_calendar_triggers:
return
if self.media_type == MediaTypes.SEASON.value:
# Get or create the TV item for this season
try:
tv_item = Item.objects.get(
media_id=self.media_id,
source=self.source,
media_type=MediaTypes.TV.value,
)
except Item.DoesNotExist:
# Get metadata for the TV show
tv_metadata = providers.services.get_media_metadata(
MediaTypes.TV.value,
self.media_id,
self.source,
)
tv_item = Item.objects.create(
media_id=self.media_id,
source=self.source,
media_type=MediaTypes.TV.value,
title=tv_metadata["title"],
image=tv_metadata["image"],
)
logger.info("Created TV item %s for season %s", tv_item, self)
# Process the TV item instead of the season
items_to_process = [tv_item]
else:
items_to_process = [self]
if delay:
events.tasks.reload_calendar.delay(items_to_process=items_to_process)
else:
events.tasks.reload_calendar(items_to_process=items_to_process)
class MediaManager(models.Manager):
"""Custom manager for media models."""
def get_historical_models(self):
"""Return list of historical model names."""
return [f"historical{media_type}" for media_type in MediaTypes.values]
def get_media_list(self, user, media_type, status_filter, sort_filter, search=None):
"""Get media list based on filters, sorting and search."""
model = apps.get_model(app_label="app", model_name=media_type)
queryset = model.objects.filter(user=user.id)
if status_filter != users.models.MediaStatusChoices.ALL:
queryset = queryset.filter(status=status_filter)
if search:
queryset = queryset.filter(item__title__icontains=search)
queryset = queryset.annotate(
repeats=Window(
expression=Count("id"),
partition_by=[F("item")],
),
row_number=Window(
expression=RowNumber(),
partition_by=[F("item")],
order_by=F("created_at").desc(),
),
).filter(row_number=1)
queryset = queryset.select_related("item")
queryset = self._apply_prefetch_related(queryset, media_type)
if sort_filter:
return self._sort_media_list(queryset, sort_filter, media_type)
return queryset
def _apply_prefetch_related(self, queryset, media_type):
"""Apply appropriate prefetch_related based on media type."""
# Apply media-specific prefetches
if media_type == MediaTypes.TV.value:
return queryset.prefetch_related(
Prefetch(
"seasons",
queryset=Season.objects.select_related("item"),
),
Prefetch(
"seasons__episodes",
queryset=Episode.objects.select_related("item"),
),
)
base_queryset = queryset.prefetch_related(
Prefetch(
"item__event_set",
queryset=events.models.Event.objects.all(),
to_attr="prefetched_events",
),
)
if media_type == MediaTypes.SEASON.value:
return base_queryset.prefetch_related(
Prefetch(
"episodes",
queryset=Episode.objects.select_related("item"),
),
)
return base_queryset
def _sort_media_list(self, queryset, sort_filter, media_type=None):
"""Sort media list using SQL sorting with annotations for calculated fields."""
if media_type == MediaTypes.TV.value:
return self._sort_tv_media_list(queryset, sort_filter)
if media_type == MediaTypes.SEASON.value:
return self._sort_season_media_list(queryset, sort_filter)
return self._sort_generic_media_list(queryset, sort_filter)
def _sort_tv_media_list(self, queryset, sort_filter):
"""Sort TV media list based on the sort criteria."""
if sort_filter == "start_date":
# Annotate with the minimum start_date from related seasons/episodes
queryset = queryset.annotate(
calculated_start_date=models.Min(
"seasons__episodes__end_date",
filter=models.Q(seasons__item__season_number__gt=0),
),
)
return queryset.order_by(
models.F("calculated_start_date").asc(nulls_last=True),
models.functions.Lower("item__title"),
)
if sort_filter == "end_date":
# Annotate with the maximum end_date from related seasons/episodes
queryset = queryset.annotate(
calculated_end_date=models.Max(
"seasons__episodes__end_date",
filter=models.Q(seasons__item__season_number__gt=0),
),
)
return queryset.order_by(
models.F("calculated_end_date").desc(nulls_last=True),
models.functions.Lower("item__title"),
)
if sort_filter == "progress":
# Annotate with the sum of episodes watched (excluding season 0)
queryset = queryset.annotate(
# Count episodes in regular seasons (season_number > 0)
calculated_progress=models.Count(
"seasons__episodes",
filter=models.Q(seasons__item__season_number__gt=0),
),
)
return queryset.order_by(
"-calculated_progress",
models.functions.Lower("item__title"),
)
# Default to generic sorting
return self._sort_generic_media_list(queryset, sort_filter)
def _sort_season_media_list(self, queryset, sort_filter):
"""Sort Season media list based on the sort criteria."""
if sort_filter == "start_date":
# Annotate with the minimum end_date from related episodes
queryset = queryset.annotate(
calculated_start_date=models.Min("episodes__end_date"),
)
return queryset.order_by(
models.F("calculated_start_date").asc(nulls_last=True),
models.functions.Lower("item__title"),
)
if sort_filter == "end_date":
# Annotate with the maximum end_date from related episodes
queryset = queryset.annotate(
calculated_end_date=models.Max("episodes__end_date"),
)
return queryset.order_by(
models.F("calculated_end_date").desc(nulls_last=True),
models.functions.Lower("item__title"),
)
if sort_filter == "progress":
# Annotate with the maximum episode number
queryset = queryset.annotate(
calculated_progress=models.Max("episodes__item__episode_number"),
)
return queryset.order_by(
"-calculated_progress",
models.functions.Lower("item__title"),
)
# Default to generic sorting
return self._sort_generic_media_list(queryset, sort_filter)
def _sort_generic_media_list(self, queryset, sort_filter):
"""Apply generic sorting logic for all media types."""
# Handle sorting by date fields with special null handling
if sort_filter in ("start_date", "end_date"):
# For start_date, sort ascending (earliest first)
if sort_filter == "start_date":
return queryset.order_by(
models.F(sort_filter).asc(nulls_last=True),
models.functions.Lower("item__title"),
)
# For other date fields, sort descending (latest first)
return queryset.order_by(
models.F(sort_filter).desc(nulls_last=True),
models.functions.Lower("item__title"),
)
# Handle sorting by Item fields
item_fields = [f.name for f in Item._meta.fields]
if sort_filter in item_fields:
if sort_filter == "title":
# Case-insensitive title sorting
return queryset.order_by(models.functions.Lower("item__title"))
# Default sorting for other Item fields
return queryset.order_by(
f"-item__{sort_filter}",
models.functions.Lower("item__title"),
)
# Default sorting by media field
return queryset.order_by(
models.F(sort_filter).desc(nulls_last=True),
models.functions.Lower("item__title"),
)
def get_in_progress(self, user, sort_by, items_limit, specific_media_type=None):
"""Get a media list of in progress media by type."""
list_by_type = {}
media_types = self._get_media_types_to_process(user, specific_media_type)
for media_type in media_types:
# Get base media list for in-progress media
media_list = self.get_media_list(
user=user,
media_type=media_type,
status_filter=Status.IN_PROGRESS.value,
sort_filter=None,
)
if not media_list:
continue
# Annotate with max_progress and next_event
self.annotate_max_progress(media_list, media_type)
self._annotate_next_event(media_list)
# Sort the media list
sorted_list = self._sort_in_progress_media(media_list, sort_by)
# Apply pagination
total_count = len(sorted_list)
if specific_media_type:
paginated_list = sorted_list[items_limit:]
else:
paginated_list = sorted_list[:items_limit]
list_by_type[media_type] = {
"items": paginated_list,
"total": total_count,
}
return list_by_type
def _get_media_types_to_process(self, user, specific_media_type):
"""Determine which media types to process based on user settings."""
if specific_media_type:
return [specific_media_type]
# Get active types excluding TV
return [
media_type
for media_type in user.get_active_media_types()
if media_type != MediaTypes.TV.value
]
def _annotate_next_event(self, media_list):
"""Annotate next_event for media items."""
current_time = timezone.now()
for media in media_list:
# Get future events sorted by datetime
future_events = sorted(
[
event
for event in getattr(media.item, "prefetched_events", [])
if event.datetime > current_time
],
key=lambda e: e.datetime,
)
media.next_event = future_events[0] if future_events else None
def _sort_in_progress_media(self, media_list, sort_by):
"""Sort in-progress media based on the sort criteria."""
# Define primary sort functions based on sort_by
primary_sort_functions = {
users.models.HomeSortChoices.UPCOMING: lambda x: (
x.next_event is None,
x.next_event.datetime if x.next_event else None,
),
users.models.HomeSortChoices.RECENT: lambda x: (
-timezone.datetime.timestamp(
x.progressed_at if x.progressed_at is not None else x.created_at,
)
),
users.models.HomeSortChoices.COMPLETION: lambda x: (
x.max_progress is None,
-(
x.progress / x.max_progress * 100
if x.max_progress and x.max_progress > 0
else 0
),
),
users.models.HomeSortChoices.EPISODES_LEFT: lambda x: (
x.max_progress is None,
(x.max_progress - x.progress if x.max_progress else 0),
),
users.models.HomeSortChoices.TITLE: lambda x: x.item.title.lower(),
}
primary_sort_function = primary_sort_functions[sort_by]
return sorted(
media_list,
key=lambda x: (
primary_sort_function(x),
-timezone.datetime.timestamp(
x.progressed_at if x.progressed_at is not None else x.created_at,
),
x.item.title.lower(),
),
)
def annotate_max_progress(self, media_list, media_type):
"""Annotate max_progress for all media items."""
current_datetime = timezone.now()
if media_type == MediaTypes.MOVIE.value:
for media in media_list:
media.max_progress = 1
return
if media_type == MediaTypes.TV.value:
self._annotate_tv_released_episodes(media_list, current_datetime)
return
# For other media types, calculate max_progress from events
# Create a dictionary mapping item_id to max content_number
max_progress_dict = {}
item_ids = [media.item.id for media in media_list]
# Fetch all relevant events in a single query
events_data = events.models.Event.objects.filter(
item_id__in=item_ids,
datetime__lte=current_datetime,
).values("item_id", "content_number")
# Process events to find max content number per item
for event in events_data:
item_id = event["item_id"]
content_number = event["content_number"]
if content_number is not None:
current_max = max_progress_dict.get(item_id, 0)
max_progress_dict[item_id] = max(current_max, content_number)
for media in media_list:
media.max_progress = max_progress_dict.get(media.item.id)
def _annotate_tv_released_episodes(self, tv_list, current_datetime):
"""Annotate TV shows with the number of released episodes."""
# Prefetch all relevant events in one query
released_events = events.models.Event.objects.filter(
item__media_id__in=[tv.item.media_id for tv in tv_list],
item__source=tv_list[0].item.source if tv_list else None,
item__media_type=MediaTypes.SEASON.value,
item__season_number__gt=0,
datetime__lte=current_datetime,
content_number__isnull=False,
).select_related("item")
# Create a dictionary to store max episode numbers per season per show
released_episodes = {}
for event in released_events:
media_id = event.item.media_id
season_number = event.item.season_number
episode_number = event.content_number
if media_id not in released_episodes:
released_episodes[media_id] = {}
if (
season_number not in released_episodes[media_id]
or episode_number > released_episodes[media_id][season_number]
):
released_episodes[media_id][season_number] = episode_number
# Calculate total released episodes per TV show
for tv in tv_list:
tv_episodes = released_episodes.get(tv.item.media_id, {})
tv.max_progress = sum(tv_episodes.values()) if tv_episodes else 0
def fetch_media_for_items(self, media_types, item_ids, user, status_filter=None):
"""Fetch media objects for given items, optionally filtering by status.
Args:
media_types: Iterable of media type strings to query
item_ids: QuerySet or list of item IDs to fetch media for
user: User to filter media by
status_filter: Optional status value to filter by
Returns:
dict mapping item_id to media object
"""
media_by_item_id = {}
for media_type in media_types:
model = apps.get_model("app", media_type)
if media_type == MediaTypes.EPISODE.value:
filter_kwargs = {
"item__in": item_ids,
"related_season__user": user,
}
if status_filter:
filter_kwargs["related_season__status"] = status_filter
else:
filter_kwargs = {
"item__in": item_ids,
"user": user,
}
if status_filter:
filter_kwargs["status"] = status_filter
queryset = model.objects.filter(**filter_kwargs).select_related("item")
queryset = self._apply_prefetch_related(queryset, media_type)
self.annotate_max_progress(queryset, media_type)
for entry in queryset:
media_by_item_id.setdefault(entry.item_id, entry)
return media_by_item_id
def get_media(
self,
user,
media_type,
instance_id,
):
"""Get user media object given the media type and item."""
model = apps.get_model(app_label="app", model_name=media_type)
params = self._get_media_params(
user,
media_type,
instance_id,
)
return model.objects.get(**params)
def get_media_prefetch(
self,
user,
media_type,
instance_id,
):
"""Get user media object with prefetch_related applied."""
model = apps.get_model(app_label="app", model_name=media_type)
params = self._get_media_params(
user,
media_type,
instance_id,
)
queryset = model.objects.filter(**params)
queryset = self._apply_prefetch_related(queryset, media_type)
self.annotate_max_progress(queryset, media_type)
return queryset[0]
def _get_media_params(
self,
user,
media_type,
instance_id,
):
"""Get the common filter parameters for media queries."""
params = {"id": instance_id}
if media_type == MediaTypes.EPISODE.value:
params["related_season__user"] = user
else:
params["user"] = user
return params
def filter_media(
self,
user,
media_id,
media_type,
source,
season_number=None,
episode_number=None,
):
"""Filter media objects based on parameters."""
model = apps.get_model(app_label="app", model_name=media_type)
params = self._filter_media_params(
media_type,
media_id,
source,
user,
season_number,
episode_number,
)
return model.objects.filter(**params)
def filter_media_prefetch(
self,
user,
media_id,
media_type,
source,
season_number=None,
episode_number=None,
):
"""Filter user media object with prefetch_related applied."""
queryset = self.filter_media(
user,
media_id,
media_type,
source,
season_number,
episode_number,
)
queryset = self._apply_prefetch_related(queryset, media_type)
self.annotate_max_progress(queryset, media_type)
return queryset
def _filter_media_params(
self,
media_type,
media_id,
source,
user,
season_number=None,
episode_number=None,
):
"""Get the common filter parameters for media queries."""
params = {
"item__media_type": media_type,
"item__source": source,
"item__media_id": media_id,
}
if media_type == MediaTypes.SEASON.value:
params["item__season_number"] = season_number
params["user"] = user
elif media_type == MediaTypes.EPISODE.value:
params["item__season_number"] = season_number
params["item__episode_number"] = episode_number
params["related_season__user"] = user
else:
params["user"] = user
return params
class Status(models.TextChoices):
"""Choices for item status."""
COMPLETED = "Completed", "Completed"
IN_PROGRESS = "In progress", "In Progress"
PLANNING = "Planning", "Planning"
PAUSED = "Paused", "Paused"
DROPPED = "Dropped", "Dropped"
class Media(models.Model):
"""Abstract model for all media types."""
history = HistoricalRecords(
cascade_delete_history=True,
inherit=True,
excluded_fields=[
"item",
"progressed_at",
"user",
"related_tv",
"created_at",
],
)
created_at = models.DateTimeField(auto_now_add=True)
item = models.ForeignKey(Item, on_delete=models.CASCADE)
user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
score = models.DecimalField(
null=True,
blank=True,
max_digits=3,
decimal_places=1,
validators=[
DecimalValidator(3, 1),
MinValueValidator(0),
MaxValueValidator(10),
],
)
progress = models.PositiveIntegerField(default=0)
progressed_at = MonitorField(monitor="progress")
status = models.CharField(
max_length=20,
choices=Status,
default=Status.COMPLETED.value,
)
start_date = models.DateTimeField(null=True, blank=True)
end_date = models.DateTimeField(null=True, blank=True)
notes = models.TextField(blank=True, default="")
class Meta:
"""Meta options for the model."""
abstract = True
ordering = ["user", "item", "-created_at"]
def __str__(self):
"""Return the title of the media."""
return self.item.__str__()
def get_progress_unit(self):
"""Return the progress unit for the media."""
# Check if instance has a specific progress_unit field (like Book)
return getattr(self, "progress_unit", None)
def save(self, *args, **kwargs):
"""Save the media instance."""
if self.tracker.has_changed("progress"):
self.process_progress()
if self.tracker.has_changed("status"):
self.process_status()
super().save(*args, **kwargs)
def process_progress(self):
"""Update fields depending on the progress of the media."""
if self.progress < 0:
self.progress = 0
if self.status != Status.IN_PROGRESS.value:
return
if self.get_progress_unit() == users.models.ProgressUnit.PERCENTAGE:
self.progress = min(self.progress, 100)
if self.progress == 100:
self.status = Status.COMPLETED.value
now = timezone.now().replace(second=0, microsecond=0)
self.end_date = now
return
max_progress = providers.services.get_media_metadata(
self.item.media_type,
self.item.media_id,
self.item.source,
)["max_progress"]
if max_progress:
self.progress = min(self.progress, max_progress)
if self.progress == max_progress:
self.status = Status.COMPLETED.value
now = timezone.now().replace(second=0, microsecond=0)
self.end_date = now
def process_status(self):
"""Update fields depending on the status of the media."""
if self.status == Status.COMPLETED.value:
if self.get_progress_unit() == users.models.ProgressUnit.PERCENTAGE:
self.progress = 100
else:
max_progress = providers.services.get_media_metadata(
self.item.media_type,
self.item.media_id,
self.item.source,
)["max_progress"]
if max_progress:
self.progress = max_progress
self.item.fetch_releases(delay=True)
@property
def formatted_score(self):
"""Return as int if score is 10.0 or 0.0, otherwise show decimal."""
if self.score is not None:
max_score = 10
min_score = 0
if self.score in (max_score, min_score):
return int(self.score)
return self.score
return None
@property
def formatted_progress(self):
"""Return the progress of the media in a formatted string."""
display = str(self.progress)
max_progress = getattr(self, "max_progress", None)
if max_progress and self.item.media_type != MediaTypes.MOVIE.value:
display += f" / {max_progress}"
return display
def increase_progress(self):
"""Increase the progress of the media by one."""
self.progress += 1
self.save()
logger.info("Incresed progress of %s to %s", self, self.progress)
def decrease_progress(self):
"""Decrease the progress of the media by one."""
self.progress -= 1
self.save()
logger.info("Decreased progress of %s to %s", self, self.progress)
class BasicMedia(Media):
"""Model for basic media types."""
objects = MediaManager()
class TV(Media):
"""Model for TV shows."""
tracker = FieldTracker()
class Meta:
"""Meta options for the model."""
ordering = ["user", "item"]
constraints = [
models.UniqueConstraint(
fields=["user", "item"],
name="%(app_label)s_%(class)s_unique_item_user",
),
]
@tracker # postpone field reset until after the save
def save(self, *args, **kwargs):
"""Save the media instance."""
super(Media, self).save(*args, **kwargs)
if self.tracker.has_changed("status"):
if self.status == Status.COMPLETED.value:
self._completed()
elif self.status == Status.DROPPED.value:
self._mark_in_progress_seasons_as_dropped()
elif (
self.status == Status.IN_PROGRESS.value
and not self.seasons.filter(status=Status.IN_PROGRESS.value).exists()
):
self._start_next_available_season()
self.item.fetch_releases(delay=True)
@property
def progress(self):
"""Return the total episodes watched for the TV show."""
return sum(
season.progress
for season in self.seasons.all()
if season.item.season_number != 0
)
@property
def last_watched(self):
"""Return the latest watched episode in SxxExx format."""
watched_episodes = [
{
"season": season.item.season_number,
"episode": episode.item.episode_number,
"end_date": episode.end_date,
}
for season in self.seasons.all()
if hasattr(season, "episodes") and season.item.season_number != 0
for episode in season.episodes.all()
if episode.end_date is not None
]
if not watched_episodes:
return ""
latest_episode = max(
watched_episodes,
key=lambda x: (x["end_date"], x["season"], x["episode"]),
)
return f"S{latest_episode['season']:02d}E{latest_episode['episode']:02d}"
@property
def progressed_at(self):
"""Return the date when the last episode was watched."""