fixes fore failing vocabulary/global search; fixes erroring ajax sear…

…ch queries; fixes waypoint system used in search; added checks for various easyrdf http client errors
NatLibFi · Jul 16, 2020 · 9f762ff · 9f762ff
1 parent af94269
commit 9f762ff
Show file tree

Hide file tree

Showing 10 changed files with 128 additions and 32 deletions.
diff --git a/controller/WebController.php b/controller/WebController.php
@@ -337,23 +337,47 @@ public function invokeGlobalSearch($request)
         $vocabObjects = array();
         if ($vocids) {
             foreach($vocids as $vocid) {
-                $vocabObjects[] = $this->model->getVocabulary($vocid);
+                try {
+                    $vocabObjects[] = $this->model->getVocabulary($vocid);
+                } catch (Exception $e) {
+                    // skip vocabularies not found in configuration
+                    // please note that this may result in global search
+                    // NB: should not happen in normal UI interaction
+                }
             }
         }
         $parameters->setVocabularies($vocabObjects);
 
+        $nondefaultEndpointVocs = array();
+
+        if (sizeOf($vocabObjects) != 1) {
+            // global search, either from all (sizeOf($vocabObjects) == 0) or from selected ones
+            if (sizeOf($vocabObjects) == 0) {
+                $vocabObjects = $this->model->getVocabularies();
+            }
+            $defaultEndpoint = $this->model->getConfig()->getDefaultEndpoint();
+            foreach($vocabObjects as $voc) {
+                if ($voc->getEndpoint() !== $defaultEndpoint) {
+                    $nondefaultEndpointVocs[] = $voc;
+                }
+            }
+        }
+
+        $counts = null;
+        $searchResults = null;
+        $errored = false;
+
         try {
             $countAndResults = $this->model->searchConceptsAndInfo($parameters);
+            $counts = $countAndResults['count'];
+            $searchResults = $countAndResults['results'];
         } catch (Exception $e) {
-            header("HTTP/1.0 404 Not Found");
+            $errored = true;
+            header("HTTP/1.0 500 Internal Server Error");
             if ($this->model->getConfig()->getLogCaughtExceptions()) {
                 error_log('Caught exception: ' . $e->getMessage());
             }
-            $this->invokeGenericErrorPage($request, $e->getMessage());
-            return;
         }
-        $counts = $countAndResults['count'];
-        $searchResults = $countAndResults['results'];
         $vocabList = $this->model->getVocabularyList();
         $sortedVocabs = $this->model->getVocabularyList(false, true);
         $langList = $this->model->getLanguages($lang);
@@ -365,6 +389,8 @@ public function invokeGlobalSearch($request)
                 'search_results' => $searchResults,
                 'rest' => $parameters->getOffset()>0,
                 'global_search' => true,
+                'search_failed' => $errored,
+                'skipped_vocabs' => $nondefaultEndpointVocs,
                 'term' => $request->getQueryParamRaw('q'),
                 'lang_list' => $langList,
                 'vocabs' => str_replace(' ', '+', $vocabs),
@@ -383,6 +409,7 @@ public function invokeVocabularySearch($request)
         $template = $this->twig->loadTemplate('vocab-search-listing.twig');
         $this->setLanguageProperties($request->getLang());
         $vocab = $request->getVocab();
+        $searchResults = null;
         try {
             $vocabTypes = $this->model->getTypes($request->getVocabid(), $request->getLang());
         } catch (Exception $e) {
@@ -396,6 +423,7 @@ public function invokeVocabularySearch($request)
                     'languages' => $this->languages,
                     'vocab' => $vocab,
                     'request' => $request,
+                    'search_results' => $searchResults
                 ));
 
             return;
@@ -419,6 +447,7 @@ public function invokeVocabularySearch($request)
                     'languages' => $this->languages,
                     'vocab' => $vocab,
                     'term' => $request->getQueryParam('q'),
+                    'search_results' => $searchResults
                 ));
             return;
         }

diff --git a/model/DataObject.php b/model/DataObject.php
@@ -46,10 +46,15 @@ public function __construct($model, $resource)
     protected function getExternalLabel($exvoc, $exuri, $lang)
     {
         if ($exvoc) {
-            $exsparql = $exvoc->getSparql();
-            $results = $exsparql->queryLabel($exuri, $lang);
-
-            return isset($results[$lang]) ? $results[$lang] : null;
+            try {
+                $exsparql = $exvoc->getSparql();
+                $results = $exsparql->queryLabel($exuri, $lang);
+                return isset($results[$lang]) ? $results[$lang] : null;
+            } catch (EasyRdf\Http\Exception | EasyRdf\Exception | Throwable $e) {
+                if ($this->model->getConfig()->getLogCaughtExceptions()) {
+                    error_log('Caught exception: ' . $e->getMessage());
+                }
+            }
         }
         return null;
     }
@@ -63,9 +68,15 @@ protected function getExternalLabel($exvoc, $exuri, $lang)
     protected function getExternalNotation($exvoc, $exuri)
     {
         if ($exvoc) {
-            $exsparql = $exvoc->getSparql();
-            $results = $exsparql->queryNotation($exuri);
-            return isset($results) ? $results : null;
+            try {
+                $exsparql = $exvoc->getSparql();
+                $results = $exsparql->queryNotation($exuri);
+                return isset($results) ? $results : null;
+            } catch (EasyRdf\Http\Exception | EasyRdf\Exception | Throwable $e) {
+                if ($this->model->getConfig()->getLogCaughtExceptions()) {
+                    error_log('Caught exception: ' . $e->getMessage());
+                }
+            }
         }
         return null;
     }

diff --git a/model/Model.php b/model/Model.php
@@ -470,11 +470,18 @@ private function disambiguateVocabulary($vocabs, $uri, $preferredVocabId = null)
         if($preferredVocabId != null) {
             foreach ($vocabs as $vocab) {
                 if($vocab->getId() == $preferredVocabId) {
-                    // double check that a label exists in the preferred vocabulary
-                    if ($vocab->getConceptLabel($uri, null) !== null) {
-                        return $vocab;
-                    } else {
-                        // not found in preferred vocabulary, fall back to next method
+                    try {
+                        // double check that a label exists in the preferred vocabulary
+                        if ($vocab->getConceptLabel($uri, null) !== null) {
+                            return $vocab;
+                        } else {
+                            // not found in preferred vocabulary, fall back to next method
+                            break;
+                        }
+                    } catch (EasyRdf\Http\Exception | EasyRdf\Exception | Throwable $e) {
+                        if ($this->getConfig()->getLogCaughtExceptions()) {
+                            error_log('Caught exception: ' . $e->getMessage());
+                        }
                         break;
                     }
                 }
@@ -483,8 +490,16 @@ private function disambiguateVocabulary($vocabs, $uri, $preferredVocabId = null)
 
         // no preferred vocabulary, or it was not found, search in which vocabulary the concept has a label
         foreach ($vocabs as $vocab) {
-            if ($vocab->getConceptLabel($uri, null) !== null)
-                return $vocab;
+            try {
+                if ($vocab->getConceptLabel($uri, null) !== null) {
+                    return $vocab;
+                }
+            } catch (EasyRdf\Http\Exception | EasyRdf\Exception | Throwable $e) {
+                if ($this->getConfig()->getLogCaughtExceptions()) {
+                    error_log('Caught exception: ' . $e->getMessage());
+                }
+                break;
+            }
         }
 
         // if the URI couldn't be found, fall back to the first vocabulary

diff --git a/model/Vocabulary.php b/model/Vocabulary.php
@@ -237,7 +237,7 @@ public function getConceptSchemes($lang = '')
         $conceptSchemes = null;
         try {
             $conceptSchemes = $this->getSparql()->queryConceptSchemes($lang);
-        } catch (EasyRdf\Http\Exception | EasyRdf\Exception | Exception | Throwable $e) {
+        } catch (EasyRdf\Http\Exception | EasyRdf\Exception | Throwable $e) {
              if ($this->model->getConfig()->getLogCaughtExceptions()) {
                  error_log('Caught exception: ' . $e->getMessage());
              }
@@ -435,7 +435,7 @@ public function getConceptInfo($uri, $clang)
         $conceptInfo = null;
         try {
             $conceptInfo = $sparql->queryConceptInfo($uri, $this->config->getArrayClassURI(), array($this), $clang);
-        } catch (EasyRdf\Http\Exception | EasyRdf\Exception | Exception | Throwable $e) {
+        } catch (EasyRdf\Http\Exception | EasyRdf\Exception | Throwable $e) {
              if ($this->model->getConfig()->getLogCaughtExceptions()) {
                  error_log('Caught exception: ' . $e->getMessage());
              }

diff --git a/resource/css/styles.css b/resource/css/styles.css
@@ -943,6 +943,21 @@ div#sidebar-grey > div > div > form.search-options {
   top: 10px;
 }
 
+.search-result-listing .alert .btn-default {
+  position: unset;
+  vertical-align: unset;
+  margin-left: 15px;
+  font-size: 18px;
+}
+
+.alert h4, .alert h3  {
+  display: inline;
+}
+
+.search-result-listing .alert-warning h4 {
+  display: block;
+}
+
 .search-options .mCSB_container > li > a > .radio {
   margin: 0;
   padding-left: 25px;

diff --git a/resource/js/docready.js b/resource/js/docready.js
@@ -835,7 +835,7 @@ $(function() { // DOCUMENT READY
       $('.search-result-listing').append($ready);
     }
     else {
-      $trigger.waypoint(function() { waypointCallback(); }, options);
+      $trigger.waypoint(function() { waypointCallback(this); }, options);
     }
   }
 
@@ -881,9 +881,13 @@ $(function() { // DOCUMENT READY
     changeOffset += 200;
   }
 
-  function waypointCallback() {
+  function waypointCallback(waypoint) {
+    if ($('.search-result-listing > p .spinner,.search-result-listing .alert-danger').length > 0) {
+      return false;
+    }
     var number_of_hits = $(".search-result").length;
-    if (number_of_hits < parseInt($('.search-count p').text().substr(0, $('.search-count p').text().indexOf(' ')), 10)) { $('.search-result-listing').append($loading);
+    if (number_of_hits < parseInt($('.search-count p').text().substr(0, $('.search-count p').text().indexOf(' ')), 10)) {
+      $('.search-result-listing').append($loading);
       var typeLimit = $('#type-limit').val();
       var schemeLimit = $('#scheme-limit').val();
       var groupLimit = $('#group-limit').val();
@@ -903,7 +907,20 @@ $(function() { // DOCUMENT READY
             $('.search-result-listing').append($ready);
             return false;
           }
-          $('.search-result:nth-last-of-type(4)').waypoint(function() { waypointCallback(); }, options );
+          waypoint.destroy();
+          $('.search-result:nth-last-of-type(4)').waypoint(function() { waypointCallback(this); }, options );
+        },
+        error: function(jqXHR, textStatus, errorThrown) {
+          $loading.detach();
+          var $failedSearch = $('<div class="alert alert-danger"><h4>Error: Loading for more items failed!</h4></div>');
+          var $retryButton = $('<button class="btn btn-default" type="button">Retry</button>');
+          $retryButton.on('click', function () {
+            $failedSearch.remove();
+            waypointCallback(waypoint);
+            return false;
+          });
+          $failedSearch.append($retryButton)
+          $('.search-result-listing').append($failedSearch);
         }
       });
     }

diff --git a/resource/js/scripts.js b/resource/js/scripts.js
@@ -157,7 +157,8 @@ function loadLimitedResults(parameters) {
   clearResultsAndAddSpinner();
   $.ajax({
     data: parameters,
-    success : function(data) {
+    complete : function(jqXHR, textStatus) {
+      var data = jqXHR.responseText;
       var response = $('.search-result-listing', data).html();
       if (window.history.pushState) { window.history.pushState({url: this.url}, '', this.url); }
       $('.search-result-listing').append(response);

diff --git a/view/headerbar.twig b/view/headerbar.twig
@@ -7,7 +7,7 @@
 <div class="header-float">
 {% if request.page != 'About' and request.page != 'Feedback' %}
 
-  {% if request.page != '' %}<div class="search-vocab-text"><p>{% trans "Content language" %}</p></div>{% endif %}
+  {% if request.page != '' and not global_search %}<div class="search-vocab-text"><p>{% trans "Content language" %}</p></div>{% endif %}
   {% if sorted_vocabs is defined %}
     <label class="sr-only" for="multiselect">{% trans "Search from vocabulary" %}</label>
     <select class="multiselect" id="multiselect" multiple="multiple">

diff --git a/view/search-result.twig b/view/search-result.twig
@@ -2,7 +2,15 @@
 <div class="search-count{% if limit_type or limit_parent or limit_group or limit_scheme %} search-limited{% endif %}"><p>{% trans %}{{ search_count }} results for '{{ term }}'{% endtrans %}{% if limit_type %}, {% trans "limited to type" %} '{% for type in limit_type %}{{ type }}{% if loop.last == false %}, {% endif %}{% endfor %}'{% endif %}{% if limit_parent %}, {% trans "limited to parent" %} '{{ limit_parent }}'{% endif %}{% if limit_group %}, {% trans "limited to group" %} '{{ limit_group }}'{% endif %}{% if limit_scheme %}, {% trans "limited to scheme" %} '{% for scheme in limit_scheme %}{{ scheme }}{% if loop.last == false %}, {% endif %}{% endfor %}'{% endif %}</p>
 </div>{% if limit_type or limit_parent or limit_group or limit_scheme %}<button type="button" class="btn btn-default" id="remove-limits">{% trans "Clear limitations" %}</button>{% endif %}
 {% endif %}
-{% if search_results is defined and search_results|length == 0 %}<p class="no-results">{% trans 'The search provided no results.' %}</p>{% endif %}
+{% if global_search and not search_failed and skipped_vocabs|length > 0 %}
+<div class="alert alert-warning">
+{% for voc in skipped_vocabs %}
+{% set vocTitle = voc.title %}
+<h4>{% trans %}Warning: Skipped searching from '{{vocTitle}}' vocabulary!{% endtrans %}</h4>
+{% endfor %}
+</div>
+{% endif %}
+{% if search_results is not null and search_results|length == 0 %}<p class="no-results">{% trans 'The search provided no results.' %}</p>{% endif %}
 {% for concept in search_results %} {# loop through the hits #}
 <div class="search-result">
   {% spaceless %}

diff --git a/view/vocab-search-listing.twig b/view/vocab-search-listing.twig
@@ -5,12 +5,12 @@
 {% block content %}
 <div class="search-result-listing">
   {% include 'search-result.twig' %}
-  {% if search_results is not defined and not global_search %}
+  {% if search_results is null %}
   <div class="alert alert-danger">
-    {% if request.vocabid == 'null' %}
+    {% if request.vocabid == 'null' and not global_search %}
     <h4>{% trans %}Error: Requested vocabulary not found!{% endtrans %}</h4>
     {% else %}
-    <h4>{% trans %}Error: Search failed for vocabulary!{% endtrans %}</h4>
+    <h4>{% trans %}Error: Search failed!{% endtrans %}</h4>
     {% endif %}
   </div>
   {% endif %}