-
Notifications
You must be signed in to change notification settings - Fork 384
/
Copy pathclass-amp-validation-manager.php
1851 lines (1660 loc) · 60.6 KB
/
class-amp-validation-manager.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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Class AMP_Validation_Manager
*
* @package AMP
*/
/**
* Class AMP_Validation_Manager
*
* @since 0.7
*/
class AMP_Validation_Manager {
/**
* Query var that triggers validation.
*
* @var string
*/
const VALIDATE_QUERY_VAR = 'amp_validate';
/**
* Query var for containing the number of validation errors on the frontend after redirection when invalid.
*
* @var string
*/
const VALIDATION_ERRORS_QUERY_VAR = 'amp_validation_errors';
/**
* Query var for passing status preview/update for validation error.
*
* @var string
*/
const VALIDATION_ERROR_TERM_STATUS_QUERY_VAR = 'amp_validation_error_term_status';
/**
* Query var for cache-busting.
*
* @var string
*/
const CACHE_BUST_QUERY_VAR = 'amp_cache_bust';
/**
* Transient key to store validation errors when activating a plugin.
*
* @var string
*/
const PLUGIN_ACTIVATION_VALIDATION_ERRORS_TRANSIENT_KEY = 'amp_plugin_activation_validation_errors';
/**
* The name of the REST API field with the AMP validation results.
*
* @var string
*/
const VALIDITY_REST_FIELD_NAME = 'amp_validity';
/**
* The errors encountered when validating.
*
* @var array[][] {
* @type array $error Error code.
* @type bool $sanitized Whether sanitized.
* @type string $slug Hash of the error.
* }
*/
public static $validation_results = array();
/**
* Sources that enqueue each script.
*
* @var array
*/
public static $enqueued_script_sources = array();
/**
* Sources that enqueue each style.
*
* @var array
*/
public static $enqueued_style_sources = array();
/**
* Post IDs for posts that have been updated which need to be re-validated.
*
* Keys are post IDs and values are whether the post has been re-validated.
*
* @var bool[]
*/
public static $posts_pending_frontend_validation = array();
/**
* Current sources gathered for a given hook currently being run.
*
* @see AMP_Validation_Manager::wrap_hook_callbacks()
* @see AMP_Validation_Manager::decorate_filter_source()
* @var array[]
*/
protected static $current_hook_source_stack = array();
/**
* Index for where block appears in a post's content.
*
* @var int
*/
protected static $block_content_index = 0;
/**
* Hook source stack.
*
* This has to be public for the sake of PHP 5.3.
*
* @since 0.7
* @var array[]
*/
public static $hook_source_stack = array();
/**
* Whether validation error sources should be located.
*
* @var bool
*/
public static $should_locate_sources = false;
/**
* Overrides for validation errors.
*
* @var array
*/
public static $validation_error_status_overrides = array();
/**
* Whether the admin bar item was added for AMP.
*
* @var bool
*/
protected static $amp_admin_bar_item_added = false;
/**
* Add the actions.
*
* @param array $args {
* Args.
*
* @type bool $should_locate_sources Whether to locate sources.
* }
* @return void
*/
public static function init( $args = array() ) {
$args = array_merge(
array(
'should_locate_sources' => self::should_validate_response(),
),
$args
);
self::$should_locate_sources = $args['should_locate_sources'];
AMP_Invalid_URL_Post_Type::register();
AMP_Validation_Error_Taxonomy::register();
// Short-circuit if AMP is not supported as only the post types should be available.
if ( ! current_theme_supports( 'amp' ) ) {
return;
}
add_action( 'save_post', array( __CLASS__, 'handle_save_post_prompting_validation' ) );
add_action( 'enqueue_block_editor_assets', array( __CLASS__, 'enqueue_block_validation' ) );
add_action( 'edit_form_top', array( __CLASS__, 'print_edit_form_validation_status' ), 10, 2 );
add_action( 'all_admin_notices', array( __CLASS__, 'print_plugin_notice' ) );
add_action( 'rest_api_init', array( __CLASS__, 'add_rest_api_fields' ) );
// Actions and filters involved in validation.
add_action( 'activate_plugin', function() {
if ( ! has_action( 'shutdown', array( __CLASS__, 'validate_after_plugin_activation' ) ) ) {
add_action( 'shutdown', array( __CLASS__, 'validate_after_plugin_activation' ) ); // Shutdown so all plugins will have been activated.
}
} );
// Prevent query vars from persisting after redirect.
add_filter( 'removable_query_args', function( $query_vars ) {
$query_vars[] = AMP_Validation_Manager::VALIDATION_ERRORS_QUERY_VAR;
return $query_vars;
} );
add_action( 'admin_bar_menu', array( __CLASS__, 'add_admin_bar_menu_items' ), 100 );
// Add filter to auto-accept tree shaking validation error.
if ( AMP_Options_Manager::get_option( 'accept_tree_shaking' ) || AMP_Options_Manager::get_option( 'force_sanitization' ) ) {
add_filter( 'amp_validation_error_sanitized', array( __CLASS__, 'filter_tree_shaking_validation_error_as_accepted' ), 10, 2 );
}
if ( self::$should_locate_sources ) {
self::add_validation_error_sourcing();
}
}
/**
* Determine whether AMP theme support is forced via the amp_validate query param.
*
* @since 1.0
*
* @return bool Whether theme support forced.
*/
public static function is_theme_support_forced() {
return (
isset( $_GET[ self::VALIDATE_QUERY_VAR ] ) // WPCS: CSRF OK.
&&
( self::has_cap() || self::get_amp_validate_nonce() === $_GET[ self::VALIDATE_QUERY_VAR ] ) // WPCS: CSRF OK.
);
}
/**
* Return whether sanitization is forcibly accepted, whether because in native mode or via user option.
*
* @return bool Whether sanitization is forcibly accepted.
*/
public static function is_sanitization_forcibly_accepted() {
return amp_is_canonical() || AMP_Options_Manager::get_option( 'force_sanitization' );
}
/**
* Filter a tree-shaking validation error as accepted for sanitization.
*
* @param bool $sanitized Sanitized.
* @param array $error Error.
* @return bool Sanitized.
*/
public static function filter_tree_shaking_validation_error_as_accepted( $sanitized, $error ) {
if ( AMP_Style_Sanitizer::TREE_SHAKING_ERROR_CODE === $error['code'] ) {
$sanitized = true;
}
return $sanitized;
}
/**
* Add menu items to admin bar for AMP.
*
* When on a non-AMP response (paired mode), then the admin bar item should include:
* - Icon: LINK SYMBOL when AMP not known to be invalid and sanitization is not forced, or CROSS MARK when AMP is known to be valid.
* - Parent admin item and first submenu item: link to AMP version.
* - Second submenu item: link to validate the URL.
*
* When on paired AMP response:
* - Icon: CHECK MARK if no unaccepted validation errors on page, or WARNING SIGN if there are unaccepted validation errors which are being forcibly sanitized.
* Otherwise, if there are unsanitized validation errors then a redirect to the non-AMP version will be done.
* - Parent admin item and first submenu item: link to non-AMP version.
* - Second submenu item: link to validate the URL.
*
* When on native AMP response:
* - Icon: CHECK MARK if no unaccepted validation errors on page, or WARNING SIGN if there are unaccepted validation errors.
* - Parent admin and first submenu item: link to validate the URL.
*
* @see AMP_Validation_Manager::finalize_validation() Where the emoji is updated.
*
* @param WP_Admin_Bar $wp_admin_bar Admin bar.
*/
public static function add_admin_bar_menu_items( $wp_admin_bar ) {
if ( is_admin() || ! self::has_cap() ) {
self::$amp_admin_bar_item_added = false;
return;
}
$availability = AMP_Theme_Support::get_template_availability();
if ( ! $availability['supported'] ) {
self::$amp_admin_bar_item_added = false;
return;
}
$amp_invalid_url_post = null;
$current_url = amp_get_current_url();
$non_amp_url = amp_remove_endpoint( $current_url );
$amp_url = remove_query_arg(
array_merge(
wp_removable_query_args(),
array(
self::VALIDATE_QUERY_VAR,
'amp_preserve_source_comments',
)
),
$current_url
);
if ( ! amp_is_canonical() ) {
$amp_url = add_query_arg( amp_get_slug(), '', $amp_url );
}
$error_count = -1;
/*
* If not an AMP response, then obtain the count of validation errors from either the query param supplied after redirecting from AMP
* to non-AMP due to validation errors (see AMP_Theme_Support::prepare_response()), or if there is an amp_invalid_url post that already
* is populated with the last-known validation errors. Otherwise, if it *is* an AMP response then the error count is obtained after
* when the response is being prepared by AMP_Validation_Manager::finalize_validation().
*/
if ( ! is_amp_endpoint() ) {
if ( isset( $_GET[ self::VALIDATION_ERRORS_QUERY_VAR ] ) && is_numeric( $_GET[ self::VALIDATION_ERRORS_QUERY_VAR ] ) ) { // WPCS: CSRF OK.
$error_count = intval( $_GET[ self::VALIDATION_ERRORS_QUERY_VAR ] );
}
if ( $error_count < 0 ) {
$amp_invalid_url_post = AMP_Invalid_URL_Post_Type::get_invalid_url_post( $amp_url );
if ( $amp_invalid_url_post ) {
$error_count = 0;
foreach ( AMP_Invalid_URL_Post_Type::get_invalid_url_validation_errors( $amp_invalid_url_post ) as $error ) {
if ( AMP_Validation_Error_Taxonomy::VALIDATION_ERROR_ACCEPTED_STATUS !== $error['term_status'] ) {
$error_count++;
}
}
}
}
}
$user_can_revalidate = $amp_invalid_url_post ? current_user_can( 'edit_post', $amp_invalid_url_post->ID ) : current_user_can( 'manage_options' );
if ( ! $user_can_revalidate ) {
return;
}
// @todo The amp_invalid_url post should probably only be accessible to users who can manage_options, or limit access to a post if the user has the cap to edit the queried object?
$validate_url = AMP_Invalid_URL_Post_Type::get_recheck_url( $amp_invalid_url_post ? $amp_invalid_url_post : $amp_url );
if ( is_amp_endpoint() ) {
$icon = '✅'; // WHITE HEAVY CHECK MARK. This will get overridden in AMP_Validation_Manager::finalize_validation() if there are unaccepted errors.
} elseif ( $error_count > 0 && ! self::is_sanitization_forcibly_accepted() ) {
$icon = '❌'; // CROSS MARK.
} else {
$icon = '🔗'; // LINK SYMBOL.
}
$validate_item = array(
'parent' => 'amp',
'id' => 'amp-validity',
'href' => esc_url( $validate_url ),
);
if ( $error_count <= 0 ) {
$validate_item['item'] = esc_html__( 'Re-validate', 'amp' );
} else {
$validate_item['item'] = esc_html(
sprintf(
/* translators: %s is count of validation errors */
_n(
'Re-validate (%s validation error)',
'Re-validate (%s validation errors)',
$error_count,
'amp'
),
number_format_i18n( $error_count )
)
);
}
$parent = array(
'id' => 'amp',
'title' => sprintf(
'<span id="amp-admin-bar-item-status-icon">%s</span> %s',
$icon,
esc_html( is_amp_endpoint() ? __( 'AMP', 'amp' ) : __( 'View AMP', 'amp' ) )
),
);
$first_item_is_validate = (
amp_is_canonical()
||
( ! is_amp_endpoint() && $error_count > 0 && ! self::is_sanitization_forcibly_accepted() )
);
if ( $first_item_is_validate ) {
$title = __( 'Validate AMP', 'amp' );
$parent['href'] = esc_url( $validate_url );
} elseif ( is_amp_endpoint() ) {
$title = __( 'AMP', 'amp' );
$parent['href'] = esc_url( $non_amp_url );
} else {
$title = __( 'View AMP', 'amp' );
$parent['href'] = esc_url( $amp_url );
}
$parent['title'] = sprintf(
'<span id="amp-admin-bar-item-status-icon">%s</span> %s',
$icon,
esc_html( $title )
);
$wp_admin_bar->add_menu( $parent );
// Add admin bar item to switch between AMP and non-AMP if parent node is also an AMP link.
if ( ! $first_item_is_validate ) {
$wp_admin_bar->add_menu( array(
'parent' => 'amp',
'id' => 'amp-view',
'title' => esc_html( is_amp_endpoint() ? __( 'View non-AMP version', 'amp' ) : __( 'View AMP version', 'amp' ) ),
'href' => esc_url( is_amp_endpoint() ? $non_amp_url : $amp_url ),
) );
}
// Validate admin bar item.
if ( $error_count <= 0 ) {
$title = esc_html__( 'Re-validate', 'amp' );
} else {
$title = esc_html(
sprintf(
/* translators: %s is count of validation errors */
_n(
'Re-validate (%s validation error)',
'Re-validate (%s validation errors)',
$error_count,
'amp'
),
number_format_i18n( $error_count )
)
);
}
$wp_admin_bar->add_menu( array(
'parent' => 'amp',
'id' => 'amp-validity',
'title' => esc_html( $title ),
'href' => esc_url( $validate_url ),
) );
// Scrub the query var from the URL.
if ( ! is_amp_endpoint() && isset( $_GET[ self::VALIDATION_ERRORS_QUERY_VAR ] ) ) { // WPCS: CSRF OK.
add_action( 'wp_before_admin_bar_render', function() {
?>
<script>
(function( queryVar ) {
var urlParser = document.createElement( 'a' );
urlParser.href = location.href;
urlParser.search = urlParser.search.substr( 1 ).split( /&/ ).filter( function( part ) {
return 0 !== part.indexOf( queryVar + '=' );
} );
if ( urlParser.href !== location.href ) {
history.replaceState( {}, '', urlParser.href );
}
})( <?php echo wp_json_encode( AMP_Validation_Manager::VALIDATION_ERRORS_QUERY_VAR ); ?> );
</script>
<?php
} );
}
self::$amp_admin_bar_item_added = true;
}
/**
* Add hooks for doing determining sources for validation errors during preprocessing/sanitizing.
*/
public static function add_validation_error_sourcing() {
// Capture overrides validation error status overrides from query var.
$can_override_validation_error_statuses = (
isset( $_REQUEST[ self::VALIDATE_QUERY_VAR ] ) // WPCS: CSRF ok.
&&
self::get_amp_validate_nonce() === $_REQUEST[ self::VALIDATE_QUERY_VAR ] // WPCS: CSRF ok.
&&
isset( $_REQUEST[ self::VALIDATION_ERROR_TERM_STATUS_QUERY_VAR ] ) // WPCS: CSRF ok.
&&
is_array( $_REQUEST[ self::VALIDATION_ERROR_TERM_STATUS_QUERY_VAR ] ) // WPCS: CSRF ok.
);
if ( $can_override_validation_error_statuses ) {
/*
* This can't just easily add an amp_validation_error_sanitized filter because the the filter_sanitizer_args() method
* currently needs to obtain the list of overrides to create a parsed_cache_variant.
*/
foreach ( $_REQUEST[ self::VALIDATION_ERROR_TERM_STATUS_QUERY_VAR ] as $slug => $status ) { // WPCS: CSRF ok.
$slug = sanitize_key( $slug );
$status = intval( $status );
self::$validation_error_status_overrides[ $slug ] = $status;
ksort( self::$validation_error_status_overrides );
}
}
add_action( 'wp', array( __CLASS__, 'wrap_widget_callbacks' ) );
add_action( 'all', array( __CLASS__, 'wrap_hook_callbacks' ) );
$wrapped_filters = array( 'the_content', 'the_excerpt' );
foreach ( $wrapped_filters as $wrapped_filter ) {
add_filter( $wrapped_filter, array( __CLASS__, 'decorate_filter_source' ), PHP_INT_MAX );
}
add_filter( 'do_shortcode_tag', array( __CLASS__, 'decorate_shortcode_source' ), -1, 2 );
$do_blocks_priority = has_filter( 'the_content', 'do_blocks' );
$is_gutenberg_active = (
false !== $do_blocks_priority
&&
class_exists( 'WP_Block_Type_Registry' )
);
if ( $is_gutenberg_active ) {
add_filter( 'the_content', array( __CLASS__, 'add_block_source_comments' ), $do_blocks_priority - 1 );
}
}
/**
* Handle save_post action to queue re-validation of the post on the frontend.
*
* This is intended to only apply to post edits made in the classic editor.
*
* @see AMP_Validation_Manager::get_amp_validity_rest_field() The method responsible for validation post changes via Gutenberg.
* @see AMP_Validation_Manager::validate_queued_posts_on_frontend()
*
* @param int $post_id Post ID.
*/
public static function handle_save_post_prompting_validation( $post_id ) {
global $pagenow;
$post = get_post( $post_id );
$is_classic_editor_post_save = (
isset( $_SERVER['REQUEST_METHOD'] )
&&
'POST' === $_SERVER['REQUEST_METHOD']
&&
'post.php' === $pagenow
&&
isset( $_POST['post_ID'] ) // WPCS: csrf ok.
&&
intval( $_POST['post_ID'] ) === (int) $post_id // WPCS: csrf ok.
);
$should_validate_post = (
$is_classic_editor_post_save
&&
is_post_type_viewable( $post->post_type )
&&
! wp_is_post_autosave( $post )
&&
! wp_is_post_revision( $post )
&&
'auto-draft' !== $post->post_status
&&
! isset( self::$posts_pending_frontend_validation[ $post_id ] )
);
if ( $should_validate_post ) {
self::$posts_pending_frontend_validation[ $post_id ] = true;
// The reason for shutdown is to ensure that all postmeta changes have been saved, including whether AMP is enabled.
if ( ! has_action( 'shutdown', array( __CLASS__, 'validate_queued_posts_on_frontend' ) ) ) {
add_action( 'shutdown', array( __CLASS__, 'validate_queued_posts_on_frontend' ) );
}
}
}
/**
* Validate the posts pending frontend validation.
*
* @see AMP_Validation_Manager::handle_save_post_prompting_validation()
*
* @return array Mapping of post ID to the result of validating or storing the validation result.
*/
public static function validate_queued_posts_on_frontend() {
$posts = array_filter(
array_map( 'get_post', array_keys( array_filter( self::$posts_pending_frontend_validation ) ) ),
function( $post ) {
return $post && post_supports_amp( $post ) && 'trash' !== $post->post_status;
}
);
$validation_posts = array();
/*
* It is unlikely that there will be more than one post in the array.
* For the bulk recheck action, see AMP_Invalid_URL_Post_Type::handle_bulk_action().
*/
foreach ( $posts as $post ) {
$url = amp_get_permalink( $post->ID );
if ( ! $url ) {
$validation_posts[ $post->ID ] = new WP_Error( 'no_amp_permalink' );
continue;
}
// Prevent re-validating.
self::$posts_pending_frontend_validation[ $post->ID ] = false;
$validity = self::validate_url( $url );
if ( is_wp_error( $validity ) ) {
$validation_posts[ $post->ID ] = $validity;
} else {
$invalid_url_post_id = intval( get_post_meta( $post->ID, '_amp_invalid_url_post_id', true ) );
$validation_posts[ $post->ID ] = AMP_Invalid_URL_Post_Type::store_validation_errors(
wp_list_pluck( $validity['results'], 'error' ),
$validity['url'],
array_merge(
array(
'invalid_url_post' => $invalid_url_post_id,
),
wp_array_slice_assoc( $validity, array( 'queried_object' ) )
)
);
// Remember the amp_invalid_url post so that when the slug changes the old amp_invalid_url post can be updated.
if ( ! is_wp_error( $validation_posts[ $post->ID ] ) && $invalid_url_post_id !== $validation_posts[ $post->ID ] ) {
update_post_meta( $post->ID, '_amp_invalid_url_post_id', $validation_posts[ $post->ID ] );
}
}
}
return $validation_posts;
}
/**
* Adds fields to the REST API responses, in order to display validation errors.
*
* @return void
*/
public static function add_rest_api_fields() {
if ( amp_is_canonical() ) {
$object_types = get_post_types_by_support( 'editor' );
} else {
$object_types = array_intersect(
get_post_types_by_support( 'amp' ),
get_post_types( array(
'show_in_rest' => true,
) )
);
}
register_rest_field(
$object_types,
self::VALIDITY_REST_FIELD_NAME,
array(
'get_callback' => array( __CLASS__, 'get_amp_validity_rest_field' ),
'schema' => array(
'description' => __( 'AMP validity status', 'amp' ),
'type' => 'object',
),
)
);
}
/**
* Adds a field to the REST API responses to display the validation status.
*
* First, get existing errors for the post.
* If there are none, validate the post and return any errors.
*
* @param array $post_data Data for the post.
* @param string $field_name The name of the field to add.
* @param WP_REST_Request $request The name of the field to add.
* @return array|null $validation_data Validation data if it's available, or null.
*/
public static function get_amp_validity_rest_field( $post_data, $field_name, $request ) {
unset( $field_name );
if ( ! current_user_can( 'edit_post', $post_data['id'] ) ) {
return null;
}
$post = get_post( $post_data['id'] );
$validation_status_post = null;
if ( in_array( $request->get_method(), array( 'PUT', 'POST' ), true ) ) {
if ( ! isset( self::$posts_pending_frontend_validation[ $post->ID ] ) ) {
self::$posts_pending_frontend_validation[ $post->ID ] = true;
}
$results = self::validate_queued_posts_on_frontend();
if ( isset( $results[ $post->ID ] ) && is_int( $results[ $post->ID ] ) ) {
$validation_status_post = get_post( $results[ $post->ID ] );
}
}
if ( empty( $validation_status_post ) ) {
$validation_status_post = AMP_Invalid_URL_Post_Type::get_invalid_url_post( amp_get_permalink( $post->ID ) );
}
$field = array(
'results' => array(),
'review_link' => null,
);
if ( $validation_status_post ) {
$field['review_link'] = get_edit_post_link( $validation_status_post->ID, 'raw' );
foreach ( AMP_Invalid_URL_Post_Type::get_invalid_url_validation_errors( $validation_status_post ) as $result ) {
$field['results'][] = array(
'sanitized' => AMP_Validation_Error_Taxonomy::VALIDATION_ERROR_ACCEPTED_STATUS === $result['status'],
'error' => $result['data'],
'status' => $result['status'],
'term_status' => $result['term_status'],
'forced' => $result['forced'],
);
}
}
return $field;
}
/**
* Whether the user has the required capability.
*
* Checks for permissions before validating.
*
* @return boolean $has_cap Whether the current user has the capability.
*/
public static function has_cap() {
return current_user_can( 'edit_posts' );
}
/**
* Add validation error.
*
* @param array $error Error info, especially code.
* @param array $data Additional data, including the node.
*
* @return bool Whether the validation error should result in sanitization.
*/
public static function add_validation_error( array $error, array $data = array() ) {
$node = null;
$matches = null;
$sources = null;
if ( isset( $data['node'] ) && $data['node'] instanceof DOMNode ) {
$node = $data['node'];
}
if ( self::$should_locate_sources ) {
if ( ! empty( $error['sources'] ) ) {
$sources = $error['sources'];
} elseif ( $node ) {
$sources = self::locate_sources( $node );
}
}
unset( $error['sources'] );
if ( ! isset( $error['code'] ) ) {
$error['code'] = 'unknown';
}
/**
* Filters the validation error array.
*
* This allows plugins to add amend additional properties which can help with
* more accurately identifying a validation error beyond the name of the parent
* node and the element's attributes. The $sources are also omitted because
* these are only available during an explicit validation request and so they
* are not suitable for plugins to vary sanitization by. If looking to force a
* validation error to be ignored, use the 'amp_validation_error_sanitized'
* filter instead of attempting to return an empty value with this filter (as
* that is not supported).
*
* @since 1.0
*
* @param array $error Validation error to be printed.
* @param array $context {
* Context data for validation error sanitization.
*
* @type DOMNode $node Node for which the validation error is being reported. May be null.
* }
*/
$error = apply_filters( 'amp_validation_error', $error, compact( 'node' ) );
$sanitization = AMP_Validation_Error_Taxonomy::get_validation_error_sanitization( $error );
$sanitized = AMP_Validation_Error_Taxonomy::VALIDATION_ERROR_ACCEPTED_STATUS === $sanitization['status'];
// Ignore validation errors which are forcibly sanitized by filter or in special case if it is a tree shaking error and this is accepted by options.
if ( $sanitized && 'with_filter' === $sanitization['forced'] ) {
return true;
}
// Add sources back into the $error for referencing later. @todo It may be cleaner to store sources separately to avoid having to re-remove later during storage.
$error = array_merge( $error, compact( 'sources' ) );
self::$validation_results[] = compact( 'error', 'sanitized' );
return $sanitized;
}
/**
* Reset the stored removed nodes and attributes.
*
* After testing if the markup is valid,
* these static values will remain.
* So reset them in case another test is needed.
*
* @return void
*/
public static function reset_validation_results() {
self::$validation_results = array();
self::$enqueued_style_sources = array();
self::$enqueued_script_sources = array();
}
/**
* Checks the AMP validity of the post content.
*
* If it's not valid AMP, it displays an error message above the 'Classic' editor.
*
* This is essentially a PHP implementation of ampBlockValidation.handleValidationErrorsStateChange() in JS.
*
* @param WP_Post $post The updated post.
* @return void
*/
public static function print_edit_form_validation_status( $post ) {
if ( ! post_supports_amp( $post ) || ! self::has_cap() ) {
return;
}
// Skip if the post type is not viewable on the frontend, since we need a permalink to validate.
if ( ! is_post_type_viewable( $post->post_type ) ) {
return;
}
$invalid_url_post = AMP_Invalid_URL_Post_Type::get_invalid_url_post( get_permalink( $post->ID ) );
if ( ! $invalid_url_post ) {
return;
}
$has_actually_unaccepted_error = false;
$validation_errors = array();
foreach ( AMP_Invalid_URL_Post_Type::get_invalid_url_validation_errors( $invalid_url_post ) as $error ) {
if ( AMP_Validation_Error_Taxonomy::VALIDATION_ERROR_ACCEPTED_STATUS !== $error['term_status'] ) {
$validation_errors[] = $error['data'];
if ( AMP_Validation_Error_Taxonomy::VALIDATION_ERROR_ACCEPTED_STATUS !== $error['status'] ) {
$has_actually_unaccepted_error = true;
}
}
}
// No validation errors so abort.
if ( empty( $validation_errors ) ) {
return;
}
echo '<div class="notice notice-warning">';
echo '<p>';
esc_html_e( 'There is content which fails AMP validation.', 'amp' );
echo ' ';
if ( $has_actually_unaccepted_error && ! amp_is_canonical() ) {
esc_html_e( 'Non-accepted validation errors prevent AMP from being served, and the user will be redirected to the non-AMP version.', 'amp' );
} else {
esc_html_e( 'The invalid markup will be automatically sanitized to ensure a valid AMP response is served.', 'amp' );
}
echo sprintf(
' <a href="%s" target="_blank">%s</a>',
esc_url( get_edit_post_link( $invalid_url_post ) ),
esc_html__( 'Review issues', 'amp' )
);
echo '</p>';
$results = AMP_Validation_Error_Taxonomy::summarize_validation_errors( array_unique( $validation_errors, SORT_REGULAR ) );
$removed_sets = array();
if ( ! empty( $results[ AMP_Validation_Error_Taxonomy::REMOVED_ELEMENTS ] ) && is_array( $results[ AMP_Validation_Error_Taxonomy::REMOVED_ELEMENTS ] ) ) {
$removed_sets[] = array(
'label' => __( 'Invalid elements:', 'amp' ),
'names' => array_map( 'sanitize_key', $results[ AMP_Validation_Error_Taxonomy::REMOVED_ELEMENTS ] ),
);
}
if ( ! empty( $results[ AMP_Validation_Error_Taxonomy::REMOVED_ATTRIBUTES ] ) && is_array( $results[ AMP_Validation_Error_Taxonomy::REMOVED_ATTRIBUTES ] ) ) {
$removed_sets[] = array(
'label' => __( 'Invalid attributes:', 'amp' ),
'names' => array_map( 'sanitize_key', $results[ AMP_Validation_Error_Taxonomy::REMOVED_ATTRIBUTES ] ),
);
}
// @todo There are other kinds of errors other than REMOVED_ELEMENTS and REMOVED_ATTRIBUTES.
foreach ( $removed_sets as $removed_set ) {
printf( '<p>%s ', esc_html( $removed_set['label'] ) );
$items = array();
foreach ( $removed_set['names'] as $name => $count ) {
if ( 1 === intval( $count ) ) {
$items[] = sprintf( '<code>%s</code>', esc_html( $name ) );
} else {
$items[] = sprintf( '<code>%s</code> (%d)', esc_html( $name ), $count );
}
}
echo implode( ', ', $items ); // WPCS: XSS OK.
echo '</p>';
}
echo '</div>';
}
/**
* Get source start comment.
*
* @param array $source Source data.
* @param bool $is_start Whether the comment is the start or end.
* @return string HTML Comment.
*/
public static function get_source_comment( array $source, $is_start = true ) {
unset( $source['reflection'] );
return sprintf(
'<!--%samp-source-stack %s-->',
$is_start ? '' : '/',
str_replace( '--', '', wp_json_encode( $source ) )
);
}
/**
* Parse source comment.
*
* @param DOMComment $comment Comment.
* @return array|null Parsed source or null if not a source comment.
*/
public static function parse_source_comment( DOMComment $comment ) {
if ( ! preg_match( '#^\s*(?P<closing>/)?amp-source-stack\s+(?P<args>{.+})\s*$#s', $comment->nodeValue, $matches ) ) {
return null;
}
$source = json_decode( $matches['args'], true );
$closing = ! empty( $matches['closing'] );
return compact( 'source', 'closing' );
}
/**
* Walk back tree to find the open sources.
*
* @todo This method and others for sourcing could be moved to a separate class.
*
* @param DOMNode $node Node to look for.
* @return array[][] {
* The data of the removed sources (theme, plugin, or mu-plugin).
*
* @type string $name The name of the source.
* @type string $type The type of the source.
* }
*/
public static function locate_sources( DOMNode $node ) {
$xpath = new DOMXPath( $node->ownerDocument );
$comments = $xpath->query( 'preceding::comment()[ starts-with( ., "amp-source-stack" ) or starts-with( ., "/amp-source-stack" ) ]', $node );
$sources = array();
$matches = array();
foreach ( $comments as $comment ) {
$parsed_comment = self::parse_source_comment( $comment );
if ( ! $parsed_comment ) {
continue;
}
if ( $parsed_comment['closing'] ) {
array_pop( $sources );
} else {
$sources[] = $parsed_comment['source'];
}
}
$is_enqueued_link = (
$node instanceof DOMElement
&&
'link' === $node->nodeName
&&
preg_match( '/(?P<handle>.+)-css$/', (string) $node->getAttribute( 'id' ), $matches )
&&
isset( self::$enqueued_style_sources[ $matches['handle'] ] )
);
if ( $is_enqueued_link ) {
$sources = array_merge(
self::$enqueued_style_sources[ $matches['handle'] ],
$sources
);
}
/**
* Script dependency.
*
* @var _WP_Dependency $script_dependency
*/
if ( $node instanceof DOMElement && 'script' === $node->nodeName ) {
$enqueued_script_handles = array_intersect( wp_scripts()->done, array_keys( self::$enqueued_script_sources ) );
if ( $node->hasAttribute( 'src' ) ) {
// External script.
$src = $node->getAttribute( 'src' );
foreach ( $enqueued_script_handles as $enqueued_script_handle ) {
$script_dependency = wp_scripts()->registered[ $enqueued_script_handle ];
$is_matching_script = (
$script_dependency
&&
$script_dependency->src
&&
// Script attribute is haystack because includes protocol and may include query args (like ver).
false !== strpos( $src, preg_replace( '#^https?:(?=//)#', '', $script_dependency->src ) )
);
if ( $is_matching_script ) {
$sources = array_merge(
self::$enqueued_script_sources[ $enqueued_script_handle ],
$sources
);
break;
}
}
} elseif ( $node->firstChild ) {
// Inline script.
$text = $node->textContent;
foreach ( $enqueued_script_handles as $enqueued_script_handle ) {
$inline_scripts = array_filter( array_merge(
(array) wp_scripts()->get_data( $enqueued_script_handle, 'data' ),
(array) wp_scripts()->get_data( $enqueued_script_handle, 'before' ),
(array) wp_scripts()->get_data( $enqueued_script_handle, 'after' )
) );
foreach ( $inline_scripts as $inline_script ) {
/*
* Check to see if the inline script is inside (or the same) as the script in the document.
* Note that WordPress takes the registered inline script and will output it with newlines
* padding it, and sometimes with the script wrapped by CDATA blocks.
*/
if ( false !== strpos( $text, trim( $inline_script ) ) ) {
$sources = array_merge(
self::$enqueued_script_sources[ $enqueued_script_handle ],
$sources
);
break;
}
}
}
}