mirror of
https://github.com/ArchiveBox/ArchiveBox
synced 2024-11-22 20:23:12 +00:00
174 lines
10 KiB
Python
174 lines
10 KiB
Python
__package__ = 'archivebox.abid_utils'
|
|
|
|
from typing import Any
|
|
|
|
from django.contrib import admin, messages
|
|
from django.core.exceptions import ValidationError
|
|
from django.utils.html import format_html
|
|
from django.utils.safestring import mark_safe
|
|
from django.shortcuts import redirect
|
|
|
|
from django_object_actions import DjangoObjectActions, action
|
|
|
|
from archivebox.misc.util import parse_date
|
|
|
|
from .abid import ABID
|
|
|
|
|
|
def highlight_diff(display_val: Any, compare_val: Any, invert: bool=False, color_same: str | None=None, color_diff: str | None=None):
|
|
"""highlight each character in red that differs with the char at the same index in compare_val"""
|
|
|
|
display_val = str(display_val)
|
|
compare_val = str(compare_val)
|
|
|
|
if len(compare_val) < len(display_val):
|
|
compare_val += ' ' * (len(display_val) - len(compare_val))
|
|
|
|
similar_color, highlighted_color = color_same or 'inherit', color_diff or 'red'
|
|
if invert:
|
|
similar_color, highlighted_color = color_same or 'green', color_diff or 'inherit'
|
|
|
|
return mark_safe(''.join(
|
|
format_html('<span style="color: {};">{}</span>', highlighted_color, display_val[i])
|
|
if display_val[i] != compare_val[i] else
|
|
format_html('<span style="color: {};">{}</span>', similar_color, display_val[i])
|
|
for i in range(len(display_val))
|
|
))
|
|
|
|
def get_abid_info(self, obj, request=None):
|
|
from archivebox.api.auth import get_or_create_api_token
|
|
|
|
try:
|
|
#abid_diff = f' != obj.ABID: {highlight_diff(obj.ABID, obj.abid)} ❌' if str(obj.ABID) != str(obj.abid) else ' == .ABID ✅'
|
|
|
|
fresh_values = obj.ABID_FRESH_VALUES
|
|
fresh_hashes = obj.ABID_FRESH_HASHES
|
|
fresh_diffs = obj.ABID_FRESH_DIFFS
|
|
fresh_abid = ABID(**fresh_hashes)
|
|
|
|
fresh_abid_diff = f'❌ != .fresh_abid: {highlight_diff(fresh_abid, obj.ABID)}' if str(fresh_abid) != str(obj.ABID) else '✅'
|
|
fresh_uuid_diff = f'❌ != .fresh_uuid: {highlight_diff(fresh_abid.uuid, obj.ABID.uuid)}' if str(fresh_abid.uuid) != str(obj.ABID.uuid) else '✅'
|
|
|
|
id_pk_diff = f'❌ != .pk: {highlight_diff(obj.pk, obj.id)}' if str(obj.pk) != str(obj.id) else '✅'
|
|
|
|
fresh_ts = parse_date(fresh_values['ts']) or None
|
|
ts_diff = f'❌ != {highlight_diff( fresh_hashes["ts"], obj.ABID.ts)}' if fresh_hashes["ts"] != obj.ABID.ts else '✅'
|
|
|
|
derived_uri = fresh_hashes['uri']
|
|
uri_diff = f'❌ != {highlight_diff(derived_uri, obj.ABID.uri)}' if derived_uri != obj.ABID.uri else '✅'
|
|
|
|
derived_subtype = fresh_hashes['subtype']
|
|
subtype_diff = f'❌ != {highlight_diff(derived_subtype, obj.ABID.subtype)}' if derived_subtype != obj.ABID.subtype else '✅'
|
|
|
|
derived_rand = fresh_hashes['rand']
|
|
rand_diff = f'❌ != {highlight_diff(derived_rand, obj.ABID.rand)}' if derived_rand != obj.ABID.rand else '✅'
|
|
|
|
return format_html(
|
|
# URL Hash: <code style="font-size: 10px; user-select: all">{}</code><br/>
|
|
'''
|
|
<a href="{}" style="font-size: 16px; font-family: monospace; user-select: all; border-radius: 8px; background-color: #ddf; padding: 3px 5px; border: 1px solid #aaa; margin-bottom: 8px; display: inline-block; vertical-align: top;">{}</a> <a href="{}" style="color: limegreen; font-size: 0.9em; vertical-align: 1px; font-family: monospace;">📖 API DOCS</a>
|
|
<br/><hr/>
|
|
<div style="opacity: 0.8">
|
|
<small style="opacity: 0.8">.id: <code style="font-size: 10px; user-select: all">{}</code> {}</small><br/>
|
|
<small style="opacity: 0.8">.abid.uuid: <code style="font-size: 10px; user-select: all">{}</code> {}</small><br/>
|
|
<small style="opacity: 0.8">.abid: <code style="font-size: 10px; user-select: all">{}</code> {}</small><br/>
|
|
<hr/>
|
|
TS: <code style="font-size: 10px;"><b style="user-select: all">{}</b> {}</code> <code style="font-size: 10px;"><b>{}</b></code> {}: <code style="user-select: all">{}</code><br/>
|
|
URI: <code style="font-size: 10px;"><b style="user-select: all">{}</b> {}</code> <code style="font-size: 10px;"><b>{}</b></code> <span style="display:inline-block; vertical-align: -4px; width: 330px; white-space: nowrap; overflow: hidden; text-overflow: ellipsis;">{}: <code style="user-select: all">{}</code></span><br/>
|
|
SUBTYPE: <code style="font-size: 10px;"><b style="user-select: all">{}</b> {}</code> <code style="font-size: 10px;"><b>{}</b></code> {}: <code style="user-select: all">{}</code><br/>
|
|
RAND: <code style="font-size: 10px;"><b style="user-select: all">{}</b> {}</code> <code style="font-size: 10px;"><b>{}</b></code> {}: <code style="user-select: all">{}</code></code>
|
|
<br/><hr/>
|
|
<span style="color: #f375a0">{}</span> <code style="color: red"><b>{}</b></code> {}
|
|
</div>
|
|
''',
|
|
obj.api_url + (f'?api_key={get_or_create_api_token(request.user)}' if request and request.user else ''), obj.api_url, obj.api_docs_url,
|
|
highlight_diff(obj.id, obj.ABID.uuid, invert=True), mark_safe(id_pk_diff),
|
|
highlight_diff(obj.ABID.uuid, obj.id, invert=True), mark_safe(fresh_uuid_diff),
|
|
highlight_diff(obj.abid, fresh_abid), mark_safe(fresh_abid_diff),
|
|
# str(fresh_abid.uuid), mark_safe(fresh_uuid_diff),
|
|
# str(fresh_abid), mark_safe(fresh_abid_diff),
|
|
highlight_diff(obj.ABID.ts, fresh_hashes['ts']), highlight_diff(str(obj.ABID.uuid)[0:14], str(fresh_abid.uuid)[0:14]), mark_safe(ts_diff), obj.abid_ts_src, fresh_ts and fresh_ts.isoformat(),
|
|
highlight_diff(obj.ABID.uri, derived_uri), highlight_diff(str(obj.ABID.uuid)[14:26], str(fresh_abid.uuid)[14:26]), mark_safe(uri_diff), obj.abid_uri_src, str(fresh_values['uri']),
|
|
highlight_diff(obj.ABID.subtype, derived_subtype), highlight_diff(str(obj.ABID.uuid)[26:28], str(fresh_abid.uuid)[26:28]), mark_safe(subtype_diff), obj.abid_subtype_src, str(fresh_values['subtype']),
|
|
highlight_diff(obj.ABID.rand, derived_rand), highlight_diff(str(obj.ABID.uuid)[28:36], str(fresh_abid.uuid)[28:36]), mark_safe(rand_diff), obj.abid_rand_src, str(fresh_values['rand'])[-7:],
|
|
'Some values the ABID depends on have changed since the ABID was issued:' if fresh_diffs else '',
|
|
", ".join(diff['abid_src'] for diff in fresh_diffs.values()),
|
|
'(clicking "Regenerate ABID" in the upper right will assign a new ABID, breaking any external references to the old ABID)' if fresh_diffs else '',
|
|
)
|
|
except Exception as e:
|
|
# import ipdb; ipdb.set_trace()
|
|
return str(e)
|
|
|
|
|
|
class ABIDModelAdmin(DjangoObjectActions, admin.ModelAdmin):
|
|
list_display = ('created_at', 'created_by', 'abid')
|
|
sort_fields = ('created_at', 'created_by', 'abid')
|
|
readonly_fields = ('created_at', 'modified_at', 'abid_info')
|
|
# fields = [*readonly_fields]
|
|
|
|
change_actions = ("regenerate_abid",)
|
|
# changelist_actions = ("regenerate_abid",)
|
|
|
|
def _get_obj_does_not_exist_redirect(self, request, opts, object_id):
|
|
try:
|
|
object_pk = self.model.id_from_abid(object_id)
|
|
return redirect(self.request.path.replace(object_id, object_pk), permanent=False)
|
|
except (self.model.DoesNotExist, ValidationError):
|
|
pass
|
|
return super()._get_obj_does_not_exist_redirect(request, opts, object_id) # type: ignore
|
|
|
|
def queryset(self, request):
|
|
self.request = request
|
|
return super().queryset(request) # type: ignore
|
|
|
|
def change_view(self, request, object_id, form_url="", extra_context=None):
|
|
self.request = request
|
|
return super().change_view(request, object_id, form_url, extra_context)
|
|
|
|
def get_form(self, request, obj=None, **kwargs):
|
|
self.request = request
|
|
form = super().get_form(request, obj, **kwargs)
|
|
if 'created_by' in form.base_fields:
|
|
form.base_fields['created_by'].initial = request.user
|
|
|
|
if obj:
|
|
if obj.ABID_FRESH_DIFFS:
|
|
messages.warning(request, "The ABID is not in sync with the object! See the API Identifiers section below for more info...")
|
|
|
|
return form
|
|
|
|
def get_formset(self, request, formset=None, obj=None, **kwargs):
|
|
formset = super().get_formset(request, formset, obj, **kwargs) # type: ignore
|
|
formset.form.base_fields['created_at'].disabled = True
|
|
|
|
return formset
|
|
|
|
def save_model(self, request, obj, form, change):
|
|
self.request = request
|
|
|
|
old_abid = getattr(obj, '_previous_abid', None) or obj.abid
|
|
|
|
super().save_model(request, obj, form, change)
|
|
obj.refresh_from_db()
|
|
|
|
new_abid = obj.abid
|
|
if new_abid != old_abid:
|
|
messages.warning(request, f"The object's ABID has been updated! {old_abid} -> {new_abid} (any external references to the old ABID will need to be updated manually)")
|
|
# import ipdb; ipdb.set_trace()
|
|
|
|
@admin.display(description='API Identifiers')
|
|
def abid_info(self, obj):
|
|
return get_abid_info(self, obj, request=self.request)
|
|
|
|
@action(label="Regenerate ABID", description="Re-Generate the ABID based on fresh values")
|
|
def regenerate_abid(self, request, obj):
|
|
old_abid = str(obj.abid)
|
|
obj.abid = obj.issue_new_abid(overwrite=True)
|
|
obj.save()
|
|
obj.refresh_from_db()
|
|
new_abid = str(obj.abid)
|
|
|
|
if new_abid != old_abid:
|
|
messages.warning(request, f"The object's ABID has been updated! {old_abid} -> {new_abid} (any external references to the old ABID will need to be updated manually)")
|
|
else:
|
|
messages.success(request, "The ABID was not regenerated, it is already up-to-date with the object.")
|