forked from WordPress/wordpress-develop
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcapabilities.php
More file actions
2211 lines (1810 loc) · 75.2 KB
/
capabilities.php
File metadata and controls
2211 lines (1810 loc) · 75.2 KB
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
// Test roles and capabilities via the WP_User class
/**
* @group user
* @group capabilities
*/
class Tests_User_Capabilities extends WP_UnitTestCase {
protected static $users = array(
'administrator' => null,
'editor' => null,
'author' => null,
'contributor' => null,
'subscriber' => null,
);
protected static $super_admin = null;
protected static $block_id;
public static function wpSetUpBeforeClass( $factory ) {
self::$users = array(
'administrator' => $factory->user->create_and_get( array( 'role' => 'administrator' ) ),
'editor' => $factory->user->create_and_get( array( 'role' => 'editor' ) ),
'author' => $factory->user->create_and_get( array( 'role' => 'author' ) ),
'contributor' => $factory->user->create_and_get( array( 'role' => 'contributor' ) ),
'subscriber' => $factory->user->create_and_get( array( 'role' => 'subscriber' ) ),
);
self::$super_admin = $factory->user->create_and_get( array( 'role' => 'contributor' ) );
grant_super_admin( self::$super_admin->ID );
self::$block_id = $factory->post->create(
array(
'post_author' => self::$users['administrator']->ID,
'post_type' => 'wp_block',
'post_status' => 'publish',
'post_title' => 'Test Block',
'post_content' => '<!-- wp:core/paragraph --><p>Hello world!</p><!-- /wp:core/paragraph -->',
)
);
}
function setUp() {
parent::setUp();
// keep track of users we create
$this->_flush_roles();
}
public static function wpTearDownAfterClass() {
wp_delete_post( self::$block_id, true );
}
function _flush_roles() {
// we want to make sure we're testing against the db, not just in-memory data
// this will flush everything and reload it from the db
unset( $GLOBALS['wp_user_roles'] );
global $wp_roles;
$wp_roles = new WP_Roles();
}
function _meta_yes_you_can( $can, $key, $post_id, $user_id, $cap, $caps ) {
return true;
}
function _meta_no_you_cant( $can, $key, $post_id, $user_id, $cap, $caps ) {
return false;
}
function _meta_filter( $meta_value, $meta_key, $meta_type ) {
return $meta_value;
}
final private function _getSingleSitePrimitiveCaps() {
return array(
'unfiltered_html' => array( 'administrator', 'editor' ),
'activate_plugins' => array( 'administrator' ),
'create_users' => array( 'administrator' ),
'delete_plugins' => array( 'administrator' ),
'delete_themes' => array( 'administrator' ),
'delete_users' => array( 'administrator' ),
'edit_files' => array( 'administrator' ),
'edit_plugins' => array( 'administrator' ),
'edit_themes' => array( 'administrator' ),
'edit_users' => array( 'administrator' ),
'install_plugins' => array( 'administrator' ),
'install_themes' => array( 'administrator' ),
'update_core' => array( 'administrator' ),
'update_plugins' => array( 'administrator' ),
'update_themes' => array( 'administrator' ),
'edit_theme_options' => array( 'administrator' ),
'export' => array( 'administrator' ),
'import' => array( 'administrator' ),
'list_users' => array( 'administrator' ),
'manage_options' => array( 'administrator' ),
'promote_users' => array( 'administrator' ),
'remove_users' => array( 'administrator' ),
'switch_themes' => array( 'administrator' ),
'edit_dashboard' => array( 'administrator' ),
'resume_plugins' => array( 'administrator' ),
'resume_themes' => array( 'administrator' ),
'view_site_health_checks' => array( 'administrator' ),
'moderate_comments' => array( 'administrator', 'editor' ),
'manage_categories' => array( 'administrator', 'editor' ),
'edit_others_posts' => array( 'administrator', 'editor' ),
'edit_pages' => array( 'administrator', 'editor' ),
'edit_others_pages' => array( 'administrator', 'editor' ),
'edit_published_pages' => array( 'administrator', 'editor' ),
'publish_pages' => array( 'administrator', 'editor' ),
'delete_pages' => array( 'administrator', 'editor' ),
'delete_others_pages' => array( 'administrator', 'editor' ),
'delete_published_pages' => array( 'administrator', 'editor' ),
'delete_others_posts' => array( 'administrator', 'editor' ),
'delete_private_posts' => array( 'administrator', 'editor' ),
'edit_private_posts' => array( 'administrator', 'editor' ),
'read_private_posts' => array( 'administrator', 'editor' ),
'delete_private_pages' => array( 'administrator', 'editor' ),
'edit_private_pages' => array( 'administrator', 'editor' ),
'read_private_pages' => array( 'administrator', 'editor' ),
'edit_published_posts' => array( 'administrator', 'editor', 'author' ),
'upload_files' => array( 'administrator', 'editor', 'author' ),
'publish_posts' => array( 'administrator', 'editor', 'author' ),
'delete_published_posts' => array( 'administrator', 'editor', 'author' ),
'edit_posts' => array( 'administrator', 'editor', 'author', 'contributor' ),
'delete_posts' => array( 'administrator', 'editor', 'author', 'contributor' ),
'read' => array( 'administrator', 'editor', 'author', 'contributor', 'subscriber' ),
'level_10' => array( 'administrator' ),
'level_9' => array( 'administrator' ),
'level_8' => array( 'administrator' ),
'level_7' => array( 'administrator', 'editor' ),
'level_6' => array( 'administrator', 'editor' ),
'level_5' => array( 'administrator', 'editor' ),
'level_4' => array( 'administrator', 'editor' ),
'level_3' => array( 'administrator', 'editor' ),
'level_2' => array( 'administrator', 'editor', 'author' ),
'level_1' => array( 'administrator', 'editor', 'author', 'contributor' ),
'level_0' => array( 'administrator', 'editor', 'author', 'contributor', 'subscriber' ),
'administrator' => array( 'administrator' ),
'editor' => array( 'editor' ),
'author' => array( 'author' ),
'contributor' => array( 'contributor' ),
'subscriber' => array( 'subscriber' ),
);
}
final private function _getMultiSitePrimitiveCaps() {
return array(
'unfiltered_html' => array(),
'activate_plugins' => array(),
'create_users' => array(),
'delete_plugins' => array(),
'delete_themes' => array(),
'delete_users' => array(),
'edit_files' => array(),
'edit_plugins' => array(),
'edit_themes' => array(),
'edit_users' => array(),
'install_plugins' => array(),
'install_themes' => array(),
'update_core' => array(),
'update_plugins' => array(),
'update_themes' => array(),
'view_site_health_checks' => array(),
'edit_theme_options' => array( 'administrator' ),
'export' => array( 'administrator' ),
'import' => array( 'administrator' ),
'list_users' => array( 'administrator' ),
'manage_options' => array( 'administrator' ),
'promote_users' => array( 'administrator' ),
'remove_users' => array( 'administrator' ),
'switch_themes' => array( 'administrator' ),
'edit_dashboard' => array( 'administrator' ),
'resume_plugins' => array( 'administrator' ),
'resume_themes' => array( 'administrator' ),
'moderate_comments' => array( 'administrator', 'editor' ),
'manage_categories' => array( 'administrator', 'editor' ),
'edit_others_posts' => array( 'administrator', 'editor' ),
'edit_pages' => array( 'administrator', 'editor' ),
'edit_others_pages' => array( 'administrator', 'editor' ),
'edit_published_pages' => array( 'administrator', 'editor' ),
'publish_pages' => array( 'administrator', 'editor' ),
'delete_pages' => array( 'administrator', 'editor' ),
'delete_others_pages' => array( 'administrator', 'editor' ),
'delete_published_pages' => array( 'administrator', 'editor' ),
'delete_others_posts' => array( 'administrator', 'editor' ),
'delete_private_posts' => array( 'administrator', 'editor' ),
'edit_private_posts' => array( 'administrator', 'editor' ),
'read_private_posts' => array( 'administrator', 'editor' ),
'delete_private_pages' => array( 'administrator', 'editor' ),
'edit_private_pages' => array( 'administrator', 'editor' ),
'read_private_pages' => array( 'administrator', 'editor' ),
'edit_published_posts' => array( 'administrator', 'editor', 'author' ),
'upload_files' => array( 'administrator', 'editor', 'author' ),
'publish_posts' => array( 'administrator', 'editor', 'author' ),
'delete_published_posts' => array( 'administrator', 'editor', 'author' ),
'edit_posts' => array( 'administrator', 'editor', 'author', 'contributor' ),
'delete_posts' => array( 'administrator', 'editor', 'author', 'contributor' ),
'read' => array( 'administrator', 'editor', 'author', 'contributor', 'subscriber' ),
'level_10' => array( 'administrator' ),
'level_9' => array( 'administrator' ),
'level_8' => array( 'administrator' ),
'level_7' => array( 'administrator', 'editor' ),
'level_6' => array( 'administrator', 'editor' ),
'level_5' => array( 'administrator', 'editor' ),
'level_4' => array( 'administrator', 'editor' ),
'level_3' => array( 'administrator', 'editor' ),
'level_2' => array( 'administrator', 'editor', 'author' ),
'level_1' => array( 'administrator', 'editor', 'author', 'contributor' ),
'level_0' => array( 'administrator', 'editor', 'author', 'contributor', 'subscriber' ),
'administrator' => array( 'administrator' ),
'editor' => array( 'editor' ),
'author' => array( 'author' ),
'contributor' => array( 'contributor' ),
'subscriber' => array( 'subscriber' ),
);
}
final private function _getSingleSiteMetaCaps() {
return array(
'create_sites' => array(),
'delete_sites' => array(),
'manage_network' => array(),
'manage_sites' => array(),
'manage_network_users' => array(),
'manage_network_plugins' => array(),
'manage_network_themes' => array(),
'manage_network_options' => array(),
'delete_site' => array(),
'upgrade_network' => array(),
'setup_network' => array( 'administrator' ),
'upload_plugins' => array( 'administrator' ),
'upload_themes' => array( 'administrator' ),
'customize' => array( 'administrator' ),
'add_users' => array( 'administrator' ),
'install_languages' => array( 'administrator' ),
'update_languages' => array( 'administrator' ),
'deactivate_plugins' => array( 'administrator' ),
'update_php' => array( 'administrator' ),
'export_others_personal_data' => array( 'administrator' ),
'erase_others_personal_data' => array( 'administrator' ),
'manage_privacy_options' => array( 'administrator' ),
'edit_categories' => array( 'administrator', 'editor' ),
'delete_categories' => array( 'administrator', 'editor' ),
'manage_post_tags' => array( 'administrator', 'editor' ),
'edit_post_tags' => array( 'administrator', 'editor' ),
'delete_post_tags' => array( 'administrator', 'editor' ),
'edit_css' => array( 'administrator', 'editor' ),
'assign_categories' => array( 'administrator', 'editor', 'author', 'contributor' ),
'assign_post_tags' => array( 'administrator', 'editor', 'author', 'contributor' ),
);
}
final private function _getMultiSiteMetaCaps() {
return array(
'create_sites' => array(),
'delete_sites' => array(),
'manage_network' => array(),
'manage_sites' => array(),
'manage_network_users' => array(),
'manage_network_plugins' => array(),
'manage_network_themes' => array(),
'manage_network_options' => array(),
'setup_network' => array(),
'upload_plugins' => array(),
'upload_themes' => array(),
'edit_css' => array(),
'upgrade_network' => array(),
'install_languages' => array(),
'update_languages' => array(),
'deactivate_plugins' => array(),
'update_php' => array(),
'export_others_personal_data' => array( '' ),
'erase_others_personal_data' => array( '' ),
'manage_privacy_options' => array(),
'customize' => array( 'administrator' ),
'delete_site' => array( 'administrator' ),
'add_users' => array( 'administrator' ),
'edit_categories' => array( 'administrator', 'editor' ),
'delete_categories' => array( 'administrator', 'editor' ),
'manage_post_tags' => array( 'administrator', 'editor' ),
'edit_post_tags' => array( 'administrator', 'editor' ),
'delete_post_tags' => array( 'administrator', 'editor' ),
'assign_categories' => array( 'administrator', 'editor', 'author', 'contributor' ),
'assign_post_tags' => array( 'administrator', 'editor', 'author', 'contributor' ),
);
}
protected function getAllCapsAndRoles() {
return $this->getPrimitiveCapsAndRoles() + $this->getMetaCapsAndRoles();
}
protected function getPrimitiveCapsAndRoles() {
if ( is_multisite() ) {
return $this->_getMultiSitePrimitiveCaps();
} else {
return $this->_getSingleSitePrimitiveCaps();
}
}
protected function getMetaCapsAndRoles() {
if ( is_multisite() ) {
return $this->_getMultiSiteMetaCaps();
} else {
return $this->_getSingleSiteMetaCaps();
}
}
// test the tests
function test_single_and_multisite_cap_tests_match() {
$single_primitive = array_keys( $this->_getSingleSitePrimitiveCaps() );
$multi_primitive = array_keys( $this->_getMultiSitePrimitiveCaps() );
sort( $single_primitive );
sort( $multi_primitive );
$this->assertEquals( $single_primitive, $multi_primitive );
$single_meta = array_keys( $this->_getSingleSiteMetaCaps() );
$multi_meta = array_keys( $this->_getMultiSiteMetaCaps() );
sort( $single_meta );
sort( $multi_meta );
$this->assertEquals( $single_meta, $multi_meta );
}
// test the tests
function test_all_caps_of_users_are_being_tested() {
$caps = $this->getPrimitiveCapsAndRoles();
// `manage_links` is a special case
$this->assertSame( '0', get_option( 'link_manager_enabled' ) );
// `unfiltered_upload` is a special case
$this->assertFalse( defined( 'ALLOW_UNFILTERED_UPLOADS' ) );
foreach ( self::$users as $role => $user ) {
// make sure the user is valid
$this->assertTrue( $user->exists(), "User with {$role} role does not exist" );
$user_caps = $user->allcaps;
unset(
// `manage_links` is a special case
$user_caps['manage_links'],
// `unfiltered_upload` is a special case
$user_caps['unfiltered_upload']
);
$diff = array_diff( array_keys( $user_caps ), array_keys( $caps ) );
$this->assertEquals( array(), $diff, "User with {$role} role has capabilities that aren't being tested" );
}
}
/**
* Test the tests. The administrator role has all primitive capabilities, therefore the
* primitive capabilitity tests can be tested by checking that the list of tested
* capabilities matches those of the administrator role.
*
* @group capTestTests
*/
public function testPrimitiveCapsTestsAreCorrect() {
$actual = $this->getPrimitiveCapsAndRoles();
$admin = get_role( 'administrator' );
$expected = $admin->capabilities;
unset(
// Role names as capabilities are a special case:
$actual['administrator'],
$actual['editor'],
$actual['author'],
$actual['subscriber'],
$actual['contributor'],
// The following are granted via `user_has_cap`:
$actual['resume_plugins'],
$actual['resume_themes'],
$actual['view_site_health_checks']
);
unset(
// `manage_links` is a special case in the caps tests:
$expected['manage_links'],
// `unfiltered_upload` is a special case in the caps tests:
$expected['unfiltered_upload']
);
$expected = array_keys( $expected );
$actual = array_keys( $actual );
$missing_primitive_cap_checks = array_diff( $expected, $actual );
$this->assertSame( array(), $missing_primitive_cap_checks, 'These primitive capabilities are not tested' );
$incorrect_primitive_cap_checks = array_diff( $actual, $expected );
$this->assertSame( array(), $incorrect_primitive_cap_checks, 'These capabilities are not primitive' );
}
/**
* Test the tests. All meta capabilities should have a condition in the `map_meta_cap()`
* function that handles the capability.
*
* @group capTestTests
*/
public function testMetaCapsTestsAreCorrect() {
$actual = $this->getMetaCapsAndRoles();
$file = file_get_contents( ABSPATH . WPINC . '/capabilities.php' );
$matched = preg_match( '/^function map_meta_cap\((.*?)^\}/ms', $file, $function );
$this->assertSame( 1, $matched );
$this->assertNotEmpty( $function );
$matched = preg_match_all( '/^[\t]{1,2}case \'([^\']+)/m', $function[0], $cases );
$this->assertNotEmpty( $matched );
$this->assertNotEmpty( $cases );
$expected = array_flip( $cases[1] );
unset(
// These primitive capabilities have a 'case' in `map_meta_cap()` but aren't meta capabilities:
$expected['unfiltered_upload'],
$expected['unfiltered_html'],
$expected['edit_files'],
$expected['edit_plugins'],
$expected['edit_themes'],
$expected['update_plugins'],
$expected['delete_plugins'],
$expected['install_plugins'],
$expected['update_themes'],
$expected['delete_themes'],
$expected['install_themes'],
$expected['update_core'],
$expected['activate_plugins'],
$expected['edit_users'],
$expected['delete_users'],
$expected['create_users'],
$expected['manage_links'],
// Singular object meta capabilities (where an object ID is passed) are not tested:
$expected['activate_plugin'],
$expected['deactivate_plugin'],
$expected['resume_plugin'],
$expected['resume_theme'],
$expected['remove_user'],
$expected['promote_user'],
$expected['edit_user'],
$expected['delete_post'],
$expected['delete_page'],
$expected['edit_post'],
$expected['edit_page'],
$expected['read_post'],
$expected['read_page'],
$expected['publish_post'],
$expected['edit_post_meta'],
$expected['delete_post_meta'],
$expected['add_post_meta'],
$expected['edit_comment'],
$expected['edit_comment_meta'],
$expected['delete_comment_meta'],
$expected['add_comment_meta'],
$expected['edit_term'],
$expected['delete_term'],
$expected['assign_term'],
$expected['edit_term_meta'],
$expected['delete_term_meta'],
$expected['add_term_meta'],
$expected['delete_user'],
$expected['edit_user_meta'],
$expected['delete_user_meta'],
$expected['add_user_meta']
);
$expected = array_keys( $expected );
$actual = array_keys( $actual );
$missing_meta_cap_checks = array_diff( $expected, $actual );
$this->assertSame( array(), $missing_meta_cap_checks, 'These meta capabilities are not tested' );
$incorrect_meta_cap_checks = array_diff( $actual, $expected );
$this->assertSame( array(), $incorrect_meta_cap_checks, 'These capabilities are not meta' );
}
// test the default roles and caps
function test_all_roles_and_caps() {
$caps = $this->getAllCapsAndRoles();
foreach ( self::$users as $role => $user ) {
// make sure the user is valid
$this->assertTrue( $user->exists(), "User with {$role} role does not exist" );
// make sure the role name is correct
$this->assertEquals( array( $role ), $user->roles, "User should only have the {$role} role" );
foreach ( $caps as $cap => $roles ) {
if ( in_array( $role, $roles, true ) ) {
$this->assertTrue( $user->has_cap( $cap ), "User with the {$role} role should have the {$cap} capability" );
$this->assertTrue( user_can( $user, $cap ), "User with the {$role} role should have the {$cap} capability" );
} else {
$this->assertFalse( $user->has_cap( $cap ), "User with the {$role} role should not have the {$cap} capability" );
$this->assertFalse( user_can( $user, $cap ), "User with the {$role} role should not have the {$cap} capability" );
}
}
}
$this->assertFalse( $user->has_cap( 'start_a_fire' ), "User with the {$role} role should not have a custom capability" );
$this->assertFalse( user_can( $user, 'start_a_fire' ), "User with the {$role} role should not have a custom capability" );
$this->assertFalse( $user->has_cap( 'do_not_allow' ), "User with the {$role} role should not have the do_not_allow capability" );
$this->assertFalse( user_can( $user, 'do_not_allow' ), "User with the {$role} role should not have the do_not_allow capability" );
$this->assertTrue( $user->has_cap( 'exist' ), "User with the {$role} role should have the exist capability" );
$this->assertTrue( user_can( $user, 'exist' ), "User with the {$role} role should have the exist capability" );
}
/**
* @ticket 41059
*/
public function test_do_not_allow_is_denied_for_all_roles() {
foreach ( self::$users as $role => $user ) {
# Test adding the cap directly to the user
$user->add_cap( 'do_not_allow' );
$has_cap = $user->has_cap( 'do_not_allow' );
$user->remove_cap( 'do_not_allow' );
$this->assertFalse( $has_cap, "User with the {$role} role should not have the do_not_allow capability" );
# Test adding the cap to the user's role
$role_obj = get_role( $role );
$role_obj->add_cap( 'do_not_allow' );
$has_cap = $user->has_cap( 'do_not_allow' );
$role_obj->remove_cap( 'do_not_allow' );
$this->assertFalse( $has_cap, "User with the {$role} role should not have the do_not_allow capability" );
# Test adding the cap via a filter
add_filter( 'user_has_cap', array( $this, 'grant_do_not_allow' ), 10, 4 );
$has_cap = $user->has_cap( 'do_not_allow' );
remove_filter( 'user_has_cap', array( $this, 'grant_do_not_allow' ), 10, 4 );
$this->assertFalse( $has_cap, "User with the {$role} role should not have the do_not_allow capability" );
}
}
/**
* @group ms-required
* @ticket 41059
*/
public function test_do_not_allow_is_denied_for_super_admins() {
# Test adding the cap directly to the user
self::$super_admin->add_cap( 'do_not_allow' );
$has_cap = self::$super_admin->has_cap( 'do_not_allow' );
self::$super_admin->remove_cap( 'do_not_allow' );
$this->assertFalse( $has_cap, 'Super admins should not have the do_not_allow capability' );
# Test adding the cap via a filter
add_filter( 'user_has_cap', array( $this, 'grant_do_not_allow' ), 10, 4 );
$has_cap = self::$super_admin->has_cap( 'do_not_allow' );
remove_filter( 'user_has_cap', array( $this, 'grant_do_not_allow' ), 10, 4 );
$this->assertFalse( $has_cap, 'Super admins should not have the do_not_allow capability' );
}
public function grant_do_not_allow( $allcaps, $caps, $args, $user ) {
$allcaps['do_not_allow'] = true;
return $allcaps;
}
// special case for the link manager
function test_link_manager_caps() {
$caps = array(
'manage_links' => array( 'administrator', 'editor' ),
);
$this->assertSame( '0', get_option( 'link_manager_enabled' ) );
// no-one should have access to the link manager by default
foreach ( self::$users as $role => $user ) {
foreach ( $caps as $cap => $roles ) {
$this->assertFalse( $user->has_cap( $cap ), "User with the {$role} role should not have the {$cap} capability" );
$this->assertFalse( user_can( $user, $cap ), "User with the {$role} role should not have the {$cap} capability" );
}
}
update_option( 'link_manager_enabled', '1' );
$this->assertSame( '1', get_option( 'link_manager_enabled' ) );
foreach ( self::$users as $role => $user ) {
foreach ( $caps as $cap => $roles ) {
if ( in_array( $role, $roles, true ) ) {
$this->assertTrue( $user->has_cap( $cap ), "User with the {$role} role should have the {$cap} capability" );
$this->assertTrue( user_can( $user, $cap ), "User with the {$role} role should have the {$cap} capability" );
} else {
$this->assertFalse( $user->has_cap( $cap ), "User with the {$role} role should not have the {$cap} capability" );
$this->assertFalse( user_can( $user, $cap ), "User with the {$role} role should not have the {$cap} capability" );
}
}
}
update_option( 'link_manager_enabled', '0' );
$this->assertSame( '0', get_option( 'link_manager_enabled' ) );
}
// special case for unfiltered uploads
function test_unfiltered_upload_caps() {
$this->assertFalse( defined( 'ALLOW_UNFILTERED_UPLOADS' ) );
// no-one should have this cap
foreach ( self::$users as $role => $user ) {
$this->assertFalse( $user->has_cap( 'unfiltered_upload' ), "User with the {$role} role should not have the unfiltered_upload capability" );
$this->assertFalse( user_can( $user, 'unfiltered_upload' ), "User with the {$role} role should not have the unfiltered_upload capability" );
}
}
/**
* @dataProvider data_user_with_role_can_edit_own_post
*
* @param string $role User role name
* @param bool $can_edit_own_post Can users with this role edit their own posts?
*/
public function test_user_can_edit_comment_on_own_post( $role, $can_edit_own_post ) {
$owner = self::$users[ $role ];
$post = self::factory()->post->create_and_get(
array(
'post_author' => $owner->ID,
)
);
$comment = self::factory()->comment->create_and_get(
array(
'comment_post_ID' => $post->ID,
)
);
$owner_can_edit = user_can( $owner->ID, 'edit_comment', $comment->comment_ID );
$this->assertSame( $can_edit_own_post, $owner_can_edit );
}
/**
* @dataProvider data_user_with_role_can_edit_others_posts
*
* @param string $role User role name
* @param bool $can_edit_others_post Can users with this role edit others' posts?
*/
public function test_user_can_edit_comment_on_others_post( $role, $can_edit_others_post ) {
$user = self::$users[ $role ];
$owner = self::factory()->user->create_and_get(
array(
'role' => 'editor',
)
);
$post = self::factory()->post->create_and_get(
array(
'post_author' => $owner->ID,
)
);
$comment = self::factory()->comment->create_and_get(
array(
'comment_post_ID' => $post->ID,
)
);
$user_can_edit = user_can( $user->ID, 'edit_comment', $comment->comment_ID );
$this->assertSame( $can_edit_others_post, $user_can_edit );
}
public function data_user_with_role_can_edit_own_post() {
$data = array();
$caps = $this->getPrimitiveCapsAndRoles();
foreach ( self::$users as $role => $null ) {
$data[] = array(
$role,
in_array( $role, $caps['edit_published_posts'], true ),
);
}
return $data;
}
public function data_user_with_role_can_edit_others_posts() {
$data = array();
$caps = $this->getPrimitiveCapsAndRoles();
foreach ( self::$users as $role => $null ) {
$data[] = array(
$role,
in_array( $role, $caps['edit_others_posts'], true ),
);
}
return $data;
}
/**
* @group ms-required
*/
function test_super_admin_caps() {
$caps = $this->getAllCapsAndRoles();
$user = self::$super_admin;
$this->assertTrue( is_super_admin( $user->ID ) );
foreach ( $caps as $cap => $roles ) {
$this->assertTrue( $user->has_cap( $cap ), "Super Admins should have the {$cap} capability" );
$this->assertTrue( user_can( $user, $cap ), "Super Admins should have the {$cap} capability" );
}
$this->assertTrue( $user->has_cap( 'start_a_fire' ), 'Super admins should have all custom capabilities' );
$this->assertTrue( user_can( $user, 'start_a_fire' ), 'Super admins should have all custom capabilities' );
$this->assertFalse( $user->has_cap( 'do_not_allow' ), 'Super Admins should not have the do_not_allow capability' );
$this->assertFalse( user_can( $user, 'do_not_allow' ), 'Super Admins should not have the do_not_allow capability' );
$this->assertFalse( defined( 'ALLOW_UNFILTERED_UPLOADS' ) );
$this->assertFalse( $user->has_cap( 'unfiltered_upload' ), 'Super Admins should not have the unfiltered_upload capability' );
$this->assertFalse( user_can( $user, 'unfiltered_upload' ), 'Super Admins should not have the unfiltered_upload capability' );
}
// a role that doesn't exist
function test_bogus_role() {
$user = self::factory()->user->create_and_get( array( 'role' => 'invalid_role' ) );
// make sure the user is valid
$this->assertTrue( $user->exists(), 'User does not exist' );
// make sure the role name is correct
$this->assertEquals( array(), $user->roles, 'User should not have any roles' );
$caps = $this->getAllCapsAndRoles();
foreach ( $caps as $cap => $roles ) {
$this->assertFalse( $user->has_cap( $cap ), "User with an invalid role should not have the {$cap} capability" );
$this->assertFalse( user_can( $user, $cap ), "User with an invalid role should not have the {$cap} capability" );
}
}
// a user with multiple roles
function test_user_subscriber_contributor() {
$user = self::$users['subscriber'];
// make sure the user is valid
$this->assertTrue( $user->exists(), 'User does not exist' );
$user->add_role( 'contributor' );
// user should have two roles now
$this->assertEquals( array( 'subscriber', 'contributor' ), $user->roles );
$caps = $this->getAllCapsAndRoles();
foreach ( $caps as $cap => $roles ) {
if ( array_intersect( $user->roles, $roles ) ) {
$this->assertTrue( $user->has_cap( $cap ), "User should have the {$cap} capability" );
$this->assertTrue( user_can( $user, $cap ), "User should have the {$cap} capability" );
} else {
$this->assertFalse( $user->has_cap( $cap ), "User should not have the {$cap} capability" );
$this->assertFalse( user_can( $user, $cap ), "User should not have the {$cap} capability" );
}
}
$user->remove_role( 'contributor' );
// user should have one role now
$this->assertEquals( array( 'subscriber' ), $user->roles );
}
// newly added empty role
function test_add_empty_role() {
global $wp_roles;
$role_name = 'janitor';
add_role( $role_name, 'Janitor', array() );
$this->_flush_roles();
$this->assertTrue( $wp_roles->is_role( $role_name ) );
$user = self::factory()->user->create_and_get( array( 'role' => $role_name ) );
// make sure the user is valid
$this->assertTrue( $user->exists(), 'User does not exist' );
// make sure the role name is correct
$this->assertEquals( array( $role_name ), $user->roles );
$caps = $this->getAllCapsAndRoles();
foreach ( $caps as $cap => $roles ) {
$this->assertFalse( $user->has_cap( $cap ), "User should not have the {$cap} capability" );
$this->assertFalse( user_can( $user, $cap ), "User should not have the {$cap} capability" );
}
// clean up
remove_role( $role_name );
$this->_flush_roles();
$this->assertFalse( $wp_roles->is_role( $role_name ) );
}
// newly added role
function test_add_role() {
global $wp_roles;
$role_name = 'janitor';
$expected_caps = array(
'edit_posts' => true,
'edit_pages' => true,
'level_0' => true,
'level_1' => true,
'level_2' => true,
);
add_role( $role_name, 'Janitor', $expected_caps );
$this->_flush_roles();
$this->assertTrue( $wp_roles->is_role( $role_name ) );
$user = self::factory()->user->create_and_get( array( 'role' => $role_name ) );
// make sure the user is valid
$this->assertTrue( $user->exists(), 'User does not exist' );
// make sure the role name is correct
$this->assertEquals( array( $role_name ), $user->roles );
$caps = $this->getPrimitiveCapsAndRoles();
foreach ( $caps as $cap => $roles ) {
// the user should have all the above caps
if ( isset( $expected_caps[ $cap ] ) ) {
$this->assertTrue( $user->has_cap( $cap ), "User should have the {$cap} capability" );
$this->assertTrue( user_can( $user, $cap ), "User should have the {$cap} capability" );
} else {
$this->assertFalse( $user->has_cap( $cap ), "User should not have the {$cap} capability" );
$this->assertFalse( user_can( $user, $cap ), "User should not have the {$cap} capability" );
}
}
// clean up
remove_role( $role_name );
$this->_flush_roles();
$this->assertFalse( $wp_roles->is_role( $role_name ) );
}
function test_role_add_cap() {
// change the capabilites associated with a role and make sure the change is reflected in has_cap()
global $wp_roles;
$role_name = 'janitor';
add_role( $role_name, 'Janitor', array( 'level_1' => true ) );
$this->_flush_roles();
$this->assertTrue( $wp_roles->is_role( $role_name ) );
// assign a user to that role
$id = self::factory()->user->create( array( 'role' => $role_name ) );
// now add a cap to the role
$wp_roles->add_cap( $role_name, 'sweep_floor' );
$this->_flush_roles();
$user = new WP_User( $id );
$this->assertTrue( $user->exists(), "Problem getting user $id" );
$this->assertEquals( array( $role_name ), $user->roles );
// the user should have all the above caps
$this->assertTrue( $user->has_cap( $role_name ) );
$this->assertTrue( $user->has_cap( 'level_1' ) );
$this->assertTrue( $user->has_cap( 'sweep_floor' ) );
// shouldn't have any other caps
$caps = $this->getAllCapsAndRoles();
foreach ( $caps as $cap => $roles ) {
if ( 'level_1' !== $cap ) {
$this->assertFalse( $user->has_cap( $cap ), "User should not have the {$cap} capability" );
}
}
// clean up
remove_role( $role_name );
$this->_flush_roles();
$this->assertFalse( $wp_roles->is_role( $role_name ) );
}
function test_role_remove_cap() {
// change the capabilites associated with a role and make sure the change is reflected in has_cap()
global $wp_roles;
$role_name = 'janitor';
add_role(
$role_name,
'Janitor',
array(
'level_1' => true,
'sweep_floor' => true,
'polish_doorknobs' => true,
)
);
$this->_flush_roles();
$this->assertTrue( $wp_roles->is_role( $role_name ) );
// assign a user to that role
$id = self::factory()->user->create( array( 'role' => $role_name ) );
// now remove a cap from the role
$wp_roles->remove_cap( $role_name, 'polish_doorknobs' );
$this->_flush_roles();
$user = new WP_User( $id );
$this->assertTrue( $user->exists(), "Problem getting user $id" );
$this->assertEquals( array( $role_name ), $user->roles );
// the user should have all the above caps
$this->assertTrue( $user->has_cap( $role_name ) );
$this->assertTrue( $user->has_cap( 'level_1' ) );
$this->assertTrue( $user->has_cap( 'sweep_floor' ) );
// shouldn't have the removed cap
$this->assertFalse( $user->has_cap( 'polish_doorknobs' ) );
// clean up
remove_role( $role_name );
$this->_flush_roles();
$this->assertFalse( $wp_roles->is_role( $role_name ) );
}
function test_user_add_cap() {
// add an extra capability to a user
// there are two contributors
$id_1 = self::factory()->user->create( array( 'role' => 'contributor' ) );
$id_2 = self::factory()->user->create( array( 'role' => 'contributor' ) );
// user 1 has an extra capability
$user_1 = new WP_User( $id_1 );
$this->assertTrue( $user_1->exists(), "Problem getting user $id_1" );
$user_1->add_cap( 'publish_posts' );
// re-fetch both users from the db
$user_1 = new WP_User( $id_1 );
$this->assertTrue( $user_1->exists(), "Problem getting user $id_1" );
$user_2 = new WP_User( $id_2 );
$this->assertTrue( $user_2->exists(), "Problem getting user $id_2" );
// make sure they're both still contributors
$this->assertEquals( array( 'contributor' ), $user_1->roles );
$this->assertEquals( array( 'contributor' ), $user_2->roles );
// check the extra cap on both users
$this->assertTrue( $user_1->has_cap( 'publish_posts' ) );
$this->assertFalse( $user_2->has_cap( 'publish_posts' ) );
// make sure the other caps didn't get messed up
$caps = $this->getAllCapsAndRoles();
foreach ( $caps as $cap => $roles ) {
if ( in_array( 'contributor', $roles, true ) || 'publish_posts' === $cap ) {
$this->assertTrue( $user_1->has_cap( $cap ), "User should have the {$cap} capability" );
} else {
$this->assertFalse( $user_1->has_cap( $cap ), "User should not have the {$cap} capability" );
}
}
}
function test_user_remove_cap() {
// add an extra capability to a user then remove it
// there are two contributors
$id_1 = self::factory()->user->create( array( 'role' => 'contributor' ) );
$id_2 = self::factory()->user->create( array( 'role' => 'contributor' ) );
// user 1 has an extra capability
$user_1 = new WP_User( $id_1 );
$this->assertTrue( $user_1->exists(), "Problem getting user $id_1" );
$user_1->add_cap( 'publish_posts' );
// now remove the extra cap
$user_1->remove_cap( 'publish_posts' );