CGM_Public/pretix_original
2
0
Fork 1
mirror of https://github.com/pretix/pretix.git synced 2026-05-16 17:03:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Store information about objects transferred in last successful sync

Browse Source
This commit is contained in:
Mira Weller
2025-03-04 16:18:10 +01:00
parent 87570df3f8
commit e051470e91
6 changed files with 130 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
src/pretix/base/datasync/datasync.py
View File

@@ -15,8 +15,8 @@ from django_scopes import scope, scopes_disabled
from pretix.base.datasync.sourcefields import (
EVENT, EVENT_OR_SUBEVENT, ORDER, ORDER_POSITION, get_data_fields,
)
from pretix.base.models import Event, Order
from pretix.base.services.tasks import TransactionAwareTask
from pretix.base.logentrytype_registry import make_link
from pretix.base.models import Order, OrderPosition
from pretix.base.signals import EventPluginRegistry, periodic_task
from pretix.celery_app import app
@@ -58,6 +58,34 @@ class OrderSyncQueue(models.Model):
return self.provider_class.max_attempts
class OrderSyncLink(models.Model):
class Meta:
indexes = [
models.Index(fields=("order", "sync_provider")),
]
order = models.ForeignKey(
Order, on_delete=models.CASCADE, related_name="synced_objects"
)
sync_provider = models.CharField(blank=False, null=False, max_length=128)
order_position = models.ForeignKey(
OrderPosition, on_delete=models.CASCADE, related_name="synced_objects", blank=True, null=True,
)
external_object_type = models.CharField(blank=False, null=False, max_length=128)
external_pk_name = models.CharField(blank=False, null=False, max_length=128)
external_pk_value = models.CharField(blank=False, null=False, max_length=128)
external_link_href = models.CharField(blank=True, null=True, max_length=255)
external_link_display_name = models.CharField(blank=True, null=True, max_length=255)
timestamp = models.DateTimeField(blank=False, null=False, auto_now_add=True)
def external_link_html(self):
if not self.external_link_display_name:
return None
prov, meta = sync_targets.get(identifier=self.sync_provider)
if prov:
return prov.get_external_link_html(self.order.event, self.external_link_href, self.external_link_display_name)
@receiver(periodic_task, dispatch_uid="data_sync_periodic")
def on_periodic_task(sender, **kwargs):
sync_all.apply_async()
@@ -73,7 +101,6 @@ def sync_event_to_target(event, target_cls, queued_orders):
p.sync_queued_orders(queued_orders)
@app.task()
def sync_all():
with scopes_disabled():
@@ -100,7 +127,6 @@ StaticMapping = namedtuple('StaticMapping', ('pk', 'pretix_model', 'external_obj
class OutboundSyncProvider:
#identifier = None
max_attempts = 5
syncer_class = None
@@ -126,8 +152,20 @@ class OutboundSyncProvider:
triggered_by=triggered_by,
not_before=not_before)
@classmethod
def get_external_link_info(cls, event, external_link_href, external_link_display_name):
return {
"href": external_link_href,
"val": external_link_display_name,
}
@classmethod
def get_external_link_html(cls, event, external_link_href, external_link_display_name):
info = cls.get_external_link_info(event, external_link_href, external_link_display_name)
return make_link(info, '{val}')
def next_retry_date(self, sq):
return datetime.now() + timedelta(days=1)
return datetime.now() + timedelta(hours=1)
def sync_queued_orders(self, queued_orders):
for sq in queued_orders:
@@ -135,16 +173,14 @@ class OutboundSyncProvider:
mapped_objects = self.sync_order(sq.order)
except SyncConfigError as e:
logger.warning(
f"Could not sync order {sq.order.code} to {self.__name__} (config error)",
f"Could not sync order {sq.order.code} to {type(self).__name__} (config error)",
exc_info=True,
)
sq.order.log_action(
"pretix.event.order.data_sync.failed",
{
"error": e.messages,
"full_message": e.full_message,
},
)
sq.order.log_action("pretix.event.order.data_sync.failed", {
"provider": self.identifier,
"error": e.messages,
"full_message": e.full_message,
})
sq.delete()
except Exception as e:
# TODO: different handling per Exception, or even per HTTP response code?
@@ -156,20 +192,19 @@ class OutboundSyncProvider:
)
if sq.failed_attempts >= self.max_attempts:
sentry_sdk.capture_exception(e)
sq.order.log_action(
"pretix.event.order.data_sync.failed",
{
"error": [_("Maximum number of retries exceeded.")],
"full_message": str(e),
},
)
sq.order.log_action("pretix.event.order.data_sync.failed", {
"provider": self.identifier,
"error": [_("Maximum number of retries exceeded.")],
"full_message": str(e),
})
sq.delete()
else:
sq.save()
else:
sq.order.log_action(
"pretix.event.order.data_sync.success", {"objects": mapped_objects}
)
sq.order.log_action("pretix.event.order.data_sync.success", {
"provider": self.identifier,
"objects": mapped_objects
})
sq.delete()
def order_valid_for_sync(self, order):
@@ -177,7 +212,7 @@ class OutboundSyncProvider:
@property
def mappings(self):
raise NotImplemented
raise NotImplementedError
@cached_property
def data_fields(self):
@@ -223,7 +258,16 @@ class OutboundSyncProvider:
if not pk_value:
return None
return self.sync_object_with_properties(inputs, mapping, mapped_objects, pk_value, properties)
info = self.sync_object_with_properties(inputs, mapping, mapped_objects, pk_value, properties)
OrderSyncLink.objects.create(
order=inputs.get(ORDER), order_position=inputs.get(ORDER_POSITION), sync_provider=self.identifier,
external_object_type=info.get('object_type'),
external_pk_name=info.get('pk_field'),
external_pk_value=info.get('pk_value'),
external_link_href=info.get('external_link_href'),
external_link_display_name=info.get('external_link_display_name'),
)
return info
def sync_order(self, order):
if not self.order_valid_for_sync(order):
@@ -238,6 +282,7 @@ class OutboundSyncProvider:
"voucher",
)
)
order.synced_objects.filter(sync_provider=self.identifier).delete()
order_inputs = {ORDER: order, EVENT: self.event}
mapped_objects = {}
for mapping in self.mappings:
@@ -259,7 +304,7 @@ class OutboundSyncProvider:
"""
Called after sync_object has been called successfully for all objects of a specific order. Can be used for saving
bulk information per order.
bulk information per order.
"""
def finalize_sync_order(self, order):
pass

3
src/pretix/base/datasync/sourcefields.py
View File

@@ -426,7 +426,7 @@ def translate_property_mappings(property_mapping, checkin_list_map):
for mapping in mappings:
if mapping["pretix_field"].startswith("checkin_date_"):
old_id = int(mapping["pretix_field"][len("checkin_date_") :])
old_id = int(mapping["pretix_field"][len("checkin_date_"):])
mapping["pretix_field"] = "checkin_date_%d" % checkin_list_map[old_id].pk
return json.dumps(mappings)
@@ -437,6 +437,7 @@ def get_enum_opts(q):
else:
return None
QUESTION_TYPE_IDENTIFIERS = {
Question.TYPE_NUMBER: "NUMBER",
Question.TYPE_STRING: "STRING",

23
src/pretix/control/datasync.py
View File

@@ -1,3 +1,5 @@
from itertools import groupby
from django.contrib import messages
from django.dispatch import receiver
from django.http import HttpResponseNotAllowed
@@ -14,24 +16,23 @@ from pretix.control.views.orders import OrderView
@receiver(order_info, dispatch_uid="datasync_control_order_info")
def on_control_order_info(sender: Event, request, order: Order, **kwargs):
providers = [provider for provider, meta in sync_targets.filter(active_in=sender)]
if not providers: return ""
if not providers:
return ""
queued = order.queued_sync_jobs.all()
queued_provider_ids = {p.sync_provider for p in queued}
non_pending = [(provider.identifier, provider.display_name) for provider in providers if provider.identifier not in queued_provider_ids]
#sync_logs = order.all_logentries().filter(action_type__in=(
# "pretix.event.order.data_sync.success",
# "pretix.event.order.data_sync.failed"
#))
queued = {p.sync_provider: p for p in order.queued_sync_jobs.all()}
objects = {
provider: list(objects)
for (provider, objects)
in groupby(order.synced_objects.order_by('sync_provider').all(), key=lambda o: o.sync_provider)
}
providers = [(provider.identifier, provider.display_name, queued.get(provider.identifier), objects.get(provider.identifier)) for provider in providers]
template = get_template("pretixcontrol/datasync/control_order_info.html")
ctx = {
"order": order,
"request": request,
"event": sender,
"non_pending_providers": non_pending,
"queued_sync_jobs": queued,
"providers": providers,
}
return template.render(ctx, request=request)

16
src/pretix/control/logdisplay.py
View File

@@ -46,6 +46,7 @@ from django.utils.html import escape, format_html
from django.utils.translation import gettext_lazy as _, pgettext_lazy
from i18nfield.strings import LazyI18nString
from pretix.base.datasync.datasync import sync_targets
from pretix.base.logentrytypes import (
DiscountLogEntryType, EventLogEntryType, ItemCategoryLogEntryType,
ItemLogEntryType, LogEntryType, OrderLogEntryType, QuestionLogEntryType,
@@ -420,11 +421,24 @@ class OrderPrintLogEntryType(OrderLogEntryType):
type=dict(PrintLog.PRINT_TYPES)[data["type"]],
)
@log_entry_types.new_from_dict({
"pretix.event.order.data_sync.success": _("Ticket data successfully transferred to {provider}."),
})
class OrderDataSyncLogentrytype(OrderLogEntryType):
pass
def display(self, logentry, data):
links = []
if data.get('provider') and data.get('objects'):
prov, meta = sync_targets.get(identifier=data['provider'])
if prov:
for objs in data['objects'].values():
links.append(", ".join(
prov.get_external_link_html(logentry.event, obj['external_link_href'], obj['external_link_display_name'])
for obj in objs
if obj and 'external_link_href' in obj and 'external_link_display_name' in obj
))
return mark_safe(super().display(logentry, data) + "".join("<p>" + link + "</p>" for link in links))
@log_entry_types.new_from_dict({

51
src/pretix/control/templates/pretixcontrol/datasync/control_order_info.html
View File

@@ -12,10 +12,11 @@
{{ test.hello }}
<table class="table table-condensed">
<tbody>
{% for pending in queued_sync_jobs %}
{% for identifier, display_name, pending, objects in providers %}
<tr>
<td>{{ pending.sync_provider }}</td>
<td>{{ display_name }}</td>
<td>
{% if pending %}
{% if pending.failed_attempts %}
<i class="fa fa-warning"></i>
{% blocktrans trimmed with num=pending.failed_attempts max=pending.max_retry_attempts %}
@@ -32,32 +33,40 @@
{% else %}
<i class="fa fa-hourglass"></i> {% trans "Pending" %}
{% endif %}
(triggered by {{ pending.triggered_by }} at {{ pending.triggered }})
{% else %}
-
{% endif %}
</td>
<td>
<form action="{% url "control:event.order.sync_job" organizer=event.organizer.slug event=event.slug code=order.code provider=pending.sync_provider %}" method="post" class="form-inline">
{% csrf_token %}
{% if pending.not_before %}
<button type="submit" name="run_job_now" value="{{ pending.pk }}" class="btn btn-default"><i class="fa fa-refresh"></i> {% trans "Retry now" %}</button>
{% endif %}
<button type="submit" name="cancel_job" value="{{ pending.pk }}" class="btn btn-danger"><i class="fa fa-trash"></i> {% trans "Cancel" %}</button>
</form>
</td>
</tr>
{% endfor %}
{% for identifier, display_name in non_pending_providers %}
<tr>
<td>{{ display_name }}</td>
<td>-</td>
<td>
<td align="right">
<form action="{% url "control:event.order.sync_job" organizer=event.organizer.slug event=event.slug code=order.code provider=identifier %}" method="post" class="form-inline">
{% csrf_token %}
<button type="submit" class="btn btn-default"><i class="fa fa-refresh"></i> {% trans "Sync now" %}</button>
<input type="hidden" name="queue_sync" value="true">
{% if pending %}
{% if pending.not_before %}
<button type="submit" name="run_job_now" value="{{ pending.pk }}" class="btn btn-default"><i class="fa fa-refresh"></i> {% trans "Retry now" %}</button>
{% endif %}
<button type="submit" name="cancel_job" value="{{ pending.pk }}" class="btn btn-danger"><i class="fa fa-trash"></i> {% trans "Cancel" %}</button>
{% else %}
<button type="submit" class="btn btn-default"><i class="fa fa-refresh"></i> {% trans "Sync now" %}</button>
<input type="hidden" name="queue_sync" value="true">
{% endif %}
</form>
</td>
</tr>
{% for obj in objects %}
<tr>
<td></td>
<td>
{% if obj.external_link_html %}
{{ obj.external_link_html }}
{% else %}
{{ obj.external_object_type }} with {{ obj.external_pk_name }} = {{ obj.external_pk_value }}
{% endif %}
</td>
<td align="right">{{ obj.timestamp }}</td>
</tr>
{% endfor %}
{% endfor %}
</tbody>
</table>
</div>

3
src/pretix/control/views/event.py
View File

@@ -1677,6 +1677,3 @@ class EventQRCode(EventPermissionRequiredMixin, View):
r = HttpResponse(byte_io.read(), content_type='image/' + filetype)
r['Content-Disposition'] = f'inline; filename="qrcode-{request.event.slug}.{filetype}"'
return r
#class DataSyncSettings