woocommerce /
woocommerce-rest-api
| Total Complexity | 89 |
| Total Lines | 1160 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like WC_REST_System_Status_V2_Controller often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use WC_REST_System_Status_V2_Controller, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 19 | class WC_REST_System_Status_V2_Controller extends WC_REST_Controller { |
||
| 20 | |||
| 21 | /** |
||
| 22 | * Endpoint namespace. |
||
| 23 | * |
||
| 24 | * @var string |
||
| 25 | */ |
||
| 26 | protected $namespace = 'wc/v2'; |
||
| 27 | |||
| 28 | /** |
||
| 29 | * Route base. |
||
| 30 | * |
||
| 31 | * @var string |
||
| 32 | */ |
||
| 33 | protected $rest_base = 'system_status'; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * Register the route for /system_status |
||
| 37 | */ |
||
| 38 | public function register_routes() { |
||
| 39 | register_rest_route( |
||
| 40 | $this->namespace, |
||
| 41 | '/' . $this->rest_base, |
||
| 42 | array( |
||
| 43 | array( |
||
| 44 | 'methods' => WP_REST_Server::READABLE, |
||
| 45 | 'callback' => array( $this, 'get_items' ), |
||
| 46 | 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
||
| 47 | 'args' => $this->get_collection_params(), |
||
| 48 | ), |
||
| 49 | 'schema' => array( $this, 'get_public_item_schema' ), |
||
| 50 | ) |
||
| 51 | ); |
||
| 52 | } |
||
| 53 | |||
| 54 | /** |
||
| 55 | * Check whether a given request has permission to view system status. |
||
| 56 | * |
||
| 57 | * @param WP_REST_Request $request Full details about the request. |
||
| 58 | * @return WP_Error|boolean |
||
| 59 | */ |
||
| 60 | public function get_items_permissions_check( $request ) { |
||
| 61 | if ( ! wc_rest_check_manager_permissions( 'system_status', 'read' ) ) { |
||
| 62 | return new WP_Error( 'woocommerce_rest_cannot_view', __( 'Sorry, you cannot list resources.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) ); |
||
| 63 | } |
||
| 64 | return true; |
||
| 65 | } |
||
| 66 | |||
| 67 | /** |
||
| 68 | * Get a system status info, by section. |
||
| 69 | * |
||
| 70 | * @param WP_REST_Request $request Full details about the request. |
||
| 71 | * @return WP_Error|WP_REST_Response |
||
| 72 | */ |
||
| 73 | public function get_items( $request ) { |
||
| 74 | $schema = $this->get_item_schema(); |
||
| 75 | $mappings = $this->get_item_mappings(); |
||
| 76 | $response = array(); |
||
| 77 | |||
| 78 | foreach ( $mappings as $section => $values ) { |
||
| 79 | foreach ( $values as $key => $value ) { |
||
| 80 | if ( isset( $schema['properties'][ $section ]['properties'][ $key ]['type'] ) ) { |
||
| 81 | settype( $values[ $key ], $schema['properties'][ $section ]['properties'][ $key ]['type'] ); |
||
| 82 | } |
||
| 83 | } |
||
| 84 | settype( $values, $schema['properties'][ $section ]['type'] ); |
||
| 85 | $response[ $section ] = $values; |
||
| 86 | } |
||
| 87 | |||
| 88 | $response = $this->prepare_item_for_response( $response, $request ); |
||
| 89 | |||
| 90 | return rest_ensure_response( $response ); |
||
| 91 | } |
||
| 92 | |||
| 93 | /** |
||
| 94 | * Get the system status schema, conforming to JSON Schema. |
||
| 95 | * |
||
| 96 | * @return array |
||
| 97 | */ |
||
| 98 | public function get_item_schema() { |
||
| 99 | $schema = array( |
||
| 100 | '$schema' => 'http://json-schema.org/draft-04/schema#', |
||
| 101 | 'title' => 'system_status', |
||
| 102 | 'type' => 'object', |
||
| 103 | 'properties' => array( |
||
| 104 | 'environment' => array( |
||
| 105 | 'description' => __( 'Environment.', 'woocommerce' ), |
||
| 106 | 'type' => 'object', |
||
| 107 | 'context' => array( 'view' ), |
||
| 108 | 'readonly' => true, |
||
| 109 | 'properties' => array( |
||
| 110 | 'home_url' => array( |
||
| 111 | 'description' => __( 'Home URL.', 'woocommerce' ), |
||
| 112 | 'type' => 'string', |
||
| 113 | 'format' => 'uri', |
||
| 114 | 'context' => array( 'view' ), |
||
| 115 | 'readonly' => true, |
||
| 116 | ), |
||
| 117 | 'site_url' => array( |
||
| 118 | 'description' => __( 'Site URL.', 'woocommerce' ), |
||
| 119 | 'type' => 'string', |
||
| 120 | 'format' => 'uri', |
||
| 121 | 'context' => array( 'view' ), |
||
| 122 | 'readonly' => true, |
||
| 123 | ), |
||
| 124 | 'wc_version' => array( |
||
| 125 | 'description' => __( 'WooCommerce version.', 'woocommerce' ), |
||
| 126 | 'type' => 'string', |
||
| 127 | 'context' => array( 'view' ), |
||
| 128 | 'readonly' => true, |
||
| 129 | ), |
||
| 130 | 'log_directory' => array( |
||
| 131 | 'description' => __( 'Log directory.', 'woocommerce' ), |
||
| 132 | 'type' => 'string', |
||
| 133 | 'context' => array( 'view' ), |
||
| 134 | 'readonly' => true, |
||
| 135 | ), |
||
| 136 | 'log_directory_writable' => array( |
||
| 137 | 'description' => __( 'Is log directory writable?', 'woocommerce' ), |
||
| 138 | 'type' => 'boolean', |
||
| 139 | 'context' => array( 'view' ), |
||
| 140 | 'readonly' => true, |
||
| 141 | ), |
||
| 142 | 'wp_version' => array( |
||
| 143 | 'description' => __( 'WordPress version.', 'woocommerce' ), |
||
| 144 | 'type' => 'string', |
||
| 145 | 'context' => array( 'view' ), |
||
| 146 | 'readonly' => true, |
||
| 147 | ), |
||
| 148 | 'wp_multisite' => array( |
||
| 149 | 'description' => __( 'Is WordPress multisite?', 'woocommerce' ), |
||
| 150 | 'type' => 'boolean', |
||
| 151 | 'context' => array( 'view' ), |
||
| 152 | 'readonly' => true, |
||
| 153 | ), |
||
| 154 | 'wp_memory_limit' => array( |
||
| 155 | 'description' => __( 'WordPress memory limit.', 'woocommerce' ), |
||
| 156 | 'type' => 'integer', |
||
| 157 | 'context' => array( 'view' ), |
||
| 158 | 'readonly' => true, |
||
| 159 | ), |
||
| 160 | 'wp_debug_mode' => array( |
||
| 161 | 'description' => __( 'Is WordPress debug mode active?', 'woocommerce' ), |
||
| 162 | 'type' => 'boolean', |
||
| 163 | 'context' => array( 'view' ), |
||
| 164 | 'readonly' => true, |
||
| 165 | ), |
||
| 166 | 'wp_cron' => array( |
||
| 167 | 'description' => __( 'Are WordPress cron jobs enabled?', 'woocommerce' ), |
||
| 168 | 'type' => 'boolean', |
||
| 169 | 'context' => array( 'view' ), |
||
| 170 | 'readonly' => true, |
||
| 171 | ), |
||
| 172 | 'language' => array( |
||
| 173 | 'description' => __( 'WordPress language.', 'woocommerce' ), |
||
| 174 | 'type' => 'string', |
||
| 175 | 'context' => array( 'view' ), |
||
| 176 | 'readonly' => true, |
||
| 177 | ), |
||
| 178 | 'server_info' => array( |
||
| 179 | 'description' => __( 'Server info.', 'woocommerce' ), |
||
| 180 | 'type' => 'string', |
||
| 181 | 'context' => array( 'view' ), |
||
| 182 | 'readonly' => true, |
||
| 183 | ), |
||
| 184 | 'php_version' => array( |
||
| 185 | 'description' => __( 'PHP version.', 'woocommerce' ), |
||
| 186 | 'type' => 'string', |
||
| 187 | 'context' => array( 'view' ), |
||
| 188 | 'readonly' => true, |
||
| 189 | ), |
||
| 190 | 'php_post_max_size' => array( |
||
| 191 | 'description' => __( 'PHP post max size.', 'woocommerce' ), |
||
| 192 | 'type' => 'integer', |
||
| 193 | 'context' => array( 'view' ), |
||
| 194 | 'readonly' => true, |
||
| 195 | ), |
||
| 196 | 'php_max_execution_time' => array( |
||
| 197 | 'description' => __( 'PHP max execution time.', 'woocommerce' ), |
||
| 198 | 'type' => 'integer', |
||
| 199 | 'context' => array( 'view' ), |
||
| 200 | 'readonly' => true, |
||
| 201 | ), |
||
| 202 | 'php_max_input_vars' => array( |
||
| 203 | 'description' => __( 'PHP max input vars.', 'woocommerce' ), |
||
| 204 | 'type' => 'integer', |
||
| 205 | 'context' => array( 'view' ), |
||
| 206 | 'readonly' => true, |
||
| 207 | ), |
||
| 208 | 'curl_version' => array( |
||
| 209 | 'description' => __( 'cURL version.', 'woocommerce' ), |
||
| 210 | 'type' => 'string', |
||
| 211 | 'context' => array( 'view' ), |
||
| 212 | 'readonly' => true, |
||
| 213 | ), |
||
| 214 | 'suhosin_installed' => array( |
||
| 215 | 'description' => __( 'Is SUHOSIN installed?', 'woocommerce' ), |
||
| 216 | 'type' => 'boolean', |
||
| 217 | 'context' => array( 'view' ), |
||
| 218 | 'readonly' => true, |
||
| 219 | ), |
||
| 220 | 'max_upload_size' => array( |
||
| 221 | 'description' => __( 'Max upload size.', 'woocommerce' ), |
||
| 222 | 'type' => 'integer', |
||
| 223 | 'context' => array( 'view' ), |
||
| 224 | 'readonly' => true, |
||
| 225 | ), |
||
| 226 | 'mysql_version' => array( |
||
| 227 | 'description' => __( 'MySQL version.', 'woocommerce' ), |
||
| 228 | 'type' => 'string', |
||
| 229 | 'context' => array( 'view' ), |
||
| 230 | 'readonly' => true, |
||
| 231 | ), |
||
| 232 | 'mysql_version_string' => array( |
||
| 233 | 'description' => __( 'MySQL version string.', 'woocommerce' ), |
||
| 234 | 'type' => 'string', |
||
| 235 | 'context' => array( 'view' ), |
||
| 236 | 'readonly' => true, |
||
| 237 | ), |
||
| 238 | 'default_timezone' => array( |
||
| 239 | 'description' => __( 'Default timezone.', 'woocommerce' ), |
||
| 240 | 'type' => 'string', |
||
| 241 | 'context' => array( 'view' ), |
||
| 242 | 'readonly' => true, |
||
| 243 | ), |
||
| 244 | 'fsockopen_or_curl_enabled' => array( |
||
| 245 | 'description' => __( 'Is fsockopen/cURL enabled?', 'woocommerce' ), |
||
| 246 | 'type' => 'boolean', |
||
| 247 | 'context' => array( 'view' ), |
||
| 248 | 'readonly' => true, |
||
| 249 | ), |
||
| 250 | 'soapclient_enabled' => array( |
||
| 251 | 'description' => __( 'Is SoapClient class enabled?', 'woocommerce' ), |
||
| 252 | 'type' => 'boolean', |
||
| 253 | 'context' => array( 'view' ), |
||
| 254 | 'readonly' => true, |
||
| 255 | ), |
||
| 256 | 'domdocument_enabled' => array( |
||
| 257 | 'description' => __( 'Is DomDocument class enabled?', 'woocommerce' ), |
||
| 258 | 'type' => 'boolean', |
||
| 259 | 'context' => array( 'view' ), |
||
| 260 | 'readonly' => true, |
||
| 261 | ), |
||
| 262 | 'gzip_enabled' => array( |
||
| 263 | 'description' => __( 'Is GZip enabled?', 'woocommerce' ), |
||
| 264 | 'type' => 'boolean', |
||
| 265 | 'context' => array( 'view' ), |
||
| 266 | 'readonly' => true, |
||
| 267 | ), |
||
| 268 | 'mbstring_enabled' => array( |
||
| 269 | 'description' => __( 'Is mbstring enabled?', 'woocommerce' ), |
||
| 270 | 'type' => 'boolean', |
||
| 271 | 'context' => array( 'view' ), |
||
| 272 | 'readonly' => true, |
||
| 273 | ), |
||
| 274 | 'remote_post_successful' => array( |
||
| 275 | 'description' => __( 'Remote POST successful?', 'woocommerce' ), |
||
| 276 | 'type' => 'boolean', |
||
| 277 | 'context' => array( 'view' ), |
||
| 278 | 'readonly' => true, |
||
| 279 | ), |
||
| 280 | 'remote_post_response' => array( |
||
| 281 | 'description' => __( 'Remote POST response.', 'woocommerce' ), |
||
| 282 | 'type' => 'string', |
||
| 283 | 'context' => array( 'view' ), |
||
| 284 | 'readonly' => true, |
||
| 285 | ), |
||
| 286 | 'remote_get_successful' => array( |
||
| 287 | 'description' => __( 'Remote GET successful?', 'woocommerce' ), |
||
| 288 | 'type' => 'boolean', |
||
| 289 | 'context' => array( 'view' ), |
||
| 290 | 'readonly' => true, |
||
| 291 | ), |
||
| 292 | 'remote_get_response' => array( |
||
| 293 | 'description' => __( 'Remote GET response.', 'woocommerce' ), |
||
| 294 | 'type' => 'string', |
||
| 295 | 'context' => array( 'view' ), |
||
| 296 | 'readonly' => true, |
||
| 297 | ), |
||
| 298 | ), |
||
| 299 | ), |
||
| 300 | 'database' => array( |
||
| 301 | 'description' => __( 'Database.', 'woocommerce' ), |
||
| 302 | 'type' => 'object', |
||
| 303 | 'context' => array( 'view' ), |
||
| 304 | 'readonly' => true, |
||
| 305 | 'properties' => array( |
||
| 306 | 'wc_database_version' => array( |
||
| 307 | 'description' => __( 'WC database version.', 'woocommerce' ), |
||
| 308 | 'type' => 'string', |
||
| 309 | 'context' => array( 'view' ), |
||
| 310 | 'readonly' => true, |
||
| 311 | ), |
||
| 312 | 'database_prefix' => array( |
||
| 313 | 'description' => __( 'Database prefix.', 'woocommerce' ), |
||
| 314 | 'type' => 'string', |
||
| 315 | 'context' => array( 'view' ), |
||
| 316 | 'readonly' => true, |
||
| 317 | ), |
||
| 318 | 'maxmind_geoip_database' => array( |
||
| 319 | 'description' => __( 'MaxMind GeoIP database.', 'woocommerce' ), |
||
| 320 | 'type' => 'string', |
||
| 321 | 'context' => array( 'view' ), |
||
| 322 | 'readonly' => true, |
||
| 323 | ), |
||
| 324 | 'database_tables' => array( |
||
| 325 | 'description' => __( 'Database tables.', 'woocommerce' ), |
||
| 326 | 'type' => 'array', |
||
| 327 | 'context' => array( 'view' ), |
||
| 328 | 'readonly' => true, |
||
| 329 | 'items' => array( |
||
| 330 | 'type' => 'string', |
||
| 331 | ), |
||
| 332 | ), |
||
| 333 | ), |
||
| 334 | ), |
||
| 335 | 'active_plugins' => array( |
||
| 336 | 'description' => __( 'Active plugins.', 'woocommerce' ), |
||
| 337 | 'type' => 'array', |
||
| 338 | 'context' => array( 'view' ), |
||
| 339 | 'readonly' => true, |
||
| 340 | 'items' => array( |
||
| 341 | 'type' => 'string', |
||
| 342 | ), |
||
| 343 | ), |
||
| 344 | 'inactive_plugins' => array( |
||
| 345 | 'description' => __( 'Inactive plugins.', 'woocommerce' ), |
||
| 346 | 'type' => 'array', |
||
| 347 | 'context' => array( 'view' ), |
||
| 348 | 'readonly' => true, |
||
| 349 | 'items' => array( |
||
| 350 | 'type' => 'string', |
||
| 351 | ), |
||
| 352 | ), |
||
| 353 | 'dropins_mu_plugins' => array( |
||
| 354 | 'description' => __( 'Dropins & MU plugins.', 'woocommerce' ), |
||
| 355 | 'type' => 'array', |
||
| 356 | 'context' => array( 'view' ), |
||
| 357 | 'readonly' => true, |
||
| 358 | 'items' => array( |
||
| 359 | 'type' => 'string', |
||
| 360 | ), |
||
| 361 | ), |
||
| 362 | 'theme' => array( |
||
| 363 | 'description' => __( 'Theme.', 'woocommerce' ), |
||
| 364 | 'type' => 'object', |
||
| 365 | 'context' => array( 'view' ), |
||
| 366 | 'readonly' => true, |
||
| 367 | 'properties' => array( |
||
| 368 | 'name' => array( |
||
| 369 | 'description' => __( 'Theme name.', 'woocommerce' ), |
||
| 370 | 'type' => 'string', |
||
| 371 | 'context' => array( 'view' ), |
||
| 372 | 'readonly' => true, |
||
| 373 | ), |
||
| 374 | 'version' => array( |
||
| 375 | 'description' => __( 'Theme version.', 'woocommerce' ), |
||
| 376 | 'type' => 'string', |
||
| 377 | 'context' => array( 'view' ), |
||
| 378 | 'readonly' => true, |
||
| 379 | ), |
||
| 380 | 'version_latest' => array( |
||
| 381 | 'description' => __( 'Latest version of theme.', 'woocommerce' ), |
||
| 382 | 'type' => 'string', |
||
| 383 | 'context' => array( 'view' ), |
||
| 384 | 'readonly' => true, |
||
| 385 | ), |
||
| 386 | 'author_url' => array( |
||
| 387 | 'description' => __( 'Theme author URL.', 'woocommerce' ), |
||
| 388 | 'type' => 'string', |
||
| 389 | 'format' => 'uri', |
||
| 390 | 'context' => array( 'view' ), |
||
| 391 | 'readonly' => true, |
||
| 392 | ), |
||
| 393 | 'is_child_theme' => array( |
||
| 394 | 'description' => __( 'Is this theme a child theme?', 'woocommerce' ), |
||
| 395 | 'type' => 'boolean', |
||
| 396 | 'context' => array( 'view' ), |
||
| 397 | 'readonly' => true, |
||
| 398 | ), |
||
| 399 | 'has_woocommerce_support' => array( |
||
| 400 | 'description' => __( 'Does the theme declare WooCommerce support?', 'woocommerce' ), |
||
| 401 | 'type' => 'boolean', |
||
| 402 | 'context' => array( 'view' ), |
||
| 403 | 'readonly' => true, |
||
| 404 | ), |
||
| 405 | 'has_woocommerce_file' => array( |
||
| 406 | 'description' => __( 'Does the theme have a woocommerce.php file?', 'woocommerce' ), |
||
| 407 | 'type' => 'boolean', |
||
| 408 | 'context' => array( 'view' ), |
||
| 409 | 'readonly' => true, |
||
| 410 | ), |
||
| 411 | 'has_outdated_templates' => array( |
||
| 412 | 'description' => __( 'Does this theme have outdated templates?', 'woocommerce' ), |
||
| 413 | 'type' => 'boolean', |
||
| 414 | 'context' => array( 'view' ), |
||
| 415 | 'readonly' => true, |
||
| 416 | ), |
||
| 417 | 'overrides' => array( |
||
| 418 | 'description' => __( 'Template overrides.', 'woocommerce' ), |
||
| 419 | 'type' => 'array', |
||
| 420 | 'context' => array( 'view' ), |
||
| 421 | 'readonly' => true, |
||
| 422 | 'items' => array( |
||
| 423 | 'type' => 'string', |
||
| 424 | ), |
||
| 425 | ), |
||
| 426 | 'parent_name' => array( |
||
| 427 | 'description' => __( 'Parent theme name.', 'woocommerce' ), |
||
| 428 | 'type' => 'string', |
||
| 429 | 'context' => array( 'view' ), |
||
| 430 | 'readonly' => true, |
||
| 431 | ), |
||
| 432 | 'parent_version' => array( |
||
| 433 | 'description' => __( 'Parent theme version.', 'woocommerce' ), |
||
| 434 | 'type' => 'string', |
||
| 435 | 'context' => array( 'view' ), |
||
| 436 | 'readonly' => true, |
||
| 437 | ), |
||
| 438 | 'parent_author_url' => array( |
||
| 439 | 'description' => __( 'Parent theme author URL.', 'woocommerce' ), |
||
| 440 | 'type' => 'string', |
||
| 441 | 'format' => 'uri', |
||
| 442 | 'context' => array( 'view' ), |
||
| 443 | 'readonly' => true, |
||
| 444 | ), |
||
| 445 | ), |
||
| 446 | ), |
||
| 447 | 'settings' => array( |
||
| 448 | 'description' => __( 'Settings.', 'woocommerce' ), |
||
| 449 | 'type' => 'object', |
||
| 450 | 'context' => array( 'view' ), |
||
| 451 | 'readonly' => true, |
||
| 452 | 'properties' => array( |
||
| 453 | 'api_enabled' => array( |
||
| 454 | 'description' => __( 'REST API enabled?', 'woocommerce' ), |
||
| 455 | 'type' => 'boolean', |
||
| 456 | 'context' => array( 'view' ), |
||
| 457 | 'readonly' => true, |
||
| 458 | ), |
||
| 459 | 'force_ssl' => array( |
||
| 460 | 'description' => __( 'SSL forced?', 'woocommerce' ), |
||
| 461 | 'type' => 'boolean', |
||
| 462 | 'context' => array( 'view' ), |
||
| 463 | 'readonly' => true, |
||
| 464 | ), |
||
| 465 | 'currency' => array( |
||
| 466 | 'description' => __( 'Currency.', 'woocommerce' ), |
||
| 467 | 'type' => 'string', |
||
| 468 | 'context' => array( 'view' ), |
||
| 469 | 'readonly' => true, |
||
| 470 | ), |
||
| 471 | 'currency_symbol' => array( |
||
| 472 | 'description' => __( 'Currency symbol.', 'woocommerce' ), |
||
| 473 | 'type' => 'string', |
||
| 474 | 'context' => array( 'view' ), |
||
| 475 | 'readonly' => true, |
||
| 476 | ), |
||
| 477 | 'currency_position' => array( |
||
| 478 | 'description' => __( 'Currency position.', 'woocommerce' ), |
||
| 479 | 'type' => 'string', |
||
| 480 | 'context' => array( 'view' ), |
||
| 481 | 'readonly' => true, |
||
| 482 | ), |
||
| 483 | 'thousand_separator' => array( |
||
| 484 | 'description' => __( 'Thousand separator.', 'woocommerce' ), |
||
| 485 | 'type' => 'string', |
||
| 486 | 'context' => array( 'view' ), |
||
| 487 | 'readonly' => true, |
||
| 488 | ), |
||
| 489 | 'decimal_separator' => array( |
||
| 490 | 'description' => __( 'Decimal separator.', 'woocommerce' ), |
||
| 491 | 'type' => 'string', |
||
| 492 | 'context' => array( 'view' ), |
||
| 493 | 'readonly' => true, |
||
| 494 | ), |
||
| 495 | 'number_of_decimals' => array( |
||
| 496 | 'description' => __( 'Number of decimals.', 'woocommerce' ), |
||
| 497 | 'type' => 'integer', |
||
| 498 | 'context' => array( 'view' ), |
||
| 499 | 'readonly' => true, |
||
| 500 | ), |
||
| 501 | 'geolocation_enabled' => array( |
||
| 502 | 'description' => __( 'Geolocation enabled?', 'woocommerce' ), |
||
| 503 | 'type' => 'boolean', |
||
| 504 | 'context' => array( 'view' ), |
||
| 505 | 'readonly' => true, |
||
| 506 | ), |
||
| 507 | 'taxonomies' => array( |
||
| 508 | 'description' => __( 'Taxonomy terms for product/order statuses.', 'woocommerce' ), |
||
| 509 | 'type' => 'array', |
||
| 510 | 'context' => array( 'view' ), |
||
| 511 | 'readonly' => true, |
||
| 512 | 'items' => array( |
||
| 513 | 'type' => 'string', |
||
| 514 | ), |
||
| 515 | ), |
||
| 516 | 'product_visibility_terms' => array( |
||
| 517 | 'description' => __( 'Terms in the product visibility taxonomy.', 'woocommerce' ), |
||
| 518 | 'type' => 'array', |
||
| 519 | 'context' => array( 'view' ), |
||
| 520 | 'readonly' => true, |
||
| 521 | 'items' => array( |
||
| 522 | 'type' => 'string', |
||
| 523 | ), |
||
| 524 | ), |
||
| 525 | ), |
||
| 526 | ), |
||
| 527 | 'security' => array( |
||
| 528 | 'description' => __( 'Security.', 'woocommerce' ), |
||
| 529 | 'type' => 'object', |
||
| 530 | 'context' => array( 'view' ), |
||
| 531 | 'readonly' => true, |
||
| 532 | 'properties' => array( |
||
| 533 | 'secure_connection' => array( |
||
| 534 | 'description' => __( 'Is the connection to your store secure?', 'woocommerce' ), |
||
| 535 | 'type' => 'boolean', |
||
| 536 | 'context' => array( 'view' ), |
||
| 537 | 'readonly' => true, |
||
| 538 | ), |
||
| 539 | 'hide_errors' => array( |
||
| 540 | 'description' => __( 'Hide errors from visitors?', 'woocommerce' ), |
||
| 541 | 'type' => 'boolean', |
||
| 542 | 'context' => array( 'view' ), |
||
| 543 | 'readonly' => true, |
||
| 544 | ), |
||
| 545 | ), |
||
| 546 | ), |
||
| 547 | 'pages' => array( |
||
| 548 | 'description' => __( 'WooCommerce pages.', 'woocommerce' ), |
||
| 549 | 'type' => 'array', |
||
| 550 | 'context' => array( 'view' ), |
||
| 551 | 'readonly' => true, |
||
| 552 | 'items' => array( |
||
| 553 | 'type' => 'string', |
||
| 554 | ), |
||
| 555 | ), |
||
| 556 | ), |
||
| 557 | ); |
||
| 558 | |||
| 559 | return $this->add_additional_fields_schema( $schema ); |
||
| 560 | } |
||
| 561 | |||
| 562 | /** |
||
| 563 | * Return an array of sections and the data associated with each. |
||
| 564 | * |
||
| 565 | * @return array |
||
| 566 | */ |
||
| 567 | public function get_item_mappings() { |
||
| 568 | return array( |
||
| 569 | 'environment' => $this->get_environment_info(), |
||
| 570 | 'database' => $this->get_database_info(), |
||
| 571 | 'active_plugins' => $this->get_active_plugins(), |
||
| 572 | 'inactive_plugins' => $this->get_inactive_plugins(), |
||
| 573 | 'dropins_mu_plugins' => $this->get_dropins_mu_plugins(), |
||
| 574 | 'theme' => $this->get_theme_info(), |
||
| 575 | 'settings' => $this->get_settings(), |
||
| 576 | 'security' => $this->get_security_info(), |
||
| 577 | 'pages' => $this->get_pages(), |
||
| 578 | ); |
||
| 579 | } |
||
| 580 | |||
| 581 | /** |
||
| 582 | * Get array of environment information. Includes thing like software |
||
| 583 | * versions, and various server settings. |
||
| 584 | * |
||
| 585 | * @return array |
||
| 586 | */ |
||
| 587 | public function get_environment_info() { |
||
| 588 | global $wpdb; |
||
| 589 | |||
| 590 | // Figure out cURL version, if installed. |
||
| 591 | $curl_version = ''; |
||
| 592 | if ( function_exists( 'curl_version' ) ) { |
||
| 593 | $curl_version = curl_version(); |
||
| 594 | $curl_version = $curl_version['version'] . ', ' . $curl_version['ssl_version']; |
||
| 595 | } elseif ( extension_loaded( 'curl' ) ) { |
||
| 596 | $curl_version = __( 'cURL installed but unable to retrieve version.', 'woocommerce' ); |
||
| 597 | } |
||
| 598 | |||
| 599 | // WP memory limit. |
||
| 600 | $wp_memory_limit = wc_let_to_num( WP_MEMORY_LIMIT ); |
||
| 601 | if ( function_exists( 'memory_get_usage' ) ) { |
||
| 602 | $wp_memory_limit = max( $wp_memory_limit, wc_let_to_num( @ini_get( 'memory_limit' ) ) ); |
||
| 603 | } |
||
| 604 | |||
| 605 | // Test POST requests. |
||
| 606 | $post_response_code = get_transient( 'woocommerce_test_remote_post' ); |
||
| 607 | |||
| 608 | if ( false === $post_response_code || is_wp_error( $post_response_code ) ) { |
||
| 609 | $response = wp_safe_remote_post( |
||
| 610 | 'https://www.paypal.com/cgi-bin/webscr', |
||
| 611 | array( |
||
| 612 | 'timeout' => 10, |
||
| 613 | 'user-agent' => 'WooCommerce/' . WC()->version, |
||
| 614 | 'httpversion' => '1.1', |
||
| 615 | 'body' => array( |
||
| 616 | 'cmd' => '_notify-validate', |
||
| 617 | ), |
||
| 618 | ) |
||
| 619 | ); |
||
| 620 | if ( ! is_wp_error( $response ) ) { |
||
| 621 | $post_response_code = $response['response']['code']; |
||
| 622 | } |
||
| 623 | set_transient( 'woocommerce_test_remote_post', $post_response_code, HOUR_IN_SECONDS ); |
||
| 624 | } |
||
| 625 | |||
| 626 | $post_response_successful = ! is_wp_error( $post_response_code ) && $post_response_code >= 200 && $post_response_code < 300; |
||
| 627 | |||
| 628 | // Test GET requests. |
||
| 629 | $get_response_code = get_transient( 'woocommerce_test_remote_get' ); |
||
| 630 | |||
| 631 | if ( false === $get_response_code || is_wp_error( $get_response_code ) ) { |
||
| 632 | $response = wp_safe_remote_get( 'https://woocommerce.com/wc-api/product-key-api?request=ping&network=' . ( is_multisite() ? '1' : '0' ) ); |
||
| 633 | if ( ! is_wp_error( $response ) ) { |
||
| 634 | $get_response_code = $response['response']['code']; |
||
| 635 | } |
||
| 636 | set_transient( 'woocommerce_test_remote_get', $get_response_code, HOUR_IN_SECONDS ); |
||
| 637 | } |
||
| 638 | |||
| 639 | $get_response_successful = ! is_wp_error( $get_response_code ) && $get_response_code >= 200 && $get_response_code < 300; |
||
| 640 | |||
| 641 | $database_version = wc_get_server_database_version(); |
||
| 642 | |||
| 643 | // Return all environment info. Described by JSON Schema. |
||
| 644 | return array( |
||
| 645 | 'home_url' => get_option( 'home' ), |
||
| 646 | 'site_url' => get_option( 'siteurl' ), |
||
| 647 | 'version' => WC()->version, |
||
| 648 | 'log_directory' => WC_LOG_DIR, |
||
| 649 | 'log_directory_writable' => (bool) @fopen( WC_LOG_DIR . 'test-log.log', 'a' ), |
||
| 650 | 'wp_version' => get_bloginfo( 'version' ), |
||
| 651 | 'wp_multisite' => is_multisite(), |
||
| 652 | 'wp_memory_limit' => $wp_memory_limit, |
||
| 653 | 'wp_debug_mode' => ( defined( 'WP_DEBUG' ) && WP_DEBUG ), |
||
| 654 | 'wp_cron' => ! ( defined( 'DISABLE_WP_CRON' ) && DISABLE_WP_CRON ), |
||
| 655 | 'language' => get_locale(), |
||
| 656 | 'external_object_cache' => wp_using_ext_object_cache(), |
||
| 657 | 'server_info' => isset( $_SERVER['SERVER_SOFTWARE'] ) ? wc_clean( wp_unslash( $_SERVER['SERVER_SOFTWARE'] ) ) : '', |
||
| 658 | 'php_version' => phpversion(), |
||
| 659 | 'php_post_max_size' => wc_let_to_num( ini_get( 'post_max_size' ) ), |
||
| 660 | 'php_max_execution_time' => ini_get( 'max_execution_time' ), |
||
| 661 | 'php_max_input_vars' => ini_get( 'max_input_vars' ), |
||
| 662 | 'curl_version' => $curl_version, |
||
| 663 | 'suhosin_installed' => extension_loaded( 'suhosin' ), |
||
| 664 | 'max_upload_size' => wp_max_upload_size(), |
||
| 665 | 'mysql_version' => $database_version['number'], |
||
| 666 | 'mysql_version_string' => $database_version['string'], |
||
| 667 | 'default_timezone' => date_default_timezone_get(), |
||
| 668 | 'fsockopen_or_curl_enabled' => ( function_exists( 'fsockopen' ) || function_exists( 'curl_init' ) ), |
||
| 669 | 'soapclient_enabled' => class_exists( 'SoapClient' ), |
||
| 670 | 'domdocument_enabled' => class_exists( 'DOMDocument' ), |
||
| 671 | 'gzip_enabled' => is_callable( 'gzopen' ), |
||
| 672 | 'mbstring_enabled' => extension_loaded( 'mbstring' ), |
||
| 673 | 'remote_post_successful' => $post_response_successful, |
||
| 674 | 'remote_post_response' => is_wp_error( $post_response_code ) ? $post_response_code->get_error_message() : $post_response_code, |
||
| 675 | 'remote_get_successful' => $get_response_successful, |
||
| 676 | 'remote_get_response' => is_wp_error( $get_response_code ) ? $get_response_code->get_error_message() : $get_response_code, |
||
| 677 | ); |
||
| 678 | } |
||
| 679 | |||
| 680 | /** |
||
| 681 | * Add prefix to table. |
||
| 682 | * |
||
| 683 | * @param string $table Table name. |
||
| 684 | * @return stromg |
||
| 685 | */ |
||
| 686 | protected function add_db_table_prefix( $table ) { |
||
| 687 | global $wpdb; |
||
| 688 | return $wpdb->prefix . $table; |
||
| 689 | } |
||
| 690 | |||
| 691 | /** |
||
| 692 | * Get array of database information. Version, prefix, and table existence. |
||
| 693 | * |
||
| 694 | * @return array |
||
| 695 | */ |
||
| 696 | public function get_database_info() { |
||
| 697 | global $wpdb; |
||
| 698 | |||
| 699 | $database_table_information = $wpdb->get_results( |
||
| 700 | $wpdb->prepare( |
||
| 701 | "SELECT |
||
| 702 | table_name AS 'name', |
||
| 703 | engine, |
||
| 704 | round( ( data_length / 1024 / 1024 ), 2 ) 'data', |
||
| 705 | round( ( index_length / 1024 / 1024 ), 2 ) 'index' |
||
| 706 | FROM information_schema.TABLES |
||
| 707 | WHERE table_schema = %s |
||
| 708 | ORDER BY name ASC;", |
||
| 709 | DB_NAME |
||
| 710 | ) |
||
| 711 | ); |
||
| 712 | |||
| 713 | // WC Core tables to check existence of. |
||
| 714 | $core_tables = apply_filters( |
||
| 715 | 'woocommerce_database_tables', |
||
| 716 | array( |
||
| 717 | 'woocommerce_sessions', |
||
| 718 | 'woocommerce_api_keys', |
||
| 719 | 'woocommerce_attribute_taxonomies', |
||
| 720 | 'woocommerce_downloadable_product_permissions', |
||
| 721 | 'woocommerce_order_items', |
||
| 722 | 'woocommerce_order_itemmeta', |
||
| 723 | 'woocommerce_tax_rates', |
||
| 724 | 'woocommerce_tax_rate_locations', |
||
| 725 | 'woocommerce_shipping_zones', |
||
| 726 | 'woocommerce_shipping_zone_locations', |
||
| 727 | 'woocommerce_shipping_zone_methods', |
||
| 728 | 'woocommerce_payment_tokens', |
||
| 729 | 'woocommerce_payment_tokenmeta', |
||
| 730 | 'woocommerce_log', |
||
| 731 | ) |
||
| 732 | ); |
||
| 733 | |||
| 734 | /** |
||
| 735 | * Adding the prefix to the tables array, for backwards compatibility. |
||
| 736 | * |
||
| 737 | * If we changed the tables above to include the prefix, then any filters against that table could break. |
||
| 738 | */ |
||
| 739 | $core_tables = array_map( array( $this, 'add_db_table_prefix' ), $core_tables ); |
||
| 740 | |||
| 741 | /** |
||
| 742 | * Organize WooCommerce and non-WooCommerce tables separately for display purposes later. |
||
| 743 | * |
||
| 744 | * To ensure we include all WC tables, even if they do not exist, pre-populate the WC array with all the tables. |
||
| 745 | */ |
||
| 746 | $tables = array( |
||
| 747 | 'woocommerce' => array_fill_keys( $core_tables, false ), |
||
| 748 | 'other' => array(), |
||
| 749 | ); |
||
| 750 | |||
| 751 | $database_size = array( |
||
| 752 | 'data' => 0, |
||
| 753 | 'index' => 0, |
||
| 754 | ); |
||
| 755 | |||
| 756 | $site_tables_prefix = $wpdb->get_blog_prefix( get_current_blog_id() ); |
||
| 757 | $global_tables = $wpdb->tables( 'global', true ); |
||
| 758 | foreach ( $database_table_information as $table ) { |
||
| 759 | // Only include tables matching the prefix of the current site, this is to prevent displaying all tables on a MS install not relating to the current. |
||
| 760 | if ( is_multisite() && 0 !== strpos( $table->name, $site_tables_prefix ) && ! in_array( $table->name, $global_tables, true ) ) { |
||
| 761 | continue; |
||
| 762 | } |
||
| 763 | $table_type = in_array( $table->name, $core_tables ) ? 'woocommerce' : 'other'; |
||
| 764 | |||
| 765 | $tables[ $table_type ][ $table->name ] = array( |
||
| 766 | 'data' => $table->data, |
||
| 767 | 'index' => $table->index, |
||
| 768 | 'engine' => $table->engine, |
||
| 769 | ); |
||
| 770 | |||
| 771 | $database_size['data'] += $table->data; |
||
| 772 | $database_size['index'] += $table->index; |
||
| 773 | } |
||
| 774 | |||
| 775 | // Return all database info. Described by JSON Schema. |
||
| 776 | return array( |
||
| 777 | 'wc_database_version' => get_option( 'woocommerce_db_version' ), |
||
| 778 | 'database_prefix' => $wpdb->prefix, |
||
| 779 | 'maxmind_geoip_database' => WC_Geolocation::get_local_database_path(), |
||
| 780 | 'database_tables' => $tables, |
||
| 781 | 'database_size' => $database_size, |
||
| 782 | ); |
||
| 783 | } |
||
| 784 | |||
| 785 | /** |
||
| 786 | * Get array of counts of objects. Orders, products, etc. |
||
| 787 | * |
||
| 788 | * @return array |
||
| 789 | */ |
||
| 790 | public function get_post_type_counts() { |
||
| 791 | global $wpdb; |
||
| 792 | |||
| 793 | $post_type_counts = $wpdb->get_results( "SELECT post_type AS 'type', count(1) AS 'count' FROM {$wpdb->posts} GROUP BY post_type;" ); |
||
| 794 | |||
| 795 | return is_array( $post_type_counts ) ? $post_type_counts : array(); |
||
| 796 | } |
||
| 797 | |||
| 798 | /** |
||
| 799 | * Get a list of plugins active on the site. |
||
| 800 | * |
||
| 801 | * @return array |
||
| 802 | */ |
||
| 803 | public function get_active_plugins() { |
||
| 804 | require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
||
| 805 | |||
| 806 | if ( ! function_exists( 'get_plugin_data' ) ) { |
||
| 807 | return array(); |
||
| 808 | } |
||
| 809 | |||
| 810 | $active_plugins = (array) get_option( 'active_plugins', array() ); |
||
| 811 | if ( is_multisite() ) { |
||
| 812 | $network_activated_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) ); |
||
| 813 | $active_plugins = array_merge( $active_plugins, $network_activated_plugins ); |
||
| 814 | } |
||
| 815 | |||
| 816 | $active_plugins_data = array(); |
||
| 817 | |||
| 818 | foreach ( $active_plugins as $plugin ) { |
||
| 819 | $data = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin ); |
||
| 820 | $active_plugins_data[] = $this->format_plugin_data( $plugin, $data ); |
||
| 821 | } |
||
| 822 | |||
| 823 | return $active_plugins_data; |
||
| 824 | } |
||
| 825 | |||
| 826 | /** |
||
| 827 | * Get a list of inplugins active on the site. |
||
| 828 | * |
||
| 829 | * @return array |
||
| 830 | */ |
||
| 831 | public function get_inactive_plugins() { |
||
| 832 | require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
||
| 833 | |||
| 834 | if ( ! function_exists( 'get_plugins' ) ) { |
||
| 835 | return array(); |
||
| 836 | } |
||
| 837 | |||
| 838 | $plugins = get_plugins(); |
||
| 839 | $active_plugins = (array) get_option( 'active_plugins', array() ); |
||
| 840 | |||
| 841 | if ( is_multisite() ) { |
||
| 842 | $network_activated_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) ); |
||
| 843 | $active_plugins = array_merge( $active_plugins, $network_activated_plugins ); |
||
| 844 | } |
||
| 845 | |||
| 846 | $plugins_data = array(); |
||
| 847 | |||
| 848 | foreach ( $plugins as $plugin => $data ) { |
||
| 849 | if ( in_array( $plugin, $active_plugins, true ) ) { |
||
| 850 | continue; |
||
| 851 | } |
||
| 852 | $plugins_data[] = $this->format_plugin_data( $plugin, $data ); |
||
| 853 | } |
||
| 854 | |||
| 855 | return $plugins_data; |
||
| 856 | } |
||
| 857 | |||
| 858 | /** |
||
| 859 | * Format plugin data, including data on updates, into a standard format. |
||
| 860 | * |
||
| 861 | * @since 3.6.0 |
||
| 862 | * @param string $plugin Plugin directory/file. |
||
| 863 | * @param array $data Plugin data from WP. |
||
| 864 | * @return array Formatted data. |
||
| 865 | */ |
||
| 866 | protected function format_plugin_data( $plugin, $data ) { |
||
| 867 | require_once ABSPATH . 'wp-admin/includes/update.php'; |
||
| 868 | |||
| 869 | if ( ! function_exists( 'get_plugin_updates' ) ) { |
||
| 870 | return array(); |
||
| 871 | } |
||
| 872 | |||
| 873 | // Use WP API to lookup latest updates for plugins. WC_Helper injects updates for premium plugins. |
||
| 874 | if ( empty( $this->available_updates ) ) { |
||
| 875 | $this->available_updates = get_plugin_updates(); |
||
| 876 | } |
||
| 877 | |||
| 878 | $version_latest = $data['Version']; |
||
| 879 | |||
| 880 | // Find latest version. |
||
| 881 | if ( isset( $this->available_updates[ $plugin ]->update->new_version ) ) { |
||
| 882 | $version_latest = $this->available_updates[ $plugin ]->update->new_version; |
||
| 883 | } |
||
| 884 | |||
| 885 | return array( |
||
| 886 | 'plugin' => $plugin, |
||
| 887 | 'name' => $data['Name'], |
||
| 888 | 'version' => $data['Version'], |
||
| 889 | 'version_latest' => $version_latest, |
||
| 890 | 'url' => $data['PluginURI'], |
||
| 891 | 'author_name' => $data['AuthorName'], |
||
| 892 | 'author_url' => esc_url_raw( $data['AuthorURI'] ), |
||
| 893 | 'network_activated' => $data['Network'], |
||
| 894 | ); |
||
| 895 | } |
||
| 896 | |||
| 897 | /** |
||
| 898 | * Get a list of Dropins and MU plugins. |
||
| 899 | * |
||
| 900 | * @since 3.6.0 |
||
| 901 | * @return array |
||
| 902 | */ |
||
| 903 | public function get_dropins_mu_plugins() { |
||
| 904 | $dropins = get_dropins(); |
||
| 905 | $plugins = array( |
||
| 906 | 'dropins' => array(), |
||
| 907 | 'mu_plugins' => array(), |
||
| 908 | ); |
||
| 909 | foreach ( $dropins as $key => $dropin ) { |
||
| 910 | $plugins['dropins'][] = array( |
||
| 911 | 'plugin' => $key, |
||
| 912 | 'name' => $dropin['Name'], |
||
| 913 | ); |
||
| 914 | } |
||
| 915 | |||
| 916 | $mu_plugins = get_mu_plugins(); |
||
| 917 | foreach ( $mu_plugins as $plugin => $mu_plugin ) { |
||
| 918 | $plugins['mu_plugins'][] = array( |
||
| 919 | 'plugin' => $plugin, |
||
| 920 | 'name' => $mu_plugin['Name'], |
||
| 921 | 'version' => $mu_plugin['Version'], |
||
| 922 | 'url' => $mu_plugin['PluginURI'], |
||
| 923 | 'author_name' => $mu_plugin['AuthorName'], |
||
| 924 | 'author_url' => esc_url_raw( $mu_plugin['AuthorURI'] ), |
||
| 925 | ); |
||
| 926 | } |
||
| 927 | return $plugins; |
||
| 928 | } |
||
| 929 | |||
| 930 | /** |
||
| 931 | * Get info on the current active theme, info on parent theme (if presnet) |
||
| 932 | * and a list of template overrides. |
||
| 933 | * |
||
| 934 | * @return array |
||
| 935 | */ |
||
| 936 | public function get_theme_info() { |
||
| 937 | $active_theme = wp_get_theme(); |
||
| 938 | |||
| 939 | // Get parent theme info if this theme is a child theme, otherwise |
||
| 940 | // pass empty info in the response. |
||
| 941 | if ( is_child_theme() ) { |
||
| 942 | $parent_theme = wp_get_theme( $active_theme->template ); |
||
| 943 | $parent_theme_info = array( |
||
| 944 | 'parent_name' => $parent_theme->name, |
||
| 945 | 'parent_version' => $parent_theme->version, |
||
| 946 | 'parent_version_latest' => WC_Admin_Status::get_latest_theme_version( $parent_theme ), |
||
| 947 | 'parent_author_url' => $parent_theme->{'Author URI'}, |
||
| 948 | ); |
||
| 949 | } else { |
||
| 950 | $parent_theme_info = array( |
||
| 951 | 'parent_name' => '', |
||
| 952 | 'parent_version' => '', |
||
| 953 | 'parent_version_latest' => '', |
||
| 954 | 'parent_author_url' => '', |
||
| 955 | ); |
||
| 956 | } |
||
| 957 | |||
| 958 | /** |
||
| 959 | * Scan the theme directory for all WC templates to see if our theme |
||
| 960 | * overrides any of them. |
||
| 961 | */ |
||
| 962 | $override_files = array(); |
||
| 963 | $outdated_templates = false; |
||
| 964 | $scan_files = WC_Admin_Status::scan_template_files( WC()->plugin_path() . '/templates/' ); |
||
| 965 | foreach ( $scan_files as $file ) { |
||
| 966 | $located = apply_filters( 'wc_get_template', $file, $file, array(), WC()->template_path(), WC()->plugin_path() . '/templates/' ); |
||
| 967 | |||
| 968 | if ( file_exists( $located ) ) { |
||
| 969 | $theme_file = $located; |
||
| 970 | } elseif ( file_exists( get_stylesheet_directory() . '/' . $file ) ) { |
||
| 971 | $theme_file = get_stylesheet_directory() . '/' . $file; |
||
| 972 | } elseif ( file_exists( get_stylesheet_directory() . '/' . WC()->template_path() . $file ) ) { |
||
| 973 | $theme_file = get_stylesheet_directory() . '/' . WC()->template_path() . $file; |
||
| 974 | } elseif ( file_exists( get_template_directory() . '/' . $file ) ) { |
||
| 975 | $theme_file = get_template_directory() . '/' . $file; |
||
| 976 | } elseif ( file_exists( get_template_directory() . '/' . WC()->template_path() . $file ) ) { |
||
| 977 | $theme_file = get_template_directory() . '/' . WC()->template_path() . $file; |
||
| 978 | } else { |
||
| 979 | $theme_file = false; |
||
| 980 | } |
||
| 981 | |||
| 982 | if ( ! empty( $theme_file ) ) { |
||
| 983 | $core_version = WC_Admin_Status::get_file_version( WC()->plugin_path() . '/templates/' . $file ); |
||
| 984 | $theme_version = WC_Admin_Status::get_file_version( $theme_file ); |
||
| 985 | if ( $core_version && ( empty( $theme_version ) || version_compare( $theme_version, $core_version, '<' ) ) ) { |
||
| 986 | if ( ! $outdated_templates ) { |
||
| 987 | $outdated_templates = true; |
||
| 988 | } |
||
| 989 | } |
||
| 990 | $override_files[] = array( |
||
| 991 | 'file' => str_replace( WP_CONTENT_DIR . '/themes/', '', $theme_file ), |
||
| 992 | 'version' => $theme_version, |
||
| 993 | 'core_version' => $core_version, |
||
| 994 | ); |
||
| 995 | } |
||
| 996 | } |
||
| 997 | |||
| 998 | $active_theme_info = array( |
||
| 999 | 'name' => $active_theme->name, |
||
| 1000 | 'version' => $active_theme->version, |
||
| 1001 | 'version_latest' => WC_Admin_Status::get_latest_theme_version( $active_theme ), |
||
| 1002 | 'author_url' => esc_url_raw( $active_theme->{'Author URI'} ), |
||
| 1003 | 'is_child_theme' => is_child_theme(), |
||
| 1004 | 'has_woocommerce_support' => current_theme_supports( 'woocommerce' ), |
||
| 1005 | 'has_woocommerce_file' => ( file_exists( get_stylesheet_directory() . '/woocommerce.php' ) || file_exists( get_template_directory() . '/woocommerce.php' ) ), |
||
| 1006 | 'has_outdated_templates' => $outdated_templates, |
||
| 1007 | 'overrides' => $override_files, |
||
| 1008 | ); |
||
| 1009 | |||
| 1010 | return array_merge( $active_theme_info, $parent_theme_info ); |
||
| 1011 | } |
||
| 1012 | |||
| 1013 | /** |
||
| 1014 | * Get some setting values for the site that are useful for debugging |
||
| 1015 | * purposes. For full settings access, use the settings api. |
||
| 1016 | * |
||
| 1017 | * @return array |
||
| 1018 | */ |
||
| 1019 | public function get_settings() { |
||
| 1020 | // Get a list of terms used for product/order taxonomies. |
||
| 1021 | $term_response = array(); |
||
| 1022 | $terms = get_terms( 'product_type', array( 'hide_empty' => 0 ) ); |
||
| 1023 | foreach ( $terms as $term ) { |
||
| 1024 | $term_response[ $term->slug ] = strtolower( $term->name ); |
||
| 1025 | } |
||
| 1026 | |||
| 1027 | // Get a list of terms used for product visibility. |
||
| 1028 | $product_visibility_terms = array(); |
||
| 1029 | $terms = get_terms( 'product_visibility', array( 'hide_empty' => 0 ) ); |
||
| 1030 | foreach ( $terms as $term ) { |
||
| 1031 | $product_visibility_terms[ $term->slug ] = strtolower( $term->name ); |
||
| 1032 | } |
||
| 1033 | |||
| 1034 | // Check if WooCommerce.com account is connected. |
||
| 1035 | $woo_com_connected = 'no'; |
||
| 1036 | $helper_options = get_option( 'woocommerce_helper_data', array() ); |
||
| 1037 | if ( array_key_exists( 'auth', $helper_options ) && ! empty( $helper_options['auth'] ) ) { |
||
| 1038 | $woo_com_connected = 'yes'; |
||
| 1039 | } |
||
| 1040 | |||
| 1041 | // Return array of useful settings for debugging. |
||
| 1042 | return array( |
||
| 1043 | 'api_enabled' => 'yes' === get_option( 'woocommerce_api_enabled' ), |
||
| 1044 | 'force_ssl' => 'yes' === get_option( 'woocommerce_force_ssl_checkout' ), |
||
| 1045 | 'currency' => get_woocommerce_currency(), |
||
| 1046 | 'currency_symbol' => get_woocommerce_currency_symbol(), |
||
| 1047 | 'currency_position' => get_option( 'woocommerce_currency_pos' ), |
||
| 1048 | 'thousand_separator' => wc_get_price_thousand_separator(), |
||
| 1049 | 'decimal_separator' => wc_get_price_decimal_separator(), |
||
| 1050 | 'number_of_decimals' => wc_get_price_decimals(), |
||
| 1051 | 'geolocation_enabled' => in_array( get_option( 'woocommerce_default_customer_address' ), array( 'geolocation_ajax', 'geolocation' ) ), |
||
| 1052 | 'taxonomies' => $term_response, |
||
| 1053 | 'product_visibility_terms' => $product_visibility_terms, |
||
| 1054 | 'woocommerce_com_connected' => $woo_com_connected, |
||
| 1055 | ); |
||
| 1056 | } |
||
| 1057 | |||
| 1058 | /** |
||
| 1059 | * Returns security tips. |
||
| 1060 | * |
||
| 1061 | * @return array |
||
| 1062 | */ |
||
| 1063 | public function get_security_info() { |
||
| 1064 | $check_page = wc_get_page_permalink( 'shop' ); |
||
| 1065 | return array( |
||
| 1066 | 'secure_connection' => 'https' === substr( $check_page, 0, 5 ), |
||
| 1067 | 'hide_errors' => ! ( defined( 'WP_DEBUG' ) && defined( 'WP_DEBUG_DISPLAY' ) && WP_DEBUG && WP_DEBUG_DISPLAY ) || 0 === intval( ini_get( 'display_errors' ) ), |
||
| 1068 | ); |
||
| 1069 | } |
||
| 1070 | |||
| 1071 | /** |
||
| 1072 | * Returns a mini-report on WC pages and if they are configured correctly: |
||
| 1073 | * Present, visible, and including the correct shortcode. |
||
| 1074 | * |
||
| 1075 | * @return array |
||
| 1076 | */ |
||
| 1077 | public function get_pages() { |
||
| 1078 | // WC pages to check against. |
||
| 1079 | $check_pages = array( |
||
| 1080 | _x( 'Shop base', 'Page setting', 'woocommerce' ) => array( |
||
| 1081 | 'option' => 'woocommerce_shop_page_id', |
||
| 1082 | 'shortcode' => '', |
||
| 1083 | ), |
||
| 1084 | _x( 'Cart', 'Page setting', 'woocommerce' ) => array( |
||
| 1085 | 'option' => 'woocommerce_cart_page_id', |
||
| 1086 | 'shortcode' => '[' . apply_filters( 'woocommerce_cart_shortcode_tag', 'woocommerce_cart' ) . ']', |
||
| 1087 | ), |
||
| 1088 | _x( 'Checkout', 'Page setting', 'woocommerce' ) => array( |
||
| 1089 | 'option' => 'woocommerce_checkout_page_id', |
||
| 1090 | 'shortcode' => '[' . apply_filters( 'woocommerce_checkout_shortcode_tag', 'woocommerce_checkout' ) . ']', |
||
| 1091 | ), |
||
| 1092 | _x( 'My account', 'Page setting', 'woocommerce' ) => array( |
||
| 1093 | 'option' => 'woocommerce_myaccount_page_id', |
||
| 1094 | 'shortcode' => '[' . apply_filters( 'woocommerce_my_account_shortcode_tag', 'woocommerce_my_account' ) . ']', |
||
| 1095 | ), |
||
| 1096 | _x( 'Terms and conditions', 'Page setting', 'woocommerce' ) => array( |
||
| 1097 | 'option' => 'woocommerce_terms_page_id', |
||
| 1098 | 'shortcode' => '', |
||
| 1099 | ), |
||
| 1100 | ); |
||
| 1101 | |||
| 1102 | $pages_output = array(); |
||
| 1103 | foreach ( $check_pages as $page_name => $values ) { |
||
| 1104 | $page_id = get_option( $values['option'] ); |
||
| 1105 | $page_set = false; |
||
| 1106 | $page_exists = false; |
||
| 1107 | $page_visible = false; |
||
| 1108 | $shortcode_present = false; |
||
| 1109 | $shortcode_required = false; |
||
| 1110 | |||
| 1111 | // Page checks. |
||
| 1112 | if ( $page_id ) { |
||
| 1113 | $page_set = true; |
||
| 1114 | } |
||
| 1115 | if ( get_post( $page_id ) ) { |
||
| 1116 | $page_exists = true; |
||
| 1117 | } |
||
| 1118 | if ( 'publish' === get_post_status( $page_id ) ) { |
||
| 1119 | $page_visible = true; |
||
| 1120 | } |
||
| 1121 | |||
| 1122 | // Shortcode checks. |
||
| 1123 | if ( $values['shortcode'] && get_post( $page_id ) ) { |
||
| 1124 | $shortcode_required = true; |
||
| 1125 | $page = get_post( $page_id ); |
||
| 1126 | if ( strstr( $page->post_content, $values['shortcode'] ) ) { |
||
| 1127 | $shortcode_present = true; |
||
| 1128 | } |
||
| 1129 | } |
||
| 1130 | |||
| 1131 | // Wrap up our findings into an output array. |
||
| 1132 | $pages_output[] = array( |
||
| 1133 | 'page_name' => $page_name, |
||
| 1134 | 'page_id' => $page_id, |
||
| 1135 | 'page_set' => $page_set, |
||
| 1136 | 'page_exists' => $page_exists, |
||
| 1137 | 'page_visible' => $page_visible, |
||
| 1138 | 'shortcode' => $values['shortcode'], |
||
| 1139 | 'shortcode_required' => $shortcode_required, |
||
| 1140 | 'shortcode_present' => $shortcode_present, |
||
| 1141 | ); |
||
| 1142 | } |
||
| 1143 | |||
| 1144 | return $pages_output; |
||
| 1145 | } |
||
| 1146 | |||
| 1147 | /** |
||
| 1148 | * Get any query params needed. |
||
| 1149 | * |
||
| 1150 | * @return array |
||
| 1151 | */ |
||
| 1152 | public function get_collection_params() { |
||
| 1153 | return array( |
||
| 1154 | 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
||
| 1155 | ); |
||
| 1156 | } |
||
| 1157 | |||
| 1158 | /** |
||
| 1159 | * Prepare the system status response |
||
| 1160 | * |
||
| 1161 | * @param array $system_status System status data. |
||
| 1162 | * @param WP_REST_Request $request Request object. |
||
| 1163 | * @return WP_REST_Response |
||
| 1164 | */ |
||
| 1165 | public function prepare_item_for_response( $system_status, $request ) { |
||
| 1166 | $data = $this->add_additional_fields_to_object( $system_status, $request ); |
||
| 1167 | $data = $this->filter_response_by_context( $data, 'view' ); |
||
| 1168 | |||
| 1169 | $response = rest_ensure_response( $data ); |
||
| 1170 | |||
| 1171 | /** |
||
| 1172 | * Filter the system status returned from the REST API. |
||
| 1173 | * |
||
| 1174 | * @param WP_REST_Response $response The response object. |
||
| 1175 | * @param mixed $system_status System status |
||
| 1176 | * @param WP_REST_Request $request Request object. |
||
| 1177 | */ |
||
| 1178 | return apply_filters( 'woocommerce_rest_prepare_system_status', $response, $system_status, $request ); |
||
| 1179 | } |
||
| 1181 |
