Migrated UserList Service

module/VuFind/src/VuFind/ChannelProvider/ListItems.php

@@ -31,6 +31,7 @@
 
 use Laminas\Mvc\Controller\Plugin\Url;
 use Laminas\Stdlib\Parameters;
+use VuFind\Db\Entity\UserList;
 use VuFind\RecordDriver\AbstractBase as RecordDriver;
 use VuFind\Search\Base\Results;
 
@@ -86,11 +87,11 @@ class ListItems extends AbstractChannelProvider
     protected $initialListsToDisplay;
 
     /**
-     * UserList table
+     * UserList database service
      *
-     * @var \VuFind\Db\Table\UserList
+     * @var \VuFind\Db\Service\UserListService
      */
-    protected $userList;
+    protected $listService;
 
     /**
      * Tag database service
@@ -116,21 +117,21 @@ class ListItems extends AbstractChannelProvider
     /**
      * Constructor
      *
-     * @param \VuFind\Db\Table\UserList            $userList       UserList table
+     * @param \VuFind\Db\Service\UserListService   $listService    UserList table
      * @param \VuFind\Db\Service\TagService        $tagService     Tag database service
      * @param Url                                  $url            URL helper
      * @param \VuFind\Search\Results\PluginManager $resultsManager Results manager
      * @param array                                $options        Settings
      * (optional)
      */
     public function __construct(
-        \VuFind\Db\Table\UserList $userList,
+        \VuFind\Db\Service\UserListService $listService,
         \VuFind\Db\Service\TagService $tagService,
         Url $url,
         \VuFind\Search\Results\PluginManager $resultsManager,
         array $options = []
     ) {
-        $this->userList = $userList;
+        $this->listService = $listService;
         $this->tagService = $tagService;
         $this->url = $url;
         $this->resultsManager = $resultsManager;
@@ -222,35 +223,8 @@ protected function getListsById($ids)
     {
         $lists = [];
         foreach ($ids as $id) {
-            $list = $this->userList->getExisting($id);
-            if ($list->public) {
-                $lists[] = $list;
-            }
-        }
-        return $lists;
-    }
-
-    /**
-     * Given an array of lists, add public lists if configured to do so.
-     *
-     * @param array $lists List to expand.
-     *
-     * @return array
-     */
-    protected function addPublicLists($lists)
-    {
-        if ($this->displayPublicLists) {
-            $resultIds = [];
-            foreach ($lists as $list) {
-                $resultIds[] = $list->id;
-            }
-            $callback = function ($select) use ($resultIds) {
-                $select->where->equalTo('public', 1);
-                if (!empty($resultIds)) {
-                    $select->where->notIn('id', $resultIds);
-                }
-            };
-            foreach ($this->userList->select($callback) as $list) {
+            $list = $this->listService->getExisting($id);
+            if ($list->isPublic()) {
                 $lists[] = $list;
             }
         }
@@ -271,7 +245,11 @@ protected function getLists()
             : $this->getListsById($this->ids);
 
         // Next, we add other public lists if necessary:
-        return $this->addPublicLists($baseLists);
+        $publicLists = [];
+        if ($this->displayPublicLists) {
+            $publicLists = $this->listService->getPublicLists($baseLists);
+        }
+        return array_merge($baseLists, $publicLists);
     }
 
     /**
@@ -282,22 +260,17 @@ protected function getLists()
     protected function getListsByTagAndId()
     {
         // Get public lists by search criteria
-        $lists = $this->tagService->getListsForTag(
+        $listIds = $this->tagService->getListsForTag(
             $this->tags,
             $this->ids,
             true,
             $this->andTags
         );
 
-        // Format result set into an array:
         $result = [];
-        if (count($lists)) {
-            $callback = function ($select) use ($lists) {
-                $select->where->in('id', $lists);
-            };
-
-            foreach ($this->userList->select($callback) as $list) {
-                $result[] = $list;
+        if (count($listIds)) {
+            foreach ($listIds as $id) {
+                $result[] = $this->listService->getEntityById(\VuFind\Db\Entity\UserList::class, $id);
             }
         }
 
@@ -306,8 +279,8 @@ protected function getListsByTagAndId()
             $orderIds = (array)$this->ids;
             $sortFn = function ($left, $right) use ($orderIds) {
                 return
-                    array_search($left->id, $orderIds)
-                    <=> array_search($right->id, $orderIds);
+                    array_search($left->getId(), $orderIds)
+                    <=> array_search($right->getId(), $orderIds);
             };
             usort($result, $sortFn);
         }
@@ -326,21 +299,21 @@ protected function getListsByTagAndId()
     protected function getChannelFromList($list, $tokenOnly)
     {
         $retVal = [
-            'title' => $list->title,
+            'title' => $list->getTitle(),
             'providerId' => $this->providerId,
-            'token' => $list->id,
+            'token' => $list->getId(),
             'links' => [],
         ];
         if ($tokenOnly) {
             return $retVal;
         }
         $results = $this->resultsManager->get('Favorites');
-        $results->getParams()->initFromRequest(new Parameters(['id' => $list->id]));
+        $results->getParams()->initFromRequest(new Parameters(['id' => $list->getId()]));
         $retVal['contents'] = $this->summarizeRecordDrivers($results->getResults());
         $retVal['links'][] = [
             'label' => 'channel_search',
             'icon' => 'fa-list',
-            'url' => $this->url->fromRoute('userList', ['id' => $list->id]),
+            'url' => $this->url->fromRoute('userList', ['id' => $list->getId()]),
         ];
         return $retVal;
     }

module/VuFind/src/VuFind/ChannelProvider/ListItemsFactory.php

@@ -68,11 +68,10 @@ public function __invoke(
         if ($options !== null) {
             throw new \Exception('Unexpected options sent to factory!');
         }
+        $sm = $container->get(\VuFind\Db\Service\PluginManager::class);
         return new $requestedName(
-            $container->get(\VuFind\Db\Table\PluginManager::class)->get('UserList'),
-            $container
-                ->get(\VuFind\Db\Service\PluginManager::class)
-                ->get(\VuFind\Db\Service\TagService::class),
+            $sm->get(\VuFind\Db\Service\UserListService::class),
+            $sm->get(\VuFind\Db\Service\TagService::class),
             $container->get('ControllerPluginManager')->get('url'),
             $container->get(\VuFind\Search\Results\PluginManager::class)
         );

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

@@ -496,13 +496,15 @@ public function saveAction()
 
         // Loop through all user lists and sort out containing/non-containing lists
         $containingLists = $nonContainingLists = [];
-        foreach ($user->getLists() as $list) {
+        $lists = $this->getDbService(\VuFind\Db\Service\UserListService::class)->getLists($user->id);
+        foreach ($lists as $current) {
             // Assign list to appropriate array based on whether or not we found
             // it earlier in the list of lists containing the selected record.
-            if (in_array($list->id, $listIds)) {
-                $containingLists[] = $list->toArray();
+            $list = $current[0];
+            if (in_array($list->getId(), $listIds)) {
+                $containingLists[] = $list;
             } else {
-                $nonContainingLists[] = $list->toArray();
+                $nonContainingLists[] = $list;
             }
         }
 

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

@@ -485,12 +485,13 @@ public function saveAction()
             $this->flashMessenger()->addMessage($message, 'success');
             return $this->redirect()->toUrl($listUrl);
         }
-
+        $listService = $this->serviceLocator->get(\VuFind\Db\Service\PluginManager::class)
+            ->get(\VuFind\Db\Service\UserListService::class);
         // Pass record and list information to view:
         return $this->createViewModel(
             [
                 'records' => $this->getRecordLoader()->loadBatch($ids),
-                'lists' => $user->getLists(),
+                'lists' => $listService->getLists($user->id),
             ]
         );
     }

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

@@ -807,8 +807,7 @@ public function deleteAction()
         if (empty($listID)) {
             $list = false;
         } else {
-            $table = $this->getTable('UserList');
-            $list = $table->getExisting($listID);
+            $list = $this->getListService()->getExisting($listID);
         }
         return $this->createViewModel(
             [
@@ -845,9 +844,9 @@ public function performDeleteFavorite($id, $source)
         // Perform delete and send appropriate flash message:
         if (null !== $listID) {
             // ...Specific List
-            $table = $this->getTable('UserList');
-            $list = $table->getExisting($listID);
-            $list->removeResourcesById($user, [$id], $source);
+            $listService = $this->getListService();
+            $list = $listService->getExisting($listID);
+            $listService->removeResourcesById($user->id, $list, [$id], $source);
             $this->flashMessenger()->addMessage('Item removed from list', 'success');
         } else {
             // ...My Favorites
@@ -958,13 +957,13 @@ public function editAction()
         foreach ($userResources as $current) {
             $containingLists[] = $current->list_id;
         }
-
         // Send non-containing lists to the view for user selection:
-        $userLists = $user->getLists();
+        $userLists = $this->getListService()->getLists($user->id);
         $lists = [];
         foreach ($userLists as $userList) {
-            if (!in_array($userList->id, $containingLists)) {
-                $lists[$userList->id] = $userList->title;
+            $list = $userList[0];
+            if (!in_array($list->getId(), $containingLists)) {
+                $lists[$list->getId()] = $list->getTitle();
             }
         }
 
@@ -1065,7 +1064,8 @@ public function mylistAction()
 
             if ($this->listTagsEnabled()) {
                 if ($list = $results->getListObject()) {
-                    foreach ($list->getListTags() as $tag) {
+                    $tagService = $this->getDbService(\VuFind\Db\Service\TagService::class);
+                    foreach ($tagService->getForList($list, $list->getUser()) as $tag) {
                         $listTags[$tag['id']] = $tag['tag'];
                     }
                 }
@@ -1087,8 +1087,8 @@ public function mylistAction()
     /**
      * Process the "edit list" submission.
      *
-     * @param \VuFind\Db\Row\User     $user Logged in user
-     * @param \VuFind\Db\Row\UserList $list List being created/edited
+     * @param \VuFind\Db\Row\User        $user Logged in user
+     * @param \VuFind\Db\Entity\UserList $list List being created/edited
      *
      * @return object|bool                  Response object if redirect is
      * needed, false if form needs to be redisplayed.
@@ -1097,8 +1097,7 @@ protected function processEditList($user, $list)
     {
         // Process form within a try..catch so we can handle errors appropriately:
         try {
-            $finalId
-                = $list->updateFromRequest($user, $this->getRequest()->getPost());
+            $finalId = $this->getListService()->updateFromRequest($user->id, $list, $this->getRequest()->getPost());
 
             // If the user is in the process of saving a record, send them back
             // to the save screen; otherwise, send them back to the list they
@@ -1164,12 +1163,12 @@ public function editlistAction()
         // Is this a new list or an existing list?  Handle the special 'NEW' value
         // of the ID parameter:
         $id = $this->params()->fromRoute('id', $this->params()->fromQuery('id'));
-        $table = $this->getTable('UserList');
+        $listService = $this->getListService();
         $newList = ($id == 'NEW');
-        $list = $newList ? $table->getNew($user) : $table->getExisting($id);
+        $list = $newList ? $listService->getNew($user->id) : $listService->getExisting($id);
 
         // Make sure the user isn't fishing for other people's lists:
-        if (!$newList && !$list->editAllowed($user)) {
+        if (!$newList && !$list->editAllowed($user->id)) {
             throw new ListPermissionException('Access denied.');
         }
 
@@ -1182,7 +1181,8 @@ public function editlistAction()
 
         $listTags = null;
         if ($this->listTagsEnabled() && !$newList) {
-            $listTags = $user->formatTagString($list->getListTags());
+            $tags = $this->getDbService(\VuFind\Db\Service\TagService::class)->getForList($list, $user->id);
+            $listTags = $user->formatTagString($tags);
         }
         // Send the list to the view:
         return $this->createViewModel(
@@ -1245,9 +1245,9 @@ public function deletelistAction()
         );
         if ($confirm) {
             try {
-                $table = $this->getTable('UserList');
-                $list = $table->getExisting($listID);
-                $list->delete($this->getUser());
+                $listService = $this->getListService();
+                $list = $listService->getExisting($listID);
+                $listService->delete($list, $this->getUser()->id);
 
                 // Success Message
                 $this->flashMessenger()->addMessage('fav_list_delete', 'success');
@@ -2267,4 +2267,14 @@ protected function addPendingEmailChangeMessage($user)
             );
         }
     }
+
+    /**
+     * Get userlist database service
+     *
+     * @return \VuFind\Db\Service\AbstractService
+     */
+    protected function getListService()
+    {
+        return $this->getDbService(\VuFind\Db\Service\UserListService::class);
+    }
 }

module/VuFind/src/VuFind/Controller/Plugin/Favorites.php

@@ -5,7 +5,7 @@
  *
  * PHP version 8
  *
- * Copyright (C) Villanova University 2010.
+ * Copyright (C) Villanova University 2010-2023.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 2,
@@ -83,8 +83,12 @@ class Favorites extends \Laminas\Mvc\Controller\Plugin\AbstractPlugin
      * @param Tags             $tags      Tag parser
      * @param FavoritesService $favorites Favorites service
      */
-    public function __construct(Loader $loader, Cache $cache, Tags $tags, FavoritesService $favorites)
-    {
+    public function __construct(
+        Loader $loader,
+        Cache $cache,
+        Tags $tags,
+        FavoritesService $favorites,
+    ) {
         $this->loader = $loader;
         $this->cache = $cache;
         $this->tags = $tags;
@@ -152,7 +156,7 @@ public function saveBulk($params, $user)
             // Add the information to the user's account:
             $tags = isset($params['mytags'])
                 ? $this->tags->parse($params['mytags']) : [];
-            $user->saveResource($resource, $list, $tags, '', false);
+            $user->saveResource($resource, $list->getId(), $tags, '', false);
 
             // Collect record IDs for caching
             if ($this->cache->isCachable($resource->source)) {
@@ -161,7 +165,7 @@ public function saveBulk($params, $user)
         }
 
         $this->cacheBatch($cacheRecordIds);
-        return ['listId' => $list->id];
+        return ['listId' => $list->getId()];
     }
 
     /**
@@ -193,10 +197,10 @@ public function delete($ids, $listID, $user)
                 $user->removeResourcesById($ids, $source);
             }
         } else {
-            $table = $this->getController()->getTable('UserList');
-            $list = $table->getExisting($listID);
+            $listService = $this->favoritesService->getDbService(\VuFind\Db\Service\UserListService::class);
+            $list = $listService->getExisting($listID);
             foreach ($sorted as $source => $ids) {
-                $list->removeResourcesById($user, $ids, $source);
+                $listService->removeResourcesById($user->id, $list, $ids, $source);
             }
         }
     }