Files
com2care_website/apps/products/models.py
T
2026-10-29 04:39:49 +08:00

656 lines
24 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import os
from django.conf import settings
from django.core.exceptions import ValidationError
from django.db import models
from django.urls import reverse
from django.utils.text import slugify
from apps.core.utils import CONTENT_FORMAT_CHOICES, FORMAT_PLAIN, render_content
from apps.core.video import VideoBlockMixin
from .release_assets import (
FILE_FIELD_BY_ASSET_KEY,
RELEASE_ASSET_KEY_BY_URL_FIELD,
RELEASE_FILE_BY_URL_FIELD,
RELEASE_FILE_HELP_TEXT,
RELEASE_ORIGINAL_FILENAME_BY_ASSET,
RELEASE_ORIGINAL_FILENAME_FIELDS,
release_file_storage,
release_linux_file_upload_to,
release_macos_file_upload_to,
release_source_file_upload_to,
release_windows_file_upload_to,
)
INSTALLABLE_PLATFORM_SPECS = (
("windows_download_url", "Windows", "images/icon-windows.svg"),
("macos_download_url", "macOS", "images/icon-macos.svg"),
("linux_download_url", "Linux", "images/icon-linux.svg"),
("source_code_url", "Source code", None),
)
RELEASE_CHANNEL_STABLE = "stable"
RELEASE_CHANNEL_BETA = "beta"
RELEASE_CHANNEL_RC = "rc"
RELEASE_CHANNEL_PREVIEW = "preview"
RELEASE_CHANNEL_NIGHTLY = "nightly"
RELEASE_CHANNEL_CURRENT = "current"
RELEASE_CHANNEL_PREVIOUS = "previous"
RELEASE_CHANNEL_CHOICES = [
("", "None"),
(RELEASE_CHANNEL_STABLE, "Stable"),
(RELEASE_CHANNEL_BETA, "Beta"),
(RELEASE_CHANNEL_RC, "Release candidate"),
(RELEASE_CHANNEL_PREVIEW, "Preview"),
(RELEASE_CHANNEL_NIGHTLY, "Nightly"),
(RELEASE_CHANNEL_CURRENT, "Current"),
(RELEASE_CHANNEL_PREVIOUS, "Previous"),
]
RELEASE_CHANNEL_LABELS = {
RELEASE_CHANNEL_STABLE: "Stable",
RELEASE_CHANNEL_BETA: "Beta",
RELEASE_CHANNEL_RC: "Release candidate",
RELEASE_CHANNEL_PREVIEW: "Preview",
RELEASE_CHANNEL_NIGHTLY: "Nightly",
RELEASE_CHANNEL_CURRENT: "Current",
RELEASE_CHANNEL_PREVIOUS: "Previous",
}
class MainProduct(models.Model):
created_by = models.ForeignKey(
settings.AUTH_USER_MODEL, on_delete=models.SET_NULL, null=True, blank=True,
related_name="created_main_projects", editable=False,
)
name = models.CharField(max_length=200)
slug = models.SlugField(unique=True, blank=True)
short_description = models.CharField(max_length=300)
read_more_short_description = models.BooleanField(default=False, help_text="Collapse the short description with Read more.")
description = models.TextField()
read_more_description = models.BooleanField(default=False, help_text="Collapse the full description with Read more.")
description_format = models.CharField(
max_length=20, choices=CONTENT_FORMAT_CHOICES, default=FORMAT_PLAIN
)
image = models.ImageField(upload_to="products/main/", blank=True, null=True)
order = models.PositiveIntegerField(default=0)
is_active = models.BooleanField(default=True)
show_on_homepage = models.BooleanField(default=False, help_text="Display this project in the homepage Projects section.")
homepage_order = models.PositiveIntegerField(default=0, help_text="Order within the homepage Projects section.")
created_at = models.DateTimeField(auto_now_add=True)
updated_at = models.DateTimeField(auto_now=True)
class Meta:
ordering = ["order", "name"]
verbose_name = "Main Project"
verbose_name_plural = "Main Projects"
@property
def rendered_description(self):
return render_content(self.description, self.description_format)
def __str__(self):
return self.name
def save(self, *args, **kwargs):
if not self.slug:
self.slug = slugify(self.name)
super().save(*args, **kwargs)
def get_absolute_url(self):
return reverse("products:main_product_detail", kwargs={"main_slug": self.slug})
class SubProduct(models.Model):
created_by = models.ForeignKey(
settings.AUTH_USER_MODEL, on_delete=models.SET_NULL, null=True, blank=True,
related_name="created_sub_projects", editable=False,
)
main_product = models.ForeignKey(
MainProduct,
on_delete=models.CASCADE,
related_name="sub_products",
)
name = models.CharField(max_length=200)
slug = models.SlugField(blank=True)
short_description = models.CharField(max_length=300)
read_more_short_description = models.BooleanField(default=False, help_text="Collapse the short description with Read more.")
description = models.TextField()
read_more_description = models.BooleanField(default=False, help_text="Collapse the full description with Read more.")
description_format = models.CharField(
max_length=20, choices=CONTENT_FORMAT_CHOICES, default=FORMAT_PLAIN
)
image = models.ImageField(upload_to="products/sub/", blank=True, null=True)
logo = models.ImageField(upload_to="products/sub_logos/", blank=True, null=True, help_text="Small logo shown as a corner badge on homepage product cards.")
order = models.PositiveIntegerField(default=0)
is_active = models.BooleanField(default=True)
show_on_homepage = models.BooleanField(default=False, help_text="Display this sub-project in the homepage Projects section.")
homepage_order = models.PositiveIntegerField(default=0, help_text="Order within the homepage Projects section.")
created_at = models.DateTimeField(auto_now_add=True)
updated_at = models.DateTimeField(auto_now=True)
class Meta:
ordering = ["order", "name"]
unique_together = [["main_product", "slug"]]
verbose_name = "Sub-project"
verbose_name_plural = "Sub-projects"
@property
def rendered_description(self):
return render_content(self.description, self.description_format)
def __str__(self):
return f"{self.main_product.name} › {self.name}"
def save(self, *args, **kwargs):
if not self.slug:
self.slug = slugify(self.name)
super().save(*args, **kwargs)
def get_absolute_url(self):
return reverse(
"products:sub_product_detail",
kwargs={
"main_slug": self.main_product.slug,
"sub_slug": self.slug,
},
)
class ProjectAccessPolicy(models.Model):
OWN = "own"
NONE = "none"
ALL_VIEW = "all_view"
ALL_EDIT = "all_edit"
MODE_CHOICES = [
(OWN, "Own projects only"),
(NONE, "No projects by default"),
(ALL_VIEW, "View all projects"),
(ALL_EDIT, "View and edit all projects"),
]
user = models.OneToOneField(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="project_access_policy")
mode = models.CharField(max_length=12, choices=MODE_CHOICES, default=OWN)
def __str__(self):
return f"{self.user}: {self.get_mode_display()}"
class ProjectAccess(models.Model):
NONE = "none"
VIEW = "view"
EDIT = "edit"
LEVEL_CHOICES = [(NONE, "No access"), (VIEW, "View only"), (EDIT, "View and edit")]
user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="project_access_grants")
main_product = models.ForeignKey(MainProduct, on_delete=models.CASCADE, null=True, blank=True, related_name="access_grants")
sub_product = models.ForeignKey(SubProduct, on_delete=models.CASCADE, null=True, blank=True, related_name="access_grants")
level = models.CharField(max_length=4, choices=LEVEL_CHOICES, default=VIEW)
class Meta:
verbose_name = "Project access override"
verbose_name_plural = "Project access overrides"
constraints = [
models.CheckConstraint(
check=(models.Q(main_product__isnull=False, sub_product__isnull=True)
| models.Q(main_product__isnull=True, sub_product__isnull=False)),
name="project_access_exactly_one_project",
),
models.UniqueConstraint(fields=["user", "main_product"], condition=models.Q(main_product__isnull=False), name="unique_user_main_project_access"),
models.UniqueConstraint(fields=["user", "sub_product"], condition=models.Q(sub_product__isnull=False), name="unique_user_sub_project_access"),
]
def clean(self):
super().clean()
if (self.main_product_id is None) == (self.sub_product_id is None):
raise ValidationError("Select exactly one main project or sub-project.")
def __str__(self):
return f"{self.user} → {self.main_product or self.sub_product}: {self.get_level_display()}"
class Article(models.Model):
main_product = models.ForeignKey(
MainProduct,
on_delete=models.CASCADE,
related_name="articles",
null=True,
blank=True,
)
sub_product = models.ForeignKey(
SubProduct,
on_delete=models.CASCADE,
related_name="articles",
null=True,
blank=True,
)
badge = models.CharField(
max_length=100,
blank=True,
help_text="Optional label shown above the article title (e.g. 'Overview', 'Note').",
)
title = models.CharField(max_length=300)
description = models.TextField()
read_more_description = models.BooleanField(default=False, help_text="Collapse this article text with Read more.")
description_format = models.CharField(
max_length=20, choices=CONTENT_FORMAT_CHOICES, default=FORMAT_PLAIN
)
citation_count_display = models.PositiveSmallIntegerField(
null=True,
blank=True,
help_text="Optional number shown in the dashed citation circle badge. Leave blank to show an empty circle (if a label is set) or hide the badge entirely.",
)
citation_count_label = models.CharField(
max_length=50,
blank=True,
default="",
help_text="Optional label shown below the number in the citation circle badge (e.g. 'cited'). Leave blank to show no label.",
)
order = models.PositiveIntegerField(default=0)
created_at = models.DateTimeField(auto_now_add=True)
updated_at = models.DateTimeField(auto_now=True)
class Meta:
ordering = ["order", "title"]
verbose_name = "Article"
verbose_name_plural = "Articles"
constraints = [
models.CheckConstraint(
check=(
models.Q(sub_product__isnull=False, main_product__isnull=True)
| models.Q(sub_product__isnull=True, main_product__isnull=False)
),
name="article_exactly_one_parent",
),
]
@property
def rendered_description(self):
return render_content(self.description, self.description_format)
@property
def people_heading_id(self):
return f"article-{self.pk}-people"
def clean(self):
super().clean()
has_main = self.main_product_id is not None
has_sub = self.sub_product_id is not None
if has_main == has_sub:
raise ValidationError(
"An article must belong to exactly one main project or sub-project."
)
def __str__(self):
return self.title
class ProjectPerson(models.Model):
role = models.CharField(
"Role / group", max_length=100, default="Collaborator",
help_text="Type Lead, Leader, Organizer, Collaborator, or any other role name.",
)
name = models.CharField(max_length=200)
description = models.TextField(blank=True)
read_more_description = models.BooleanField(
default=False, help_text="Collapse this person's description with Read more when it is long."
)
image = models.ImageField(upload_to="products/people/", blank=True, null=True)
image_alt = models.CharField(max_length=240, blank=True)
url = models.URLField(blank=True)
order = models.PositiveIntegerField(
"Display order", default=0,
help_text="Smaller numbers appear first within each role. Leads/Leaders, Organizers, Collaborators, then custom roles.",
)
class Meta:
abstract = True
ordering = [
models.Case(
models.When(role__iexact="lead", then=models.Value(0)),
models.When(role__iexact="leader", then=models.Value(0)),
models.When(role__iexact="organizer", then=models.Value(1)),
models.When(role__iexact="collaborator", then=models.Value(2)),
default=models.Value(3), output_field=models.IntegerField(),
),
"order", "pk",
]
@property
def role_label(self):
return self.role.title() if self.role.casefold() in {"lead", "leader", "organizer", "collaborator"} else self.role
def __str__(self):
return f"{self.name} ({self.role_label})"
class MainProductPerson(ProjectPerson):
main_product = models.ForeignKey(MainProduct, on_delete=models.CASCADE, related_name="people")
class Meta(ProjectPerson.Meta):
verbose_name = "Main project person"
verbose_name_plural = "Main project people"
class SubProductPerson(ProjectPerson):
sub_product = models.ForeignKey(SubProduct, on_delete=models.CASCADE, related_name="people")
class Meta(ProjectPerson.Meta):
verbose_name = "Sub-project person"
verbose_name_plural = "Sub-project people"
class ArticlePerson(ProjectPerson):
article = models.ForeignKey(Article, on_delete=models.CASCADE, related_name="people")
class Meta(ProjectPerson.Meta):
verbose_name = "Project article person"
verbose_name_plural = "Project article people"
class SubProductVersion(models.Model):
main_product = models.ForeignKey(
MainProduct,
on_delete=models.CASCADE,
related_name="versions",
null=True,
blank=True,
)
sub_product = models.ForeignKey(
SubProduct,
on_delete=models.CASCADE,
related_name="versions",
null=True,
blank=True,
)
version = models.CharField(max_length=80)
release_channel = models.CharField(
max_length=20,
choices=RELEASE_CHANNEL_CHOICES,
blank=True,
default="",
help_text="Preset badge for this release (Stable, Beta, Previous, etc.).",
)
channel_label = models.CharField(
max_length=50,
blank=True,
help_text="Optional custom badge text. Overrides the preset channel label when set.",
)
is_featured = models.BooleanField(
default=False,
help_text="Primary release shown at the top of the downloads section.",
)
show_on_product_page = models.BooleanField(
default=False,
help_text="Also show this release on the product page (e.g. beta or previous version).",
)
windows_download_url = models.URLField(blank=True)
macos_download_url = models.URLField(blank=True)
linux_download_url = models.URLField(blank=True)
source_code_url = models.URLField(blank=True)
windows_download_file = models.FileField(
upload_to=release_windows_file_upload_to,
storage=release_file_storage,
blank=True,
help_text=RELEASE_FILE_HELP_TEXT,
)
macos_download_file = models.FileField(
upload_to=release_macos_file_upload_to,
storage=release_file_storage,
blank=True,
help_text=RELEASE_FILE_HELP_TEXT,
)
linux_download_file = models.FileField(
upload_to=release_linux_file_upload_to,
storage=release_file_storage,
blank=True,
help_text=RELEASE_FILE_HELP_TEXT,
)
source_code_file = models.FileField(
upload_to=release_source_file_upload_to,
storage=release_file_storage,
blank=True,
help_text=RELEASE_FILE_HELP_TEXT,
)
windows_download_filename = models.CharField(max_length=255, blank=True)
macos_download_filename = models.CharField(max_length=255, blank=True)
linux_download_filename = models.CharField(max_length=255, blank=True)
source_code_filename = models.CharField(max_length=255, blank=True)
package_resource_url = models.URLField(
blank=True,
help_text="Shown on the site when set. For Resources it is the main Open link; for Installable it appears under the platform grid.",
)
release_notes = models.TextField(blank=True)
is_active = models.BooleanField(default=True)
order = models.PositiveIntegerField(default=0)
class Meta:
ordering = ["order", "version", "pk"]
verbose_name = "Release version"
verbose_name_plural = "Release versions"
constraints = [
models.CheckConstraint(
check=(
models.Q(sub_product__isnull=False, main_product__isnull=True)
| models.Q(sub_product__isnull=True, main_product__isnull=False)
),
name="release_version_exactly_one_parent",
),
models.UniqueConstraint(
fields=["sub_product", "version"],
condition=models.Q(sub_product__isnull=False),
name="release_version_unique_sub_product_version",
),
models.UniqueConstraint(
fields=["main_product", "version"],
condition=models.Q(main_product__isnull=False),
name="release_version_unique_main_product_version",
),
]
def clean(self):
super().clean()
has_main = self.main_product_id is not None
has_sub = self.sub_product_id is not None
if has_main == has_sub:
raise ValidationError(
"A release version must belong to exactly one main product or sub-product."
)
def __str__(self):
parent = self.sub_product or self.main_product
return f"{parent.name} v{self.version}"
@property
def display_channel_label(self):
custom = (self.channel_label or "").strip()
if custom:
return custom
if self.release_channel:
return RELEASE_CHANNEL_LABELS.get(
self.release_channel,
self.release_channel.replace("_", " ").title(),
)
return ""
@property
def display_channel_css_modifier(self):
if (self.channel_label or "").strip():
return "custom"
return self.release_channel or "none"
@property
def is_previous_channel(self):
if self.release_channel == RELEASE_CHANNEL_PREVIOUS:
return True
label = (self.channel_label or "").strip().lower()
return label == "previous"
def save(self, *args, **kwargs):
for file_field, name_field in RELEASE_ORIGINAL_FILENAME_FIELDS.items():
field_file = getattr(self, file_field)
if field_file and field_file._file is not None:
setattr(self, name_field, os.path.basename(field_file.name))
elif not field_file:
setattr(self, name_field, "")
super().save(*args, **kwargs)
def release_download_filename(self, asset):
name_field = RELEASE_ORIGINAL_FILENAME_BY_ASSET.get(asset)
if name_field:
stored = (getattr(self, name_field, "") or "").strip()
if stored:
return stored
file_field = FILE_FIELD_BY_ASSET_KEY.get(asset)
if file_field:
release_file = getattr(self, file_field)
if release_file:
return os.path.basename(release_file.name)
return "download"
def has_platform_asset(self, url_field_name):
if (getattr(self, url_field_name) or "").strip():
return True
file_field = RELEASE_FILE_BY_URL_FIELD.get(url_field_name)
if not file_field:
return False
return bool(getattr(self, file_field))
def resolve_asset_url(self, url_field_name):
url = (getattr(self, url_field_name) or "").strip()
if url:
return url
file_field = RELEASE_FILE_BY_URL_FIELD.get(url_field_name)
if not file_field or not getattr(self, file_field):
return ""
if not self.pk:
return ""
asset = RELEASE_ASSET_KEY_BY_URL_FIELD[url_field_name]
return reverse(
"products:release_asset_download",
kwargs={"version_id": self.pk, "asset": asset},
)
def install_urls_for_specs(self, specs):
out = []
for field_name, label, icon in specs:
url = self.resolve_asset_url(field_name)
if url:
out.append(
{
"field": field_name,
"label": label,
"icon": icon,
"url": url,
"external": bool((getattr(self, field_name) or "").strip()),
}
)
return out
def has_any_install_asset(self):
return any(self.has_platform_asset(f[0]) for f in INSTALLABLE_PLATFORM_SPECS)
@property
def resolved_source_code_url(self):
return self.resolve_asset_url("source_code_url")
def has_package_link(self):
return bool((self.package_resource_url or "").strip())
class ArticleSection(models.Model):
article = models.ForeignKey(
Article,
on_delete=models.CASCADE,
related_name="sections",
)
title = models.CharField(max_length=200)
value = models.TextField()
read_more_value = models.BooleanField(default=False, help_text="Collapse this section text with Read more.")
value_format = models.CharField(
max_length=20, choices=CONTENT_FORMAT_CHOICES, default=FORMAT_PLAIN
)
order = models.PositiveIntegerField(default=0)
class Meta:
ordering = ["order"]
verbose_name = "Article Section"
verbose_name_plural = "Article Sections"
@property
def rendered_value(self):
return render_content(self.value, self.value_format)
def __str__(self):
return f"{self.article.title} › {self.title}"
class ArticleCitation(models.Model):
article = models.ForeignKey(
Article,
on_delete=models.CASCADE,
related_name="citations",
)
text = models.TextField(help_text="Full citation text.")
read_more_text = models.BooleanField(default=False, help_text="Collapse a long citation with Read more.")
url = models.URLField(blank=True, help_text="Optional link to the cited source.")
order = models.PositiveIntegerField(default=0)
class Meta:
ordering = ["order", "pk"]
verbose_name = "Article Citation"
verbose_name_plural = "Article Citations"
def __str__(self):
return f"{self.article.title} — citation {self.order or self.pk}"
class ProductVideo(VideoBlockMixin, models.Model):
main_product = models.ForeignKey(
MainProduct,
on_delete=models.CASCADE,
related_name="videos",
null=True,
blank=True,
)
sub_product = models.ForeignKey(
SubProduct,
on_delete=models.CASCADE,
related_name="videos",
null=True,
blank=True,
)
badge = models.CharField(max_length=100, blank=True)
title = models.CharField(max_length=300, blank=True)
description = models.TextField(blank=True)
read_more_description = models.BooleanField(default=False, help_text="Collapse this video description with Read more.")
order = models.PositiveIntegerField(default=0)
is_active = models.BooleanField(default=True)
class Meta:
ordering = ["order", "pk"]
verbose_name = "Project Video"
verbose_name_plural = "Project Videos"
constraints = [
models.CheckConstraint(
check=(
models.Q(sub_product__isnull=False, main_product__isnull=True)
| models.Q(sub_product__isnull=True, main_product__isnull=False)
),
name="product_video_exactly_one_parent",
),
]
def clean(self):
super().clean()
has_main = self.main_product_id is not None
has_sub = self.sub_product_id is not None
if has_main == has_sub:
raise ValidationError(
"A project video must belong to exactly one main project or sub-project."
)
self.clean_video_fields(require=True)
def __str__(self):
parent = self.sub_product or self.main_product
label = self.title or self.badge or "Video"
return f"{parent} › {label}"