From 5ab45017830c10c83cc54243a4c82499a72f8d9d Mon Sep 17 00:00:00 2001 From: Alexander-D-Karpov Date: Sat, 5 Aug 2023 11:41:29 +0300 Subject: [PATCH] added shortcutter view meta --- akarpov/static/js/clipboard.min.js | 7 +++ akarpov/templates/base.html | 1 + akarpov/templates/files/view.html | 5 +- akarpov/templates/tools/shortener/create.html | 14 ----- .../tools/shortener/list_create.html | 53 +++++++++++++++++++ akarpov/templates/tools/shortener/view.html | 35 +++++++++++- .../migrations/0002_alter_link_options.py | 17 ++++++ .../migrations/0003_linkviewmeta_user.py | 26 +++++++++ .../0004_alter_linkviewmeta_options.py | 17 ++++++ akarpov/tools/shortener/models.py | 24 +++++++-- akarpov/tools/shortener/services.py | 10 ++++ akarpov/tools/shortener/tasks.py | 15 ++++++ akarpov/tools/shortener/urls.py | 3 +- akarpov/tools/shortener/views.py | 51 +++++++++++++----- clipboard.min.js | 7 +++ poetry.lock | 15 +++++- pyproject.toml | 1 + 17 files changed, 267 insertions(+), 34 deletions(-) create mode 100644 akarpov/static/js/clipboard.min.js delete mode 100644 akarpov/templates/tools/shortener/create.html create mode 100644 akarpov/templates/tools/shortener/list_create.html create mode 100644 akarpov/tools/shortener/migrations/0002_alter_link_options.py create mode 100644 akarpov/tools/shortener/migrations/0003_linkviewmeta_user.py create mode 100644 akarpov/tools/shortener/migrations/0004_alter_linkviewmeta_options.py create mode 100644 akarpov/tools/shortener/tasks.py create mode 100644 clipboard.min.js diff --git a/akarpov/static/js/clipboard.min.js b/akarpov/static/js/clipboard.min.js new file mode 100644 index 0000000..c32b5cc --- /dev/null +++ b/akarpov/static/js/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v2.0.10 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */ +!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return n={686:function(t,e,n){"use strict";n.d(e,{default:function(){return o}});var e=n(279),i=n.n(e),e=n(370),u=n.n(e),e=n(817),c=n.n(e);function a(t){try{return document.execCommand(t)}catch(t){return}}var f=function(t){t=c()(t);return a("cut"),t};var l=function(t){var e,n,o,r=1
+ {# TODO: add cache for sidebar #}
diff --git a/akarpov/templates/files/view.html b/akarpov/templates/files/view.html index 9a91a8e..acacdb3 100644 --- a/akarpov/templates/files/view.html +++ b/akarpov/templates/files/view.html @@ -1,4 +1,5 @@ {% extends 'base.html' %} +{% load static %} {% block meta %} {% autoescape off %} @@ -51,7 +52,7 @@

File is private

{% else %}

File is public{% if file.short_link %}, - short link {% endif %}

@@ -68,7 +69,7 @@ {{ preview_content }} {% endautoescape %}
- + diff --git a/akarpov/templates/tools/shortener/create.html b/akarpov/templates/tools/shortener/create.html deleted file mode 100644 index 0f4c960..0000000 --- a/akarpov/templates/tools/shortener/create.html +++ /dev/null @@ -1,14 +0,0 @@ -{% extends "base.html" %} -{% load crispy_forms_tags %} - -{% block content %} -
- {% csrf_token %} - {{ form|crispy }} -
-
- -
-
-
-{% endblock %} diff --git a/akarpov/templates/tools/shortener/list_create.html b/akarpov/templates/tools/shortener/list_create.html new file mode 100644 index 0000000..abf9ede --- /dev/null +++ b/akarpov/templates/tools/shortener/list_create.html @@ -0,0 +1,53 @@ +{% extends "base.html" %} +{% load crispy_forms_tags %} + +{% block content %} +
+ {% csrf_token %} + {{ form|crispy }} +
+
+ +
+
+
+
+ {% for link in object_list %} +
+
+
{{ link.full_source }}
+ +

Viewed: {{ link.viewed }}

+ +

Created: {{ link.created | time:"H:i"}} {{ link.created | date:"d.m.Y"}}

+

Updated: {{ link.modified | time:"H:i"}} {{ link.modified | date:"d.m.Y"}}

+ +
+
+ {% endfor %} + + {% if page_obj.has_other_pages %} +
+ {% if page_obj.has_previous %} + « + {% endif %} + + {% for page_number in page_obj.paginator.page_range %} + {% if page_obj.number == page_number %} + + {% else %} + + {{ page_number }} + + {% endif %} + {% endfor %} + + {% if page_obj.has_next %} + » + {% endif %} +
+{% endif %} +
+{% endblock %} diff --git a/akarpov/templates/tools/shortener/view.html b/akarpov/templates/tools/shortener/view.html index 0494c7e..3fcd88d 100644 --- a/akarpov/templates/tools/shortener/view.html +++ b/akarpov/templates/tools/shortener/view.html @@ -1,6 +1,39 @@ {% extends "base.html" %} +{% load static %} {% block content %} -{{ link }} +
+

Link to: {{ link.full_source }}

+

{{ request.get_host }}{% url 'short_url' slug=link.slug %}

+

Viewed: {{ link.viewed }} times

+

Recent views:

+ + + + + + + + + + + {% for view in views %} + + + + + + + {% endfor %} + +
IPUser AgentTimeUser
{{ view.ip }}{{ view.user_agent }}{{ view.viewed | time:"H:i:s"}} {{ view.viewed | date:"d.m.Y"}}{% if view.user %}{{ view.user.username }}{% else %} - {% endif %}
+
+ + + {% endblock %} diff --git a/akarpov/tools/shortener/migrations/0002_alter_link_options.py b/akarpov/tools/shortener/migrations/0002_alter_link_options.py new file mode 100644 index 0000000..343fa24 --- /dev/null +++ b/akarpov/tools/shortener/migrations/0002_alter_link_options.py @@ -0,0 +1,17 @@ +# Generated by Django 4.2.3 on 2023-08-04 13:22 + +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ("shortener", "0001_initial"), + ] + + operations = [ + migrations.AlterModelOptions( + name="link", + options={"ordering": ["-modified"]}, + ), + ] diff --git a/akarpov/tools/shortener/migrations/0003_linkviewmeta_user.py b/akarpov/tools/shortener/migrations/0003_linkviewmeta_user.py new file mode 100644 index 0000000..38cc318 --- /dev/null +++ b/akarpov/tools/shortener/migrations/0003_linkviewmeta_user.py @@ -0,0 +1,26 @@ +# Generated by Django 4.2.3 on 2023-08-05 08:28 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ("shortener", "0002_alter_link_options"), + ] + + operations = [ + migrations.AddField( + model_name="linkviewmeta", + name="user", + field=models.ForeignKey( + null=True, + on_delete=django.db.models.deletion.SET_NULL, + related_name="link_views", + to=settings.AUTH_USER_MODEL, + ), + ), + ] diff --git a/akarpov/tools/shortener/migrations/0004_alter_linkviewmeta_options.py b/akarpov/tools/shortener/migrations/0004_alter_linkviewmeta_options.py new file mode 100644 index 0000000..71c02c7 --- /dev/null +++ b/akarpov/tools/shortener/migrations/0004_alter_linkviewmeta_options.py @@ -0,0 +1,17 @@ +# Generated by Django 4.2.3 on 2023-08-05 08:35 + +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ("shortener", "0003_linkviewmeta_user"), + ] + + operations = [ + migrations.AlterModelOptions( + name="linkviewmeta", + options={"ordering": ["-viewed"]}, + ), + ] diff --git a/akarpov/tools/shortener/models.py b/akarpov/tools/shortener/models.py index 6cc8713..717ae1b 100644 --- a/akarpov/tools/shortener/models.py +++ b/akarpov/tools/shortener/models.py @@ -9,7 +9,7 @@ class Link(TimeStampedModel): source = models.URLField(blank=False) - slug = models.SlugField(db_index=True) + slug = models.SlugField(db_index=True, unique=False) creator = models.ForeignKey( "users.User", related_name="links", null=True, on_delete=models.SET_NULL ) @@ -17,12 +17,23 @@ class Link(TimeStampedModel): viewed = models.IntegerField(default=0) + @property + def full_source(self): + return ( + "https://akarpov.ru" + self.source + if self.source.startswith("/") + else self.source + ) + def get_absolute_url(self): - return reverse("short_url", kwargs={"slug": self.slug}) + return reverse("tools:shortener:view", kwargs={"slug": self.slug}) def __str__(self): return f"link to {self.source}" + class Meta: + ordering = ["-modified"] + class LinkViewMeta(models.Model): # TODO: move to mem, delete within 7 days @@ -31,6 +42,12 @@ class LinkViewMeta(models.Model): viewed = models.DateTimeField(auto_now_add=True) ip = models.GenericIPAddressField() user_agent = models.CharField(max_length=200) + user = models.ForeignKey( + "users.User", related_name="link_views", null=True, on_delete=models.SET_NULL + ) + + class Meta: + ordering = ["-viewed"] def __str__(self): return f"view on {self.link.source}" @@ -38,6 +55,7 @@ def __str__(self): def create_model_link(sender, instance, created, **kwargs): # had to move to models due to circular import + # TODO: add link create to celery if created: link = Link(source=instance.get_absolute_url()) if hasattr(instance, "private"): @@ -112,7 +130,7 @@ def __init_subclass__(cls, **kwargs): @abstractmethod def get_absolute_url(self): - ... + raise NotImplementedError @property def get_short_link(self) -> str: diff --git a/akarpov/tools/shortener/services.py b/akarpov/tools/shortener/services.py index 107e4be..eea37d4 100644 --- a/akarpov/tools/shortener/services.py +++ b/akarpov/tools/shortener/services.py @@ -1,3 +1,4 @@ +from functools import lru_cache from secrets import compare_digest from django.conf import settings @@ -28,3 +29,12 @@ def get_link_from_slug(slug: str, check_whole=True) -> Link | bool: return link except Link.DoesNotExist: return False + + +@lru_cache +def get_cached_link_source(slug: str) -> tuple[bool, bool] | tuple[str, int]: + # TODO: add TTL here or update cache on link update + link = get_link_from_slug(slug) + if link: + return link.source, link.pk + return False, False diff --git a/akarpov/tools/shortener/tasks.py b/akarpov/tools/shortener/tasks.py new file mode 100644 index 0000000..8d90cd6 --- /dev/null +++ b/akarpov/tools/shortener/tasks.py @@ -0,0 +1,15 @@ +from celery import shared_task + +from akarpov.tools.shortener.models import Link, LinkViewMeta + + +@shared_task +def save_view_meta(pk, ip, user_agent, user_id): + link = Link.objects.get(pk=pk) + meta = LinkViewMeta(link=link, ip=ip, user_agent=user_agent) + if user_id: + meta.user_id = user_id + meta.save() + link.viewed += 1 + link.save(update_fields=["viewed"]) + return diff --git a/akarpov/tools/shortener/urls.py b/akarpov/tools/shortener/urls.py index be2776c..8257d88 100644 --- a/akarpov/tools/shortener/urls.py +++ b/akarpov/tools/shortener/urls.py @@ -1,10 +1,11 @@ from django.urls import path -from akarpov.tools.shortener.views import short_link_create_view +from akarpov.tools.shortener.views import link_detail_view, short_link_create_view app_name = "shortener" urlpatterns = [ path("", short_link_create_view, name="create"), + path("", link_detail_view, name="view"), path("revoked", short_link_create_view, name="revoked"), ] diff --git a/akarpov/tools/shortener/views.py b/akarpov/tools/shortener/views.py index d5f94c3..4e5ae24 100644 --- a/akarpov/tools/shortener/views.py +++ b/akarpov/tools/shortener/views.py @@ -1,17 +1,25 @@ -from django.core.exceptions import ObjectDoesNotExist, PermissionDenied -from django.http import HttpResponseNotFound, HttpResponseRedirect -from django.views.generic import CreateView, DetailView, TemplateView +from django.core.exceptions import PermissionDenied +from django.http import Http404, HttpResponseNotFound, HttpResponseRedirect +from django.views.generic import CreateView, DetailView, ListView, TemplateView +from ipware import get_client_ip from akarpov.tools.shortener.forms import LinkForm from akarpov.tools.shortener.models import Link -from akarpov.tools.shortener.services import get_link_from_slug +from akarpov.tools.shortener.services import get_cached_link_source, get_link_from_slug +from akarpov.tools.shortener.tasks import save_view_meta -class ShortLinkCreateView(CreateView): +class ShortLinkCreateListView(CreateView, ListView): model = Link form_class = LinkForm + paginate_by = 50 - template_name = "tools/shortener/create.html" + template_name = "tools/shortener/list_create.html" + + def get_queryset(self): + if self.request.user.is_authenticated: + return Link.objects.filter(creator=self.request.user) + return Link.objects.none() def form_valid(self, form): if self.request.user.is_authenticated: @@ -19,21 +27,27 @@ def form_valid(self, form): return super().form_valid(form) -short_link_create_view = ShortLinkCreateView.as_view() +short_link_create_view = ShortLinkCreateListView.as_view() class LinkDetailView(DetailView): - template_name = "tools/shortener/view.html" def get_object(self, *args, **kwargs): link = get_link_from_slug(self.kwargs["slug"]) if not link: - raise ObjectDoesNotExist + raise Http404 + if self.request.user.is_superuser: + return link if link.creator and link.creator != self.request.user: raise PermissionDenied return link + def get_context_data(self, **kwargs): + context = super().get_context_data(**kwargs) + context["views"] = kwargs["object"].views.all().prefetch_related("user") + return context + link_detail_view = LinkDetailView.as_view() @@ -46,8 +60,21 @@ class LinkRevokedView(TemplateView): def redirect_view(request, slug): - # TODO: move to faster framework, like FastApi - link = get_link_from_slug(slug) + # TODO: move to faster framework, like FastAPI + link, pk = get_cached_link_source(slug) if not link: return HttpResponseNotFound("such link doesn't exist or has been revoked") - return HttpResponseRedirect(link.source) + ip, is_routable = get_client_ip(request) + if request.user.is_authenticated: + user_id = request.user.id + else: + user_id = None + save_view_meta.apply_async( + kwargs={ + "pk": pk, + "ip": ip, + "user_agent": request.META["HTTP_USER_AGENT"], + "user_id": user_id, + }, + ) + return HttpResponseRedirect(link) diff --git a/clipboard.min.js b/clipboard.min.js new file mode 100644 index 0000000..c32b5cc --- /dev/null +++ b/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v2.0.10 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */ +!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return n={686:function(t,e,n){"use strict";n.d(e,{default:function(){return o}});var e=n(279),i=n.n(e),e=n(370),u=n.n(e),e=n(817),c=n.n(e);function a(t){try{return document.execCommand(t)}catch(t){return}}var f=function(t){t=c()(t);return a("cut"),t};var l=function(t){var e,n,o,r=1=5.0.3)", "zope.event", "zope.testing"] [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "d06b2a1ccbc8c661df8bc425ccab27516a6dfea1b550976d1338292b47ce8f83" +content-hash = "7ba29eabdec9961c09b653bd8b10f0f2dfd8cab294233495ea61c1f6d4462b08" diff --git a/pyproject.toml b/pyproject.toml index 8713e49..47d1692 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -93,6 +93,7 @@ tablib = "^3.4.0" django-location-field = "^2.7.0" pydantic = "^2.0.2" channels-redis = "^4.1.0" +django-ipware = "^5.0.0" [build-system]