-
Notifications
You must be signed in to change notification settings - Fork 5
/
checkplugini18n.php
1744 lines (1618 loc) · 56 KB
/
checkplugini18n.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
$tool_version = '0.4.7';
$p = array(); // will hold all the plugin info
$whitelist = array ('1.2.3.4', '5.6.7.8');
// Some DDoS protection
$ret = throttle_requests( $whitelist );
// Page header and CSS
page_start( $tool_version );
if ( $ret == 'whitelisted' ) echo '(=> IP whitelisted)<br>';
// Ask slug in inputbox if not already in URL
get_slug();
// If slug is not a slug, die!
if ( !is_valid_slug($p['slug']) ) {
$args = array(
'type' => 'err',
'text' => 'That is not a valid slug in the URL',
'die' => true,
);
show_msg( $args );
}
// Add an indication in the log
error_log('Running for ' . $p['slug']);
// Get WP and other current versions
$current_stable_ver = get_current_versions();
$wp_dev_major = get_major_version( $current_stable_ver['wp_dev'] );
$wp_current_major = get_major_version( $current_stable_ver['wp_current'] );
// Check if plugin is closed
check_closed();
// Check base dir
$url = 'https://plugins.svn.wordpress.org/' . $p['slug'];
if ( !is_accessible( $url . '/' ) ) {
$args = array(
'type' => 'err',
'text' => 'Unable to find path ' . $url . '/',
'die' => true,
'cbid' => __LINE__,
);
show_msg( $args );
}
$p['svn_base_dir'] = $url;
echo 'Plugin <b>slug</b>: ' . $p['slug'] . '<br>';
// Get readme.txt and .md correct upper/lower case spelling
// Check access to the files
// Show warning if both txt and md exist
get_readmes_filenames('trunk');
echo '<b>Readme file</b> is available on ' . $p['fp_trunk_readme'] . '<br>';
// Readme file size
$i = get_file_size( $p['fp_trunk_readme'] );
$fs = (int)($i/1024);
if ($fs == 0) $fs = 1;
echo '- Readme filesize: ' . $fs . 'k<br>';
if ( $i > 10240 ) {
$args = array(
'type' => 'warn',
'spaces' => 2,
'text' => 'Please reduce your ' . $p['fn_trunk_readme'] . ' in /trunk as it is over 10k',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/#file-size',
'cbid' => __LINE__,
);
show_msg( $args );
}
// Get trunk readme file contents
$headers = array(
'Tags' => 'Tags',
'RequiresAtLeast' => 'Requires at least',
'TestedUpTo' => 'Tested up to',
'StableTag' => 'Stable tag',
'RequiresPHP' => 'Requires PHP',
);
$trunk_tags = get_file_tags( $p['fp_trunk_readme'], $headers );
//Readme tags and check stable tag
$p['stable_tag'] = $trunk_tags['StableTag'];
$p['req_at_least'] = $trunk_tags['RequiresAtLeast'];
$p['req_php'] = $trunk_tags['RequiresPHP'];
$p['tested_up_to'] = $trunk_tags['TestedUpTo'];
$p['tags'] = explode(',', $trunk_tags['Tags'] );
$p['tags_string'] = $trunk_tags['Tags'];
if ( $p['stable_tag'] ) {
echo '- Stable tag: ' . $p['stable_tag'] . '<br>';
} else {
$args = array(
'type' => 'warn',
'spaces' => 2,
'text' => 'Stable tag not found in readme file so defaulting to trunk, but better define it!',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/#how-the-readme-is-parsed',
'cbid' => __LINE__,
);
show_msg( $args );
$p['stable_tag'] = 'trunk';
}
// If trunk, check the tags in the readme.txt trunk
if ( $p['stable_tag'] == 'trunk' ) {
$args = array(
'type' => 'warn',
'spaces' => 2,
'text' => 'The plugin sources used by everyone are in /trunk, is this what is expected?',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/#how-the-readme-is-parsed',
'cbid' => __LINE__,
);
show_msg( $args );
}
// Get the tags folder if any
$tags = get_all_tags_folders( $p['svn_base_dir'] . '/tags' );
if ($tags) {
echo '<p class="ind">';
echo 'Tag folders found: ';
$first = true;
$errors = '';
foreach ($tags as $tag) {
if (!$first) {
echo ', ';
} else {
$first = false;
}
// Highlight if tag is the stable tag
if ( $tag == $p['stable_tag'] ) {
echo '<b>' . $tag . '</b>';
} else {
echo $tag;
}
if ( !is_valid_version ( $tag ) ) {
$errors = $errors . ', ' . $tag;
}
}
if ($p['stable_tag'] == 'trunk') {
echo ' (but none are used, only trunk)';
}
// If over 20, give recommendations to clean
if ( count( $tags ) > 20 ) {
echo '<br>';
$args = array(
'type' => 'rec',
'text' => 'You have over 20 versions here, is that really needed? Does anybody actually need those older versions? Why have the system build ZIP files for them?',
'cbid' => __LINE__,
);
show_msg( $args );
}
if ( $errors ) {
echo '<br>';
$args = array(
'type' => 'rec',
'text' => 'You can use any naming you want for your Stable Tag and so folders in /tags, however most common usage is to use versions. The following folders are not valid PHP version numbers :' . $errors,
'cbid' => __LINE__,
);
show_msg( $args );
}
echo '</p>';
} else {
if ($p['stable_tag'] == 'trunk') {
echo ' No folders found under /tags, but trunk is used so that is fine.';
} else {
$args = array(
'type' => 'warn',
'text' => 'No folders found under /tags although your Stable Tag is set to ' . $p['stable_tag'] .
' ! So create the <b>' . $p['stable_tag'] . '</b> folder under /tags OR change the Stable Tag to <b>trunk</b>. Defaulting now to trunk. ',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/#how-the-readme-is-parsed',
'cbid' => __LINE__,
);
show_msg( $args );
$p['stable_tag'] = 'trunk';
}
echo '<br>';
}
// Make sure the needed folder exists
if ($p['stable_tag'] != 'trunk') {
$folder = $p['svn_base_dir'] . '/tags/' . $p['stable_tag'] . '/';
if ( !is_accessible( $folder ) ) {
$args = array(
'type' => 'warn',
'text' => 'Unable to find or access ' . $folder . ' Defaulting to trunk.',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/#how-the-readme-is-parsed',
'cbid' => __LINE__,
);
show_msg( $args );
$p['stable_tag'] = 'trunk';
$folder = $p['svn_base_dir'] . '/trunk/';
} else {
// Get readme in the /tags folder
get_readmes_filenames( $p['stable_tag'] );
echo '<b>Readme file</b> is available on ' . $p['fp_tags_readme'] . '<br>';
// Readme file size
$i = get_file_size( $p['fp_tags_readme'] );
$fs = (int)($i/1024);
if ($fs == 0) $fs = 1;
echo '- Readme filesize: ' . $fs . 'k<br>';
if ( $i > 10240 ) {
$args = array(
'type' => 'warn',
'spaces' => 2,
'text' => 'Please reduce your ' . $p['fn_tags_readme'] . ' in /tags/' . $p['stable_tag'] . ' as it is over 10k',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/#file-size',
'cbid' => __LINE__,
);
show_msg( $args );
}
// Get trunk readme file contents
$headers = array(
'Tags' => 'Tags',
'RequiresAtLeast' => 'Requires at least',
'TestedUpTo' => 'Tested up to',
'StableTag' => 'Stable tag',
'RequiresPHP' => 'Requires PHP',
);
$trunk_tags = get_file_tags( $p['fp_tags_readme'], $headers );
//Readme tags
$p['req_at_least'] = $trunk_tags['RequiresAtLeast'];
$p['req_php'] = $trunk_tags['RequiresPHP'];
$p['tested_up_to'] = $trunk_tags['TestedUpTo'];
$p['tags'] = explode(',', $trunk_tags['Tags'] );
$p['tags_string'] = $trunk_tags['Tags'];
}
} else {
$folder = $p['svn_base_dir'] . '/trunk/';
}
// Show the readme tags
// Requires at least
echo '- Requires at least: '; echo $p['req_at_least']?:'<not set>'; echo '<br>';
if ( !$p['req_at_least'] ) {
$args = array(
'type' => 'warn',
'spaces' => 2,
'text' => 'No <b>Requires at least:</b> is set in the readme file. Considering 1.0 for further testing on this page, but please consider adding it.',
'cbid' => __LINE__,
);
show_msg( $args );
$p['req_at_least'] = '1.0';
} else {
if ( version_has_wp( $p['req_at_least'] ) ) {
$args = array(
'type' => 'warn',
'spaces' => 2,
'text' => 'Your <b>Requires at least:</b> starts with "WP" or "WordPress", please use only the version, something like ' . $wp_current_major,
'cbid' => __LINE__,
);
show_msg( $args );
} else {
if ( !is_valid_version( $p['req_at_least'] ) ) {
$args = array(
'type' => 'err',
'spaces' => 2,
'text' => 'Your <b>Requires at least</b> is not a valid version. It should be something like ' . $wp_current_major,
'action' => 'link',
'action_text' => 'https://www.php.net/manual/en/function.version-compare.php',
'cbid' => __LINE__,
);
show_msg( $args );
} else {
// Compare Tested_up_to with Req_at_least
if ( is_valid_version( $p['tested_up_to'] ) ) {
if ( version_compare($p['req_at_least'], $p['tested_up_to'], '>') ) {
$args = array(
'type' => 'warn',
'text' => 'Your <b>Requires at least:</b> is set to <b>' . $p['req_at_least'] . '</b>, but the plugin seems only <b>Tested up to: ' . $p['tested_up_to'] . '</b>',
'cbid' => __LINE__,
);
show_msg( $args );
}
}
}
}
}
// Tested up to
echo '- Tested up to: '; echo $p['tested_up_to']?:'<not set>'; echo '<br>';
if ( !$p['tested_up_to'] ) {
$args = array(
'type' => 'warn',
'spaces' => 2,
'text' => 'No <b>Tested up to:</b> is set in the readme file. Consider adding it to positively impact your ranking in the repository.',
'action' => 'link',
'action_text' => 'https://meta.trac.wordpress.org/ticket/3936#comment:9',
'cbid' => __LINE__,
);
show_msg( $args );
} else {
if ( version_has_wp( $p['tested_up_to'] ) ) {
$args = array(
'type' => 'warn',
'spaces' => 2,
'text' => 'Your <b>Tested up to:</b> starts with "WP" or "WordPress", please use only the version, something like ' . $wp_current_major,
'cbid' => __LINE__,
);
show_msg( $args );
} else {
if ( !is_valid_version( $p['tested_up_to'] ) ) {
$args = array(
'type' => 'err',
'spaces' => 2,
'text' => 'Your <b>Tested up to:</b> is not a valid version. It should be something like ' . $wp_current_major,
'action' => 'link',
'action_text' => 'https://www.php.net/manual/en/function.version-compare.php',
'cbid' => __LINE__,
);
show_msg( $args );
} else {
if ( !version_has_only_major_minor( $p['tested_up_to'] ) ) {
$args = array(
'type' => 'rec',
'spaces' => 2,
'text' => 'You can limit your <b>Tested up to:</b> to just the major release (e.g. ' . $wp_current_major . '). The repository will automatically add the latest minor version as plugins shouldn’t break with a minor update.',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/#readmeheader-information',
'cbid' => __LINE__,
);
show_msg( $args );
}
if ( version_compare($wp_dev_major, $p['tested_up_to'], '<') ) {
$args = array(
'type' => 'err',
'spaces' => 2,
'text' => 'Your <b>Tested up to:</b> is set higher then the current development version (' . $wp_dev_major . ')',
'cbid' => __LINE__,
);
show_msg( $args );
}
}
}
}
// Requires PHP
echo '- Requires PHP: '; echo $p['req_php']?:'<not set>'; echo '<br>';
if ( !empty( $p['req_php'] ) ) {
if ( !is_valid_version( $p['req_php'] ) ) {
$args = array(
'type' => 'err',
'spaces' => 2,
'text' => 'Your <b>Requires PHP:</b> is not a valid version. It should be something like 5.6',
'action' => 'link',
'action_text' => 'https://www.php.net/manual/en/function.version-compare.php',
'cbid' => __LINE__,
);
show_msg( $args );
}
}
// Max 12, better not more than 5 tags
if ( isset($p['tags'] ) ) {
echo '- Tags: ' . $p['tags_string'] . '<br>';
if ( count($p['tags']) > 12 ) {
$args = array(
'type' => 'err',
'spaces' => 2,
'text' => 'You have more than 12 tags defined, max 5 should be your target! Important terms should go in the body of the readme as a list of keywords is basically useless for the search engine.',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/wordpress-org/detailed-plugin-guidelines/#12-public-facing-pages-on-wordpress-org-readmes-must-not-spam',
'cbid' => __LINE__,
);
show_msg( $args );
} else {
if ( count($p['tags']) > 5 ) {
$args = array(
'type' => 'rec',
'spaces' => 2,
'text' => 'You have more than 5 tags defined, only the first 5 are displayed so you could remove the extra ones.',
'action' => 'info',
'action_text' => 'Tag 6 and further work for sorting (like if you go to /tags/tagname) but the rest may or may not help you. Important terms should go in the body of the readme. Lists of keywords are basically useless for the search engine. People search for solutions to the problems they\'re having, not keywords. Think sentences, not lists of words.',
'cbid' => __LINE__,
);
show_msg( $args );
}
}
}
echo '<br>';
// Get the php files in the folder
$files = checkplug_get_file_contents( $folder );
$lines = explode("\n", $files);
$php_files = array();
foreach ($lines as $line) {
$line = trim($line);
if (strpos($line, '<li>') !== false) {
$f = checkplug_get_text_between('<li><a href="', '/"', $line);
if (!$f) {
$php_file = checkplug_get_text_between('<li><a href="', '.php"', $line);
if ($php_file) {
$php_files[] = $php_file . '.php';
}
}
}
}
if (!$php_files) {
$args = array(
'type' => 'err',
'text' => 'Unable to find or access php files in ' . $folder,
);
show_msg( $args );
}
// Loop all php files found
foreach ($php_files as $php_file) {
// Find and read the main php file
$p['fp_main_php'] = $folder . $php_file;
$headers = array(
'Name' => 'Plugin Name',
'PluginURI' => 'Plugin URI',
'Version' => 'Version',
'Description' => 'Description',
'Author' => 'Author',
'AuthorURI' => 'Author URI',
'License' => 'License',
'LicenseURI' => 'License URI',
'TextDomain' => 'Text Domain',
'DomainPath' => 'Domain Path',
'Network' => 'Network',
'RequiresWP' => 'Requires at least',
'RequiresPHP' => 'Requires PHP',
// Site Wide Only is deprecated in favor of Network.
'_sitewide' => 'Site Wide Only',
);
$phpfile_tags = get_file_tags( $p['fp_main_php'], $headers );
if ( !empty( $phpfile_tags['Name'] ) ) {
echo 'File <b>' . $php_file . '</b> in ' . $folder . ' had the info needed:<br>';
echo ' - Plugin Name: '; echo $phpfile_tags['Name']?:'<not set>'; echo '<br>';
echo ' - Version: '; echo $phpfile_tags['Version']?:'<not set>'; echo '<br>';
echo ' - Text Domain: '; echo $phpfile_tags['TextDomain']?:'<not set>'; echo '<br>';
break;
}
}
if ( empty( $phpfile_tags['Name'] ) ) {
if ( !empty( $phpfile_tags['Version'] ) ) {
$args = array(
'type' => 'err',
'spaces' => 2,
'text' => 'Your plugin in <b>' . $php_file . '</b> does not seem to contain the mandatory "Plugin Name" tag!',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/plugin-basics/header-requirements/#header-fields',
'cbid' => __LINE__,
);
show_msg( $args );
} else {
$args = array(
'type' => 'err',
'text' => 'It looks like no php file contained the headers in <b>' . $folder . '</b>, so cannot check anything!',
);
show_msg( $args );
}
}
// Check Text domain
if ( empty( $phpfile_tags['TextDomain'] ) ) {
if ( version_compare($p['req_at_least'], '4.6', '>=') ) {
// No Text domain needs to be defined if WP is 4.6+
$phpfile_tags['TextDomain'] = $p['slug'];
} else {
$args = array(
'type' => 'err',
'spaces' => 2,
'text' => 'Your "Requires at least" is below 4.6. so you need to set a Text Domain in <b>' . $php_file . '</b> and it needs to be <b>' . $p['slug'] . '</b> to correctly internationalize your plugin! ',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/#text-domains',
'cbid' => __LINE__,
);
show_msg( $args );
}
}
if ( $phpfile_tags['TextDomain'] ) {
if ( $phpfile_tags['TextDomain'] != $p['slug'] ) {
if ( version_compare($p['req_at_least'], '4.6', '>=') ) {
// No Text domain needs to be defined if WP is 4.6+
$args = array(
'type' => 'err',
'spaces' => 2,
'text' => 'Your plugin slug is <b>' . $p['slug'] . '</b>, but your Text Domain is set as <b>' . $phpfile_tags['TextDomain'] .'</b>. As the "Requires at least" is at least 4.6, you should remove the Text Domain tag, but you still need to modify the text domain in all your source files.',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/#text-domains',
'cbid' => __LINE__,
);
show_msg( $args );
} else {
$args = array(
'type' => 'err',
'spaces' => 2,
'text' => 'Your plugin slug is <b>' . $p['slug'] . '</b>, but your Text Domain is <b>' . $phpfile_tags['TextDomain'] .'</b>. Change your Text Domain so it is equal to your slug and modify the text domain in all your source files. This change is needed because your "Requires at least" is below 4.6.',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/#text-domains',
'cbid' => __LINE__,
);
show_msg( $args );
}
}
}
// No underscores in text domain
$pos = strpos( $phpfile_tags['TextDomain'], '_' );
if( false !== $pos) {
$args = array(
'type' => 'err',
'spaces' => 2,
'text' => 'Your Text Domain should not contain underscores!',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/#text-domains',
'cbid' => __LINE__,
);
show_msg( $args );
}
// If trunk, check if version has existing tag
if ( ( $p['stable_tag'] == 'trunk' ) && ( in_array( $phpfile_tags['Version'], $tags ) ) ) {
$args = array(
'type' => 'rec',
'text' => 'Trunk is being used, but there is a folder under tags with the same name as your plugin version (' . $phpfile_tags['Version'] . '). This could lead to confusion',
'cbid' => __LINE__,
);
show_msg( $args );
}
// Domain Path check
if ( $phpfile_tags['DomainPath'] ) {
echo ' - Domain Path: ' . $phpfile_tags['DomainPath'] . '<br>';
$args = array(
'type' => 'rec',
'spaces' => 2,
'text' => 'The <b>Domain Path</b> header can be omitted as the plugin is in the official WordPress Plugin Directory.',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/#domain-path',
'cbid' => __LINE__,
);
show_msg( $args );
}
// License
if ( !$phpfile_tags['License'] ) {
$args = array(
'type' => 'warn',
'spaces' => 2,
'text' => 'Setting a <b>License</b> header is mandatory for new plugins since April 2020. Consider adding one, preferably the same one as WordPress itself: “GPLv2 or later”.',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/wordpress-org/detailed-plugin-guidelines/#1-plugins-must-be-compatible-with-the-gnu-general-public-license',
'cbid' => __LINE__,
);
show_msg( $args );
} else {
echo ' - License: ' . $phpfile_tags['License'] . '<br>';
if ( filter_var( $phpfile_tags['License'], FILTER_VALIDATE_URL ) ) {
$args = array(
'type' => 'rec',
'spaces' => 2,
'text' => 'It looks like the <b>License</b> header is a URL, so you probably wanted to add it under <b>License URI</b>?',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/plugin-basics/header-requirements/#header-fields',
'cbid' => __LINE__,
);
show_msg( $args );
} else {
if ( license_is_not_for_software( $phpfile_tags['License'] ) ) {
$args = array(
'type' => 'err',
'spaces' => 2,
'text' => 'The <b>' . $phpfile_tags['License'] . '</b> license is not for software, changing to the same license as WordPress — “GPLv2 or later” — is strongly recommended.',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/wordpress-org/detailed-plugin-guidelines/#1-plugins-must-be-compatible-with-the-gnu-general-public-license',
'cbid' => __LINE__,
);
show_msg( $args );
} else {
if ( license_is_gpl_incompatible( $phpfile_tags['License'] ) ) {
$args = array(
'type' => 'err',
'spaces' => 2,
'text' => 'The <b>' . $phpfile_tags['License'] . '</b> license is incompatible! Changing to the same license as WordPress — “GPLv2 or later” — is strongly recommended.',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/wordpress-org/detailed-plugin-guidelines/#1-plugins-must-be-compatible-with-the-gnu-general-public-license',
'cbid' => __LINE__,
);
show_msg( $args );
} else {
if ( !license_is_gpl_compatible( $phpfile_tags['License'] ) ) {
$args = array(
'type' => 'rec',
'spaces' => 2,
'text' => 'The <b>' . $phpfile_tags['License'] . '</b> license is not a standard abbreviation for a compatible license. You might have a compatible license but the correct abbreviation (e.g. GPLv2) is expected here...',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/plugin-basics/header-requirements/#header-fields',
'cbid' => __LINE__,
);
show_msg( $args );
error_log('=> Lic: ' . $phpfile_tags['License']);
}
}
}
}
}
// Network or _sitewide
if ( $phpfile_tags['_sitewide'] ) {
$args = array(
'type' => 'warn',
'spaces' => 2,
'text' => 'The <b>_sitewide</b> header is deprecated, please use <b>Network: true</b>',
'cbid' => __LINE__,
);
show_msg( $args );
}
if ( $phpfile_tags['Network'] ) {
if ( ( $phpfile_tags['Network'] == 'true' ) || ( $phpfile_tags['Network'] == true ) ) {
// all fine
} else {
$args = array(
'type' => 'err',
'spaces' => 2,
'text' => 'The <b>Network</b> header can only have <b>true</b> as value!',
'cbid' => __LINE__,
);
show_msg( $args );
}
}
// load_plugin_textdomain checks
echo '<br>';
if ( is_valid_version( $p['req_at_least'] ) ) {
if ( version_compare($p['req_at_least'], '4.6', '>=') ) {
$args = array(
'type' => 'rec',
'text' => '"Requires at least" (' . $p['req_at_least'] . ') is at least 4.6 so no <b>load_plugin_textdomain</b> is needed. If you have the function somewhere, you can remove it.',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/#loading-text-domain',
'cbid' => __LINE__,
);
show_msg( $args );
} else {
$args = array(
'type' => 'warn',
'text' => '"Requires at least" (' . $p['req_at_least'] . ') is below 4.6 so a <b>load_plugin_textdomain</b> is needed. Please make sure you load it at a certain point in your plugin.',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/#loading-text-domain',
'cbid' => __LINE__,
);
show_msg( $args );
} // MORE CODE NEEDED HERE TO CHECK
} else {
$args = array(
'type' => 'warn',
'text' => 'Unable to evaluate "Requires at least" correctly (' . $p['req_at_least'] . ') so a <b>load_plugin_textdomain</b> is needed. Please make sure you load it at a certain point in your plugin.',
'action' => 'link',
'action_text' => 'https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/#loading-text-domain',
'cbid' => __LINE__,
);
show_msg( $args );
}
// Language packs
echo '<h3>Language packs created:</h3>';
$l_arr = array();
$v_arr = array();
$f = checkplug_get_file_contents('https://api.wordpress.org/translations/plugins/1.0/?slug=' . $p['slug']);
if ($f) {
$a = json_decode($f);
foreach ($a->translations as $item) {
$d = new DateTime($item->updated);
$l_arr[$item->language]['updated'] = $d->format('Y-m-d');
$l_arr[$item->language]['english_name'] = $item->english_name;
$l_arr[$item->language]['language'] = $item->language;
$l_arr[$item->language]['version'] = $item->version;
if( !in_array($item->version, $v_arr ) ) {
$v_arr[] = $item->version;
}
}
}
usort($v_arr, 'version_compare'); //sort versions
$v_arr = array_reverse($v_arr); // in reverse order
foreach ( $v_arr as $ver ) {
echo '<p class="ind">';
echo 'v<b>' . $ver . '</b>: ';
foreach ( $l_arr as $l ) {
if ( $l['version'] == $ver ) {
echo $l['english_name'] . ' (<b>' . $l['language'] . '</b> - ' . $l['updated'] . '), ';
}
}
echo '</p>';
}
// Translation editors from https://translate.wordpress.org/projects/wp-plugins/$p['slug']/contributors
echo '<h3>Translation editors per locale</h3>';
$url = 'https://translate.wordpress.org/projects/wp-plugins/' . $p['slug'] . '/contributors';
$f = checkplug_get_file_contents($url);
if ($f) {
$doc = new DOMDocument;
@$doc->loadHTML($f);
$doc->preserveWhiteSpace = false;
$classname = 'has-editors';
$xpath = new DOMXPath($doc);
$rows = $xpath->query("//*[contains(@class, '" . $classname . "')]");
$nbr_rows = $rows->length;
if ($nbr_rows) {
echo '<table border="1">';
foreach ($rows as $row) {
//Get locale name and code
$classname = "locale-name";
$loc_name = trim($xpath->query(".//*[contains(@class, '" . $classname . "')]", $row)->item(0)->childNodes[0]->nodeValue);
$classname = "locale-code";
$loc_code = $xpath->query(".//*[contains(@class, '" . $classname . "')]", $row)->item(0)->nodeValue;
$loc_code = str_replace('#', '', $loc_code);
//Get usernames
$hrefs = $xpath->query('.//p[1]/a/@href', $row);
$ptes = '';
foreach ($hrefs as $href) {
$uname = checkplug_get_text_between('https://profiles.wordpress.org/', '/', $href->nodeValue);
if ($ptes) $ptes = $ptes . '; ';
$ptes = $ptes . '<a href="' . $href->nodeValue . '">' . $uname . '</a>';
}
echo '<tr><td>' . $loc_code . '</td><td>' . $ptes . '</td></tr>';
// add to central array
if ( !isset($l_arr[$loc_code]) ) {
$l_arr[$loc_code]['language'] = $loc_code;
$l_arr[$loc_code]['english_name'] = $loc_name;
}
$l_arr[$loc_code]['pte'] = $ptes;
}
echo '</table>';
}
}
// Translation status per locale
// Just adding to the global table
// Only create new locales if > 0%
$f = checkplug_get_file_contents('https://translate.wordpress.org/api/projects/wp-plugins/' . $p['slug'] . '/stable');
if ($f) {
$a = json_decode($f);
if ( !isset ( $a->error ) ) {
foreach ($a->translation_sets as $item) {
// add to central array
$loc_code = $item->wp_locale;
if ( ( !isset($l_arr[$loc_code]) ) && ( $item->percent_translated > 3 ) ) {
$l_arr[$loc_code]['language'] = $loc_code;
$l_arr[$loc_code]['english_name'] = $item->name;
}
if ( isset($l_arr[$loc_code]) ) {
$l_arr[$loc_code]['trstat_stable'] = $item->percent_translated;
$l_arr[$loc_code]['trurl_stable'] = 'https://translate.wordpress.org/projects/wp-plugins/' . $p['slug'] . '/stable/' . $item->locale . '/default' ;
}
}
}
}
$f = checkplug_get_file_contents('https://translate.wordpress.org/api/projects/wp-plugins/' . $p['slug'] . '/dev');
if ($f) {
$a = json_decode($f);
if ( !isset ( $a->error ) ) {
foreach ($a->translation_sets as $item) {
// add to central array
$loc_code = $item->wp_locale;
if ( ( !isset($l_arr[$loc_code]) ) && ( $item->percent_translated > 3 ) ) {
$l_arr[$loc_code]['language'] = $loc_code;
$l_arr[$loc_code]['english_name'] = $item->name;
}
if ( isset($l_arr[$loc_code]) ) {
$l_arr[$loc_code]['trstat_dev'] = $item->percent_translated;
$l_arr[$loc_code]['trurl_dev'] = 'https://translate.wordpress.org/projects/wp-plugins/' . $p['slug'] . '/dev/' . $item->locale . '/default' ;
}
}
}
}
// Latest Revision log
echo '<h3>Latest Revision log entries</h3>';
$url = 'https://plugins.trac.wordpress.org/log/' . $p['slug'] . '/?limit=10&mode=stop_on_copy&format=rss';
$rss_items = checkplug_fetch_feed( $url );
if (!$rss_items) {
echo '<span style="color: orange;">' . 'WARNING: Unable to get <a href="' . $url . '">latest revision log</a>, might be just a temporary issue.</span>';
} else {
echo '<table border="1">';
foreach ( $rss_items as $item ) {
$revlog_url = $item['link'];
$revlog_desc = $item['description'];
$revlog_date = date('Y-m-d H:i', $item['date']);
echo '<tr><td>' . $revlog_date . ' GMT</td><td>' . $revlog_desc . '</td></tr>';
}
echo '</table>';
}
// Links
checkplug_print_links();
// Summary table
echo '<h3>Summary table</h3>';
echo '<table border="1">';
echo '<tr><th>Locale</th><th>Name</th><th colspan="2">Language pack</th><th>Editor (PTE)</th><th>Stable</th><th>Dev</th></tr>';
ksort($l_arr);
foreach ( $l_arr as $loc ) {
echo '<tr><td>' . $loc['language'] . '</td><td>' . $loc['english_name'] . '</td><td>' . $loc['version'] . '</td><td>' . $loc['updated'] . '</td><td>' . $loc['pte'] .
'</td><td><a href="' . $loc['trurl_stable'] . '">' . $loc['trstat_stable'] . '%</a></td><td><a href="' . $loc['trurl_dev'] . '">' . $loc['trstat_dev'] . '%</a></td></tr>';
}
echo '</table>';
page_end();
/***************************
***************************
******* FUNCTIONS ********
***************************
***************************/
function show_msg( $args ) {
// $args['type'] : err, warn, rec
// $args['spaces'] : number of nbsp before the text
// $args['text']
// $args['action'] : link, info
// $args['action_text'] : The link or the hover text
// $args['die'] : true
// $args['cbid'] : line number (for the clipboard copy)
if ( ! isset( $args['type'] ) )
die( '$args type is empty' );
if ( !in_array( $args['type'], array('err', 'warn', 'rec') ) )
die( '$args type incorrect' );
if ( ! isset($args['text']) )
die( '$args text is empty' );
if ( isset( $args['action'] ) ) {
if ( !in_array( $args['action'], array('link', 'info') ) )
die( '$args action incorrect' );
if ( !isset( $args['action_text'] ) )
die( '$args text_text is empty' );
}
if ( isset( $args['die'] ) ) {
if ( !is_bool( $args['die'] ) )
die( '$args die can only have true as value' );
}
$prefix = '';
if ( isset( $args['spaces'] ) ) {
$prefix = str_repeat( ' ', $args['spaces'] );
}
if ( $args['type'] == 'rec') {
$type_string = 'RECOMMENDATION: ';
echo $prefix;
echo '<span style="color: DarkKhaki;">RECOMMENDATION: ' . $args['text'] . '</span>';
}
if ( $args['type'] == 'warn') {
$type_string = 'WARNING: ';
echo $prefix;
echo '<span style="color: orange;">WARNING: ' . $args['text'] . '</span>';
}
if ( $args['type'] == 'err') {
$type_string = 'ERROR: ';
echo $prefix;
echo '<span style="color: red;">ERROR: ' . $args['text'] . '</span>';
}
if ( $args['action'] == 'info') {
echo ' <div class="tooltip">i<span class="tooltiptext">' . $args['action_text'] . '</span></div>';
}
if ( $args['action'] == 'link') {
echo ' <a href="' . $args['action_text'] . '" class="button" title="Opens in new tab" target="_blank">More info</a>';
}
if ( isset($args['cbid'] ) ) {
echo ' <span id="' . $args['cbid'] . '" style="display: none;">' . $type_string . $args['text'];
if ( $args['action_text'] ) echo ' (see ' . $args['action_text'] . ')';
echo '</span>';
echo '<img style="vertical-align: middle;" height="24" width="24" src="https://lh5.ggpht.com/b-7FA5CMqRQMFt5g77SJNbIw0qfHCuyg1kaiahhKIL4nmsumXH27MYNps1B2lvmqV6qI4kZ3M-DCN9k5OZ4lcbKT"' .
'alt="Copy to clipboard" title="Copy to clipboard" onClick="CopyCB(\'' . $args['cbid'] . '\')">';
}
echo '<br>';
if ( $args['die'] )
die();
}
function check_closed() {
global $p;
$url = 'https://wordpress.org/plugins/' . $p['slug'] . '/';
$doc1 = checkplug_get_file_contents($url);
if ($doc1) {
$doc = new DOMDocument;
@$doc->loadHTML($doc1);
$doc->preserveWhiteSpace = false;
$classname = 'notice-error';
$xpath = new DOMXPath($doc);
$lists = $xpath->query("//*[contains(@class, '" . $classname . "')]");
foreach ($lists as $list) {
$args = array(
'type' => 'warn',
'text' => 'The plugin is mentioning an error: ' . $list->nodeValue,
'action' => 'link',
'action_text' => $url,
'cbid' => __LINE__,
);
show_msg( $args );
echo '<br>';
}
} else {
$args = array(
'type' => 'err',
'text' => 'The plugin cannot be accessed WordPress Plugin Directory! (' . $url . ')',
'cbid' => __LINE__,
);
show_msg( $args );
}
}
function is_accessible( $url ) {
$ch = curl_init();
curl_setopt_array(
$ch, array(
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_NOBODY => false,
CURLOPT_USERAGENT => 'Mozilla/5.0 (X11; Linux i686) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.43 Safari/537.31',
));
$output = curl_exec($ch);
$retcode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
// $retcode >= 400 -> not found, $retcode = 200, found.
if ( $retcode == 200) {
return true;
} else {
return false;
}
}
function get_file_tags( $file, $headers) {
$file_data = checkplug_get_file_contents( $file, 10000 );
// Make sure we catch CR-only line endings.
$file_data = str_replace( "\r", "\n", $file_data );
foreach ( $headers as $field => $regex ) {
if ( preg_match( '/^[ \t\/*#@]*' . preg_quote( $regex, '/' ) . ':(.*)$/mi', $file_data, $match ) && $match[1] ) {
$headers[ $field ] = trim( preg_replace( '/\s*(?:\*\/|\?>).*/', '', $match[1] ) );
} else {
$headers[ $field ] = '';
}
}
return $headers;
}
function get_readmes_filenames( $context ) {
// context is trunk OR folder under tags
global $p;
unset($p['readme_ext_txt']);
unset($p['readme_ext_md']);
if ( $context == 'trunk' ) {
$text = checkplug_get_file_contents( $p['svn_base_dir'] . '/trunk/' );
} else {
$text = checkplug_get_file_contents( $p['svn_base_dir'] . '/tags/' . $p['stable_tag'] . '/' );
}
$lines = explode("\n", $text);
foreach ($lines as $line) {
if (stripos($line, '<a href="readme.txt">') !== false) {
if ( $context == 'trunk' ) {
$p['fn_trunk_readme'] = checkplug_get_text_between('<li><a href="', '"', $line);
} else {
$p['fn_tags_readme'] = checkplug_get_text_between('<li><a href="', '"', $line);
}
$p['readme_ext_txt'] = 'y';
}
if (stripos($line, '<a href="readme.md">') !== false) {
if ( $context == 'trunk' ) {
if ( !isset( $p['fn_trunk_readme'] ) )
$p['fn_trunk_readme'] = checkplug_get_text_between('<li><a href="', '"', $line);
$p['readme_ext_md'] = 'y';
} else {
if ( !isset( $p['fn_tags_readme'] ) )
$p['fn_tags_readme'] = checkplug_get_text_between('<li><a href="', '"', $line);
$p['readme_ext_md'] = 'y';
}
}
}
if ( $context == 'trunk' ) {
if (!$p['fn_trunk_readme']) {
$args = array(
'type' => 'err',