register();
}
/**
* Pre/Post Connection JITM factory metod
*
* @return Post_Connection_JITM|Pre_Connection_JITM JITM instance.
*/
public static function get_instance() {
if ( ( new Connection_Manager() )->is_connected() ) {
$jitm = new Post_Connection_JITM();
} else {
$jitm = new Pre_Connection_JITM();
}
return $jitm;
}
/**
* Sets up JITM action callbacks if needed.
*/
public function register() {
if ( did_action( 'jetpack_registered_jitms' ) ) {
// JITMs have already been registered.
return;
}
if ( ! $this->jitms_enabled() ) {
// Do nothing.
return;
}
add_action( 'rest_api_init', array( __NAMESPACE__ . '\\Rest_Api_Endpoints', 'register_endpoints' ) );
add_action( 'current_screen', array( $this, 'prepare_jitms' ) );
/**
* These are sync actions that we need to keep track of for jitms.
*/
add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
/**
* Fires when the JITMs are registered. This action is used to ensure that
* JITMs are registered only once.
*
* @since 1.16.0
*/
do_action( 'jetpack_registered_jitms' );
}
/**
* Checks the jetpack_just_in_time_msgs filters and whether the site
* is offline to determine whether JITMs are enabled.
*
* @return bool True if JITMs are enabled, else false.
*/
public function jitms_enabled() {
/**
* Filter to turn off all just in time messages
*
* @since 1.1.0
* @since-jetpack 3.7.0
* @since-jetpack 5.4.0 Correct docblock to reflect default arg value
*
* @param bool true Whether to show just in time messages.
*/
if ( ! apply_filters( 'jetpack_just_in_time_msgs', true ) ) {
return false;
}
// Folks cannot connect to WordPress.com and won't really be able to act on the pre-connection messages. So bail.
if ( ( new Status() )->is_offline_mode() ) {
return false;
}
return true;
}
/**
* Prepare actions according to screen and post type.
*
* @since 1.1.0
* @since-jetpack 3.8.2
*
* @uses Jetpack_Autoupdate::get_possible_failures()
*
* @param \WP_Screen $screen WP Core's screen object.
*/
public function prepare_jitms( $screen ) {
/**
* Filter to hide JITMs on certain screens.
*
* @since 1.14.0
*
* @param bool true Whether to show just in time messages.
* @param string $string->id The ID of the current screen.
*/
if ( apply_filters( 'jetpack_display_jitms_on_screen', true, $screen->id ) ) {
add_action( 'admin_enqueue_scripts', array( $this, 'jitm_enqueue_files' ) );
add_action( 'admin_notices', array( $this, 'ajax_message' ) );
add_action( 'edit_form_top', array( $this, 'ajax_message' ) );
}
}
/**
* Function to enqueue jitm css and js
*/
public function jitm_enqueue_files() {
if ( $this->is_gutenberg_page() ) {
return;
}
Assets::register_script(
'jetpack-jitm',
'../build/index.js',
__FILE__,
array(
'in_footer' => true,
'dependencies' => array( 'jquery' ),
)
);
Assets::enqueue_script( 'jetpack-jitm' );
wp_localize_script(
'jetpack-jitm',
'jitm_config',
array(
'api_root' => esc_url_raw( rest_url() ),
'activate_module_text' => esc_html__( 'Activate', 'jetpack-jitm' ),
'activated_module_text' => esc_html__( 'Activated', 'jetpack-jitm' ),
'activating_module_text' => esc_html__( 'Activating', 'jetpack-jitm' ),
'nonce' => wp_create_nonce( 'wp_rest' ),
)
);
}
/**
* Is the current page a block editor page?
*
* @since 1.1.0
* @since-jetpack 8.0.0
*/
public function is_gutenberg_page() {
$current_screen = get_current_screen();
return ( method_exists( $current_screen, 'is_block_editor' ) && $current_screen->is_block_editor() );
}
/**
* Get's the current message path for display of a JITM
*
* @return string The message path
*/
public function get_message_path() {
$screen = get_current_screen();
return 'wp:' . $screen->id . ':' . current_filter();
}
/**
* Injects the dom to show a JITM inside of wp-admin.
*/
public function ajax_message() {
if ( ! is_admin() ) {
return;
}
// do not display on Gutenberg pages.
if ( $this->is_gutenberg_page() ) {
return;
}
$message_path = $this->get_message_path();
$query_string = _http_build_query( $_GET, '', ',' ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
$current_screen = isset( $_SERVER['REQUEST_URI'] ) ? wp_unslash( $_SERVER['REQUEST_URI'] ) : ''; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput -- Escaped below
?>
' . ( ( $full_jp_logo_exists ) ? $jetpack_logo->get_jp_emblem() : $jetpack_logo->get_jp_emblem_larger() ) . '';
break;
case 'woocommerce':
$content_icon = '';
break;
default:
$content_icon = '';
break;
}
return $content_icon;
}
/**
* Returns an array containing the supported icons for JITMs.
*
* The list includes an empty string, which is used when no icon should be displayed.
*
* @return array The list of supported icons.
*/
public function get_supported_icons() {
return array(
'jetpack',
'woocommerce',
'',
);
}
/**
* Stores dismiss data into an option
*
* @param string $key Dismiss key.
*/
public function save_dismiss( $key ) {
$hide_jitm = \Jetpack_Options::get_option( 'hide_jitm' );
if ( ! is_array( $hide_jitm ) ) {
$hide_jitm = array();
}
if ( ! isset( $hide_jitm[ $key ] ) || ! is_array( $hide_jitm[ $key ] ) ) {
$hide_jitm[ $key ] = array(
'last_dismissal' => 0,
'number' => 0,
);
}
$hide_jitm[ $key ] = array(
'last_dismissal' => time(),
'number' => $hide_jitm[ $key ]['number'] + 1,
);
\Jetpack_Options::update_option( 'hide_jitm', $hide_jitm );
}
/**
* Sets the 'jetpack_last_plugin_sync' transient when the active_plugins option is synced.
*
* @param array $params The action parameters.
*
* @return array Returns the action parameters unchanged.
*/
public function jetpack_track_last_sync_callback( $params ) {
/**
* This filter is documented in the Automattic\Jetpack\JITMS\Post_Connection_JITM class.
*/
if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', true ) ) {
return $params;
}
if ( is_array( $params ) && isset( $params[0] ) ) {
$option = $params[0];
if ( 'active_plugins' === $option ) {
// Use the cache if we can, but not terribly important if it gets evicted.
set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
}
}
return $params;
}
}