Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Allow filtering exercise edits

Roland Geiderff5974232e75
diff --git a/wger/exercises/templates/history/overview.html b/wger/exercises/templates/history/overview.html
index 540e1f6c8..8c747e5b1 100644
--- a/wger/exercises/templates/history/overview.html
+++ b/wger/exercises/templates/history/overview.html
@@ -21,12 +21,54 @@
Main Content
-->
{% block content %}
+
+ <div class="row mb-3">
+ <div class="col-md-4">
+ <div class="card">
+ <div class="card-body py-2">
+ <small class="text-muted">{% translate "Edits last 24h" %}</small>
+ <h4 class="mb-0">{{ stats.last_24h }}</h4>
+ </div>
+ </div>
+ </div>
+ <div class="col-md-4">
+ <div class="card">
+ <div class="card-body py-2">
+ <small class="text-muted">{% translate "Edits last 7d" %}</small>
+ <h4 class="mb-0">{{ stats.last_7d }}</h4>
+ </div>
+ </div>
+ </div>
+ <div class="col-md-4">
+ <div class="card">
+ <div class="card-body py-2">
+ <small class="text-muted">{% translate "Edits last 30d" %}</small>
+ <h4 class="mb-0">{{ stats.last_30d }}</h4>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <form method="get" class="row g-2 align-items-end mb-3">
+ {% for field in filter.form %}
+ <div class="col-md-2">
+ <label for="{{ field.id_for_label }}" class="form-label mb-0">{{ field.label }}</label>
+ {{ field }}
+ </div>
+ {% endfor %}
+ <div class="col-md-2 d-flex gap-2">
+ <button type="submit" class="btn btn-sm btn-primary">{% translate "Apply" %}</button>
+ <a href="{% url 'exercise:history:overview' %}" class="btn btn-sm btn-outline-secondary">{% translate "Reset" %}</a>
+ </div>
+ </form>
+
<table class="table">
<thead class="thead-light">
<tr>
<th scope="col" style="width: 5%">{% translate 'Action' %}</th>
- <th scope="col" style="width: 5%">{% translate 'User' %}</th>
- <th scope="col" style="width: 45%">{% translate 'Object' %}</th>
+ <th scope="col" style="width: 10%">{% translate 'User' %}</th>
+ <th scope="col" style="width: 8%">{% translate 'Type' %}</th>
+ <th scope="col" style="width: 32%">{% translate 'Object' %}</th>
<th scope="col" style="width: 15%">{% translate 'Time' %}</th>
<th scope="col" style="width: 15%">{% translate 'Changes' %}</th>
<th scope="col" style="width: 15%">{% translate 'Revert' %}</th>
@@ -34,7 +76,7 @@
</thead>
<tbody>
{% for event in context %}
- <tr>
+ <tr {% if event.is_new_contributor %}class="table-warning"{% endif %}>
<td>
{% if event.stream.verb == verbs.CREATED.value %}
<span class="{% fa_class 'circle-plus' %}"></span>
@@ -44,9 +86,23 @@
{{ event.verb }}
{% endif %}
</td>
- <td>{{ event.stream.actor }}</td>
<td>
- {% if event.stream.action_object.get_absolute_url %}
+ {{ event.stream.actor }}
+ {% if event.is_new_contributor %}
+ <span class="badge bg-warning text-dark" title="{% translate 'Account younger than 60 days' %}">
+ {% translate 'new' %}
+ </span>
+ {% endif %}
+ </td>
+ <td>
+ {% if event.model_key %}
+ <span class="badge text-bg-light">{{ event.model_key }}</span>
+ {% endif %}
+ </td>
+ <td>
+ {% if event.object_missing %}
+ <em class="text-muted">{% translate "Object was deleted" %}</em>
+ {% elif event.stream.action_object.get_absolute_url %}
<a href="{{ event.stream.action_object.get_absolute_url }}">{{ event.stream.action_object }}</a>
{% else %}
{{ event.stream.action_object }}
@@ -59,10 +115,12 @@
<td>{{ event.stream.timesince }}</td>
{% if event.stream.verb == verbs.CREATED.value %}
<td>
- <a href="{{ event.stream.action_object.get_absolute_url }}" id="view-changes"
- class="btn btn-success btn-sm btn-block">
- {% translate "View Object" %}
- </a>
+ {% if not event.object_missing %}
+ <a href="{{ event.stream.action_object.get_absolute_url }}" id="view-changes"
+ class="btn btn-success btn-sm btn-block">
+ {% translate "View Object" %}
+ </a>
+ {% endif %}
</td>
<td>
@@ -114,7 +172,7 @@
{% endif %}
</tr>
<tr class="collapse" id="collapse-{{ event.stream.id }}">
- <td colspan="6">
+ <td colspan="7">
<table class="table">
<thead>
<tr>
@@ -142,6 +200,50 @@
{% endfor %}
</tbody>
</table>
+
+ {% if is_paginated %}
+ <nav aria-label="{% translate 'History pagination' %}">
+ <ul class="pagination justify-content-center">
+ {% if page_obj.has_previous %}
+ <li class="page-item">
+ <a class="page-link" href="?page=1{% if querystring %}&amp;{{ querystring }}{% endif %}">
+ « {% translate "First" %}
+ </a>
+ </li>
+ <li class="page-item">
+ <a class="page-link" href="?page={{ page_obj.previous_page_number }}{% if querystring %}&amp;{{ querystring }}{% endif %}">
+ ‹ {% translate "Previous" %}
+ </a>
+ </li>
+ {% else %}
+ <li class="page-item disabled"><span class="page-link">« {% translate "First" %}</span></li>
+ <li class="page-item disabled"><span class="page-link">‹ {% translate "Previous" %}</span></li>
+ {% endif %}
+
+ <li class="page-item disabled">
+ <span class="page-link">
+ {% blocktranslate with current=page_obj.number total=paginator.num_pages %}Page {{ current }} of {{ total }}{% endblocktranslate %}
+ </span>
+ </li>
+
+ {% if page_obj.has_next %}
+ <li class="page-item">
+ <a class="page-link" href="?page={{ page_obj.next_page_number }}{% if querystring %}&amp;{{ querystring }}{% endif %}">
+ {% translate "Next" %} ›
+ </a>
+ </li>
+ <li class="page-item">
+ <a class="page-link" href="?page={{ paginator.num_pages }}{% if querystring %}&amp;{{ querystring }}{% endif %}">
+ {% translate "Last" %} »
+ </a>
+ </li>
+ {% else %}
+ <li class="page-item disabled"><span class="page-link">{% translate "Next" %} ›</span></li>
+ <li class="page-item disabled"><span class="page-link">{% translate "Last" %} »</span></li>
+ {% endif %}
+ </ul>
+ </nav>
+ {% endif %}
{% endblock %}
diff --git a/wger/exercises/tests/test_history.py b/wger/exercises/tests/test_history.py
index df3869ca3..d38f78b3a 100644
--- a/wger/exercises/tests/test_history.py
+++ b/wger/exercises/tests/test_history.py
@@ -12,18 +12,27 @@
#
# You should have received a copy of the GNU Affero General Public License
+# Standard Library
+from datetime import timedelta
+
# Django
from django.contrib.auth.models import User
from django.contrib.contenttypes.models import ContentType
from django.urls import reverse
+from django.utils import timezone
# Third Party
from actstream import action as actstream_action
+from actstream.models import Action
# wger
from wger.core.tests.base_testcase import WgerTestCase
-from wger.exercises.models import Translation
+from wger.exercises.models import (
+ Alias,
+ Translation,
+)
from wger.exercises.views.helper import StreamVerbs
+from wger.exercises.views.history import PAGE_SIZE
class ExerciseHistoryControl(WgerTestCase):
@@ -81,3 +90,120 @@ class ExerciseHistoryControl(WgerTestCase):
translation = Translation.objects.get(pk=2)
self.assertEqual(translation.description, 'Boring exercise')
+
+
+class ExerciseHistoryControlRegression(WgerTestCase):
+ """
+ Regression tests for the rewritten history control view.
+ """
+
+ def setUp(self):
+ super().setUp()
+ self.user_login()
+ self.user = User.objects.get(username='admin')
+
+ def _make_action(self, target, verb=None):
+ verb = verb or StreamVerbs.UPDATED.value
+ actstream_action.send(self.user, verb=verb, action_object=target)
+
+ def test_deleted_action_object_does_not_crash(self):
+ """
+ If the action_object referenced by an Action no longer resolves to a
+ live row, the view must still render
+
+ actstream's ``registry.register`` attaches a GenericRelation that
+ cascades when the action_object is deleted, so we simulate a dangling
+ reference by pointing the action_object FK to a non-existent pk.
+ """
+ translation = Translation.objects.get(pk=2)
+ self._make_action(translation)
+
+ action = Action.objects.first()
+ action.action_object_object_id = 999_999
+ action.save()
+
+ response = self.client.get(reverse('exercise:history:overview'))
+ self.assertEqual(response.status_code, 200)
+ self.assertContains(response, 'Object was deleted')
+
+ def test_pagination(self):
+ """
+ Verify the paginator splits the action stream into pages of PAGE_SIZE.
+ """
+ translation = Translation.objects.get(pk=2)
+ for _ in range(PAGE_SIZE + 5):
+ self._make_action(translation)
+
+ response = self.client.get(reverse('exercise:history:overview'))
+ self.assertEqual(response.status_code, 200)
+ self.assertEqual(len(response.context['context']), PAGE_SIZE)
+ self.assertTrue(response.context['is_paginated'])
+
+ response_page2 = self.client.get(
+ reverse('exercise:history:overview') + '?page=2'
+ )
+ self.assertEqual(response_page2.status_code, 200)
+ self.assertEqual(len(response_page2.context['context']), 5)
+
+ def test_filter_by_user(self):
+ """
+ The ``user`` GET parameter filters by actor username (case-insensitive
+ substring match).
+ """
+ other_user = User.objects.get(username='test')
+ translation = Translation.objects.get(pk=2)
+
+ actstream_action.send(self.user, verb=StreamVerbs.UPDATED.value, action_object=translation)
+ actstream_action.send(other_user, verb=StreamVerbs.UPDATED.value, action_object=translation)
+
+ response = self.client.get(reverse('exercise:history:overview') + '?user=test')
+ self.assertEqual(response.status_code, 200)
+ self.assertEqual(len(response.context['context']), 1)
+ self.assertEqual(response.context['context'][0]['stream'].actor, other_user)
+
+ def test_filter_by_model_type(self):
+ """
+ Filtering by ``model_type`` should restrict to the matching content
+ type only.
+ """
+ translation = Translation.objects.get(pk=2)
+ alias = Alias.objects.create(translation=translation, alias='filter-test')
+
+ self._make_action(translation)
+ self._make_action(alias)
+
+ response = self.client.get(reverse('exercise:history:overview') + '?model_type=alias')
+ self.assertEqual(response.status_code, 200)
+ self.assertEqual(len(response.context['context']), 1)
+ self.assertEqual(response.context['context'][0]['model_key'], 'alias')
+
+ def test_new_contributor_flag(self):
+ """
+ Actors whose account is younger than 60 days are flagged so admins
+ can review them more carefully.
+ """
+
+ new_user = User.objects.create_user(username='newbie', password='pw')
+ new_user.date_joined = timezone.now() - timedelta(days=3)
+ new_user.save()
+
+ translation = Translation.objects.get(pk=2)
+ actstream_action.send(new_user, verb=StreamVerbs.UPDATED.value, action_object=translation)
+ actstream_action.send(self.user, verb=StreamVerbs.UPDATED.value, action_object=translation)
+
+ response = self.client.get(reverse('exercise:history:overview'))
+ self.assertEqual(response.status_code, 200)
+
+ new_flagged = [e for e in response.context['context'] if e['is_new_contributor']]
+ self.assertEqual(len(new_flagged), 1)
+ self.assertEqual(new_flagged[0]['stream'].actor, new_user)
+
+ def test_stats_header(self):
+ translation = Translation.objects.get(pk=2)
+ self._make_action(translation)
+
+ response = self.client.get(reverse('exercise:history:overview'))
+ self.assertEqual(response.status_code, 200)
+ self.assertGreaterEqual(response.context['stats']['last_24h'], 1)
+ self.assertGreaterEqual(response.context['stats']['last_7d'], 1)
+ self.assertGreaterEqual(response.context['stats']['last_30d'], 1)
diff --git a/wger/exercises/views/history.py b/wger/exercises/views/history.py
index 75bacd870..3ec1bd420 100644
--- a/wger/exercises/views/history.py
+++ b/wger/exercises/views/history.py
@@ -15,18 +15,30 @@
# Standard Library
import logging
+from datetime import timedelta
# Django
+from django import forms
from django.contrib.auth.decorators import permission_required
+from django.contrib.auth.models import User
from django.contrib.contenttypes.models import ContentType
-from django.http import HttpResponseRedirect
+from django.core.paginator import (
+ EmptyPage,
+ PageNotAnInteger,
+ Paginator,
+)
+from django.db.models import QuerySet
+from django.http import HttpResponseRedirect, HttpRequest, HttpResponse
from django.shortcuts import (
get_object_or_404,
render,
)
from django.urls import reverse
+from django.utils import timezone
+from django.utils.translation import gettext_lazy as _
# Third Party
+import django_filters
from actstream import action as actstream_action
from actstream.models import Action
@@ -37,35 +49,212 @@ from wger.exercises.views.helper import StreamVerbs
logger = logging.getLogger(__name__)
+PAGE_SIZE = 50
+
+# Models that the history view exposes as filter options. Each tuple is
+# (filter key, app_label, model name).
+TRACKED_MODELS = (
+ ('exercise', 'exercises', 'exercise'),
+ ('translation', 'exercises', 'translation'),
+ ('image', 'exercises', 'exerciseimage'),
+ ('video', 'exercises', 'exercisevideo'),
+ ('comment', 'exercises', 'exercisecomment'),
+ ('alias', 'exercises', 'alias'),
+)
+
+NEW_CONTRIBUTOR_DAYS = 60
+"""
+Edits made by accounts younger than this are visually flagged so admins can
+review them more carefully (watchlist concept).
+"""
+
+
+def _content_type_map():
+ """
+ Return a dict mapping the filter key (e.g. ``'translation'``) to its
+ ContentType. Looked up once per request.
+ """
+ result = {}
+ for key, app_label, model in TRACKED_MODELS:
+ try:
+ ct = ContentType.objects.get(app_label=app_label, model=model)
+ except ContentType.DoesNotExist:
+ continue
+ result[key] = ct
+ return result
+
+
+class ActionHistoryFilter(django_filters.FilterSet):
+
+ MODEL_CHOICES = [(key, key.capitalize()) for key, *_ in TRACKED_MODELS]
+ VERB_CHOICES = [(v.value, v.value.capitalize()) for v in StreamVerbs]
+
+ user = django_filters.CharFilter(
+ method='filter_user',
+ label=_('User'),
+ widget=forms.TextInput(attrs={'class': 'form-control form-control-sm'}),
+ )
+ model_type = django_filters.ChoiceFilter(
+ choices=MODEL_CHOICES,
+ method='filter_model_type',
+ label=_('Type'),
+ empty_label=_('All'),
+ widget=forms.Select(attrs={'class': 'form-select form-select-sm'}),
+ )
+ verb = django_filters.ChoiceFilter(
+ field_name='verb',
+ choices=VERB_CHOICES,
+ label=_('Action'),
+ empty_label=_('All'),
+ widget=forms.Select(attrs={'class': 'form-select form-select-sm'}),
+ )
+ date_from = django_filters.DateFilter(
+ field_name='timestamp',
+ lookup_expr='date__gte',
+ label=_('From'),
+ widget=forms.DateInput(
+ attrs={'class': 'form-control form-control-sm', 'type': 'date'},
+ ),
+ )
+ date_to = django_filters.DateFilter(
+ field_name='timestamp',
+ lookup_expr='date__lte',
+ label=_('To'),
+ widget=forms.DateInput(
+ attrs={'class': 'form-control form-control-sm', 'type': 'date'},
+ ),
+ )
+
+ class Meta:
+ model = Action
+ fields = ['user', 'model_type', 'verb', 'date_from', 'date_to']
+
+ def filter_user(self, queryset: QuerySet, name: str, value: str):
+ if not value:
+ return queryset
+ user_ct = ContentType.objects.get_for_model(User)
+ return queryset.filter(
+ actor_content_type=user_ct,
+ actor_object_id__in=User.objects.filter(
+ username__icontains=value
+ ).values_list('pk', flat=True),
+ )
+
+ def filter_model_type(self, queryset: QuerySet, name: str, value: str):
+ ct_map = _content_type_map()
+ if value in ct_map:
+ return queryset.filter(action_object_content_type=ct_map[value])
+ return queryset
+
+
@permission_required('exercises.change_exercise')
-def control(request):
+def control(request: HttpRequest) -> HttpResponse:
"""
Admin view of the history of the exercises
"""
- all_streams = Action.objects.all()
+
+ ct_map = _content_type_map()
+ # Inverse mapping used for cheap template lookups without hitting the DB again.
+ ct_id_to_key = {ct.id: key for key, ct in ct_map.items()}
+ tracked_ct_ids = [ct.id for ct in ct_map.values()]
+
+ base_queryset = (
+ Action.objects.select_related(
+ 'actor_content_type',
+ 'action_object_content_type',
+ 'target_content_type',
+ )
+ # Only show events related to tracked exercise models
+ .filter(action_object_content_type__in=tracked_ct_ids)
+ .order_by('-timestamp')
+ )
+
+ action_filter = ActionHistoryFilter(request.GET, queryset=base_queryset)
+
+ now = timezone.now()
+ stats_base = Action.objects.filter(action_object_content_type__in=tracked_ct_ids)
+ stats = {
+ 'last_24h': stats_base.filter(timestamp__gte=now - timedelta(days=1)).count(),
+ 'last_7d': stats_base.filter(timestamp__gte=now - timedelta(days=7)).count(),
+ 'last_30d': stats_base.filter(timestamp__gte=now - timedelta(days=30)).count(),
+ }
+
+ paginator = Paginator(action_filter.qs, PAGE_SIZE)
+ page_number = request.GET.get('page', 1)
+ try:
+ page = paginator.page(page_number)
+ except (PageNotAnInteger, EmptyPage):
+ page = paginator.page(1)
+
+ # Bulk-load the actor users for this page
+ user_ct = ContentType.objects.get_for_model(User)
+ actor_ids = {
+ int(entry.actor_object_id)
+ for entry in page.object_list
+ if entry.actor_content_type_id == user_ct.id and entry.actor_object_id
+ }
+ actor_map = {u.pk: u for u in User.objects.filter(pk__in=actor_ids)}
+ new_contributor_cutoff = now - timedelta(days=NEW_CONTRIBUTOR_DAYS)
+
out = []
- for entry in all_streams:
- data = {'verb': entry.verb, 'stream': entry}
+ for entry in page.object_list:
+ actor = (
+ actor_map.get(int(entry.actor_object_id))
+ if entry.actor_content_type_id == user_ct.id and entry.actor_object_id
+ else None
+ )
+ is_new_contributor = bool(
+ actor and actor.date_joined and actor.date_joined >= new_contributor_cutoff
+ )
- if entry.verb == StreamVerbs.UPDATED.value:
- entry_obj = entry.action_object.history.as_of(entry.timestamp)
- historical_entry = entry_obj._history
- previous_entry = historical_entry.prev_record
+ data = {
+ 'verb': entry.verb,
+ 'stream': entry,
+ 'model_key': ct_id_to_key.get(entry.action_object_content_type_id),
+ 'is_new_contributor': is_new_contributor,
+ 'object_missing': False,
+ }
- data['id'] = historical_entry.id
- data['content_type_id'] = ContentType.objects.get_for_model(entry_obj).id
+ if entry.verb == StreamVerbs.UPDATED.value:
+ entry_obj = entry.action_object
+ if entry_obj is None or not hasattr(entry_obj, 'history'):
+ # The underlying object has been deleted (or doesn't track
+ # history), render a placeholder row
+ data['object_missing'] = entry_obj is None
+ else:
+ try:
+ historical_entry = entry_obj.history.as_of(entry.timestamp)._history
+ except (entry_obj.__class__.DoesNotExist, AttributeError, ValueError):
+ # No history snapshot exists at that timestamp (e.g. because the
+ # row predates history tracking).
+ historical_entry = None
- if previous_entry:
- data['delta'] = historical_entry.diff_against(previous_entry)
- data['history_id'] = previous_entry.history_id
+ if historical_entry is not None:
+ previous_entry = historical_entry.prev_record
+ data['id'] = historical_entry.id
+ data['content_type_id'] = entry.action_object_content_type_id
+ if previous_entry:
+ data['delta'] = historical_entry.diff_against(previous_entry)
+ data['history_id'] = previous_entry.history_id
out.append(data)
+ # GET parameters without ``page`` so pagination links keep filters intact.
+ qs_no_page = request.GET.copy()
+ qs_no_page.pop('page', None)
+ querystring = qs_no_page.urlencode()
+
return render(
request,
'history/overview.html',
{
'context': out,
+ 'filter': action_filter,
+ 'page_obj': page,
+ 'paginator': paginator,
+ 'is_paginated': page.has_other_pages(),
+ 'querystring': querystring,
+ 'stats': stats,
# We can't pass the enum to the template, so we have to do this
# https://stackoverflow.com/questions/35953132/
'verbs': StreamVerbs.__members__,