refactor: Filter campaigns for users - add age range

Alter filter to display campaigns for which the user meets the search
criteria and add the ability to filter the returned campaigns by age
range.

Author: AlexanderBlanchardAC

code/web/Drivers/Koha.php

@@ -1107,7 +1107,7 @@ private function loadPatronInfoFromDB($patronId, $password, $suppliedUsernameOrB
 		global $logger;
 
 		/** @noinspection SqlResolve */
-		$sql = "SELECT borrowernumber, cardnumber, surname, firstname, streetnumber, streettype, address, address2, city, state, zipcode, country, email, phone, mobile, categorycode, dateexpiry, password, userid, branchcode, opacnote, privacy from borrowers where borrowernumber = '" . mysqli_escape_string($this->dbConnection, $patronId) . "';";
+		$sql = "SELECT borrowernumber, cardnumber, surname, firstname, streetnumber, streettype, address, address2, city, state, zipcode, country, email, phone, mobile, categorycode, dateexpiry, password, userid, branchcode, opacnote, privacy, dateofbirth from borrowers where borrowernumber = '" . mysqli_escape_string($this->dbConnection, $patronId) . "';";
 
 		$userExistsInDB = false;
 		$lookupUserResult = mysqli_query($this->dbConnection, $sql, MYSQLI_USE_RESULT);
@@ -1229,6 +1229,7 @@ private function loadPatronInfoFromDB($patronId, $password, $suppliedUsernameOrB
 			$user->ils_password = $password;
 			$user->email = $userFromDb['email'];
 			$user->patronType = $userFromDb['categorycode'];
+			$user->dateOfBirth = $userFromDb['dateofbirth'];
 
 			$user->_address1 = trim($userFromDb['streetnumber'] . ' ' . $userFromDb['address']);
 			$user->_address2 = $userFromDb['address2'];

code/web/sys/Account/User.php

@@ -52,6 +52,7 @@ class User extends DataObject {
 	public $userCookiePreferenceLocalAnalytics;
 	public $holdInfoLastLoaded;
 	public $checkoutInfoLastLoaded;
+	public $dateOfBirth;
 
 	public $onboardAppNotifications;
 	public $shouldAskBrightness;
@@ -3068,6 +3069,24 @@ public function getPTypeObj(): ?PType {
 		return $this->_pTypeObj;
 	}
 
+	/**
+	 * Get the user's age based on their date of birth.
+	 * 
+	 * @return int|null The user's age or null if date of birth is not set.
+	*/
+	public function getAge(): ?int {
+		if (empty($this->dateOfBirth)) {
+			return null;
+		}
+
+		$dob = new DateTime($this->dateOfBirth);
+		$today = new DateTime();
+
+		$age = $dob->diff($today)->y;
+
+		return $age;
+	}
+
 	public function updatePatronInfo($canUpdateContactInfo, $fromMasquerade = false) {
 		$result = $this->getCatalogDriver()->updatePatronInfo($this, $canUpdateContactInfo, $fromMasquerade);
 		$this->clearCache();

code/web/sys/Community/Campaign.php

@@ -20,6 +20,7 @@ class Campaign extends DataObject {
     public $unenrollmentCounter;
     public $currentEnrollments;
     public $campaignReward;
+    public $userAgeRange;
 
     /** @var AvailableMilestones[] */
     private $_availableMilestones;
@@ -111,6 +112,15 @@ public static function getObjectStructure($context = ''): array {
 				'values' => $libraryList,
 				'hideInLists' => false,
 			],
+            'userAgeRange' => [
+                'property' => 'userAgeRange',
+                'type' => 'text',
+                'label' => 'User Age Range',
+                'description' => 'Define the age range for this campaign e.g. "14-18", "14+", "All Ages")',
+                'default' => 'All Ages',
+                'maxLength' => 255,
+                'hideInLists' => false,
+            ],
         ];
     }
 
@@ -349,10 +359,24 @@ public function find($fetchFirst = false, $requireOneMatchToReturn = true): bool
         if (!UserAccount::isLoggedIn() || UserAccount::getActiveUserObj()->isAspenAdminUser())
             return parent::find($fetchFirst, $requireOneMatchToReturn);
 
-        $this->joinAdd(new CampaignPatronTypeAccess(), 'INNER', 'ce_campaign_patron_type_access', 'id', 'campaignId');
-        $this->whereAdd("ce_campaign_patron_type_access.patronTypeId = '" . UserAccount::getActiveUserObj()->getPTypeObj()->id . "'");
-        $this->joinAdd(new CampaignLibraryAccess(), 'INNER', 'ce_campaign_library_access', 'id', 'campaignId');
-        $this->whereAdd("ce_campaign_library_access.libraryId = '" . UserAccount::getActiveUserObj()->getHomeLibrary()->libraryId . "'");
+        $this->joinAdd(new CampaignPatronTypeAccess(), 'LEFT', 'ce_campaign_patron_type_access', 'id', 'campaignId');
+        $this->whereAdd("ce_campaign_patron_type_access.patronTypeId = '" . UserAccount::getActiveUserObj()->getPTypeObj()->id . "' OR ce_campaign_patron_type_access.patronTypeId IS NULL");
+        $this->joinAdd(new CampaignLibraryAccess(), 'LEFT', 'ce_campaign_library_access', 'id', 'campaignId');
+        $this->whereAdd("ce_campaign_library_access.libraryId = '" . UserAccount::getActiveUserObj()->getHomeLibrary()->libraryId . "' OR NOT EXISTS (SELECT 1 FROM ce_campaign_library_access WHERE ce_campaign_library_access.campaignId = ce_campaign.id)");
+        $userAge = (int)UserAccount::getActiveUserObj()->getAge();
+        $ageCondition = "(
+            userAgeRange IS NULL OR
+            userAgeRange = '' OR
+            userAgeRange = 'All Ages' OR
+            (userAgeRange LIKE 'Under %' AND $userAge < CAST(SUBSTRING_INDEX(userAgeRange, ' ', -1) AS UNSIGNED)) OR
+            (userAgeRange LIKE 'Over %' AND $userAge > CAST(SUBSTRING_INDEX(userAgeRange, ' ', -1) AS UNSIGNED)) OR
+            (userAgeRange LIKE '%+' AND $userAge >= CAST(LEFT(userAgeRange, LOCATE('+', userAgeRange) -1) AS UNSIGNED)) OR
+            (userAgeRange LIKE '%-%' AND $userAge BETWEEN
+                CAST(LEFT(userAgeRange, LOCATE('-', userAgeRange) -1) AS UNSIGNED) AND
+                CAST(SUBSTRING_INDEX(userAgeRange, '-', -1) AS UNSIGNED)
+            )
+        )";
+        $this->whereAdd($ageCondition);
         return parent::find($fetchFirst, $requireOneMatchToReturn);
 	}
 

code/web/sys/DBMaintenance/community_engagement_updates.php

@@ -296,5 +296,19 @@ function getCommunityEngagementUpdates() {
                 "INSERT INTO role_permissions(roleId, permissionId) VALUES ((SELECT roleId from roles where name='opacAdmin'), (SELECT id from permissions where name='Administer Community Module'))"
             ],
         ],
+        'add_date_of_birth_to_user' => [
+            'title' => 'Add Date Of Birth To User',
+            'description' => 'Add the date of birth to the user object',
+            'sql' => [
+                "ALTER TABLE user ADD COLUMN dateOfBirth DATE"
+            ],
+        ],
+        'add_user_age_range_to_campaign' => [
+            'title' => 'Add User Age Range To Campaign',
+            'description' => 'Add an ange range to the campaign',
+            'sql' => [
+                "ALTER TABLE ce_campaign ADD COLUMN userAgeRange VARCHAR(255) DEFAULT 'All Ages'"
+            ],
+        ],
     ];
 }