<?php
namespace Elementor\App\Modules\ImportExport\Processes;
use Elementor\App\Modules\ImportExport\Compatibility\Base_Adapter;
use Elementor\App\Modules\ImportExport\Compatibility\Envato;
use Elementor\App\Modules\ImportExport\Compatibility\Kit_Library;
use Elementor\App\Modules\ImportExport\Utils;
use Elementor\Core\Base\Document;
use Elementor\Plugin;
use Elementor\App\Modules\ImportExport\Runners\Import\Elementor_Content;
use Elementor\App\Modules\ImportExport\Runners\Import\Import_Runner_Base;
use Elementor\App\Modules\ImportExport\Runners\Import\Plugins;
use Elementor\App\Modules\ImportExport\Runners\Import\Site_Settings;
use Elementor\App\Modules\ImportExport\Runners\Import\Taxonomies;
use Elementor\App\Modules\ImportExport\Runners\Import\Templates;
use Elementor\App\Modules\ImportExport\Runners\Import\Wp_Content;
use Elementor\App\Modules\ImportExport\Module;
class Import {
const MANIFEST_ERROR_KEY = 'manifest-error';
const SESSION_DOES_NOT_EXITS_ERROR = 'session-does-not-exits-error';
const ZIP_FILE_ERROR_KEY = 'zip-file-error';
/**
* @var Import_Runner_Base[]
*/
protected $runners = [];
/**
* The session ID of the import process.
* This ID is uniquely generated for each import process (by the temp folder which contains the extracted kit files).
*
* @var string
*/
private $session_id;
/**
* Adapter for the kit compatibility.
*
* @var Base_Adapter[]
*/
private $adapters;
/**
* Document's elements that imported during the process.
*
* @var array
*/
private $documents_elements = [];
/**
* Path to the extracted kit files.
*
* @var string
*/
private $extracted_directory_path;
/**
* Imported kit manifest.
*
* @var array
*/
private $manifest;
/**
* Imported kit site settings. (e.g: custom_colors, custom_typography, etc.)
*
* @var array
*/
private $site_settings;
/**
* Selected content types to import.
*
* @var array
*/
private $settings_include;
/**
* Referer of the import. (e.g: kit-library, local, etc.)
*
* @var string
*/
private $settings_referrer;
/**
* All the conflict between the exited templates and the kit templates.
*
* @var array
*/
private $settings_conflicts;
/**
* Selected elementor templates conditions to override.
*
* @var array
*/
private $settings_selected_override_conditions;
/**
* Selected custom post types to import.
*
* @var array
*/
private $settings_selected_custom_post_types;
/**
* Selected plugins to import.
*
* @var array
*/
private $settings_selected_plugins;
/**
* The imported data output.
*
* @var array
*/
private $imported_data = [];
/**
* The metadata output of the import runners.
* Will be saved in the import_session and will be used to revert the import process.
*
* @var array
*/
private $runners_import_metadata = [];
/**
* @param $path string session_id | zip_file_path
* @param $settings array Use to determine which content to import.
* (e.g: include, selected_plugins, selected_cpt, selected_override_conditions, etc.)
* @throws \Exception
*/
public function __construct( string $path, array $settings = [] ) {
if ( is_file( $path ) ) {
$this->extracted_directory_path = $this->extract_zip( $path );
} else {
$elementor_tmp_directory = Plugin::$instance->uploads_manager->get_temp_dir();
$path = $elementor_tmp_directory . basename( $path );
if ( ! is_dir( $path ) ) {
throw new \Exception( static::SESSION_DOES_NOT_EXITS_ERROR );
}
$this->extracted_directory_path = $path . '/';
}
$this->session_id = basename( $this->extracted_directory_path );
$this->settings_referrer = ! empty( $settings['referrer'] ) ? $settings['referrer'] : 'local';
$this->settings_include = ! empty( $settings['include'] ) ? $settings['include'] : null;
// Using isset and not empty is important since empty array is valid option.
$this->settings_selected_override_conditions = $settings['overrideConditions'] ?? null;
$this->settings_selected_custom_post_types = $settings['selectedCustomPostTypes'] ?? null;
$this->settings_selected_plugins = $settings['plugins'] ?? null;
$this->manifest = $this->read_manifest_json();
$this->site_settings = $this->read_site_settings_json();
$this->set_default_settings();
}
/**
* Register a runner.
* Be aware that the runner will be executed in the order of registration, the order is crucial for the import process.
*
* @param Import_Runner_Base $runner_instance
*/
public function register( Import_Runner_Base $runner_instance ) {
$this->runners[ $runner_instance::get_name() ] = $runner_instance;
}
public function register_default_runners() {
$this->register( new Site_Settings() );
$this->register( new Plugins() );
$this->register( new Templates() );
$this->register( new Taxonomies() );
$this->register( new Elementor_Content() );
$this->register( new Wp_Content() );
}
/**
* Set default settings for the import.
*/
private function set_default_settings() {
if ( ! is_array( $this->get_settings_include() ) ) {
$this->settings_include( $this->get_default_settings_include() );
}
if ( ! is_array( $this->get_settings_conflicts() ) ) {
$this->settings_conflicts( $this->get_default_settings_conflicts() );
}
if ( ! is_array( $this->get_settings_selected_override_conditions() ) ) {
$this->settings_selected_override_conditions( $this->get_default_settings_override_conditions() );
}
if ( ! is_array( $this->get_settings_selected_custom_post_types() ) ) {
$this->settings_selected_custom_post_types( $this->get_default_settings_custom_post_types() );
}
if ( ! is_array( $this->get_settings_selected_plugins() ) ) {
$this->settings_selected_plugins( $this->get_default_settings_plugins() );
}
}
/**
* Execute the import process.
*
* @return array The imported data output.
* @throws \Exception
*/
public function run() {
$start_time = current_time( 'timestamp' );
if ( empty( $this->runners ) ) {
throw new \Exception( 'Please specify import runners.' );
}
$data = [
'session_id' => $this->session_id,
'include' => $this->settings_include,
'manifest' => $this->manifest,
'site_settings' => $this->site_settings,
'selected_plugins' => $this->settings_selected_plugins,
'extracted_directory_path' => $this->extracted_directory_path,
'selected_custom_post_types' => $this->settings_selected_custom_post_types,
];
add_filter( 'elementor/document/save/data', [ $this, 'prevent_saving_elements_on_post_creation' ], 10, 2 );
// Set the Request's state as an Elementor upload request, in order to support unfiltered file uploads.
Plugin::$instance->uploads_manager->set_elementor_upload_state( true );
foreach ( $this->runners as $runner ) {
if ( $runner->should_import( $data ) ) {
$import = $runner->import( $data, $this->imported_data );
$this->imported_data = array_merge_recursive( $this->imported_data, $import );
$this->runners_import_metadata[ $runner::get_name() ] = $runner->get_import_session_metadata();
}
}
// After the upload complete, set the elementor upload state back to false.
Plugin::$instance->uploads_manager->set_elementor_upload_state( false );
remove_filter( 'elementor/document/save/data', [ $this, 'prevent_saving_elements_on_post_creation' ], 10 );
$this->add_import_session_option( $start_time );
$this->save_elements_of_imported_posts();
Plugin::$instance->uploads_manager->remove_file_or_dir( $this->extracted_directory_path );
return $this->imported_data;
}
public function get_manifest() {
return $this->manifest;
}
public function get_extracted_directory_path() {
return $this->extracted_directory_path;
}
public function get_session_id() {
return $this->session_id;
}
public function get_adapters() {
return $this->adapters;
}
/**
* Get settings by key.
* Used for backward compatibility.
*
* @param string $key The key of the setting.
*/
public function get_settings( $key ) {
switch ( $key ) {
case 'include':
return $this->get_settings_include();
case 'overrideConditions':
return $this->get_settings_selected_override_conditions();
case 'selectedCustomPostTypes':
return $this->get_settings_selected_custom_post_types();
case 'plugins':
return $this->get_settings_selected_plugins();
default:
return [];
}
}
public function settings_include( array $settings_include ) {
$this->settings_include = $settings_include;
return $this;
}
public function get_settings_include() {
return $this->settings_include;
}
public function settings_referrer( $settings_referrer ) {
$this->settings_referrer = $settings_referrer;
return $this;
}
public function get_settings_referrer() {
return $this->settings_referrer;
}
public function settings_conflicts( array $settings_conflicts ) {
$this->settings_conflicts = $settings_conflicts;
return $this;
}
public function get_settings_conflicts() {
return $this->settings_conflicts;
}
public function settings_selected_override_conditions( array $settings_selected_override_conditions ) {
$this->settings_selected_override_conditions = $settings_selected_override_conditions;
return $this;
}
public function get_settings_selected_override_conditions() {
return $this->settings_selected_override_conditions;
}
public function settings_selected_custom_post_types( array $settings_selected_custom_post_types ) {
$this->settings_selected_custom_post_types = $settings_selected_custom_post_types;
return $this;
}
public function get_settings_selected_custom_post_types() {
return $this->settings_selected_custom_post_types;
}
public function settings_selected_plugins( array $settings_selected_plugins ) {
$this->settings_selected_plugins = $settings_selected_plugins;
return $this;
}
public function get_settings_selected_plugins() {
return $this->settings_selected_plugins;
}
/**
* Prevent saving elements on elementor post creation.
*
* @param array $data
* @param Document $document
*
* @return array
*/
public function prevent_saving_elements_on_post_creation( array $data, Document $document ) {
if ( isset( $data['elements'] ) ) {
$this->documents_elements[ $document->get_main_id() ] = $data['elements'];
$data['elements'] = [];
}
return $data;
}
/**
* Extract the zip file.
*
* @param string $zip_path The path to the zip file.
* @return string The extracted directory path.
*/
private function extract_zip( $zip_path ) {
$extraction_result = Plugin::$instance->uploads_manager->extract_and_validate_zip( $zip_path, [ 'json', 'xml' ] );
if ( is_wp_error( $extraction_result ) ) {
throw new \Error( static::ZIP_FILE_ERROR_KEY );
}
return $extraction_result['extraction_directory'];
}
/**
* Get the manifest file from the extracted directory and adapt it if needed.
*
* @return string The manifest file content.
*/
private function read_manifest_json() {
$manifest = Utils::read_json_file( $this->extracted_directory_path . 'manifest' );
if ( ! $manifest ) {
throw new \Error( static::MANIFEST_ERROR_KEY );
}
$this->init_adapters( $manifest );
foreach ( $this->adapters as $adapter ) {
$manifest = $adapter->adapt_manifest( $manifest );
}
return $manifest;
}
/**
* Init the adapters and determine which ones to use.
*
* @param array $manifest_data The manifest file content.
*/
private function init_adapters( array $manifest_data ) {
$this->adapters = [];
/** @var Base_Adapter[] $adapter_types */
$adapter_types = [ Envato::class, Kit_Library::class ];
foreach ( $adapter_types as $adapter_type ) {
if ( $adapter_type::is_compatibility_needed( $manifest_data, [ 'referrer' => $this->get_settings_referrer() ] ) ) {
$this->adapters[] = new $adapter_type( $this );
}
}
}
/**
* Get the site settings file from the extracted directory and adapt it if needed.
*
* @return string The site settings file content.
*/
private function read_site_settings_json() {
$site_settings = Utils::read_json_file( $this->extracted_directory_path . 'site-settings' );
foreach ( $this->adapters as $adapter ) {
$site_settings = $adapter->adapt_site_settings( $site_settings, $this->manifest, $this->extracted_directory_path );
}
return $site_settings;
}
/**
* Get all the custom post types in the kit.
*
* @return array Custom post types names.
*/
private function get_default_settings_custom_post_types() {
if ( empty( $this->manifest['custom-post-type-title'] ) ) {
return [];
}
$manifest_post_types = array_keys( $this->manifest['custom-post-type-title'] );
return array_diff( $manifest_post_types, Utils::get_builtin_wp_post_types() );
}
/**
* Get the default settings of elementor templates conditions to override.
*
* @return array
*/
private function get_default_settings_conflicts() {
if ( empty( $this->manifest['templates'] ) ) {
return [];
}
return apply_filters( 'elementor/import/get_default_settings_conflicts', [], $this->manifest['templates'] );
}
/**
* Get the default settings of elementor templates conditions to override.
*
* @return array
*/
private function get_default_settings_override_conditions() {
if ( empty( $this->settings_conflicts ) ) {
return [];
}
return array_keys( $this->settings_conflicts );
}
/**
* Get the default settings of the plugins that should be imported.
*
* @return array
*/
private function get_default_settings_plugins() {
return ! empty( $this->manifest['plugins'] ) ? $this->manifest['plugins'] : [];
}
/**
* Get the default settings of which content types should be imported.
*
* @return array
*/
private function get_default_settings_include() {
return [ 'templates', 'plugins', 'content', 'settings' ];
}
/**
* Get the data that requires updating/replacement when imported.
*
* @return array{post_ids: array, term_ids: array}
*/
private function get_imported_data_replacements() : array {
return [
'post_ids' => Utils::map_old_new_post_ids( $this->imported_data ),
'term_ids' => Utils::map_old_new_term_ids( $this->imported_data ),
];
}
/**
* Save the prevented elements on elementor post creation elements.
* Handle the replacement of all the dynamic content of the elements that probably have been changed during the import.
*/
private function save_elements_of_imported_posts() {
foreach ( $this->documents_elements as $new_id => $document_elements ) {
$document = Plugin::$instance->documents->get( $new_id );
$updated_elements = $document->on_import_update_dynamic_content( $document_elements, $this->get_imported_data_replacements() );
$document->save( [ 'elements' => $updated_elements ] );
}
}
private function add_import_session_option( $start_time ) {
$import_sessions = get_option( Module::OPTION_KEY_ELEMENTOR_IMPORT_SESSIONS );
$import_sessions[ time() ] = [
'session_id' => $this->session_id,
'kit_name' => $this->manifest['name'],
'kit_source' => $this->settings_referrer,
'user_id' => get_current_user_id(),
'start_timestamp' => $start_time,
'end_timestamp' => current_time( 'timestamp' ),
'runners' => $this->runners_import_metadata,
];
update_option( Module::OPTION_KEY_ELEMENTOR_IMPORT_SESSIONS, $import_sessions, false );
}
}