VUFIND-1210: Use Solr JSON APIs

config/vufind/searches.ini

@@ -138,9 +138,10 @@ always_display_reset_filters = false
 ; caveats described at
 ; https://opensourceconnections.com/blog/2018/02/20/edismax-and-multiterm-synonyms-oddities/
 ;
-; Parameters are entered as query parameters and they can be repeated like in Solr's
-; query string syntax:
-; default_parameters[search] = "fq=field%3A%2Fmatch%2F&fq=another%3A2"
+; Parameters are entered as a JSON object according to Solr's JSON Request API.
+; See https://solr.apache.org/guide/solr/latest/query-guide/json-request-api.html
+; Parameters with multiple values can be entered using an array like:
+; default_parameters[search] = '{ "filter": ["format:DVD", "author:Smith"] }'
 ;
 ; Parameters can be defined for the following search contexts:
 ; *                 All contexts not otherwise defined here
@@ -150,8 +151,8 @@ always_display_reset_filters = false
 ; terms             Return terms
 ; alphabeticBrowse  Return information from the browse index
 ; workExpressions   Return work expressions (record versions)
-;default_parameters[*] = "echoParams=none&debugQuery=false"
-;default_parameters[search] = "sow=false"
+;default_parameters[*] = '{ "params": { "echoParams": "none", "debugQuery": true } }'
+;default_parameters[search] = '{ "params": { "sow": false } }'
 
 ; If you set this setting, VuFind will use a secondary Solr field to try to find
 ; previous record IDs when primary ID lookups fail. If you leave the setting

module/VuFind/src/VuFind/Hierarchy/TreeDataSource/Solr.php

@@ -31,7 +31,7 @@
 
 use VuFind\Hierarchy\TreeDataFormatter\PluginManager as FormatterManager;
 use VuFindSearch\Backend\Solr\Command\RawJsonSearchCommand;
-use VuFindSearch\ParamBag;
+use VuFindSearch\ParamBagBag;
 use VuFindSearch\Query\Query;
 use VuFindSearch\Service;
 
@@ -152,12 +152,14 @@ public function getXML($id, $options = [])
     protected function getDefaultSearchParams(): array
     {
         return [
-            'fq' => $this->filters,
-            'hl' => ['false'],
-            'fl' => ['title,id,hierarchy_parent_id,hierarchy_top_id,'
+            'filter' => $this->filters,
+            'fields' => ['title,id,hierarchy_parent_id,hierarchy_top_id,'
                 . 'is_hierarchy_id,hierarchy_sequence,title_in_hierarchy'],
-            'wt' => ['json'],
-            'json.nl' => ['arrarr'],
+            'params' => [
+                'hl' => ['false'],
+                'wt' => ['json'],
+                'json.nl' => ['arrarr'],
+            ],
         ];
     }
 
@@ -172,7 +174,7 @@ protected function getDefaultSearchParams(): array
      */
     protected function searchSolrLegacy(Query $query, $rows): array
     {
-        $params = new ParamBag($this->getDefaultSearchParams());
+        $params = ParamBagBag::fromArray($this->getDefaultSearchParams());
         $command = new RawJsonSearchCommand(
             $this->backendId,
             $query,
@@ -198,14 +200,16 @@ protected function searchSolrCursor(Query $query, $rows): array
         $cursorMark = '*';
         $records = [];
         while ($cursorMark !== $prevCursorMark) {
-            $params = new ParamBag(
+            $params = ParamBagBag::fromArray(
                 $this->getDefaultSearchParams() + [
                     // Sort is required
                     'sort' => ['id asc'],
-                    // Override any default timeAllowed since it cannot be used with
-                    // cursorMark
-                    'timeAllowed' => -1,
-                    'cursorMark' => $cursorMark,
+                    'params' => [
+                        // Override any default timeAllowed since it cannot be used with
+                        // cursorMark
+                        'timeAllowed' => -1,
+                        'cursorMark' => $cursorMark,
+                    ],
                 ]
             );
             $command = new RawJsonSearchCommand(

module/VuFind/src/VuFind/RecordDriver/SolrDefault.php

@@ -33,6 +33,8 @@
 namespace VuFind\RecordDriver;
 
 use VuFindSearch\Command\SearchCommand;
+use VuFindSearch\ParamBag;
+use VuFindSearch\ParamBagBag;
 
 use function count;
 use function in_array;
@@ -317,7 +319,7 @@ public function getChildRecordCount()
             'hierarchy_parent_id:"' . $safeId . '"'
         );
         // Disable highlighting for efficiency; not needed here:
-        $params = new \VuFindSearch\ParamBag(['hl' => ['false']]);
+        $params = new ParamBagBag(['params' => new ParamBag(['hl' => ['false']])]);
         $command = new SearchCommand($this->sourceIdentifier, $query, 0, 0, $params);
         return $this->searchService
             ->invoke($command)->getResult()->getTotal();

module/VuFind/src/VuFind/Search/Factory/AbstractSolrBackendFactory.php

@@ -494,16 +494,16 @@ protected function createConnector()
         $handlers = [
             'select' => [
                 'fallback' => true,
-                'defaults' => ['fl' => $defaultFields],
-                'appends'  => ['fq' => []],
+                'defaults' => ['fields' => $defaultFields],
+                'appends'  => ['filter' => []],
             ],
             'terms' => [
                 'functions' => ['terms'],
             ],
         ];
 
         foreach ($this->getHiddenFilters() as $filter) {
-            array_push($handlers['select']['appends']['fq'], $filter);
+            array_push($handlers['select']['appends']['filter'], $filter);
         }
 
         $connector = new $this->connectorClass(

module/VuFind/src/VuFind/Search/Params/FacetLimitTrait.php

@@ -77,10 +77,10 @@ trait FacetLimitTrait
     protected function initFacetLimitsFromConfig(?Config $config = null)
     {
         if (is_numeric($config->facet_limit ?? null)) {
-            $this->setFacetLimit($config->facet_limit);
+            $this->setFacetLimit((int)($config->facet_limit));
         }
         foreach ($config->facet_limit_by_field ?? [] as $k => $v) {
-            $this->facetLimitByField[$k] = $v;
+            $this->facetLimitByField[$k] = (int)$v;
         }
     }
 
@@ -91,7 +91,7 @@ protected function initFacetLimitsFromConfig(?Config $config = null)
      *
      * @return void
      */
-    public function setFacetLimit($l)
+    public function setFacetLimit(int $l): void
     {
         $this->facetLimit = $l;
     }
@@ -125,7 +125,7 @@ public function getHierarchicalFacetLimit()
      *
      * @return void
      */
-    public function setHierarchicalFacetLimit($limit)
+    public function setHierarchicalFacetLimit(int $limit)
     {
         $this->hierarchicalFacetLimit = $limit;
     }

module/VuFind/src/VuFind/Search/Solr/CustomFilterListener.php

@@ -74,7 +74,7 @@ class CustomFilterListener
      *
      * @var string
      */
-    protected $filterParam = 'fq';
+    protected $filterParam = 'filter';
 
     /**
      * Constructor.

module/VuFind/src/VuFind/Search/Solr/DeduplicationListener.php

@@ -154,15 +154,15 @@ public function onSearchPre(EventInterface $event)
                     $this->enabled && 'getids' !== $context
                     && !$this->hasChildFilter($params)
                 ) {
-                    $fq = '-merged_child_boolean:true';
+                    $filter = '-merged_child_boolean:true';
                     if ($context == 'similar' && $id = $event->getParam('id')) {
-                        $fq .= ' AND -local_ids_str_mv:"'
+                        $filter .= ' AND -local_ids_str_mv:"'
                             . addcslashes($id, '"') . '"';
                     }
                 } else {
-                    $fq = '-merged_boolean:true';
+                    $filter = '-merged_boolean:true';
                 }
-                $params->add('fq', $fq);
+                $params->add('filter', $filter);
             }
         }
         return $event;
@@ -177,7 +177,7 @@ public function onSearchPre(EventInterface $event)
      */
     public function hasChildFilter($params)
     {
-        $filters = $params->get('fq');
+        $filters = $params->get('filter');
         return $filters != null && in_array('merged_child_boolean:true', $filters);
     }
 

module/VuFind/src/VuFind/Search/Solr/DefaultParametersListener.php

@@ -29,9 +29,11 @@
 
 namespace VuFind\Search\Solr;
 
+use JsonException;
 use Laminas\EventManager\EventInterface;
 use Laminas\EventManager\SharedEventManagerInterface;
 use VuFindSearch\Backend\Solr\Backend;
+use VuFindSearch\ParamBagBag;
 use VuFindSearch\Service;
 
 /**
@@ -119,16 +121,21 @@ public function onSearchPre(EventInterface $event): EventInterface
                 $context = null;
             }
             $context = $this->contextMap[$context] ?? $context;
-            $defaultParams = $this->defaultParams[$context]
+            $defaultParamsText = $this->defaultParams[$context]
                 ?? $this->defaultParams['*']
                 ?? '';
-            if ($defaultParams && $params = $command->getSearchParameters()) {
-                foreach (explode('&', $defaultParams) as $keyVal) {
-                    $parts = explode('=', $keyVal, 2);
-                    if (!isset($parts[1])) {
-                        continue;
-                    }
-                    $params->add(urldecode($parts[0]), urldecode($parts[1]));
+            if ($defaultParamsText && $params = ParamBagBag::from($command->getSearchParameters())) {
+                $command->setSearchParameters($params);
+                try {
+                    $defaultParams = json_decode($defaultParamsText, true, flags: JSON_THROW_ON_ERROR);
+                } catch (JsonException $e) {
+                    throw new \Exception(
+                        'Default parameters must be expressed in JSON, using Solr\'s JSON Request API '
+                        . '(starting in VuFind 12)'
+                    );
+                }
+                foreach ($defaultParams as $name => $param) {
+                    $params->addMultiNested($name, $param);
                 }
             }
         }

module/VuFind/src/VuFind/Search/Solr/Explanation.php

@@ -32,6 +32,7 @@
 
 use VuFindSearch\Backend\Solr\Command\RawJsonSearchCommand;
 use VuFindSearch\ParamBag;
+use VuFindSearch\ParamBagBag;
 
 use function count;
 use function floatval;
@@ -249,13 +250,16 @@ public function performRequest($recordId)
 
         // prepare search params
         $params = $this->getParams()->getBackendParameters();
-        $params->set('spellcheck', 'false');
-        $explainParams = new ParamBag([
-            'fl' => 'id,score',
-            'debug' => 'true',
-            'indent' => 'true',
-            'echoParams' => 'all',
-            'explainOther' => 'id:"' . addcslashes($recordId, '"') . '"',
+        $params = ParamBagBag::from($params);
+        $params->setNested('params', 'spellcheck', 'false');
+        $explainParams = new ParamBagBag([
+            'fields' => 'id,score',
+            'params' => new ParamBag([
+                'debug' => 'true',
+                'indent' => 'true',
+                'echoParams' => 'all',
+                'explainOther' => 'id:"' . addcslashes($recordId, '"') . '"',
+            ]),
         ]);
         $params->mergeWith($explainParams);
 

module/VuFind/src/VuFind/Search/Solr/FilterFieldConversionListener.php

@@ -91,22 +91,22 @@ public function attach(SharedEventManagerInterface $manager)
     public function onSearchPre(EventInterface $event)
     {
         $params = $event->getParam('command')->getSearchParameters();
-        $fq = $params->get('fq');
-        if (is_array($fq) && !empty($fq)) {
+        $filters = $params->get('filter');
+        if (is_array($filters) && !empty($filters)) {
             // regex lookahead to ignore strings inside quotes:
             $lookahead = '(?=(?:[^\"]*+\"[^\"]*+\")*+[^\"]*+$)';
-            $new_fq = [];
-            foreach ($fq as $currentFilter) {
+            $new_filters = [];
+            foreach ($filters as $currentFilter) {
                 foreach ($this->map as $oldField => $newField) {
                     $currentFilter = preg_replace(
                         "/\b$oldField:$lookahead/",
                         "$newField:",
                         $currentFilter
                     );
                 }
-                $new_fq[] = $currentFilter;
+                $new_filters[] = $currentFilter;
             }
-            $params->set('fq', $new_fq);
+            $params->set('filter', $new_filters);
         }
 
         return $event;

module/VuFind/src/VuFind/Search/Solr/InjectConditionalFilterListener.php

@@ -147,12 +147,12 @@ public function onSearchPre(EventInterface $event)
         }
 
         $params = $command->getSearchParameters();
-        $fq = $params->get('fq');
-        if (!is_array($fq)) {
-            $fq = [];
+        $filters = $params->get('filter');
+        if (!is_array($filters)) {
+            $filters = [];
         }
-        $new_fq = array_merge($fq, $this->filterList);
-        $params->set('fq', $new_fq);
+        $new_filters = array_merge($filters, $this->filterList);
+        $params->set('filters', $new_filters);
 
         return $event;
     }

module/VuFind/src/VuFind/Search/Solr/InjectHighlightingListener.php

@@ -32,6 +32,7 @@
 use Laminas\EventManager\EventInterface;
 use Laminas\EventManager\SharedEventManagerInterface;
 use VuFindSearch\Backend\BackendInterface;
+use VuFindSearch\ParamBagBag;
 use VuFindSearch\Service;
 
 /**
@@ -120,18 +121,19 @@ public function onSearchPre(EventInterface $event)
         }
         if ($command->getTargetIdentifier() === $this->backend->getIdentifier()) {
             if ($params = $command->getSearchParameters()) {
+                $params = ParamBagBag::from($params);
                 // Set highlighting parameters unless explicitly disabled:
-                $hl = $params->get('hl');
+                $hl = $params->getNested('params', 'hl');
                 if (($hl[0] ?? 'true') != 'false') {
                     $this->active = true;
                     // Set extra parameters first so they don't override necessary
                     // core parameters:
                     foreach ($this->extraHighlightingParameters as $key => $val) {
                         $params->set($key, $val);
                     }
-                    $params->set('hl', 'true');
-                    $params->set('hl.simple.pre', '{{{{START_HILITE}}}}');
-                    $params->set('hl.simple.post', '{{{{END_HILITE}}}}');
+                    $params->setNested('params', 'hl', 'true');
+                    $params->setNested('params', 'hl.simple.pre', '{{{{START_HILITE}}}}');
+                    $params->setNested('params', 'hl.simple.post', '{{{{END_HILITE}}}}');
 
                     // Turn on hl.q generation in query builder:
                     $this->backend->getQueryBuilder()