jetpack / modules / shortcodes / mailchimp.php

mailchimp.php in Jetpack – WP Security, Backup, Speed, & Growth 14.8, at modules/shortcodes/mailchimp.php

226 lines 7.0 KB

Raw Download Zip

1	<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* MailChimp Subscriber Popup Form shortcode
4	*
5	* Example:
6	* [mailchimp_subscriber_popup baseUrl="mc.us11.list-manage.com" uuid="1ca7856462585a934b8674c71" lid="2d24f1898b"]
7	*
8	* Embed code example:
9	* <script type="text/javascript" src="//downloads.mailchimp.com/js/signup-forms/popup/unique-methods/embed.js" data-dojo-config="usePlainJson: true, isDebug: false"></script><script type="text/javascript">window.dojoRequire(["mojo/signup-forms/Loader"], function(L) { L.start({"baseUrl":"mc.us11.list-manage.com","uuid":"1ca7856462585a934b8674c71","lid":"2d24f1898b","uniqueMethods":true}) })</script>
10	*/
11
12	// phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move classes to appropriately-named class files.
13
14	/**
15	* Register [mailchimp_subscriber_popup] shortcode and add a filter to 'pre_kses' queue to reverse MailChimp embed to shortcode.
16	*
17	* @since 4.5.0
18	*/
19	function jetpack_mailchimp_subscriber_popup() {
20	add_shortcode(
21	'mailchimp_subscriber_popup',
22	array(
23	'MailChimp_Subscriber_Popup',
24	'shortcode',
25	)
26	);
27	add_filter(
28	'pre_kses',
29	array(
30	'MailChimp_Subscriber_Popup',
31	'reversal',
32	)
33	);
34	}
35
36	if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
37	add_action( 'init', 'jetpack_mailchimp_subscriber_popup' );
38	} else {
39	jetpack_mailchimp_subscriber_popup();
40	}
41
42	/**
43	* Class MailChimp_Subscriber_Popup
44	*
45	* @since 4.5.0
46	*/
47	class MailChimp_Subscriber_Popup {
48
49	/**
50	* Regular expressions to reverse script tags to shortcodes.
51	*
52	* @var array
53	*/
54	private static $reversal_regexes = array(
55	/* raw examplejs */
56	'/<script type="text\/javascript" src="(https?:)?\/\/downloads\.mailchimp\.com\/js\/signup-forms\/popup\/unique-methods\/embed\.js" data-dojo-config="([^"]?)"><\/script><script type="text\/javascript">window.dojoRequire$\["mojo\/signup-forms\/Loader"\]\, function\(L$ { L\.start${([^}]?)}$ }\)<\/script>/s', //phpcs:ignore
57	/* visual editor */
58	'/<script type="text\/javascript" src="(https?:)?\/\/downloads\.mailchimp\.com\/js\/signup-forms\/popup\/unique-methods\/embed\.js" data-dojo-config="([^"]?)"><\/script><script type="text\/javascript">window.dojoRequire$\["mojo\/signup-forms\/Loader"]\, function\(L$ { L\.start${([^}]?)}$ }\)<\/script>/s',
59	);
60
61	/**
62	* Allowed configuration attributes. Used in reversal when checking allowed attributes.
63	*
64	* @var array
65	*/
66	private static $allowed_config = array(
67	'usePlainJson' => 'true',
68	'isDebug' => 'false',
69	);
70
71	/**
72	* Allowed JS variables. Used in reversal to whitelist variables.
73	*
74	* @var array
75	*/
76	private static $allowed_js_vars = array(
77	'baseUrl',
78	'uuid',
79	'lid',
80	);
81
82	/**
83	* Runs the whole reversal.
84	*
85	* @since 4.5.0
86	*
87	* @param string $content Post Content.
88	*
89	* @return string Content with embeds replaced
90	*/
91	public static function reversal( $content ) {
92	// Bail without the js src.
93	if ( ! is_string( $content ) \|\| false === stripos( $content, 'downloads.mailchimp.com/js/signup-forms/popup/unique-methods/embed.js' ) ) {
94	return $content;
95	}
96
97	// loop through our rules and find valid embeds.
98	foreach ( self::$reversal_regexes as $regex ) {
99
100	if ( ! preg_match_all( $regex, $content, $matches ) ) {
101	continue;
102	}
103
104	foreach ( $matches[3] as $index => $js_vars ) {
105	// the regex rule for a specific embed.
106	$replace_regex = sprintf( '#\s%s\s#', preg_quote( $matches[0][ $index ], '#' ) );
107
108	$attrs = json_decode( '{' . $js_vars . '}' );
109
110	if ( $matches[2][ $index ] ) {
111	$config_attrs = json_decode( '{' . $matches[2][ $index ] . '}' );
112	foreach ( $config_attrs as $key => $value ) {
113	$attrs->$key = ( 1 === $value ) ? 'true' : 'false';
114	}
115	}
116
117	$shortcode = self::build_shortcode_from_reversal_attrs( $attrs );
118
119	$content = preg_replace( $replace_regex, "\n\n$shortcode\n\n", $content );
120
121	/** This action is documented in modules/widgets/social-media-icons.php */
122	do_action( 'jetpack_bump_stats_extras', 'html_to_shortcode', 'mailchimp_subscriber_popup' );
123	}
124	}
125
126	return $content;
127	}
128
129	/**
130	* Builds the actual shortcode based on passed in attributes.
131	*
132	* @since 4.5.0
133	*
134	* @param array $attrs A valid list of attributes (gets matched against self::$allowed_config and self::$allowed_js_vars).
135	*
136	* @return string
137	*/
138	private static function build_shortcode_from_reversal_attrs( $attrs ) {
139	$shortcode = '[mailchimp_subscriber_popup ';
140
141	foreach ( $attrs as $key => $value ) {
142	// skip unsupported keys.
143	if (
144	! array_key_exists( $key, self::$allowed_config )
145	&& ! in_array( $key, self::$allowed_js_vars, true )
146	) {
147	continue;
148	}
149
150	$value = esc_attr( $value );
151	$shortcode .= "$key='$value' ";
152	}
153	return trim( $shortcode ) . ']';
154	}
155
156	/**
157	* Parses the shortcode back out to embedded information.
158	*
159	* @since 4.5.0
160	*
161	* @param array $lcase_attrs Lowercase shortcode attributes.
162	*
163	* @return string
164	*/
165	public static function shortcode( $lcase_attrs ) {
166	static $displayed_once = false;
167
168	// Limit to one form per page load.
169	if ( $displayed_once ) {
170	return '';
171	}
172
173	if ( empty( $lcase_attrs ) ) {
174	return '<!-- Missing MailChimp baseUrl, uuid or lid -->';
175	}
176
177	$defaults = array_fill_keys( self::$allowed_js_vars, '' );
178	$defaults = array_merge( $defaults, self::$allowed_config );
179
180	// Convert $attrs back to proper casing since they come through in all lowercase.
181	$attrs = array();
182	foreach ( $defaults as $key => $value ) {
183	if ( array_key_exists( strtolower( $key ), $lcase_attrs ) ) {
184	$attrs[ $key ] = $lcase_attrs[ strtolower( $key ) ];
185	}
186	}
187	$attrs = array_map( 'esc_js', array_filter( shortcode_atts( $defaults, $attrs ) ) );
188
189	// Split config & js vars.
190	$js_vars = array();
191	$config_vars = array();
192	foreach ( $attrs as $key => $value ) {
193	if (
194	'baseUrl' === $key
195	&& (
196	! preg_match( '#mc\.us\d+\.list-manage\d?\.com#', $value, $matches )
197	\|\| $value !== $matches[0]
198	)
199	) {
200	return '<!-- Invalid MailChimp baseUrl -->';
201	}
202
203	if ( in_array( $key, self::$allowed_js_vars, true ) ) {
204	$js_vars[ $key ] = $value;
205	} else {
206	$config_vars[] = "$key: $value";
207	}
208	}
209
210	// If one of these parameters is missing we can't render the form so exist.
211	if ( empty( $js_vars['baseUrl'] ) \|\| empty( $js_vars['uuid'] ) \|\| empty( $js_vars['lid'] ) ) {
212	return '<!-- Missing MailChimp baseUrl, uuid or lid -->';
213	}
214
215	// Add a uniqueMethods parameter if it is missing from the data we got from the embed code.
216	$js_vars['uniqueMethods'] = true;
217
218	/** This action is already documented in modules/widgets/gravatar-profile.php */
219	do_action( 'jetpack_stats_extra', 'mailchimp_subscriber_popup', 'view' );
220
221	$displayed_once = true;
222
223	return "\n\n" . '<script type="text/javascript" data-dojo-config="' . esc_attr( implode( ', ', $config_vars ) ) . '">jQuery.getScript( "//downloads.mailchimp.com/js/signup-forms/popup/unique-methods/embed.js", function( data, textStatus, jqxhr ) { window.dojoRequire(["mojo/signup-forms/Loader"], function(L) { L.start(' . wp_json_encode( $js_vars ) . ') });} );</script>' . "\n\n";
224	}
225	}
226