Merge pull request #174 from Chloe070196/25.02.00_newsletter_consent_koha_integration

25.02.00 newsletter consent koha integration

Author: Chloe070196

code/web/CatalogConnection.php

@@ -1923,4 +1923,8 @@ public function submitLocalIllRequest(User $patron, LocalIllForm $localIllForm):
 			];
 		}
 	}
+
+	public function hasIlsConsentSupport(): bool {
+		return $this->driver->hasIlsConsentSupport();
+	}
 }

code/web/Drivers/AbstractIlsDriver.php

@@ -917,4 +917,8 @@ public function loadLibraries() : array {
 			'message' => 'This functionality has not been implemented for this ILS',
 		];
 	}
+
+	public function hasIlsConsentSupport(): bool {
+		return false;
+	}
 }

code/web/Drivers/Koha.php

@@ -4122,7 +4122,7 @@ function getSelfRegistrationFields($type = 'selfReg') {
 			}
 		}
 
-		if($library->ilsConsentEnabled) {
+		if($library->ilsConsentEnabled && $this->areAnyConsentPluginsEnabled()) {
 			$fields['privacySection'] = $this->getSelfRegistrationFormPrivacySection();
 		}
 
@@ -4507,19 +4507,25 @@ function selfRegister(): array {
 
 			$result = $this->postSelfRegistrationToKoha($postVariables);
 
-			if ($result) {
-				$consentTypes = $this->getConsentTypes();
-				if (!empty($consentTypes)) {
-					foreach ($consentTypes as $key => $consentType) {
-						if (strtolower($key) == 'gdpr_processing') {
-							continue;
-						}
-						$this->updatePatronConsent($result['patronId'], strtolower($key), isset($_REQUEST['privacy_consent_' . strtolower($key)]));
+			if (!$library->ilsConsentEnabled) {
+				return $result;
+			}
+
+			if (!$this->areAnyConsentPluginsEnabled()) {
+				return $result;
+			}
+
+			$consentTypes = $this->getConsentTypes();
+			if (!empty($consentTypes)) {
+				foreach ($consentTypes as $key => $consentType) {
+					if (strtolower($key) == 'gdpr_processing') {
+						continue;
 					}
+					$this->updatePatronConsent($result['patronId'], strtolower($key), isset($_REQUEST['privacy_consent_' . strtolower($key)]));
 				}
 			}
-			
 		}
+
 		return $result;
 	}
 
@@ -6786,6 +6792,10 @@ public function getPluginStatus(string $pluginName) {
 		/** @noinspection SqlResolve */
 		$sql = "SELECT * FROM plugin_data WHERE plugin_class LIKE '%$pluginName';";
 		$results = mysqli_query($this->dbConnection, $sql);
+		$plugin = [
+			'installed' => 0,
+			'enabled' => 0,
+		];
 
 		if ($results !== false) {
 			while ($curRow = $results->fetch_assoc()) {
@@ -8396,6 +8406,44 @@ protected function getUserMessageTranslation($code, User $patron): array {
 		return $result;
 	}
 
+	public function areAnyConsentPluginsEnabled(): bool {
+		global $library;
+		$anyConsentPluginsEnabled = true;
+		$consentPluginNames = $this->getPluginNamesByMethodName('patron_consent_type');
+		foreach($consentPluginNames as $pluginName) {
+			$pluginStatus = $this->getPluginStatus($pluginName);
+			if ($library->ilsConsentEnabled && !$pluginStatus['enabled']) {
+				global $logger;
+				$statusDescription = $pluginStatus['installed'] ? 'disabled' : 'not installed';
+				$logger->log("Consent options could not be presented or recorded because the $pluginName plugin is $statusDescription", Logger::LOG_ERROR);
+				$anyConsentPluginsEnabled = false;
+				break;
+			} 
+		}
+		return $anyConsentPluginsEnabled;
+	}
+
+	public function getPluginNamesByMethodName(string $methodName): array|bool {
+		$this->initDatabaseConnection();
+		/** @noinspection SqlResolve */
+		$sql = 'SELECT plugin_class FROM plugin_methods WHERE plugin_method = "' . $methodName . '"';
+		$results = mysqli_query($this->dbConnection, $sql);
+		$pluginNames = [];
+
+		if ($results === false) {
+			global $logger;
+			$logger->log("Error loading plugins " . mysqli_error($this->dbConnection), Logger::LOG_ERROR);
+			return false;
+		}
+		while ($curRow = $results->fetch_assoc()) {
+			$pluginNames[] = $curRow['plugin_class'];
+		}
+		$results->close();
+
+		return $pluginNames;
+	}
+
+
 	public function getFormattedConsentTypes(): array {
 		$consentTypes = $this->getConsentTypes();
 		if (empty($consentTypes)) {
@@ -8412,6 +8460,7 @@ public function getFormattedConsentTypes(): array {
 				'allCapsCode' => $key,
 				'label' => $consentType['title']['en'],
 				'description' => $consentType['description']['en'],
+				'actionConsentedTo' => $consentType['title']['en'] == 'Newsletter' ? "receiving our Newsletter" : $consentType['title']['en'],
 			];
 		}
 		return $formattedConsentTypes;
@@ -8453,13 +8502,13 @@ public function getSelfRegistrationFormPrivacySection(): array {
 		return $privacySection;
 	}
 
-	public function updatePatronConsent(int $patronIlsId, string $consentType, $consentEnabled = false) {
+	public function updatePatronConsent(int $patronIlsId, string $consentType, $consentEnabled = false): array {
 		$result = ['success' => false,];
 
 		$oauthToken = $this->getOAuthToken();
 		if (!$oauthToken) {
 			$result['message'] = translate([
-				'text' => 'Unable to authenticate with the ILS.  Please try again later or contact the library.',
+				'text' => 'Unable to authenticate with the ILS. Please try again later or contact the library.',
 				'isPublicFacing' => true,
 			]);
 			return $result;
@@ -8502,7 +8551,7 @@ public function updatePatronConsent(int $patronIlsId, string $consentType, $cons
 		return $result;
 	}
 
-	public function getPatronConsents($patron) {
+	public function getPatronConsents($patron): array {	
 		$oauthToken = $this->getOAuthToken();
 		if (!$oauthToken) {
 			$result['message'] = translate([
@@ -8545,7 +8594,7 @@ public function getPatronConsents($patron) {
 
 	}
 
-	private function getConsentTypes() {
+	private function getConsentTypes(): array {
 		$oauthToken = $this->getOAuthToken();
 		if (!$oauthToken) {
 			return translate([
@@ -8585,4 +8634,8 @@ private function getConsentTypes() {
 			]);
 		}
 	}
+
+	public function hasIlsConsentSupport(): bool {
+		return true;
+	}
 }

code/web/interface/themes/responsive/MyAccount/myPrivacySettings.tpl

@@ -119,6 +119,7 @@
 					<input type="hidden" name="patronId" value={$profile->id|escape}>
 					{foreach $consentTypes as $consentType}
 						<section id="{$consentType['lowercaseCode']}ConsentSection">
+						<input type="hidden" name="updateScopeSection" value="{$consentType['lowercaseCode']}">
 							{$consentCode = $consentType['capitalisedCode']}
 							<h2>{translate text={$consentType['label']} isPublicFacing=true}</h2>
 							<div class="form-group #propertyRow" style="margin-bottom:10px;">
@@ -133,7 +134,7 @@
 								</div>
 							</div>
 							<div id="my{$consentCode}ConsentExplanation" style="display:none; margin-top: 10px;">
-									{translate text="By checking this box you are giving your consent to our {$consentType['label']}. Aspen Discovery will send your consent information to Koha, where it will be stored. You can return to this page to update your consent at any point."}
+									{translate text="By checking this box you are giving your consent to {$consentType['actionConsentedTo']}. You can return to this page to update your consent at any point."}
 							</div>
 						</section>
 					{/foreach}

code/web/release_notes/25.02.00.MD

@@ -25,14 +25,16 @@
 
 - For libraries that use Koha as their ILS, and use the koha-plugin-newsletter-consent plugin
   - Administrator with the permission to edit library settings will be able to toggle on/off the 'Enable ILS-issued consents' setting under the 'Data Protection Regulations' section. (*CZ*)
+    - if the Koha plugin has not been installed and enabled in Koha, then the 'Enable ILS-issued consents' setting will not appear as it requires the plugin to be installed and enabled. (*CZ*)
+    - if the Koha plugin is uninstalled or disabled in Koha while 'Enable ILS-issued consents' is toggled on, 'Enable ILS-issued consents' will still display. (*CZ*)
   - If 'Enable ILS-issued consents' is enabled:
     - the 'Privacy Settings' options will appear in patron side menus. (*CZ*)
     - In the self-registration form, under a ‘Privacy’ section, patrons need to see information about the consent types set by their library in Koha. For example, they may be given the opportunity to receive the library’s newsletter. (*CZ*)
     - Patrons will be able to choose to opt in, which implies that consent is not assumed by default. (*CZ*)
     - Patrons will be able to submit their consent along with their registration form. (*CZ*)
     - Patrons will be sent to Koha, where it is stored. (*CZ*)
     - Patrons will be able to view and change their consent information (as retrieved from Koha) at any point through the ‘Your Account > Privacy Settings ’ section. (*CZ*)
-
+    - If ILS consent is enabled in the Aspen settings, but the Koha plugin is disabled or uninstalled, patron will see an informative message in 'Privacy Settings'.  (*CZ*)
 //pedro
 
 // lucas

code/web/services/Admin/Libraries.php

@@ -70,6 +70,28 @@ function getObjectStructure($context = ''): array {
 		if (!UserAccount::userHasPermission('Administer All Libraries')) {
 			unset($objectStructure['isDefault']);
 		}
+		global $library;
+		$accountProfile = $library->getAccountProfile();
+		if (!$accountProfile || empty($accountProfile) || !isset($accountProfile->driver)) {
+			return $objectStructure;
+		}
+
+		// if 'Enable ILS-issued consents' is not already toggled on, prevent administrators from seeing it (and toggling it on) if no consent plugins are installed and enabled in Koha
+		$catalogDriver = CatalogFactory::getCatalogConnectionInstance(trim($accountProfile->driver), $accountProfile);
+		$consentPluginNames = $catalogDriver->getPluginNamesByMethodName('patron_consent_type');
+		$anyConsentPluginsEnabled = false;
+		foreach($consentPluginNames as $pluginName) {
+			$pluginStatus = $catalogDriver->getPluginStatus($pluginName);
+			if ($pluginStatus['enabled']) {
+				$anyConsentPluginsEnabled = true;
+				break;
+			}
+		}
+
+		if($catalogDriver->hasIlsConsentSupport() && !$anyConsentPluginsEnabled && $library->ilsConsentEnabled == 0) {
+			unset($objectStructure['dataProtectionRegulations']['properties']['ilsConsentEnabled']);
+		}
+		
 		return $objectStructure;
 	}
 

code/web/services/MyAccount/MyPrivacySettings.php

@@ -3,25 +3,48 @@
 require_once ROOT_DIR . '/services/MyAccount/MyAccount.php';
 
 class MyAccount_MyPrivacySettings extends MyAccount {
-	function launch() {
+	function launch(): void {
 		global $interface;
 		global $library;
 
 		if (!UserAccount::isLoggedIn()) {
 			$interface->assign('error', 'You must be logged in to access the Administration Interface');
-		} 
+		}
 
-		// Do not lauch this page if there is nothing to show
+		// Handles patrons attempting to access the page directly through the URL when the 'Privacy Settings' link is disabled and does not show
 		if (!$library->ilsConsentEnabled && !$library->cookieStorageConsent) {
 			header("Location: " . '/MyAccount');
 		}
+		
+		$user = UserAccount::getLoggedInUser();
+		$linkedUsers = $user->getLinkedUsers();
+		$driver = $user->getCatalogDriver();
+
+		$consentPluginNames = $driver->getPluginNamesByMethodName('patron_consent_type');
+		$anyConsentPluginsEnabled = false;
+
+		foreach($consentPluginNames as $pluginName) {
+			$pluginStatus = $driver->getPluginStatus($pluginName);
+			if ($library->ilsConsentEnabled && !$pluginStatus['enabled']) {
+				global $logger;
+				$statusDescription = $pluginStatus['installed'] ? 'disabled' : 'not installed';
+				$logger->log("Patrons Privacy Settings: Patrons cannot view and update their consents as the $pluginName plugin is $statusDescription", Logger::LOG_ERROR);
+	
+				$messages = [];
+				$messages[] = [
+					'message' => 'Other consent options are enabled but cannot be shown here due to a technical issue. Please contact your library.',
+					'messageStyle' => 'info',
+				];
+				$interface->assign('ilsMessages', $messages);
+				continue;
+			}
+			$anyConsentPluginsEnabled = true;
+		}
 
-		$interface->assign('ilsConsentEnabled', $library->ilsConsentEnabled);
+		$interface->assign('ilsConsentEnabled', $library->ilsConsentEnabled && $anyConsentPluginsEnabled);
 		$interface->assign('cookieConsentEnabled', $library->cookieStorageConsent);
 
 		//Determine which user we are showing/updating settings for
-		$user = UserAccount::getLoggedInUser();
-		$linkedUsers = $user->getLinkedUsers();
 		$patronId = isset($_REQUEST['patronId']) ? $_REQUEST['patronId'] : $user->id;
 		/** @var $patron */
 		$patronRefferedTo = $user->getUserReferredTo($patronId);
@@ -40,11 +63,10 @@ function launch() {
 		}
 
 		$action = $this->assignAction();
-		$driver = $user->getCatalogDriver();
-		$consentTypes = $library->ilsConsentEnabled ? $driver->getFormattedConsentTypes() : null;
+		$consentTypes = $library->ilsConsentEnabled && $anyConsentPluginsEnabled ? $driver->getFormattedConsentTypes() : null;
 
 		if ($action == 'save') {
-			$this->updatePrivacySettings($user, $patronRefferedTo, $driver, $library->ilsConsentEnabled, $consentTypes);
+			$this->updatePrivacySettings($user, $patronRefferedTo, $driver, $anyConsentPluginsEnabled, $consentTypes);
 			session_write_close();
 			$actionUrl = '/MyAccount/MyPrivacySettings' . ($patronRefferedTo->id == $user->id ? '': '?patronId=' . $patronId);
 			header("Location: " . $actionUrl);
@@ -60,7 +82,7 @@ function launch() {
 			$user->updateMessageIsError = 0;
 		}
 
-		if (!$library->ilsConsentEnabled) {
+		if (!$library->ilsConsentEnabled || !$anyConsentPluginsEnabled) {
 			$this->display('myPrivacySettings.tpl', 'My Privacy Settings');
 			return;
 		}
@@ -93,7 +115,7 @@ private function assignAction(): string {
 		return "";
 	}
 
-	private function updatePrivacySettings($user, $patronRefferedTo, $driver, $ilsConsentEnabled = null, $consentTypes = null): void {
+	private function updatePrivacySettings($user, $patronRefferedTo, $driver, $anyConsentPluginsEnabled = null, $consentTypes = null): void {
 		if ($_REQUEST['patronId'] != $user->id) {
 			$user->updateMessage = translate([
 				'text' => 'Wrong account credentials, please try again.',
@@ -111,10 +133,19 @@ private function updatePrivacySettings($user, $patronRefferedTo, $driver, $ilsCo
 		}
 
 		if ($_POST['updateScope'] === 'userILSIssuedConsent') {
-			if ($ilsConsentEnabled) {
-				foreach ($consentTypes as $consentType) {
-					$result = $driver->updatePatronConsent($patronRefferedTo->unique_ils_id, $consentType['allCapsCode'], isset($_POST['userNewsletter']));
-				}
+			$consentTypeName = $_REQUEST['updateScopeSection'];
+			if (!$anyConsentPluginsEnabled) {
+				global $logger;
+				$logger->log("Patrons Privacy Settings: Patron with id $patronRefferedTo->id could not update their $consentTypeName consent", Logger::LOG_ERROR);
+	
+				$user->updateMessage = translate([
+					'text' => 'Could not update consent due to a technical issue. Please contact your library',
+					'isPublicFacing' => true,
+				]);
+				$user->updateMessageIsError = true;
+			}
+			foreach ($consentTypes as $consentType) {
+				$result = $driver->updatePatronConsent($patronRefferedTo->unique_ils_id, $consentType['allCapsCode'], isset($_POST['userNewsletter']));
 			}
 		}
 		if (isset($result['message'])) {

code/web/sys/DBMaintenance/version_updates/25.02.00.php

@@ -24,6 +24,12 @@ function getUpdates25_02_00(): array {
 		//alexander - PTFS-Europe
 
 		//chloe - PTFS-Europe
+		'save_library_ils_consent_feature_toggle_value' => [
+			'title' => 'Save Library ILS Consent Feature Toggle Value',
+			'description' => 'Allows to record whether a library has enabled the ILS Consent feature or not',
+			'continueOnError' => false,
+			'sql' => ['ALTER TABLE library ADD COLUMN ilsConsentEnabled tinyint(1) DEFAULT 0'],
+		], //'save_library_ils_consent_feature_toggle_value'
 
 		//James Staub - Nashville Public Library
 

code/web/sys/LibraryLocation/Library.php

@@ -912,20 +912,6 @@ static function getObjectStructure($context = ''): array {
 			$validCardRenewalOptions[3] = 'Quipu eRenewal';
 		}
 
-		// prevent administrators from enabling the ILS consent integration if their ILS does not allow for it
-		$driverAllowsForIlsConsentTypes = true;
-		if (
-			$catalog == null ||
-			$catalog->driver == null ||
-			!method_exists($catalog->driver, 'getConsentTypes') || 
-			!method_exists($catalog->driver, 'getFormattedConsentTypes') || 
-			!method_exists($catalog->driver, 'getPatronConsents') || 
-			!method_exists($catalog->driver, 'getSelfRegistrationFormPrivacySection') ||
-			!method_exists($catalog->driver, 'updatePatronConsent')
-		) {
-			$driverAllowsForIlsConsentTypes = false;
-		}
-
 		/** @noinspection HtmlRequiredAltAttribute */
 		/** @noinspection RequiredAttributes */
 		$structure = [
@@ -4183,7 +4169,7 @@ static function getObjectStructure($context = ''): array {
 		if (!array_key_exists('Single sign-on', $enabledModules)) {
 			unset($structure['ssoSection']);
 		}
-		if (!$driverAllowsForIlsConsentTypes) {
+		if (!$catalog->hasIlsConsentSupport()) {
 			unset($structure['dataProtectionRegulations']['properties']['ilsConsentEnabled']);
 		}
 

install/aspen.sql

@@ -2779,7 +2779,6 @@ CREATE TABLE `library` (
   `eCommerceFee` varchar(11) DEFAULT '0',
   `eCommerceTerms` mediumtext DEFAULT NULL,
   `cookieStorageConsent` tinyint(1) DEFAULT 0,
-  `ilsConsentEnabled` tinyint(1) DEFAULT 0,
   `cookiePolicyHTML` text DEFAULT NULL,
   `openArchivesFacetSettingId` int(11) DEFAULT 1,
   `websiteIndexingFacetSettingId` int(11) DEFAULT 1,