Automattic\Jetpack\JITMS\Pre_Connection_JITM

Complexity

Total Complexity

21

Size/Duplication

Total Lines	181
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	get_raw_messages()	0	38	1
A	generate_admin_url()	0	5	1
B	filter_messages()	0	38	6
A	is_matching_active_plugin()	0	11	4
B	get_messages()	0	33	8
A	dismiss()	0	4	1

<?php
/**
 * Jetpack's Pre-Connection JITM class.
 *
 * @package automattic/jetpack-jitm
 */

namespace Automattic\Jetpack\JITMS;

use Automattic\Jetpack\JITMS\JITM;

/**
 * Jetpack pre-connection just in time messaging through out the admin.
 */
class Pre_Connection_JITM extends JITM {

	/**
	 * Returns all the pre-connection messages.
	 *
	 * The 'plugin_active' key contains a list of plugins. The JITM will display only when at least one of the plugins
	 * in the list is active.
	 */
	private function get_raw_messages() {
		$jetpack_setup_url = $this->generate_admin_url(
			array(
				'page'    => 'jetpack',
				'#/setup' => '',
			)
		);

		return array(
			array(
				'id'             => 'jpsetup-posts',
				'message_path'   => '/wp:edit-post:admin_notices/',
				'message'        => __( 'Do you know which of these posts gets the most traffic?', 'jetpack' ),
				'description'    => __( 'Set up Jetpack to get in-depth stats about your content and visitors.', 'jetpack' ),
				'button_link'    => $jetpack_setup_url,
				'button_caption' => __( 'Set up Jetpack', 'jetpack' ),
				'plugin_active'  => array( 'jetpack/jetpack.php' ),
			),
			array(
				'id'             => 'jpsetup-upload',
				'message_path'   => '/wp:upload:admin_notices/',
				'message'        => __( 'Do you want lightning-fast images?', 'jetpack' ),
				'description'    => __( 'Set up Jetpack, enable Site Accelerator, and start serving your images lightning fast, for free.', 'jetpack' ),
				'button_link'    => $jetpack_setup_url,
				'button_caption' => __( 'Set up Jetpack', 'jetpack' ),
				'plugin_active'  => array( 'jetpack/jetpack.php' ),
			),
			array(
				'id'             => 'jpsetup-widgets',
				'message_path'   => '/wp:widgets:admin_notices/',
				'message'        => __( 'Looking for even more widgets?', 'jetpack' ),
				'description'    => __( 'Set up Jetpack for great additional widgets that display business contact info and maps, blog stats, and top posts.', 'jetpack' ),
				'button_link'    => $jetpack_setup_url,
				'button_caption' => __( 'Set up Jetpack', 'jetpack' ),
				'plugin_active'  => array( 'jetpack/jetpack.php' ),
			),
		);
	}

	/**
	 * Adds the input query arguments to the admin url.
	 *
	 * @param array $args The query arguments.
	 *
	 * @return string The admin url.
	 */
	private function generate_admin_url( $args ) {
		$args = wp_parse_args( $args );
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
		return $url;
	}

	/**
	 * Filters and formats the messages for the client-side JS renderer
	 *
	 * @param string $message_path Current message path.
	 *
	 * @return array Formatted messages.
	 */
	private function filter_messages( $message_path ) {
		$messages = $this->get_raw_messages();

		$formatted_messages = array();

		foreach ( $messages as $message ) {
			if ( ! preg_match( $message['message_path'], $message_path ) ) {
				continue;
			}

			if ( 'jpsetup-posts' === $message['id'] && wp_count_posts()->publish < 5 ) {
				continue;
			}

			if ( ! $this->is_matching_active_plugin( $message ) ) {
				continue;
			}

			$obj                 = new \stdClass();
			$obj->CTA            = array( // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
				'message'   => $message['button_caption'],
				'newWindow' => false,
			);
			$obj->url            = $message['button_link'];
			$obj->id             = $message['id'];
			$obj->is_dismissible = true;
			$obj->content        = array(
				'message'     => $message['message'],
				'description' => $message['description'],
				'list'        => array(),
				'icon'        => 'jetpack',
			);

			$formatted_messages[] = $obj;
		}

		return $formatted_messages;
	}

	/**
	 * Returns true when one of the plugins in the message's required active plugin list
	 * is active.
	 *
	 * @param array $message The message array.
	 *
	 * @return bool True when a matching plugin is active, else false.
	 */
	private function is_matching_active_plugin( $message ) {
		if ( ! function_exists( 'is_plugin_active' ) ) {
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
		}
		foreach ( $message['plugin_active'] as $plugin ) {
			if ( is_plugin_active( $plugin ) ) {
				return true;
			}
		}
		return false;
	}

	/**
	 * Retrieve the current message to display keyed on query string and message path
	 *
	 * @param string $message_path The message path to ask for.
	 * @param string $query The query string originally from the front end. Unused in this subclass.
	 * @param bool   $full_jp_logo_exists If there is a full Jetpack logo already on the page.
	 *
	 * @return array The JITMs to show, or an empty array if there is nothing to show
	 */
	public function get_messages( $message_path, $query, $full_jp_logo_exists ) {
		/** This filter is documented in  class.jetpack-connection-banner.php */
		if ( ! apply_filters( 'jetpack_pre_connection_prompt_helpers', false ) ) {
			// If filter jetpack_pre_connection_prompt_helpers is not set, return an empty array.
			return array();
		}

		if ( ! current_user_can( 'install_plugins' ) ) {
			return array();
		}

		$messages = $this->filter_messages( $message_path );

		if ( empty( $messages ) ) {
			return array();
		}

		$hidden_jitms = \Jetpack_Options::get_option( 'hide_jitm' );

		foreach ( $messages as $idx => &$envelope ) {
			$dismissed_feature = isset( $hidden_jitms[ 'pre-connection-' . $envelope->id ] ) &&
				is_array( $hidden_jitms[ 'pre-connection-' . $envelope->id ] ) ? $hidden_jitms[ 'pre-connection-' . $envelope->id ] : null;

			if ( is_array( $dismissed_feature ) ) {
				unset( $messages[ $idx ] );
				continue;
			}

			$envelope->content['icon'] = $this->generate_icon( $envelope->content['icon'], $full_jp_logo_exists );
		}

		return $messages;
	}

	/**
	 * Dismisses a JITM ID so that it will no longer be shown.
	 *
	 * @param string $id The id of the JITM that was dismissed.
	 *
	 * @return bool Always true
	 */
	public function dismiss( $id ) {
		$this->save_dismiss( 'pre-connection-' . $id );
		return true;
	}
}