django-snapnote 0.1.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- django_snapnote-0.1.1.dist-info/METADATA +112 -0
- django_snapnote-0.1.1.dist-info/RECORD +34 -0
- django_snapnote-0.1.1.dist-info/WHEEL +4 -0
- django_snapnote-0.1.1.dist-info/licenses/LICENSE +21 -0
- snapnote/__init__.py +1 -0
- snapnote/admin.py +12 -0
- snapnote/apps.py +14 -0
- snapnote/checks.py +22 -0
- snapnote/conf.py +25 -0
- snapnote/forms.py +83 -0
- snapnote/locale/es/LC_MESSAGES/django.mo +0 -0
- snapnote/locale/es/LC_MESSAGES/django.po +186 -0
- snapnote/management/__init__.py +0 -0
- snapnote/management/commands/__init__.py +0 -0
- snapnote/management/commands/snapnote_purge.py +26 -0
- snapnote/middleware.py +32 -0
- snapnote/migrations/0001_initial.py +92 -0
- snapnote/migrations/__init__.py +0 -0
- snapnote/models.py +120 -0
- snapnote/notifiers.py +42 -0
- snapnote/permissions.py +2 -0
- snapnote/signals.py +5 -0
- snapnote/static/snapnote/management.css +26 -0
- snapnote/static/snapnote/snapnote.js +40 -0
- snapnote/templates/snapnote/base.html +12 -0
- snapnote/templates/snapnote/button.html +1 -0
- snapnote/templates/snapnote/includes/status_badge.html +1 -0
- snapnote/templates/snapnote/ticket_confirm_delete.html +12 -0
- snapnote/templates/snapnote/ticket_detail.html +42 -0
- snapnote/templates/snapnote/ticket_list.html +39 -0
- snapnote/templatetags/__init__.py +0 -0
- snapnote/templatetags/snapnote_tags.py +65 -0
- snapnote/urls.py +14 -0
- snapnote/views.py +123 -0
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# Generated by Django 5.2.19 on 2026-11-11 21:14
|
|
2
|
+
|
|
3
|
+
import django.db.models.deletion
|
|
4
|
+
from django.conf import settings
|
|
5
|
+
from django.db import migrations, models
|
|
6
|
+
|
|
7
|
+
import snapnote.models
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class Migration(migrations.Migration):
|
|
11
|
+
initial = True
|
|
12
|
+
|
|
13
|
+
dependencies = [
|
|
14
|
+
migrations.swappable_dependency(settings.AUTH_USER_MODEL),
|
|
15
|
+
]
|
|
16
|
+
|
|
17
|
+
operations = [
|
|
18
|
+
migrations.CreateModel(
|
|
19
|
+
name="Ticket",
|
|
20
|
+
fields=[
|
|
21
|
+
(
|
|
22
|
+
"id",
|
|
23
|
+
models.BigAutoField(
|
|
24
|
+
auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
|
|
25
|
+
),
|
|
26
|
+
),
|
|
27
|
+
("title", models.CharField(max_length=200, verbose_name="title")),
|
|
28
|
+
("description", models.TextField(blank=True, verbose_name="description")),
|
|
29
|
+
("page_url", models.CharField(max_length=2000, verbose_name="page url")),
|
|
30
|
+
(
|
|
31
|
+
"screenshot",
|
|
32
|
+
models.ImageField(
|
|
33
|
+
blank=True,
|
|
34
|
+
max_length=255,
|
|
35
|
+
upload_to=snapnote.models.screenshot_upload_to,
|
|
36
|
+
verbose_name="screenshot",
|
|
37
|
+
),
|
|
38
|
+
),
|
|
39
|
+
(
|
|
40
|
+
"annotations",
|
|
41
|
+
models.ImageField(
|
|
42
|
+
blank=True,
|
|
43
|
+
max_length=255,
|
|
44
|
+
upload_to=snapnote.models.annotations_upload_to,
|
|
45
|
+
verbose_name="annotations",
|
|
46
|
+
),
|
|
47
|
+
),
|
|
48
|
+
(
|
|
49
|
+
"status",
|
|
50
|
+
models.CharField(
|
|
51
|
+
choices=[("open", "open"), ("closed", "closed")],
|
|
52
|
+
default="open",
|
|
53
|
+
max_length=10,
|
|
54
|
+
verbose_name="status",
|
|
55
|
+
),
|
|
56
|
+
),
|
|
57
|
+
(
|
|
58
|
+
"closed_at",
|
|
59
|
+
models.DateTimeField(blank=True, null=True, verbose_name="closed at"),
|
|
60
|
+
),
|
|
61
|
+
("created_at", models.DateTimeField(auto_now_add=True, verbose_name="created at")),
|
|
62
|
+
("updated_at", models.DateTimeField(auto_now=True, verbose_name="updated at")),
|
|
63
|
+
(
|
|
64
|
+
"closed_by",
|
|
65
|
+
models.ForeignKey(
|
|
66
|
+
blank=True,
|
|
67
|
+
null=True,
|
|
68
|
+
on_delete=django.db.models.deletion.SET_NULL,
|
|
69
|
+
related_name="+",
|
|
70
|
+
to=settings.AUTH_USER_MODEL,
|
|
71
|
+
verbose_name="closed by",
|
|
72
|
+
),
|
|
73
|
+
),
|
|
74
|
+
(
|
|
75
|
+
"reported_by",
|
|
76
|
+
models.ForeignKey(
|
|
77
|
+
blank=True,
|
|
78
|
+
null=True,
|
|
79
|
+
on_delete=django.db.models.deletion.SET_NULL,
|
|
80
|
+
related_name="snapnote_tickets",
|
|
81
|
+
to=settings.AUTH_USER_MODEL,
|
|
82
|
+
verbose_name="reported by",
|
|
83
|
+
),
|
|
84
|
+
),
|
|
85
|
+
],
|
|
86
|
+
options={
|
|
87
|
+
"verbose_name": "ticket",
|
|
88
|
+
"verbose_name_plural": "tickets",
|
|
89
|
+
"ordering": ("-created_at", "-pk"),
|
|
90
|
+
},
|
|
91
|
+
),
|
|
92
|
+
]
|
|
File without changes
|
snapnote/models.py
ADDED
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
from urllib.parse import urlsplit
|
|
2
|
+
|
|
3
|
+
from django.conf import settings
|
|
4
|
+
from django.db import models
|
|
5
|
+
from django.urls import NoReverseMatch, reverse
|
|
6
|
+
from django.utils.translation import gettext_lazy as _
|
|
7
|
+
|
|
8
|
+
from . import conf
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def screenshot_upload_to(instance, filename):
|
|
12
|
+
return f"{conf.get('UPLOAD_TO')}screenshots/{filename}"
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
def annotations_upload_to(instance, filename):
|
|
16
|
+
return f"{conf.get('UPLOAD_TO')}annotations/{filename}"
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
class TicketQuerySet(models.QuerySet):
|
|
20
|
+
def search(self, term):
|
|
21
|
+
term = (term or "").strip()
|
|
22
|
+
if not term:
|
|
23
|
+
return self
|
|
24
|
+
from django.apps import apps
|
|
25
|
+
from django.db import connection
|
|
26
|
+
|
|
27
|
+
lookup = "icontains"
|
|
28
|
+
if (
|
|
29
|
+
conf.get("SEARCH_UNACCENT")
|
|
30
|
+
and connection.vendor == "postgresql"
|
|
31
|
+
and apps.is_installed("django.contrib.postgres")
|
|
32
|
+
):
|
|
33
|
+
lookup = "unaccent__icontains"
|
|
34
|
+
query = models.Q()
|
|
35
|
+
for field in ("title", "description", "page_url"):
|
|
36
|
+
query |= models.Q(**{f"{field}__{lookup}": term})
|
|
37
|
+
return self.filter(query)
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
class Ticket(models.Model):
|
|
41
|
+
"""A problem reported by a user from any page, with an optional screenshot."""
|
|
42
|
+
|
|
43
|
+
class Status(models.TextChoices):
|
|
44
|
+
OPEN = "open", _("open")
|
|
45
|
+
CLOSED = "closed", _("closed")
|
|
46
|
+
|
|
47
|
+
title = models.CharField(_("title"), max_length=200)
|
|
48
|
+
description = models.TextField(_("description"), blank=True)
|
|
49
|
+
# Not a URLField: it rejects intranet hosts and http://testserver/.
|
|
50
|
+
page_url = models.CharField(_("page url"), max_length=2000)
|
|
51
|
+
screenshot = models.ImageField(
|
|
52
|
+
_("screenshot"), upload_to=screenshot_upload_to, blank=True, max_length=255
|
|
53
|
+
)
|
|
54
|
+
# Transparent layer with the annotations, kept apart from the screenshot.
|
|
55
|
+
annotations = models.ImageField(
|
|
56
|
+
_("annotations"), upload_to=annotations_upload_to, blank=True, max_length=255
|
|
57
|
+
)
|
|
58
|
+
status = models.CharField(
|
|
59
|
+
_("status"), max_length=10, choices=Status.choices, default=Status.OPEN
|
|
60
|
+
)
|
|
61
|
+
reported_by = models.ForeignKey(
|
|
62
|
+
settings.AUTH_USER_MODEL,
|
|
63
|
+
verbose_name=_("reported by"),
|
|
64
|
+
on_delete=models.SET_NULL,
|
|
65
|
+
null=True,
|
|
66
|
+
blank=True,
|
|
67
|
+
related_name="snapnote_tickets",
|
|
68
|
+
)
|
|
69
|
+
closed_at = models.DateTimeField(_("closed at"), null=True, blank=True)
|
|
70
|
+
closed_by = models.ForeignKey(
|
|
71
|
+
settings.AUTH_USER_MODEL,
|
|
72
|
+
verbose_name=_("closed by"),
|
|
73
|
+
on_delete=models.SET_NULL,
|
|
74
|
+
null=True,
|
|
75
|
+
blank=True,
|
|
76
|
+
related_name="+",
|
|
77
|
+
)
|
|
78
|
+
created_at = models.DateTimeField(_("created at"), auto_now_add=True)
|
|
79
|
+
updated_at = models.DateTimeField(_("updated at"), auto_now=True)
|
|
80
|
+
|
|
81
|
+
objects = TicketQuerySet.as_manager()
|
|
82
|
+
|
|
83
|
+
class Meta:
|
|
84
|
+
verbose_name = _("ticket")
|
|
85
|
+
verbose_name_plural = _("tickets")
|
|
86
|
+
ordering = ("-created_at", "-pk")
|
|
87
|
+
|
|
88
|
+
def __str__(self):
|
|
89
|
+
return f"#{self.pk} {self.title}"
|
|
90
|
+
|
|
91
|
+
def get_absolute_url(self):
|
|
92
|
+
try:
|
|
93
|
+
return reverse("snapnote:ticket_detail", kwargs={"pk": self.pk})
|
|
94
|
+
except NoReverseMatch:
|
|
95
|
+
return ""
|
|
96
|
+
|
|
97
|
+
@property
|
|
98
|
+
def page_path(self):
|
|
99
|
+
parts = urlsplit(self.page_url)
|
|
100
|
+
path = parts.path or "/"
|
|
101
|
+
return f"{path}?{parts.query}" if parts.query else path
|
|
102
|
+
|
|
103
|
+
@property
|
|
104
|
+
def safe_page_url(self):
|
|
105
|
+
"""page_url if its scheme is http(s), else empty (never render javascript: links)."""
|
|
106
|
+
return self.page_url if urlsplit(self.page_url).scheme in ("http", "https") else ""
|
|
107
|
+
|
|
108
|
+
def close(self, user):
|
|
109
|
+
from django.utils import timezone
|
|
110
|
+
|
|
111
|
+
self.status = self.Status.CLOSED
|
|
112
|
+
self.closed_at = timezone.now()
|
|
113
|
+
self.closed_by = user
|
|
114
|
+
self.save(update_fields=["status", "closed_at", "closed_by", "updated_at"])
|
|
115
|
+
|
|
116
|
+
def reopen(self):
|
|
117
|
+
self.status = self.Status.OPEN
|
|
118
|
+
self.closed_at = None
|
|
119
|
+
self.closed_by = None
|
|
120
|
+
self.save(update_fields=["status", "closed_at", "closed_by", "updated_at"])
|
snapnote/notifiers.py
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import logging
|
|
2
|
+
|
|
3
|
+
from django.conf import settings
|
|
4
|
+
from django.core.mail import send_mail
|
|
5
|
+
from django.utils.translation import gettext as _
|
|
6
|
+
|
|
7
|
+
from . import conf
|
|
8
|
+
|
|
9
|
+
logger = logging.getLogger("snapnote")
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
def email(ticket, absolute_url):
|
|
13
|
+
recipients = list(conf.get("NOTIFY_EMAILS"))
|
|
14
|
+
if not recipients:
|
|
15
|
+
return
|
|
16
|
+
body = "\n".join(
|
|
17
|
+
part
|
|
18
|
+
for part in (
|
|
19
|
+
ticket.description,
|
|
20
|
+
f"{_('Page')}: {ticket.page_url}",
|
|
21
|
+
f"{_('Ticket')}: {absolute_url}" if absolute_url else "",
|
|
22
|
+
)
|
|
23
|
+
if part
|
|
24
|
+
)
|
|
25
|
+
send_mail(
|
|
26
|
+
subject=f"[Snapnote] {ticket.title}",
|
|
27
|
+
message=body,
|
|
28
|
+
from_email=getattr(settings, "DEFAULT_FROM_EMAIL", None),
|
|
29
|
+
recipient_list=recipients,
|
|
30
|
+
)
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
def run_notifiers(sender, ticket, request_url="", **kwargs):
|
|
34
|
+
"""Runs every configured notifier; a failing one never breaks the others."""
|
|
35
|
+
from django.utils.module_loading import import_string
|
|
36
|
+
|
|
37
|
+
for path in conf.get("NOTIFIERS"):
|
|
38
|
+
try:
|
|
39
|
+
notifier = import_string(path) if isinstance(path, str) else path
|
|
40
|
+
notifier(ticket, request_url)
|
|
41
|
+
except Exception:
|
|
42
|
+
logger.exception("Snapnote notifier %r failed", path)
|
snapnote/permissions.py
ADDED
snapnote/signals.py
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
:root {
|
|
2
|
+
--snapnote-accent: #e5383b;
|
|
3
|
+
--snapnote-border: #d0d4d9;
|
|
4
|
+
--snapnote-muted: #6b7280;
|
|
5
|
+
}
|
|
6
|
+
.snapnote-body { margin: 0; font-family: system-ui, sans-serif; color: #1f2933; }
|
|
7
|
+
.snapnote-wrap { max-width: 72rem; margin: 0 auto; padding: 1rem; }
|
|
8
|
+
.snapnote-table { width: 100%; border-collapse: collapse; margin: 1rem 0; }
|
|
9
|
+
.snapnote-table th, .snapnote-table td { border: 1px solid var(--snapnote-border); padding: .4rem .6rem; text-align: left; vertical-align: top; }
|
|
10
|
+
.snapnote-detail th { width: 10rem; background: #f3f4f6; }
|
|
11
|
+
.snapnote-empty { text-align: center; color: var(--snapnote-muted); }
|
|
12
|
+
.snapnote-filter { display: flex; gap: .5rem; flex-wrap: wrap; }
|
|
13
|
+
.snapnote-actions { display: flex; gap: .5rem; }
|
|
14
|
+
.snapnote-btn { display: inline-block; padding: .35rem .8rem; border: 1px solid var(--snapnote-border); border-radius: .3rem; background: #fff; color: inherit; text-decoration: none; cursor: pointer; font: inherit; }
|
|
15
|
+
.snapnote-btn-ok { background: #2f9e44; border-color: #2f9e44; color: #fff; }
|
|
16
|
+
.snapnote-btn-danger { color: var(--snapnote-accent); border-color: var(--snapnote-accent); }
|
|
17
|
+
.snapnote-badge { padding: .1rem .5rem; border-radius: 1rem; font-size: .85em; }
|
|
18
|
+
.snapnote-badge-open { background: #fde8e8; color: #b42318; }
|
|
19
|
+
.snapnote-badge-closed { background: #e6f4ea; color: #1e6b34; }
|
|
20
|
+
.snapnote-alert { padding: .8rem; background: #fde8e8; border-radius: .3rem; }
|
|
21
|
+
.snapnote-pagination { display: flex; gap: 1rem; justify-content: center; }
|
|
22
|
+
.snapnote-shot-frame { position: relative; display: inline-block; max-width: 100%; border: 1px solid var(--snapnote-border); }
|
|
23
|
+
.snapnote-shot-frame img { display: block; max-width: 100%; }
|
|
24
|
+
.snapnote-shot-frame .snapnote-annotations { position: absolute; inset: 0; width: 100%; height: 100%; pointer-events: none; }
|
|
25
|
+
.snapnote-shot { margin-top: 1rem; }
|
|
26
|
+
.snapnote-shot:has(#snapnote-ann-toggle:not(:checked)) .snapnote-annotations { display: none; }
|