| @@ -3,268 +3,260 @@ | ||
| 3 | 3 | namespace Boxzilla\Licensing; |
| 4 | 4 | |
| 5 | 5 | use Boxzilla\Plugin; |
| 6 | 6 | |
| 7 | -class UpdateManager | |
| 8 | -{ | |
| 9 | - /** | |
| 10 | - * @var array | |
| 11 | - */ | |
| 12 | - protected $extensions = []; | |
| 7 | +class UpdateManager { | |
| 13 | 8 | |
| 14 | - /** | |
| 15 | - * @var API | |
| 16 | - */ | |
| 17 | - protected $api; | |
| 18 | 9 | |
| 19 | - /** | |
| 20 | - * @var License | |
| 21 | - */ | |
| 22 | - protected $license; | |
| 10 | + /** | |
| 11 | + * @var array | |
| 12 | + */ | |
| 13 | + protected $extensions = array(); | |
| 23 | 14 | |
| 24 | - /** | |
| 25 | - * @var | |
| 26 | - */ | |
| 27 | - protected $available_updates; | |
| 15 | + /** | |
| 16 | + * @var API | |
| 17 | + */ | |
| 18 | + protected $api; | |
| 28 | 19 | |
| 29 | - /** | |
| 30 | - * @param array $extensions | |
| 31 | - * @param API $api | |
| 32 | - * @param License $license | |
| 33 | - */ | |
| 34 | - public function __construct(array $extensions, API $api, License $license) | |
| 35 | - { | |
| 36 | - $this->extensions = $extensions; | |
| 37 | - $this->license = $license; | |
| 38 | - $this->api = $api; | |
| 39 | - } | |
| 20 | + /** | |
| 21 | + * @var License | |
| 22 | + */ | |
| 23 | + protected $license; | |
| 40 | 24 | |
| 41 | - /** | |
| 42 | - * Add hooks | |
| 43 | - */ | |
| 44 | - public function init() | |
| 45 | - { | |
| 46 | - add_filter('pre_set_site_transient_update_plugins', [ $this, 'add_updates' ]); | |
| 47 | - add_filter('plugins_api', [ $this, 'get_plugin_info' ], 20, 3); | |
| 48 | - add_filter('http_request_args', [ $this, 'add_auth_headers' ], 10, 2); | |
| 49 | - } | |
| 25 | + /** | |
| 26 | + * @var | |
| 27 | + */ | |
| 28 | + protected $available_updates; | |
| 50 | 29 | |
| 51 | - /** | |
| 52 | - * This adds the license key header to download package requests. | |
| 53 | - * | |
| 54 | - * @param array $args | |
| 55 | - * @param string $url | |
| 56 | - * | |
| 57 | - * @return mixed | |
| 58 | - */ | |
| 59 | - public function add_auth_headers($args, $url) | |
| 60 | - { | |
| 61 | - // only act on download request's to the Boxzilla update API | |
| 62 | - if (strpos($url, $this->api->url) !== 0 || strpos($url, '/download') === false) { | |
| 63 | - return $args; | |
| 64 | - } | |
| 30 | + /** | |
| 31 | + * @param array $extensions | |
| 32 | + * @param API $api | |
| 33 | + * @param License $license | |
| 34 | + */ | |
| 35 | + public function __construct( array $extensions, API $api, License $license ) { | |
| 36 | + $this->extensions = $extensions; | |
| 37 | + $this->license = $license; | |
| 38 | + $this->api = $api; | |
| 39 | + } | |
| 65 | 40 | |
| 66 | - // only add if activation key not empty | |
| 67 | - if (empty($this->license->activation_key)) { | |
| 68 | - return $args; | |
| 69 | - } | |
| 41 | + /** | |
| 42 | + * Add hooks | |
| 43 | + */ | |
| 44 | + public function init() { | |
| 45 | + add_filter( 'pre_set_site_transient_update_plugins', array( $this, 'add_updates' ) ); | |
| 46 | + add_filter( 'plugins_api', array( $this, 'get_plugin_info' ), 20, 3 ); | |
| 47 | + add_filter( 'http_request_args', array( $this, 'add_auth_headers' ), 10, 2 ); | |
| 48 | + } | |
| 70 | 49 | |
| 71 | - if (! isset($args['headers'])) { | |
| 72 | - $args['headers'] = []; | |
| 73 | - } | |
| 50 | + /** | |
| 51 | + * This adds the license key header to download package requests. | |
| 52 | + * | |
| 53 | + * @param array $args | |
| 54 | + * @param string $url | |
| 55 | + * | |
| 56 | + * @return mixed | |
| 57 | + */ | |
| 58 | + public function add_auth_headers( $args, $url ) { | |
| 59 | + // only act on download request's to the Boxzilla update API | |
| 60 | + if ( strpos( $url, $this->api->url ) !== 0 || strpos( $url, '/download' ) === false ) { | |
| 61 | + return $args; | |
| 62 | + } | |
| 74 | 63 | |
| 75 | - $args['headers']['Authorization'] = "Bearer {$this->license->activation_key}"; | |
| 76 | - return $args; | |
| 77 | - } | |
| 64 | + // only add if activation key not empty | |
| 65 | + if ( empty( $this->license->activation_key ) ) { | |
| 66 | + return $args; | |
| 67 | + } | |
| 78 | 68 | |
| 79 | - private function get_plugin_by_slug($slug) | |
| 80 | - { | |
| 81 | - foreach ($this->extensions as $p) { | |
| 82 | - // find plugin by slug | |
| 83 | - if (dirname($p->slug()) === $slug) { | |
| 84 | - return $p; | |
| 85 | - } | |
| 86 | - } | |
| 69 | + if ( ! isset( $args['headers'] ) ) { | |
| 70 | + $args['headers'] = array(); | |
| 71 | + } | |
| 87 | 72 | |
| 88 | - return null; | |
| 89 | - } | |
| 73 | + $args['headers']['Authorization'] = sprintf( 'Bearer %s', $this->license->activation_key ); | |
| 74 | + return $args; | |
| 75 | + } | |
| 90 | 76 | |
| 91 | - /** | |
| 92 | - * @param $result | |
| 93 | - * @param string $action | |
| 94 | - * @param null $args | |
| 95 | - * | |
| 96 | - * @return object | |
| 97 | - */ | |
| 98 | - public function get_plugin_info($result, $action = '', $args = null) | |
| 99 | - { | |
| 100 | - // do nothing for unrelated requests | |
| 101 | - if ($action !== 'plugin_information' || ! isset($args->slug)) { | |
| 102 | - return $result; | |
| 103 | - } | |
| 77 | + private function get_plugin_by_slug( $slug ) { | |
| 78 | + foreach ( $this->extensions as $p ) { | |
| 79 | + // find plugin by slug | |
| 80 | + if ( dirname( $p->slug() ) === $slug ) { | |
| 81 | + return $p; | |
| 82 | + } | |
| 83 | + } | |
| 104 | 84 | |
| 105 | - // only act on our plugins | |
| 106 | - if (strpos($args->slug, 'boxzilla-') !== 0) { | |
| 107 | - return $result; | |
| 108 | - } | |
| 85 | + return null; | |
| 86 | + } | |
| 109 | 87 | |
| 110 | - return $this->get_update_info($args->slug); | |
| 111 | - } | |
| 88 | + /** | |
| 89 | + * @param $result | |
| 90 | + * @param string $action | |
| 91 | + * @param null $args | |
| 92 | + * | |
| 93 | + * @return object | |
| 94 | + */ | |
| 95 | + public function get_plugin_info( $result, $action = '', $args = null ) { | |
| 96 | + // do nothing for unrelated requests | |
| 97 | + if ( $action !== 'plugin_information' || ! isset( $args->slug ) ) { | |
| 98 | + return $result; | |
| 99 | + } | |
| 112 | 100 | |
| 113 | - /** | |
| 114 | - * @param object $updates | |
| 115 | - * @return object | |
| 116 | - */ | |
| 117 | - public function add_updates($updates) | |
| 118 | - { | |
| 101 | + // only act on our plugins | |
| 102 | + if ( strpos( $args->slug, 'boxzilla-' ) !== 0 ) { | |
| 103 | + return $result; | |
| 104 | + } | |
| 119 | 105 | |
| 120 | - // do nothing if no plugins registered | |
| 121 | - if (empty($this->extensions)) { | |
| 122 | - return $updates; | |
| 123 | - } | |
| 106 | + return $this->get_update_info( $args->slug ); | |
| 107 | + } | |
| 124 | 108 | |
| 125 | - // failsafe WP bug | |
| 126 | - if (empty($updates) || ! isset($updates->response) || ! is_array($updates->response)) { | |
| 127 | - return $updates; | |
| 128 | - } | |
| 109 | + /** | |
| 110 | + * @param object $updates | |
| 111 | + * @return object | |
| 112 | + */ | |
| 113 | + public function add_updates( $updates ) { | |
| 129 | 114 | |
| 130 | - // fetch available updates | |
| 131 | - $available_updates = $this->fetch_updates(); | |
| 115 | + // do nothing if no plugins registered | |
| 116 | + if ( empty( $this->extensions ) ) { | |
| 117 | + return $updates; | |
| 118 | + } | |
| 132 | 119 | |
| 133 | - // merge with other updates | |
| 134 | - $updates->response = array_merge($updates->response, $available_updates); | |
| 120 | + // failsafe WP bug | |
| 121 | + if ( empty( $updates ) || ! isset( $updates->response ) || ! is_array( $updates->response ) ) { | |
| 122 | + return $updates; | |
| 123 | + } | |
| 135 | 124 | |
| 136 | - return $updates; | |
| 137 | - } | |
| 125 | + // fetch available updates | |
| 126 | + $available_updates = $this->fetch_updates(); | |
| 138 | 127 | |
| 139 | - /** | |
| 140 | - * Fetch array of available updates from remote server | |
| 141 | - * | |
| 142 | - * @return array | |
| 143 | - */ | |
| 144 | - protected function fetch_updates() | |
| 145 | - { | |
| 146 | - if (is_array($this->available_updates)) { | |
| 147 | - return $this->available_updates; | |
| 148 | - } | |
| 128 | + // merge with other updates | |
| 129 | + $updates->response = array_merge( $updates->response, $available_updates ); | |
| 149 | 130 | |
| 150 | - // don't try if we failed a request recently. | |
| 151 | - $failed_at = get_transient('boxzilla_request_failed'); | |
| 152 | - if (! empty($failed_at) && ( ( strtotime('now') - 300 ) < $failed_at )) { | |
| 153 | - return []; | |
| 154 | - } | |
| 131 | + return $updates; | |
| 132 | + } | |
| 155 | 133 | |
| 156 | - // fetch remote info | |
| 157 | - try { | |
| 158 | - $remote_plugins = $this->api->get_plugins(); | |
| 159 | - } catch (API_Exception $e) { | |
| 160 | - // set flag for 5 minutes | |
| 161 | - set_transient('boxzilla_request_failed', strtotime('now'), 300); | |
| 162 | - return []; | |
| 163 | - } | |
| 134 | + /** | |
| 135 | + * Fetch array of available updates from remote server | |
| 136 | + * | |
| 137 | + * @return array | |
| 138 | + */ | |
| 139 | + protected function fetch_updates() { | |
| 140 | + if ( is_array( $this->available_updates ) ) { | |
| 141 | + return $this->available_updates; | |
| 142 | + } | |
| 164 | 143 | |
| 165 | - // filter remote plugins, we only want the ones with an update available | |
| 166 | - $this->available_updates = $this->filter_remote_plugins($remote_plugins); | |
| 144 | + // don't try if we failed a request recently. | |
| 145 | + $failed_at = get_transient( 'boxzilla_request_failed' ); | |
| 146 | + if ( ! empty( $failed_at ) && ( ( strtotime( 'now' ) - 300 ) < $failed_at ) ) { | |
| 147 | + return array(); | |
| 148 | + } | |
| 167 | 149 | |
| 168 | - return $this->available_updates; | |
| 169 | - } | |
| 150 | + // fetch remote info | |
| 151 | + try { | |
| 152 | + $remote_plugins = $this->api->get_plugins(); | |
| 153 | + } catch ( API_Exception $e ) { | |
| 154 | + // set flag for 5 minutes | |
| 155 | + set_transient( 'boxzilla_request_failed', strtotime( 'now' ), 300 ); | |
| 156 | + return array(); | |
| 157 | + } | |
| 170 | 158 | |
| 171 | - /** | |
| 172 | - * @param $remote_plugins | |
| 173 | - * @return array | |
| 174 | - */ | |
| 175 | - protected function filter_remote_plugins($remote_plugins) | |
| 176 | - { | |
| 177 | - $available_updates = []; | |
| 159 | + // filter remote plugins, we only want the ones with an update available | |
| 160 | + $this->available_updates = $this->filter_remote_plugins( $remote_plugins ); | |
| 178 | 161 | |
| 179 | - // find new versions | |
| 180 | - foreach ($remote_plugins as $remote_plugin) { | |
| 181 | - // sanity check | |
| 182 | - if (! isset($remote_plugin->new_version)) { | |
| 183 | - continue; | |
| 184 | - } | |
| 162 | + return $this->available_updates; | |
| 163 | + } | |
| 185 | 164 | |
| 186 | - // if plugin is activated, we can access it here | |
| 187 | - if (isset($this->extensions[ $remote_plugin->sid ])) { | |
| 165 | + /** | |
| 166 | + * @param $remote_plugins | |
| 167 | + * @return array | |
| 168 | + */ | |
| 169 | + protected function filter_remote_plugins( $remote_plugins ) { | |
| 170 | + $available_updates = array(); | |
| 188 | 171 | |
| 189 | - /** @var Plugin $local_plugin */ | |
| 190 | - $local_plugin = $this->extensions[ $remote_plugin->sid ]; | |
| 172 | + // find new versions | |
| 173 | + foreach ( $remote_plugins as $remote_plugin ) { | |
| 191 | 174 | |
| 192 | - // plugin found and local plugin version not same as remote version? | |
| 193 | - if (! $local_plugin || version_compare($local_plugin->version(), $remote_plugin->new_version, '>=')) { | |
| 194 | - continue; | |
| 195 | - } | |
| 175 | + // sanity check | |
| 176 | + if ( ! isset( $remote_plugin->new_version ) ) { | |
| 177 | + continue; | |
| 178 | + } | |
| 196 | 179 | |
| 197 | - // add some dynamic data | |
| 198 | - $available_updates[ $local_plugin->slug() ] = $this->format_response($local_plugin->slug(), $remote_plugin); | |
| 199 | - } else { | |
| 200 | - // if plugin is not active, use get_plugin_data for fetching version | |
| 201 | - $plugin_file = WP_PLUGIN_DIR . "/{$remote_plugin->slug}/{$remote_plugin->slug}.php"; | |
| 202 | - if (! file_exists($plugin_file)) { | |
| 203 | - continue; | |
| 204 | - } | |
| 180 | + // if plugin is activated, we can access it here | |
| 181 | + if ( isset( $this->extensions[ $remote_plugin->sid ] ) ) { | |
| 205 | 182 | |
| 206 | - $plugin_data = get_plugin_data($plugin_file); | |
| 183 | + /** @var Plugin $local_plugin */ | |
| 184 | + $local_plugin = $this->extensions[ $remote_plugin->sid ]; | |
| 207 | 185 | |
| 208 | - if (! $plugin_data || version_compare($plugin_data['Version'], $remote_plugin->new_version, '>=')) { | |
| 209 | - continue; | |
| 210 | - } | |
| 186 | + // plugin found and local plugin version not same as remote version? | |
| 187 | + if ( ! $local_plugin || version_compare( $local_plugin->version(), $remote_plugin->new_version, '>=' ) ) { | |
| 188 | + continue; | |
| 189 | + } | |
| 211 | 190 | |
| 212 | - // add some dynamic data | |
| 213 | - $slug = plugin_basename($plugin_file); | |
| 214 | - $available_updates[ $slug ] = $this->format_response($slug, $remote_plugin); | |
| 215 | - } | |
| 216 | - } | |
| 191 | + // add some dynamic data | |
| 192 | + $available_updates[ $local_plugin->slug() ] = $this->format_response( $local_plugin->slug(), $remote_plugin ); | |
| 193 | + } else { | |
| 194 | + // if plugin is not active, use get_plugin_data for fetching version | |
| 195 | + $plugin_file = WP_PLUGIN_DIR . "/{$remote_plugin->slug}/{$remote_plugin->slug}.php"; | |
| 196 | + if ( ! file_exists( $plugin_file ) ) { | |
| 197 | + continue; | |
| 198 | + } | |
| 217 | 199 | |
| 218 | - return $available_updates; | |
| 219 | - } | |
| 200 | + $plugin_data = get_plugin_data( $plugin_file ); | |
| 220 | 201 | |
| 221 | - /** | |
| 222 | - * @param string $slug | |
| 223 | - * | |
| 224 | - * @return null | |
| 225 | - */ | |
| 226 | - public function get_update_info($slug) | |
| 227 | - { | |
| 228 | - $available_updates = $this->fetch_updates(); | |
| 202 | + if ( ! $plugin_data || version_compare( $plugin_data['Version'], $remote_plugin->new_version, '>=' ) ) { | |
| 203 | + continue; | |
| 204 | + } | |
| 229 | 205 | |
| 230 | - foreach ($available_updates as $plugin_file => $update_info) { | |
| 231 | - if ($slug === $update_info->slug) { | |
| 232 | - return $update_info; | |
| 233 | - } | |
| 234 | - } | |
| 206 | + // add some dynamic data | |
| 207 | + $slug = plugin_basename( $plugin_file ); | |
| 208 | + $available_updates[ $slug ] = $this->format_response( $slug, $remote_plugin ); | |
| 209 | + } | |
| 210 | + } | |
| 235 | 211 | |
| 236 | - return null; | |
| 237 | - } | |
| 212 | + return $available_updates; | |
| 213 | + } | |
| 238 | 214 | |
| 239 | - /** | |
| 240 | - * @param $slug | |
| 241 | - * @param $response | |
| 242 | - * | |
| 243 | - * @return mixed | |
| 244 | - */ | |
| 245 | - protected function format_response($slug, $response) | |
| 246 | - { | |
| 247 | - $response->slug = dirname($slug); | |
| 248 | - $response->plugin = $slug; | |
| 215 | + /** | |
| 216 | + * @param string $slug | |
| 217 | + * | |
| 218 | + * @return null | |
| 219 | + */ | |
| 220 | + public function get_update_info( $slug ) { | |
| 221 | + $available_updates = $this->fetch_updates(); | |
| 249 | 222 | |
| 250 | - // add some notices if license is inactive | |
| 251 | - if (! $this->license->activated) { | |
| 252 | - $response->upgrade_notice = sprintf('You will need to <a href="%s">activate your license</a> to install this plugin update.', admin_url('edit.php?post_type=boxzilla-box&page=boxzilla-settings')); | |
| 253 | - $response->sections->changelog = '<p>' . sprintf('You will need to <a href="%s" target="_top">activate your license</a> to install this plugin update.', admin_url('edit.php?post_type=boxzilla-box&page=boxzilla-settings')) . '</p>' . $response->sections->changelog; | |
| 254 | - $response->package = null; | |
| 255 | - } | |
| 223 | + foreach ( $available_updates as $plugin_file => $update_info ) { | |
| 224 | + if ( $slug === $update_info->slug ) { | |
| 225 | + return $update_info; | |
| 226 | + } | |
| 227 | + } | |
| 256 | 228 | |
| 257 | - // cast subkey objects to array as that is what WP expects | |
| 258 | - $response->sections = get_object_vars($response->sections); | |
| 259 | - $response->banners = get_object_vars($response->banners); | |
| 260 | - $response->contributors = get_object_vars($response->contributors); | |
| 261 | - $response->contributors = array_map( | |
| 262 | - function ($v) { | |
| 263 | - return get_object_vars($v); | |
| 264 | - }, | |
| 265 | - $response->contributors | |
| 266 | - ); | |
| 229 | + return null; | |
| 230 | + } | |
| 267 | 231 | |
| 268 | - return $response; | |
| 269 | - } | |
| 232 | + /** | |
| 233 | + * @param $slug | |
| 234 | + * @param $response | |
| 235 | + * | |
| 236 | + * @return mixed | |
| 237 | + */ | |
| 238 | + protected function format_response( $slug, $response ) { | |
| 239 | + $response->slug = dirname( $slug ); | |
| 240 | + $response->plugin = $slug; | |
| 241 | + | |
| 242 | + // add some notices if license is inactive | |
| 243 | + if ( ! $this->license->activated ) { | |
| 244 | + $response->upgrade_notice = sprintf( 'You will need to <a href="%s">activate your license</a> to install this plugin update.', admin_url( 'edit.php?post_type=boxzilla-box&page=boxzilla-settings' ) ); | |
| 245 | + $response->sections->changelog = '<p>' . sprintf( 'You will need to <a href="%s" target="_top">activate your license</a> to install this plugin update.', admin_url( 'edit.php?post_type=boxzilla-box&page=boxzilla-settings' ) ) . '</p>' . $response->sections->changelog; | |
| 246 | + $response->package = null; | |
| 247 | + } | |
| 248 | + | |
| 249 | + // cast subkey objects to array as that is what WP expects | |
| 250 | + $response->sections = get_object_vars( $response->sections ); | |
| 251 | + $response->banners = get_object_vars( $response->banners ); | |
| 252 | + $response->contributors = get_object_vars( $response->contributors ); | |
| 253 | + $response->contributors = array_map( | |
| 254 | + function ( $v ) { | |
| 255 | + return get_object_vars( $v ); | |
| 256 | + }, | |
| 257 | + $response->contributors | |
| 258 | + ); | |
| 259 | + | |
| 260 | + return $response; | |
| 261 | + } | |
| 270 | 262 | } |
