class-groups.php
5 days ago
class-licenses.php
2 days ago
class-onboarding.php
1 year ago
class-page-quick-edit.php
2 days ago
class-placements.php
1 year ago
class-utilities.php
2 days ago
class-licenses.php
224 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Licenses Rest route and endpoints. |
| 4 | * |
| 5 | * @package AdvancedAds |
| 6 | * @author Advanced Ads <info@wpadvancedads.com> |
| 7 | * @since 1.50.0 |
| 8 | */ |
| 9 | |
| 10 | namespace AdvancedAds\Rest; |
| 11 | |
| 12 | use AdvancedAds\Admin\Plugin_Auto_Update; |
| 13 | use AdvancedAds\Constants; |
| 14 | use AdvancedAds\Framework\Interfaces\Routes_Interface; |
| 15 | use AdvancedAds\License\License; |
| 16 | use AdvancedAds\License\License_Utils; |
| 17 | use AdvancedAds\Utilities\Conditional; |
| 18 | use WP_Error; |
| 19 | use WP_REST_Request; |
| 20 | use WP_REST_Server; |
| 21 | |
| 22 | defined( 'ABSPATH' ) || exit; |
| 23 | |
| 24 | /** |
| 25 | * Rest Licenses. |
| 26 | */ |
| 27 | class Licenses implements Routes_Interface { |
| 28 | /** |
| 29 | * Registers routes with WordPress. |
| 30 | * |
| 31 | * @return void |
| 32 | */ |
| 33 | public function register_routes(): void { |
| 34 | register_rest_route( |
| 35 | Constants::REST_BASE, |
| 36 | '/licenses', |
| 37 | [ |
| 38 | [ |
| 39 | 'methods' => WP_REST_Server::READABLE, |
| 40 | 'callback' => [ $this, 'get_licenses' ], |
| 41 | 'permission_callback' => [ $this, 'can_manage' ], |
| 42 | ], |
| 43 | [ |
| 44 | 'methods' => WP_REST_Server::CREATABLE, |
| 45 | 'callback' => [ $this, 'set_licenses' ], |
| 46 | 'permission_callback' => [ $this, 'can_manage' ], |
| 47 | 'args' => [ |
| 48 | 'licenses' => [ |
| 49 | 'required' => true, |
| 50 | 'type' => 'array', |
| 51 | ], |
| 52 | 'activate' => [ |
| 53 | 'required' => false, |
| 54 | 'type' => 'boolean', |
| 55 | 'default' => false, |
| 56 | ], |
| 57 | 'activatingLicenseKey' => [ |
| 58 | 'required' => false, |
| 59 | 'type' => 'string', |
| 60 | 'default' => '', |
| 61 | ], |
| 62 | 'activatingAddonId' => [ |
| 63 | 'required' => false, |
| 64 | 'type' => 'string', |
| 65 | 'default' => '', |
| 66 | ], |
| 67 | 'installOnly' => [ |
| 68 | 'required' => false, |
| 69 | 'type' => 'boolean', |
| 70 | 'default' => false, |
| 71 | ], |
| 72 | 'deactivatingAddonId' => [ |
| 73 | 'required' => false, |
| 74 | 'type' => 'string', |
| 75 | 'default' => '', |
| 76 | ], |
| 77 | 'deactivatingLicenseKey' => [ |
| 78 | 'required' => false, |
| 79 | 'type' => 'string', |
| 80 | 'default' => '', |
| 81 | ], |
| 82 | ], |
| 83 | ], |
| 84 | ] |
| 85 | ); |
| 86 | |
| 87 | register_rest_route( |
| 88 | Constants::REST_BASE, |
| 89 | '/plugin-autoupdate', |
| 90 | [ |
| 91 | 'methods' => WP_REST_Server::CREATABLE, |
| 92 | 'callback' => [ $this, 'set_plugin_autoupdate' ], |
| 93 | 'permission_callback' => [ $this, 'can_manage' ], |
| 94 | 'args' => [ |
| 95 | 'addonId' => [ |
| 96 | 'required' => false, |
| 97 | 'type' => 'string', |
| 98 | 'default' => Plugin_Auto_Update::MAIN_ADDON_KEY, |
| 99 | ], |
| 100 | 'state' => [ |
| 101 | 'required' => true, |
| 102 | 'type' => 'string', |
| 103 | 'enum' => [ Plugin_Auto_Update::STATE_ON, Plugin_Auto_Update::STATE_OFF ], |
| 104 | ], |
| 105 | ], |
| 106 | ] |
| 107 | ); |
| 108 | } |
| 109 | |
| 110 | /** |
| 111 | * Permission callback. |
| 112 | * |
| 113 | * @return bool |
| 114 | */ |
| 115 | public function can_manage(): bool { |
| 116 | return Conditional::user_can( 'advanced_ads_manage_options' ); |
| 117 | } |
| 118 | |
| 119 | /** |
| 120 | * Get persisted licenses. |
| 121 | * |
| 122 | * @return array |
| 123 | */ |
| 124 | public function get_licenses(): array { |
| 125 | License::maybe_complete_legacy_license_migration(); |
| 126 | |
| 127 | $rich = License::get_licenses(); |
| 128 | |
| 129 | // Passive reconcile on read: mirror addon status only; never reshuffle activations. |
| 130 | $rich = License::reconcile_persisted_licenses( $rich, false, false ); |
| 131 | $rich = License::finalize_license_sync( $rich ); |
| 132 | |
| 133 | return $this->licenses_api_response( $rich ); |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Persist licenses. |
| 138 | * |
| 139 | * @param WP_REST_Request $request the request object. |
| 140 | * |
| 141 | * @return array|WP_Error |
| 142 | */ |
| 143 | public function set_licenses( WP_REST_Request $request ) { |
| 144 | $licenses = $request->get_param( 'licenses' ); |
| 145 | $licenses = is_array( $licenses ) ? $licenses : []; |
| 146 | $licenses = wp_unslash( $licenses ); |
| 147 | |
| 148 | $activate = (bool) $request->get_param( 'activate' ); |
| 149 | $activating_license_key = (string) $request->get_param( 'activatingLicenseKey' ); |
| 150 | $activating_license_key = sanitize_text_field( $activating_license_key ); |
| 151 | $activating_addon_id = (string) $request->get_param( 'activatingAddonId' ); |
| 152 | $activating_addon_id = sanitize_key( $activating_addon_id ); |
| 153 | $install_only = (bool) $request->get_param( 'installOnly' ); |
| 154 | $deactivating_addon_id = (string) $request->get_param( 'deactivatingAddonId' ); |
| 155 | $deactivating_addon_id = sanitize_key( $deactivating_addon_id ); |
| 156 | $deactivating_license_key = (string) $request->get_param( 'deactivatingLicenseKey' ); |
| 157 | $deactivating_license_key = sanitize_text_field( $deactivating_license_key ); |
| 158 | |
| 159 | $rich = License::save_licenses( |
| 160 | $licenses, |
| 161 | $activate, |
| 162 | $activating_license_key, |
| 163 | $activating_addon_id, |
| 164 | $install_only, |
| 165 | $deactivating_addon_id, |
| 166 | $deactivating_license_key |
| 167 | ); |
| 168 | |
| 169 | if ( is_wp_error( $rich ) ) { |
| 170 | return $rich; |
| 171 | } |
| 172 | |
| 173 | return $this->licenses_api_response( $rich ); |
| 174 | } |
| 175 | |
| 176 | /** |
| 177 | * Toggle per-plugin auto-update (advanced-ads-{addon}-autoupdate). |
| 178 | * |
| 179 | * @param WP_REST_Request $request Request. |
| 180 | * @return array|WP_Error |
| 181 | */ |
| 182 | public function set_plugin_autoupdate( WP_REST_Request $request ) { |
| 183 | $addon_id = (string) $request->get_param( 'addonId' ); |
| 184 | $state = (string) $request->get_param( 'state' ); |
| 185 | |
| 186 | $normalized = Plugin_Auto_Update::MAIN_ADDON_KEY === $addon_id || '' === $addon_id |
| 187 | ? null |
| 188 | : sanitize_key( $addon_id ); |
| 189 | |
| 190 | $result = Plugin_Auto_Update::set_state( $normalized, $state ); |
| 191 | |
| 192 | if ( is_wp_error( $result ) ) { |
| 193 | return $result; |
| 194 | } |
| 195 | |
| 196 | $response_key = null === $normalized ? Plugin_Auto_Update::MAIN_ADDON_KEY : $normalized; |
| 197 | |
| 198 | return [ |
| 199 | 'addonId' => $response_key, |
| 200 | 'state' => Plugin_Auto_Update::get_state( $normalized ), |
| 201 | 'autoUpdateStates' => Plugin_Auto_Update::get_all_states(), |
| 202 | ]; |
| 203 | } |
| 204 | |
| 205 | /** |
| 206 | * REST payload: rich rows plus legacy addon key map (advanced-ads-licenses). |
| 207 | * |
| 208 | * @param array<int, array<string, mixed>> $rich Rich license list. |
| 209 | * @return array{licenses: array<int, array<string, mixed>>, appliedAddonKeyMap: array<string, string>} |
| 210 | */ |
| 211 | private function licenses_api_response( array $rich ): array { |
| 212 | $rich = License::normalize_rich_license_list( $rich ); |
| 213 | |
| 214 | return [ |
| 215 | 'licenses' => $rich, |
| 216 | 'appliedAddonKeyMap' => License::get_addon_key_map(), |
| 217 | 'autoUpdateStates' => Plugin_Auto_Update::get_all_states(), |
| 218 | 'addonInstallStates' => License::get_addon_install_states(), |
| 219 | 'lastSyncAt' => License_Utils::get_last_sync(), |
| 220 | 'expiryNoticeFlags' => License_Utils::get_expiry_notice_flags(), |
| 221 | ]; |
| 222 | } |
| 223 | } |
| 224 |