Back to browse results feature

languages/en.ini

@@ -111,6 +111,7 @@ Available Functionality = "Available Functionality"
 Awards = "Awards"
 Back to Record = "Back to Record"
 Back to Search Results = "Back to Search Results"
+back_to_browse_by = "Back to Browse %%field%%"
 Backtrace = "Backtrace"
 Bag = "Bag"
 Balance = "Balance"

languages/fr.ini

@@ -111,6 +111,7 @@ Available Functionality = "Fonctions disponibles"
 Awards = "Récompenses"
 Back to Record = "Retourner à la notice"
 Back to Search Results = "Retourner aux résultats de recherche"
+back_to_browse_by = "Retour à la recherche %%field%%"
 Backtrace = "Historique"
 Bag = "Panier"
 Balance = "Solde du compte"

module/VuFind/config/module.config.php

@@ -506,6 +506,7 @@
             'VuFind\Search\Params\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
             'VuFind\Search\Results\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
             'VuFind\Search\SearchNormalizer' => 'VuFind\Search\SearchNormalizerFactory',
+            \VuFind\Search\SearchOrigin\SearchOriginFactory::class => \Laminas\ServiceManager\Factory\InvokableFactory::class,
             'VuFind\Search\SearchRunner' => 'VuFind\Search\SearchRunnerFactory',
             'VuFind\Search\SearchTabsHelper' => 'VuFind\Search\SearchTabsHelperFactory',
             'VuFind\Search\Solr\HierarchicalFacetHelper' => 'VuFind\Search\Solr\HierarchicalFacetHelperFactory',

module/VuFind/src/VuFind/Controller/AbstractRecord.php

@@ -37,6 +37,7 @@
 use VuFind\Ratings\RatingsService;
 use VuFind\Record\ResourcePopulator;
 use VuFind\RecordDriver\AbstractBase as AbstractRecordDriver;
+use VuFind\Search\SearchOrigin\SearchOriginFactory;
 use VuFind\Tags\TagsService;
 use VuFindSearch\ParamBag;
 
@@ -955,9 +956,9 @@ protected function showTab($tab, $ajax = false)
         $view->defaultTab = strtolower($this->getDefaultTab());
         $view->backgroundTabs = $this->getBackgroundTabs();
         $view->tabsExtraScripts = $this->getTabsExtraScripts($view->tabs);
-        $view->loadInitialTabWithAjax
-            = isset($config->Site->loadInitialTabWithAjax)
-            ? (bool)$config->Site->loadInitialTabWithAjax : false;
+        $view->loadInitialTabWithAjax = (bool)($config->Site->loadInitialTabWithAjax ?? false);
+        $factory = $this->getService(SearchOriginFactory::class);
+        $this->layout()->setVariable('searchOrigin', $factory->createObject($this->params()->fromQuery()));
 
         // Set up next/previous record links (if appropriate)
         if ($this->resultScrollerActive()) {

module/VuFind/src/VuFind/Controller/AbstractSearch.php

@@ -37,7 +37,10 @@
 use Laminas\View\Model\ViewModel;
 use VuFind\Db\Entity\SearchEntityInterface;
 use VuFind\Db\Service\SearchServiceInterface;
+use VuFind\Search\Base\Results;
 use VuFind\Search\RecommendListener;
+use VuFind\Search\SearchOrigin\AbstractSearchOrigin;
+use VuFind\Search\SearchOrigin\SearchOriginFactory;
 use VuFind\Solr\Utils as SolrUtils;
 
 use function count;
@@ -393,6 +396,8 @@ protected function getSearchResultsView($setupCallback = null)
             $queryParams['page'] = $lastPage;
             return $this->redirect()->toRoute('search-results', [], [ 'query' => $queryParams ]);
         }
+        $factory = $this->getService(SearchOriginFactory::class);
+        $searchOrigin = $factory->createObject($this->params()->fromQuery());
 
         // If we received an EmptySet back, that indicates that the real search
         // failed due to some kind of syntax error, and we should display a
@@ -402,7 +407,7 @@ protected function getSearchResultsView($setupCallback = null)
             $view->parseError = true;
         } else {
             // If a "jumpto" parameter is set, deal with that now:
-            if ($jump = $this->processJumpTo($results)) {
+            if ($jump = $this->processJumpTo($results, $searchOrigin)) {
                 return $jump;
             }
 
@@ -415,7 +420,7 @@ protected function getSearchResultsView($setupCallback = null)
             }
 
             // Jump to only result, if configured:
-            if ($jump = $this->processJumpToOnlyResult($results)) {
+            if ($jump = $this->processJumpToOnlyResult($results, $searchOrigin)) {
                 return $jump;
             }
 
@@ -428,6 +433,8 @@ protected function getSearchResultsView($setupCallback = null)
                 $this->flashMessenger()->addErrorMessage($error);
             }
         }
+        // For the header link
+        $this->layout()->setVariable('searchOrigin', $searchOrigin);
 
         // Special case: If we're in RSS view, we need to render differently:
         if (isset($view->params) && $view->params->getView() == 'rss') {
@@ -444,11 +451,12 @@ protected function getSearchResultsView($setupCallback = null)
      * Process the jumpto parameter -- either redirect to a specific record and
      * return view model, or ignore the parameter and return false.
      *
-     * @param \VuFind\Search\Base\Results $results Search results object.
+     * @param Results                   $results      Search results object.
+     * @param AbstractSearchOrigin|null $searchOrigin Search origin to propagate
      *
      * @return bool|HttpResponse
      */
-    protected function processJumpTo($results)
+    protected function processJumpTo($results, ?AbstractSearchOrigin $searchOrigin = null)
     {
         // Missing/invalid parameter?  Ignore it:
         $jumpto = $this->params()->fromQuery('jumpto');
@@ -457,18 +465,20 @@ protected function processJumpTo($results)
         }
 
         $recordList = $results->getResults();
+        $queryParams = $searchOrigin?->getSearchUrlParamsArray() ?? [];
         return isset($recordList[$jumpto - 1])
-            ? $this->getRedirectForRecord($recordList[$jumpto - 1]) : false;
+            ? $this->getRedirectForRecord($recordList[$jumpto - 1], $queryParams) : false;
     }
 
     /**
      * Process jump to record if there is only one result.
      *
-     * @param \VuFind\Search\Base\Results $results Search results object.
+     * @param Results                   $results      Search results object.
+     * @param AbstractSearchOrigin|null $searchOrigin Search origin to propagate
      *
      * @return bool|HttpResponse
      */
-    protected function processJumpToOnlyResult($results)
+    protected function processJumpToOnlyResult($results, ?AbstractSearchOrigin $searchOrigin = null)
     {
         // If jumpto is explicitly disabled (set to false, e.g. by combined search),
         // we should NEVER jump to a result regardless of other factors.
@@ -479,10 +489,9 @@ protected function processJumpToOnlyResult($results)
             && $results->getResultTotal() == 1
             && $recordList = $results->getResults()
         ) {
-            return $this->getRedirectForRecord(
-                reset($recordList),
-                ['sid' => $results->getSearchId()]
-            );
+            $queryParams = $searchOrigin?->getSearchUrlParamsArray() ?? [];
+            $queryParams['sid'] = $results->getSearchId();
+            return $this->getRedirectForRecord(reset($recordList), $queryParams);
         }
 
         return false;

module/VuFind/src/VuFind/Controller/AlphabrowseController.php

@@ -30,9 +30,11 @@
 
 namespace VuFind\Controller;
 
+use Exception;
 use Laminas\Config\Config;
 use Laminas\View\Model\ViewModel;
 use VuFind\Exception\BadRequest;
+use VuFind\Search\SearchOrigin\AlphaBrowseSearchOrigin;
 use VuFindSearch\ParamBag;
 
 use function in_array;
@@ -236,6 +238,16 @@ public function homeAction(): ViewModel
         $source = $this->params()->fromQuery('source', false);
         $from   = $this->params()->fromQuery('from', false);
         $page   = intval($this->params()->fromQuery('page', 0));
+        try {
+            $origin = new AlphaBrowseSearchOrigin(
+                $this->getTypes($config)[$source] ?? null,
+                $source,
+                $from,
+                $page ?: null
+            );
+        } catch (Exception) {
+            $origin = null;
+        }
 
         // Load highlighting configuration while accounting for special case:
         // highlighting is pointless if there's no user input:
@@ -252,6 +264,7 @@ public function homeAction(): ViewModel
                 'from' => $from,
                 'source' => $source,
                 'extras' => array_filter(explode(':', $extras[$source] ?? '')),
+                'origin' => $origin,
             ]
         );
 

module/VuFind/src/VuFind/Controller/WebController.php

@@ -30,6 +30,7 @@
 namespace VuFind\Controller;
 
 use Laminas\ServiceManager\ServiceLocatorInterface;
+use VuFind\Search\SearchOrigin\AbstractSearchOrigin;
 
 /**
  * Web Controller
@@ -57,11 +58,12 @@ public function __construct(ServiceLocatorInterface $sm)
      * Process the jumpto parameter -- either redirect to a specific record and
      * return view model, or ignore the parameter and return false.
      *
-     * @param \VuFind\Search\Base\Results $results Search results object.
+     * @param \VuFind\Search\Base\Results $results      Search results object.
+     * @param AbstractSearchOrigin|null   $searchOrigin Search origin to propagate
      *
      * @return mixed
      */
-    protected function processJumpTo($results)
+    protected function processJumpTo($results, ?AbstractSearchOrigin $searchOrigin = null)
     {
         // Missing/invalid parameter?  Ignore it:
         $jumpto = $this->params()->fromQuery('jumpto');

module/VuFind/src/VuFind/Search/SearchOrigin/AbstractSearchOrigin.php

@@ -0,0 +1,91 @@
+<?php
+
+/**
+ * Search Origin Object
+ *
+ * PHP version 8
+ *
+ * Copyright (C) Michigan State University 2024.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * @category VuFind
+ * @package  Search
+ * @author   Robby ROUDON <roudonro@msu.edu>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org Main Page
+ */
+
+namespace VuFind\Search\SearchOrigin;
+
+/**
+ * Abstract object for any search origin
+ *
+ * @category VuFind
+ * @package  Search
+ * @author   Robby ROUDON <roudonro@msu.edu>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org Main Page
+ */
+abstract class AbstractSearchOrigin
+{
+    /**
+     * Name of the URL parameter containing the value of the search origin
+     *
+     * @var string
+     */
+    public const PARAM_NAME = 'origin';
+
+    /**
+     * Get origin name
+     *
+     * @return string
+     */
+    abstract public static function getName(): string;
+
+    /**
+     * Get array of parameters to put in the search URL
+     *
+     * @return array
+     */
+    abstract public function getSearchUrlParamsArray(): array;
+
+    /**
+     * Get array of parameters to recreate the origin in the URL
+     *
+     * @return array
+     */
+    abstract public function getOriginUrlParamsArray(): array;
+
+    /**
+     * Get route name to generate the url
+     *
+     * @return string
+     */
+    abstract public function getRouteName(): string;
+
+    /**
+     * Get translation label
+     *
+     * @return string
+     */
+    abstract public function getLinkTranslationKey(): string;
+
+    /**
+     * Get translation label for breadcrumbs
+     *
+     * @return string
+     */
+    abstract public function getBreadcrumbsTranslationKey(): string;
+}