mainwp / class / class-mainwp-api-manager-plugin-update.php

class-mainwp-api-manager-plugin-update.php in MainWP Dashboard: Self-hosted WordPress Management for Agencies 5.2.2, at class/class-mainwp-api-manager-plugin-update.php

211 lines 6.1 KB

Raw Download Zip

1	<?php
2	/**
3	* MainWP API Manager Update Handler
4	*
5	* This class handles updates for MainWP Extension.
6	*
7	* @package MainWP API Manager/Update Handler
8	*/
9
10	namespace MainWP\Dashboard;
11
12	// Exit if accessed directly.
13	if ( ! defined( 'ABSPATH' ) ) {
14	exit;
15	}
16
17	/**
18	* Class MainWP_Api_Manager_Plugin_Update
19	*
20	* MainWP API Manager Update Handler.
21	*
22	* @package MainWP API Manager/Update Handler
23	* @author Todd Lahman LLC
24	* @copyright Copyright (c) Todd Lahman LLC
25	* @since 1.0.0
26	*/
27	class MainWP_Api_Manager_Plugin_Update { // phpcs:ignore Generic.Classes.OpeningBraceSameLine.ContentAfterBrace -- NOSONAR.
28
29	/**
30	* Protected static variable to hold the instance.
31	*
32	* @var null Default value.
33	*/
34	protected static $instance = null;
35
36	/**
37	* Method instance()
38	*
39	* @static
40	* @return class instance
41	*/
42	public static function instance() {
43	if ( is_null( static::$instance ) ) {
44	static::$instance = new self();
45	}
46
47	return static::$instance;
48	}
49
50	/**
51	* MainWP_Api_Manager_Plugin_Update constructor.
52	*
53	* Run each time the class is called.
54	*/
55	public function __construct() {
56	// API data.
57	}
58
59	/**
60	* Create upgrade request API URL.
61	*
62	* @param array $args Request arguments.
63	*
64	* @return string Build URL.
65	*
66	* @uses \MainWP\Dashboard\MainWP_Api_Manager::get_upgrade_url()
67	*/
68	private function create_upgrade_api_url( $args ) {
69	$upgrade_url = esc_url_raw( add_query_arg( 'mainwp-api', 'am-software-api', MainWP_Api_Manager::instance()->get_upgrade_url() ) );
70
71	$query_url = '';
72	foreach ( $args as $key => $value ) {
73	$query_url .= $key . '=' . rawurlencode( $value ) . '&';
74	}
75	$query_url = rtrim( $query_url, '&' );
76
77	return $upgrade_url . '&' . $query_url;
78	}
79
80	/**
81	* Returns plugin information in an array.
82	*
83	* @param array $plugin Plugin to check.
84	*
85	* @return array Plugin information.
86	*/
87	public function update_check( $plugin ) {
88
89	$args = array(
90	'request' => 'pluginupdatecheck',
91	'plugin_name' => $plugin['plugin_name'],
92	'version' => $plugin['software_version'],
93	'product_id' => $plugin['product_id'],
94	'api_key' => $plugin['api_key'],
95	'instance' => $plugin['instance'],
96	'software_version' => $plugin['software_version'],
97	'extra' => isset( $plugin['extra'] ) ? $plugin['extra'] : '',
98	);
99
100	// Check for a plugin update.
101	return $this->plugin_information( $args ); // pluginupdatecheck.
102	}
103
104
105	/**
106	* Check if bulkupdateapi is true\|false & grab domain name adn extensions list.
107	*
108	* @param array $plugins List of plugins (extensions).
109	*
110	* @return array Plugin Information & bulkupdatecheck.
111	*/
112	public function bulk_update_check( $plugins ) {
113
114	$args = array(
115	'request' => 'bulkupdatecheck',
116	'extensions' => base64_encode( wp_json_encode( $plugins ) ), // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions -- base64_encode used for http encoding compatible.
117	'json' => true,
118	);
119
120	$mainwp_api_key = MainWP_Api_Manager_Key::instance()->get_decrypt_master_api_key();
121
122	if ( ! empty( $mainwp_api_key ) ) {
123	$args['api_key'] = $mainwp_api_key;
124	}
125
126	return $this->plugin_information( $args, true ); // bulkupdatecheck.
127	}
128
129
130	/**
131	* Check $args, if there is a response, an object exists & response is not false.
132	*
133	* @param array $args Request arguments.
134	*
135	* @return array\|false $response Plugin information.
136	*/
137	public function request( $args ) {
138	$args['request'] = 'plugininformation';
139
140	$response = $this->plugin_information( $args ); // plugininformation.
141
142	// If everything is okay return the response.
143	if ( isset( $response ) && is_object( $response ) && false !== $response ) {
144	return $response;
145	}
146	}
147
148	/**
149	* Sends and receives data to and from the server API.
150	*
151	* @access public
152	*
153	* @param array $args Request arguments.
154	* @param bool $bulk_check Check if updating in bulk true\|false.
155	*
156	* @return array\|false Plugin information.
157	* @since 1.0.0
158	*
159	* @uses \MainWP\Dashboard\MainWP_System_Utility::maybe_unserialyze()
160	*/
161	public function plugin_information( $args, $bulk_check = false ) {
162
163	$args['object'] = MainWP_Api_Manager::instance()->get_domain();
164
165	$target_url = $this->create_upgrade_api_url( $args );
166	$default = array(
167	'timeout' => 150,
168	'sslverify' => 1,
169	);
170
171	$params = apply_filters( 'mainwp_plugin_information_sslverify', $default, $args );
172
173	$request = wp_remote_get(
174	$target_url,
175	$params
176	);
177
178	if ( is_wp_error( $request ) \|\| wp_remote_retrieve_response_code( $request ) !== 200 ) {
179	return false;
180	}
181
182	$response = wp_remote_retrieve_body( $request );
183
184	if ( isset( $args['json'] ) ) { // bulkupdatecheck: json.
185	$response = json_decode( $response, true );
186	} else { // pluginupdatecheck, plugininformation : serialize.
187	$response = unserialize( $response ); // phpcs:ignore -- data from extensions, to compatible.
188	}
189
190	/**
191	* For debugging errors from the API
192	* For errors like: unserialize(): Error at offset 0 of 170 bytes
193	* Comment out $response above first
194	*/
195	if ( ! $bulk_check ) {
196	if ( is_object( $response ) ) {
197	if ( isset( $response->package ) ) {
198	$response->package = apply_filters( 'mainwp_api_manager_upgrade_package_url', $response->package, $response );
199	}
200	return $response;
201	}
202	} elseif ( is_array( $response ) ) {
203	return $response;
204	}
205
206	return false;
207	}
208	}
209
210	// End of class.
211