Integrate archived content into browse view

Author: bkis

Tekst-API/openapi.json

@@ -121,6 +121,24 @@
               "title": "Head"
             },
             "description": "Only return contents for the head location of the path"
+          },
+          {
+            "name": "ts",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "integer"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "UTC timestamp in milliseconds to get contents that were current at that point in time",
+              "title": "Ts"
+            },
+            "description": "UTC timestamp in milliseconds to get contents that were current at that point in time"
           }
         ],
         "responses": {

Tekst-API/tekst/routers/browse.py

@@ -1,7 +1,8 @@
+from datetime import UTC, datetime
 from typing import Annotated, Literal
 
 from beanie import PydanticObjectId
-from beanie.operators import Eq, In, NotIn
+from beanie.operators import LTE, Eq, In, NotIn
 from fastapi import APIRouter, Path, Query, status
 
 from tekst import errors
@@ -154,6 +155,16 @@ async def get_location_data(
             description="Only return contents for the head location of the path",
         ),
     ] = False,
+    archive_ts: Annotated[
+        int | None,
+        Query(
+            alias="ts",
+            description=(
+                "UTC timestamp in milliseconds to get contents "
+                "that were current at that point in time"
+            ),
+        ),
+    ] = None,
 ) -> LocationData:
     """
     Returns the location path from the location with the given ID or text/level/position
@@ -165,6 +176,16 @@ async def get_location_data(
     # (internal constant to conveniently adjust it later if needed)
     contents_fetch_limit = 1024
 
+    # preprocess archive UTC TS
+    archive_ts = (
+        None
+        if archive_ts is None
+        else datetime.fromtimestamp(
+            archive_ts / 1000,
+            tz=UTC,
+        )
+    )
+
     # find target location
     location_doc = None
     if location_id:
@@ -202,20 +223,39 @@ async def get_location_data(
         with_children=True,
     ).to_list()
 
-    contents = {
-        content.resource_id: [content]
-        for content in await ContentBaseDocument.find(
-            In(ContentBaseDocument.location_id, location_ids or []),
-            In(
-                ContentBaseDocument.resource_id,
-                [resource.id for resource in target_resources],
-            ),
-            Eq(ContentBaseDocument.archived, False),
-            with_children=True,
-        )
-        .limit(contents_fetch_limit)
-        .to_list()
-    }
+    if archive_ts is None:
+        # just query for most recent contents (we can do that in one DB request)
+        contents = {
+            content.resource_id: [content]
+            for content in await ContentBaseDocument.find(
+                In(ContentBaseDocument.location_id, location_ids or []),
+                In(
+                    ContentBaseDocument.resource_id,
+                    [resource.id for resource in target_resources],
+                ),
+                Eq(ContentBaseDocument.archived, False),
+                with_children=True,
+            )
+            .limit(contents_fetch_limit)
+            .to_list()
+        }
+    else:
+        # for each resource/location combination,
+        # get the content that fits the requested timestamp
+        contents = {}
+        for resource in target_resources:
+            content = (
+                await ContentBaseDocument.find(
+                    In(ContentBaseDocument.location_id, location_ids or []),
+                    Eq(ContentBaseDocument.resource_id, resource.id),
+                    LTE(ContentBaseDocument.created_at, archive_ts),
+                    with_children=True,
+                )
+                .sort(-ContentBaseDocument.created_at)
+                .first_or_none()
+            )
+            if content:
+                contents[resource.id] = [content]
 
     # add combined contents (content context) of resources that are on the subordinate
     # level of the target location (if the resources are configured to support this!)

Tekst-Web/i18n/ui/deDE.yml

@@ -81,7 +81,7 @@ common:
   years: Jahre
   months: Monate
   days: Tage
-  today: heute
+  latest: aktuell
   backToOverview: Zurück zur Übersicht
   downloadSaved: Datei gespeichert als {filename}.
   areYouSure: Sind Sie sich sicher?
@@ -608,18 +608,6 @@ contents:
   forComparison: '{title} (zum Vergleich)'
   noContent: Für diese Belegstelle liegen keine Inhalte vor.
   btnAddContent: Inhalt hinzufügen
-  archiveWidgetTitle: Archivierte Versionen
-  archiveAction: Archivieren
-  archived: archiviert
-  msgArchived: Der Inhalt für diese Belegstelle wurde archiviert.
-  msgNoArchivedContents: Keine archivierten Inhalte für diese Belegstelle gefunden.
-  confirmArchive: |
-    Sind Sie sicher, dass Sie den Inhalt für diese Belegstelle archivieren wollen?
-    Er wird nicht mehr in Suchergebnissen oder der Leseansicht angezeigt, kann aber
-    weiterhin als archivierte Version aufgerufen werden.
-    Sie können ihn später wiederherstellen.
-  restore: Wiederherstellen
-  msgRestored: Der Inhalt für diese Belegstelle wurde aus dem Archiv wiederhergestellt.
   confirmDelete: |
     Möchten Sie den Inhalt für diese Belegstelle wirklich löschen? Sie können ihn stattdessen auch archivieren.
     Wenn Sie den Inhalt löschen, werden auch alle archivierten Versionen des Inhalts gelöscht,
@@ -637,6 +625,28 @@ contents:
     oder Änderungen vornehmen und sie als Inhalt dieser Ressourcen-Ausbesserung speichern.
   msgContentNoFocusView: Dieser Inhalt kann in der Fokus-Ansicht nicht angezeigt werden.
   warnUrlInvalid: 'Diese URL scheint ungültig oder nicht erreichbar zu sein: {url}'
+  archive:
+    widgetTitle: Archivierte Versionen
+    widgetTip: Archivierte Versionen von Inhalten anzeigen
+    action: Archivieren
+    archived: archiviert
+    msgArchived: Der Inhalt für diese Belegstelle wurde archiviert.
+    msgNoArchivedContents: Keine archivierten Inhalte für diese Belegstelle gefunden.
+    confirmArchive: |
+      Sind Sie sicher, dass Sie den Inhalt für diese Belegstelle archivieren wollen?
+      Er wird nicht mehr in Suchergebnissen oder der Leseansicht angezeigt, kann aber
+      weiterhin als archivierte Version aufgerufen werden.
+      Sie können ihn später wiederherstellen.
+    warnBrowseArchive: |
+      Sie sehen Inhalte vom {date}.
+      Einige der angezeigten Inhalte sind möglicherweise archivierte Versionen,
+      die nicht mehr aktuell sind – diese sind mit einem gelben Symbol gekennzeichnet.
+      Andere Inhalte fehlen möglicherweise, da sie zu diesem Zeitpunkt noch nicht existierten.
+      Wenn Sie den aktuellen Stand der Inhalte sehen möchten, klicken Sie auf den Button unter diesem Hinweis.
+    loadCurrentContents: Aktuelle Inhalte laden
+    archivedContentTip: Archivierte Version von {date}
+    restore: Wiederherstellen
+    msgRestored: Der Inhalt für diese Belegstelle wurde aus dem Archiv wiederhergestellt.
   corrections:
     notes: Korrekturnotizen
     otherTitle: Andere Belegstellen

Tekst-Web/i18n/ui/enUS.yml

@@ -81,7 +81,7 @@ common:
   years: years
   months: months
   days: days
-  today: today
+  latest: latest
   backToOverview: Back to overview
   downloadSaved: File saved as {filename}.
   areYouSure: Are you sure?
@@ -231,6 +231,7 @@ browse:
     showNonPublicResources: Show unpublished resources
     activateCategory: Show all resources in this category
     deactivateCategory: Hide all resources in this category
+  archiveWidgetTitle: Content Archive
   uncategorized: Uncategorized
   locationResourceNoData: No data for this location
   textNoLocations: This text's setup seems incomplete. There are no locations defined.
@@ -597,17 +598,6 @@ contents:
   forComparison: '{title} (for comparison)'
   noContent: There is no content for this location.
   btnAddContent: Add content
-  archiveWidgetTitle: Archived Versions
-  archiveAction: Archive
-  archived: archived
-  msgArchived: The content for this location has been archived.
-  msgNoArchivedContents: No archived contents found for this location.
-  confirmArchive: |
-    Are you sure you want to archive the content for this location?
-    It won't be shown in search results or the reading view anymore, but can still be
-    accessed as an archived version. You will also be able to restore it later.
-  restore: Restore
-  msgRestored: The content for this location has been restored from the archive.
   confirmDelete: |
     Are you sure you want to delete the content for this location? You may archive it instead.
     Deleting it will also delete all archived versions of this content,
@@ -625,6 +615,27 @@ contents:
     or make changes and save them as content of this resource patch.
   msgContentNoFocusView: This content cannot be displayed in focus view.
   warnUrlInvalid: 'The URL seems to be invalid or unreachable: {url}'
+  archive:
+    widgetTitle: Archived Versions
+    widgetTip: View archived content versions
+    action: Archive
+    archived: archived
+    msgArchived: The content for this location has been archived.
+    msgNoArchivedContents: No archived contents found for this location.
+    confirmArchive: |
+      Are you sure you want to archive the content for this location?
+      It won't be shown in search results or the reading view anymore, but can still be
+      accessed as an archived version. You will also be able to restore it later.
+    warnBrowseArchive: |
+      You are viewing contents from {date}.
+      Some of the contents shown may be archived versions that are not up to date – those
+      are marked with a yellow symbol.
+      Other contents might be missing because they didn't exist at this date, yet.
+      If you want to see the current state of the contents, click the button below this message.
+    loadCurrentContents: Load current contents
+    archivedContentTip: Archived version from {date}
+    restore: Restore
+    msgRestored: The content for this location has been restored from the archive.
   corrections:
     notes: Correction Notes
     otherTitle: Other locations

Tekst-Web/src/components/browse/ArchiveWidget.vue

@@ -11,7 +11,7 @@ import ButtonShelf from '@/components/generic/ButtonShelf.vue';
 import GenericModal from '@/components/generic/GenericModal.vue';
 import { useMessages } from '@/composables/messages';
 import { $t } from '@/i18n';
-import { ArrowBackIcon, HistoryIcon, NoContentIcon } from '@/icons';
+import { ArchiveIcon, ArrowBackIcon, NoContentIcon } from '@/icons';
 import { useStateStore } from '@/stores';
 import { utcToDateTimeString } from '@/utils';
 import { NButton, NEmpty, NFlex, NIcon, NSpin } from 'naive-ui';
@@ -40,7 +40,7 @@ const showModal = ref(false);
 const loading = ref(false);
 const selectedContent = ref<AnyContentRead>();
 const archiveItems = ref<AnyContentArchiveItem[]>([]);
-const title = ref($t('contents.archiveWidgetTitle'));
+const title = ref($t('contents.archive.widgetTitle'));
 
 function getTsDistanceMs(utcStr1: string, utcStr2: string) {
   return Math.ceil(Math.abs(new Date(utcStr1).getTime() - new Date(utcStr2).getTime()));
@@ -111,7 +111,7 @@ async function handleItemClick(archiveItem: AnyContentArchiveItem) {
   const { data, error } = await GET('/contents/{id}', { params: { path: { id: archiveItem.id } } });
   if (!error) {
     selectedContent.value = data;
-    title.value = archiveItem.createdAtStr ?? $t('contents.archiveWidgetTitle');
+    title.value = archiveItem.createdAtStr ?? $t('contents.archive.widgetTitle');
   }
   loading.value = false;
 }
@@ -124,33 +124,37 @@ async function restoreArchivedContent(archivedContent: AnyContentRead) {
   });
   if (!error) {
     emit('restore', data);
-    message.success($t('contents.msgRestored'));
+    message.success($t('contents.archive.msgRestored'));
   }
   loading.value = false;
   showModal.value = false;
 }
 
 function handleBackToOverview() {
   selectedContent.value = undefined;
-  title.value = $t('contents.archiveWidgetTitle');
+  title.value = $t('contents.archive.widgetTitle');
 }
 
 function cleanup() {
   selectedContent.value = undefined;
   archiveItems.value = [];
-  title.value = $t('contents.archiveWidgetTitle');
+  title.value = $t('contents.archive.widgetTitle');
 }
 </script>
 
 <template>
-  <n-button v-bind="$attrs" @click.stop.prevent="handleWidgetClick">
-    {{ $t('contents.archiveWidgetTitle') }}
+  <n-button
+    v-bind="$attrs"
+    :title="$t('contents.archive.widgetTip')"
+    @click.stop.prevent="handleWidgetClick"
+  >
+    {{ $t('contents.archive.widgetTitle') }}
   </n-button>
 
   <generic-modal
     v-model:show="showModal"
     :title="title"
-    :icon="HistoryIcon"
+    :icon="ArchiveIcon"
     width="wide"
     @after-enter="loadArchiveData"
     @after-leave="cleanup"
@@ -177,10 +181,11 @@ function cleanup() {
       />
     </div>
     <template v-else-if="!selectedContent">
-      <n-flex v-if="archiveItems?.length > 1" vertical size="large">
+      <n-flex vertical size="large">
         <template v-for="item in archiveItems" :key="item.id">
-          <n-button v-if="!item.archived" secondary disabled>
-            {{ $t('common.today') }}
+          <n-button v-if="!item.archived" dashed disabled>
+            {{ item.createdAtStr }}
+            ({{ $t('common.latest') }})
           </n-button>
           <n-button v-else secondary @click="handleItemClick(item)">
             {{ item.createdAtStr }}
@@ -190,11 +195,15 @@ function cleanup() {
             class="time-gap translucent text-tiny"
             :style="{ lineHeight: 12 + item.distanceRel * 120 + 'px' }"
           >
-            {{ item.distanceStr }}
+            ~ {{ item.distanceStr }}
           </div>
         </template>
       </n-flex>
-      <n-empty v-else-if="!loading" :description="$t('contents.msgNoArchivedContents')">
+      <n-empty
+        v-if="!loading"
+        :description="$t('contents.archive.msgNoArchivedContents')"
+        class="mt-lg"
+      >
         <template #icon>
           <n-icon :component="NoContentIcon" />
         </template>
@@ -208,7 +217,7 @@ function cleanup() {
         type="warning"
         @click="restoreArchivedContent(selectedContent)"
       >
-        {{ $t('contents.restore') }}
+        {{ $t('contents.archive.restore') }}
       </n-button>
       <n-button type="primary" @click="showModal = false">
         {{ $t('common.close') }}