Multi page selection in favorite list

config/vufind/config.ini

@@ -2441,6 +2441,15 @@ lists = enabled
 ; searches.ini, but used to control the page sizes of lists of favorites:
 lists_default_limit   = 20
 ;lists_limit_options   = 10,20,40,60,80,100
+; If multi page selection is activated one can select elements on one page in the favorite list
+; and the elements will stay selected when switching to another page.
+multi_page_favorites_selection = true
+; Choose which type of select_all checkbox should be shown in the favorite list.
+; on_page - selects all elements on the current page
+; global - selects all elements of the current list (only works if multi page selection is enabled)
+; both - shows on_page and global (only works if multi page selection is enabled)
+; none - disable select_all checkboxes
+checkbox_select_all_favorites_type = both
 ; This section controls what happens when a record title in a favorites list
 ; is clicked. VuFind can either embed the full result directly in the list using
 ; AJAX or can display it at its own separate URL as a full HTML page.

languages/de.ini

@@ -1221,6 +1221,7 @@ See also = "Siehe auch"
 see_all_ellipsis = "Alle anzeigen …"
 Select this record = "Datensatz auswählen"
 Select your carrier = "Wählen Sie Ihren Telefonanbieter aus"
+select_all = "Alle Einträge auswählen"
 select_all_on_page = "Alle Einträge der Seite auswählen"
 select_item = "Titel für weitere Aktion auswählen"
 select_item_checked_out_renew = "Titel zum Verlängern auswählen"

languages/en.ini

@@ -1241,6 +1241,7 @@ See also = "See also"
 see_all_ellipsis = "see all…"
 Select this record = "Select this record"
 Select your carrier = "Select your carrier"
+select_all = "Select all entries"
 select_all_on_page = "Select all entries on the page"
 select_item = "Select item for further action"
 select_item_checked_out_renew = "Select item for renewing"

module/VuFind/src/VuFind/Controller/CartController.php

@@ -31,6 +31,7 @@
 
 use Laminas\ServiceManager\ServiceLocatorInterface;
 use Laminas\Session\Container;
+use VuFind\Controller\Feature\ListItemSelectionTrait;
 use VuFind\Exception\Forbidden as ForbiddenException;
 use VuFind\Exception\Mail as MailException;
 
@@ -50,6 +51,7 @@
 class CartController extends AbstractBase
 {
     use Feature\BulkActionControllerTrait;
+    use ListItemSelectionTrait;
 
     /**
      * Session container
@@ -179,9 +181,7 @@ public function homeAction()
         $this->followup()->retrieveAndClear('cartAction');
         $this->followup()->retrieveAndClear('cartIds');
 
-        $ids = null === $this->params()->fromPost('selectAll')
-            ? $this->params()->fromPost('ids')
-            : $this->params()->fromPost('idsAll');
+        $ids = $this->getSelectedIds();
 
         // Add items if necessary:
         if (strlen($this->params()->fromPost('empty', '')) > 0) {
@@ -259,9 +259,7 @@ public function myresearchbulkAction()
     public function emailAction()
     {
         // Retrieve ID list:
-        $ids = null === $this->params()->fromPost('selectAll')
-            ? $this->params()->fromPost('ids', [])
-            : $this->params()->fromPost('idsAll', []);
+        $ids = $this->getSelectedIds();
 
         // Retrieve follow-up information if necessary:
         if (!is_array($ids) || empty($ids)) {
@@ -345,9 +343,7 @@ public function emailAction()
      */
     public function printcartAction()
     {
-        $ids = null === $this->params()->fromPost('selectAll')
-            ? $this->params()->fromPost('ids')
-            : $this->params()->fromPost('idsAll');
+        $ids = $this->getSelectedIds();
         if (!is_array($ids) || empty($ids)) {
             return $this->redirectToSource('error', 'bulk_noitems_advice');
         }
@@ -378,9 +374,7 @@ public function printcartAction()
     public function exportAction()
     {
         // Get the desired ID list:
-        $ids = null === $this->params()->fromPost('selectAll')
-            ? $this->params()->fromPost('ids', [])
-            : $this->params()->fromPost('idsAll', []);
+        $ids = $this->getSelectedIds();
 
         // Get export tools:
         $export = $this->export;
@@ -506,9 +500,7 @@ public function saveAction()
 
         // Load record information first (no need to prompt for login if we just
         // need to display a "no records" error message):
-        $ids = null === $this->params()->fromPost('selectAll')
-            ? $this->params()->fromPost('ids', $this->params()->fromQuery('ids', []))
-            : $this->params()->fromPost('idsAll', []);
+        $ids = $this->getSelectedIds();
         if (!is_array($ids) || empty($ids)) {
             $ids = $this->followup()->retrieveAndClear('cartIds') ?? [];
         }

module/VuFind/src/VuFind/Controller/Feature/ListItemSelectionTrait.php

@@ -0,0 +1,75 @@
+<?php
+
+/**
+ * List Item Selection
+ *
+ * PHP version 8
+ *
+ * Copyright (C) Hebis Verbundzentrale 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  Controller_Plugins
+ * @author   David Lahm <lahm@uni-frankfurt.de>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org Main Page
+ */
+
+namespace VuFind\Controller\Feature;
+
+use function in_array;
+
+/**
+ * List Item Selection
+ *
+ * @category VuFind
+ * @package  Controller_Plugins
+ * @author   David Lahm <lahm@uni-frankfurt.de>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org Main Page
+ */
+trait ListItemSelectionTrait
+{
+    /**
+     * Get selected ids
+     *
+     * @return array
+     */
+    protected function getSelectedIds()
+    {
+        // Values may be stored as a default state (checked_default), a list of IDs that do not
+        // match the default state (non_default_ids), and a list of all IDs (all_ids_global). If these
+        // values are found, we need to calculate the selected list from them.
+        $checkedDefault = $this->params()->fromPost('checked_default') !== null;
+        $nonDefaultIds = $this->params()->fromPost('non_default_ids');
+        $allIdsGlobal = $this->params()->fromPost('all_ids_global', '[]');
+        if ($nonDefaultIds !== null) {
+            $nonDefaultIds = json_decode($nonDefaultIds);
+            return array_values(array_filter(
+                json_decode($allIdsGlobal),
+                function ($id) use ($checkedDefault, $nonDefaultIds) {
+                    $nonDefaultId = in_array($id, $nonDefaultIds);
+                    return $checkedDefault xor $nonDefaultId;
+                }
+            ));
+        }
+        // If we got this far, values were passed in a simpler format: a list of checked IDs (ids),
+        // a list of all IDs on the current page (idsAll), and whether the whole page is
+        // selected (selectAll):
+        return null === $this->params()->fromPost('selectAll')
+            ? $this->params()->fromPost('ids', [])
+            : $this->params()->fromPost('idsAll', []);
+    }
+}

module/VuFind/src/VuFind/Controller/MyResearchController.php

@@ -34,6 +34,7 @@
 use Laminas\ServiceManager\ServiceLocatorInterface;
 use Laminas\Session\Container;
 use Laminas\View\Model\ViewModel;
+use VuFind\Controller\Feature\ListItemSelectionTrait;
 use VuFind\Exception\Auth as AuthException;
 use VuFind\Exception\AuthEmailNotVerified as AuthEmailNotVerifiedException;
 use VuFind\Exception\AuthInProgress as AuthInProgressException;
@@ -69,6 +70,7 @@ class MyResearchController extends AbstractBase
     use Feature\BulkActionControllerTrait;
     use Feature\CatchIlsExceptionsTrait;
     use \VuFind\ILS\Logic\SummaryTrait;
+    use ListItemSelectionTrait;
 
     /**
      * Configuration loader
@@ -853,9 +855,7 @@ public function deleteAction()
             : $this->url()->fromRoute('userList', ['id' => $listID]);
 
         // Fail if we have nothing to delete:
-        $ids = null === $this->params()->fromPost('selectAll')
-            ? $this->params()->fromPost('ids', [])
-            : $this->params()->fromPost('idsAll', []);
+        $ids = $this->getSelectedIds();
 
         $actionLimit = $this->getBulkActionLimit('delete');
         if (!is_array($ids) || empty($ids)) {

module/VuFind/src/VuFind/Search/Favorites/Results.php

@@ -89,6 +89,13 @@ class Results extends BaseResults implements AuthorizationServiceAwareInterface
      */
     protected $facets;
 
+    /**
+     * All ids
+     *
+     * @var array
+     */
+    protected $allIds;
+
     /**
      * Constructor
      *
@@ -207,6 +214,9 @@ protected function performSearch()
             $this->getParams()->getSort()
         );
         $this->resultTotal = count($rawResults);
+        $this->allIds = array_map(function ($result) {
+            return $result['source'] . '|' . $result['record_id'];
+        }, $rawResults->toArray());
 
         // Apply offset and limit if necessary!
         $limit = $this->getParams()->getLimit();
@@ -266,4 +276,14 @@ public function getListObject()
         }
         return $this->list;
     }
+
+    /**
+     * Get all ids.
+     *
+     * @return array
+     */
+    public function getAllIds()
+    {
+        return $this->allIds;
+    }
 }