class-fw-extension-page-builder.php

<?php if ( ! defined( 'FW' ) ) {
	die( 'Forbidden' );
}

class FW_Extension_Page_Builder extends FW_Extension {
	private $builder_option_key = 'page-builder';
	private $supports_feature_name = 'fw-page-builder';

	/**
	 * @var _FW_Ext_Page_Builder_Shortcode_Atts_Coder $shortcode_atts_coder
	 * @deprecated Since Shortcodes 1.3.0
	 */
	private $shortcode_atts_coder;

	/**
	 * Alternative to remove_action() wp_update_post() add_action().
	 * I think this is better because the wp_update_post() may fire other post creation/updates
	 * and the action will not be executed for them.
	 * @var array { post_id: ~ }
	 */
	private $prevent_post_update_recursion = array();

	/**
	 * @var FW_Access_Key
	 */
	private static $access_key;

	private static function get_access_key() {
		if (empty(self::$access_key)) {
			self::$access_key = new FW_Access_Key('fw:ext:page-builder');
		}

		return self::$access_key;
	}

	public function get_supports_feature_name() {
		return $this->supports_feature_name;
	}

	/**
	 * @internal
	 */
	protected function _init() {
		add_action( 'fw_option_types_init', array( $this, '_action_option_types_init' ) );

		$this->add_filters();
		$this->add_actions();
	}

	/**
	 * @internal
	 */
	public function _action_option_types_init() {
		FW_Option_Type::register( 'FW_Option_Type_Page_Builder' );
	}

	private function add_filters() {
		add_filter( 'fw_post_options', array( $this, '_admin_filter_fw_post_options' ), 10, 2 );
		add_filter( 'the_content', array( $this, '_theme_filter_prevent_autop' ), 1 );
		/** @since 1.5.0 */
		add_filter( 'the_posts', array( $this, '_filter_the_posts' ), 2, 2 );
		/** @since 1.6.0 */
		add_filter( 'get_pages', array( $this, '_filter_the_posts' ), 2, 2 );

		/**
		 * @deprecated Since Shortcodes 1.3.0
		 */
		add_filter( 'fw_shortcode_atts', array( $this, '_theme_filter_fw_shortcode_atts' ) );
		add_filter( 'wp_save_post_revision_post_has_changed', array( $this, '_filter_wp_save_post_revision_post_has_changed' ), 12, 3 );
		add_filter( 'display_post_states', array( $this, '_filter_display_post_states' ), 10, 2 );
	}

	private function add_actions() {
		add_action( 'fw_extensions_init', array( $this, '_admin_action_fw_extensions_init' ) );
		add_action( 'fw_post_options_update', array( $this, '_action_fw_post_options_update' ), 11, 3 );
		add_action( 'fw_admin_enqueue_scripts:post', array( $this, '_action_enqueue_shortcodes_admin_scripts' ) );

		/** @since 1.6.15 */
		if ( ! is_admin() ) {
			add_action( 'rest_api_init', array( $this, '_rest_api_init' ) );
		}
	}

	/**
	 * Sets up filters when being called from WordPress REST API
	 *
	 * Neither 'the_posts' nor 'get_pages' filter hooks are called when
	 * a single page is called from the REST API, only 'the_content'.
	 * This function adds a hook to 'the_content' filter only when
	 * the REST API is being used to generate the response.
	 *
	 * @internal
	 */
	public function _rest_api_init() {
		// Fixes: https://github.com/ThemeFuse/Unyson/issues/2754
		add_filter( 'the_content', array( $this, '_rest_api_the_content_filter_the_posts' ), 2 );
	}

	/**
	 * Processes the page builder shortcodes when called from the REST API
	 *
	 * When 'the_content' filter is called by wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php
	 * only the page content as stored in the database is returned in the API
	 * request for filtered pages (e.g. <server>/wp-json/wp/v2/pages/<page_id>).
	 * This function makes sure that the post content is passed through the
	 * various functions to process the page builder shortcodes when called
	 * from the REST API for any type of page
	 *
	 * @internal
	 * @return string The post content after any page builder shortcodes are processed
	 */
	public function _rest_api_the_content_filter_the_posts() {
		return fw_ext_page_builder_get_post_content(get_post());
	}

	/**
	 * when a builder modal window draws or saves
	 * options the shortcodes must be loaded
	 * because they may load their own custom option types
	 *
	 * NOTE: this checking is done at the `fw_extensions_init`
	 * at the moment when all the extensions are loaded the shortcode
	 * extension can begin collecting their shortcodes.
	 * We need this because the shortcodes can load their own option types
	 */
	public function _admin_action_fw_extensions_init() {
		if (
			defined( 'DOING_AJAX' ) &&
			DOING_AJAX === true &&
			(
				FW_Request::POST( 'action', '' ) === 'fw_backend_options_render' ||
				FW_Request::POST( 'action', '' ) === 'fw_backend_options_get_values'
			)
		) {
			$this->get_parent()->load_shortcodes();
		}
	}

	/*
	 * Adds the page builder metabox if the $post_type is supported
	 * @internal
	 */
	public function _admin_filter_fw_post_options( $post_options, $post_type ) {
		if ($this->is_admin_builder_enabled($post_type)) {
			$this->get_parent()->load_shortcodes();
			$page_builder_options = array(
				'page-builder-box' => array(
					'title'    => false,
					'type'     => 'box',
					'priority' => 'high',
					'options'  => array(
						$this->get_option_key() => array(
							'label'              => false,
							'desc'               => false,
							'type'               => 'page-builder',
							'editor_integration' => true,
							'fullscreen'         => true,
							'template_saving'    => true,
							'history'            => true,
							'fw-storage'         => 'post-meta-page-builder',
						)
					)
				)
			);
			$post_options         = array_merge( $page_builder_options, $post_options );
		}

		return $post_options;
	}

	/**
	 * Replace post content with the generated builder shortcodes
	 * @internal
	 * @param int $post_id
	 * @param string $option_id
	 * @param array $sub_keys
	 */
	public function _action_fw_post_options_update( $post_id, $option_id, $sub_keys ) {
		if (
			empty($option_id) // all options were updated
			||
			$option_id === $this->get_option_key() // our option was updated
		) {
			//
		} else {
			return;
		}

		if ( wp_is_post_autosave($post_id) || wp_is_post_revision($post_id) ) {
			return;
		}

		if ( ! post_type_supports( get_post_type($post_id), $this->supports_feature_name ) ) {
			return;
		}

		$builder_data = fw_get_db_post_option( $post_id, $this->get_option_key() );

		if ( ! $builder_data['builder_active'] ) {
			return;
		}

		/**
		 * @var FW_Option_Type_Page_Builder $option_type
		 */
		$option_type = fw()->backend->option_type('page-builder');

		/**
		 * Just to create a revision if content was changed
		 * Also for SEO admin inspector and WP Search to work
		 * Note: Treat " because it create problems with slashes (" -> \") and duplicate revisions
		 */
		if (apply_filters('fw:ext:page-builder:generate-post-content-html', true, $post_id)) {
			$post_content = $option_type->json_to_shortcodes( $builder_data['json'] );
			$post_content = str_replace('\\', '\\\\', $post_content); // WordPress "fixes" the slashes
			$post_content = do_shortcode($post_content);
			$post_content = preg_replace('#<script(.*?)>(.*?)</script>#is', '', $post_content);
			$post_content = wp_kses_post( $post_content );

			// In case some shortcode option has been changed but it doesn't have impact on html
			$post_content .= "\n\n". '<!-- '. md5($builder_data['json']) .' -->';
		} else {
			$post_content = '<!-- '. md5($builder_data['json']) .' -->';
		}

		if (
			!($post = get_post($post_id))
			&&
			$post->post_content === $post_content
		) {
			return; // Do nothing if content has no changes
		}

		if (isset($this->prevent_post_update_recursion[$post_id])) {
			return;
		} else {
			$this->prevent_post_update_recursion[$post_id] = true;
		}

		wp_update_post(array(
			'ID' => $post_id,
			'post_content' => $post_content,
		));

		unset($this->prevent_post_update_recursion[$post_id]);
	}

	/**
	 * @internal
	 *
	 * @param $atts
	 *
	 * @return mixed
	 *
	 * @deprecated Since Shortcodes 1.3.0
	 */
	public function _theme_filter_fw_shortcode_atts( $atts ) {
		return $this->get_shortcode_atts_coder()->decode_atts( $atts );
	}

	/**
	 * @internal
	 *
	 * @param string $content
	 *
	 * @return string
	 */
	public function _theme_filter_prevent_autop( $content ) {
		if ( $this->is_builder_post() ) {
			if (!apply_filters(
				'fw_ext_page_builder_output_content_wrapper', true
			)) {
				return $content;
			}

			$wrapper_class = apply_filters( 'fw_ext_page_builder_content_wrapper_class', 'fw-page-builder-content' );

			/**
			 * Wrap the content in a div to prevent wpautop change/break the html generated by shortcodes
			 */

			return
				'<div ' . ( empty( $wrapper_class ) ? '' : 'class="' . esc_attr( $wrapper_class ) . '"' ) . '>' .
				$content .
				'</div>';
		}

		return $content;
	}

	/**
	 * Checks if a post was built with builder
	 *
	 * @param int $post_id
	 *
	 * @return bool
	 */
	public function is_builder_post( $post_id = null ) {
		if ( empty( $post_id ) ) {
			global $post;
		} else {
			$post = get_post( $post_id );
		}

		if ( ! $post ) {
			return false;
		}

		if ( post_type_supports( $post->post_type, $this->supports_feature_name ) ) {
			return (bool) fw_get_db_post_option( $post->ID, $this->get_option_key() . '/builder_active' );
		} else {
			return false;
		}
	}

	public function get_shortcode_atts_coder() {
		if ( ! $this->shortcode_atts_coder ) {
			// lazy init
			$this->shortcode_atts_coder = new _FW_Ext_Page_Builder_Shortcode_Atts_Coder();
		}

		return $this->shortcode_atts_coder;
	}

	/**
	 * @param WP_Post | object $post
	 * @return boolean
	 * @since 1.6.15
	 */
	public function builder_is_active_for($post, $builder_data = null) {
		if (! $builder_data) {
			$builder_data = fw_get_db_post_option(
				$post->ID, $this->get_option_key()
			);
		}

		return post_type_supports(
			get_post_type(
				($post_revision_id = wp_is_post_revision($post)) ? $post_revision_id : $post
			),
			$this->supports_feature_name
		)
		&&
		($builder_data = fw_get_db_post_option($post->ID, $this->get_option_key()))
		&&
		$builder_data['builder_active'];
	}

	/**
	 * @param WP_Post|object $post
	 * @return string
	 * @since 1.5.0
	 */
	private function get_post_content_shortcodes($post) {
		/**
		 * @var FW_Option_Type_Page_Builder $option_type
		 */
		$option_type = fw()->backend->option_type('page-builder');

		if (
			post_type_supports(
				get_post_type(
					($post_revision_id = wp_is_post_revision($post)) ? $post_revision_id : $post
				),
				$this->supports_feature_name
			)
			&&
			($builder_data = fw_get_db_post_option($post->ID, $this->get_option_key()))
			&&
			$builder_data['builder_active']
		) {
			$builder_data = apply_filters(
				'fw:ext:page-builder:builder-data:before-shortcode-generate',
				$builder_data
			);

			if (is_admin()) {
				/**
				 * We can't store in a post meta the shortcode notation [shortcode attr="&quot;hello..."]
				 * because it's much bigger than the json value.
				 * So we generate the shortcode notation before post display in frontend
				 */
				return str_replace( '\\', '\\\\', // WordPress "fixes" the slashes
					$option_type->json_to_shortcodes( $builder_data['json'] )
				);
			} else {
				try { // fixes https://github.com/ThemeFuse/Unyson/issues/2356
					return FW_Cache::get($cache_key = 'fw:ext:page-builder:json-to-shortcodes/'. $post->ID);
				} catch (FW_Cache_Not_Found_Exception $e) {
					$content = str_replace( '\\', '\\\\',
						$option_type->json_to_shortcodes( $builder_data['json'] )
					);

					FW_Cache::set( $cache_key, $content );

					return $content;
				}
			}
		}

		return $post->post_content;
	}

	/**
	 * @param WP_Post[] $posts
	 * @param WP_Query $query
	 *
	 * @return WP_Post[]
	 * @since 1.5.0
	 */
	public function _filter_the_posts( $posts, $query ) {
		if ( empty( $posts ) ) {
			return $posts;
		} elseif ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
			/**
			 * Some plugins do get_posts() in ajax and need full post content html
			 * fixes https://github.com/ThemeFuse/Unyson/issues/1798
			 */
		} elseif ( is_admin() ) {
			/**
			 * This filter is applied for every post in backend
			 * but we don't need post content in backend
			 */
			return $posts;
		}

		if ( ! isset( $posts[1] ) && is_preview() ) {

			$preview = ( $rewisions = wp_get_post_revisions( $posts[0]->ID ) ) && $rewisions ? reset( $rewisions ) : $posts[0];

			$posts[0]->post_content = $this->get_post_content_shortcodes( $preview );

		} else {

			foreach ( $posts as &$post ) {
				$post->post_content = $this->get_post_content_shortcodes( $post );
			}
		}

		return $posts;
	}

	/**
	 * @param FW_Access_Key $access_key
	 * @param int|WP_Post $post
	 * @return string
	 * @internal
	 * @since 1.5.1
	 */
	public function _get_post_content(FW_Access_Key $access_key, $post) {
		if ($access_key->get_key() !== 'fw:ext:page-builder:helper:get-post-content') {
			trigger_error('Method call denied', E_USER_ERROR);
		}

		if (!$post instanceof WP_Post) {
			$post = get_post($post);
		}

		if (!$post) {
			return null;
		}

		return $this->get_post_content_shortcodes($post);
	}

	public function _action_enqueue_shortcodes_admin_scripts(WP_Post $post) {
		if (!$this->is_admin_builder_enabled($post->post_type)) {
			return;
		}

		if (function_exists('fw_ext_shortcodes_enqueue_shortcodes_admin_scripts')) {
			fw_ext_shortcodes_enqueue_shortcodes_admin_scripts();
		}
	}

	private function is_admin_builder_enabled( $post_type ) {
		return (
			post_type_supports( $post_type, 'editor' )
			&&
			post_type_supports( $post_type, $this->supports_feature_name )
			&&
			( ! is_user_logged_in() || ( is_admin() && get_user_meta( get_current_user_id(), 'rich_editing', true ) === 'true' ) || ! is_admin() )
		);
	}

	public function _filter_wp_save_post_revision_post_has_changed($post_has_changed, $last_revision, $post) {
		if (
			$post_has_changed // prevent duplicate revision
			&&
			post_type_supports( $post->post_type, $this->supports_feature_name )
			&&
			($builder_data = fw_get_db_post_option( $post->ID, $this->get_option_key() ))
			&&
			$builder_data['builder_active']
		) {
			return ( fw_get_db_post_option( $last_revision->ID, $this->get_option_key() ) !== fw_get_db_post_option( $post->ID, $this->get_option_key() ) );
		} else {
			return $post_has_changed;
		}
	}

	/**
	 * @param array $post_states
	 * @param WP_Post $post
	 *
	 * @return mixed
	 */
	public function _filter_display_post_states( $post_states, $post ) {

		if ( $this->is_builder_post( $post->ID ) ) {
			$post_states['unyson'] = 'Unyson';
		}

		return $post_states;
	}

	public function get_option_key() {
		return 'page-builder';
	}
}