LicenseRepository.php
229 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\License\Repositories; |
| 4 | |
| 5 | use Give\License\DataTransferObjects\License; |
| 6 | use Give\License\ValueObjects\LicenseOptionKeys; |
| 7 | |
| 8 | /** |
| 9 | * @since 4.3.0 |
| 10 | */ |
| 11 | class LicenseRepository |
| 12 | { |
| 13 | /** |
| 14 | * Check if we have stored licenses in the database. |
| 15 | * |
| 16 | * @since 4.3.0 |
| 17 | */ |
| 18 | public function hasStoredLicenses(): bool |
| 19 | { |
| 20 | return !empty($this->getStoredLicenses()); |
| 21 | } |
| 22 | |
| 23 | /** |
| 24 | * Gets the raw, stored licenses from the database. |
| 25 | * |
| 26 | * @since 4.3.0 |
| 27 | */ |
| 28 | public function getStoredLicenses(): array |
| 29 | { |
| 30 | return (array)get_option(LicenseOptionKeys::LICENSES, []); |
| 31 | } |
| 32 | |
| 33 | /** |
| 34 | * Gets the stored licenses from the database and converts them to License objects. |
| 35 | * |
| 36 | * @since 4.3.0 |
| 37 | * @return License[] |
| 38 | */ |
| 39 | public function getLicenses(): array |
| 40 | { |
| 41 | if (!$this->hasStoredLicenses()) { |
| 42 | return []; |
| 43 | } |
| 44 | |
| 45 | $storedLicenses = $this->getStoredLicenses(); |
| 46 | $licenses = []; |
| 47 | |
| 48 | foreach ($storedLicenses as $license) { |
| 49 | $licenses[] = License::fromData($license); |
| 50 | } |
| 51 | |
| 52 | return $licenses; |
| 53 | } |
| 54 | |
| 55 | /** |
| 56 | * Returns only the active licenses. |
| 57 | * |
| 58 | * @since 4.3.0 |
| 59 | */ |
| 60 | public function getActiveLicenses(): array |
| 61 | { |
| 62 | if (!$this->hasStoredLicenses()) { |
| 63 | return []; |
| 64 | } |
| 65 | |
| 66 | $licenses = $this->getLicenses(); |
| 67 | |
| 68 | return array_filter($licenses, static function(License $license) { |
| 69 | return $license->isActive; |
| 70 | }); |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Checks if we have any active licenses. |
| 75 | * |
| 76 | * @since 4.3.0 |
| 77 | */ |
| 78 | public function hasActiveLicenses(): bool |
| 79 | { |
| 80 | if (!$this->hasStoredLicenses()) { |
| 81 | return false; |
| 82 | } |
| 83 | |
| 84 | $activeLicenses = $this->getActiveLicenses(); |
| 85 | |
| 86 | return !empty($activeLicenses); |
| 87 | } |
| 88 | |
| 89 | /** |
| 90 | * The platform fee percentage is used by gateways to calculate a platform fee. |
| 91 | * |
| 92 | * @since 4.8.0 add grace period |
| 93 | * @since 4.3.0 |
| 94 | */ |
| 95 | public function getPlatformFeePercentage(): float |
| 96 | { |
| 97 | if (!$this->hasActiveLicenses()) { |
| 98 | |
| 99 | if ($this->isLicenseInGracePeriod()) { |
| 100 | return 0.0; |
| 101 | } |
| 102 | |
| 103 | return 2.0; |
| 104 | } |
| 105 | |
| 106 | if (!$this->hasStoredPlatformFeePercentage()) { |
| 107 | return 0.0; |
| 108 | } |
| 109 | |
| 110 | return $this->getStoredPlatformFeePercentage(); |
| 111 | } |
| 112 | |
| 113 | /** |
| 114 | * Check if licenses are in the grace period. |
| 115 | * |
| 116 | * @since 4.8.0 |
| 117 | */ |
| 118 | private function isLicenseInGracePeriod(): bool |
| 119 | { |
| 120 | $currentTime = current_time('timestamp', true); |
| 121 | $lastActiveDate = $this->getLastActiveLicenseDate(); |
| 122 | |
| 123 | if ($lastActiveDate && $currentTime <= $lastActiveDate + $this->getGracePeriodInSeconds()) { |
| 124 | return true; |
| 125 | } |
| 126 | |
| 127 | return false; |
| 128 | } |
| 129 | |
| 130 | /** |
| 131 | * Returns the current timestamp if at least one active license is present. |
| 132 | * This is used to track the moment a license was last confirmed active, |
| 133 | * |
| 134 | * @since 4.8.0 |
| 135 | */ |
| 136 | public function getCurrentActiveLicenseDate(): ?int |
| 137 | { |
| 138 | if (!$this->hasActiveLicenses()) { |
| 139 | return null; |
| 140 | } |
| 141 | |
| 142 | $currentTime = current_time('timestamp', true); |
| 143 | |
| 144 | return $currentTime; |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * Retrieves the timestamp of when a license was last active. |
| 149 | * |
| 150 | * @since 4.8.0 |
| 151 | */ |
| 152 | public function getLastActiveLicenseDate(): ?int |
| 153 | { |
| 154 | $value = get_option(LicenseOptionKeys::LAST_ACTIVE_LICENSE_DATE); |
| 155 | return $value ?: null; |
| 156 | } |
| 157 | |
| 158 | /** |
| 159 | * Grace period is 30 days after the last active license date with a 3 day buffer for the refresh system. |
| 160 | * |
| 161 | * @since 4.8.0 |
| 162 | */ |
| 163 | public function getGracePeriodInSeconds(): ?int |
| 164 | { |
| 165 | return 33 * DAY_IN_SECONDS; |
| 166 | } |
| 167 | |
| 168 | /** |
| 169 | * Check if we have an available platform fee percentage set. |
| 170 | * This can be used to determine if we can charge a platform fee. |
| 171 | * |
| 172 | * @since 4.3.0 |
| 173 | */ |
| 174 | public function hasPlatformFeePercentage(): bool |
| 175 | { |
| 176 | return $this->getPlatformFeePercentage() > 0; |
| 177 | } |
| 178 | |
| 179 | /** |
| 180 | * The stored platform fee percentage comes from License Server API. |
| 181 | * When licenses are activated and refreshed, this value is stored in the database. |
| 182 | * |
| 183 | * @since 4.3.0 |
| 184 | */ |
| 185 | public function getStoredPlatformFeePercentage(): ?float |
| 186 | { |
| 187 | if (!get_option(LicenseOptionKeys::PLATFORM_FEE_PERCENTAGE)) { |
| 188 | return null; |
| 189 | } |
| 190 | |
| 191 | return (float)get_option(LicenseOptionKeys::PLATFORM_FEE_PERCENTAGE); |
| 192 | } |
| 193 | |
| 194 | /** |
| 195 | * Check if we have a stored platform fee percentage. |
| 196 | * |
| 197 | * @since 4.3.0 |
| 198 | */ |
| 199 | public function hasStoredPlatformFeePercentage(): bool |
| 200 | { |
| 201 | return !is_null($this->getStoredPlatformFeePercentage()); |
| 202 | } |
| 203 | |
| 204 | /** |
| 205 | * Find the lowest platform fee percentage from active licenses. |
| 206 | * Since there can be multiple licenses, we need to find the lowest fee from all active licenses. |
| 207 | * Once we have the lowest fee, we store it in the database for future use. |
| 208 | * |
| 209 | * @since 4.3.0 |
| 210 | */ |
| 211 | public function findLowestPlatformFeePercentageFromActiveLicenses(): ?float |
| 212 | { |
| 213 | if (!$this->hasActiveLicenses()) { |
| 214 | return null; |
| 215 | } |
| 216 | |
| 217 | $fees = array_map(static function(License $license) { |
| 218 | return $license->gatewayFee; |
| 219 | |
| 220 | }, $this->getActiveLicenses()); |
| 221 | |
| 222 | if (empty($fees)) { |
| 223 | return null; |
| 224 | } |
| 225 | |
| 226 | return (float)min($fees); |
| 227 | } |
| 228 | } |
| 229 |