738 lines
18 KiB
PHP
738 lines
18 KiB
PHP
<?php
|
|
namespace Elementor\TemplateLibrary;
|
|
|
|
use Elementor\Api;
|
|
use Elementor\Core\Common\Modules\Ajax\Module as Ajax;
|
|
use Elementor\Core\Settings\Manager as SettingsManager;
|
|
use Elementor\Includes\TemplateLibrary\Data\Controller;
|
|
use Elementor\TemplateLibrary\Classes\Import_Images;
|
|
use Elementor\Plugin;
|
|
use Elementor\User;
|
|
use Elementor\Utils;
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit; // Exit if accessed directly.
|
|
}
|
|
|
|
/**
|
|
* Elementor template library manager.
|
|
*
|
|
* Elementor template library manager handler class is responsible for
|
|
* initializing the template library.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
class Manager {
|
|
|
|
/**
|
|
* Registered template sources.
|
|
*
|
|
* Holds a list of all the supported sources with their instances.
|
|
*
|
|
* @access protected
|
|
*
|
|
* @var Source_Base[]
|
|
*/
|
|
protected $_registered_sources = []; // phpcs:ignore PSR2.Classes.PropertyDeclaration.Underscore
|
|
|
|
/**
|
|
* Imported template images.
|
|
*
|
|
* Holds an instance of `Import_Images` class.
|
|
*
|
|
* @access private
|
|
*
|
|
* @var Import_Images
|
|
*/
|
|
private $_import_images = null; // phpcs:ignore PSR2.Classes.PropertyDeclaration.Underscore
|
|
|
|
/**
|
|
* Template library manager constructor.
|
|
*
|
|
* Initializing the template library manager by registering default template
|
|
* sources and initializing ajax calls.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*/
|
|
public function __construct() {
|
|
Plugin::$instance->data_manager_v2->register_controller( new Controller() );
|
|
|
|
$this->register_default_sources();
|
|
|
|
$this->add_actions();
|
|
}
|
|
|
|
/**
|
|
* @since 2.3.0
|
|
* @access public
|
|
*/
|
|
public function add_actions() {
|
|
add_action( 'elementor/ajax/register_actions', [ $this, 'register_ajax_actions' ] );
|
|
add_action( 'wp_ajax_elementor_library_direct_actions', [ $this, 'handle_direct_actions' ] );
|
|
}
|
|
|
|
/**
|
|
* Get `Import_Images` instance.
|
|
*
|
|
* Retrieve the instance of the `Import_Images` class.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*
|
|
* @return Import_Images Imported images instance.
|
|
*/
|
|
public function get_import_images_instance() {
|
|
if ( null === $this->_import_images ) {
|
|
$this->_import_images = new Import_Images();
|
|
}
|
|
|
|
return $this->_import_images;
|
|
}
|
|
|
|
/**
|
|
* Register template source.
|
|
*
|
|
* Used to register new template sources displayed in the template library.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*
|
|
* @param string $source_class The name of source class.
|
|
* @param array $args Optional. Class arguments. Default is an
|
|
* empty array.
|
|
*
|
|
* @return \WP_Error|true True if the source was registered, `WP_Error`
|
|
* otherwise.
|
|
*/
|
|
public function register_source( $source_class, $args = [] ) {
|
|
if ( ! class_exists( $source_class ) ) {
|
|
return new \WP_Error( 'source_class_name_not_exists' );
|
|
}
|
|
|
|
$source_instance = new $source_class( $args );
|
|
|
|
if ( ! $source_instance instanceof Source_Base ) {
|
|
return new \WP_Error( 'wrong_instance_source' );
|
|
}
|
|
|
|
$source_id = $source_instance->get_id();
|
|
|
|
if ( isset( $this->_registered_sources[ $source_id ] ) ) {
|
|
return new \WP_Error( 'source_exists' );
|
|
}
|
|
|
|
$this->_registered_sources[ $source_id ] = $source_instance;
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Unregister template source.
|
|
*
|
|
* Remove an existing template sources from the list of registered template
|
|
* sources.
|
|
*
|
|
* @since 1.0.0
|
|
* @deprecated 2.7.0
|
|
* @access public
|
|
*
|
|
* @param string $id The source ID.
|
|
*
|
|
* @return bool Whether the source was unregistered.
|
|
*/
|
|
public function unregister_source( $id ) {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Get registered template sources.
|
|
*
|
|
* Retrieve registered template sources.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*
|
|
* @return Source_Base[] Registered template sources.
|
|
*/
|
|
public function get_registered_sources() {
|
|
return $this->_registered_sources;
|
|
}
|
|
|
|
/**
|
|
* Get template source.
|
|
*
|
|
* Retrieve single template sources for a given template ID.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*
|
|
* @param string $id The source ID.
|
|
*
|
|
* @return false|Source_Base Template sources if one exist, False otherwise.
|
|
*/
|
|
public function get_source( $id ) {
|
|
$sources = $this->get_registered_sources();
|
|
|
|
if ( ! isset( $sources[ $id ] ) ) {
|
|
return false;
|
|
}
|
|
|
|
return $sources[ $id ];
|
|
}
|
|
|
|
/**
|
|
* Get templates.
|
|
*
|
|
* Retrieve all the templates from all the registered sources.
|
|
*
|
|
* @param array $filter_sources
|
|
* @param bool $force_update
|
|
* @return array
|
|
*/
|
|
public function get_templates( array $filter_sources = [], bool $force_update = false ): array {
|
|
$templates = [];
|
|
|
|
foreach ( $this->get_registered_sources() as $source ) {
|
|
if ( ! empty( $filter_sources ) && ! in_array( $source->get_id(), $filter_sources, true ) ) {
|
|
continue;
|
|
}
|
|
|
|
$templates = array_merge( $templates, $source->get_items( [ 'force_update' => $force_update ] ) );
|
|
}
|
|
|
|
return $templates;
|
|
}
|
|
|
|
/**
|
|
* Get library data.
|
|
*
|
|
* Retrieve the library data.
|
|
*
|
|
* @since 1.9.0
|
|
* @access public
|
|
*
|
|
* @param array $args Library arguments.
|
|
*
|
|
* @return array Library data.
|
|
*/
|
|
public function get_library_data( array $args ) {
|
|
$library_data = Api::get_library_data( ! empty( $args['sync'] ) );
|
|
|
|
if ( empty( $library_data ) ) {
|
|
return $library_data;
|
|
}
|
|
|
|
// Ensure all document are registered.
|
|
Plugin::$instance->documents->get_document_types();
|
|
|
|
$filter_sources = ! empty( $args['filter_sources'] ) ? $args['filter_sources'] : [];
|
|
$force_update = ! empty( $args['sync'] );
|
|
|
|
return [
|
|
'templates' => $this->get_templates( $filter_sources, $force_update ),
|
|
'config' => $library_data['types_data'],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Save template.
|
|
*
|
|
* Save new or update existing template on the database.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*
|
|
* @param array $args Template arguments.
|
|
*
|
|
* @return \WP_Error|int The ID of the saved/updated template.
|
|
*/
|
|
public function save_template( array $args ) {
|
|
$validate_args = $this->ensure_args( [ 'post_id', 'source', 'content', 'type' ], $args );
|
|
|
|
if ( is_wp_error( $validate_args ) ) {
|
|
return $validate_args;
|
|
}
|
|
|
|
$source = $this->get_source( $args['source'] );
|
|
|
|
if ( ! $source ) {
|
|
return new \WP_Error( 'template_error', 'Template source not found.' );
|
|
}
|
|
|
|
$args['content'] = json_decode( $args['content'], true );
|
|
|
|
$page = SettingsManager::get_settings_managers( 'page' )->get_model( $args['post_id'] );
|
|
|
|
$args['page_settings'] = $page->get_data( 'settings' );
|
|
|
|
$template_id = $source->save_item( $args );
|
|
|
|
if ( is_wp_error( $template_id ) ) {
|
|
return $template_id;
|
|
}
|
|
|
|
return $source->get_item( $template_id );
|
|
}
|
|
|
|
/**
|
|
* Update template.
|
|
*
|
|
* Update template on the database.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*
|
|
* @param array $template_data New template data.
|
|
*
|
|
* @return \WP_Error|Source_Base Template sources instance if the templates
|
|
* was updated, `WP_Error` otherwise.
|
|
*/
|
|
public function update_template( array $template_data ) {
|
|
$validate_args = $this->ensure_args( [ 'source', 'content', 'type' ], $template_data );
|
|
|
|
if ( is_wp_error( $validate_args ) ) {
|
|
return $validate_args;
|
|
}
|
|
|
|
$source = $this->get_source( $template_data['source'] );
|
|
|
|
if ( ! $source ) {
|
|
return new \WP_Error( 'template_error', 'Template source not found.' );
|
|
}
|
|
|
|
$template_data['content'] = json_decode( $template_data['content'], true );
|
|
|
|
$update = $source->update_item( $template_data );
|
|
|
|
if ( is_wp_error( $update ) ) {
|
|
return $update;
|
|
}
|
|
|
|
return $source->get_item( $template_data['id'] );
|
|
}
|
|
|
|
/**
|
|
* Update templates.
|
|
*
|
|
* Update template on the database.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*
|
|
* @param array $args Template arguments.
|
|
*
|
|
* @return \WP_Error|true True if templates updated, `WP_Error` otherwise.
|
|
*/
|
|
public function update_templates( array $args ) {
|
|
foreach ( $args['templates'] as $template_data ) {
|
|
$result = $this->update_template( $template_data );
|
|
|
|
if ( is_wp_error( $result ) ) {
|
|
return $result;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Get template data.
|
|
*
|
|
* Retrieve the template data.
|
|
*
|
|
* @since 1.5.0
|
|
* @access public
|
|
*
|
|
* @param array $args Template arguments.
|
|
*
|
|
* @return \WP_Error|bool|array ??
|
|
*/
|
|
public function get_template_data( array $args ) {
|
|
$validate_args = $this->ensure_args( [ 'source', 'template_id' ], $args );
|
|
|
|
if ( is_wp_error( $validate_args ) ) {
|
|
return $validate_args;
|
|
}
|
|
|
|
if ( isset( $args['edit_mode'] ) ) {
|
|
Plugin::$instance->editor->set_edit_mode( $args['edit_mode'] );
|
|
}
|
|
|
|
$source = $this->get_source( $args['source'] );
|
|
|
|
if ( ! $source ) {
|
|
return new \WP_Error( 'template_error', 'Template source not found.' );
|
|
}
|
|
|
|
do_action( 'elementor/template-library/before_get_source_data', $args, $source );
|
|
|
|
$data = $source->get_data( $args );
|
|
|
|
do_action( 'elementor/template-library/after_get_source_data', $args, $source );
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Delete template.
|
|
*
|
|
* Delete template from the database.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*
|
|
* @param array $args Template arguments.
|
|
*
|
|
* @return \WP_Post|\WP_Error|false|null Post data on success, false or null
|
|
* or 'WP_Error' on failure.
|
|
*/
|
|
public function delete_template( array $args ) {
|
|
$validate_args = $this->ensure_args( [ 'source', 'template_id' ], $args );
|
|
|
|
if ( is_wp_error( $validate_args ) ) {
|
|
return $validate_args;
|
|
}
|
|
|
|
$source = $this->get_source( $args['source'] );
|
|
|
|
if ( ! $source ) {
|
|
return new \WP_Error( 'template_error', 'Template source not found.' );
|
|
}
|
|
|
|
return $source->delete_template( $args['template_id'] );
|
|
}
|
|
|
|
/**
|
|
* Export template.
|
|
*
|
|
* Export template to a file after ensuring it is a valid Elementor template
|
|
* and checking user permissions for private posts.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*
|
|
* @param array $args Template arguments.
|
|
*
|
|
* @return mixed Whether the export succeeded or failed.
|
|
*/
|
|
public function export_template( array $args ) {
|
|
$validate_args = $this->ensure_args( [ 'source', 'template_id' ], $args );
|
|
|
|
if ( is_wp_error( $validate_args ) ) {
|
|
return $validate_args;
|
|
}
|
|
|
|
$post_id = intval( $args['template_id'] );
|
|
$post_status = get_post_status( $post_id );
|
|
|
|
if ( get_post_type( $post_id ) !== Source_Local::CPT ) {
|
|
return new \WP_Error( 'template_error', esc_html__( 'Invalid template type or template does not exist.', 'elementor' ) );
|
|
}
|
|
|
|
if ( 'private' === $post_status && ! current_user_can( 'read_private_posts', $post_id ) ) {
|
|
return new \WP_Error( 'template_error', esc_html__( 'You do not have permission to access this template.', 'elementor' ) );
|
|
}
|
|
|
|
if ( 'publish' !== $post_status && ! current_user_can( 'edit_post', $post_id ) ) {
|
|
return new \WP_Error( 'template_error', esc_html__( 'You do not have permission to export this template.', 'elementor' ) );
|
|
}
|
|
|
|
$source = $this->get_source( $args['source'] );
|
|
|
|
if ( ! $source ) {
|
|
return new \WP_Error( 'template_error', 'Template source not found' );
|
|
}
|
|
|
|
return $source->export_template( $args['template_id'] );
|
|
}
|
|
|
|
/**
|
|
* @since 2.3.0
|
|
* @access public
|
|
*/
|
|
public function direct_import_template() {
|
|
/** @var Source_Local $source */
|
|
$source = $this->get_source( 'local' );
|
|
$file = Utils::get_super_global_value( $_FILES, 'file' );
|
|
return $source->import_template( $file['name'], $file['tmp_name'] );
|
|
}
|
|
|
|
/**
|
|
* Import template.
|
|
*
|
|
* Import template from a file.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*
|
|
* @param array $data
|
|
*
|
|
* @return mixed Whether the export succeeded or failed.
|
|
*/
|
|
public function import_template( array $data ) {
|
|
// If the template is a JSON file, allow uploading it.
|
|
add_filter( 'elementor/files/allow-file-type/json', [ $this, 'enable_json_template_upload' ] );
|
|
add_filter( 'elementor/files/allow_unfiltered_upload', [ $this, 'enable_json_template_upload' ] );
|
|
|
|
// Imported templates can be either JSON files, or Zip files containing multiple JSON files
|
|
$upload_result = Plugin::$instance->uploads_manager->handle_elementor_upload( $data, [ 'zip', 'json' ] );
|
|
|
|
remove_filter( 'elementor/files/allow-file-type/json', [ $this, 'enable_json_template_upload' ] );
|
|
remove_filter( 'elementor/files/allow_unfiltered_upload', [ $this, 'enable_json_template_upload' ] );
|
|
|
|
if ( is_wp_error( $upload_result ) ) {
|
|
Plugin::$instance->uploads_manager->remove_file_or_dir( dirname( $upload_result['tmp_name'] ) );
|
|
|
|
return $upload_result;
|
|
}
|
|
|
|
/** @var Source_Local $source_local */
|
|
$source_local = $this->get_source( 'local' );
|
|
|
|
$import_result = $source_local->import_template( $upload_result['name'], $upload_result['tmp_name'] );
|
|
|
|
// Remove the temporary directory generated for the stream-uploaded file.
|
|
Plugin::$instance->uploads_manager->remove_file_or_dir( dirname( $upload_result['tmp_name'] ) );
|
|
|
|
return $import_result;
|
|
}
|
|
|
|
/**
|
|
* Enable JSON Template Upload
|
|
*
|
|
* Runs on the 'elementor/files/allow-file-type/json' Uploads Manager filter.
|
|
*
|
|
* @since 3.5.0
|
|
* @access public
|
|
*
|
|
* return bool
|
|
*/
|
|
public function enable_json_template_upload() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Mark template as favorite.
|
|
*
|
|
* Add the template to the user favorite templates.
|
|
*
|
|
* @since 1.9.0
|
|
* @access public
|
|
*
|
|
* @param array $args Template arguments.
|
|
*
|
|
* @return mixed Whether the template marked as favorite.
|
|
*/
|
|
public function mark_template_as_favorite( $args ) {
|
|
$validate_args = $this->ensure_args( [ 'source', 'template_id', 'favorite' ], $args );
|
|
|
|
if ( is_wp_error( $validate_args ) ) {
|
|
return $validate_args;
|
|
}
|
|
|
|
$source = $this->get_source( $args['source'] );
|
|
|
|
return $source->mark_as_favorite( $args['template_id'], filter_var( $args['favorite'], FILTER_VALIDATE_BOOLEAN ) );
|
|
}
|
|
|
|
public function import_from_json( array $args ) {
|
|
$validate_args = $this->ensure_args( [ 'editor_post_id', 'elements' ], $args );
|
|
|
|
if ( is_wp_error( $validate_args ) ) {
|
|
return $validate_args;
|
|
}
|
|
|
|
$elements = json_decode( $args['elements'], true );
|
|
|
|
$document = Plugin::$instance->documents->get( $args['editor_post_id'] );
|
|
if ( ! $document ) {
|
|
return new \WP_Error( 'template_error', 'Document not found.' );
|
|
}
|
|
|
|
$import_data = $document->get_import_data( [ 'content' => $elements ] );
|
|
|
|
return $import_data['content'];
|
|
}
|
|
|
|
/**
|
|
* Register default template sources.
|
|
*
|
|
* Register the 'local' and 'remote' template sources that Elementor use by
|
|
* default.
|
|
*
|
|
* @since 1.0.0
|
|
* @access private
|
|
*/
|
|
private function register_default_sources() {
|
|
$sources = [
|
|
'local',
|
|
'remote',
|
|
];
|
|
|
|
foreach ( $sources as $source_filename ) {
|
|
$class_name = ucwords( $source_filename );
|
|
$class_name = str_replace( '-', '_', $class_name );
|
|
|
|
$this->register_source( __NAMESPACE__ . '\Source_' . $class_name );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handle ajax request.
|
|
*
|
|
* Fire authenticated ajax actions for any given ajax request.
|
|
*
|
|
* @since 1.0.0
|
|
* @access private
|
|
*
|
|
* @param string $ajax_request Ajax request.
|
|
*
|
|
* @param array $data
|
|
*
|
|
* @return mixed
|
|
* @throws \Exception
|
|
*/
|
|
private function handle_ajax_request( $ajax_request, array $data ) {
|
|
if ( ! User::is_current_user_can_edit_post_type( Source_Local::CPT ) ) {
|
|
throw new \Exception( 'Access denied.' );
|
|
}
|
|
|
|
if ( ! empty( $data['editor_post_id'] ) ) {
|
|
$editor_post_id = absint( $data['editor_post_id'] );
|
|
|
|
if ( ! get_post( $editor_post_id ) ) {
|
|
throw new \Exception( 'Post not found.' );
|
|
}
|
|
|
|
Plugin::$instance->db->switch_to_post( $editor_post_id );
|
|
}
|
|
|
|
$result = call_user_func( [ $this, $ajax_request ], $data );
|
|
|
|
if ( is_wp_error( $result ) ) {
|
|
throw new \Exception( $result->get_error_message() );
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Init ajax calls.
|
|
*
|
|
* Initialize template library ajax calls for allowed ajax requests.
|
|
*
|
|
* @since 2.3.0
|
|
* @access public
|
|
*
|
|
* @param Ajax $ajax
|
|
*/
|
|
public function register_ajax_actions( Ajax $ajax ) {
|
|
$library_ajax_requests = [
|
|
'get_library_data',
|
|
'get_template_data',
|
|
'save_template',
|
|
'update_templates',
|
|
'delete_template',
|
|
'import_template',
|
|
'mark_template_as_favorite',
|
|
'import_from_json',
|
|
];
|
|
|
|
foreach ( $library_ajax_requests as $ajax_request ) {
|
|
$ajax->register_ajax_action( $ajax_request, function( $data ) use ( $ajax_request ) {
|
|
return $this->handle_ajax_request( $ajax_request, $data );
|
|
} );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @since 2.3.0
|
|
* @access public
|
|
*/
|
|
public function handle_direct_actions() {
|
|
if ( ! User::is_current_user_can_edit_post_type( Source_Local::CPT ) ) {
|
|
return;
|
|
}
|
|
|
|
/** @var Ajax $ajax */
|
|
$ajax = Plugin::$instance->common->get_component( 'ajax' );
|
|
|
|
if ( ! $ajax->verify_request_nonce() ) {
|
|
$this->handle_direct_action_error( 'Access Denied' );
|
|
}
|
|
|
|
$action = Utils::get_super_global_value( $_REQUEST, 'library_action' ); // phpcs:ignore -- Nonce already verified.
|
|
|
|
$whitelist_methods = [
|
|
'export_template',
|
|
'direct_import_template',
|
|
];
|
|
|
|
if ( in_array( $action, $whitelist_methods, true ) ) {
|
|
$result = $this->$action( $_REQUEST ); // phpcs:ignore -- Nonce already verified.
|
|
} else {
|
|
$result = new \WP_Error( 'method_not_exists', 'Method Not exists' );
|
|
}
|
|
|
|
if ( is_wp_error( $result ) ) {
|
|
/** @var \WP_Error $result */
|
|
$this->handle_direct_action_error( $result->get_error_message() . '.' );
|
|
}
|
|
|
|
$callback = "on_{$action}_success";
|
|
|
|
if ( method_exists( $this, $callback ) ) {
|
|
$this->$callback( $result );
|
|
}
|
|
|
|
die;
|
|
}
|
|
|
|
/**
|
|
* On successful template import.
|
|
*
|
|
* Redirect the user to the template library after template import was
|
|
* successful finished.
|
|
*
|
|
* @since 2.3.0
|
|
* @access private
|
|
*/
|
|
private function on_direct_import_template_success() {
|
|
wp_safe_redirect( admin_url( Source_Local::ADMIN_MENU_SLUG ) );
|
|
}
|
|
|
|
/**
|
|
* @since 2.3.0
|
|
* @access private
|
|
*/
|
|
private function handle_direct_action_error( $message ) {
|
|
_default_wp_die_handler( $message, 'Elementor Library' );
|
|
}
|
|
|
|
/**
|
|
* Ensure arguments exist.
|
|
*
|
|
* Checks whether the required arguments exist in the specified arguments.
|
|
*
|
|
* @since 1.0.0
|
|
* @access private
|
|
*
|
|
* @param array $required_args Required arguments to check whether they
|
|
* exist.
|
|
* @param array $specified_args The list of all the specified arguments to
|
|
* check against.
|
|
*
|
|
* @return \WP_Error|true True on success, 'WP_Error' otherwise.
|
|
*/
|
|
private function ensure_args( array $required_args, array $specified_args ) {
|
|
$not_specified_args = array_diff( $required_args, array_keys( $specified_args ) );
|
|
|
|
if ( $not_specified_args ) {
|
|
return new \WP_Error( 'arguments_not_specified', sprintf( 'The required argument(s) "%s" not specified.', implode( ', ', $not_specified_args ) ) );
|
|
}
|
|
|
|
return true;
|
|
}
|
|
}
|