mirror of
https://github.com/sissbruecker/linkding.git
synced 2026-02-27 22:43:15 +08:00
7333b283cf
* basic pdf snapshots * cleanup website_loader tests * cleanup asset tests * cleanup asset service tests * use PDF download as display name * update new snapshot name * update docs * update e2e test * update test
544 lines
18 KiB
Python
544 lines
18 KiB
Python
import binascii
|
|
import hashlib
|
|
import logging
|
|
import os
|
|
|
|
from django.conf import settings
|
|
from django.contrib.auth.models import User
|
|
from django.core.validators import MinValueValidator
|
|
from django.db import models
|
|
from django.db.models import Q
|
|
from django.db.models.signals import post_delete, post_save
|
|
from django.dispatch import receiver
|
|
from django.http import QueryDict
|
|
|
|
from bookmarks.utils import normalize_url, unique
|
|
from bookmarks.validators import BookmarkURLValidator
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class Tag(models.Model):
|
|
name = models.CharField(max_length=64)
|
|
date_added = models.DateTimeField()
|
|
owner = models.ForeignKey(User, on_delete=models.CASCADE)
|
|
|
|
def __str__(self):
|
|
return self.name
|
|
|
|
|
|
def sanitize_tag_name(tag_name: str):
|
|
# strip leading/trailing spaces
|
|
# replace inner spaces with replacement char
|
|
return tag_name.strip().replace(" ", "-")
|
|
|
|
|
|
def parse_tag_string(tag_string: str, delimiter: str = ","):
|
|
if not tag_string:
|
|
return []
|
|
names = tag_string.strip().split(delimiter)
|
|
# remove empty names, sanitize remaining names
|
|
names = [sanitize_tag_name(name) for name in names if name.strip()]
|
|
# remove duplicates
|
|
names = unique(names, str.lower)
|
|
names.sort(key=str.lower)
|
|
|
|
return names
|
|
|
|
|
|
def build_tag_string(tag_names: list[str], delimiter: str = ","):
|
|
return delimiter.join(tag_names)
|
|
|
|
|
|
class Bookmark(models.Model):
|
|
url = models.CharField(max_length=2048, validators=[BookmarkURLValidator()])
|
|
url_normalized = models.CharField(max_length=2048, blank=True, db_index=True)
|
|
title = models.CharField(max_length=512, blank=True)
|
|
description = models.TextField(blank=True)
|
|
notes = models.TextField(blank=True)
|
|
# Obsolete field, kept to not remove column when generating migrations
|
|
website_title = models.CharField(max_length=512, blank=True, null=True)
|
|
# Obsolete field, kept to not remove column when generating migrations
|
|
website_description = models.TextField(blank=True, null=True)
|
|
web_archive_snapshot_url = models.CharField(max_length=2048, blank=True)
|
|
favicon_file = models.CharField(max_length=512, blank=True)
|
|
preview_image_file = models.CharField(max_length=512, blank=True)
|
|
unread = models.BooleanField(default=False)
|
|
is_archived = models.BooleanField(default=False)
|
|
shared = models.BooleanField(default=False)
|
|
date_added = models.DateTimeField()
|
|
date_modified = models.DateTimeField()
|
|
date_accessed = models.DateTimeField(blank=True, null=True)
|
|
owner = models.ForeignKey(User, on_delete=models.CASCADE)
|
|
tags = models.ManyToManyField(Tag)
|
|
latest_snapshot = models.ForeignKey(
|
|
"BookmarkAsset",
|
|
on_delete=models.SET_NULL,
|
|
null=True,
|
|
blank=True,
|
|
related_name="latest_snapshot",
|
|
)
|
|
|
|
@property
|
|
def resolved_title(self):
|
|
if self.title:
|
|
return self.title
|
|
else:
|
|
return self.url
|
|
|
|
@property
|
|
def resolved_description(self):
|
|
return self.description
|
|
|
|
@property
|
|
def tag_names(self):
|
|
names = [tag.name for tag in self.tags.all()]
|
|
return sorted(names)
|
|
|
|
def save(self, *args, **kwargs):
|
|
self.url_normalized = normalize_url(self.url)
|
|
super().save(*args, **kwargs)
|
|
|
|
def __str__(self):
|
|
return self.resolved_title + " (" + self.url[:30] + "...)"
|
|
|
|
@staticmethod
|
|
def query_existing(owner: User, url: str) -> models.QuerySet:
|
|
# Find existing bookmark by normalized URL, or fall back to exact URL if
|
|
# normalized URL was not generated for whatever reason
|
|
normalized_url = normalize_url(url)
|
|
q = Q(owner=owner) & (
|
|
Q(url_normalized=normalized_url) | Q(url_normalized="", url=url)
|
|
)
|
|
return Bookmark.objects.filter(q)
|
|
|
|
|
|
@receiver(post_delete, sender=Bookmark)
|
|
def bookmark_deleted(sender, instance, **kwargs):
|
|
if instance.preview_image_file:
|
|
filepath = os.path.join(settings.LD_PREVIEW_FOLDER, instance.preview_image_file)
|
|
if os.path.isfile(filepath):
|
|
try:
|
|
os.remove(filepath)
|
|
except Exception as error:
|
|
logger.error(
|
|
f"Failed to delete preview image: {filepath}", exc_info=error
|
|
)
|
|
|
|
|
|
class BookmarkAsset(models.Model):
|
|
TYPE_SNAPSHOT = "snapshot"
|
|
TYPE_UPLOAD = "upload"
|
|
|
|
CONTENT_TYPE_HTML = "text/html"
|
|
CONTENT_TYPE_PDF = "application/pdf"
|
|
|
|
STATUS_PENDING = "pending"
|
|
STATUS_COMPLETE = "complete"
|
|
STATUS_FAILURE = "failure"
|
|
|
|
bookmark = models.ForeignKey(Bookmark, on_delete=models.CASCADE)
|
|
date_created = models.DateTimeField(auto_now_add=True, null=False)
|
|
file = models.CharField(max_length=2048, blank=True, null=False)
|
|
file_size = models.IntegerField(null=True)
|
|
asset_type = models.CharField(max_length=64, blank=False, null=False)
|
|
content_type = models.CharField(max_length=128, blank=False, null=False)
|
|
display_name = models.CharField(max_length=2048, blank=True, null=False)
|
|
status = models.CharField(max_length=64, blank=False, null=False)
|
|
gzip = models.BooleanField(default=False, null=False)
|
|
|
|
@property
|
|
def download_name(self):
|
|
if self.asset_type == BookmarkAsset.TYPE_SNAPSHOT:
|
|
if self.content_type == BookmarkAsset.CONTENT_TYPE_PDF:
|
|
return f"{self.display_name}.pdf"
|
|
return f"{self.display_name}.html"
|
|
return self.display_name
|
|
|
|
def save(self, *args, **kwargs):
|
|
if self.file:
|
|
try:
|
|
file_path = os.path.join(settings.LD_ASSET_FOLDER, self.file)
|
|
if os.path.isfile(file_path):
|
|
self.file_size = os.path.getsize(file_path)
|
|
except Exception:
|
|
pass
|
|
super().save(*args, **kwargs)
|
|
|
|
def __str__(self):
|
|
return self.display_name or f"Bookmark Asset #{self.pk}"
|
|
|
|
|
|
@receiver(post_delete, sender=BookmarkAsset)
|
|
def bookmark_asset_deleted(sender, instance, **kwargs):
|
|
if instance.file:
|
|
filepath = os.path.join(settings.LD_ASSET_FOLDER, instance.file)
|
|
if os.path.isfile(filepath):
|
|
try:
|
|
os.remove(filepath)
|
|
except Exception as error:
|
|
logger.error(f"Failed to delete asset file: {filepath}", exc_info=error)
|
|
|
|
|
|
class BookmarkBundle(models.Model):
|
|
name = models.CharField(max_length=256, blank=False)
|
|
search = models.CharField(max_length=256, blank=True)
|
|
any_tags = models.CharField(max_length=1024, blank=True)
|
|
all_tags = models.CharField(max_length=1024, blank=True)
|
|
excluded_tags = models.CharField(max_length=1024, blank=True)
|
|
order = models.IntegerField(null=False, default=0)
|
|
date_created = models.DateTimeField(auto_now_add=True, null=False)
|
|
date_modified = models.DateTimeField(auto_now=True, null=False)
|
|
owner = models.ForeignKey(User, on_delete=models.CASCADE)
|
|
|
|
def __str__(self):
|
|
return self.name
|
|
|
|
|
|
class BookmarkSearch:
|
|
SORT_ADDED_ASC = "added_asc"
|
|
SORT_ADDED_DESC = "added_desc"
|
|
SORT_TITLE_ASC = "title_asc"
|
|
SORT_TITLE_DESC = "title_desc"
|
|
|
|
FILTER_SHARED_OFF = "off"
|
|
FILTER_SHARED_SHARED = "yes"
|
|
FILTER_SHARED_UNSHARED = "no"
|
|
|
|
FILTER_UNREAD_OFF = "off"
|
|
FILTER_UNREAD_YES = "yes"
|
|
FILTER_UNREAD_NO = "no"
|
|
|
|
params = [
|
|
"q",
|
|
"user",
|
|
"bundle",
|
|
"sort",
|
|
"shared",
|
|
"unread",
|
|
"modified_since",
|
|
"added_since",
|
|
]
|
|
preferences = ["sort", "shared", "unread"]
|
|
defaults = {
|
|
"q": "",
|
|
"user": "",
|
|
"bundle": None,
|
|
"sort": SORT_ADDED_DESC,
|
|
"shared": FILTER_SHARED_OFF,
|
|
"unread": FILTER_UNREAD_OFF,
|
|
"modified_since": None,
|
|
"added_since": None,
|
|
}
|
|
|
|
def __init__(
|
|
self,
|
|
q: str = None,
|
|
user: str = None,
|
|
bundle: BookmarkBundle = None,
|
|
sort: str = None,
|
|
shared: str = None,
|
|
unread: str = None,
|
|
modified_since: str = None,
|
|
added_since: str = None,
|
|
preferences: dict = None,
|
|
request: any = None,
|
|
):
|
|
if not preferences:
|
|
preferences = {}
|
|
self.defaults = {**BookmarkSearch.defaults, **preferences}
|
|
self.request = request
|
|
|
|
self.q = q or self.defaults["q"]
|
|
self.user = user or self.defaults["user"]
|
|
self.bundle = bundle or self.defaults["bundle"]
|
|
self.sort = sort or self.defaults["sort"]
|
|
self.shared = shared or self.defaults["shared"]
|
|
self.unread = unread or self.defaults["unread"]
|
|
self.modified_since = modified_since or self.defaults["modified_since"]
|
|
self.added_since = added_since or self.defaults["added_since"]
|
|
|
|
def is_modified(self, param):
|
|
value = self.__dict__[param]
|
|
return value != self.defaults[param]
|
|
|
|
@property
|
|
def modified_params(self):
|
|
return [field for field in self.params if self.is_modified(field)]
|
|
|
|
@property
|
|
def modified_preferences(self):
|
|
return [
|
|
preference
|
|
for preference in self.preferences
|
|
if self.is_modified(preference)
|
|
]
|
|
|
|
@property
|
|
def has_modifications(self):
|
|
return len(self.modified_params) > 0
|
|
|
|
@property
|
|
def has_modified_preferences(self):
|
|
return len(self.modified_preferences) > 0
|
|
|
|
@property
|
|
def query_params(self):
|
|
query_params = {}
|
|
for param in self.modified_params:
|
|
value = self.__dict__[param]
|
|
if isinstance(value, models.Model):
|
|
query_params[param] = value.id
|
|
else:
|
|
query_params[param] = value
|
|
return query_params
|
|
|
|
@property
|
|
def preferences_dict(self):
|
|
return {
|
|
preference: self.__dict__[preference] for preference in self.preferences
|
|
}
|
|
|
|
@staticmethod
|
|
def from_request(request: any, query_dict: QueryDict, preferences: dict = None):
|
|
initial_values = {}
|
|
for param in BookmarkSearch.params:
|
|
value = query_dict.get(param)
|
|
if value:
|
|
if param == "bundle":
|
|
initial_values[param] = BookmarkBundle.objects.filter(
|
|
owner=request.user, pk=value
|
|
).first()
|
|
else:
|
|
initial_values[param] = value
|
|
|
|
return BookmarkSearch(
|
|
**initial_values, preferences=preferences, request=request
|
|
)
|
|
|
|
|
|
class UserProfile(models.Model):
|
|
THEME_AUTO = "auto"
|
|
THEME_LIGHT = "light"
|
|
THEME_DARK = "dark"
|
|
THEME_CHOICES = [
|
|
(THEME_AUTO, "Auto"),
|
|
(THEME_LIGHT, "Light"),
|
|
(THEME_DARK, "Dark"),
|
|
]
|
|
BOOKMARK_DATE_DISPLAY_RELATIVE = "relative"
|
|
BOOKMARK_DATE_DISPLAY_ABSOLUTE = "absolute"
|
|
BOOKMARK_DATE_DISPLAY_HIDDEN = "hidden"
|
|
BOOKMARK_DATE_DISPLAY_CHOICES = [
|
|
(BOOKMARK_DATE_DISPLAY_RELATIVE, "Relative"),
|
|
(BOOKMARK_DATE_DISPLAY_ABSOLUTE, "Absolute"),
|
|
(BOOKMARK_DATE_DISPLAY_HIDDEN, "Hidden"),
|
|
]
|
|
BOOKMARK_DESCRIPTION_DISPLAY_INLINE = "inline"
|
|
BOOKMARK_DESCRIPTION_DISPLAY_SEPARATE = "separate"
|
|
BOOKMARK_DESCRIPTION_DISPLAY_CHOICES = [
|
|
(BOOKMARK_DESCRIPTION_DISPLAY_INLINE, "Inline"),
|
|
(BOOKMARK_DESCRIPTION_DISPLAY_SEPARATE, "Separate"),
|
|
]
|
|
BOOKMARK_LINK_TARGET_BLANK = "_blank"
|
|
BOOKMARK_LINK_TARGET_SELF = "_self"
|
|
BOOKMARK_LINK_TARGET_CHOICES = [
|
|
(BOOKMARK_LINK_TARGET_BLANK, "New page"),
|
|
(BOOKMARK_LINK_TARGET_SELF, "Same page"),
|
|
]
|
|
WEB_ARCHIVE_INTEGRATION_DISABLED = "disabled"
|
|
WEB_ARCHIVE_INTEGRATION_ENABLED = "enabled"
|
|
WEB_ARCHIVE_INTEGRATION_CHOICES = [
|
|
(WEB_ARCHIVE_INTEGRATION_DISABLED, "Disabled"),
|
|
(WEB_ARCHIVE_INTEGRATION_ENABLED, "Enabled"),
|
|
]
|
|
TAG_SEARCH_STRICT = "strict"
|
|
TAG_SEARCH_LAX = "lax"
|
|
TAG_SEARCH_CHOICES = [
|
|
(TAG_SEARCH_STRICT, "Strict"),
|
|
(TAG_SEARCH_LAX, "Lax"),
|
|
]
|
|
TAG_GROUPING_ALPHABETICAL = "alphabetical"
|
|
TAG_GROUPING_DISABLED = "disabled"
|
|
TAG_GROUPING_CHOICES = [
|
|
(TAG_GROUPING_ALPHABETICAL, "Alphabetical"),
|
|
(TAG_GROUPING_DISABLED, "Disabled"),
|
|
]
|
|
user = models.OneToOneField(User, related_name="profile", on_delete=models.CASCADE)
|
|
theme = models.CharField(
|
|
max_length=10, choices=THEME_CHOICES, blank=False, default=THEME_AUTO
|
|
)
|
|
bookmark_date_display = models.CharField(
|
|
max_length=10,
|
|
choices=BOOKMARK_DATE_DISPLAY_CHOICES,
|
|
blank=False,
|
|
default=BOOKMARK_DATE_DISPLAY_RELATIVE,
|
|
)
|
|
bookmark_description_display = models.CharField(
|
|
max_length=10,
|
|
choices=BOOKMARK_DESCRIPTION_DISPLAY_CHOICES,
|
|
blank=False,
|
|
default=BOOKMARK_DESCRIPTION_DISPLAY_INLINE,
|
|
)
|
|
bookmark_description_max_lines = models.IntegerField(
|
|
null=False,
|
|
default=1,
|
|
)
|
|
bookmark_link_target = models.CharField(
|
|
max_length=10,
|
|
choices=BOOKMARK_LINK_TARGET_CHOICES,
|
|
blank=False,
|
|
default=BOOKMARK_LINK_TARGET_BLANK,
|
|
)
|
|
web_archive_integration = models.CharField(
|
|
max_length=10,
|
|
choices=WEB_ARCHIVE_INTEGRATION_CHOICES,
|
|
blank=False,
|
|
default=WEB_ARCHIVE_INTEGRATION_DISABLED,
|
|
)
|
|
tag_search = models.CharField(
|
|
max_length=10,
|
|
choices=TAG_SEARCH_CHOICES,
|
|
blank=False,
|
|
default=TAG_SEARCH_STRICT,
|
|
)
|
|
tag_grouping = models.CharField(
|
|
max_length=12,
|
|
choices=TAG_GROUPING_CHOICES,
|
|
blank=False,
|
|
default=TAG_GROUPING_ALPHABETICAL,
|
|
)
|
|
enable_sharing = models.BooleanField(default=False, null=False)
|
|
enable_public_sharing = models.BooleanField(default=False, null=False)
|
|
enable_favicons = models.BooleanField(default=False, null=False)
|
|
enable_preview_images = models.BooleanField(default=False, null=False)
|
|
display_url = models.BooleanField(default=False, null=False)
|
|
display_view_bookmark_action = models.BooleanField(default=True, null=False)
|
|
display_edit_bookmark_action = models.BooleanField(default=True, null=False)
|
|
display_archive_bookmark_action = models.BooleanField(default=True, null=False)
|
|
display_remove_bookmark_action = models.BooleanField(default=True, null=False)
|
|
permanent_notes = models.BooleanField(default=False, null=False)
|
|
custom_css = models.TextField(blank=True, null=False)
|
|
custom_css_hash = models.CharField(blank=True, null=False, max_length=32)
|
|
auto_tagging_rules = models.TextField(blank=True, null=False)
|
|
search_preferences = models.JSONField(default=dict, null=False)
|
|
enable_automatic_html_snapshots = models.BooleanField(default=True, null=False)
|
|
default_mark_unread = models.BooleanField(default=False, null=False)
|
|
default_mark_shared = models.BooleanField(default=False, null=False)
|
|
items_per_page = models.IntegerField(
|
|
null=False, default=30, validators=[MinValueValidator(10)]
|
|
)
|
|
sticky_pagination = models.BooleanField(default=False, null=False)
|
|
collapse_side_panel = models.BooleanField(default=False, null=False)
|
|
hide_bundles = models.BooleanField(default=False, null=False)
|
|
legacy_search = models.BooleanField(default=False, null=False)
|
|
|
|
def save(self, *args, **kwargs):
|
|
if self.custom_css:
|
|
self.custom_css_hash = hashlib.md5(
|
|
self.custom_css.encode("utf-8")
|
|
).hexdigest()
|
|
else:
|
|
self.custom_css_hash = ""
|
|
super().save(*args, **kwargs)
|
|
|
|
|
|
@receiver(post_save, sender=User)
|
|
def create_user_profile(sender, instance, created, **kwargs):
|
|
if created:
|
|
UserProfile.objects.create(user=instance)
|
|
|
|
|
|
@receiver(post_save, sender=User)
|
|
def save_user_profile(sender, instance, **kwargs):
|
|
instance.profile.save()
|
|
|
|
|
|
class Toast(models.Model):
|
|
key = models.CharField(max_length=50)
|
|
message = models.TextField()
|
|
acknowledged = models.BooleanField(default=False)
|
|
owner = models.ForeignKey(User, on_delete=models.CASCADE)
|
|
|
|
|
|
class FeedToken(models.Model):
|
|
"""
|
|
Adapted from authtoken.models.Token
|
|
"""
|
|
|
|
key = models.CharField(max_length=40, primary_key=True)
|
|
user = models.OneToOneField(
|
|
User,
|
|
related_name="feed_token",
|
|
on_delete=models.CASCADE,
|
|
)
|
|
created = models.DateTimeField(auto_now_add=True)
|
|
|
|
def save(self, *args, **kwargs):
|
|
if not self.key:
|
|
self.key = self.generate_key()
|
|
return super().save(*args, **kwargs)
|
|
|
|
@classmethod
|
|
def generate_key(cls):
|
|
return binascii.hexlify(os.urandom(20)).decode()
|
|
|
|
def __str__(self):
|
|
return self.key
|
|
|
|
|
|
class ApiToken(models.Model):
|
|
key = models.CharField(max_length=40, unique=True)
|
|
user = models.ForeignKey(
|
|
User,
|
|
related_name="api_tokens",
|
|
on_delete=models.CASCADE,
|
|
)
|
|
name = models.CharField(max_length=128, blank=False)
|
|
created = models.DateTimeField(auto_now_add=True)
|
|
|
|
def save(self, *args, **kwargs):
|
|
if not self.key:
|
|
self.key = self.generate_key()
|
|
return super().save(*args, **kwargs)
|
|
|
|
@classmethod
|
|
def generate_key(cls):
|
|
return binascii.hexlify(os.urandom(20)).decode()
|
|
|
|
def __str__(self):
|
|
return f"{self.name} ({self.user.username})"
|
|
|
|
|
|
class GlobalSettings(models.Model):
|
|
LANDING_PAGE_LOGIN = "login"
|
|
LANDING_PAGE_SHARED_BOOKMARKS = "shared_bookmarks"
|
|
LANDING_PAGE_CHOICES = [
|
|
(LANDING_PAGE_LOGIN, "Login"),
|
|
(LANDING_PAGE_SHARED_BOOKMARKS, "Shared Bookmarks"),
|
|
]
|
|
|
|
landing_page = models.CharField(
|
|
max_length=50,
|
|
choices=LANDING_PAGE_CHOICES,
|
|
blank=False,
|
|
default=LANDING_PAGE_LOGIN,
|
|
)
|
|
guest_profile_user = models.ForeignKey(
|
|
User, on_delete=models.SET_NULL, null=True, blank=True
|
|
)
|
|
enable_link_prefetch = models.BooleanField(default=False, null=False)
|
|
|
|
@classmethod
|
|
def get(cls):
|
|
instance = GlobalSettings.objects.first()
|
|
if not instance:
|
|
instance = GlobalSettings()
|
|
instance.save()
|
|
return instance
|
|
|
|
def save(self, *args, **kwargs):
|
|
if not self.pk and GlobalSettings.objects.exists():
|
|
raise Exception("There is already one instance of GlobalSettings")
|
|
return super().save(*args, **kwargs)
|