Fix bugs related to the reader and annotation features

apps/iiif/manifests/documents.py

@@ -56,7 +56,7 @@ class ManifestDocument(Document):
     class Index:
         """Settings for Elasticsearch"""
 
-        name = f"{settings.INDEX_PREFIX}_manifests"
+        name = f"{settings.INDEX_PREFIX}_manifests" if settings.INDEX_PREFIX else "manifests"
 
     class Django:
         """Settings for automatically pulling data from Django"""

apps/readux/annotations.py

@@ -22,7 +22,7 @@ class Annotations(View):
     """
 
     def get_queryset(self):
-        return Canvas.objects.filter(pid=self.kwargs["canvas"])
+        return Canvas.objects.filter(pid=self.kwargs["canvas"], manifest__pid=self.kwargs["vol"])
 
     def get(self, request, *args, **kwargs):
         username = kwargs["username"]
@@ -54,19 +54,20 @@ def get(self, request, *args, **kwargs):
                     )
 
             if "3" in kwargs["version"]:
+                canvas = queryset.first()
                 annotations = []
 
                 if username == "ocr":
-                    annotations = queryset.first().annotation_set.all()
+                    annotations = canvas.annotation_set.all()
                 elif owner.username == username:
-                    annotations = queryset.first().userannotation_set.filter(
-                        owner=owner
-                    )
+                    annotations = canvas.userannotation_set.filter(owner=owner)
 
                 return JsonResponse(
                     json.loads(
                         serialize(
-                            "annotation_page_v3", queryset, annotations=annotations
+                            "annotation_page_v3",
+                            Canvas.objects.filter(pk=canvas.pk),
+                            annotations=annotations,
                         )
                     )
                 )

apps/readux/documents.py

@@ -26,7 +26,7 @@ class UserAnnotationDocument(Document):
     class Index:
         """Settings for Elasticsearch"""
 
-        name = f"{settings.INDEX_PREFIX}_annotations"
+        name = f"{settings.INDEX_PREFIX}_annotations" if settings.INDEX_PREFIX else "annotations"
 
     class Django:
         """Settings for automatically pulling data from Django"""

apps/readux/search.py

@@ -142,7 +142,15 @@ def get_queryresults(self):
             anno_queries_exact.append({"bool": {"should": [nested_exact]}})
 
         # combine exact and partial with bool: { should, must }
-        q = Q("bool", should=anno_queries, must=anno_queries_exact)
+        # NOTE: because we apply `.filter()` (owner + manifest), the bool query has a
+        # filter context. When there is no `must` clause, Elasticsearch defaults
+        # minimum_should_match to 0, which would return *every* annotation in the volume
+        # regardless of the keyword. Require at least one `should` match when there are no
+        # exact (must) queries to enforce the keyword.
+        bool_kwargs = {"should": anno_queries, "must": anno_queries_exact}
+        if not anno_queries_exact:
+            bool_kwargs["minimum_should_match"] = 1
+        q = Q("bool", **bool_kwargs)
         annotations = annotations.query(q)
         annotations = annotations.highlight("content")
 
@@ -154,11 +162,16 @@ def get_queryresults(self):
         annotation_matches = []
         if annotation_match_count:
             for anno in anno_response.hits:
+                # skip hits without a highlight (no actual keyword match); accessing
+                # missing highlight data would otherwise raise an AttributeError
+                highlight = getattr(anno.meta, "highlight", None)
+                if not highlight or "content" not in highlight:
+                    continue
                 annotation_matches.append(
                     {
                         "canvas_index": anno["canvas_index"],
                         "canvas_pid": anno["canvas_pid"],
-                        "context": list(anno.meta.highlight.content),
+                        "context": list(highlight.content),
                     }
                 )
 
@@ -171,10 +184,11 @@ def get_queryresults(self):
         annotation_matches_on_canvas = 0
         annotation_matches_in_volume = 0
         for k, v in groupby(annotation_matches, key=group_key):
-            canvas_matches = list(flatten([match["context"] for match in v]))
+            group = list(v)
+            canvas_matches = list(flatten([match["context"] for match in group]))
             annotation_matches_grouped.append(
                 {
-                    "canvas_index": anno["canvas_index"],
+                    "canvas_index": group[0]["canvas_index"],
                     "canvas_match_count": len(canvas_matches),
                     "canvas_pid": k,
                     "context": canvas_matches,

apps/readux/tests/test_search.py

@@ -147,6 +147,21 @@ def test_manifest_canvas_user_annotation_partial_search(self):
             # should be in canvas indices 1 and 2
             assert match["canvas_index"] in [1, 2]
 
+    def test_manifest_canvas_user_annotation_partial_search_no_results(self):
+        # a partial (non-exact) keyword that matches none of the user's annotations should
+        # return zero matches. Regression test: a filter context with only `should` clauses
+        # caused Elasticsearch to default minimum_should_match to 0 and return every
+        # annotation in the volume regardless of the keyword.
+        query_params = {'volume_id': self.volume.pid, 'keyword': 'nonexistentword'}
+        request = self.request.get(
+            self.url, query_params
+        )
+        request.user = self.user
+        response = self.search_manifest_view(request)
+        search_results = self.load_results(response)
+        assert search_results['matches_in_annotations']['total_matches_in_volume'] == 0
+        assert len(search_results['matches_in_annotations']['volume_matches']) == 0
+
     def test_manifest_canvas_user_annotation_exact_search(self):
         query_params = {'volume_id': self.volume.pid, 'keyword': '"outcasts"'}
         request = self.request.get(

apps/static/css/components/collection.scss

@@ -94,7 +94,18 @@
     .description-text {
         display: block;
     }
-
+
+    /* Links need a light color for contrast against the dark hero background */
+    a {
+        color: $rx-color-sky-blue;
+        text-decoration: underline;
+
+        &:hover,
+        &:focus {
+            color: $rx-color-faded-mint;
+        }
+    }
+
     /* When description is truncated */
     &.description-truncated .description-text::after {
         content: '';

apps/static/css/components/reader.scss

@@ -86,6 +86,39 @@
   right: 240px;
 }
 
+/* .ecds-annotator sets color:white globally; reset text color for annotation
+   content popups and the Jodit editor which both have white backgrounds. */
+.rdx-annotation-content,
+.jodit-container {
+  color: $rx-color-dark-charcoal;
+}
+
 .uk-search {
   padding-right: 10px;
+}
+
+.rx-annotation-index-row {
+  display: flex;
+  align-items: center;
+  gap: 0.4rem;
+
+  a {
+    display: flex;
+    align-items: center;
+    line-height: 1;
+  }
+
+  .rx-label-copy {
+    vertical-align: middle;
+  }
+}
+
+.rx-search-result-list {
+  margin-top: 0.25rem !important;
+  margin-bottom: 0 !important;
+  padding-left: 1.25rem !important;
+
+  .rx-search-result-item {
+    margin-top: 0.2rem;
+  }
 }

apps/static/css/readux.scss

@@ -40,8 +40,14 @@ html, body {
 
 main { flex-grow: 1; }
 
-/* Home page navigation transparent */
-.home-nav { nav { background-color: transparent !important; } }
+/* Home page navigation transparent, light text/icons over dark hero */
+.home-nav {
+  nav { background-color: transparent !important; }
+  a, .brand-logo, .brand-tagline { color: $color-white !important; }
+  svg line, svg path, svg circle, svg polygon, svg polyline, svg rect {
+    stroke: $color-white !important;
+  }
+}
 
 /* Overlay & content shell */
 .overlay {
@@ -185,8 +191,9 @@ em { color: inherit !important; }
 /* Buttons */
 .uk-button-default { @include interactive-border($rx-color-midnight-blue); }
 .uk-button-primary {
-  background-color: var(--link-color);
-  &:hover, &:active { background-color: var(--link-color); filter: contrast(var(--contrast)); }
+  background-color: var(--link-color) !important;
+  color: #fff !important;
+  &:hover, &:active { background-color: var(--link-color) !important; color: #fff !important; filter: contrast(var(--contrast)); }
 }
 
 /* Close icon */
@@ -342,9 +349,6 @@ button.google, button.github { color: $color-white; }
   padding: 0; margin: 0; user-select: auto;
 }
 .rx-action-btn { letter-spacing: 0.1em; font-size: small; }
-.rx-action-btn:hover { 
-  .rx-label-copy { background-color: $rx-color-midnight-blue !important; color: $color-white !important; }
-}
 
 .rx-breadcrumb-item > a, .rx-action-btn, .rx-icon-btn, .uk-dropdown-nav > li > a:hover {
   color: var(--link-color) !important; opacity: 0.75; transition: all 100ms ease-in-out;
@@ -356,12 +360,26 @@ button.google, button.github { color: $color-white; }
 .rx-anchor { color: var(--link-color) !important; opacity: 0.75; word-break: break-all; transition: all 100ms; &:hover { color: var(--link-color); opacity: 1; } }
 
 .rx-label-copy {
-  background: $color-white;
-  color: var(--link-color) !important;
-  border: var(--link-color) 1px solid;
-  font-size: 0.75rem; letter-spacing: 0.1rem; cursor: pointer; transition: all 100ms ease-in-out; font-weight: 600; font-family: 'Consolas','Monaco','Andale Mono','Ubuntu Mono','monospace' !important;
-  &:active { background-color: $rx-color-midnight-blue !important; border: 1px solid $rx-color-midnight-blue !important; opacity: 1; }
-  &:hover { background: $rx-color-midnight-blue; border-color: $rx-color-midnight-blue; color: $color-white !important; }
+  background: $rx-color-midnight-blue !important;
+  color: $color-white !important;
+  border: none !important;
+  font-size: 0.75rem;
+  letter-spacing: 0.1rem;
+  cursor: pointer;
+  transition: background 150ms ease-in-out, opacity 150ms ease-in-out;
+  font-weight: 600;
+  font-family: 'Consolas', 'Monaco', 'Andale Mono', 'Ubuntu Mono', monospace !important;
+
+  &:hover {
+    background: darken($rx-color-midnight-blue, 12%) !important;
+    color: $color-white !important;
+    opacity: 0.9;
+  }
+
+  &:active {
+    background: darken($rx-color-midnight-blue, 20%) !important;
+    opacity: 1;
+  }
 }
 
 /* Navigation & bars */

apps/static/js/components/OcrInspector.vue

@@ -5,9 +5,8 @@
       This page does not have any usable OCR.
     </div>
 
-    <div class="rx-info-content-label uk-flex-between rx-flex" style="align-items:center;">
-      <label class="uk-switch" for="ocr-overlay">
-        <span>Overlay OCR on Page</span>
+    <div class="rx-info-content-label uk-flex uk-flex-middle" style="gap: 1rem; align-items:center;">
+      <label class="uk-switch" for="ocr-overlay" style="margin: 0; flex-shrink: 0;">
         <input
           type="checkbox"
           id="ocr-overlay"
@@ -17,6 +16,7 @@
         >
         <div class="uk-switch-slider"></div>
       </label>
+      <span style="flex: 1;">Overlay OCR on Page</span>
     </div>
 
     <div class="rx-info-content-value uk-margin-small-bottom uk-text-italic">