RegisterDonationRoutes.php
226 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\API\REST\V3\Routes\Donations; |
| 4 | |
| 5 | use Give\API\REST\V3\Routes\Donations\ValueObjects\DonationAnonymousMode; |
| 6 | use Give\API\REST\V3\Routes\Donations\ValueObjects\DonationRoute; |
| 7 | use Give\Donations\Controllers\DonationRequestController; |
| 8 | use WP_Error; |
| 9 | use WP_REST_Request; |
| 10 | use WP_REST_Server; |
| 11 | |
| 12 | /** |
| 13 | * @since 4.0.0 |
| 14 | */ |
| 15 | class RegisterDonationRoutes |
| 16 | { |
| 17 | /** |
| 18 | * @var DonationRequestController |
| 19 | */ |
| 20 | protected $donationRequestController; |
| 21 | |
| 22 | /** |
| 23 | * @since 4.0.0 |
| 24 | */ |
| 25 | public function __construct(DonationRequestController $donationRequestController) |
| 26 | { |
| 27 | $this->donationRequestController = $donationRequestController; |
| 28 | } |
| 29 | |
| 30 | /** |
| 31 | * @since 4.0.0 |
| 32 | */ |
| 33 | public function __invoke() |
| 34 | { |
| 35 | $this->registerGetDonation(); |
| 36 | $this->registerGetDonations(); |
| 37 | } |
| 38 | |
| 39 | /** |
| 40 | * Get Donation route |
| 41 | * |
| 42 | * @since 4.0.0 |
| 43 | */ |
| 44 | public function registerGetDonation() |
| 45 | { |
| 46 | register_rest_route( |
| 47 | DonationRoute::NAMESPACE, |
| 48 | DonationRoute::DONATION, |
| 49 | [ |
| 50 | [ |
| 51 | 'methods' => WP_REST_Server::READABLE, |
| 52 | 'callback' => function (WP_REST_Request $request) { |
| 53 | return $this->donationRequestController->getDonation($request); |
| 54 | }, |
| 55 | 'permission_callback' => function (WP_REST_Request $request) { |
| 56 | return $this->permissionsCheck($request); |
| 57 | }, |
| 58 | ], |
| 59 | 'args' => [ |
| 60 | 'id' => [ |
| 61 | 'type' => 'integer', |
| 62 | 'required' => true, |
| 63 | ], |
| 64 | 'includeSensitiveData' => [ |
| 65 | 'type' => 'boolean', |
| 66 | 'default' => false, |
| 67 | ], |
| 68 | 'anonymousDonations' => [ |
| 69 | 'type' => 'string', |
| 70 | 'default' => 'exclude', |
| 71 | 'enum' => [ |
| 72 | 'exclude', |
| 73 | 'include', |
| 74 | 'redact', |
| 75 | ], |
| 76 | ], |
| 77 | ], |
| 78 | ] |
| 79 | ); |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * Get Donations route |
| 84 | * |
| 85 | * @since 4.4.0 add status parameter. |
| 86 | * @since 4.0.0 |
| 87 | */ |
| 88 | public function registerGetDonations() |
| 89 | { |
| 90 | register_rest_route( |
| 91 | DonationRoute::NAMESPACE, |
| 92 | DonationRoute::DONATIONS, |
| 93 | [ |
| 94 | [ |
| 95 | 'methods' => WP_REST_Server::READABLE, |
| 96 | 'callback' => function (WP_REST_Request $request) { |
| 97 | return $this->donationRequestController->getDonations($request); |
| 98 | }, |
| 99 | 'permission_callback' => function (WP_REST_Request $request) { |
| 100 | return $this->permissionsCheck($request); |
| 101 | }, |
| 102 | ], |
| 103 | 'args' => [ |
| 104 | 'page' => [ |
| 105 | 'type' => 'integer', |
| 106 | 'default' => 1, |
| 107 | 'minimum' => 1, |
| 108 | ], |
| 109 | 'per_page' => [ |
| 110 | 'type' => 'integer', |
| 111 | 'default' => 30, |
| 112 | 'minimum' => 1, |
| 113 | 'maximum' => 100, |
| 114 | ], |
| 115 | 'sort' => [ |
| 116 | 'type' => 'string', |
| 117 | 'default' => 'id', |
| 118 | 'enum' => [ |
| 119 | 'id', |
| 120 | 'createdAt', |
| 121 | 'updatedAt', |
| 122 | 'status', |
| 123 | 'amount', |
| 124 | 'feeAmountRecovered', |
| 125 | 'donorId', |
| 126 | 'firstName', |
| 127 | 'lastName', |
| 128 | ], |
| 129 | ], |
| 130 | 'direction' => [ |
| 131 | 'type' => 'string', |
| 132 | 'default' => 'DESC', |
| 133 | 'enum' => ['ASC', 'DESC'], |
| 134 | ], |
| 135 | 'mode' => [ |
| 136 | 'type' => 'string', |
| 137 | 'default' => 'live', |
| 138 | 'enum' => ['live', 'test'], |
| 139 | ], |
| 140 | 'status' => [ |
| 141 | 'type' => 'array', |
| 142 | 'items' => [ |
| 143 | 'type' => 'string', |
| 144 | 'enum' => [ |
| 145 | 'any', |
| 146 | 'publish', |
| 147 | 'give_subscription', |
| 148 | 'pending', |
| 149 | 'processing', |
| 150 | 'refunded', |
| 151 | 'revoked', |
| 152 | 'failed', |
| 153 | 'cancelled', |
| 154 | 'abandoned', |
| 155 | 'preapproval' |
| 156 | ], |
| 157 | ], |
| 158 | 'default' => ['any'], |
| 159 | ], |
| 160 | 'campaignId' => [ |
| 161 | 'type' => 'integer', |
| 162 | 'default' => 0, |
| 163 | ], |
| 164 | 'donorId' => [ |
| 165 | 'type' => 'integer', |
| 166 | 'default' => 0, |
| 167 | ], |
| 168 | 'includeSensitiveData' => [ |
| 169 | 'type' => 'boolean', |
| 170 | 'default' => false, |
| 171 | ], |
| 172 | 'anonymousDonations' => [ |
| 173 | 'type' => 'string', |
| 174 | 'default' => 'exclude', |
| 175 | 'enum' => [ |
| 176 | 'exclude', |
| 177 | 'include', |
| 178 | 'redact', |
| 179 | ], |
| 180 | ], |
| 181 | ], |
| 182 | ] |
| 183 | ); |
| 184 | } |
| 185 | |
| 186 | /** |
| 187 | * @since 4.0.0 |
| 188 | */ |
| 189 | public function permissionsCheck(WP_REST_Request $request) |
| 190 | { |
| 191 | $isAdmin = current_user_can('manage_options'); |
| 192 | |
| 193 | $includeSensitiveData = $request->get_param('includeSensitiveData'); |
| 194 | if ( ! $isAdmin && $includeSensitiveData) { |
| 195 | return new WP_Error( |
| 196 | 'rest_forbidden', |
| 197 | esc_html__('You do not have permission to include sensitive data.', 'give'), |
| 198 | ['status' => $this->authorizationStatusCode()] |
| 199 | ); |
| 200 | } |
| 201 | |
| 202 | $donationAnonymousMode = new DonationAnonymousMode($request->get_param('anonymousDonations')); |
| 203 | if ( ! $isAdmin && $donationAnonymousMode->isIncluded()) { |
| 204 | return new WP_Error( |
| 205 | 'rest_forbidden', |
| 206 | esc_html__('You do not have permission to include anonymous donations.', 'give'), |
| 207 | ['status' => $this->authorizationStatusCode()] |
| 208 | ); |
| 209 | } |
| 210 | |
| 211 | return true; |
| 212 | } |
| 213 | |
| 214 | /** |
| 215 | * @since 4.0.0 |
| 216 | */ |
| 217 | public function authorizationStatusCode(): int |
| 218 | { |
| 219 | if (is_user_logged_in()) { |
| 220 | return 403; |
| 221 | } |
| 222 | |
| 223 | return 401; |
| 224 | } |
| 225 | } |
| 226 |