| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776 |
- __package__ = 'archivebox.core'
- import os
- import threading
- from pathlib import Path
- from django.contrib import admin, messages
- from django.urls import path, reverse, resolve
- from django.utils import timezone
- from django.utils.functional import cached_property
- from django.utils.html import format_html
- from django.utils.safestring import mark_safe
- from django.contrib.auth import get_user_model, get_permission_codename
- from django.contrib.auth.admin import UserAdmin
- from django.core.paginator import Paginator
- from django.core.exceptions import ValidationError
- from django.template import Template, RequestContext
- from django.conf import settings
- from django import forms
- from signal_webhooks.admin import WebhookAdmin
- from signal_webhooks.utils import get_webhook_model
- # from plugantic.admin import CustomPlugin
- from ..util import htmldecode, urldecode
- from core.models import Snapshot, ArchiveResult, Tag
- from core.mixins import SearchResultsAdminMixin
- from api.models import APIToken
- from abid_utils.admin import ABIDModelAdmin
- from queues.tasks import bg_archive_links, bg_add
- from index.html import snapshot_icons
- from logging_util import printable_filesize
- from main import add, remove
- from extractors import archive_links
- CONFIG = settings.CONFIG
- GLOBAL_CONTEXT = {'VERSION': CONFIG.VERSION, 'VERSIONS_AVAILABLE': CONFIG.VERSIONS_AVAILABLE, 'CAN_UPGRADE': CONFIG.CAN_UPGRADE}
- # Admin URLs
- # /admin/
- # /admin/login/
- # /admin/core/
- # /admin/core/snapshot/
- # /admin/core/snapshot/:uuid/
- # /admin/core/tag/
- # /admin/core/tag/:uuid/
- # TODO: https://stackoverflow.com/questions/40760880/add-custom-button-to-django-admin-panel
- class ArchiveBoxAdmin(admin.AdminSite):
- site_header = 'ArchiveBox'
- index_title = 'Links'
- site_title = 'Index'
- namespace = 'admin'
- class CustomUserAdmin(UserAdmin):
- sort_fields = ['id', 'email', 'username', 'is_superuser', 'last_login', 'date_joined']
- list_display = ['username', 'id', 'email', 'is_superuser', 'last_login', 'date_joined']
- readonly_fields = ('snapshot_set', 'archiveresult_set', 'tag_set', 'apitoken_set', 'outboundwebhook_set')
- fieldsets = [*UserAdmin.fieldsets, ('Data', {'fields': readonly_fields})]
- @admin.display(description='Snapshots')
- def snapshot_set(self, obj):
- total_count = obj.snapshot_set.count()
- return mark_safe('<br/>'.join(
- format_html(
- '<code><a href="/admin/core/snapshot/{}/change"><b>[{}]</b></a></code> <b>📅 {}</b> {}',
- snap.pk,
- snap.abid,
- snap.downloaded_at.strftime('%Y-%m-%d %H:%M') if snap.downloaded_at else 'pending...',
- snap.url[:64],
- )
- for snap in obj.snapshot_set.order_by('-modified_at')[:10]
- ) + f'<br/><a href="/admin/core/snapshot/?created_by__id__exact={obj.pk}">{total_count} total records...<a>')
- @admin.display(description='Archive Result Logs')
- def archiveresult_set(self, obj):
- total_count = obj.archiveresult_set.count()
- return mark_safe('<br/>'.join(
- format_html(
- '<code><a href="/admin/core/archiveresult/{}/change"><b>[{}]</b></a></code> <b>📅 {}</b> <b>📄 {}</b> {}',
- result.pk,
- result.abid,
- result.snapshot.downloaded_at.strftime('%Y-%m-%d %H:%M') if result.snapshot.downloaded_at else 'pending...',
- result.extractor,
- result.snapshot.url[:64],
- )
- for result in obj.archiveresult_set.order_by('-modified_at')[:10]
- ) + f'<br/><a href="/admin/core/archiveresult/?created_by__id__exact={obj.pk}">{total_count} total records...<a>')
- @admin.display(description='Tags')
- def tag_set(self, obj):
- total_count = obj.tag_set.count()
- return mark_safe(', '.join(
- format_html(
- '<code><a href="/admin/core/tag/{}/change"><b>{}</b></a></code>',
- tag.pk,
- tag.name,
- )
- for tag in obj.tag_set.order_by('-modified_at')[:10]
- ) + f'<br/><a href="/admin/core/tag/?created_by__id__exact={obj.pk}">{total_count} total records...<a>')
- @admin.display(description='API Tokens')
- def apitoken_set(self, obj):
- total_count = obj.apitoken_set.count()
- return mark_safe('<br/>'.join(
- format_html(
- '<code><a href="/admin/api/apitoken/{}/change"><b>[{}]</b></a></code> {} (expires {})',
- apitoken.pk,
- apitoken.abid,
- apitoken.token_redacted[:64],
- apitoken.expires,
- )
- for apitoken in obj.apitoken_set.order_by('-modified_at')[:10]
- ) + f'<br/><a href="/admin/api/apitoken/?created_by__id__exact={obj.pk}">{total_count} total records...<a>')
- @admin.display(description='API Outbound Webhooks')
- def outboundwebhook_set(self, obj):
- total_count = obj.outboundwebhook_set.count()
- return mark_safe('<br/>'.join(
- format_html(
- '<code><a href="/admin/api/outboundwebhook/{}/change"><b>[{}]</b></a></code> {} -> {}',
- outboundwebhook.pk,
- outboundwebhook.abid,
- outboundwebhook.referenced_model,
- outboundwebhook.endpoint,
- )
- for outboundwebhook in obj.outboundwebhook_set.order_by('-modified_at')[:10]
- ) + f'<br/><a href="/admin/api/outboundwebhook/?created_by__id__exact={obj.pk}">{total_count} total records...<a>')
- archivebox_admin = ArchiveBoxAdmin()
- archivebox_admin.register(get_user_model(), CustomUserAdmin)
- archivebox_admin.disable_action('delete_selected')
- # archivebox_admin.register(CustomPlugin)
- # patch admin with methods to add data views (implemented by admin_data_views package)
- # https://github.com/MrThearMan/django-admin-data-views
- # https://mrthearman.github.io/django-admin-data-views/setup/
- ############### Additional sections are defined in settings.ADMIN_DATA_VIEWS #########
- from admin_data_views.admin import get_app_list, admin_data_index_view, get_admin_data_urls, get_urls
- archivebox_admin.get_app_list = get_app_list.__get__(archivebox_admin, ArchiveBoxAdmin)
- archivebox_admin.admin_data_index_view = admin_data_index_view.__get__(archivebox_admin, ArchiveBoxAdmin) # type: ignore
- archivebox_admin.get_admin_data_urls = get_admin_data_urls.__get__(archivebox_admin, ArchiveBoxAdmin) # type: ignore
- archivebox_admin.get_urls = get_urls(archivebox_admin.get_urls).__get__(archivebox_admin, ArchiveBoxAdmin)
- from huey_monitor.apps import HueyMonitorConfig
- HueyMonitorConfig.verbose_name = 'Background Workers'
- from huey_monitor.admin import TaskModel, TaskModelAdmin, SignalInfoModel, SignalInfoModelAdmin
- archivebox_admin.register(SignalInfoModel, SignalInfoModelAdmin)
- class CustomTaskModelAdmin(TaskModelAdmin):
- actions = ["delete_selected"]
- def has_delete_permission(self, request, obj=None):
- codename = get_permission_codename("delete", self.opts)
- return request.user.has_perm("%s.%s" % (self.opts.app_label, codename))
- archivebox_admin.register(TaskModel, CustomTaskModelAdmin)
- def result_url(result: TaskModel) -> str:
- url = reverse("admin:huey_monitor_taskmodel_change", args=[str(result.id)])
- return format_html('<a href="{url}" class="fade-in-progress-url">See progress...</a>'.format(url=url))
- class AccelleratedPaginator(Paginator):
- """
- Accellerated Pagniator ignores DISTINCT when counting total number of rows.
- Speeds up SELECT Count(*) on Admin views by >20x.
- https://hakibenita.com/optimizing-the-django-admin-paginator
- """
- @cached_property
- def count(self):
- if self.object_list._has_filters(): # type: ignore
- # fallback to normal count method on filtered queryset
- return super().count
- else:
- # otherwise count total rows in a separate fast query
- return self.object_list.model.objects.count()
-
- # Alternative approach for PostgreSQL: fallback count takes > 200ms
- # from django.db import connection, transaction, OperationalError
- # with transaction.atomic(), connection.cursor() as cursor:
- # cursor.execute('SET LOCAL statement_timeout TO 200;')
- # try:
- # return super().count
- # except OperationalError:
- # return 9999999999999
- class ArchiveResultInline(admin.TabularInline):
- name = 'Archive Results Log'
- model = ArchiveResult
- parent_model = Snapshot
- # fk_name = 'snapshot'
- extra = 0
- sort_fields = ('end_ts', 'extractor', 'output', 'status', 'cmd_version')
- readonly_fields = ('id', 'result_id', 'completed', 'command', 'version')
- fields = ('start_ts', 'end_ts', *readonly_fields, 'extractor', 'cmd', 'cmd_version', 'pwd', 'created_by', 'status', 'output')
- # exclude = ('id',)
- ordering = ('end_ts',)
- show_change_link = True
- # # classes = ['collapse']
- # # list_display_links = ['abid']
- def get_parent_object_from_request(self, request):
- resolved = resolve(request.path_info)
- try:
- return self.parent_model.objects.get(pk=resolved.kwargs['object_id'])
- except (self.parent_model.DoesNotExist, ValidationError):
- return self.parent_model.objects.get(pk=self.parent_model.id_from_abid(resolved.kwargs['object_id']))
- @admin.display(
- description='Completed',
- ordering='end_ts',
- )
- def completed(self, obj):
- return format_html('<p style="white-space: nowrap">{}</p>', obj.end_ts.strftime('%Y-%m-%d %H:%M:%S'))
- def result_id(self, obj):
- return format_html('<a href="{}"><code style="font-size: 10px">[{}]</code></a>', reverse('admin:core_archiveresult_change', args=(obj.id,)), obj.abid)
-
- def command(self, obj):
- return format_html('<small><code>{}</code></small>', " ".join(obj.cmd or []))
-
- def version(self, obj):
- return format_html('<small><code>{}</code></small>', obj.cmd_version or '-')
-
- def get_formset(self, request, obj=None, **kwargs):
- formset = super().get_formset(request, obj, **kwargs)
- snapshot = self.get_parent_object_from_request(request)
- # import ipdb; ipdb.set_trace()
- # formset.form.base_fields['id'].widget = formset.form.base_fields['id'].hidden_widget()
-
- # default values for new entries
- formset.form.base_fields['status'].initial = 'succeeded'
- formset.form.base_fields['start_ts'].initial = timezone.now()
- formset.form.base_fields['end_ts'].initial = timezone.now()
- formset.form.base_fields['cmd_version'].initial = '-'
- formset.form.base_fields['pwd'].initial = str(snapshot.link_dir)
- formset.form.base_fields['created_by'].initial = request.user
- formset.form.base_fields['cmd'] = forms.JSONField(initial=['-'])
- formset.form.base_fields['output'].initial = 'Manually recorded cmd output...'
-
- if obj is not None:
- # hidden values for existing entries and new entries
- formset.form.base_fields['start_ts'].widget = formset.form.base_fields['start_ts'].hidden_widget()
- formset.form.base_fields['end_ts'].widget = formset.form.base_fields['end_ts'].hidden_widget()
- formset.form.base_fields['cmd'].widget = formset.form.base_fields['cmd'].hidden_widget()
- formset.form.base_fields['pwd'].widget = formset.form.base_fields['pwd'].hidden_widget()
- formset.form.base_fields['created_by'].widget = formset.form.base_fields['created_by'].hidden_widget()
- formset.form.base_fields['cmd_version'].widget = formset.form.base_fields['cmd_version'].hidden_widget()
- return formset
-
- def get_readonly_fields(self, request, obj=None):
- if obj is not None:
- return self.readonly_fields
- else:
- return []
- class TagInline(admin.TabularInline):
- model = Tag.snapshot_set.through # type: ignore
- # fk_name = 'snapshot'
- fields = ('id', 'tag')
- extra = 1
- # min_num = 1
- max_num = 1000
- autocomplete_fields = (
- 'tag',
- )
- from django.contrib.admin.helpers import ActionForm
- from django.contrib.admin.widgets import FilteredSelectMultiple
- # class AutocompleteTags:
- # model = Tag
- # search_fields = ['name']
- # name = 'name'
- # # source_field = 'name'
- # remote_field = Tag._meta.get_field('name')
- # class AutocompleteTagsAdminStub:
- # name = 'admin'
- class SnapshotActionForm(ActionForm):
- tags = forms.ModelMultipleChoiceField(
- label='Edit tags',
- queryset=Tag.objects.all(),
- required=False,
- widget=FilteredSelectMultiple(
- 'core_tag__name',
- False,
- ),
- )
- # TODO: allow selecting actions for specific extractors? is this useful?
- # extractor = forms.ChoiceField(
- # choices=ArchiveResult.EXTRACTOR_CHOICES,
- # required=False,
- # widget=forms.MultileChoiceField(attrs={'class': "form-control"})
- # )
- @admin.register(Snapshot, site=archivebox_admin)
- class SnapshotAdmin(SearchResultsAdminMixin, ABIDModelAdmin):
- list_display = ('created_at', 'title_str', 'files', 'size', 'url_str')
- sort_fields = ('title_str', 'url_str', 'created_at')
- readonly_fields = ('admin_actions', 'status_info', 'tags_str', 'imported_timestamp', 'created_at', 'modified_at', 'downloaded_at', 'abid_info', 'link_dir')
- search_fields = ('id', 'url', 'abid', 'timestamp', 'title', 'tags__name')
- list_filter = ('created_at', 'downloaded_at', 'archiveresult__status', 'created_by', 'tags__name')
- fields = ('url', 'title', 'created_by', 'bookmarked_at', *readonly_fields)
- ordering = ['-created_at']
- actions = ['add_tags', 'remove_tags', 'update_titles', 'update_snapshots', 'resnapshot_snapshot', 'overwrite_snapshots', 'delete_snapshots']
- inlines = [TagInline, ArchiveResultInline]
- list_per_page = min(max(5, CONFIG.SNAPSHOTS_PER_PAGE), 5000)
- action_form = SnapshotActionForm
- paginator = AccelleratedPaginator
- save_on_top = True
- show_full_result_count = False
- def changelist_view(self, request, extra_context=None):
- self.request = request
- extra_context = extra_context or {}
- try:
- return super().changelist_view(request, extra_context | GLOBAL_CONTEXT)
- except Exception as e:
- self.message_user(request, f'Error occurred while loading the page: {str(e)} {request.GET} {request.POST}')
- return super().changelist_view(request, GLOBAL_CONTEXT)
- def get_urls(self):
- urls = super().get_urls()
- custom_urls = [
- path('grid/', self.admin_site.admin_view(self.grid_view), name='grid')
- ]
- return custom_urls + urls
- # def get_queryset(self, request):
- # # tags_qs = SnapshotTag.objects.all().select_related('tag')
- # # prefetch = Prefetch('snapshottag_set', queryset=tags_qs)
- # self.request = request
- # return super().get_queryset(request).prefetch_related('archiveresult_set').distinct() # .annotate(archiveresult_count=Count('archiveresult'))
- @admin.action(
- description="Imported Timestamp"
- )
- def imported_timestamp(self, obj):
- context = RequestContext(self.request, {
- 'bookmarked_date': obj.bookmarked,
- 'timestamp': obj.timestamp,
- })
- html = Template("""{{bookmarked_date}} (<code>{{timestamp}}</code>)""")
- return mark_safe(html.render(context))
-
- # pretty_time = obj.bookmarked.strftime('%Y-%m-%d %H:%M:%S')
- # return f'{pretty_time} ({obj.timestamp})'
- # TODO: figure out a different way to do this, you cant nest forms so this doenst work
- # def action(self, obj):
- # # csrfmiddlewaretoken: Wa8UcQ4fD3FJibzxqHN3IYrrjLo4VguWynmbzzcPYoebfVUnDovon7GEMYFRgsh0
- # # action: update_snapshots
- # # select_across: 0
- # # _selected_action: 76d29b26-2a88-439e-877c-a7cca1b72bb3
- # return format_html(
- # '''
- # <form action="/admin/core/snapshot/" method="post" onsubmit="e => e.stopPropagation()">
- # <input type="hidden" name="csrfmiddlewaretoken" value="{}">
- # <input type="hidden" name="_selected_action" value="{}">
- # <button name="update_snapshots">Check</button>
- # <button name="update_titles">Pull title + favicon</button>
- # <button name="update_snapshots">Update</button>
- # <button name="overwrite_snapshots">Re-Archive (overwrite)</button>
- # <button name="delete_snapshots">Permanently delete</button>
- # </form>
- # ''',
- # csrf.get_token(self.request),
- # obj.pk,
- # )
- def admin_actions(self, obj):
- return format_html(
- # URL Hash: <code style="font-size: 10px; user-select: all">{}</code><br/>
- '''
- <a class="btn" style="font-size: 18px; display: inline-block; border-radius: 10px; border: 3px solid #eee; padding: 4px 8px" href="/archive/{}">Summary page ➡️</a>
- <a class="btn" style="font-size: 18px; display: inline-block; border-radius: 10px; border: 3px solid #eee; padding: 4px 8px" href="/archive/{}/index.html#all">Result files 📑</a>
- <a class="btn" style="font-size: 18px; display: inline-block; border-radius: 10px; border: 3px solid #eee; padding: 4px 8px" href="/admin/core/snapshot/?id__exact={}">Admin actions ⚙️</a>
- ''',
- obj.timestamp,
- obj.timestamp,
- obj.pk,
- )
- def status_info(self, obj):
- return format_html(
- # URL Hash: <code style="font-size: 10px; user-select: all">{}</code><br/>
- '''
- Archived: {} ({} files {})
- Favicon: <img src="{}" style="height: 20px"/>
- Status code: {} <br/>
- Server: {}
- Content type: {}
- Extension: {}
- ''',
- '✅' if obj.is_archived else '❌',
- obj.num_outputs,
- self.size(obj) or '0kb',
- f'/archive/{obj.timestamp}/favicon.ico',
- obj.status_code or '-',
- obj.headers and obj.headers.get('Server') or '-',
- obj.headers and obj.headers.get('Content-Type') or '-',
- obj.extension or '-',
- )
- @admin.display(
- description='Title',
- ordering='title',
- )
- def title_str(self, obj):
- tags = ''.join(
- format_html('<a href="/admin/core/snapshot/?tags__id__exact={}"><span class="tag">{}</span></a> ', tag.pk, tag.name)
- for tag in obj.tags.all()
- if str(tag.name).strip()
- )
- return format_html(
- '<a href="/{}">'
- '<img src="/{}/favicon.ico" class="favicon" onerror="this.remove()">'
- '</a>'
- '<a href="/{}/index.html">'
- '<b class="status-{}">{}</b>'
- '</a>',
- obj.archive_path,
- obj.archive_path,
- obj.archive_path,
- 'fetched' if obj.latest_title or obj.title else 'pending',
- urldecode(htmldecode(obj.latest_title or obj.title or ''))[:128] or 'Pending...'
- ) + mark_safe(f' <span class="tags">{tags}</span>')
- @admin.display(
- description='Files Saved',
- # ordering='archiveresult_count',
- )
- def files(self, obj):
- # return '-'
- return snapshot_icons(obj)
- @admin.display(
- # ordering='archiveresult_count'
- )
- def size(self, obj):
- archive_size = (Path(obj.link_dir) / 'index.html').exists() and obj.archive_size
- if archive_size:
- size_txt = printable_filesize(archive_size)
- if archive_size > 52428800:
- size_txt = mark_safe(f'<b>{size_txt}</b>')
- else:
- size_txt = mark_safe('<span style="opacity: 0.3">...</span>')
- return format_html(
- '<a href="/{}" title="View all files">{}</a>',
- obj.archive_path,
- size_txt,
- )
- @admin.display(
- description='Original URL',
- ordering='url',
- )
- def url_str(self, obj):
- return format_html(
- '<a href="{}"><code style="user-select: all;">{}</code></a>',
- obj.url,
- obj.url[:128],
- )
- def grid_view(self, request, extra_context=None):
- # cl = self.get_changelist_instance(request)
- # Save before monkey patching to restore for changelist list view
- saved_change_list_template = self.change_list_template
- saved_list_per_page = self.list_per_page
- saved_list_max_show_all = self.list_max_show_all
- # Monkey patch here plus core_tags.py
- self.change_list_template = 'private_index_grid.html'
- self.list_per_page = CONFIG.SNAPSHOTS_PER_PAGE
- self.list_max_show_all = self.list_per_page
- # Call monkey patched view
- rendered_response = self.changelist_view(request, extra_context=extra_context)
- # Restore values
- self.change_list_template = saved_change_list_template
- self.list_per_page = saved_list_per_page
- self.list_max_show_all = saved_list_max_show_all
- return rendered_response
- # for debugging, uncomment this to print all requests:
- # def changelist_view(self, request, extra_context=None):
- # print('[*] Got request', request.method, request.POST)
- # return super().changelist_view(request, extra_context=None)
- @admin.action(
- description="ℹ️ Get Title"
- )
- def update_titles(self, request, queryset):
- links = [snapshot.as_link() for snapshot in queryset]
- if len(links) < 3:
- # run syncronously if there are only 1 or 2 links
- archive_links(links, overwrite=True, methods=('title','favicon'), out_dir=CONFIG.OUTPUT_DIR)
- messages.success(request, f"Title and favicon have been fetched and saved for {len(links)} URLs.")
- else:
- # otherwise run in a background worker
- result = bg_archive_links((links,), kwargs={"overwrite": True, "methods": ["title", "favicon"], "out_dir": CONFIG.OUTPUT_DIR})
- messages.success(
- request,
- mark_safe(f"Title and favicon are updating in the background for {len(links)} URLs. {result_url(result)}"),
- )
- @admin.action(
- description="⬇️ Get Missing"
- )
- def update_snapshots(self, request, queryset):
- links = [snapshot.as_link() for snapshot in queryset]
- result = bg_archive_links((links,), kwargs={"overwrite": False, "out_dir": CONFIG.OUTPUT_DIR})
- messages.success(
- request,
- mark_safe(f"Re-trying any previously failed methods for {len(links)} URLs in the background. {result_url(result)}"),
- )
- @admin.action(
- description="🆕 Archive Again"
- )
- def resnapshot_snapshot(self, request, queryset):
- for snapshot in queryset:
- timestamp = timezone.now().isoformat('T', 'seconds')
- new_url = snapshot.url.split('#')[0] + f'#{timestamp}'
- result = bg_add({'urls': new_url, 'tag': snapshot.tags_str()})
- messages.success(
- request,
- mark_safe(f"Creating new fresh snapshots for {queryset.count()} URLs in the background. {result_url(result)}"),
- )
- @admin.action(
- description="🔄 Redo"
- )
- def overwrite_snapshots(self, request, queryset):
- links = [snapshot.as_link() for snapshot in queryset]
- result = bg_archive_links((links,), kwargs={"overwrite": True, "out_dir": CONFIG.OUTPUT_DIR})
- messages.success(
- request,
- mark_safe(f"Clearing all previous results and re-downloading {len(links)} URLs in the background. {result_url(result)}"),
- )
- @admin.action(
- description="☠️ Delete"
- )
- def delete_snapshots(self, request, queryset):
- remove(snapshots=queryset, yes=True, delete=True, out_dir=CONFIG.OUTPUT_DIR)
- messages.success(
- request,
- mark_safe(f"Succesfully deleted {queryset.count()} Snapshots. Don't forget to scrub URLs from import logs (data/sources) and error logs (data/logs) if needed."),
- )
- @admin.action(
- description="+"
- )
- def add_tags(self, request, queryset):
- tags = request.POST.getlist('tags')
- print('[+] Adding tags', tags, 'to Snapshots', queryset)
- for obj in queryset:
- obj.tags.add(*tags)
- messages.success(
- request,
- f"Added {len(tags)} tags to {queryset.count()} Snapshots.",
- )
- @admin.action(
- description="–"
- )
- def remove_tags(self, request, queryset):
- tags = request.POST.getlist('tags')
- print('[-] Removing tags', tags, 'to Snapshots', queryset)
- for obj in queryset:
- obj.tags.remove(*tags)
- messages.success(
- request,
- f"Removed {len(tags)} tags from {queryset.count()} Snapshots.",
- )
- # @admin.register(SnapshotTag, site=archivebox_admin)
- # class SnapshotTagAdmin(ABIDModelAdmin):
- # list_display = ('id', 'snapshot', 'tag')
- # sort_fields = ('id', 'snapshot', 'tag')
- # search_fields = ('id', 'snapshot_id', 'tag_id')
- # fields = ('snapshot', 'id')
- # actions = ['delete_selected']
- # ordering = ['-id']
- @admin.register(Tag, site=archivebox_admin)
- class TagAdmin(ABIDModelAdmin):
- list_display = ('created_at', 'created_by', 'abid', 'name', 'num_snapshots', 'snapshots')
- list_filter = ('created_at', 'created_by')
- sort_fields = ('name', 'slug', 'abid', 'created_by', 'created_at')
- readonly_fields = ('slug', 'abid', 'created_at', 'modified_at', 'abid_info', 'snapshots')
- search_fields = ('abid', 'name', 'slug')
- fields = ('name', 'created_by', *readonly_fields)
- actions = ['delete_selected']
- ordering = ['-created_at']
- paginator = AccelleratedPaginator
- def num_snapshots(self, tag):
- return format_html(
- '<a href="/admin/core/snapshot/?tags__id__exact={}">{} total</a>',
- tag.id,
- tag.snapshot_set.count(),
- )
- def snapshots(self, tag):
- total_count = tag.snapshot_set.count()
- return mark_safe('<br/>'.join(
- format_html(
- '<code><a href="/admin/core/snapshot/{}/change"><b>[{}]</b></a></code> {}',
- snap.pk,
- snap.downloaded_at.strftime('%Y-%m-%d %H:%M') if snap.downloaded_at else 'pending...',
- snap.url[:64],
- )
- for snap in tag.snapshot_set.order_by('-downloaded_at')[:10]
- ) + (f'<br/><a href="/admin/core/snapshot/?tags__id__exact={tag.id}">{total_count} total snapshots...<a>'))
- @admin.register(ArchiveResult, site=archivebox_admin)
- class ArchiveResultAdmin(ABIDModelAdmin):
- list_display = ('start_ts', 'snapshot_info', 'tags_str', 'extractor', 'cmd_str', 'status', 'output_str')
- sort_fields = ('start_ts', 'extractor', 'status')
- readonly_fields = ('cmd_str', 'snapshot_info', 'tags_str', 'created_at', 'modified_at', 'abid_info', 'output_summary')
- search_fields = ('id', 'abid', 'snapshot__url', 'extractor', 'output', 'cmd_version', 'cmd', 'snapshot__timestamp')
- fields = ('snapshot', 'extractor', 'status', 'output', 'pwd', 'start_ts', 'end_ts', 'created_by', 'cmd_version', 'cmd', *readonly_fields)
- autocomplete_fields = ['snapshot']
- list_filter = ('status', 'extractor', 'start_ts', 'cmd_version')
- ordering = ['-start_ts']
- list_per_page = CONFIG.SNAPSHOTS_PER_PAGE
-
- paginator = AccelleratedPaginator
- save_on_top = True
- 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)
- @admin.display(
- description='Snapshot Info'
- )
- def snapshot_info(self, result):
- return format_html(
- '<a href="/archive/{}/index.html"><b><code>[{}]</code></b> {} {}</a><br/>',
- result.snapshot.timestamp,
- result.snapshot.abid,
- result.snapshot.bookmarked_at.strftime('%Y-%m-%d %H:%M'),
- result.snapshot.url[:128],
- )
- @admin.display(
- description='Snapshot Tags'
- )
- def tags_str(self, result):
- return result.snapshot.tags_str()
- def cmd_str(self, result):
- return format_html(
- '<pre>{}</pre>',
- ' '.join(result.cmd) if isinstance(result.cmd, list) else str(result.cmd),
- )
-
- def output_str(self, result):
- return format_html(
- '<a href="/archive/{}/{}" class="output-link">↗️</a><pre>{}</pre>',
- result.snapshot.timestamp,
- result.output if (result.status == 'succeeded') and result.extractor not in ('title', 'archive_org') else 'index.html',
- result.output,
- )
- def output_summary(self, result):
- snapshot_dir = Path(CONFIG.OUTPUT_DIR) / str(result.pwd).split('data/', 1)[-1]
- output_str = format_html(
- '<pre style="display: inline-block">{}</pre><br/>',
- result.output,
- )
- output_str += format_html('<a href="/archive/{}/index.html#all">See result files ...</a><br/><pre><code>', str(result.snapshot.timestamp))
- path_from_output_str = (snapshot_dir / result.output)
- output_str += format_html('<i style="padding: 1px">{}</i><b style="padding-right: 20px">/</b><i>{}</i><br/><hr/>', str(snapshot_dir), str(result.output))
- if path_from_output_str.exists():
- root_dir = str(path_from_output_str)
- else:
- root_dir = str(snapshot_dir)
- # print(root_dir, str(list(os.walk(root_dir))))
- for root, dirs, files in os.walk(root_dir):
- depth = root.replace(root_dir, '').count(os.sep) + 1
- if depth > 2:
- continue
- indent = ' ' * 4 * (depth)
- output_str += format_html('<b style="padding: 1px">{}{}/</b><br/>', indent, os.path.basename(root))
- indentation_str = ' ' * 4 * (depth + 1)
- for filename in sorted(files):
- is_hidden = filename.startswith('.')
- output_str += format_html('<span style="opacity: {}.2">{}{}</span><br/>', int(not is_hidden), indentation_str, filename.strip())
- return output_str + format_html('</code></pre>')
- @admin.register(APIToken, site=archivebox_admin)
- class APITokenAdmin(ABIDModelAdmin):
- list_display = ('created_at', 'abid', 'created_by', 'token_redacted', 'expires')
- sort_fields = ('abid', 'created_at', 'created_by', 'expires')
- readonly_fields = ('created_at', 'modified_at', 'abid_info')
- search_fields = ('id', 'abid', 'created_by__username', 'token')
- fields = ('created_by', 'token', 'expires', *readonly_fields)
- list_filter = ('created_by',)
- ordering = ['-created_at']
- list_per_page = 100
- @admin.register(get_webhook_model(), site=archivebox_admin)
- class CustomWebhookAdmin(WebhookAdmin, ABIDModelAdmin):
- list_display = ('created_at', 'created_by', 'abid', *WebhookAdmin.list_display)
- sort_fields = ('created_at', 'created_by', 'abid', 'referenced_model', 'endpoint', 'last_success', 'last_error')
- readonly_fields = ('created_at', 'modified_at', 'abid_info', *WebhookAdmin.readonly_fields)
|