Merge pull request #874 from michaelkubina/fix_collections

sebastian-meyer · web-flow · commit 532e6be118cf · 2023-02-02T12:46:14.000+01:00
[BUGFIX] Fix virtual and normal collections
diff --git a/Classes/Common/SolrSearch.php b/Classes/Common/SolrSearch.php
@@ -237,22 +237,35 @@ public function prepare()
                 . $fields['uid'] . ':' . $this->searchParams['documentId'];
         }
 
-        // if a collection is given, we prepare the collection query string
+        // if collections are given, we prepare the collection query string
         if ($this->collection) {
-            if ($this->collection instanceof Collection) {
-                $collectionsQueryString = '"' . $this->collection->getIndexName() . '"';
-            } else {
-                $collectionsQueryString = '';
-                foreach ($this->collection as $index => $collectionEntry) {
-                    $collectionsQueryString .= ($index > 0 ? ' OR ' : '') . '"' . $collectionEntry->getIndexName() . '"';
+            $collectionsQueryString = '';
+            $virtualCollectionsQueryString = '';
+            foreach ($this->collection as $collectionEntry) {
+                // check for virtual collections query string
+                if($collectionEntry->getIndexSearch()) {
+                    $virtualCollectionsQueryString .= empty($virtualCollectionsQueryString) ? '(' . $collectionEntry->getIndexSearch() . ')' : ' OR ('. $collectionEntry->getIndexSearch() . ')' ;
+                } else {
+                    $collectionsQueryString .= empty($collectionsQueryString) ? '"' . $collectionEntry->getIndexName() . '"' : ' OR "' . $collectionEntry->getIndexName() . '"';
+                }
+            }
+            
+            // distinguish between simple collection browsing and actual searching within the collection(s)
+            if(!empty($collectionsQueryString)) {
+                if(empty($query)) {
+                    $collectionsQueryString = '(collection_faceting:(' . $collectionsQueryString . ') AND toplevel:true AND partof:0)';
+                } else {
+                    $collectionsQueryString = '(collection_faceting:(' . $collectionsQueryString . '))';
                 }
             }
 
-            if (empty($query)) {
-                $params['filterquery'][]['query'] = 'toplevel:true';
-                $params['filterquery'][]['query'] = 'partof:0';
+            // virtual collections might query documents that are neither toplevel:true nor partof:0 and need to be searched separatly
+            if(!empty($virtualCollectionsQueryString)) {
+                $virtualCollectionsQueryString = '(' . $virtualCollectionsQueryString . ')';
             }
-            $params['filterquery'][]['query'] = 'collection_faceting:(' . $collectionsQueryString . ')';
+
+            // combine both querystrings into a single filterquery via OR if both are given, otherwise pass either of those
+            $params['filterquery'][]['query'] = implode(' OR ', array_filter([$collectionsQueryString, $virtualCollectionsQueryString]));
         }
 
         // Set some query parameters.
diff --git a/Classes/Controller/CollectionController.php b/Classes/Controller/CollectionController.php
@@ -100,7 +100,13 @@ public function listAction()
             } else {
                 $solr_query .= 'collection:("' . Solr::escapeQuery($collection->getIndexName()) . '")';
             }
-            $params['query'] = $solr_query . ' AND partof:0 AND toplevel:true';
+
+            // virtual collection might yield documents, that are not toplevel true or partof anything
+            if ($collection->getIndexSearch()) {
+                $params['query'] = $solr_query;
+            } else {
+                $params['query'] = $solr_query . ' AND partof:0 AND toplevel:true';
+            }
             $partOfNothing = $solr->search_raw($params);
 
             $params['query'] = $solr_query . ' AND NOT partof:0 AND toplevel:true';
diff --git a/Classes/Controller/ListViewController.php b/Classes/Controller/ListViewController.php
@@ -72,9 +72,12 @@ public function mainAction()
     {
         $this->searchParams = $this->getParametersSafely('searchParameter');
 
+        // extract collection(s) from collection parameter
         $collection = null;
-        if ($this->searchParams['collection'] && MathUtility::canBeInterpretedAsInteger($this->searchParams['collection'])) {
-            $collection = $this->collectionRepository->findByUid($this->searchParams['collection']);
+        if ($this->searchParams['collection']) {
+            foreach(explode(',', $this->searchParams['collection']) as $collectionEntry) {
+                $collection[] = $this->collectionRepository->findByUid($collectionEntry);
+            }
         }
 
         $widgetPage = $this->getParametersSafely('@widget_0');
diff --git a/Classes/Controller/SearchController.php b/Classes/Controller/SearchController.php
@@ -255,6 +255,46 @@ public function makeFacetsMenuArray($facets)
             }
         }
 
+        // if collections are given, we prepare the collection query string
+        // extract collections from collection parameter
+        $collection = null;
+        if ($this->searchParams['collection']) {
+            foreach(explode(',', $this->searchParams['collection']) as $collectionEntry) {
+                $collection[] = $this->collectionRepository->findByUid($collectionEntry);
+            }
+            
+        }
+        if ($collection) {
+            $collectionsQueryString = '';
+            $virtualCollectionsQueryString = '';
+            foreach ($collection as $collectionEntry) {
+                // check for virtual collections query string
+                if($collectionEntry->getIndexSearch()) {
+                    $virtualCollectionsQueryString .= empty($virtualCollectionsQueryString) ? '(' . $collectionEntry->getIndexSearch() . ')' : ' OR ('. $collectionEntry->getIndexSearch() . ')' ;
+                }
+                else {
+                    $collectionsQueryString .= empty($collectionsQueryString) ? '"' . $collectionEntry->getIndexName() . '"' : ' OR "' . $collectionEntry->getIndexName() . '"';
+                }
+            }
+            
+            // distinguish between simple collection browsing and actual searching within the collection(s)
+            if(!empty($collectionsQueryString)) {
+                if(empty($searchParams['query'])) {
+                    $collectionsQueryString = '(collection_faceting:(' . $collectionsQueryString . ') AND toplevel:true AND partof:0)';
+                } else {
+                    $collectionsQueryString = '(collection_faceting:(' . $collectionsQueryString . '))';
+                }
+            }
+
+            // virtual collections might query documents that are neither toplevel:true nor partof:0 and need to be searched separatly
+            if(!empty($virtualCollectionsQueryString)) {
+                $virtualCollectionsQueryString = '(' . $virtualCollectionsQueryString . ')';
+            }
+
+            // combine both querystrings into a single filterquery via OR if both are given, otherwise pass either of those
+            $search['params']['filterquery'][]['query'] = implode(" OR ", array_filter([$collectionsQueryString, $virtualCollectionsQueryString]));
+        }
+
         // add filter query for date search
         if (!empty($this->searchParams['dateFrom']) && !empty($this->searchParams['dateTo'])) {
             // combine dateFrom and dateTo into filterquery as range search
diff --git a/Resources/Private/Partials/ListView/SortingForm.html b/Resources/Private/Partials/ListView/SortingForm.html
@@ -54,7 +54,6 @@
 
                 </f:form.select>
                 <f:form.hidden property="collection" value="{lastSearch.collection}" />
-                <f:form.hidden property="collections" value="{settings.collections}" />
                 <f:form.hidden property="query" value="{lastSearch.query}" />
                 <f:form.hidden property="fulltext" value="{lastSearch.fulltext}" />
                 <f:if condition="{lastSearch.dateFrom} || {lastSearch.dateTo}">
diff --git a/Resources/Private/Templates/Search/Main.html b/Resources/Private/Templates/Search/Main.html
@@ -44,19 +44,20 @@
         <label for="tx-dlf-search-fulltext-yes-{viewData.uniqueId}"><f:translate key="search.inFulltext"/></label>
     </f:if>
 
+    <f:comment><!-- Add list of collections as parameter when configured in search plugin --></f:comment>
     <f:if condition="{settings.searchIn} == 'collection' || {settings.searchIn} == 'all'">
-        <f:form.hidden property="collections" value="{settings.collections}" />
+        <f:form.hidden property="collection" value="{settings.collections}" />
     </f:if>
 
     <f:if condition="{settings.searchIn} == 'document' || {settings.searchIn} == 'all'">
         <f:form.hidden property="documentId" value="{currentDocument.uid}" />
         <input type="hidden" name="tx_dlf[id]" value="{currentDocument.uid}" />
     </f:if>
 
-    <!-- Add current collection if using on collection single view -->
+    <f:comment><!-- Add current collection(s) if using on collection single view or collections-search --></f:comment>
     <f:if condition="{lastSearch.collection}">
         <f:then>
-            <input type="hidden" name="collection" value="{lastSearch.collection}" />
+            <f:form.hidden property="collection" value="{lastSearch.collection}" />
         </f:then>
     </f:if>
 
@@ -125,12 +126,12 @@
                                         <li class="tx-dlf-search-cur">
                                             <f:if condition="{lastSearch.dateFrom} || {lastSearch.dateTo}">
                                                 <f:then>
-                                                    <f:link.action title="{f:translate(key:'search.resetFacet', arguments:{0: '{values.title}'})}" additionalParams="{'tx_dlf_search[searchParameter][fq]':'{values.queryColumn}', 'tx_dlf_search[searchParameter][query]':'{lastSearch.query}',  'tx_dlf_search[searchParameter][fulltext]':'{lastSearch.fulltext}', 'tx_dlf_search[searchParameter][order]':'{lastSearch.order}', 'tx_dlf_search[searchParameter][orderBy]':'{lastSearch.orderBy}', 'tx_dlf_search[searchParameter][extQuery]':'{lastSearch.extQuery}', 'tx_dlf_search[searchParameter][extField]':'{lastSearch.extField}', 'tx_dlf_search[searchParameter][extOperator]':'{lastSearch.extField}', 'tx_dlf_search[searchParameter][dateFrom]':'{lastSearch.dateFrom}', 'tx_dlf_search[searchParameter][dateTo]':'{lastSearch.dateTo}'}">
+                                                    <f:link.action title="{f:translate(key:'search.resetFacet', arguments:{0: '{values.title}'})}" additionalParams="{'tx_dlf_search[searchParameter][fq]':'{values.queryColumn}', 'tx_dlf_search[searchParameter][query]':'{lastSearch.query}', 'tx_dlf_search[searchParameter][collection]':'{lastSearch.collection}', 'tx_dlf_search[searchParameter][fulltext]':'{lastSearch.fulltext}', 'tx_dlf_search[searchParameter][order]':'{lastSearch.order}', 'tx_dlf_search[searchParameter][orderBy]':'{lastSearch.orderBy}', 'tx_dlf_search[searchParameter][extQuery]':'{lastSearch.extQuery}', 'tx_dlf_search[searchParameter][extField]':'{lastSearch.extField}', 'tx_dlf_search[searchParameter][extOperator]':'{lastSearch.extField}', 'tx_dlf_search[searchParameter][dateFrom]':'{lastSearch.dateFrom}', 'tx_dlf_search[searchParameter][dateTo]':'{lastSearch.dateTo}'}">
                                                         {values.title} ({values.count})
                                                     </f:link.action>
                                                 </f:then>
                                                 <f:else>
-                                                    <f:link.action title="{f:translate(key:'search.resetFacet', arguments:{0: '{values.title}'})}" additionalParams="{'tx_dlf_search[searchParameter][fq]':'{values.queryColumn}', 'tx_dlf_search[searchParameter][query]':'{lastSearch.query}',  'tx_dlf_search[searchParameter][fulltext]':'{lastSearch.fulltext}', 'tx_dlf_search[searchParameter][order]':'{lastSearch.order}', 'tx_dlf_search[searchParameter][orderBy]':'{lastSearch.orderBy}', 'tx_dlf_search[searchParameter][extQuery]':'{lastSearch.extQuery}', 'tx_dlf_search[searchParameter][extField]':'{lastSearch.extField}', 'tx_dlf_search[searchParameter][extOperator]':'{lastSearch.extField}'}">
+                                                    <f:link.action title="{f:translate(key:'search.resetFacet', arguments:{0: '{values.title}'})}" additionalParams="{'tx_dlf_search[searchParameter][fq]':'{values.queryColumn}', 'tx_dlf_search[searchParameter][query]':'{lastSearch.query}', 'tx_dlf_search[searchParameter][collection]':'{lastSearch.collection}', 'tx_dlf_search[searchParameter][fulltext]':'{lastSearch.fulltext}', 'tx_dlf_search[searchParameter][order]':'{lastSearch.order}', 'tx_dlf_search[searchParameter][orderBy]':'{lastSearch.orderBy}', 'tx_dlf_search[searchParameter][extQuery]':'{lastSearch.extQuery}', 'tx_dlf_search[searchParameter][extField]':'{lastSearch.extField}', 'tx_dlf_search[searchParameter][extOperator]':'{lastSearch.extField}'}">
                                                         {values.title} ({values.count})
                                                     </f:link.action>
                                                 </f:else>
@@ -141,12 +142,12 @@
                                         <li class="tx-dlf-search-no">
                                             <f:if condition="{lastSearch.dateFrom} || {lastSearch.dateTo}">
                                                 <f:then>
-                                                    <f:link.action additionalParams="{'tx_dlf_search[searchParameter][fq]':'{values.queryColumn}', 'tx_dlf_search[searchParameter][query]':'{lastSearch.query}',  'tx_dlf_search[searchParameter][fulltext]':'{lastSearch.fulltext}', 'tx_dlf_search[searchParameter][order]':'{lastSearch.order}', 'tx_dlf_search[searchParameter][orderBy]':'{lastSearch.orderBy}', 'tx_dlf_search[searchParameter][extQuery]':'{lastSearch.extQuery}', 'tx_dlf_search[searchParameter][extField]':'{lastSearch.extField}', 'tx_dlf_search[searchParameter][extOperator]':'{lastSearch.extField}', 'tx_dlf_search[searchParameter][dateFrom]':'{lastSearch.dateFrom}', 'tx_dlf_search[searchParameter][dateTo]':'{lastSearch.dateTo}'}">
+                                                    <f:link.action additionalParams="{'tx_dlf_search[searchParameter][fq]':'{values.queryColumn}', 'tx_dlf_search[searchParameter][query]':'{lastSearch.query}', 'tx_dlf_search[searchParameter][collection]':'{lastSearch.collection}', 'tx_dlf_search[searchParameter][fulltext]':'{lastSearch.fulltext}', 'tx_dlf_search[searchParameter][order]':'{lastSearch.order}', 'tx_dlf_search[searchParameter][orderBy]':'{lastSearch.orderBy}', 'tx_dlf_search[searchParameter][extQuery]':'{lastSearch.extQuery}', 'tx_dlf_search[searchParameter][extField]':'{lastSearch.extField}', 'tx_dlf_search[searchParameter][extOperator]':'{lastSearch.extField}', 'tx_dlf_search[searchParameter][dateFrom]':'{lastSearch.dateFrom}', 'tx_dlf_search[searchParameter][dateTo]':'{lastSearch.dateTo}'}">
                                                         {values.title} ({values.count})
                                                     </f:link.action>
                                                 </f:then>
                                                 <f:else>
-                                                    <f:link.action additionalParams="{'tx_dlf_search[searchParameter][fq]':'{values.queryColumn}', 'tx_dlf_search[searchParameter][query]':'{lastSearch.query}',  'tx_dlf_search[searchParameter][fulltext]':'{lastSearch.fulltext}', 'tx_dlf_search[searchParameter][order]':'{lastSearch.order}', 'tx_dlf_search[searchParameter][orderBy]':'{lastSearch.orderBy}', 'tx_dlf_search[searchParameter][extQuery]':'{lastSearch.extQuery}', 'tx_dlf_search[searchParameter][extField]':'{lastSearch.extField}', 'tx_dlf_search[searchParameter][extOperator]':'{lastSearch.extField}'}">
+                                                    <f:link.action additionalParams="{'tx_dlf_search[searchParameter][fq]':'{values.queryColumn}', 'tx_dlf_search[searchParameter][query]':'{lastSearch.query}', 'tx_dlf_search[searchParameter][collection]':'{lastSearch.collection}', 'tx_dlf_search[searchParameter][fulltext]':'{lastSearch.fulltext}', 'tx_dlf_search[searchParameter][order]':'{lastSearch.order}', 'tx_dlf_search[searchParameter][orderBy]':'{lastSearch.orderBy}', 'tx_dlf_search[searchParameter][extQuery]':'{lastSearch.extQuery}', 'tx_dlf_search[searchParameter][extField]':'{lastSearch.extField}', 'tx_dlf_search[searchParameter][extOperator]':'{lastSearch.extField}'}">
                                                         {values.title} ({values.count})
                                                     </f:link.action>
                                                 </f:else>

Original file line number	Diff line number	Diff line change
`@@ -72,9 +72,12 @@ public function mainAction()`
`72`	`72`	`{`
`73`	`73`	`$this->searchParams = $this->getParametersSafely('searchParameter');`
`74`	`74`
	`75`	`+ // extract collection(s) from collection parameter`
`75`	`76`	`$collection = null;`
`76`		`- if ($this->searchParams['collection'] && MathUtility::canBeInterpretedAsInteger($this->searchParams['collection'])) {`
`77`		`- $collection = $this->collectionRepository->findByUid($this->searchParams['collection']);`
	`77`	`+ if ($this->searchParams['collection']) {`
	`78`	`+ foreach(explode(',', $this->searchParams['collection']) as $collectionEntry) {`
	`79`	`+ $collection[] = $this->collectionRepository->findByUid($collectionEntry);`
	`80`	`+ }`
`78`	`81`	`}`
`79`	`82`
`80`	`83`	`$widgetPage = $this->getParametersSafely('@widget_0');`