| @@ -1,361 +1,550 @@ | ||
| 1 | 1 | <?php |
| 2 | - | |
| 3 | 2 | namespace Elementor\App\Modules\Onboarding; |
| 4 | 3 | |
| 5 | -use Elementor\App\Modules\Onboarding\Data\Controller; | |
| 6 | -use Elementor\App\Modules\Onboarding\Data\Endpoints\Install_Theme; | |
| 7 | -use Elementor\App\Modules\Onboarding\Storage\Entities\User_Choices; | |
| 8 | -use Elementor\App\Modules\Onboarding\Storage\Entities\User_Progress; | |
| 9 | -use Elementor\App\Modules\Onboarding\Storage\Onboarding_Progress_Manager; | |
| 4 | +use Automatic_Upgrader_Skin; | |
| 10 | 5 | use Elementor\Core\Base\Module as BaseModule; |
| 11 | -use Elementor\Core\Settings\Manager as SettingsManager; | |
| 6 | +use Elementor\Core\Common\Modules\Ajax\Module as Ajax; | |
| 7 | +use Elementor\Core\Common\Modules\Connect\Apps\Library; | |
| 8 | +use Elementor\Core\Files\Uploads_Manager; | |
| 12 | 9 | use Elementor\Includes\EditorAssetsAPI; |
| 13 | 10 | use Elementor\Plugin; |
| 14 | 11 | use Elementor\Utils; |
| 12 | +use Plugin_Upgrader; | |
| 15 | 13 | |
| 16 | 14 | if ( ! defined( 'ABSPATH' ) ) { |
| 17 | - exit; | |
| 15 | + exit; // Exit if accessed directly. | |
| 18 | 16 | } |
| 19 | 17 | |
| 18 | +/** | |
| 19 | + * Onboarding Module | |
| 20 | + * | |
| 21 | + * Responsible for initializing Elementor App functionality | |
| 22 | + * | |
| 23 | + * @since 3.6.0 | |
| 24 | + */ | |
| 20 | 25 | class Module extends BaseModule { |
| 21 | 26 | |
| 22 | - const VERSION = '2.0.0'; | |
| 23 | - const ASSETS_BASE_URL = 'https://assets.elementor.com/onboarding/v1/strings/'; | |
| 27 | + const VERSION = '1.0.0'; | |
| 24 | 28 | const ONBOARDING_OPTION = 'elementor_onboarded'; |
| 25 | 29 | |
| 26 | - const SUPPORTED_LOCALES = [ | |
| 27 | - 'de_DE' => 'de', | |
| 28 | - 'es_ES' => 'es', | |
| 29 | - 'fr_FR' => 'fr', | |
| 30 | - 'he_IL' => 'he', | |
| 31 | - 'id_ID' => 'id', | |
| 32 | - 'it_IT' => 'it', | |
| 33 | - 'nl_NL' => 'nl', | |
| 34 | - 'pl_PL' => 'pl', | |
| 35 | - 'pt_BR' => 'pt', | |
| 36 | - 'tr_TR' => 'tr', | |
| 37 | - ]; | |
| 30 | + private ?API $editor_assets_api = null; | |
| 38 | 31 | |
| 39 | - private Onboarding_Progress_Manager $progress_manager; | |
| 40 | - | |
| 41 | - public function get_name(): string { | |
| 32 | + /** | |
| 33 | + * Get name. | |
| 34 | + * | |
| 35 | + * @since 3.6.0 | |
| 36 | + * @access public | |
| 37 | + * | |
| 38 | + * @return string | |
| 39 | + */ | |
| 40 | + public function get_name() { | |
| 42 | 41 | return 'onboarding'; |
| 43 | 42 | } |
| 44 | 43 | |
| 45 | - public static function has_user_finished_onboarding(): bool { | |
| 46 | - return (bool) get_option( self::ONBOARDING_OPTION ); | |
| 47 | - } | |
| 44 | + private function is_theme_selection_experiment_enabled() { | |
| 45 | + $editor_assets_api = $this->get_editor_assets_api(); | |
| 48 | 46 | |
| 49 | - public function __construct() { | |
| 50 | - $this->progress_manager = Onboarding_Progress_Manager::instance(); | |
| 47 | + if ( null === $editor_assets_api ) { | |
| 48 | + return false; | |
| 49 | + } | |
| 51 | 50 | |
| 52 | - Plugin::instance()->data_manager_v2->register_controller( new Controller() ); | |
| 51 | + return $editor_assets_api->is_theme_selection_experiment_enabled(); | |
| 52 | + } | |
| 53 | 53 | |
| 54 | - add_action( 'elementor/init', [ $this, 'on_elementor_init' ], 12 ); | |
| 54 | + private function is_good_to_go_experiment_enabled() { | |
| 55 | + $editor_assets_api = $this->get_editor_assets_api(); | |
| 55 | 56 | |
| 56 | - if ( $this->should_show_starter() ) { | |
| 57 | - add_filter( 'elementor/editor/localize_settings', [ $this, 'add_starter_settings' ] ); | |
| 58 | - add_filter( 'elementor/editor/v2/packages', [ $this, 'add_starter_packages' ] ); | |
| 59 | - add_action( 'elementor/editor/v2/styles/enqueue', [ $this, 'enqueue_fonts' ] ); | |
| 60 | - add_action( 'elementor/preview/enqueue_styles', [ $this, 'enqueue_starter_preview_css' ] ); | |
| 57 | + if ( null === $editor_assets_api ) { | |
| 58 | + return false; | |
| 61 | 59 | } |
| 60 | + | |
| 61 | + return $editor_assets_api->is_good_to_go_experiment_enabled(); | |
| 62 | 62 | } |
| 63 | 63 | |
| 64 | - public function on_elementor_init(): void { | |
| 65 | - if ( ! Plugin::instance()->app->is_current() ) { | |
| 66 | - return; | |
| 64 | + private function get_editor_assets_api(): ?API { | |
| 65 | + if ( null !== $this->editor_assets_api ) { | |
| 66 | + return $this->editor_assets_api; | |
| 67 | 67 | } |
| 68 | 68 | |
| 69 | - $this->set_onboarding_settings(); | |
| 70 | - $this->enqueue_fonts(); | |
| 71 | - } | |
| 69 | + $editor_assets_api_instance = new EditorAssetsAPI( $this->get_editor_assets_api_config() ); | |
| 70 | + $this->editor_assets_api = new API( $editor_assets_api_instance ); | |
| 72 | 71 | |
| 73 | - public function enqueue_fonts(): void { | |
| 74 | - wp_enqueue_style( | |
| 75 | - 'elementor-onboarding-fonts', | |
| 76 | - 'https://fonts.googleapis.com/css2?family=Poppins:wght@500&display=swap', | |
| 77 | - [], | |
| 78 | - ELEMENTOR_VERSION | |
| 79 | - ); | |
| 72 | + return $this->editor_assets_api; | |
| 80 | 73 | } |
| 81 | 74 | |
| 82 | - public function enqueue_starter_preview_css(): void { | |
| 83 | - $css = ' | |
| 84 | - #site-header, | |
| 85 | - .page-header { display: var(--e-starter-header-display, none); } | |
| 86 | - '; | |
| 87 | - | |
| 88 | - wp_register_style( 'elementor-starter-preview', false ); | |
| 89 | - wp_enqueue_style( 'elementor-starter-preview' ); | |
| 90 | - wp_add_inline_style( 'elementor-starter-preview', $css ); | |
| 75 | + private function get_editor_assets_api_config(): array { | |
| 76 | + return [ | |
| 77 | + EditorAssetsAPI::ASSETS_DATA_URL => 'https://assets.elementor.com/ab-testing/v1/ab-testing.json', | |
| 78 | + EditorAssetsAPI::ASSETS_DATA_TRANSIENT_KEY => '_elementor_ab_testing_data', | |
| 79 | + EditorAssetsAPI::ASSETS_DATA_KEY => 'ab-testing', | |
| 80 | + ]; | |
| 91 | 81 | } |
| 92 | 82 | |
| 93 | - public function progress_manager(): Onboarding_Progress_Manager { | |
| 94 | - return $this->progress_manager; | |
| 95 | - } | |
| 96 | - | |
| 97 | - private function set_onboarding_settings(): void { | |
| 98 | - if ( ! Plugin::instance()->common ) { | |
| 83 | + /** | |
| 84 | + * Set Onboarding Settings | |
| 85 | + * | |
| 86 | + * Creates an array of module settings that is localized into the JS App config. | |
| 87 | + * | |
| 88 | + * @since 3.6.0 | |
| 89 | + */ | |
| 90 | + private function set_onboarding_settings() { | |
| 91 | + if ( ! Plugin::$instance->common ) { | |
| 99 | 92 | return; |
| 100 | 93 | } |
| 101 | 94 | |
| 102 | - $progress = $this->progress_manager->get_progress(); | |
| 103 | - $choices = $this->progress_manager->get_choices(); | |
| 104 | - $steps = $this->get_steps_config(); | |
| 95 | + // Get the published pages and posts | |
| 96 | + $pages_and_posts = new \WP_Query( [ | |
| 97 | + 'post_type' => [ 'page', 'post' ], | |
| 98 | + 'post_status' => 'publish', | |
| 99 | + 'update_post_meta_cache' => false, | |
| 100 | + 'update_post_term_cache' => false, | |
| 101 | + 'no_found_rows' => true, | |
| 102 | + ] ); | |
| 105 | 103 | |
| 106 | - // If the user previously selected a theme but it's no longer the active theme, | |
| 107 | - // clear the theme selection so the user can re-select. | |
| 108 | - $this->maybe_invalidate_theme_selection( $progress, $choices ); | |
| 104 | + $custom_site_logo_id = get_theme_mod( 'custom_logo' ); | |
| 105 | + $custom_logo_src = wp_get_attachment_image_src( $custom_site_logo_id, 'full' ); | |
| 106 | + $site_name = get_option( 'blogname', '' ); | |
| 109 | 107 | |
| 110 | - $is_connected = $this->is_user_connected(); | |
| 108 | + $hello_theme = wp_get_theme( 'hello-elementor' ); | |
| 109 | + $hello_theme_errors = is_object( $hello_theme->errors() ) ? $hello_theme->errors()->errors : []; | |
| 111 | 110 | |
| 111 | + /** @var Library $library */ | |
| 112 | + $library = Plugin::$instance->common->get_component( 'connect' )->get_app( 'library' ); | |
| 113 | + | |
| 112 | 114 | Plugin::$instance->app->set_settings( 'onboarding', [ |
| 113 | - 'version' => self::VERSION, | |
| 114 | - 'restUrl' => rest_url( 'elementor/v1/onboarding/' ), | |
| 115 | - 'nonce' => wp_create_nonce( 'wp_rest' ), | |
| 116 | - 'progress' => $this->validate_progress_for_steps( $progress, $steps ), | |
| 117 | - 'choices' => $choices->to_array(), | |
| 118 | - 'hadUnexpectedExit' => $progress->had_unexpected_exit( self::has_user_finished_onboarding() ), | |
| 119 | - 'isConnected' => $is_connected, | |
| 120 | - 'userName' => $this->get_user_display_name(), | |
| 121 | - 'steps' => $steps, | |
| 122 | - 'uiTheme' => $this->get_ui_theme_preference(), | |
| 123 | - 'translations' => $this->get_translated_strings(), | |
| 124 | - 'shouldShowProInstallScreen' => $is_connected ? $this->should_show_pro_install_screen() : false, | |
| 115 | + 'eventPlacement' => 'Onboarding wizard', | |
| 116 | + 'onboardingAlreadyRan' => get_option( self::ONBOARDING_OPTION ), | |
| 117 | + 'onboardingVersion' => self::VERSION, | |
| 118 | + 'isLibraryConnected' => $library->is_connected(), | |
| 119 | + // Used to check if the Hello Elementor theme is installed but not activated. | |
| 120 | + 'helloInstalled' => empty( $hello_theme_errors['theme_not_found'] ), | |
| 121 | + 'helloActivated' => 'hello-elementor' === get_option( 'template' ), | |
| 122 | + // The "Use Hello theme on my site" checkbox should be checked by default only if this condition is met. | |
| 123 | + 'helloOptOut' => count( $pages_and_posts->posts ) < 5, | |
| 124 | + 'siteName' => esc_html( $site_name ), | |
| 125 | + 'isUnfilteredFilesEnabled' => Uploads_Manager::are_unfiltered_uploads_enabled(), | |
| 125 | 126 | 'urls' => [ |
| 126 | - 'dashboard' => admin_url(), | |
| 127 | - 'editor' => admin_url( 'edit.php?post_type=elementor_library' ), | |
| 128 | - 'connect' => $this->get_connect_url(), | |
| 129 | - 'signUp' => $this->get_connect_url( 'signup' ), | |
| 130 | - 'comparePlans' => 'https://go.elementor.com/go-pro-onboarding-editor-features-step-upgrade/', | |
| 127 | + 'kitLibrary' => Plugin::$instance->app->get_base_url() . '&source=onboarding#/kit-library?order[direction]=desc&order[by]=featuredIndex', | |
| 128 | + 'sitePlanner' => add_query_arg( [ | |
| 129 | + 'type' => 'editor', | |
| 130 | + 'siteUrl' => esc_url( home_url() ), | |
| 131 | + 'siteName' => esc_html( $site_name ), | |
| 132 | + 'siteDescription' => esc_html( get_bloginfo( 'description' ) ), | |
| 133 | + 'siteLanguage' => get_locale(), | |
| 134 | + ], 'https://planner.elementor.com/onboarding.html' ), | |
| 131 | 135 | 'createNewPage' => Plugin::$instance->documents->get_create_new_post_url(), |
| 132 | - 'upgradeUrl' => 'https://go.elementor.com/go-pro-onboarding-editor-header-upgrade/', | |
| 136 | + 'connect' => $library->get_admin_url( 'authorize', [ | |
| 137 | + 'utm_source' => 'onboarding-wizard', | |
| 138 | + 'utm_campaign' => 'connect-account', | |
| 139 | + 'utm_medium' => 'wp-dash', | |
| 140 | + 'utm_term' => self::VERSION, | |
| 141 | + 'source' => 'generic', | |
| 142 | + ] ), | |
| 143 | + 'upgrade' => 'https://go.elementor.com/go-pro-onboarding-wizard-upgrade/', | |
| 144 | + 'signUp' => $library->get_admin_url( 'authorize', [ | |
| 145 | + 'utm_source' => 'onboarding-wizard', | |
| 146 | + 'utm_campaign' => 'connect-account', | |
| 147 | + 'utm_medium' => 'wp-dash', | |
| 148 | + 'utm_term' => self::VERSION, | |
| 149 | + 'source' => 'generic', | |
| 150 | + 'screen_hint' => 'signup', | |
| 151 | + ] ), | |
| 152 | + 'uploadPro' => Plugin::$instance->app->get_base_url() . '#/onboarding/uploadAndInstallPro?mode=popup', | |
| 133 | 153 | ], |
| 154 | + 'siteLogo' => [ | |
| 155 | + 'id' => $custom_site_logo_id, | |
| 156 | + 'url' => $custom_logo_src ? $custom_logo_src[0] : '', | |
| 157 | + ], | |
| 158 | + 'utms' => [ | |
| 159 | + 'connectTopBar' => '&utm_content=top-bar', | |
| 160 | + 'connectCta' => '&utm_content=cta-button', | |
| 161 | + 'connectCtaLink' => '&utm_content=cta-link', | |
| 162 | + 'downloadPro' => '?utm_source=onboarding-wizard&utm_campaign=my-account-subscriptions&utm_medium=wp-dash&utm_content=import-pro-plugin&utm_term=' . self::VERSION, | |
| 163 | + ], | |
| 164 | + 'nonce' => wp_create_nonce( 'onboarding' ), | |
| 165 | + 'experiment' => true, | |
| 166 | + 'themeSelectionExperimentEnabled' => $this->is_theme_selection_experiment_enabled(), | |
| 167 | + 'goodToGoExperimentEnabled' => $this->is_good_to_go_experiment_enabled(), | |
| 134 | 168 | ] ); |
| 135 | 169 | } |
| 136 | 170 | |
| 137 | - private function validate_progress_for_steps( User_Progress $progress, array $steps ): array { | |
| 138 | - $progress_data = $progress->to_array(); | |
| 139 | - $step_count = count( $steps ); | |
| 140 | - $current_step_index = $progress->get_current_step_index() ?? 0; | |
| 141 | - $current_step_id = $progress->get_current_step_id() ?? $steps[0]['id'] ?? 'building_for'; | |
| 171 | + /** | |
| 172 | + * Get Permission Error Response | |
| 173 | + * | |
| 174 | + * Returns the response that is returned when the user's capabilities are not sufficient for performing an action. | |
| 175 | + * | |
| 176 | + * @since 3.6.4 | |
| 177 | + * | |
| 178 | + * @return array | |
| 179 | + */ | |
| 180 | + private function get_permission_error_response() { | |
| 181 | + return [ | |
| 182 | + 'status' => 'error', | |
| 183 | + 'payload' => [ | |
| 184 | + 'error_message' => esc_html__( 'You do not have permission to perform this action.', 'elementor' ), | |
| 185 | + ], | |
| 186 | + ]; | |
| 187 | + } | |
| 142 | 188 | |
| 143 | - $is_invalid_step_index = $current_step_index < 0 || $current_step_index >= $step_count; | |
| 189 | + /** | |
| 190 | + * Maybe Update Site Logo | |
| 191 | + * | |
| 192 | + * If a new name is provided, it will be updated as the Site Name. | |
| 193 | + * | |
| 194 | + * @since 3.6.0 | |
| 195 | + * | |
| 196 | + * @return array | |
| 197 | + */ | |
| 198 | + private function maybe_update_site_name() { | |
| 199 | + $problem_error = [ | |
| 200 | + 'status' => 'error', | |
| 201 | + 'payload' => [ | |
| 202 | + 'error_message' => esc_html__( 'There was a problem setting your site name.', 'elementor' ), | |
| 203 | + ], | |
| 204 | + ]; | |
| 144 | 205 | |
| 145 | - if ( $is_invalid_step_index ) { | |
| 146 | - $current_step_id = $steps[0]['id']; | |
| 147 | - $current_step_index = 0; | |
| 206 | + // phpcs:ignore WordPress.Security.NonceVerification.Missing | |
| 207 | + if ( empty( $_POST['data'] ) ) { | |
| 208 | + return $problem_error; | |
| 148 | 209 | } |
| 149 | 210 | |
| 150 | - $progress_data['current_step_id'] = $current_step_id; | |
| 151 | - $progress_data['current_step_index'] = $current_step_index; | |
| 211 | + // phpcs:ignore WordPress.Security.NonceVerification.Missing | |
| 212 | + $data = json_decode( Utils::get_super_global_value( $_POST, 'data' ), true ); | |
| 152 | 213 | |
| 153 | - return $progress_data; | |
| 154 | - } | |
| 214 | + if ( ! isset( $data['siteName'] ) ) { | |
| 215 | + return $problem_error; | |
| 216 | + } | |
| 155 | 217 | |
| 156 | - private function is_user_connected(): bool { | |
| 157 | - $library = $this->get_library_app(); | |
| 218 | + /** | |
| 219 | + * Onboarding Site Name | |
| 220 | + * | |
| 221 | + * Filters the new site name passed by the user to update in Elementor's onboarding process. | |
| 222 | + * Elementor runs `esc_html()` on the Site Name passed by the user for security reasons. If a user wants to | |
| 223 | + * include special characters in their site name, they can use this filter to override it. | |
| 224 | + * | |
| 225 | + * @since 3.6.0 | |
| 226 | + * | |
| 227 | + * @param string Escaped new site name | |
| 228 | + */ | |
| 229 | + $new_site_name = apply_filters( 'elementor/onboarding/site-name', $data['siteName'] ); | |
| 158 | 230 | |
| 159 | - return $library ? $library->is_connected() : false; | |
| 231 | + // The site name is sanitized in `update_options()` | |
| 232 | + update_option( 'blogname', $new_site_name ); | |
| 233 | + | |
| 234 | + return [ | |
| 235 | + 'status' => 'success', | |
| 236 | + 'payload' => [ | |
| 237 | + 'siteNameUpdated' => true, | |
| 238 | + ], | |
| 239 | + ]; | |
| 160 | 240 | } |
| 161 | 241 | |
| 162 | - private function get_connect_url( string $screen_hint = '' ): string { | |
| 163 | - $library = $this->get_library_app(); | |
| 164 | - | |
| 165 | - if ( ! $library ) { | |
| 166 | - return ''; | |
| 242 | + /** | |
| 243 | + * Maybe Update Site Logo | |
| 244 | + * | |
| 245 | + * If an image attachment ID is provided, it will be updated as the Site Logo Theme Mod. | |
| 246 | + * | |
| 247 | + * @since 3.6.0 | |
| 248 | + * | |
| 249 | + * @return array | |
| 250 | + */ | |
| 251 | + private function maybe_update_site_logo() { | |
| 252 | + if ( ! current_user_can( 'edit_theme_options' ) ) { | |
| 253 | + return $this->get_permission_error_response(); | |
| 167 | 254 | } |
| 168 | 255 | |
| 169 | - return $library->get_admin_url( 'authorize', [ | |
| 170 | - 'utm_source' => 'onboarding-wizard', | |
| 171 | - 'utm_campaign' => 'connect-account', | |
| 172 | - 'utm_medium' => 'wp-dash', | |
| 173 | - 'utm_term' => self::VERSION, | |
| 174 | - 'source' => 'generic', | |
| 175 | - 'screen_hint' => $screen_hint, | |
| 176 | - ] ) ?? ''; | |
| 177 | - } | |
| 256 | + $data_error = [ | |
| 257 | + 'status' => 'error', | |
| 258 | + 'payload' => [ | |
| 259 | + 'error_message' => esc_html__( 'There was a problem setting your site logo.', 'elementor' ), | |
| 260 | + ], | |
| 261 | + ]; | |
| 178 | 262 | |
| 179 | - private function get_library_app() { | |
| 180 | - $connect = Plugin::instance()->common->get_component( 'connect' ); | |
| 181 | - | |
| 182 | - if ( ! $connect ) { | |
| 183 | - return null; | |
| 263 | + // phpcs:ignore WordPress.Security.NonceVerification.Missing | |
| 264 | + if ( empty( $_POST['data'] ) ) { | |
| 265 | + return $data_error; | |
| 184 | 266 | } |
| 185 | 267 | |
| 186 | - return $connect->get_app( 'library' ); | |
| 187 | - } | |
| 268 | + // phpcs:ignore WordPress.Security.NonceVerification.Missing | |
| 269 | + $data = json_decode( Utils::get_super_global_value( $_POST, 'data' ), true ); | |
| 188 | 270 | |
| 189 | - public static function should_show_pro_install_screen(): bool { | |
| 190 | - if ( self::is_elementor_pro_installed() ) { | |
| 191 | - return false; | |
| 271 | + // If there is no attachment ID passed or it is not a valid ID, exit here. | |
| 272 | + if ( empty( $data['attachmentId'] ) ) { | |
| 273 | + return $data_error; | |
| 192 | 274 | } |
| 193 | 275 | |
| 194 | - $connect = Plugin::$instance->common->get_component( 'connect' ); | |
| 276 | + $absint_attachment_id = absint( $data['attachmentId'] ); | |
| 195 | 277 | |
| 196 | - if ( ! $connect ) { | |
| 197 | - return false; | |
| 278 | + if ( 0 === $absint_attachment_id ) { | |
| 279 | + return $data_error; | |
| 198 | 280 | } |
| 199 | 281 | |
| 200 | - $pro_install_app = $connect->get_app( 'pro-install' ); | |
| 282 | + $attachment_url = wp_get_attachment_url( $data['attachmentId'] ); | |
| 201 | 283 | |
| 202 | - if ( ! $pro_install_app || ! $pro_install_app->is_connected() ) { | |
| 203 | - return false; | |
| 284 | + // Check if the attachment exists. If it does not, exit here. | |
| 285 | + if ( ! $attachment_url ) { | |
| 286 | + return $data_error; | |
| 204 | 287 | } |
| 205 | 288 | |
| 206 | - $download_link = $pro_install_app->get_download_link(); | |
| 289 | + set_theme_mod( 'custom_logo', $absint_attachment_id ); | |
| 207 | 290 | |
| 208 | - return ! empty( $download_link ); | |
| 291 | + return [ | |
| 292 | + 'status' => 'success', | |
| 293 | + 'payload' => [ | |
| 294 | + 'siteLogoUpdated' => true, | |
| 295 | + ], | |
| 296 | + ]; | |
| 209 | 297 | } |
| 210 | 298 | |
| 211 | - private function get_ui_theme_preference(): string { | |
| 212 | - $editor_preferences = SettingsManager::get_settings_managers( 'editorPreferences' ); | |
| 299 | + /** | |
| 300 | + * Maybe Upload Logo Image | |
| 301 | + * | |
| 302 | + * If an image file upload is provided, and it passes validation, it will be uploaded to the site's Media Library. | |
| 303 | + * | |
| 304 | + * @since 3.6.0 | |
| 305 | + * | |
| 306 | + * @return array | |
| 307 | + */ | |
| 308 | + private function maybe_upload_logo_image() { | |
| 309 | + $error_message = esc_html__( 'There was a problem uploading your file.', 'elementor' ); | |
| 213 | 310 | |
| 214 | - $ui_theme = $editor_preferences->get_model()->get_settings( 'ui_theme' ); | |
| 311 | + $file = Utils::get_super_global_value( $_FILES, 'fileToUpload' ); // phpcs:ignore WordPress.Security.NonceVerification.Missing | |
| 215 | 312 | |
| 216 | - return $ui_theme ? $ui_theme : 'auto'; | |
| 217 | - } | |
| 313 | + // phpcs:ignore WordPress.Security.NonceVerification.Missing | |
| 314 | + if ( ! is_array( $file ) || empty( $file['type'] ) ) { | |
| 315 | + return [ | |
| 316 | + 'status' => 'error', | |
| 317 | + 'payload' => [ | |
| 318 | + 'error_message' => $error_message, | |
| 319 | + ], | |
| 320 | + ]; | |
| 321 | + } | |
| 218 | 322 | |
| 219 | - private function get_user_display_name(): string { | |
| 220 | - $library = $this->get_library_app(); | |
| 323 | + // If the user has allowed it, set the Request's state as an "Elementor Upload" request, in order to add | |
| 324 | + // support for non-standard file uploads. | |
| 325 | + if ( 'image/svg+xml' === $file['type'] ) { | |
| 326 | + if ( Uploads_Manager::are_unfiltered_uploads_enabled() ) { | |
| 327 | + Plugin::$instance->uploads_manager->set_elementor_upload_state( true ); | |
| 328 | + } else { | |
| 329 | + wp_send_json_error( 'To upload SVG files, you must allow uploading unfiltered files.' ); | |
| 330 | + } | |
| 331 | + } | |
| 221 | 332 | |
| 222 | - if ( ! $library || ! $library->is_connected() ) { | |
| 223 | - return ''; | |
| 333 | + // If the image is an SVG file, sanitation is performed during the import (upload) process. | |
| 334 | + $image_attachment = Plugin::$instance->templates_manager->get_import_images_instance()->import( $file ); | |
| 335 | + | |
| 336 | + if ( 'image/svg+xml' === $file['type'] && Uploads_Manager::are_unfiltered_uploads_enabled() ) { | |
| 337 | + // Reset Upload state. | |
| 338 | + Plugin::$instance->uploads_manager->set_elementor_upload_state( false ); | |
| 224 | 339 | } |
| 225 | 340 | |
| 226 | - $user = $library->get( 'user' ); | |
| 341 | + if ( $image_attachment && ! is_wp_error( $image_attachment ) ) { | |
| 342 | + $result = [ | |
| 343 | + 'status' => 'success', | |
| 344 | + 'payload' => [ | |
| 345 | + 'imageAttachment' => $image_attachment, | |
| 346 | + ], | |
| 347 | + ]; | |
| 348 | + } else { | |
| 349 | + $result = [ | |
| 350 | + 'status' => 'error', | |
| 351 | + 'payload' => [ | |
| 352 | + 'error_message' => $error_message, | |
| 353 | + ], | |
| 354 | + ]; | |
| 355 | + } | |
| 227 | 356 | |
| 228 | - return $user->first_name ?? ''; | |
| 357 | + return $result; | |
| 229 | 358 | } |
| 230 | 359 | |
| 231 | - public function should_show_starter(): bool { | |
| 232 | - $progress = $this->progress_manager->get_progress(); | |
| 360 | + /** | |
| 361 | + * Activate Hello Theme | |
| 362 | + * | |
| 363 | + * @since 3.6.0 | |
| 364 | + * | |
| 365 | + * @return array | |
| 366 | + */ | |
| 367 | + private function maybe_activate_hello_theme() { | |
| 368 | + if ( ! current_user_can( 'switch_themes' ) ) { | |
| 369 | + return $this->get_permission_error_response(); | |
| 370 | + } | |
| 233 | 371 | |
| 234 | - return self::VERSION === get_option( self::ONBOARDING_OPTION ) && ! $progress->is_starter_dismissed(); | |
| 235 | - } | |
| 372 | + $theme_slug = Utils::get_super_global_value( $_POST, 'theme_slug' ) ?? 'hello-biz'; // phpcs:ignore WordPress.Security.NonceVerification.Missing | |
| 373 | + $allowed_themes = [ 'hello-elementor', 'hello-biz' ]; | |
| 374 | + if ( ! in_array( $theme_slug, $allowed_themes, true ) ) { | |
| 375 | + $theme_slug = 'hello-biz'; | |
| 376 | + } | |
| 236 | 377 | |
| 237 | - public function add_starter_packages( array $packages ): array { | |
| 238 | - $packages[] = 'editor-starter'; | |
| 378 | + switch_theme( $theme_slug ); | |
| 239 | 379 | |
| 240 | - return $packages; | |
| 241 | - } | |
| 242 | - | |
| 243 | - public function add_starter_settings( array $settings ): array { | |
| 244 | - $settings['starter'] = [ | |
| 245 | - 'restPath' => 'elementor/v1/onboarding/user-progress', | |
| 246 | - 'aiPlannerUrl' => 'https://planner.elementor.com/home.html', | |
| 247 | - 'kitLibraryUrl' => Plugin::$instance->app->get_base_url() . '#/kit-library', | |
| 380 | + return [ | |
| 381 | + 'status' => 'success', | |
| 382 | + 'payload' => [ | |
| 383 | + 'helloThemeActivated' => true, | |
| 384 | + ], | |
| 248 | 385 | ]; |
| 249 | - | |
| 250 | - return $settings; | |
| 251 | 386 | } |
| 252 | 387 | |
| 253 | - private function maybe_invalidate_theme_selection( User_Progress $progress, User_Choices $choices ): void { | |
| 254 | - $selected_theme = $choices->get_theme_selection(); | |
| 255 | - | |
| 256 | - if ( empty( $selected_theme ) ) { | |
| 257 | - return; | |
| 388 | + /** | |
| 389 | + * Upload and Install Elementor Pro | |
| 390 | + * | |
| 391 | + * @since 3.6.0 | |
| 392 | + * | |
| 393 | + * @return array | |
| 394 | + */ | |
| 395 | + private function upload_and_install_pro() { | |
| 396 | + if ( ! current_user_can( 'install_plugins' ) || ! current_user_can( 'activate_plugins' ) ) { | |
| 397 | + return $this->get_permission_error_response(); | |
| 258 | 398 | } |
| 259 | 399 | |
| 260 | - $active_theme = get_stylesheet(); | |
| 400 | + $error_message = esc_html__( 'There was a problem uploading your file.', 'elementor' ); | |
| 261 | 401 | |
| 262 | - if ( $active_theme !== $selected_theme ) { | |
| 263 | - $completed = $this->filter_out_theme_selection_step( $progress->get_completed_steps() ); | |
| 264 | - $progress->set_completed_steps( $completed ); | |
| 265 | - $this->progress_manager->save_progress( $progress ); | |
| 402 | + $file = Utils::get_super_global_value( $_FILES, 'fileToUpload' ) ?? []; // phpcs:ignore WordPress.Security.NonceVerification.Missing | |
| 266 | 403 | |
| 267 | - $choices->set_theme_selection( null ); | |
| 268 | - $this->progress_manager->save_choices( $choices ); | |
| 404 | + // phpcs:ignore WordPress.Security.NonceVerification.Missing | |
| 405 | + if ( ! is_array( $file ) || empty( $file['type'] ) ) { | |
| 406 | + return [ | |
| 407 | + 'status' => 'error', | |
| 408 | + 'payload' => [ | |
| 409 | + 'error_message' => $error_message, | |
| 410 | + ], | |
| 411 | + ]; | |
| 269 | 412 | } |
| 270 | - } | |
| 271 | 413 | |
| 272 | - private function filter_out_theme_selection_step( array $steps ): array { | |
| 273 | - return array_values( array_filter( $steps, function ( $step ) { | |
| 274 | - return 'theme_selection' !== $step; | |
| 275 | - } ) ); | |
| 276 | - } | |
| 414 | + $result = []; | |
| 277 | 415 | |
| 278 | - private function get_translated_strings(): array { | |
| 279 | - $locale = $this->get_onboarding_locale(); | |
| 416 | + if ( ! class_exists( 'Automatic_Upgrader_Skin' ) ) { | |
| 417 | + require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php'; | |
| 418 | + } | |
| 280 | 419 | |
| 281 | - $api = new EditorAssetsAPI( [ | |
| 282 | - EditorAssetsAPI::ASSETS_DATA_URL => self::ASSETS_BASE_URL . $locale . '.json', | |
| 283 | - EditorAssetsAPI::ASSETS_DATA_TRANSIENT_KEY => '_elementor_onboarding_strings_' . $locale, | |
| 284 | - EditorAssetsAPI::ASSETS_DATA_KEY => 'translations', | |
| 285 | - ] ); | |
| 420 | + $skin = new Automatic_Upgrader_Skin(); | |
| 421 | + $upgrader = new Plugin_Upgrader( $skin ); | |
| 422 | + $upload_result = $upgrader->install( $file['tmp_name'], [ 'overwrite_package' => false ] ); | |
| 286 | 423 | |
| 287 | - return $api->get_assets_data(); | |
| 288 | - } | |
| 424 | + if ( ! $upload_result || is_wp_error( $upload_result ) ) { | |
| 425 | + $result = [ | |
| 426 | + 'status' => 'error', | |
| 427 | + 'payload' => [ | |
| 428 | + 'error_message' => $error_message, | |
| 429 | + ], | |
| 430 | + ]; | |
| 431 | + } else { | |
| 432 | + $activated = activate_plugin( WP_PLUGIN_DIR . '/elementor-pro/elementor-pro.php', false, false, true ); | |
| 289 | 433 | |
| 290 | - private function get_onboarding_locale(): string { | |
| 291 | - static $flipped_locales = null; | |
| 292 | - | |
| 293 | - if ( null === $flipped_locales ) { | |
| 294 | - $flipped_locales = array_flip( self::SUPPORTED_LOCALES ); | |
| 434 | + if ( ! is_wp_error( $activated ) ) { | |
| 435 | + $result = [ | |
| 436 | + 'status' => 'success', | |
| 437 | + 'payload' => [ | |
| 438 | + 'elementorProInstalled' => true, | |
| 439 | + ], | |
| 440 | + ]; | |
| 441 | + } else { | |
| 442 | + $result = [ | |
| 443 | + 'status' => 'error', | |
| 444 | + 'payload' => [ | |
| 445 | + 'error_message' => $error_message, | |
| 446 | + 'elementorProInstalled' => false, | |
| 447 | + ], | |
| 448 | + ]; | |
| 449 | + } | |
| 295 | 450 | } |
| 296 | 451 | |
| 297 | - $user_locale = get_user_locale(); | |
| 452 | + return $result; | |
| 453 | + } | |
| 298 | 454 | |
| 299 | - if ( isset( self::SUPPORTED_LOCALES[ $user_locale ] ) ) { | |
| 300 | - return $user_locale; | |
| 301 | - } | |
| 455 | + private function maybe_update_onboarding_db_option() { | |
| 456 | + $db_option = get_option( self::ONBOARDING_OPTION ); | |
| 302 | 457 | |
| 303 | - $locale = substr( $user_locale, 0, 2 ); | |
| 304 | - | |
| 305 | - if ( isset( $flipped_locales[ $locale ] ) ) { | |
| 306 | - return $flipped_locales[ $locale ]; | |
| 458 | + if ( ! $db_option ) { | |
| 459 | + update_option( self::ONBOARDING_OPTION, true ); | |
| 307 | 460 | } |
| 308 | 461 | |
| 309 | - return 'en'; | |
| 462 | + return [ | |
| 463 | + 'status' => 'success', | |
| 464 | + 'payload' => 'onboarding DB', | |
| 465 | + ]; | |
| 310 | 466 | } |
| 311 | 467 | |
| 312 | - private function get_steps_config(): array { | |
| 313 | - $steps = [ | |
| 314 | - [ | |
| 315 | - 'id' => 'building_for', | |
| 316 | - 'label' => __( 'Who are you building for?', 'elementor' ), | |
| 317 | - 'type' => 'single', | |
| 318 | - ], | |
| 319 | - [ | |
| 320 | - 'id' => 'site_about', | |
| 321 | - 'label' => __( 'What is your site about?', 'elementor' ), | |
| 322 | - 'type' => 'multiple', | |
| 323 | - ], | |
| 324 | - [ | |
| 325 | - 'id' => 'experience_level', | |
| 326 | - 'label' => __( 'How much experience do you have with Elementor?', 'elementor' ), | |
| 327 | - 'type' => 'single', | |
| 328 | - ], | |
| 329 | - ]; | |
| 468 | + /** | |
| 469 | + * Maybe Handle Ajax | |
| 470 | + * | |
| 471 | + * This method checks if there are any AJAX actions being | |
| 472 | + * | |
| 473 | + * @since 3.6.0 | |
| 474 | + */ | |
| 475 | + private function maybe_handle_ajax() { | |
| 476 | + $result = []; | |
| 330 | 477 | |
| 331 | - if ( ! $this->is_elementor_theme_active() ) { | |
| 332 | - $steps[] = [ | |
| 333 | - 'id' => 'theme_selection', | |
| 334 | - 'label' => __( 'Start with a theme that fits your needs', 'elementor' ), | |
| 335 | - 'type' => 'single', | |
| 336 | - ]; | |
| 478 | + // phpcs:ignore WordPress.Security.NonceVerification.Missing | |
| 479 | + switch ( Utils::get_super_global_value( $_POST, 'action' ) ) { | |
| 480 | + case 'elementor_update_site_name': | |
| 481 | + // If no value is passed for any reason, no need to update the site name. | |
| 482 | + $result = $this->maybe_update_site_name(); | |
| 483 | + break; | |
| 484 | + case 'elementor_update_site_logo': | |
| 485 | + $result = $this->maybe_update_site_logo(); | |
| 486 | + break; | |
| 487 | + case 'elementor_upload_site_logo': | |
| 488 | + $result = $this->maybe_upload_logo_image(); | |
| 489 | + break; | |
| 490 | + case 'elementor_activate_hello_theme': | |
| 491 | + $result = $this->maybe_activate_hello_theme(); | |
| 492 | + break; | |
| 493 | + case 'elementor_upload_and_install_pro': | |
| 494 | + $result = $this->upload_and_install_pro(); | |
| 495 | + break; | |
| 496 | + case 'elementor_update_onboarding_option': | |
| 497 | + $result = $this->maybe_update_onboarding_db_option(); | |
| 498 | + break; | |
| 499 | + case 'elementor_save_onboarding_features': | |
| 500 | + // phpcs:ignore WordPress.Security.NonceVerification.Missing | |
| 501 | + $result = $this->get_component( 'features_usage' )->save_onboarding_features( Utils::get_super_global_value( $_POST, 'data' ) ?? [] ); | |
| 337 | 502 | } |
| 338 | 503 | |
| 339 | - if ( ! self::is_elementor_pro_installed() ) { | |
| 340 | - $steps[] = [ | |
| 341 | - 'id' => 'site_features', | |
| 342 | - 'label' => __( 'What do you want to include in your site?', 'elementor' ), | |
| 343 | - 'type' => 'multiple', | |
| 344 | - ]; | |
| 504 | + if ( ! empty( $result ) ) { | |
| 505 | + if ( 'success' === $result['status'] ) { | |
| 506 | + wp_send_json_success( $result['payload'] ); | |
| 507 | + } else { | |
| 508 | + wp_send_json_error( $result['payload'] ); | |
| 509 | + } | |
| 345 | 510 | } |
| 511 | + } | |
| 346 | 512 | |
| 347 | - return apply_filters( 'elementor/onboarding/steps', $steps ); | |
| 348 | - } | |
| 513 | + public function __construct() { | |
| 514 | + $this->add_component( 'features_usage', new Features_Usage() ); | |
| 349 | 515 | |
| 350 | - private static function is_elementor_pro_installed(): bool { | |
| 351 | - $is_pro_installed = Utils::has_pro() || Utils::is_pro_installed_and_not_active(); | |
| 352 | - return (bool) apply_filters( 'elementor/onboarding/is_elementor_pro_installed', $is_pro_installed ); | |
| 353 | - } | |
| 516 | + add_action( 'elementor/init', function() { | |
| 517 | + // Only load when viewing the onboarding app. | |
| 518 | + if ( Plugin::$instance->app->is_current() ) { | |
| 519 | + $this->set_onboarding_settings(); | |
| 520 | + // Needed for installing the Hello Elementor theme. | |
| 521 | + wp_enqueue_script( 'updates' ); | |
| 522 | + // Needed for uploading Logo from WP Media Library. | |
| 523 | + wp_enqueue_media(); | |
| 524 | + } | |
| 525 | + }, 12 ); | |
| 354 | 526 | |
| 355 | - private function is_elementor_theme_active(): bool { | |
| 356 | - $active_theme = get_stylesheet(); | |
| 357 | - $is_active = in_array( $active_theme, Install_Theme::ALLOWED_THEMES, true ); | |
| 527 | + // Needed for uploading Logo from WP Media Library. The 'admin_menu' hook is used because it runs before | |
| 528 | + // 'admin_init', and the App triggers printing footer scripts on 'admin_init' at priority 0. | |
| 529 | + add_action( 'admin_menu', function () { | |
| 530 | + add_action( 'wp_print_footer_scripts', function () { | |
| 531 | + if ( function_exists( 'wp_print_media_templates' ) ) { | |
| 532 | + wp_print_media_templates(); | |
| 533 | + } | |
| 534 | + } ); | |
| 535 | + } ); | |
| 358 | 536 | |
| 359 | - return (bool) apply_filters( 'elementor/onboarding/is_elementor_theme_active', $is_active ); | |
| 537 | + add_action( 'admin_init', function() { | |
| 538 | + if ( wp_doing_ajax() && | |
| 539 | + isset( $_POST['action'] ) && | |
| 540 | + isset( $_POST['_nonce'] ) && | |
| 541 | + wp_verify_nonce( Utils::get_super_global_value( $_POST, '_nonce' ), Ajax::NONCE_KEY ) && | |
| 542 | + current_user_can( 'manage_options' ) | |
| 543 | + ) { | |
| 544 | + $this->maybe_handle_ajax(); | |
| 545 | + } | |
| 546 | + } ); | |
| 547 | + | |
| 548 | + $this->get_component( 'features_usage' )->register(); | |
| 360 | 549 | } |
| 361 | 550 | } |
