Merge remote-tracking branch 'origin/25.02.00' into DIS-211-ignore-nu…

…mber-one-bestseller
Aspen-Discovery · Jan 10, 2025 · 73c3a7a · 73c3a7a
2 parents d5c2942 + 8defd9d
commit 73c3a7a
Show file tree

Hide file tree

Showing 10 changed files with 243 additions and 44 deletions.
diff --git a/code/axis_360_export/axis_360_export.jar b/code/axis_360_export/axis_360_export.jar
diff --git a/code/hoopla_export/hoopla_export.jar b/code/hoopla_export/hoopla_export.jar
diff --git a/code/koha_export/koha_export.jar b/code/koha_export/koha_export.jar
diff --git a/code/polaris_export/polaris_export.jar b/code/polaris_export/polaris_export.jar
diff --git a/code/reindexer/reindexer.jar b/code/reindexer/reindexer.jar
diff --git a/code/user_list_indexer/user_list_indexer.jar b/code/user_list_indexer/user_list_indexer.jar
diff --git a/code/web/release_notes/25.02.00.MD b/code/web/release_notes/25.02.00.MD
@@ -0,0 +1,68 @@
+## Aspen LiDA Updates
+//mark
+### Account Updates
+- When a library has multiple sublocations that are valid as pickup areas, allow the user to change the pickup area when changing the pickup location. (DIS-195) (*MDN*)
+
+### Holds Updates
+- When a library has multiple sublocations that are valid as pickup areas, allow the user to select a pickup area when placing a hold. (DIS-195) (*MDN*)
+
+## Aspen Discovery Updates
+//mark
+### API Updates
+- Add a new API to retrieve available sublocations for the system. (DIS-195) (*MDN*)
+- API updates to support using multiple pickup areas within a location. (DIS-195) (*MDN*)
+
+//katherine
+
+//kirstien
+
+//james
+
+//alexander
+
+//chloe
+
+
+//pedro
+
+// lucas
+
+// tomas
+
+// kyle
+
+//kidclamp
+
+Use mb_substr to presrve diacritics in lists (DIS-178) (*WNC*)
+
+//yanjun
+
+//lukeg
+
+## This release includes code contributions from
+### ByWater Solutions
+  - Kyle Hall (KMH)
+  - Lucas Gass (LG)
+  - Nick Clemens (WNC)
+  - Yanjun Li (YL)
+
+### Grove For Libraries
+  - Mark Noble (MDN)
+  - Kirstien Kroeger (KK)
+  - Katherine Perdue (KP)
+
+### Nashville Public Library
+  - James Staub (JStaub)
+
+### PTFS-Europe
+  - Alexander Blanchard (AB)
+  - Chloe Zermatten (CZ)
+  - Pedro Amorim (PA)
+
+### Theke Solutions
+  - Lucas Montoya (LM)
+  - Tomás Cohen Arazi (TC)
+
+## Special Testing thanks to
+
+## This release includes sponsored developments from
diff --git a/code/web/services/API/UserAPI.php b/code/web/services/API/UserAPI.php
@@ -6,13 +6,13 @@ class UserAPI extends AbstractAPI {
 
 
 	/**
-	 * Processes method to determine return type and calls the correct method.
+	 * Processes method to determine the return type and calls the correct method.
 	 * Should not be called directly.
 	 *
 	 * @see Action::launch()
 	 * @access private
 	 */
-	function launch() {
+	function launch() : void {
 		$method = (isset($_GET['method']) && !is_array($_GET['method'])) ? $_GET['method'] : '';
 		$output = '';
 
@@ -54,6 +54,7 @@ function launch() {
 					'returnCheckout',
 					'updateOverDriveEmail',
 					'getValidPickupLocations',
+					'getValidSublocations',
 					'getHiddenBrowseCategories',
 					'getILSMessages',
 					'dismissBrowseCategory',
@@ -256,8 +257,8 @@ function logout(): bool {
 	 *
 	 * Parameters:
 	 * <ul>
-	 * <li>username - The barcode of the user.  Can be truncated to the last 7 or 9 digits.</li>
-	 * <li>password - The pin number for the user.
+	 * <li>username - The barcode of the user. Can be truncated to the last 7 or 9 digits.</li>
+	 * <li>password - The pin for the user.
 	 * </ul>
 	 *
 	 * @noinspection PhpUnused
@@ -1916,6 +1917,18 @@ function placeHold(): array {
 			$shortId = $bibId;
 		}
 
+		$pickupSublocationId = $_REQUEST['pickupSublocation'] ?? false;
+		$pickupSublocation = null;
+		if ($pickupSublocationId) {
+			//In the form this is set as the id of the sublocation in Aspen, but we want to pass the ILS ID
+			require_once ROOT_DIR . '/sys/LibraryLocation/Sublocation.php';
+			$pickupSublocationObject = new Sublocation();
+			$pickupSublocationObject->id = $pickupSublocationId;
+			if ($pickupSublocationObject->find(true)) {
+				$pickupSublocation = $pickupSublocationObject->ilsId;
+			}
+		}
+
 		$user = $this->getUserForApiCall();
 		if ($user && !($user instanceof AspenError)) {
 			global $library;
@@ -1966,7 +1979,7 @@ function placeHold(): array {
 
 					$holdType = $_REQUEST['holdType'];
 					if ($holdType == 'item' && isset($_REQUEST['itemId'])) {
-						$result = $user->placeItemHold($shortId, $_REQUEST['itemId'], $pickupBranch, $cancelDate);
+						$result = $user->placeItemHold($shortId, $_REQUEST['itemId'], $pickupBranch, $cancelDate, $pickupSublocation);
 						$action = $result['api']['action'] ?? null;
 						$responseMessage = strip_tags($result['api']['message']);
 						$responseMessage = trim($responseMessage);
@@ -1982,7 +1995,7 @@ function placeHold(): array {
 							'needsIllRequest' => $needsIllRequest
 						];
 					} elseif ($holdType == 'volume' && isset($_REQUEST['volumeId'])) {
-						$result = $user->placeVolumeHold($shortId, $_REQUEST['volumeId'], $pickupBranch);
+						$result = $user->placeVolumeHold($shortId, $_REQUEST['volumeId'], $pickupBranch, $pickupSublocation);
 						$action = $result['api']['action'] ?? null;
 						$responseMessage = strip_tags($result['api']['message']);
 						$responseMessage = trim($responseMessage);
@@ -2012,7 +2025,7 @@ function placeHold(): array {
 								];
 							}
 						}
-						$result = $user->placeHold($bibId, $pickupBranch, $cancelDate);
+						$result = $user->placeHold($bibId, $pickupBranch, $cancelDate, $pickupSublocation);
 						$action = $result['api']['action'] ?? null;
 						$responseMessage = strip_tags($result['api']['message']);
 						$responseMessage = trim($responseMessage);
@@ -2131,7 +2144,19 @@ function changeHoldPickUpLocation(): array {
 					]),
 				];
 			}
-			$result = $user->changeHoldPickUpLocation($holdId, $locationCode);
+			$newSublocation = $_REQUEST['newSublocation'] ?? null;
+			$pickupSublocation = null;
+			if (!empty($newSublocation)) {
+				//In the form this is set as the id of the sublocation in Aspen, but we want to pass the ILS ID
+				require_once ROOT_DIR . '/sys/LibraryLocation/Sublocation.php';
+				$pickupSublocationObject = new Sublocation();
+				$pickupSublocationObject->id = $newSublocation;
+				if ($pickupSublocationObject->find(true)) {
+					$pickupSublocation = $pickupSublocationObject->ilsId;
+				}
+			}
+
+			$result = $user->changeHoldPickUpLocation($holdId, $locationCode, $pickupSublocation);
 			return [
 				'success' => $result['success'],
 				'title' => $result['api']['title'],
@@ -2146,11 +2171,7 @@ function changeHoldPickUpLocation(): array {
 	}
 
 	function getValidPickupLocations(): array {
-		[
-			$username,
-			$password,
-		] = $this->loadUsernameAndPassword();
-		$patron = UserAccount::validateAccount($username, $password);
+		$patron = $this->getUserForApiCall();
 		if ($patron && !($patron instanceof AspenError)) {
 			if ($patron->hasIlsConnection()) {
 				$tmpPickupLocations = $patron->getValidPickupBranches($patron->getAccountProfile()->recordSource);
@@ -2182,6 +2203,64 @@ function getValidPickupLocations(): array {
 		}
 	}
 
+	function getValidSublocations() : array {
+		$patron = $this->getUserForApiCall();
+		if ($patron && !($patron instanceof AspenError)) {
+			if (isset($_REQUEST['locationCode'])) {
+				$location = new Location();
+				$location->code = $_REQUEST['locationCode'];
+				if ($location->find(true)) {
+					$validSubLocationsForUser = $location->getPickupSublocations($patron);
+					$subLocationsToReturn = [];
+					foreach ($validSubLocationsForUser as $sublocation) {
+						$subLocationsToReturn[$sublocation->id] = [
+							'id' => $sublocation->id,
+							'ilsId' => $sublocation->ilsId,
+							'displayName' => $sublocation->name,
+							'locationCode' => $location->code,
+							'locationId' => $location->locationId
+						];
+					}
+					return [
+						'success' => true,
+						'sublocations' => $subLocationsToReturn,
+					];
+				}else{
+					return [
+						'success' => false,
+						'message' => 'Could not find location for the specified location code',
+					];
+				}
+			}else{
+				$tmpPickupLocations = $patron->getValidPickupBranches($patron->getAccountProfile()->recordSource);
+				$subLocationsToReturn = [];
+				foreach ($tmpPickupLocations as $pickupLocation) {
+					if (!is_string($pickupLocation)) {
+						$validSubLocationsForUser = $pickupLocation->getPickupSublocations($patron);
+						foreach ($validSubLocationsForUser as $sublocation) {
+							$subLocationsToReturn[$sublocation->id] = [
+								'id' => $sublocation->id,
+								'ilsId' => $sublocation->ilsId,
+								'displayName' => $sublocation->name,
+								'locationCode' => $pickupLocation->code,
+								'locationId' => $pickupLocation->locationId
+							];
+						}
+					}
+				}
+				return [
+					'success' => true,
+					'sublocations' => $subLocationsToReturn,
+				];
+			}
+		} else {
+			return [
+				'success' => false,
+				'message' => 'Login unsuccessful',
+			];
+		}
+	}
+
 	function confirmHold(): array {
 		$user = $this->getUserForApiCall();
 		if ($user && !($user instanceof AspenError)) {
@@ -4628,7 +4707,7 @@ function updateScreenBrightnessStatus(): array {
 		$user = $this->getUserForApiCall();
 		if ($user && !($user instanceof AspenError)) {
 			$newStatus = $_REQUEST['status'] ?? null;
-			if($newStatus) {
+			if($newStatus !== null) {
 				if ($newStatus == 'false' || !$newStatus) {
 					$user->shouldAskBrightness = 0;
 					$user->update();
@@ -4639,6 +4718,11 @@ function updateScreenBrightnessStatus(): array {
 					];
 				} else {
 					// no update to the status since it defaults to 1
+					return [
+						'success' => true,
+						'title' => 'Success',
+						'message' => 'User screen brightness prompt status did not need update'
+					];
 				}
 			} else {
 				return [
@@ -4664,7 +4748,7 @@ function getUserByBarcode(): array {
 		];
 		if (isset($_REQUEST['username'])) {
 			$user = UserAccount::getUserByBarcode($_REQUEST['username']);
-			if ($user != false) {
+			if ($user !== false) {
 				$results = [
 					'success' => true,
 					'id' => $user->id,
@@ -4683,7 +4767,7 @@ function getUserByBarcode(): array {
 	/**
 	 * @return bool|User
 	 */
-	function getUserForApiCall($patronBarcode = null, $patronPassword = null) {
+	function getUserForApiCall(?String $patronBarcode = null, ?String $patronPassword = null) : bool|User {
 		if ($this->context == 'internal') {
 			if ($patronBarcode == null && $patronPassword == null) {
 				return UserAccount::getActiveUserObj();
@@ -4734,7 +4818,7 @@ function getUserForApiCall($patronBarcode = null, $patronPassword = null) {
 		}
 	}
 
-	function getLinkedAccounts() {
+	function getLinkedAccounts() : array {
 		$user = $this->getUserForApiCall();
 
 		if ($user && !($user instanceof AspenError)) {
@@ -6045,6 +6129,12 @@ function markMessageAsRead(): array {
 							'title' => translate(['text' => 'Updated', 'isPublicFacing' => true]),
 							'message' => translate(['text' => 'Marked message as read', 'isPublicFacing' => true]),
 						];
+					}else{
+						return [
+							'success' => false,
+							'title' => translate(['text' => 'Not Updated', 'isPublicFacing' => true]),
+							'message' => translate(['text' => 'Could not mark message as read', 'isPublicFacing' => true]),
+						];
 					}
 				} else {
 					return [
@@ -6087,6 +6177,12 @@ function markMessageAsUnread(): array {
 							'title' => translate(['text' => 'Updated', 'isPublicFacing' => true]),
 							'message' => translate(['text' => 'Marked message as unread', 'isPublicFacing' => true]),
 						];
+					}else{
+						return [
+							'success' => false,
+							'title' => translate(['text' => 'Not Updated', 'isPublicFacing' => true]),
+							'message' => translate(['text' => 'Could not mark message as unread', 'isPublicFacing' => true]),
+						];
 					}
 				} else {
 					return [