archivebox.core.views

Module Contents

Classes

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
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
_safe_archive_relpath
_coerce_sort_timestamp
_snapshot_sort_key
_snapshot_id_from_replay_path
_replay_path_visible
_latest_response_match
_latest_responses_root
_latest_snapshot_for_domain
_original_request_url
_serve_responses_path
_serve_snapshot_replay
_serve_original_domain_replay
live_config_list_view
live_config_value_view

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)

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)

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._coerce_sort_timestamp(value: str | float | None) → float

archivebox.core.views._snapshot_sort_key(match_path: str, cache: dict[str, float]) → tuple[float, str]

archivebox.core.views._snapshot_id_from_replay_path(path: pathlib.Path) → str | None

archivebox.core.views._replay_path_visible(request: django.http.HttpRequest, path: pathlib.Path) → bool

archivebox.core.views._latest_response_match(request: django.http.HttpRequest, domain: str, rel_path: str, *, data_root: pathlib.Path) → tuple[pathlib.Path, pathlib.Path] | None

archivebox.core.views._latest_responses_root(request: django.http.HttpRequest, domain: str, *, data_root: pathlib.Path) → pathlib.Path | None

archivebox.core.views._latest_snapshot_for_domain(request: django.http.HttpRequest, domain: str) → archivebox.core.models.Snapshot | 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._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

template_name

‘public_index.html’

model

None

ordering

[‘-bookmarked_at’, ‘-created_at’]

paginator_class

None

get_paginate_by(queryset)

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()

_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