Add a webArchive resource page block

Ships a theme-provided resource page block layout (Omeka S 4.2+) that renders
the WebArchive module's ReplayWeb.page player. It outputs nothing when an item
carries no capture, so it is safe to leave in the default block stack.

Web-archive media are excluded from mediaEmbeds so the two blocks can never
both mount a player over the same .wacz — that would mean two service-worker
clients and twice the range traffic.

Because resource_page_blocks in theme.ini is only a fallback (core prefers
site-stored settings), established sites need the block added via
Admin -> Themes -> Configure resource pages before captures render.

Matches application/warc as well as application/wacz: the module plays both
through the same viewer, so matching only wacz would silently drop a warc.

Author: fmadore

config/theme.ini

@@ -294,7 +294,23 @@ resource_page_regions.item_sets.right = "Right sidebar"
 resource_page_regions.media.right = "Right sidebar"
 
 
+; Theme-provided block layouts (Omeka S 4.2+). Each needs a label, the resource
+; types it may be placed on, and the partial under
+; view/common/resource-page-block-layout/. Core wraps these in
+; ThemeProvidedResourcePageBlockLayout, which passes the partial only
+; ['resource' => $resource] — any other data must be derived in the template.
+;
+; webArchive renders the WebArchive module's ReplayWeb.page player and outputs
+; nothing on items without a capture, so it is safe to leave in the default
+; stack. Web-archive media are excluded from mediaEmbeds to keep the two blocks
+; from mounting duplicate players; see web-archive.phtml.
+resource_page_block_layouts.webArchive.label = "Web archive"
+resource_page_block_layouts.webArchive.compatible_resource_names[] = "items"
+resource_page_block_layouts.webArchive.partial = "web-archive"
+
+
 resource_page_blocks.items.main[] = "mediaEmbeds"
+resource_page_blocks.items.main[] = "webArchive"
 resource_page_blocks.items.main[] = "values"
 resource_page_blocks.items.main[] = "itemSets"
 resource_page_blocks.items.main[] = "sitePages"

language/fr.mo

@@ -44,6 +44,12 @@ msgstr "Tout"
 msgid "An error occurred while processing your request. Please try again later."
 msgstr "Une erreur s’est produite lors du traitement de votre demande. Veuillez réessayer plus tard."
 
+#: view/common/resource-page-block-layout/web-archive.phtml:33
+msgid "Archived web page"
+msgid_plural "Archived web pages"
+msgstr[0] "Page web archivée"
+msgstr[1] "Pages web archivées"
+
 #: view/common/banner.phtml:143
 msgid "Audiovisual minutes"
 msgstr "Minutes audiovisuelles"

language/fr.po

@@ -46,6 +46,12 @@ msgstr ""
 msgid "An error occurred while processing your request. Please try again later."
 msgstr ""
 
+#: view/common/resource-page-block-layout/web-archive.phtml:33
+msgid "Archived web page"
+msgid_plural "Archived web pages"
+msgstr[0] ""
+msgstr[1] ""
+
 #: view/common/banner.phtml:143
 msgid "Audiovisual minutes"
 msgstr ""

language/template.pot

@@ -1,6 +1,17 @@
 <?php
-$resourceMedia = $resource->media();
 $decoration = $this->themeSetting('image_decoration');
+
+// Web-archive media are rendered by the dedicated `webArchive` block
+// (web-archive.phtml), not here. Without this exclusion an item with both
+// blocks enabled would mount two ReplayWeb.page players over the same .wacz —
+// two service-worker clients and twice the range traffic. Keep the type list in
+// sync with web-archive.phtml (both mirror WebArchive\Module::MEDIA_TYPES).
+$resourceMedia = [];
+foreach ($resource->media() as $media) {
+    if (!in_array($media->mediaType(), ['application/wacz', 'application/warc'], true)) {
+        $resourceMedia[] = $media;
+    }
+}
 ?>
 <?php if ($resourceMedia): ?>
 <div class="media-embeds <?php echo is_array($decoration) && in_array('media', $decoration) ? 'decoration' : ''; ?>">

view/common/resource-page-block-layout/media-embeds.phtml

@@ -0,0 +1,40 @@
+<?php
+/**
+ * Web archive block — renders the WebArchive module's ReplayWeb.page player for
+ * any web-archive media on this item.
+ *
+ * Renders nothing when the item carries no capture, so the block can sit in the
+ * default stack without leaving an empty heading on every other item.
+ *
+ * Web-archive media are deliberately excluded from `media-embeds.phtml` so the
+ * two blocks can never both mount a player: two ReplayWeb.page instances over
+ * one .wacz means two service-worker clients and twice the range traffic. The
+ * corollary is that a site which does not enable this block (Admin → Themes →
+ * Configure resource pages) will not render captures at all.
+ *
+ * @var \Laminas\View\Renderer\PhpRenderer $this
+ * @var \Omeka\Api\Representation\ItemRepresentation $resource
+ */
+
+$archives = [];
+foreach ($resource->media() as $media) {
+    // Mirrors WebArchive\Module::MEDIA_TYPES. The module plays both formats
+    // through the same viewer, so matching only 'application/wacz' would
+    // silently drop a .warc upload.
+    if (in_array($media->mediaType(), ['application/wacz', 'application/warc'], true)) {
+        $archives[] = $media;
+    }
+}
+?>
+<?php if ($archives): ?>
+<div id="web-archive" class="web-archive">
+    <div class="web-archive__header">
+        <h3 class="web-archive__heading">
+            <?php echo $this->translatePlural('Archived web page', 'Archived web pages', count($archives)); ?>
+        </h3>
+    </div>
+    <?php foreach ($archives as $media): ?>
+    <?php echo $media->render(); ?>
+    <?php endforeach; ?>
+</div>
+<?php endif; ?>