[FINNA-2767] Initial implementation of disec support for reservation lists

local/config/finna/ReservationList.yaml.sample

@@ -9,8 +9,13 @@
 # List can contain same information as under institution information to be more specific
 # about where the order is being delivered
 # LibraryCardSources is used to check for active connection to ILS to be able to use lists
-# Connection holds information about type of lists, currently only value supported is type: Database
-# and is the default value, if omitted
+# Connection holds information about type of lists:
+# Database: Default connection, orders handled with sending forms
+#   handler: email [Optional] Default handler email, other values found in FeedbackForms.yaml primary handlers
+# Disec:
+#   base_url: Api base url
+#   secret:   Api specific secret
+#   use_cat_id: [Optional] Use catalog id for user instead of firstName, lastName, email. Default false.
 #
 # Each list declared uses their own translation keys under translation domain ReservationList::
 #

local/languages/finna/ReservationList/en-gb.ini

@@ -28,3 +28,15 @@ Reservation List Name = "Reservation lists name"
 Send Reservation Request = "Send reservation request"
 select_desired_contact_method = "Select desired contact method"
 Select = "Select"
+
+; List statuses:
+status_unknown = ""
+status_in_process = "In process"
+status_handled = "Handled"
+status_delivered = "Delivered"
+status_cancelled = "Canceled"
+status_replied = "Replied"
+status_removed_item = "Item removed"
+status_loaned = "Loaned"
+status_returned = "Returned"
+status_renewed = "Renewed"

local/languages/finna/ReservationList/fi.ini

@@ -28,3 +28,15 @@ Reservation List Name = "Varauslistan nimi"
 Send Reservation Request = "Lähetä varauspyyntö"
 select_desired_contact_method = "Valitse haluamasi yhteydenottotapa"
 Select = "Valitse"
+
+; List statuses:
+status_unknown = ""
+status_in_process = "Käsittelyssä"
+status_handled = "Käsitelty"
+status_delivered = "Toimitettu"
+status_cancelled = "Peruutettu"
+status_replied = "Vastattu"
+status_removed_item = "Aineisto poistettu"
+status_loaned = "Lainattu"
+status_returned = "Palautettu"
+status_renewed = "Uusittu"

local/languages/finna/ReservationList/se.ini

@@ -28,3 +28,15 @@ Reservation List Name = ""
 Send Reservation Request = ""
 select_desired_contact_method = ""
 Select = ""
+
+; List statuses:
+status_unknown = ""
+status_in_process = ""
+status_handled = ""
+status_delivered = ""
+status_cancelled = ""
+status_replied = ""
+status_removed_item = ""
+status_loaned = ""
+status_returned = ""
+status_renewed = ""

local/languages/finna/ReservationList/sv.ini

@@ -28,3 +28,15 @@ Reservation List Name = "Namn för bokningslista"
 Send Reservation Request = "Skicka bokningsförfrågan"
 select_desired_contact_method = "Välj önskad kontaktmetod"
 Select = "Välj"
+
+; List statuses:
+status_unknown = ""
+status_in_process = "Behandlas"
+status_handled = "Behandlade"
+status_delivered = "Levererad"
+status_cancelled = "Annulerad"
+status_replied = "Besvarad"
+status_removed_item = "Objekt borttaget"
+status_loaned = "Lånad"
+status_returned = "Returnerad"
+status_renewed = "Förnyad"

module/Finna/config/module.config.php

@@ -381,6 +381,7 @@
             'Finna\Statistics\Driver\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
             'Finna\Statistics\EventHandler' => 'Finna\Statistics\EventHandlerFactory',
             \Finna\ReservationList\ReservationListService::class => \Finna\ReservationList\ReservationListServiceFactory::class,
+            \Finna\ReservationList\PluginManager::class => \VuFind\ServiceManager\AbstractPluginManagerFactory::class,
             'Finna\Favorites\FavoritesService' => 'Finna\Favorites\FavoritesServiceFactory',
             'Finna\View\CustomElement\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
             'Finna\Video\Handler\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
@@ -491,6 +492,8 @@
                         'Finna\AjaxHandler\GetUserListFactory',
                     'Finna\AjaxHandler\GetUserLists' =>
                         'Finna\AjaxHandler\GetUserListsFactory',
+                    'Finna\AjaxHandler\ReservationList' =>
+                        'Finna\AjaxHandler\ReservationListFactory',
                     'Finna\AjaxHandler\ImportFavorites' =>
                         'Finna\AjaxHandler\ImportFavoritesFactory',
                     'Finna\AjaxHandler\OnlinePaymentNotify' =>
@@ -531,6 +534,7 @@
                     'getSearchTabsRecommendations' => 'Finna\AjaxHandler\GetSearchTabsRecommendations',
                     'getSimilarRecords' => 'Finna\AjaxHandler\GetSimilarRecords',
                     'getUserList' => 'Finna\AjaxHandler\GetUserList',
+                    'reservationList' => 'Finna\AjaxHandler\ReservationList',
                     'importFavorites' => 'Finna\AjaxHandler\ImportFavorites',
                     'onlinePaymentNotify' => 'Finna\AjaxHandler\OnlinePaymentNotify',
                     'registerOnlinePayment' => 'Finna\AjaxHandler\RegisterOnlinePayment',
@@ -763,6 +767,7 @@
             ],
             'onlinepayment_handler' => [ /* see Finna\OnlinePayment\Handler\PluginManager for defaults */ ],
             'video_handler' => [ /* see Finna\Video\Handler\PluginManager for defaults */ ],
+            'reservationlist' => [ /* see Finna\ReservationList\PluginManager for defaults */ ],
             'recommend' => [
                 'factories' => [
                     'VuFind\Recommend\CollectionSideFacets' => 'Finna\Recommend\Factory::getCollectionSideFacets',

module/Finna/sql/mysql.sql

@@ -341,6 +341,7 @@ CREATE TABLE `finna_resource_list` (
   `ordered` datetime DEFAULT NULL,
   `pickup_date` datetime DEFAULT NULL,
   `connection` varchar(40) NOT NULL DEFAULT 'database',
+  `external_id` varchar(40) DEFAULT NULL,
   PRIMARY KEY (`id`),
   KEY `user_id` (`user_id`),
   CONSTRAINT `resource_list_ibfk_1` FOREIGN KEY (`user_id`) REFERENCES `user` (`id`) ON DELETE CASCADE

module/Finna/src/Finna/AjaxHandler/ReservationList.php

@@ -0,0 +1,112 @@
+<?php
+
+/**
+ * Reservation list ajax handler
+ *
+ * PHP version 8.1
+ *
+ * Copyright (C) The National Library of Finland 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  AjaxHandler
+ * @author   Juha Luoma <juha.luoma@helsinki.fi>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development:plugins:record_tabs Wiki
+ */
+
+namespace Finna\AjaxHandler;
+
+use Finna\ReservationList\PluginManager;
+use Finna\ReservationList\ReservationListService;
+use Laminas\Mvc\Controller\Plugin\Params;
+use VuFind\Db\Entity\UserEntityInterface;
+use VuFind\I18n\Translator\TranslatorAwareInterface;
+
+/**
+ * Reservation list ajax handler
+ *
+ * @category VuFind
+ * @package  AjaxHandler
+ * @author   Juha Luoma <juha.luoma@helsinki.fi>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development:plugins:record_tabs Wiki
+ */
+class ReservationList extends \VuFind\AjaxHandler\AbstractBase implements TranslatorAwareInterface
+{
+    use \VuFind\I18n\Translator\TranslatorAwareTrait;
+
+    /**
+     * Constructor
+     *
+     * @param ?UserEntityInterface   $user                   Logged in user (or null)
+     * @param ReservationListService $reservationListService Reservation list service
+     * @param PluginManager          $connectionHandler      Reservation List connection handler
+     */
+    public function __construct(
+        protected ?UserEntityInterface $user,
+        protected ReservationListService $reservationListService,
+        protected PluginManager $connectionHandler,
+    ) {
+    }
+
+    /**
+     * Handle a request.
+     *
+     * @param Params $params Parameter helper from controller
+     *
+     * @return array [response data, HTTP status code]
+     */
+    public function handleRequest(Params $params)
+    {
+        if ($this->user === null) {
+            return $this->formatResponse(
+                $this->translate('You must be logged in first'),
+                self::STATUS_HTTP_NEED_AUTH
+            );
+        }
+        $listId = (int)$params->fromQuery('list_id');
+        if (!$listId) {
+            return $this->formatResponse(
+                'Bad request',
+                self::STATUS_HTTP_BAD_REQUEST
+            );
+        }
+        $list = $this->reservationListService->getListById($listId, $this->user);
+        if (!$list) {
+            return $this->formatResponse(
+                'Bad request',
+                self::STATUS_HTTP_BAD_REQUEST
+            );
+        }
+        $result = '';
+        switch ($params->fromQuery('type')) {
+            case 'status':
+                $listProperties = $this->reservationListService->getListProperties(
+                    $list->getInstitution(),
+                    $list->getListConfigIdentifier()
+                );
+                $connectionType = $list->getConnection();
+                $handler = $this->connectionHandler->get($connectionType);
+                $handler->init($listProperties['properties']);
+                $result = $handler->getListStatus($list, $this->user);
+                $result = $this->translate($result);
+                break;
+            default:
+                break;
+        }
+        return $this->formatResponse($result);
+    }
+}

module/Finna/src/Finna/AjaxHandler/ReservationListFactory.php

@@ -0,0 +1,75 @@
+<?php
+
+/**
+ * Reservation list ajax handler factory
+ *
+ * PHP version 8.1
+ *
+ * Copyright (C) The National Library of Finland 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  AjaxHandler
+ * @author   Juha Luoma <juha.luoma@helsinki.fi>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development:plugins:record_tabs Wiki
+ */
+
+namespace Finna\AjaxHandler;
+
+use Psr\Container\ContainerInterface;
+
+/**
+ * Reservation list ajax handler
+ *
+ * @category VuFind
+ * @package  AjaxHandler
+ * @author   Juha Luoma <juha.luoma@helsinki.fi>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development:plugins:record_tabs Wiki
+ */
+class ReservationListFactory implements \Laminas\ServiceManager\Factory\FactoryInterface
+{
+    /**
+     * Create an object
+     *
+     * @param ContainerInterface $container     Service manager
+     * @param string             $requestedName Service being created
+     * @param null|array         $options       Extra options (optional)
+     *
+     * @return object
+     *
+     * @throws ServiceNotFoundException if unable to resolve the service.
+     * @throws ServiceNotCreatedException if an exception is raised when
+     * creating a service.
+     * @throws ContainerException if any other error occurs
+     *
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function __invoke(
+        ContainerInterface $container,
+        $requestedName,
+        array $options = null
+    ) {
+        if (!empty($options)) {
+            throw new \Exception('Unexpected options passed to factory.');
+        }
+        return new $requestedName(
+            $container->get(\VuFind\Auth\Manager::class)->getUserObject(),
+            $container->get(\Finna\ReservationList\ReservationListService::class),
+            $container->get(\Finna\ReservationList\PluginManager::class),
+        );
+    }
+}

module/Finna/src/Finna/Controller/ReservationListController.php

@@ -305,25 +305,21 @@ public function placeOrderAction()
         $formId = Form::RESERVATION_LIST_REQUEST;
 
         $resourcesText = '';
+        $resourceIds = [];
         foreach ($this->reservationListService->getResourcesForList($list, $user) as $resource) {
             $resourcesText .= $resource->getRecordId() . '||' . $resource->getTitle() . PHP_EOL;
+            $resourceIds[] = $resource->getSource() . '|' . $resource->getRecordId();
         }
         // Set reservationlist specific form values
         $request->getPost()
             ->set('rl_list_id', $listId)
             ->set('rl_institution', $list->getInstitution())
             ->set('rl_list_identifier', $list->getListConfigIdentifier())
-            ->set('record_ids', $resourcesText);
+            ->set('record_ids', $resourcesText)
+            ->set('resourceIDs', $resourceIds);
 
         $form = $this->getService(\Finna\Form\Form::class);
-        $params = [];
-        if ($refererHeader = $this->getRequest()->getHeader('Referer')) {
-            $params['referrer'] = $refererHeader->getFieldValue();
-        }
-        if ($userAgentHeader = $this->getRequest()->getHeader('User-Agent')) {
-            $params['userAgent'] = $userAgentHeader->getFieldValue();
-        }
-        $form->setFormId($formId, $params, $request->getPost()->toArray());
+        $form->setFormId(formId: $formId, prefill: $request->getPost()->toArray());
 
         if (!$form->isEnabled()) {
             throw new \VuFind\Exception\Forbidden("Form '$formId' is disabled");
@@ -333,13 +329,13 @@ public function placeOrderAction()
         $view->setTemplate('feedback/form');
         $view->useCaptcha = false;
 
-        $params = $this->params();
         $form->setData($request->getPost()->toArray());
         if (!$this->formWasSubmitted(useCaptcha: false)) {
             $form->setData(
                 [
-                 'name' => trim($user->getFirstname() . ' ' . $user->getLastname()),
-                 'email' => $user->getEmail(),
+                    'firstName' => $user->getFirstname(),
+                    'lastName' => $user->getLastname(),
+                    'email' => $user->getEmail(),
                 ]
             );
             return $view;
@@ -348,12 +344,12 @@ public function placeOrderAction()
         if (!$form->isValid()) {
             return $view;
         }
-
-        // Override recipients to match list's configured recipients:
-        $request->getPost()->set('recipient', $listProperties['Recipient']);
-        $primaryHandler = $form->getPrimaryHandler();
-        $success = $primaryHandler->handle($form, $params, $user);
-        if ($success) {
+        $connectionType = $listProperties['Connection']['type'];
+        $handler = $this->getService(\Finna\ReservationList\PluginManager::class)->get($connectionType);
+        $handler->init($listProperties);
+        $result = $handler->placeOrder($this->params(), $user, $form);
+        if ($result['success']) {
+            $request->getPost()->set('external_id', $result['external_id'])->set('connection', $connectionType);
             $this->reservationListService->setListOrdered($user, $list, $request->getPost());
             $this->flashMessenger()->addSuccessMessage($form->getSubmitResponse());
             return $this->getRefreshResponse();