ArrayUtil.php
7 months ago
BlocksUtil.php
5 months ago
COTMigrationUtil.php
1 year ago
DatabaseUtil.php
1 year ago
FilesystemUtil.php
3 months ago
HtmlSanitizer.php
2 years ago
LegacyRestApiStub.php
4 weeks ago
PluginInstaller.php
1 year ago
ProductUtil.php
9 months ago
Types.php
1 year ago
URL.php
1 year ago
URLException.php
4 years ago
Users.php
4 months ago
WebhookUtil.php
4 weeks ago
PluginInstaller.php
323 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Automattic\WooCommerce\Internal\Utilities; |
| 4 | |
| 5 | use Automattic\WooCommerce\Internal\RegisterHooksInterface; |
| 6 | use Automattic\WooCommerce\Utilities\{ PluginUtil, StringUtil }; |
| 7 | |
| 8 | /** |
| 9 | * This class allows installing a plugin programmatically. |
| 10 | * |
| 11 | * Information about plugins installed in that way will be stored in a 'woocommerce_autoinstalled_plugins' option, |
| 12 | * and a notice will be shown under the plugin name in the plugins list indicating that it was automatically |
| 13 | * installed (these notices can be disabled with the 'woocommerce_show_autoinstalled_plugin_notices' hook). |
| 14 | * |
| 15 | * Currently it's only possible to install new plugins, not to upgrade or reinstall already installed plugins. |
| 16 | * |
| 17 | * The 'upgrader_process_complete' hook is used to remove the autoinstall information from any plugin that is later |
| 18 | * upgraded or reinstalled by any means other than the usage of this class. |
| 19 | */ |
| 20 | class PluginInstaller implements RegisterHooksInterface { |
| 21 | |
| 22 | /** |
| 23 | * Flag indicating that a plugin install is in progress, so the upgrader_process_complete hook must be ignored. |
| 24 | * |
| 25 | * @var bool |
| 26 | */ |
| 27 | private bool $installing_plugin = false; |
| 28 | |
| 29 | /** |
| 30 | * Attach hooks used by the class. |
| 31 | */ |
| 32 | public function register() { |
| 33 | add_action( 'after_plugin_row', array( $this, 'handle_plugin_list_rows' ), 10, 2 ); |
| 34 | add_action( 'upgrader_process_complete', array( $this, 'handle_upgrader_process_complete' ), 10, 2 ); |
| 35 | } |
| 36 | |
| 37 | /** |
| 38 | * Programmatically installs a plugin. Upgrade/reinstall of already existing plugins is not supported. |
| 39 | * The plugin source must be the WordPress.org plugins directory. |
| 40 | * |
| 41 | * $metadata can contain anything, but the following keys are recognized by the code that renders the notice |
| 42 | * in the plugins list: |
| 43 | * |
| 44 | * - 'installed_by': defaults to 'WooCommerce' if not present. |
| 45 | * - 'info_link': if present, a "More information" link will be included in the notice. |
| 46 | * |
| 47 | * If 'installed_by' is supplied and it's not 'WooCommerce' (case-insensitive), an exception will be thrown |
| 48 | * if the code calling this method is not in a WooCommerce core file (in 'includes' or in 'src'). |
| 49 | * |
| 50 | * Information about plugins successfully installed with this method will be kept in an option named |
| 51 | * 'woocommerce_autoinstalled_plugins'. Keys will be the plugin name and values will be associative arrays |
| 52 | * with these keys: 'plugin_name', 'version', 'date' and 'metadata' (same meaning as in the returned array). |
| 53 | * |
| 54 | * A log entry will be created with the result of the process and all the installer messages |
| 55 | * (source: 'plugin_auto_installs'). In multisite this log entry will be created on each site. |
| 56 | * |
| 57 | * The returned array will contain the following (only 'install_ok' and 'messages' if the installation fails): |
| 58 | * |
| 59 | * - 'install_ok', a boolean. |
| 60 | * - 'messages', all the messages generated by the installer. |
| 61 | * - 'plugin_name', in the form of 'directory/file.php' (taken from the instance of PluginInstaller used). |
| 62 | * - 'version', of the plugin that has been installed. |
| 63 | * - 'date', ISO-formatted installation date. |
| 64 | * - 'metadata', as supplied (except the 'plugin_name' key) and only if not empty. |
| 65 | * |
| 66 | * If the plugin is already in the process of being installed (can happen in multisite), the returned array |
| 67 | * will contain only one key: 'already_installing', with a value of true. |
| 68 | * |
| 69 | * @param string $plugin_url URL or file path of the plugin to install. |
| 70 | * @param array $metadata Metadata to store if the installation succeeds. |
| 71 | * @return array Information about the installation result. |
| 72 | * @throws \InvalidArgumentException Source doesn't start with 'https://downloads.wordpress.org/', or installer name is 'WooCommerce' but caller is not WooCommerce core code. |
| 73 | */ |
| 74 | public function install_plugin( string $plugin_url, array $metadata = array() ): array { |
| 75 | $this->installing_plugin = true; |
| 76 | |
| 77 | $plugins_being_installed = get_site_option( 'woocommerce_autoinstalling_plugins', array() ); |
| 78 | if ( in_array( $plugin_url, $plugins_being_installed, true ) ) { |
| 79 | return array( 'already_installing' => true ); |
| 80 | } |
| 81 | $plugins_being_installed[] = $plugin_url; |
| 82 | update_site_option( 'woocommerce_autoinstalling_plugins', $plugins_being_installed ); |
| 83 | |
| 84 | try { |
| 85 | return $this->install_plugin_core( $plugin_url, $metadata ); |
| 86 | } finally { |
| 87 | $plugins_being_installed = array_diff( $plugins_being_installed, array( $plugin_url ) ); |
| 88 | if ( empty( $plugins_being_installed ) ) { |
| 89 | delete_site_option( 'woocommerce_autoinstalling_plugins' ); |
| 90 | } else { |
| 91 | update_site_option( 'woocommerce_autoinstalling_plugins', $plugins_being_installed ); |
| 92 | } |
| 93 | |
| 94 | $this->installing_plugin = false; |
| 95 | } |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Core version of 'install_plugin' (it doesn't handle the $installing_plugin flag). |
| 100 | * |
| 101 | * @param string $plugin_url URL or file path of the plugin to install. |
| 102 | * @param array $metadata Metadata to store if the installation succeeds. |
| 103 | * @return array Information about the installation result. |
| 104 | * @throws \InvalidArgumentException Source doesn't start with 'https://downloads.wordpress.org/', or installer name is 'WooCommerce' but caller is not WooCommerce core code. |
| 105 | */ |
| 106 | private function install_plugin_core( string $plugin_url, array $metadata ): array { |
| 107 | if ( ! StringUtil::starts_with( $plugin_url, 'https://downloads.wordpress.org/', false ) ) { |
| 108 | throw new \InvalidArgumentException( "Only installs from the WordPress.org plugins directory (plugin URL starting with 'https://downloads.wordpress.org/') are allowed." ); |
| 109 | } |
| 110 | |
| 111 | $installed_by = $metadata['installed_by'] ?? 'WooCommerce'; |
| 112 | if ( 0 === strcasecmp( 'WooCommerce', $installed_by ) ) { |
| 113 | // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_debug_backtrace |
| 114 | $calling_file = StringUtil::normalize_local_path_slashes( debug_backtrace()[1]['file'] ?? '' ); // [1], not [0], because the immediate caller is the install_plugin method. |
| 115 | if ( ! StringUtil::starts_with( $calling_file, StringUtil::normalize_local_path_slashes( WC_ABSPATH . 'includes/' ) ) && ! StringUtil::starts_with( $calling_file, StringUtil::normalize_local_path_slashes( WC_ABSPATH . 'src/' ) ) ) { |
| 116 | throw new \InvalidArgumentException( "If the value of 'installed_by' is 'WooCommerce', the caller of the method must be a WooCommerce core class or function." ); |
| 117 | } |
| 118 | } |
| 119 | |
| 120 | if ( ! class_exists( \Automatic_Upgrader_Skin::class ) ) { |
| 121 | include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader-skin.php'; |
| 122 | include_once ABSPATH . 'wp-admin/includes/class-automatic-upgrader-skin.php'; |
| 123 | } |
| 124 | $skin = new \Automatic_Upgrader_Skin(); |
| 125 | |
| 126 | if ( ! class_exists( \Plugin_Upgrader::class ) ) { |
| 127 | include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php'; |
| 128 | } |
| 129 | $upgrader = new \Plugin_Upgrader( $skin ); |
| 130 | |
| 131 | $install_ok = $upgrader->install( $plugin_url ); |
| 132 | |
| 133 | $result = array( 'messages' => $skin->get_upgrade_messages() ); |
| 134 | |
| 135 | if ( $install_ok ) { |
| 136 | if ( ! function_exists( 'get_plugins' ) ) { |
| 137 | require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
| 138 | } |
| 139 | $plugin_name = $upgrader->plugin_info(); |
| 140 | $plugin_version = get_plugins()[ $plugin_name ]['Version']; |
| 141 | |
| 142 | $result['plugin_name'] = $plugin_name; |
| 143 | $plugin_data = array( |
| 144 | 'version' => $plugin_version, |
| 145 | 'date' => current_time( 'mysql' ), |
| 146 | ); |
| 147 | if ( ! empty( $metadata ) ) { |
| 148 | $plugin_data['metadata'] = $metadata; |
| 149 | } |
| 150 | |
| 151 | $auto_installed_plugins = get_site_option( 'woocommerce_autoinstalled_plugins', array() ); |
| 152 | $auto_installed_plugins[ $plugin_name ] = $plugin_data; |
| 153 | update_site_option( 'woocommerce_autoinstalled_plugins', $auto_installed_plugins ); |
| 154 | |
| 155 | $auto_installed_plugins_history = get_site_option( 'woocommerce_history_of_autoinstalled_plugins', array() ); |
| 156 | if ( ! isset( $auto_installed_plugins_history[ $plugin_name ] ) ) { |
| 157 | $auto_installed_plugins_history[ $plugin_name ] = $plugin_data; |
| 158 | update_site_option( 'woocommerce_history_of_autoinstalled_plugins', $auto_installed_plugins_history ); |
| 159 | } |
| 160 | |
| 161 | $post_install = function () use ( $plugin_name, $plugin_version, $installed_by, $plugin_url, $plugin_data ) { |
| 162 | $log_context = array( |
| 163 | 'source' => 'plugin_auto_installs', |
| 164 | 'recorded_data' => $plugin_data, |
| 165 | ); |
| 166 | |
| 167 | wc_get_logger()->info( "Plugin $plugin_name v{$plugin_version} installed by $installed_by, source: $plugin_url", $log_context ); |
| 168 | }; |
| 169 | } else { |
| 170 | $messages = $skin->get_upgrade_messages(); |
| 171 | $post_install = function () use ( $plugin_url, $installed_by, $messages ) { |
| 172 | $log_context = array( |
| 173 | 'source' => 'plugin_auto_installs', |
| 174 | 'installer_messages' => $messages, |
| 175 | ); |
| 176 | wc_get_logger()->error( "$installed_by failed to install plugin from source: $plugin_url", $log_context ); |
| 177 | }; |
| 178 | } |
| 179 | |
| 180 | if ( is_multisite() ) { |
| 181 | // We log the install in the main site, unless the main site doesn't have WooCommerce installed; |
| 182 | // in that case we fallback to logging in the current site. |
| 183 | switch_to_blog( get_main_site_id() ); |
| 184 | if ( self::woocommerce_is_active_in_current_site() ) { |
| 185 | $post_install(); |
| 186 | restore_current_blog(); |
| 187 | } else { |
| 188 | restore_current_blog(); |
| 189 | $post_install(); |
| 190 | } |
| 191 | } else { |
| 192 | $post_install(); |
| 193 | } |
| 194 | |
| 195 | $result['install_ok'] = $install_ok ?? false; |
| 196 | return $result; |
| 197 | } |
| 198 | |
| 199 | /** |
| 200 | * Check if WooCommerce is installed and active in the current blog. |
| 201 | * This is useful for multisite installs when a blog other than the one running this code is selected with 'switch_to_blog'. |
| 202 | * |
| 203 | * @return bool True if WooCommerce is installed and active in the current blog, false otherwise. |
| 204 | */ |
| 205 | private static function woocommerce_is_active_in_current_site(): bool { |
| 206 | $active_valid_plugins = wc_get_container()->get( PluginUtil::class )->get_all_active_valid_plugins(); |
| 207 | |
| 208 | return ! empty( |
| 209 | array_filter( |
| 210 | $active_valid_plugins, |
| 211 | fn( $plugin ) => substr_compare( $plugin, '/woocommerce.php', -strlen( '/woocommerce.php' ) ) === 0 |
| 212 | ) |
| 213 | ); |
| 214 | } |
| 215 | |
| 216 | /** |
| 217 | * Handler for the 'plugin_list_rows' hook, it will display a notice under the name of the plugins |
| 218 | * that have been installed using this class (unless the 'woocommerce_show_autoinstalled_plugin_notices' filter |
| 219 | * returns false) in the plugins list page. |
| 220 | * |
| 221 | * @param string $plugin_file Name of the plugin. |
| 222 | * @param array $plugin_data Plugin data. |
| 223 | * |
| 224 | * @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed. |
| 225 | */ |
| 226 | public function handle_plugin_list_rows( $plugin_file, $plugin_data ) { |
| 227 | global $wp_list_table; |
| 228 | |
| 229 | if ( is_null( $wp_list_table ) ) { |
| 230 | return; |
| 231 | } |
| 232 | |
| 233 | /** |
| 234 | * Filter to suppress the notice about autoinstalled plugins in the plugins list page. |
| 235 | * |
| 236 | * @since 8.8.0 |
| 237 | * |
| 238 | * @param bool $display_notice Whether notices should be displayed or not. |
| 239 | * @returns bool |
| 240 | */ |
| 241 | if ( ! apply_filters( 'woocommerce_show_autoinstalled_plugin_notices', '__return_true' ) ) { |
| 242 | return; |
| 243 | } |
| 244 | |
| 245 | $auto_installed_plugins_info = get_site_option( 'woocommerce_autoinstalled_plugins', array() ); |
| 246 | $current_plugin_info = $auto_installed_plugins_info[ $plugin_file ] ?? null; |
| 247 | if ( is_null( $current_plugin_info ) || $current_plugin_info['version'] !== $plugin_data['Version'] ) { |
| 248 | return; |
| 249 | } |
| 250 | |
| 251 | $installed_by = $current_plugin_info['metadata']['installed_by'] ?? 'WooCommerce'; |
| 252 | $info_link = $current_plugin_info['metadata']['info_link'] ?? null; |
| 253 | if ( $info_link ) { |
| 254 | /* translators: 1 = who installed the plugin, 2 = ISO-formatted date and time, 3 = URL */ |
| 255 | $message = sprintf( __( 'Plugin installed by %1$s on %2$s. <a target="_blank" href="%3$s">More information</a>', 'woocommerce' ), $installed_by, $current_plugin_info['date'], $info_link ); |
| 256 | } else { |
| 257 | /* translators: 1 = who installed the plugin, 2 = ISO-formatted date and time */ |
| 258 | $message = sprintf( __( 'Plugin installed by %1$s on %2$s.', 'woocommerce' ), $installed_by, $current_plugin_info['date'] ); |
| 259 | } |
| 260 | |
| 261 | $columns_count = $wp_list_table->get_column_count(); |
| 262 | $is_active = is_plugin_active( $plugin_file ); |
| 263 | $is_active_class = $is_active ? 'active' : 'inactive'; |
| 264 | $is_active_td_style = $is_active ? "style='border-left: 4px solid #72aee6;'" : ''; |
| 265 | |
| 266 | // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped |
| 267 | ?> |
| 268 | <tr class='plugin-update-tr update <?php echo $is_active_class; ?>' data-plugin='<?php echo $plugin_file; ?>' data-plugin-row-type='feature-incomp-warn'> |
| 269 | <td colspan='<?php echo $columns_count; ?>' class='plugin-update'<?php echo $is_active_td_style; ?>> |
| 270 | <div class='notice inline notice-success notice-alt'> |
| 271 | <p> |
| 272 | ℹ️ <?php echo $message; ?> |
| 273 | </p> |
| 274 | </div> |
| 275 | </td> |
| 276 | </tr> |
| 277 | <?php |
| 278 | // phpcs:enable WordPress.Security.EscapeOutput.OutputNotEscaped |
| 279 | } |
| 280 | |
| 281 | /** |
| 282 | * Handler for the 'upgrader_process_complete' hook. It's used to remove the autoinstalled plugin information |
| 283 | * for plugins that are upgraded or reinstalled manually (or more generally, by using any install method |
| 284 | * other than this class). |
| 285 | * |
| 286 | * @param \WP_Upgrader $upgrader The upgrader class that has performed the plugin upgrade/reinstall. |
| 287 | * @param array $hook_extra Extra information about the upgrade process. |
| 288 | * |
| 289 | * @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed. |
| 290 | */ |
| 291 | public function handle_upgrader_process_complete( \WP_Upgrader $upgrader, array $hook_extra ) { |
| 292 | if ( $this->installing_plugin || ! ( $upgrader instanceof \Plugin_Upgrader ) || ( 'plugin' !== ( $hook_extra['type'] ?? null ) ) ) { |
| 293 | return; |
| 294 | } |
| 295 | |
| 296 | $auto_installed_plugins = get_site_option( 'woocommerce_autoinstalled_plugins' ); |
| 297 | if ( ! $auto_installed_plugins ) { |
| 298 | return; |
| 299 | } |
| 300 | |
| 301 | if ( $hook_extra['bulk'] ?? false ) { |
| 302 | $updated_plugin_names = $hook_extra['plugins'] ?? array(); |
| 303 | } else { |
| 304 | $updated_plugin_names = array( $upgrader->plugin_info() ); |
| 305 | } |
| 306 | |
| 307 | $auto_installed_plugin_names = array_keys( $auto_installed_plugins ); |
| 308 | $updated_auto_installed_plugin_names = array_intersect( $auto_installed_plugin_names, $updated_plugin_names ); |
| 309 | |
| 310 | if ( empty( $updated_auto_installed_plugin_names ) ) { |
| 311 | return; |
| 312 | } |
| 313 | |
| 314 | $new_auto_installed_plugins = array_diff_key( $auto_installed_plugins, array_flip( $updated_auto_installed_plugin_names ) ); |
| 315 | |
| 316 | if ( empty( $new_auto_installed_plugins ) ) { |
| 317 | delete_site_option( 'woocommerce_autoinstalled_plugins' ); |
| 318 | } else { |
| 319 | update_site_option( 'woocommerce_autoinstalled_plugins', $new_auto_installed_plugins ); |
| 320 | } |
| 321 | } |
| 322 | } |
| 323 |