team-3/src/c3nav/editor/models/changeset.py
2018-11-29 01:30:53 +01:00

787 lines
31 KiB
Python

import operator
import typing
from collections import OrderedDict
from contextlib import contextmanager
from functools import reduce
from itertools import chain
from django.apps import apps
from django.conf import settings
from django.core.cache import cache
from django.core.exceptions import FieldDoesNotExist
from django.db import models, transaction
from django.db.models import Q
from django.urls import reverse
from django.utils.http import int_to_base36
from django.utils.timezone import make_naive
from django.utils.translation import ugettext_lazy as _
from django.utils.translation import ungettext_lazy
from c3nav.editor.models.changedobject import ApplyToInstanceError, ChangedObject
from c3nav.editor.tasks import send_changeset_proposed_notification
from c3nav.editor.wrappers import ModelInstanceWrapper, ModelWrapper, is_created_pk
from c3nav.mapdata.models import LocationSlug, MapUpdate
from c3nav.mapdata.models.locations import LocationRedirect
from c3nav.mapdata.utils.cache.changes import changed_geometries
from c3nav.mapdata.utils.models import get_submodels
class ChangeSet(models.Model):
STATES = (
('unproposed', _('unproposed')),
('proposed', _('proposed')),
('review', _('in review')),
('rejected', _('rejected')),
('reproposed', _('proposed again')),
('finallyrejected', _('finally rejected')),
('applied', _('accepted and applied')),
)
created = models.DateTimeField(auto_now_add=True, verbose_name=_('created'))
last_change = models.ForeignKey('editor.ChangeSetUpdate', null=True, related_name='+',
verbose_name=_('last object change'), on_delete=models.CASCADE)
last_update = models.ForeignKey('editor.ChangeSetUpdate', null=True, related_name='+',
verbose_name=_('last update'), on_delete=models.CASCADE)
last_state_update = models.ForeignKey('editor.ChangeSetUpdate', null=True, related_name='+',
verbose_name=_('last state update'), on_delete=models.CASCADE)
state = models.CharField(max_length=20, db_index=True, choices=STATES, default='unproposed')
author = models.ForeignKey(settings.AUTH_USER_MODEL, null=True, on_delete=models.PROTECT, verbose_name=_('Author'))
title = models.CharField(max_length=100, default='', verbose_name=_('Title'))
description = models.TextField(max_length=1000, default='', verbose_name=_('Description'))
assigned_to = models.ForeignKey(settings.AUTH_USER_MODEL, null=True, on_delete=models.PROTECT,
related_name='assigned_changesets', verbose_name=_('assigned to'))
map_update = models.OneToOneField(MapUpdate, null=True, related_name='changeset',
verbose_name=_('map update'), on_delete=models.PROTECT)
last_cleaned_with = models.ForeignKey(MapUpdate, null=True, related_name='checked_changesets',
on_delete=models.PROTECT)
class Meta:
verbose_name = _('Change Set')
verbose_name_plural = _('Change Sets')
default_related_name = 'changesets'
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.changed_objects = None
self.created_objects = {}
self.updated_existing = {}
self.deleted_existing = {}
self.m2m_added = {}
self.m2m_removed = {}
self._object_changed = False
self._request = None
self._original_state = self.state
self.direct_editing = False
"""
Get Changesets for Request/Session/User
"""
@classmethod
def qs_for_request(cls, request):
"""
Returns a base QuerySet to get only changesets the current user is allowed to see
"""
if request.user_permissions.review_changesets:
return ChangeSet.objects.all()
elif request.user.is_authenticated:
return ChangeSet.objects.filter(author=request.user)
elif 'changeset' in request.session:
return ChangeSet.objects.filter(pk=request.session['changeset'])
return ChangeSet.objects.none()
@classmethod
def get_for_request(cls, request, select_related=None, as_logged_out=False):
"""
Get the changeset for the current request.
If a changeset is associated with the session id, it will be returned.
Otherwise, if the user is authenticated, the last created queryset
for this user will be returned and the session id will be added to it.
If both fails, an empty unsaved changeset will be returned which will
be automatically saved when a change is added to it.
In any case, the default autor for changes added to the queryset during
this request will be set to the current user.
"""
if select_related is None:
select_related = ('last_change', )
changeset_pk = request.session.get('changeset')
if changeset_pk is not None:
qs = ChangeSet.objects.select_related(*select_related).exclude(state__in=('applied', 'finallyrejected'))
if request.user.is_authenticated and not as_logged_out:
if not request.user_permissions.review_changesets:
qs = qs.filter(author=request.user)
else:
qs = qs.filter(author__isnull=True)
try:
return qs.get(pk=changeset_pk)
except ChangeSet.DoesNotExist:
pass
changeset = ChangeSet()
changeset._request = request
if request.session.get('direct_editing', False) and ChangeSet.can_direct_edit(request):
changeset.direct_editing = True
if request.user.is_authenticated:
changeset.author = request.user
return changeset
"""
Wrap Objects
"""
def wrap_model(self, model):
if isinstance(model, str):
model = apps.get_model('mapdata', model)
assert isinstance(model, type) and issubclass(model, models.Model)
if self.direct_editing:
model.EditorForm = ModelWrapper(self, model).EditorForm
return model
return ModelWrapper(self, model)
def wrap_instance(self, instance):
assert isinstance(instance, models.Model)
if self.direct_editing:
return instance
return self.wrap_model(instance.__class__).create_wrapped_model_class()(self, instance)
def relevant_changed_objects(self) -> typing.Iterable[ChangedObject]:
return self.changed_objects_set.exclude(existing_object_pk__isnull=True, deleted=True)
def fill_changes_cache(self):
"""
Get all changed objects and fill this ChangeSet's changes cache.
Only executable once, if something is changed later the cache will be automatically updated.
This method gets called automatically when the cache is needed.
Only call it if you need to set include_deleted_created to True.
:rtype: True if the method was executed, else False
"""
if self.changed_objects is not None:
return False
if self.pk is None:
self.changed_objects = {}
return False
cache_key = self.cache_key_by_changes + ':cache'
cached_cache = cache.get(cache_key)
if cached_cache is not None:
(self.changed_objects, self.created_objects, self.updated_existing,
self.deleted_existing, self.m2m_added, self.m2m_removed) = cached_cache
return True
self.changed_objects = {}
for change in self.changed_objects_set.all():
change.update_changeset_cache()
if self.state != 'applied' and not self._cleaning_changes:
self._cleaning_changes = True
try:
self._clean_changes()
finally:
self._cleaning_changes = False
cache.set(cache_key, (self.changed_objects, self.created_objects, self.updated_existing,
self.deleted_existing, self.m2m_added, self.m2m_removed), 300)
return True
def iter_changed_objects(self) -> typing.Iterable[ChangedObject]:
return chain(*(changed_objects.values() for changed_objects in self.changed_objects.values()))
def _clean_changes(self):
if self.direct_editing:
return
with self.lock_to_edit() as changeset:
last_map_update_pk = MapUpdate.last_update()[0]
if changeset.last_cleaned_with_id == last_map_update_pk:
return
changed_objects = changeset.changed_objects_set.all()
# delete changed objects that refer in some way to deleted objects and clean up m2m changes
object_pks = {}
for changed_object in changed_objects:
changed_object.add_relevant_object_pks(object_pks)
to_save = set()
deleted_object_pks = {}
for model, pks in object_pks.items():
pks = set(pk for pk in pks if not is_created_pk(pk))
deleted_object_pks[model] = pks - set(model.objects.filter(pk__in=pks).values_list('pk', flat=True))
repeat = True
while repeat:
repeat = False
for changed_object in changed_objects:
if changed_object.handle_deleted_object_pks(deleted_object_pks):
to_save.add(changed_object)
if changed_object.pk is None:
repeat = True
# remove deleted objects
changed_objects = [obj for obj in changed_objects if obj.pk is not None]
# clean updated fields
objects = changeset.get_objects(many=False, changed_objects=changed_objects, prefetch_related=('groups', ))
for changed_object in changed_objects:
if changed_object.clean_updated_fields(objects):
to_save.add(changed_object)
# clean m2m
for changed_object in changed_objects:
if changed_object.clean_m2m(objects):
to_save.add(changed_object)
# remove duplicate slugs
slugs = set()
for changed_object in changed_objects:
if issubclass(changed_object.model_class, LocationSlug):
slug = changed_object.updated_fields.get('slug', None)
if slug is not None:
slugs.add(slug)
qs = LocationSlug.objects.filter(slug__in=slugs)
if slugs:
qs = qs.filter(reduce(operator.or_, (Q(slug__startswith=slug+'__') for slug in slugs)))
existing_slugs = dict(qs.values_list('slug', 'redirect__target_id'))
slug_length = LocationSlug._meta.get_field('slug').max_length
for changed_object in changed_objects:
if issubclass(changed_object.model_class, LocationSlug):
slug = changed_object.updated_fields.get('slug', None)
if slug is None:
continue
if slug in existing_slugs:
redirect_to = existing_slugs[slug]
if issubclass(changed_object.model_class, LocationRedirect) and redirect_to is not None:
to_save.discard(changed_object)
changed_object.delete()
continue
new_slug = slug
i = 0
while new_slug in existing_slugs:
suffix = '__'+str(i)
new_slug = slug[:slug_length-len(suffix)]+suffix
i += 1
slug = new_slug
changed_object.updated_fields['slug'] = new_slug
to_save.add(changed_object)
existing_slugs[slug] = (None if not issubclass(changed_object.model_class, LocationRedirect)
else changed_object.updated_fields['target'])
for changed_object in to_save:
changed_object.save(standalone=True)
changeset.last_cleaned_with_id = last_map_update_pk
changeset.save()
"""
Analyse Changes
"""
def get_objects(self, many=True, changed_objects=None, prefetch_related=()):
if changed_objects is None:
if self.changed_objects is None:
raise TypeError
changed_objects = self.iter_changed_objects()
# collect pks of relevant objects
object_pks = {}
for change in changed_objects:
change.add_relevant_object_pks(object_pks, many=many)
# create dummy objects for deleted ones
objects = {}
for model, pks in object_pks.items():
objects[model] = {pk: model(pk=pk) for pk in pks}
slug_submodels = tuple(model for model in object_pks.keys()
if model is not LocationSlug and issubclass(model, LocationSlug))
if slug_submodels:
object_pks[LocationSlug] = reduce(operator.or_, (object_pks[model] for model in slug_submodels))
for model in slug_submodels:
object_pks.pop(model)
# retrieve relevant objects
for model, pks in object_pks.items():
if not pks:
continue
created_pks = set(pk for pk in pks if is_created_pk(pk))
existing_pks = pks - created_pks
model_objects = {}
if existing_pks:
qs = model.objects
if model is LocationSlug:
qs = qs.select_related_target()
qs = qs.filter(pk__in=existing_pks)
for prefetch in prefetch_related:
try:
model._meta.get_field(prefetch)
except FieldDoesNotExist:
pass
else:
qs = qs.prefetch_related(prefetch)
for obj in qs:
if model == LocationSlug:
obj = obj.get_child()
model_objects[obj.pk] = obj
if created_pks:
for pk in created_pks:
model_objects[pk] = self.get_created_object(model, pk, allow_deleted=True)._obj
objects[model] = model_objects
# add LocationSlug objects as their correct model
for pk, obj in objects.get(LocationSlug, {}).items():
objects.setdefault(obj.__class__, {})[pk] = obj
for pk, obj in objects.get(LocationRedirect, {}).items():
try:
target = obj.target.get_child(obj.target)
except FieldDoesNotExist:
# todo: fix this
continue
objects.setdefault(LocationSlug, {})[target.pk] = target._obj
objects.setdefault(target.__class__, {})[target.pk] = target._obj
return objects
def get_changed_values(self, model: models.Model, name: str) -> tuple:
"""
Get all changes values for a specific field on existing models
:param model: model class
:param name: field name
:return: returns a dictionary with primary keys as keys and new values as values
"""
r = tuple((pk, values[name]) for pk, values in self.updated_existing.get(model, {}).items() if name in values)
return r
def get_changed_object(self, obj) -> ChangedObject:
if isinstance(obj, ModelInstanceWrapper):
obj = obj._obj
model = obj.__class__
pk = obj.pk
if pk is None:
return ChangedObject(changeset=self, model_class=model)
self.fill_changes_cache()
objects = tuple(obj for obj in ((submodel, self.changed_objects.get(submodel, {}).get(pk, None))
for submodel in get_submodels(model)) if obj[1] is not None)
if len(objects) > 1:
raise model.MultipleObjectsReturned
if objects:
return objects[0][1]
if is_created_pk(pk):
raise model.DoesNotExist
return ChangedObject(changeset=self, model_class=model, existing_object_pk=pk)
def get_created_object(self, model, pk, get_foreign_objects=False, allow_deleted=False):
"""
Gets a created model instance.
:param model: model class
:param pk: primary key
:param get_foreign_objects: whether to fetch foreign objects and not just set their id to field.attname
:param allow_deleted: return created objects that have already been deleted (needs get_history=True)
:return: a wrapped model instance
"""
self.fill_changes_cache()
if issubclass(model, ModelWrapper):
model = model._obj
obj = self.get_changed_object(model(pk=pk))
if obj.deleted and not allow_deleted:
raise model.DoesNotExist
return obj.get_obj(get_foreign_objects=get_foreign_objects)
def get_created_pks(self, model) -> set:
"""
Returns a set with the primary keys of created objects from this model
"""
self.fill_changes_cache()
if issubclass(model, ModelWrapper):
model = model._obj
return set(self.created_objects.get(model, {}).keys())
"""
Permissions
"""
@property
def changes_editable(self):
return self.state in ('unproposed', 'rejected', 'review')
@property
def proposed(self):
return self.state not in ('unproposed', 'rejected')
@property
def closed(self):
return self.state in ('finallyrejected', 'applied')
def is_author(self, request):
return (self.pk is None or self.author == request.user or
(self.author is None and not request.user.is_authenticated and
request.session.get('changeset', None) == self.pk))
def can_see(self, request):
return self.is_author(request) or self.can_review(request)
object_changed_cache = {}
@property
def _object_changed(self):
return self.object_changed_cache.get(self.pk, None)
@_object_changed.setter
def _object_changed(self, value):
self.object_changed_cache[self.pk] = value
cleaning_changes_cache = {}
@property
def _cleaning_changes(self):
return self.cleaning_changes_cache.get(self.pk, None)
@_cleaning_changes.setter
def _cleaning_changes(self, value):
self.cleaning_changes_cache[self.pk] = value
objects_changed_count = 0
@classmethod
def object_changed_handler(cls, sender, instance, **kwargs):
if sender._meta.app_label == 'mapdata':
cls.objects_changed_count += 1
@contextmanager
def lock_to_edit(self, request=None):
with transaction.atomic():
user = request.user if request is not None and request.user.is_authenticated else None
if self.pk is not None:
changeset = ChangeSet.objects.select_for_update().get(pk=self.pk)
self._object_changed = False
yield changeset
if self._object_changed:
update = changeset.updates.create(user=user, objects_changed=True)
changeset.last_update = update
changeset.last_change = update
changeset.save()
elif self.direct_editing:
with MapUpdate.lock():
changed_geometries.reset()
ChangeSet.objects_changed_count = 0
yield self
if ChangeSet.objects_changed_count:
MapUpdate.objects.create(user=user, type='direct_edit')
else:
yield self
def can_edit(self, request):
if not self.proposed:
return self.is_author(request)
elif self.state == 'review':
return self.assigned_to == request.user
return False
def can_activate(self, request):
return not self.closed and self.can_edit(request)
def can_delete(self, request):
return self.can_edit(request) and self.state == 'unproposed'
def can_propose(self, request):
return self.can_edit(request) and not self.proposed and self.changed_objects_count
def can_unpropose(self, request):
return self.author_id == request.user.pk and self.state in ('proposed', 'reproposed')
def can_review(self, request):
return request.user_permissions.review_changesets
@classmethod
def can_direct_edit(cls, request):
return request.user_permissions.direct_edit
def can_start_review(self, request):
return self.can_review(request) and self.state in ('proposed', 'reproposed')
def can_end_review(self, request):
return self.can_review(request) and self.state == 'review' and self.assigned_to == request.user
def can_unreject(self, request):
return (self.can_review(request) and self.state in ('rejected', 'finallyrejected') and
self.assigned_to == request.user)
"""
Update methods
"""
def propose(self, user):
new_state = {'unproposed': 'proposed', 'rejected': 'reproposed'}[self.state]
update = self.updates.create(user=user, state=new_state)
self.state = new_state
self.last_update = update
self.last_state_update = update
self.save()
self.notify_reviewers()
def notify_reviewers(self):
send_changeset_proposed_notification.delay(pk=self.pk,
title=self.title,
author=self.author.username,
description=self.description)
def unpropose(self, user):
new_state = {'proposed': 'unproposed', 'reproposed': 'rejected'}[self.state]
update = self.updates.create(user=user, state=new_state)
self.state = new_state
self.last_update = update
self.last_state_update = update
self.save()
def start_review(self, user):
assign_to = user
if self.assigned_to == user:
assign_to = None
else:
self.assigned_to = user
if self.state != 'review':
update = self.updates.create(user=user, state='review', assigned_to=assign_to)
self.state = 'review'
self.last_state_update = update
elif assign_to is None:
return
else:
update = self.updates.create(user=user, assigned_to=assign_to)
self.last_update = update
self.save()
def reject(self, user, comment: str, final: bool):
state = 'finallyrejected' if final else 'rejected'
update = self.updates.create(user=user, state=state, comment=comment)
self.state = state
self.last_state_update = update
self.last_update = update
self.save()
def unreject(self, user):
update = self.updates.create(user=user, state='review')
self.state = 'review'
self.last_state_update = update
self.last_update = update
self.save()
def apply(self, user):
with MapUpdate.lock():
changed_geometries.reset()
self._clean_changes()
changed_objects = self.relevant_changed_objects()
created_objects = []
existing_objects = []
for changed_object in changed_objects:
(created_objects if changed_object.is_created else existing_objects).append(changed_object)
objects = self.get_objects(changed_objects=changed_objects)
# remove slugs on all changed existing objects
slugs_updated = set(changed_object.obj_pk for changed_object in existing_objects
if (issubclass(changed_object.model_class, LocationSlug) and
'slug' in changed_object.updated_fields))
LocationSlug.objects.filter(pk__in=slugs_updated).update(slug=None)
redirects_deleted = set(changed_object.obj_pk for changed_object in existing_objects
if (issubclass(changed_object.model_class, LocationRedirect) and
changed_object.deleted))
LocationRedirect.objects.filter(pk__in=redirects_deleted).delete()
# create created objects
created_pks = {}
objects_to_create = set(created_objects)
while objects_to_create:
created_in_last_run = set()
for created_object in objects_to_create:
model = created_object.model_class
pk = created_object.obj_pk
# lets try to create this object
obj = model()
try:
created_object.apply_to_instance(obj, created_pks=created_pks)
except ApplyToInstanceError:
continue
obj.save()
created_in_last_run.add(created_object)
created_pks.setdefault(model, {})[pk] = obj.pk
objects.setdefault(model, {})[pk] = obj
objects_to_create -= created_in_last_run
# update existing objects
for existing_object in existing_objects:
if existing_object.deleted:
continue
model = existing_object.model_class
pk = existing_object.obj_pk
obj = objects[model][pk]
existing_object.apply_to_instance(obj, created_pks=created_pks)
obj.save()
# delete existing objects
for existing_object in existing_objects:
if not existing_object.deleted and not issubclass(existing_object.model_class, LocationRedirect):
continue
model = existing_object.model_class
pk = existing_object.obj_pk
obj = objects[model][pk]
obj.delete()
# update m2m
for changed_object in changed_objects:
obj = objects[changed_object.model_class][changed_object.obj_pk]
for mode, updates in (('remove', changed_object.m2m_removed), ('add', changed_object.m2m_added)):
for name, pks in updates.items():
field = changed_object.model_class._meta.get_field(name)
pks = tuple(objects[field.related_model][pk].pk for pk in pks)
getattr(getattr(obj, name), mode)(*pks)
update = self.updates.create(user=user, state='applied')
map_update = MapUpdate.objects.create(user=user, type='changeset')
self.state = 'applied'
self.last_state_update = update
self.last_update = update
self.map_update = map_update
self.save()
def activate(self, request):
request.session['changeset'] = self.pk
"""
Methods for display
"""
@property
def changed_objects_count(self):
"""
Get the number of changed objects.
"""
self.fill_changes_cache()
count = 0
changed_locationslug_pks = set()
for model, objects in self.changed_objects.items():
if issubclass(model, LocationSlug):
if model == LocationRedirect:
continue
changed_locationslug_pks.update(objects.keys())
count += sum(1 for obj in objects.values() if not obj.is_created or not obj.deleted)
count += len(set(obj.obj.target_id
for obj in self.changed_objects.get(LocationRedirect, {}).values()) - changed_locationslug_pks)
return count
def get_changed_objects_by_model(self, model):
if isinstance(model, str):
model = apps.get_model('mapdata', model)
self.fill_changes_cache()
return self.changed_objects.get(model, {})
@property
def count_display(self):
"""
Get “%d changed objects” display text.
"""
if self.pk is None:
if self.direct_editing:
return _('Direct editing active')
return _('No objects changed')
return (ungettext_lazy('%(num)d object changed', '%(num)d objects changed', 'num') %
{'num': self.changed_objects_count})
@property
def last_update_cache_key(self):
last_update = self.created if self.last_update_id is None else self.last_update.datetime
return int_to_base36(self.last_update_id or 0)+'_'+int_to_base36(int(make_naive(last_update).timestamp()))
@property
def last_change_cache_key(self):
last_change = self.created if self.last_change_id is None else self.last_change.datetime
return int_to_base36(self.last_change_id or 0)+'_'+int_to_base36(int(make_naive(last_change).timestamp()))
@property
def cache_key_by_changes(self):
return 'editor:changeset:' + self.raw_cache_key_by_changes
@property
def raw_cache_key_by_changes(self):
if self.pk is None:
return MapUpdate.current_cache_key()
return ':'.join((str(self.pk), MapUpdate.current_cache_key(), self.last_change_cache_key))
def get_absolute_url(self):
if self.pk is None:
if self.author:
return reverse('editor.users.detail', kwargs={'pk': self.author_id})
return ''
return reverse('editor.changesets.detail', kwargs={'pk': self.pk})
def serialize(self):
return OrderedDict((
('id', self.pk),
('author', self.author_id),
('state', self.state),
('assigned_to', self.assigned_to_id),
('changed_objects_count', self.changed_objects_count),
('created', None if self.created is None else self.created.isoformat()),
('last_change', None if self.last_change is None else self.last_change.datetime.isoformat()),
('last_update', None if self.last_update is None else self.last_update.datetime.isoformat()),
('last_state_update', (None if self.last_state_update is None else
self.last_state_update.datetime.isoformat())),
('last_state_update_user', (None if self.last_state_update is None else
self.last_state_update.user_id)),
('last_state_update_comment', (None if self.last_state_update is None else
self.last_state_update.comment)),
))
def save(self, *args, **kwargs):
if self._original_state == 'applied':
raise TypeError('Applied change sets can not be edited.')
super().save(*args, **kwargs)
if self._request is not None:
self.activate(self._request)
self._request = None
STATE_ICONS = {
'unproposed': 'pencil',
'proposed': 'send',
'reproposed': 'send',
'review': 'hourglass',
'rejected': 'remove',
'finallyrejected': 'remove',
'applied': 'ok',
}
@property
def icon(self):
return self.STATE_ICONS[self.state]
STATE_STYLES = {
'unproposed': 'muted',
'proposed': 'info',
'reproposed': 'info',
'review': 'info',
'rejected': 'danger',
'finallyrejected': 'danger',
'applied': 'success',
}
@property
def style(self):
return self.STATE_STYLES[self.state]