-
Notifications
You must be signed in to change notification settings - Fork 36
/
wp-parsely.php
422 lines (357 loc) · 13.3 KB
/
wp-parsely.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
<?php
/**
* Plugin Name: VIP Parse.ly Integration
* Plugin URI: https://parse.ly
* Description: Content analytics made easy. Parse.ly gives creators, marketers and developers the tools to understand content performance, prove content value, and deliver tailored content experiences that drive meaningful results.
* Author: Automattic
* Version: 1.0
* Author URI: https://wpvip.com/
* License: GPL2+
* Text Domain: wp-parsely
* Domain Path: /languages/
*
* @package Automattic\VIP\WP_Parsely_Integration
*/
// phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed
namespace Automattic\VIP\WP_Parsely_Integration;
/**
* The default version is the first entry in the SUPPORTED_VERSIONS list.
*/
const SUPPORTED_VERSIONS = [
'3.16',
'3.15',
'3.14',
'3.13',
'3.12',
'3.7',
'3.5',
];
/**
* Keep track of Parse.ly loading info in one place.
*/
final class Parsely_Loader_Info {
// Defaults for when detection was not possible.
const VERSION_UNKNOWN = 'UNKNOWN';
/**
* Status of the plugin.
*
* @var bool
*/
private static bool $active;
/**
* Integration type of the plugin.
*
* @var string
*/
private static string $integration_type;
/**
* Version of the plugin.
*
* @var string
*/
private static string $version;
/**
* Check if the plugin is active.
*
* @return bool
*/
public static function is_active(): bool {
return isset( self::$active ) ? self::$active : false;
}
/**
* Set active.
*
* @param bool $active Status of the plugin.
*/
public static function set_active( bool $active ): void {
self::$active = $active;
}
/**
* Get integration type.
*
* @return string
*/
public static function get_integration_type(): string {
return isset( self::$integration_type ) ? self::$integration_type : Parsely_Integration_Type::NONE;
}
/**
* Set integration type.
*
* @param string $integration_type Type of the integration.
*/
public static function set_integration_type( string $integration_type ): void {
self::$integration_type = $integration_type;
}
/**
* Get version.
*
* @return string
*/
public static function get_version(): string {
return isset( self::$version ) ? self::$version : self::VERSION_UNKNOWN;
}
/**
* Set version.
*
* @param string $version Version of the plugin.
*/
public static function set_version( string $version ): void {
self::$version = $version;
}
/**
* Returns configuration which represents how the plugin is configured in site.
*
* @return array{
* is_pinned_version: bool,
* site_id: string,
* have_api_secret: bool,
* is_javascript_disabled: bool,
* is_autotracking_disabled: bool,
* should_track_logged_in_users: bool,
* tracked_post_types: array{
* name: string,
* track_type: string,
* }[]
* }
*/
public static function get_configs() {
if ( ! self::is_active() ) {
return null;
}
$configs = array();
$options = self::get_parsely_options();
$configs['is_pinned_version'] = has_filter( 'wpvip_parsely_version' );
$configs['site_id'] = $options['apikey'] ?? '';
$configs['have_api_secret'] = '' !== ( $options['api_secret'] ?? '' );
$configs['is_javascript_disabled'] = (bool) ( $options['disable_javascript'] ?? false );
$configs['is_autotracking_disabled'] = (bool) ( $options['disable_autotrack'] ?? false );
$configs['should_track_logged_in_users'] = (bool) ( $options['track_authenticated_users'] ?? false );
$configs['tracked_post_types'] = array();
$post_types = get_post_types( array( 'public' => true ) );
$tracked_post_types = $options['track_post_types'] ?? array();
$tracked_page_types = $options['track_page_types'] ?? array();
foreach ( $post_types as $post_type ) {
$tracked_post_type = array();
$tracked_post_type['name'] = $post_type;
if ( in_array( $post_type, $tracked_post_types ) ) {
$tracked_post_type['track_type'] = 'post';
} elseif ( in_array( $post_type, $tracked_page_types ) ) {
$tracked_post_type['track_type'] = 'non-post';
} else {
$tracked_post_type['track_type'] = 'do-not-track';
}
array_push( $configs['tracked_post_types'], $tracked_post_type );
}
return $configs;
}
/**
* Get Parse.ly options.
*/
public static function get_parsely_options(): array {
if ( ! self::is_active() ) {
return array();
}
/**
* Parse.ly options.
*
* @var array
*/
$parsely_options = array();
if ( isset( $GLOBALS['parsely'] ) && is_a( $GLOBALS['parsely'], 'Parsely\Parsely' ) ) {
$parsely_options = $GLOBALS['parsely']->get_options();
}
return $parsely_options;
}
}
/**
* Annotate the `parsely` option with `'meta_type' => 'repeated_metas'`.
* When this filter is applied thusly, this prints parsely meta as multiple `<meta />` tags
* vs. a single structured ld+json schema.
* This is desirable since many of our sites already have curated schema setups & this could interfere.
*
* @param mixed $parsely_options The value of the `parsely` option from the database. This materializes as an array (but is false when not yet set).
* @return array The annotated array.
*/
function alter_option_use_repeated_metas( $parsely_options = [] ) {
$parsely_options['meta_type'] = 'repeated_metas';
return $parsely_options;
}
/**
* Detects if the user is attempting to activate wp-parsely in wp-admin.
* The Parse.ly plugin will not be in active_plugins, but is pending activation.
*/
function is_queued_for_activation() {
if ( ! is_admin() ) {
return false;
}
// phpcs:disable
if ( isset( $_GET['action'] ) && isset( $_GET['plugin'] ) ) {
if ( 'activate' === $_GET['action'] && false !== strpos( wp_unslash( $_GET['plugin'] ), 'wp-parsely.php' ) ) {
return true;
}
}
// Bulk activation will activate via form submission
$isBulkActivation1 = isset( $_POST['action'] ) && 'activate-selected' === wp_unslash( $_POST['action'] );
$isBulkActivation2 = isset( $_POST['action2'] ) && 'activate-selected' === wp_unslash( $_POST['action2'] );
if ( ( $isBulkActivation1 || $isBulkActivation2 ) && isset( $_POST['checked'] ) && is_array( $_POST['checked'] ) ) {
$plugins_being_activated = wp_unslash( $_POST['checked'] );
foreach ( $plugins_being_activated as $plugin ) {
if ( false !== strpos( $plugin, 'wp-parsely.php' ) ) {
return true;
}
}
}
// phpcs:enable
return false;
}
/**
* Sourcing the wp-parsely plugin via mu-plugins is generally opt-in.
* To enable it on your site, add this line:
* add_filter( 'wpvip_parsely_load_mu', '__return_true' );
*
* We enable it for some sites via the `_wpvip_parsely_mu` blog option.
* To prevent it from loading even when this condition is met, add this line:
* add_filter( 'wpvip_parsely_load_mu', '__return_false' );
*/
function maybe_load_plugin() {
// If the user is activating the plugin in this request, do not try to load wp-parsely via mu.
if ( is_queued_for_activation() ) {
return;
}
// Self-managed integration: The plugin exists on the site and is being loaded already.
$plugin_class_exists = class_exists( 'Parsely' ) || class_exists( 'Parsely\Parsely' );
if ( $plugin_class_exists ) {
Parsely_Loader_Info::set_active( true );
Parsely_Loader_Info::set_integration_type( Parsely_Integration_Type::SELF_MANAGED );
$parsely_options = Parsely_Loader_Info::get_parsely_options();
if ( array_key_exists( 'plugin_version', $parsely_options ) ) {
Parsely_Loader_Info::set_version( $parsely_options['plugin_version'] );
}
return;
}
$parsely_enabled_constant = null; // Represents that the site doesn't have parsely enabled / blocked.
if ( defined( 'VIP_PARSELY_ENABLED' ) ) {
$parsely_enabled_constant = constant( 'VIP_PARSELY_ENABLED' );
// Opt out if constant value isn't true.
if ( true !== $parsely_enabled_constant ) {
Parsely_Loader_Info::set_active( false );
Parsely_Loader_Info::set_integration_type( Parsely_Integration_Type::DISABLED_CONSTANT );
return;
}
Parsely_Loader_Info::set_active( true );
Parsely_Loader_Info::set_integration_type( Parsely_Integration_Type::ENABLED_CONSTANT );
}
$option_load_status = get_option( '_wpvip_parsely_mu', null );
$filtered_load_status = apply_filters( 'wpvip_parsely_load_mu', null );
// If plugin isn't enabled via constant then check for filter and option status.
if ( true !== $parsely_enabled_constant ) {
$should_load = true === $filtered_load_status || '1' === $option_load_status;
$should_prevent_loading = false === $filtered_load_status || '0' === $option_load_status;
// No integration: The site has not enabled parsely.
if ( ! $should_load || $should_prevent_loading ) {
Parsely_Loader_Info::set_active( false );
if ( false === $filtered_load_status ) {
Parsely_Loader_Info::set_integration_type( Parsely_Integration_Type::DISABLED_MUPLUGINS_FILTER );
} elseif ( '0' === $option_load_status ) {
Parsely_Loader_Info::set_integration_type( Parsely_Integration_Type::DISABLED_MUPLUGINS_SILENT_OPTION );
}
return;
}
// Enqueuing the disabling of Parse.ly features when the plugin is loaded (after the `plugins_loaded` hook)
// We need priority 0, so it's executed before `widgets_init`.
add_action( 'init', __NAMESPACE__ . '\maybe_disable_some_features', 0 );
}
$versions_to_try = SUPPORTED_VERSIONS;
/**
* Allows specifying a major version of the plugin per-site.
* If the version is invalid, the default version will be used.
*/
$specified_version = apply_filters( 'wpvip_parsely_version', false );
if ( $specified_version ) {
if ( in_array( $specified_version, SUPPORTED_VERSIONS ) ) {
array_unshift( $versions_to_try, $specified_version );
$versions_to_try = array_unique( $versions_to_try );
} else {
// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error
trigger_error(
sprintf( 'Invalid value configured via wpvip_parsely_version filter: %s', esc_html( $specified_version ) ),
E_USER_WARNING
);
}
}
$versions_exist = false;
foreach ( $versions_to_try as $version ) {
$entry_file = __DIR__ . '/wp-parsely-' . $version . '/wp-parsely.php';
if ( is_readable( $entry_file ) ) {
$versions_exist = true;
break;
}
}
if ( ! $versions_exist ) {
// Attempt to load the submodule.
$entry_file = __DIR__ . '/wp-parsely/wp-parsely.php';
}
// Require the actual wp-parsely plugin.
if ( ! is_readable( $entry_file ) ) {
return;
}
require_once $entry_file;
// If plugin isn't enabled via constant then set filter or option integration_type.
if ( true !== $parsely_enabled_constant ) {
$integration_type = Parsely_Integration_Type::ENABLED_MUPLUGINS_FILTER;
if ( '1' === $option_load_status && true !== $filtered_load_status ) {
$integration_type = Parsely_Integration_Type::ENABLED_MUPLUGINS_SILENT_OPTION;
}
Parsely_Loader_Info::set_integration_type( $integration_type );
}
Parsely_Loader_Info::set_active( true );
Parsely_Loader_Info::set_version( $version );
// Require VIP's customizations over wp-parsely.
$vip_parsely_plugin = __DIR__ . '/vip-parsely/vip-parsely.php';
if ( is_readable( $vip_parsely_plugin ) ) {
require_once $vip_parsely_plugin;
}
}
add_action( 'plugins_loaded', __NAMESPACE__ . '\maybe_load_plugin', 1 );
/**
* Hides the UI if the plugin is loaded via silent option.
*/
function maybe_disable_some_features() {
if ( ! isset( $GLOBALS['parsely'] ) || ! is_a( $GLOBALS['parsely'], 'Parsely\Parsely' ) ) {
return;
}
$filtered_load_status = apply_filters( 'wpvip_parsely_load_mu', null );
$should_disable_features = apply_filters( 'wpvip_parsely_hide_ui_for_mu', true !== $filtered_load_status );
// If the plugin was not loaded via the filter, hide the UI by default.
if ( $should_disable_features ) {
remove_action( 'init', 'Parsely\parsely_wp_admin_early_register' );
remove_action( 'init', 'Parsely\init_recommendations_block' );
remove_action( 'enqueue_block_editor_assets', 'Parsely\init_content_helper' );
remove_action( 'admin_init', 'Parsely\parsely_admin_init_register' );
remove_action( 'widgets_init', 'Parsely\parsely_recommended_widget_register' );
// Don't show the row action links.
add_filter( 'wp_parsely_enable_row_action_links', '__return_false' );
add_filter( 'wp_parsely_enable_rest_api_support', '__return_false' );
add_filter( 'wp_parsely_enable_related_api_proxy', '__return_false' );
// Default to "repeated metas".
add_filter( 'option_parsely', __NAMESPACE__ . '\alter_option_use_repeated_metas' );
// Remove the Parse.ly Recommended Widget.
unregister_widget( 'Parsely_Recommended_Widget' );
}
}
/**
* Enum which represent all options to integrate `wp-parsely`.
*/
abstract class Parsely_Integration_Type { // phpcs:ignore Generic.Files.OneObjectStructurePerFile.MultipleFound, Generic.Classes.OpeningBraceSameLine.ContentAfterBrace
// When parsely is active.
const ENABLED_MUPLUGINS_FILTER = 'ENABLED_MUPLUGINS_FILTER';
const ENABLED_MUPLUGINS_SILENT_OPTION = 'ENABLED_MUPLUGINS_SILENT_OPTION';
const ENABLED_CONSTANT = 'ENABLED_CONSTANT';
const SELF_MANAGED = 'SELF_MANAGED';
// When parsely is not active.
const DISABLED_MUPLUGINS_FILTER = 'DISABLED_MUPLUGINS_FILTER';
const DISABLED_MUPLUGINS_SILENT_OPTION = 'DISABLED_MUPLUGINS_SILENT_OPTION';
const DISABLED_CONSTANT = 'DISABLED_CONSTANT'; // Prevent loading of plugin based on integration meta attribute or customers can also define it.
const NONE = 'NONE';
const NULL = 'NULL';
}