1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* Jetpack's JITM class. |
4
|
|
|
* |
5
|
|
|
* @package automattic/jetpack-jitm |
6
|
|
|
*/ |
7
|
|
|
|
8
|
|
|
namespace Automattic\Jetpack\JITMS; |
9
|
|
|
|
10
|
|
|
use Automattic\Jetpack\Assets; |
11
|
|
|
use Automattic\Jetpack\Connection\Manager; |
12
|
|
|
use Automattic\Jetpack\Connection\Client; |
13
|
|
|
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo; |
14
|
|
|
use Automattic\Jetpack\Partner; |
15
|
|
|
use Automattic\Jetpack\JITMS\Post_Connection_JITM; |
16
|
|
|
use Automattic\Jetpack\JITMS\Pre_Connection_JITM; |
17
|
|
|
use Automattic\Jetpack\Status; |
18
|
|
|
|
19
|
|
|
/** |
20
|
|
|
* Jetpack just in time messaging through out the admin |
21
|
|
|
* |
22
|
|
|
* @since 5.6.0 |
23
|
|
|
*/ |
24
|
|
|
class JITM { |
25
|
|
|
|
26
|
|
|
const PACKAGE_VERSION = '1.0'; // TODO: Keep in sync with version specified in composer.json. |
27
|
|
|
|
28
|
|
|
/** |
29
|
|
|
* The configuration method that is called from the jetpack-config package. |
30
|
|
|
*/ |
31
|
|
|
public static function configure() { |
32
|
|
|
$jitm = self::get_instance(); |
33
|
|
|
$jitm->register(); |
34
|
|
|
} |
35
|
|
|
|
36
|
|
|
/** |
37
|
|
|
* Pre/Post Connection JITM factory metod |
38
|
|
|
* |
39
|
|
|
* @return Post_Connection_JITM|Pre_Connection_JITM JITM instance. |
40
|
|
|
*/ |
41
|
|
|
public static function get_instance() { |
42
|
|
|
if ( \Jetpack::is_active() ) { |
43
|
|
|
$jitm = new Post_Connection_JITM(); |
44
|
|
|
} else { |
45
|
|
|
$jitm = new Pre_Connection_JITM(); |
46
|
|
|
} |
47
|
|
|
return $jitm; |
48
|
|
|
} |
49
|
|
|
|
50
|
|
|
/** |
51
|
|
|
* Determines if JITMs are enabled. |
52
|
|
|
* |
53
|
|
|
* @return bool Enable JITMs. |
54
|
|
|
*/ |
55
|
|
|
public function register() { |
56
|
|
|
/** |
57
|
|
|
* Filter to turn off all just in time messages |
58
|
|
|
* |
59
|
|
|
* @since 3.7.0 |
60
|
|
|
* @since 5.4.0 Correct docblock to reflect default arg value |
61
|
|
|
* |
62
|
|
|
* @param bool false Whether to show just in time messages. |
63
|
|
|
*/ |
64
|
|
|
if ( ! apply_filters( 'jetpack_just_in_time_msgs', false ) ) { |
65
|
|
|
return false; |
66
|
|
|
} |
67
|
|
|
|
68
|
|
|
// Folks cannot connect to WordPress.com and won't really be able to act on the pre-connection messages. So bail. |
69
|
|
|
if ( ( new Status() )->is_development_mode() ) { |
70
|
|
|
return false; |
71
|
|
|
} |
72
|
|
|
|
73
|
|
|
add_action( 'current_screen', array( $this, 'prepare_jitms' ) ); |
74
|
|
|
return true; |
75
|
|
|
} |
76
|
|
|
|
77
|
|
|
/** |
78
|
|
|
* Prepare actions according to screen and post type. |
79
|
|
|
* |
80
|
|
|
* @since 3.8.2 |
81
|
|
|
* |
82
|
|
|
* @uses Jetpack_Autoupdate::get_possible_failures() |
83
|
|
|
* |
84
|
|
|
* @param \WP_Screen $screen WP Core's screen object. |
85
|
|
|
*/ |
86
|
|
|
public function prepare_jitms( $screen ) { |
87
|
|
|
if ( ! in_array( |
88
|
|
|
$screen->id, |
89
|
|
|
array( |
90
|
|
|
'jetpack_page_akismet-key-config', |
91
|
|
|
'admin_page_jetpack_modules', |
92
|
|
|
), |
93
|
|
|
true |
94
|
|
|
) ) { |
95
|
|
|
add_action( 'admin_enqueue_scripts', array( $this, 'jitm_enqueue_files' ) ); |
96
|
|
|
add_action( 'admin_notices', array( $this, 'ajax_message' ) ); |
97
|
|
|
add_action( 'edit_form_top', array( $this, 'ajax_message' ) ); |
98
|
|
|
} |
99
|
|
|
} |
100
|
|
|
|
101
|
|
|
/** |
102
|
|
|
* Function to enqueue jitm css and js |
103
|
|
|
*/ |
104
|
|
|
public function jitm_enqueue_files() { |
105
|
|
|
if ( $this->is_gutenberg_page() ) { |
106
|
|
|
return; |
107
|
|
|
} |
108
|
|
|
$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min'; |
109
|
|
|
wp_register_style( |
110
|
|
|
'jetpack-jitm-css', |
111
|
|
|
plugins_url( "assets/jetpack-admin-jitm{$min}.css", __DIR__ ), |
112
|
|
|
false, |
113
|
|
|
self::PACKAGE_VERSION . |
114
|
|
|
'-201243242' |
115
|
|
|
); |
116
|
|
|
wp_style_add_data( 'jetpack-jitm-css', 'rtl', 'replace' ); |
117
|
|
|
wp_style_add_data( 'jetpack-jitm-css', 'suffix', $min ); |
118
|
|
|
wp_enqueue_style( 'jetpack-jitm-css' ); |
119
|
|
|
|
120
|
|
|
wp_enqueue_script( |
121
|
|
|
'jetpack-jitm-new', |
122
|
|
|
Assets::get_file_url_for_environment( '_inc/build/jetpack-jitm.min.js', '_inc/jetpack-jitm.js' ), |
123
|
|
|
array( 'jquery' ), |
124
|
|
|
self::PACKAGE_VERSION, |
125
|
|
|
true |
126
|
|
|
); |
127
|
|
|
wp_localize_script( |
128
|
|
|
'jetpack-jitm-new', |
129
|
|
|
'jitm_config', |
130
|
|
|
array( |
131
|
|
|
'api_root' => esc_url_raw( rest_url() ), |
132
|
|
|
'activate_module_text' => esc_html__( 'Activate', 'jetpack' ), |
133
|
|
|
'activated_module_text' => esc_html__( 'Activated', 'jetpack' ), |
134
|
|
|
'activating_module_text' => esc_html__( 'Activating', 'jetpack' ), |
135
|
|
|
) |
136
|
|
|
); |
137
|
|
|
} |
138
|
|
|
|
139
|
|
|
/** |
140
|
|
|
* Is the current page a block editor page? |
141
|
|
|
* |
142
|
|
|
* @since 8.0.0 |
143
|
|
|
*/ |
144
|
|
|
public function is_gutenberg_page() { |
145
|
|
|
$current_screen = get_current_screen(); |
146
|
|
|
return ( method_exists( $current_screen, 'is_block_editor' ) && $current_screen->is_block_editor() ); |
147
|
|
|
} |
148
|
|
|
|
149
|
|
|
/** |
150
|
|
|
* Get's the current message path for display of a JITM |
151
|
|
|
* |
152
|
|
|
* @return string The message path |
153
|
|
|
*/ |
154
|
|
|
public function get_message_path() { |
155
|
|
|
$screen = get_current_screen(); |
156
|
|
|
|
157
|
|
|
return 'wp:' . $screen->id . ':' . current_filter(); |
158
|
|
|
} |
159
|
|
|
|
160
|
|
|
/** |
161
|
|
|
* Injects the dom to show a JITM inside of wp-admin. |
162
|
|
|
*/ |
163
|
|
|
public function ajax_message() { |
164
|
|
|
if ( ! is_admin() ) { |
165
|
|
|
return; |
166
|
|
|
} |
167
|
|
|
|
168
|
|
|
// do not display on Gutenberg pages. |
169
|
|
|
if ( $this->is_gutenberg_page() ) { |
170
|
|
|
return; |
171
|
|
|
} |
172
|
|
|
|
173
|
|
|
$message_path = $this->get_message_path(); |
174
|
|
|
$query_string = _http_build_query( $_GET, '', ',' ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
175
|
|
|
$current_screen = wp_unslash( $_SERVER['REQUEST_URI'] ); |
176
|
|
|
?> |
177
|
|
|
<div class="jetpack-jitm-message" |
178
|
|
|
data-nonce="<?php echo esc_attr( wp_create_nonce( 'wp_rest' ) ); ?>" |
179
|
|
|
data-ajax-nonce="<?php echo esc_attr( wp_create_nonce( 'wp_ajax_action' ) ); ?>" |
180
|
|
|
data-message-path="<?php echo esc_attr( $message_path ); ?>" |
181
|
|
|
data-query="<?php echo urlencode_deep( $query_string ); ?>" |
182
|
|
|
data-redirect="<?php echo urlencode_deep( $current_screen ); ?>" |
183
|
|
|
></div> |
184
|
|
|
<?php |
185
|
|
|
} |
186
|
|
|
|
187
|
|
|
/** |
188
|
|
|
* Generate the icon to display on the JITM |
189
|
|
|
* |
190
|
|
|
* @param string $content_icon Icon type name. |
191
|
|
|
* @param bool $full_jp_logo_exists Is there a big JP logo already displayed on this screen. |
192
|
|
|
*/ |
193
|
|
|
public function generate_icon( $content_icon, $full_jp_logo_exists ) { |
194
|
|
|
switch ( $content_icon ) { |
195
|
|
|
case 'jetpack': |
196
|
|
|
$jetpack_logo = new Jetpack_Logo(); |
197
|
|
|
$content_icon = '<div class="jp-emblem">' . ( ( $full_jp_logo_exists ) ? $jetpack_logo->get_jp_emblem() : $jetpack_logo->get_jp_emblem_larger() ) . '</div>'; |
198
|
|
|
break; |
199
|
|
|
case 'woocommerce': |
200
|
|
|
$content_icon = '<div class="jp-emblem"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="Layer_1" x="0px" y="0px" viewBox="0 0 168 100" xml:space="preserve" enable-background="new 0 0 168 100" width="50" height="30"><style type="text/css"> |
201
|
|
|
.st0{clip-path:url(#SVGID_2_);enable-background:new ;} |
202
|
|
|
.st1{clip-path:url(#SVGID_4_);} |
203
|
|
|
.st2{clip-path:url(#SVGID_6_);} |
204
|
|
|
.st3{clip-path:url(#SVGID_8_);fill:#8F567F;} |
205
|
|
|
.st4{clip-path:url(#SVGID_10_);fill:#FFFFFE;} |
206
|
|
|
.st5{clip-path:url(#SVGID_12_);fill:#FFFFFE;} |
207
|
|
|
.st6{clip-path:url(#SVGID_14_);fill:#FFFFFE;} |
208
|
|
|
</style><g><defs><polygon id="SVGID_1_" points="83.8 100 0 100 0 0.3 83.8 0.3 167.6 0.3 167.6 100 "/></defs><clipPath id="SVGID_2_"><use xlink:href="#SVGID_1_" overflow="visible"/></clipPath><g class="st0"><g><defs><rect id="SVGID_3_" width="168" height="100"/></defs><clipPath id="SVGID_4_"><use xlink:href="#SVGID_3_" overflow="visible"/></clipPath><g class="st1"><defs><path id="SVGID_5_" d="M15.6 0.3H152c8.6 0 15.6 7 15.6 15.6v52c0 8.6-7 15.6-15.6 15.6h-48.9l6.7 16.4L80.2 83.6H15.6C7 83.6 0 76.6 0 67.9v-52C0 7.3 7 0.3 15.6 0.3"/></defs><clipPath id="SVGID_6_"><use xlink:href="#SVGID_5_" overflow="visible"/></clipPath><g class="st2"><defs><rect id="SVGID_7_" width="168" height="100"/></defs><clipPath id="SVGID_8_"><use xlink:href="#SVGID_7_" overflow="visible"/></clipPath><rect x="-10" y="-9.7" class="st3" width="187.6" height="119.7"/></g></g></g></g></g><g><defs><path id="SVGID_9_" d="M8.4 14.5c1-1.3 2.4-2 4.3-2.1 3.5-0.2 5.5 1.4 6 4.9 2.1 14.3 4.4 26.4 6.9 36.4l15-28.6c1.4-2.6 3.1-3.9 5.2-4.1 3-0.2 4.9 1.7 5.6 5.7 1.7 9.1 3.9 16.9 6.5 23.4 1.8-17.4 4.8-30 9-37.7 1-1.9 2.5-2.9 4.5-3 1.6-0.1 3 0.3 4.3 1.4 1.3 1 2 2.3 2.1 3.9 0.1 1.2-0.1 2.3-0.7 3.3 -2.7 5-4.9 13.2-6.6 24.7 -1.7 11.1-2.3 19.8-1.9 26.1 0.1 1.7-0.1 3.2-0.8 4.5 -0.8 1.5-2 2.4-3.7 2.5 -1.8 0.1-3.6-0.7-5.4-2.5C52.4 66.7 47.4 57 43.7 44.1c-4.4 8.8-7.7 15.3-9.9 19.7 -4 7.7-7.5 11.7-10.3 11.9 -1.9 0.1-3.5-1.4-4.8-4.7 -3.5-9-7.3-26.3-11.3-52C7.1 17.3 7.5 15.8 8.4 14.5"/></defs><clipPath id="SVGID_10_"><use xlink:href="#SVGID_9_" overflow="visible"/></clipPath><rect x="-2.7" y="-0.6" class="st4" width="90.6" height="86.4"/></g><g><defs><path id="SVGID_11_" d="M155.6 25.2c-2.5-4.3-6.1-6.9-11-7.9 -1.3-0.3-2.5-0.4-3.7-0.4 -6.6 0-11.9 3.4-16.1 10.2 -3.6 5.8-5.3 12.3-5.3 19.3 0 5.3 1.1 9.8 3.3 13.6 2.5 4.3 6.1 6.9 11 7.9 1.3 0.3 2.5 0.4 3.7 0.4 6.6 0 12-3.4 16.1-10.2 3.6-5.9 5.3-12.4 5.3-19.4C159 33.4 157.9 28.9 155.6 25.2zM147 44.2c-0.9 4.5-2.7 7.9-5.2 10.1 -2 1.8-3.9 2.5-5.5 2.2 -1.7-0.3-3-1.8-4-4.4 -0.8-2.1-1.2-4.2-1.2-6.2 0-1.7 0.2-3.4 0.5-5 0.6-2.8 1.8-5.5 3.6-8.1 2.3-3.3 4.7-4.8 7.1-4.2 1.7 0.3 3 1.8 4 4.4 0.8 2.1 1.2 4.2 1.2 6.2C147.5 40.9 147.3 42.6 147 44.2z"/></defs><clipPath id="SVGID_12_"><use xlink:href="#SVGID_11_" overflow="visible"/></clipPath><rect x="109.6" y="6.9" class="st5" width="59.4" height="71.4"/></g><g><defs><path id="SVGID_13_" d="M112.7 25.2c-2.5-4.3-6.1-6.9-11-7.9 -1.3-0.3-2.5-0.4-3.7-0.4 -6.6 0-11.9 3.4-16.1 10.2 -3.5 5.8-5.3 12.3-5.3 19.3 0 5.3 1.1 9.8 3.3 13.6 2.5 4.3 6.1 6.9 11 7.9 1.3 0.3 2.5 0.4 3.7 0.4 6.6 0 12-3.4 16.1-10.2 3.5-5.9 5.3-12.4 5.3-19.4C116 33.4 114.9 28.9 112.7 25.2zM104.1 44.2c-0.9 4.5-2.7 7.9-5.2 10.1 -2 1.8-3.9 2.5-5.5 2.2 -1.7-0.3-3-1.8-4-4.4 -0.8-2.1-1.2-4.2-1.2-6.2 0-1.7 0.2-3.4 0.5-5 0.6-2.8 1.8-5.5 3.6-8.1 2.3-3.3 4.7-4.8 7.1-4.2 1.7 0.3 3 1.8 4 4.4 0.8 2.1 1.2 4.2 1.2 6.2C104.6 40.9 104.4 42.6 104.1 44.2z"/></defs><clipPath id="SVGID_14_"><use xlink:href="#SVGID_13_" overflow="visible"/></clipPath><rect x="66.7" y="6.9" class="st6" width="59.4" height="71.4"/></g></svg></div>'; |
209
|
|
|
break; |
210
|
|
|
default: |
211
|
|
|
$content_icon = ''; |
212
|
|
|
break; |
213
|
|
|
} |
214
|
|
|
return $content_icon; |
215
|
|
|
} |
216
|
|
|
|
217
|
|
|
/** |
218
|
|
|
* Stores dismiss data into an option |
219
|
|
|
* |
220
|
|
|
* @param string $key Dismiss key. |
221
|
|
|
*/ |
222
|
|
|
public function save_dismiss( $key ) { |
223
|
|
|
$hide_jitm = \Jetpack_Options::get_option( 'hide_jitm' ); |
224
|
|
|
if ( ! is_array( $hide_jitm ) ) { |
225
|
|
|
$hide_jitm = array(); |
226
|
|
|
} |
227
|
|
|
|
228
|
|
|
if ( ! isset( $hide_jitm[ $key ] ) || ! is_array( $hide_jitm[ $key ] ) ) { |
229
|
|
|
$hide_jitm[ $key ] = array( |
230
|
|
|
'last_dismissal' => 0, |
231
|
|
|
'number' => 0, |
232
|
|
|
); |
233
|
|
|
} |
234
|
|
|
|
235
|
|
|
$hide_jitm[ $key ] = array( |
236
|
|
|
'last_dismissal' => time(), |
237
|
|
|
'number' => $hide_jitm[ $key ]['number'] + 1, |
238
|
|
|
); |
239
|
|
|
|
240
|
|
|
\Jetpack_Options::update_option( 'hide_jitm', $hide_jitm ); |
241
|
|
|
} |
242
|
|
|
} |
243
|
|
|
|