archivebox.core.views

Module Contents

Classes

SnapshotReplayAuthView	Admin-only handoff that lets a snap host mint its own replay cookie.
HomepageView
SnapshotView
SnapshotPathView	Serve snapshots by the new URL scheme: /////…
SnapshotHostView	Serve snapshot directory contents on .<listen_host>/.
SnapshotReplayView	Serve snapshot directory contents on a one-domain replay path.
OriginalDomainHostView	Serve responses from the most recent snapshot when using .<listen_host>/.
OriginalDomainReplayView	Serve original-domain replay content on a one-domain replay path.
PublicIndexView	Keep browsing responsive while the same small server is archiving.
AddView
WebAddView
HealthCheckView	A Django view that renders plain text “OK” for service discovery tools

Functions

_files_index_target
_find_snapshot_by_ref
_admin_login_redirect_or_forbidden
_replay_cookie_name
_clean_replay_next	Only allow same-snap relative replay paths; grants must never redirect off-host.
_replay_payload_is_valid	A replay cookie is not its own auth source; it must point at a live admin session.
_has_replay_cookie
_private_snapshot_auth_redirect
_replay_auth_response
_safe_archive_relpath
_resolve_archiveresult_relpath	Resolve a declared output path and its exact historical fallbacks.
_plugin_full_preview_response	Render an explicit plugin full template as a trusted preview wrapper.
_trusted_snapshot_frame_csp
_plugin_card_document_response	Serve the existing card template from the snapshot origin, not web.*.
_visible_response_snapshots_for_domain
_latest_response_match
_latest_responses_root
_original_request_url
_serve_responses_path
_build_snapshot_replay_response
_serve_snapshot_replay
_serve_original_domain_replay
live_config_list_view
live_config_value_view

Data

REPLAY_AUTH_SALT
REPLAY_COOKIE_PREFIX
REPLAY_GRANT_MAX_AGE

API

archivebox.core.views._files_index_target(snapshot: archivebox.core.models.Snapshot, archivefile: str | None) → str

archivebox.core.views._find_snapshot_by_ref(snapshot_ref: str) → archivebox.core.models.Snapshot | None

archivebox.core.views._admin_login_redirect_or_forbidden(request: django.http.HttpRequest)

archivebox.core.views.REPLAY_AUTH_SALT

‘archivebox.private-snapshot-replay’

archivebox.core.views.REPLAY_COOKIE_PREFIX

None

archivebox.core.views.REPLAY_GRANT_MAX_AGE

60

archivebox.core.views._replay_cookie_name(snapshot: archivebox.core.models.Snapshot) → str

archivebox.core.views._clean_replay_next(path: str | None) → str

Only allow same-snap relative replay paths; grants must never redirect off-host.

archivebox.core.views._replay_payload_is_valid(payload: dict, snapshot: archivebox.core.models.Snapshot) → bool

A replay cookie is not its own auth source; it must point at a live admin session.

Replayed pages can execute hostile JS, so admin cookies stay host-only on admin.. The snap host gets only this host-only HttpOnly cookie, and every request checks that the original Django session still exists and still belongs to an active staff user. Logout, session expiry, user deletion/deactivation, or password auth-hash rotation all make the replay cookie inert without needing admin. to delete a cookie on snap-*.

archivebox.core.views._has_replay_cookie(request: django.http.HttpRequest, snapshot: archivebox.core.models.Snapshot) → bool

archivebox.core.views._private_snapshot_auth_redirect(request: django.http.HttpRequest, snapshot: archivebox.core.models.Snapshot, path: str = '', *, preserve_query: bool = True)

archivebox.core.views._replay_auth_response(request: django.http.HttpRequest, snapshot: archivebox.core.models.Snapshot)

class archivebox.core.views.SnapshotReplayAuthView

Bases: django.views.View

Admin-only handoff that lets a snap host mint its own replay cookie.

admin.* cannot set a host-only cookie for snap-* (browsers forbid that), and widening the real Django session cookie to .archivebox.localhost would let XSS in replayed pages hit the admin UI. Instead admin. proves the user is logged in with a short URL grant, then snap-* validates it and sets a snap-host-only cookie.

get(request: django.http.HttpRequest)

class archivebox.core.views.HomepageView

Bases: django.views.View

get(request)

class archivebox.core.views.SnapshotView

Bases: django.views.View

static find_snapshots_for_url(path: str, *, allow_fallback: bool = True)

Return a queryset of snapshots matching a URL-ish path. URL only — never tries ID matching.

Use find_snapshots_for_id separately if you also want to match by snapshot UUID.

static find_snapshots_for_id(slug: str)

Return a queryset of snapshots matching a (possibly truncated) UUID via prefix or suffix.

Strips non-hex characters from slug (so input with or without hyphens both work). Requires at least 8 hex chars — shorter inputs return an empty queryset to avoid scanning the entire snapshots table on too-broad matches.

static render_live_index(request, snapshot)

get(request, path)

class archivebox.core.views.SnapshotPathView

Bases: django.views.View

Serve snapshots by the new URL scheme: /////…

get(request, username: str, date: str | None = None, domain: str | None = None, snapshot_id: str | None = None, path: str = '', url: str | None = None)

archivebox.core.views._safe_archive_relpath(path: str) → str | None

archivebox.core.views._resolve_archiveresult_relpath(snapshot: archivebox.core.models.Snapshot, rel_path: str) → tuple[str, archivebox.core.models.ArchiveResult | None, tuple[str, ...]]

Resolve a declared output path and its exact historical fallbacks.

archivebox.core.views._plugin_full_preview_response(request: django.http.HttpRequest, snapshot: archivebox.core.models.Snapshot, rel_path: str, result: archivebox.core.models.ArchiveResult | None) → django.http.HttpResponse | None

Render an explicit plugin full template as a trusted preview wrapper.

archivebox.core.views._trusted_snapshot_frame_csp(request: django.http.HttpRequest) → str

archivebox.core.views._plugin_card_document_response(request: django.http.HttpRequest, snapshot: archivebox.core.models.Snapshot, result_id: str) → django.http.HttpResponse

Serve the existing card template from the snapshot origin, not web.*.

srcdoc and inline card scripts inherit the containing page’s origin. This frame route gives them same-origin access to this snapshot’s saved files without opening CORS on raw archives or sharing the admin session cookie. The parent web page receives only the one-bit login hint; delete buttons navigate to admin.* for a real authenticated confirmation.

archivebox.core.views._visible_response_snapshots_for_domain(request: django.http.HttpRequest, domain: str) → list[archivebox.core.models.Snapshot]

archivebox.core.views._latest_response_match(snapshots: list[archivebox.core.models.Snapshot], domain: str, rel_path: str) → tuple[archivebox.core.models.Snapshot, pathlib.Path, pathlib.Path] | None

archivebox.core.views._latest_responses_root(snapshots: list[archivebox.core.models.Snapshot], domain: str) → tuple[archivebox.core.models.Snapshot, pathlib.Path] | None

archivebox.core.views._original_request_url(domain: str, path: str = '', query_string: str = '') → str

archivebox.core.views._serve_responses_path(request, responses_root: pathlib.Path, rel_path: str, show_indexes: bool)

archivebox.core.views._build_snapshot_replay_response(request: django.http.HttpRequest, snapshot: archivebox.core.models.Snapshot, path: str = '')

archivebox.core.views._serve_snapshot_replay(request: django.http.HttpRequest, snapshot: archivebox.core.models.Snapshot, path: str = '')

archivebox.core.views._serve_original_domain_replay(request: django.http.HttpRequest, domain: str, path: str = '')

class archivebox.core.views.SnapshotHostView

Bases: django.views.View

Serve snapshot directory contents on .<listen_host>/.

get(request, snapshot_id: str, path: str = '')

class archivebox.core.views.SnapshotReplayView

Bases: django.views.View

Serve snapshot directory contents on a one-domain replay path.

get(request, snapshot_id: str, path: str = '')

class archivebox.core.views.OriginalDomainHostView

Bases: django.views.View

Serve responses from the most recent snapshot when using .<listen_host>/.

get(request, domain: str, path: str = '')

class archivebox.core.views.OriginalDomainReplayView

Bases: django.views.View

Serve original-domain replay content on a one-domain replay path.

get(request, domain: str, path: str = '')

class archivebox.core.views.PublicIndexView

Bases: django.views.generic.list.ListView

Keep browsing responsive while the same small server is archiving.

Performance takes priority over perfect initial totals: on a 1 vCPU / 1 GB host with hundreds of thousands of snapshots, even an indexed count can consume the entire roughly 0.5-0.7 second page-load budget. Benchmark with the runner active, since it shares the CPU, memory, and SQLite database.

The unfiltered list therefore renders rows first and accepts missing/stale display totals. A later ordinary reload can show the background-cached count; do not restore a synchronous COUNT or add polling just to fill it in.

template_name

‘public_index.html’

model

None

ordering: ClassVar[list[str]]

[‘-bookmarked_at’, ‘-created_at’]

paginator_class

None

public_page_scan_chunk_size

50

get_paginate_by(queryset)

_base_public_snapshot_fields() → tuple[str, ...]

_ordered_public_page_from_order_index(*, page_number: int, page_size: int) → list[archivebox.core.models.Snapshot]

paginate_queryset(queryset, page_size)

get_context_data(**kwargs)

get_queryset(**kwargs)

get(*args, **kwargs)

class archivebox.core.views.AddView

Bases: django.contrib.auth.mixins.UserPassesTestMixin, django.views.generic.FormView

template_name

‘add.html’

form_class

None

get_initial()

Prefill the AddLinkForm with the ‘url’ GET parameter

get_form_kwargs()

test_func()

post(request: django.http.HttpRequest, *args: object, **kwargs: object)

_can_override_crawl_config() → bool

_get_custom_config_overrides(form: archivebox.core.forms.AddLinkForm) → dict

get_context_data(**kwargs)

_create_crawl_from_form(form, *, created_by_id=None) → archivebox.crawls.models.Crawl

form_valid(form)

class archivebox.core.views.WebAddView

Bases: archivebox.core.views.AddView

_latest_snapshot_for_url(requested_url: str)

_normalize_add_url(requested_url: str) → str

dispatch(request, *args, **kwargs)

get(request: django.http.HttpRequest, *args: object, **kwargs: object)

class archivebox.core.views.HealthCheckView

Bases: django.views.View

A Django view that renders plain text “OK” for service discovery tools

get(request)

Handle a GET request

archivebox.core.views.live_config_list_view(request: django.http.HttpRequest, **kwargs) → admin_data_views.typing.TableContext

archivebox.core.views.live_config_value_view(request: django.http.HttpRequest, key: str, **kwargs) → admin_data_views.typing.ItemContext