Archived
Resolve merge conflicts for PR #25: customizable mobile reading experience
- Backend: Replace PR's Book-only models with main's full models (EBook, BookChapter, DownloadRecord, ReadingProgress, ReadingSettings) - Backend: Add reader app (ReadingSettings model, serializer, view, URL) - Frontend: Port reader feature files from web/ to frontend/ (api, hooks, components/reader/, pages/ReadingPage, types/reader, reader.css) - Frontend: Add /read/:id route to App.tsx for chapter-based reading view - All imports adjusted for frontend/src directory structure
This commit is contained in:
Marko (Hermes Implementer)
+187
-17
@@ -1,11 +1,36 @@
|
||||
from django.conf import settings
|
||||
from django.db import models
|
||||
from django.db.models.signals import post_delete
|
||||
from django.dispatch import receiver
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
class ReadingStatus(models.TextChoices):
|
||||
WANT_TO_READ = "want_to_read", "Want to Read"
|
||||
READING = "reading", "Reading"
|
||||
FINISHED = "finished", "Finished"
|
||||
DNF = "dnf", "Did Not Finish"
|
||||
|
||||
|
||||
class FontStyle(models.TextChoices):
|
||||
SANS_SERIF = "sans-serif", "Sans Serif"
|
||||
SERIF = "serif", "Serif"
|
||||
MONOSPACE = "monospace", "Monospace"
|
||||
|
||||
|
||||
class BackgroundColor(models.TextChoices):
|
||||
WHITE = "#ffffff", "White"
|
||||
SEPIA = "#f4e4c1", "Sepia"
|
||||
DARK = "#1a1a2e", "Dark"
|
||||
GREEN = "#c7edcc", "Green"
|
||||
|
||||
|
||||
class Book(models.Model):
|
||||
"""Represents a book in the user's library."""
|
||||
|
||||
title = models.CharField(max_length=512)
|
||||
author = models.CharField(max_length=256, blank=True, default="")
|
||||
title = models.CharField(max_length=512, db_index=True)
|
||||
author = models.CharField(max_length=256, blank=True, default="", db_index=True)
|
||||
genre = models.CharField(max_length=128, blank=True, default="", db_index=True)
|
||||
description = models.TextField(blank=True, default="")
|
||||
reading_status = models.CharField(max_length=20, choices=ReadingStatus.choices, default=ReadingStatus.WANT_TO_READ, db_index=True)
|
||||
total_pages = models.PositiveIntegerField(default=0)
|
||||
cover_image = models.URLField(blank=True, default="")
|
||||
created_at = models.DateTimeField(auto_now_add=True)
|
||||
@@ -16,13 +41,154 @@ class Book(models.Model):
|
||||
verbose_name = "Book"
|
||||
verbose_name_plural = "Books"
|
||||
ordering = ["title"]
|
||||
indexes = [models.Index(fields=["title", "author", "genre"])]
|
||||
|
||||
def __str__(self) -> str:
|
||||
def __str__(self):
|
||||
return self.title
|
||||
|
||||
|
||||
class EBook(models.Model):
|
||||
user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="ebooks")
|
||||
title = models.CharField(max_length=512, db_index=True)
|
||||
author = models.CharField(max_length=256, blank=True, default="", db_index=True)
|
||||
format = models.CharField(max_length=20, blank=True, default="", editable=False)
|
||||
page_count = models.PositiveIntegerField(default=0)
|
||||
file_size = models.BigIntegerField(default=0)
|
||||
metadata_json = models.JSONField(blank=True, default=dict)
|
||||
file = models.FileField(upload_to="ebooks/%Y/%m/%d/")
|
||||
cover_image = models.ImageField(upload_to="ebook_covers/%Y/%m/%d/", blank=True, null=True)
|
||||
created_at = models.DateTimeField(auto_now_add=True)
|
||||
updated_at = models.DateTimeField(auto_now=True)
|
||||
|
||||
class Meta:
|
||||
db_table = "books_ebook"
|
||||
verbose_name = "E-Book"
|
||||
verbose_name_plural = "E-Books"
|
||||
ordering = ["-created_at"]
|
||||
indexes = [models.Index(fields=["user", "-created_at"])]
|
||||
|
||||
def __str__(self):
|
||||
return self.title
|
||||
|
||||
def filename(self):
|
||||
return Path(self.file.name).name if self.file else ""
|
||||
|
||||
|
||||
class BookChapter(models.Model):
|
||||
ebook = models.ForeignKey(EBook, on_delete=models.CASCADE, related_name="chapters")
|
||||
title = models.CharField(max_length=512)
|
||||
index = models.IntegerField(default=0)
|
||||
href = models.CharField(max_length=1024, blank=True, default="")
|
||||
children = models.JSONField(blank=True, default=list)
|
||||
|
||||
class Meta:
|
||||
db_table = "books_book_chapter"
|
||||
verbose_name = "Book Chapter"
|
||||
verbose_name_plural = "Book Chapters"
|
||||
ordering = ["index"]
|
||||
indexes = [models.Index(fields=["ebook", "index"])]
|
||||
|
||||
def __str__(self):
|
||||
return f"{self.ebook.title} - {self.title}"
|
||||
|
||||
|
||||
@receiver(post_delete, sender=EBook)
|
||||
def _auto_delete_ebook_file(sender, instance, **kwargs):
|
||||
if instance.file:
|
||||
instance.file.delete(save=False)
|
||||
if instance.cover_image:
|
||||
instance.cover_image.delete(save=False)
|
||||
|
||||
|
||||
class DownloadRecord(models.Model):
|
||||
"""Tracks book downloads for offline access management."""
|
||||
|
||||
user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="download_records")
|
||||
ebook = models.ForeignKey(EBook, on_delete=models.CASCADE, related_name="download_records")
|
||||
file_size = models.BigIntegerField(default=0)
|
||||
downloaded_at = models.DateTimeField(auto_now_add=True)
|
||||
|
||||
class Meta:
|
||||
db_table = "books_download_record"
|
||||
verbose_name = "Download Record"
|
||||
verbose_name_plural = "Download Records"
|
||||
ordering = ["-downloaded_at"]
|
||||
unique_together = [("user", "ebook")]
|
||||
|
||||
def __str__(self):
|
||||
return f"{self.user} - {self.ebook.title}"
|
||||
|
||||
|
||||
class ReadingProgress(models.Model):
|
||||
user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="reading_progress")
|
||||
ebook = models.OneToOneField(EBook, on_delete=models.CASCADE, related_name="reading_progress")
|
||||
current_position = models.FloatField(default=0.0)
|
||||
last_page = models.IntegerField(default=0)
|
||||
device_id = models.CharField(max_length=128, blank=True, default="")
|
||||
device_name = models.CharField(max_length=128, blank=True, default="")
|
||||
version = models.PositiveIntegerField(default=1)
|
||||
updated_at = models.DateTimeField(auto_now=True)
|
||||
|
||||
class Meta:
|
||||
db_table = "books_reading_progress"
|
||||
verbose_name_plural = "reading progress"
|
||||
unique_together = [("user", "ebook")]
|
||||
|
||||
def __str__(self):
|
||||
return f"{self.ebook.title} - {self.current_position:.1f}%"
|
||||
|
||||
def update_with_sync(self, position: float, last_page: int,
|
||||
device_id: str, device_name: str,
|
||||
client_updated_at: str | None = None) -> tuple["ReadingProgress", bool]:
|
||||
"""Update progress with conflict resolution (last-write-wins by timestamp).
|
||||
|
||||
Returns (instance, applied) where applied is True if the update was applied.
|
||||
"""
|
||||
if client_updated_at and self.updated_at:
|
||||
try:
|
||||
from django.utils.timezone import is_naive, make_aware
|
||||
from datetime import datetime
|
||||
client_dt = datetime.fromisoformat(client_updated_at.replace("Z", "+00:00"))
|
||||
if is_naive(client_dt):
|
||||
client_dt = make_aware(client_dt)
|
||||
if client_dt <= self.updated_at:
|
||||
return self, False
|
||||
except (ValueError, TypeError):
|
||||
pass
|
||||
|
||||
self.current_position = position
|
||||
self.last_page = last_page
|
||||
self.device_id = device_id
|
||||
self.device_name = device_name
|
||||
self.version += 1
|
||||
self.save(update_fields=[
|
||||
"current_position", "last_page",
|
||||
"device_id", "device_name", "version", "updated_at",
|
||||
])
|
||||
return self, True
|
||||
|
||||
|
||||
class ReadingSettings(models.Model):
|
||||
user = models.OneToOneField(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="reading_settings")
|
||||
font_size = models.IntegerField(default=18)
|
||||
font_style = models.CharField(max_length=20, choices=FontStyle.choices, default=FontStyle.SANS_SERIF.value)
|
||||
background_color = models.CharField(max_length=7, choices=BackgroundColor.choices, default=BackgroundColor.WHITE.value)
|
||||
updated_at = models.DateTimeField(auto_now=True)
|
||||
|
||||
class Meta:
|
||||
db_table = "books_reading_settings"
|
||||
verbose_name_plural = "reading settings"
|
||||
|
||||
def __str__(self):
|
||||
return f"Settings for {self.user}"
|
||||
|
||||
|
||||
class Chapter(models.Model):
|
||||
"""A chapter within a book, containing the text/markdown content."""
|
||||
"""A chapter within a book, containing the text/markdown content.
|
||||
|
||||
This is distinct from BookChapter (which tracks EPUB TOC entries).
|
||||
Chapter represents user-authored chapter content for a Book.
|
||||
"""
|
||||
|
||||
book = models.ForeignKey(
|
||||
Book,
|
||||
@@ -48,23 +214,27 @@ class Chapter(models.Model):
|
||||
)
|
||||
]
|
||||
|
||||
def __str__(self) -> str:
|
||||
def __str__(self):
|
||||
return f"{self.book.title} — Ch. {self.number}: {self.title}"
|
||||
|
||||
|
||||
class ReadingProgress(models.Model):
|
||||
"""Tracks a user's reading progress within a book."""
|
||||
class BookReadingProgress(models.Model):
|
||||
"""Tracks a user's reading progress within a book's chapters.
|
||||
|
||||
This is distinct from ReadingProgress (which tracks ebook progress).
|
||||
BookReadingProgress tracks chapter-based reading for Books.
|
||||
"""
|
||||
|
||||
user = models.ForeignKey(
|
||||
"users.User",
|
||||
settings.AUTH_USER_MODEL,
|
||||
on_delete=models.CASCADE,
|
||||
related_name="reading_progress",
|
||||
related_name="book_reading_progress",
|
||||
db_index=True,
|
||||
)
|
||||
book = models.ForeignKey(
|
||||
Book,
|
||||
on_delete=models.CASCADE,
|
||||
related_name="reading_progress",
|
||||
related_name="book_reading_progress",
|
||||
db_index=True,
|
||||
)
|
||||
current_chapter = models.PositiveIntegerField(default=1)
|
||||
@@ -73,16 +243,16 @@ class ReadingProgress(models.Model):
|
||||
updated_at = models.DateTimeField(auto_now=True)
|
||||
|
||||
class Meta:
|
||||
db_table = "books_reading_progress"
|
||||
verbose_name = "Reading Progress"
|
||||
verbose_name_plural = "Reading Progress"
|
||||
db_table = "books_book_reading_progress"
|
||||
verbose_name = "Book Reading Progress"
|
||||
verbose_name_plural = "Book Reading Progress"
|
||||
ordering = ["-updated_at"]
|
||||
constraints = [
|
||||
models.UniqueConstraint(
|
||||
fields=["user", "book"],
|
||||
name="uq_reading_progress_user_book",
|
||||
name="uq_book_reading_progress_user_book",
|
||||
)
|
||||
]
|
||||
|
||||
def __str__(self) -> str:
|
||||
def __str__(self):
|
||||
return f"{self.user} — {self.book.title} ({self.percentage:.0f}%)"
|
||||
Reference in New Issue
Block a user