forked from Automattic/vip-go-ci
-
Notifications
You must be signed in to change notification settings - Fork 0
/
reports.php
1728 lines (1488 loc) · 42.7 KB
/
reports.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
/**
* Reporting logic for vip-go-ci.
*
* @package Automattic/vip-go-ci
*/
declare(strict_types=1);
/**
* Generate HTML-style list for the report from an array,
* allow various options to ease the generation and
* to make it more generic.
*
* @param string $left String to the left of each entry.
* @param string $right String to the right of each entry.
* @param array|bool|int $data Data to process.
* @param string $when_data_empty When $data is empty, return this string.
* @param string $when_key_values String to use as separator between key and value.
*
* @return string HTML for list.
*
* @codeCoverageIgnore
*/
function vipgoci_report_create_scan_details_list(
string $left,
string $right,
array|bool|int $data,
string $when_data_empty,
string $when_key_values = ''
) :string {
/*
* If a boolean or numeric, process and return immediately.
*/
if ( is_bool( $data ) ) {
if ( true === $data ) {
$tmp_output = 'true';
} else {
$tmp_output = 'false';
}
return $left . $tmp_output . $right;
} elseif ( is_numeric( $data ) ) {
return $left . (string) $data . $right;
}
/*
* When an array, process further.
*/
if ( empty( $data ) ) {
// Empty array - return.
return $when_data_empty;
}
/*
* Not an empty array, continue processing.
*/
$return_string = '';
foreach ( $data as $arr_item_key => $arr_item_value ) {
if ( is_array( $arr_item_value ) ) {
$arr_item_value = join( ', ', $arr_item_value );
}
$return_string .= $left;
if ( is_numeric( $arr_item_key ) ) {
$return_string .= vipgoci_output_html_escape(
$arr_item_value
);
} else {
$return_string .= vipgoci_output_html_escape(
(string) $arr_item_key
);
$return_string .= $when_key_values;
$return_string .= vipgoci_output_html_escape(
(string) $arr_item_value
);
}
$return_string .= $right;
}
return $return_string;
}
/**
* Create scan report detail message for
* software versions.
*
* @param array $options_copy Options needed.
*
* @return string Detail message for section.
*/
function vipgoci_report_create_scan_details_software_versions(
array $options_copy
) :string {
$details = '<h4>Software versions</h4>' . PHP_EOL;
$details .= '<ul>' . PHP_EOL;
$details .= '<li>vip-go-ci version: <code>' . vipgoci_output_sanitize_version_number( VIPGOCI_VERSION ) . '</code></li>' . PHP_EOL;
$php_runtime_version = phpversion();
if ( ! empty( $php_runtime_version ) ) {
$details .= '<li>PHP runtime version for vip-go-ci: <code>' . vipgoci_output_sanitize_version_number( $php_runtime_version ) . '</code></li>' . PHP_EOL;
}
if ( true === $options_copy['lint'] ) {
$details .= '<li>PHP runtime for linting: ' . PHP_EOL;
$details .= '<ul>' . PHP_EOL;
foreach ( $options_copy['lint-php-versions'] as $lint_php_version ) {
$php_interpreter_version = vipgoci_util_php_interpreter_get_version(
$options_copy['lint-php-version-paths'][ $lint_php_version ]
);
if ( ! empty( $php_interpreter_version ) ) {
$details .= '<li>PHP ' .
vipgoci_output_sanitize_version_number( $lint_php_version ) .
': <code>' .
vipgoci_output_sanitize_version_number( $php_interpreter_version ) .
'</code></li>' .
PHP_EOL;
}
}
$details .= '</ul>';
$details .= '</li>';
}
if ( true === $options_copy['phpcs'] ) {
$phpcs_php_version = vipgoci_util_php_interpreter_get_version(
$options_copy['phpcs-php-path']
);
if ( ! empty( $phpcs_php_version ) ) {
$details .= '<li>PHP runtime version for PHPCS: <code>' . vipgoci_output_sanitize_version_number( $phpcs_php_version ) . '</code></li>' . PHP_EOL;
}
$phpcs_version = vipgoci_phpcs_get_version(
$options_copy['phpcs-path'],
$options_copy['phpcs-php-path']
);
if ( ! empty( $phpcs_version ) ) {
$details .= '<li>PHPCS version: <code>' . vipgoci_output_sanitize_version_number( $phpcs_version ) . '</code></li>' . PHP_EOL;
}
}
if ( true === $options_copy['svg-checks'] ) {
$svg_php_version = vipgoci_util_php_interpreter_get_version(
$options_copy['svg-php-path']
);
if ( ! empty( $svg_php_version ) ) {
$details .= '<li>PHP runtime version for SVG scanner: <code>' . vipgoci_output_sanitize_version_number( $svg_php_version ) . '</code></li>' . PHP_EOL;
}
}
$details .= '</ul>' . PHP_EOL;
$details .= '<h4>Options file (<code>' . vipgoci_output_html_escape( VIPGOCI_OPTIONS_FILE_NAME ) . '</code>)</h4>' . PHP_EOL;
$details .= '<p>Options file enabled: ' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_list(
'<code>',
'</code>',
$options_copy['repo-options'],
'None'
);
$details .= '</p>';
if ( true === $options_copy['repo-options'] ) {
// Clean repo-options-set array of anything sensitive.
$options_copy['repo-options-set'] =
vipgoci_options_sensitive_clean(
$options_copy['repo-options-set']
);
foreach (
array(
'repo-options-allowed' => 'Configurable options',
'repo-options-set' => 'Options altered',
) as $key => $value
) {
$details .= '<p>' . vipgoci_output_html_escape( $value ) . ':</p>' . PHP_EOL;
$details .= '<ul>' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_list(
'<li><code>',
'</code></li>',
$options_copy[ $key ],
'<li>None</li>',
'</code>set to<code>'
);
$details .= '</ul>' . PHP_EOL;
}
}
return $details;
}
/**
* Create scan report detail message for
* PHP lint options section.
*
* @param array $options_copy Options needed.
*
* @return string Detail message for section.
*/
function vipgoci_report_create_scan_details_php_lint_options(
array $options_copy
) :string {
$details = '<h4>PHP lint options</h4>' . PHP_EOL;
foreach (
array(
'lint' => 'PHP lint files enabled',
'lint-modified-files-only' => 'Lint modified files only',
) as $key => $value
) {
if ( ( false === $options_copy['lint'] ) && ( 'lint' !== $key ) ) {
continue;
}
$details .= '<p>' . vipgoci_output_html_escape( $value ) . ': ' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_list(
'<code>',
'</code>',
$options_copy[ $key ],
'None'
);
$details .= '</p>';
}
if ( true === $options_copy['lint'] ) {
foreach (
array(
'lint-file-extensions' => 'Lint files with file extensions',
'lint-skip-folders' => 'Directories not PHP linted',
) as $key => $value
) {
$details .= '<p>' . vipgoci_output_html_escape( $value ) . ':</p>' . PHP_EOL;
$details .= '<ul>' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_list(
'<li><code>',
'</code></li>',
$options_copy[ $key ],
'<li>None</li>'
);
$details .= '</ul>' . PHP_EOL;
}
}
return $details;
}
/**
* Create scan report detail message for
* PHPCS configuration section.
*
* @param array $options_copy Options needed.
*
* @return string Detail message for section.
*/
function vipgoci_report_create_scan_details_phpcs_configuration(
array $options_copy
) :string {
$details = '<h4>PHPCS configuration</h4>' . PHP_EOL;
$details .= '<p>PHPCS scanning enabled: ' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_list(
'<code>',
'</code>',
$options_copy['phpcs'],
'None'
);
$details .= '</p>';
if ( true === $options_copy['phpcs'] ) {
$details .= '<p>PHPCS severity level: ' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_list(
'<code>',
'</code>',
$options_copy['phpcs-severity'],
'None'
);
$details .= '</p>';
$options_copy['phpcs-runtime-set-tmp'] = array_map(
function ( $array_item ) {
return join( ' ', $array_item );
},
$options_copy['phpcs-runtime-set']
);
if ( true === $options_copy['phpcs-standard-file'] ) {
$options_copy['phpcs-standard'] =
$options_copy['phpcs-standard-original'];
}
foreach (
array(
'phpcs-standard' => 'Standard(s) used',
'phpcs-runtime-set-tmp' => 'Runtime set',
'phpcs-file-extensions' => 'Scan added/modified files with file extensions',
'phpcs-sniffs-include' => 'Custom sniffs included',
'phpcs-sniffs-exclude' => 'Custom sniffs excluded',
'phpcs-skip-folders' => 'Directories not PHPCS scanned',
) as $key => $value
) {
$details .= '<p>' . vipgoci_output_html_escape( $value ) . ':</p>' . PHP_EOL;
$details .= '<ul>' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_list(
'<li><code>',
'</code></li>',
$options_copy[ $key ],
'<li>None</li>'
);
$details .= '</ul>' . PHP_EOL;
}
}
return $details;
}
/**
* Create scan report detail message for
* WPScan API configuration section.
*
* @param array $options_copy Options needed.
*
* @return string Detail message for section.
*/
function vipgoci_report_create_scan_details_wpscan_configuration(
array $options_copy
) :string {
$details = '<h4>WPScan API configuration</h4>' . PHP_EOL;
$details .= '<p>WPScan API scanning enabled: ' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_list(
'<code>',
'</code>',
$options_copy['wpscan-api'],
'None'
);
$details .= '</p>';
if ( true === $options_copy['wpscan-api'] ) {
$details .= '<p>WPScan API URL: ' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_list(
'<code>',
'</code>',
array( VIPGOCI_WPSCAN_API_BASE_URL ),
'None'
);
$details .= '</p>';
foreach (
array(
'wpscan-api-paths' => 'Directories scanned',
'wpscan-api-skip-folders' => 'Directories not scanned',
'wpscan-api-plugin-file-extensions' => 'Scan added/modified plugins based on headers present in files with file extensions',
'wpscan-api-theme-file-extensions' => 'Scan added/modified themes based on headers present in files with file extensions',
) as $key => $value
) {
$details .= '<p>' . vipgoci_output_html_escape( $value ) . ':</p>' . PHP_EOL;
$details .= '<ul>' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_list(
'<li><code>',
'</code></li>',
$options_copy[ $key ],
'<li>None</li>'
);
$details .= '</ul>' . PHP_EOL;
}
}
return $details;
}
/**
* Create scan report detail message for
* SVG configuration section.
*
* @param array $options_copy Options needed.
*
* @return string Detail message for section.
*/
function vipgoci_report_create_scan_details_svg_configuration(
array $options_copy
) :string {
$details = '<h4>SVG configuration</h4>' . PHP_EOL;
$details .= '<p>SVG scanning enabled: ' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_list(
'<code>',
'</code>',
$options_copy['svg-checks'],
'None'
);
$details .= '</p>';
if ( true === $options_copy['svg-checks'] ) {
$details .= '<p>Scan added/modified files with file extensions:</p>' . PHP_EOL;
$details .= '<ul>' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_list(
'<li><code>',
'</code></li>',
$options_copy['svg-file-extensions'],
'<li>None</li>'
);
$details .= '</ul>' . PHP_EOL;
}
return $details;
}
/**
* Create scan report detail message for
* auto-approval configuration section.
*
* @param array $options_copy Options needed.
*
* @return string Detail message for section.
*/
function vipgoci_report_create_scan_details_auto_approve_configuration(
array $options_copy
) :string {
$details = '<h4>Auto-approval configuration</h4>' . PHP_EOL;
foreach (
array(
'autoapprove' => 'Auto-approvals enabled',
'autoapprove-php-nonfunctional-changes' => 'Non-functional changes auto-approved',
'autoapprove-php-nonfunctional-changes-file-extensions' => 'Files with file extensions to consider for non-functional change auto-approval',
) as $key => $value
) {
if (
( false === $options_copy['autoapprove'] ) &&
( 'autoapprove' !== $key )
) {
continue;
}
$details .= '<p>' . vipgoci_output_html_escape( $value ) . ':' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_list(
'<code>',
'</code>',
$options_copy[ $key ],
'None'
);
$details .= '</p>';
}
if ( true === $options_copy['autoapprove'] ) {
$details .= '<p>Auto-approved file-types:</p>' . PHP_EOL;
$details .= '<ul>' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_list(
'<li><code>',
'</code></li>',
$options_copy['autoapprove-filetypes'],
'<li>None</li>',
''
);
$details .= '</ul>' . PHP_EOL;
}
return $details;
}
/**
* Create scan report detail message.
*
* Information is either gathered or
* based on $options_copy.
*
* @param array $options_copy Options needed.
*
* @return string Detail message.
*
* @codeCoverageIgnore
*/
function vipgoci_report_create_scan_details(
array $options_copy
) :string {
$details = PHP_EOL . VIPGOCI_IRC_IGNORE_STRING_START . PHP_EOL;
$details .= '<details>' . PHP_EOL;
$details .= '<hr />' . PHP_EOL;
$details .= '<summary>Scan run detail</summary>' . PHP_EOL;
$details .= '<table>' . PHP_EOL;
$details .= '<tr>' . PHP_EOL;
$details .= '<td valign="top" width="40%">';
$details .= vipgoci_report_create_scan_details_software_versions( $options_copy );
$details .= '</td>' . PHP_EOL;
$details .= '<td valign="top" width="30%">' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_php_lint_options( $options_copy );
$details .= vipgoci_report_create_scan_details_svg_configuration( $options_copy );
$details .= vipgoci_report_create_scan_details_auto_approve_configuration( $options_copy );
$details .= '</td>' . PHP_EOL;
$details .= '<td valign="top" width="30%">' . PHP_EOL;
$details .= vipgoci_report_create_scan_details_phpcs_configuration( $options_copy );
$details .= vipgoci_report_create_scan_details_wpscan_configuration( $options_copy );
$details .= '</td>' . PHP_EOL;
$details .= '</tr>' . PHP_EOL;
$details .= '</table>' . PHP_EOL;
$details .= '</details>' . PHP_EOL;
$details .= PHP_EOL . VIPGOCI_IRC_IGNORE_STRING_END . PHP_EOL;
return $details;
}
/**
* Record if GitHub results have been submitted to a
* pull request. Recording once that it has been done
* will ensure it stays like that even if set to false later.
* Will return the current state when called with $feedback_submitted
* parameter as null. Default state, when nothing has
* been recorded, is that nothing has been submitted.
*
* @param string $repo_owner Repository owner.
* @param string $repo_name Repository name.
* @param int $pr_number Pull request number.
* @param null|bool $feedback_submitted Feedback submitted.
*
* @return bool True if feedback has been submitted at any time, else false.
*/
function vipgoci_report_feedback_to_github_was_submitted(
string $repo_owner,
string $repo_name,
int $pr_number,
null|bool $feedback_submitted = null
) {
static $data_has_been_submitted = array();
switch ( $feedback_submitted ) {
case true:
$data_has_been_submitted[ $repo_owner ][ $repo_name ][ $pr_number ] = true;
break;
case false:
case null:
if ( ! isset( $data_has_been_submitted[ $repo_owner ][ $repo_name ][ $pr_number ] ) ) {
$data_has_been_submitted[ $repo_owner ][ $repo_name ][ $pr_number ] = false;
}
break;
}
return $data_has_been_submitted[ $repo_owner ][ $repo_name ][ $pr_number ];
}
/**
* Checks if any results have been submitted, and if not,
* submits a message about no issues having been found.
*
* @param string $repo_owner Repository owner.
* @param string $repo_name Repository name.
* @param string $github_token GitHub access token to use.
* @param string $commit_id Commit-ID of current commit.
* @param array $prs_implicated Pull requests implicated.
* @param string $informational_msg Informational message for end-users.
* @param string $scan_details_msg Details of scan message for end-users.
*
* @return void
*/
function vipgoci_report_maybe_no_issues_found(
string $repo_owner,
string $repo_name,
string $github_token,
string $commit_id,
array $prs_implicated,
string $informational_msg,
string $scan_details_msg
) :void {
vipgoci_log(
'Maybe posting a generic comment to PRs implicated about no issues found',
array(
'pr_numbers' => array_column(
$prs_implicated,
'number'
),
)
);
foreach ( $prs_implicated as $pr_item ) {
if ( true === vipgoci_report_feedback_to_github_was_submitted(
$repo_owner,
$repo_name,
$pr_item->number
) ) {
// Results were submitted, so do nothing.
continue;
}
$pr_reviews_commented = vipgoci_github_pr_reviews_get(
$repo_owner,
$repo_name,
$pr_item->number,
$github_token,
array(
'login' => 'myself',
'state' => array( 'COMMENTED', 'CHANGES_REQUESTED' ),
)
);
if ( empty( $pr_reviews_commented ) ) {
$no_issues_msg = VIPGOCI_NO_ISSUES_FOUND_MSG_AND_NO_REVIEWS;
} else {
$no_issues_msg = VIPGOCI_NO_ISSUES_FOUND_MSG_AND_EXISTING_REVIEWS;
}
$no_issues_msg .= ' (commit-ID: ' . $commit_id . ')';
/*
* If we have informational message, append it.
*/
if ( ! empty( $informational_msg ) ) {
$no_issues_msg .= PHP_EOL . PHP_EOL;
vipgoci_markdown_comment_add_pagebreak(
$no_issues_msg
);
$no_issues_msg .= $informational_msg . "\n\r";
}
/*
* Append scan details message if we have that
* along with a pagebreak.
*/
if ( ! empty( $scan_details_msg ) ) {
$no_issues_msg .= PHP_EOL . PHP_EOL;
vipgoci_markdown_comment_add_pagebreak(
$no_issues_msg
);
$no_issues_msg .= $scan_details_msg;
}
vipgoci_github_pr_comments_generic_submit(
$repo_owner,
$repo_name,
$github_token,
$pr_item->number,
$no_issues_msg,
null // We include commit-ID manually.
);
}
}
/**
* Formats and submits one or more generic pull request comments to GitHub,
* reporting any issues found within $results, if any relevant issues were
* found.
*
* @param string $repo_owner Repository owner.
* @param string $repo_name Repository name.
* @param string $github_token GitHub token to use to make GitHub API requests.
* @param string $commit_id Commit-ID of current commit.
* @param array $results Results of scanning.
* @param array $pr_ids IDs of pull requests implicated.
* @param string $informational_msg Informational message for end-users.
* @param string $scan_details_msg Details of scan message for end-users.
* @param string $wpscan_api_report_end_msg Message to append to end of WPScan API report.
* @param bool $wpscan_api_dry_mode If WPScan API dry mode is enabled.
* @param string $name_to_use Name to use in reports to identify the bot.
*
* @return void
*/
function vipgoci_report_submit_pr_generic_comment_from_results(
string $repo_owner,
string $repo_name,
string $github_token,
string $commit_id,
array $results,
array $pr_ids,
string $informational_msg,
string $scan_details_msg,
string $wpscan_api_report_end_msg,
bool $wpscan_api_dry_mode,
string $name_to_use,
) :void {
vipgoci_log(
'About to submit generic PR comment to GitHub about issues',
array(
'repo_owner' => $repo_owner,
'repo_name' => $repo_name,
'commit_id' => $commit_id,
'pr_ids' => $pr_ids,
'informational_msg' => $informational_msg,
'scan_details_msg' => $scan_details_msg,
'wpscan_api_report_end_msg' => $wpscan_api_report_end_msg,
'wpscan_api_dry_mode' => $wpscan_api_dry_mode,
'name_to_use' => $name_to_use,
)
);
foreach (
// The $results['issues'] array is keyed by pull request number.
array_keys(
$results['issues']
) as $pr_number
) {
// Construct URL to GitHub API to post comment.
$github_url =
VIPGOCI_GITHUB_BASE_URL . '/' .
'repos/' .
rawurlencode( $repo_owner ) . '/' .
rawurlencode( $repo_name ) . '/' .
'issues/' .
rawurlencode( (string) $pr_number ) . '/' .
'comments';
/*
* Array for postfields; one key/value for PHP lint
* results, two for WPScan API results
* (plugins and themes).
*/
$postfields_bodies = array(
'lint_body' => '',
'wpscan_api_plugins_body' => '',
'wpscan_api_themes_body' => '',
);
/*
* Loop through issues found for the current pull request.
*/
foreach (
$results['issues'][ $pr_number ]
as $commit_issue
) {
$commit_issue['type'] = strtolower(
$commit_issue['type']
);
if ( ! in_array(
$commit_issue['type'],
array(
VIPGOCI_STATS_LINT,
VIPGOCI_STATS_WPSCAN_API,
),
true
) ) {
// Not an issue we process, ignore.
continue;
}
if ( VIPGOCI_STATS_LINT === $commit_issue['type'] ) {
/*
* Construct comment for PHP linting.
*/
if ( '' !== $postfields_bodies['lint_body'] ) {
/*
* Put in linebreaks.
*/
$postfields_bodies['lint_body'] .= "\n\r";
vipgoci_markdown_comment_add_pagebreak(
$postfields_bodies['lint_body']
);
}
$postfields_bodies['lint_body'] .=
vipgoci_lint_report_comment_format_result(
$repo_owner,
$repo_name,
$commit_id,
$commit_issue['file_name'],
$commit_issue['file_line'],
$commit_issue['issue']['level'],
$commit_issue['issue']['message']
);
} elseif ( VIPGOCI_STATS_WPSCAN_API === $commit_issue['type'] ) {
/*
* Determine key based on addon_type;
* either VIPGOCI_ADDON_PLUGIN or VIPGOCI_ADDON_THEME.
*/
if ( VIPGOCI_ADDON_PLUGIN === $commit_issue['issue']['addon_type'] ) {
$postfields_key = 'wpscan_api_plugins_body';
} elseif ( VIPGOCI_ADDON_THEME === $commit_issue['issue']['addon_type'] ) {
$postfields_key = 'wpscan_api_themes_body';
}
/*
* Submit comment for WPScan API result.
*/
$postfields_bodies[ $postfields_key ] .=
vipgoci_wpscan_report_comment_format_result(
$repo_owner,
$repo_name,
$commit_id,
$commit_issue['issue'],
$commit_issue['issue']['addon_type'],
$pr_ids,
$wpscan_api_dry_mode
);
vipgoci_markdown_comment_add_pagebreak(
$postfields_bodies[ $postfields_key ]
);
}
}
/*
* Loop through each postfield variable. If anything is to be
* reported add template for each and submit results to the
* GitHub API.
*/
foreach (
array_keys( $postfields_bodies ) as $key
) {
if ( '' === $postfields_bodies[ $key ] ) {
continue;
}
if ( 'lint_body' === $key ) {
$postfields_body_start = vipgoci_lint_report_comment_start(
$repo_owner,
$repo_name,
$commit_id,
$name_to_use
);
$postfields_body_end = '';
} elseif ( 'wpscan_api_plugins_body' === $key ) {
$postfields_body_start = vipgoci_wpscan_report_start(
VIPGOCI_ADDON_PLUGIN,
$name_to_use
);
$postfields_body_end = vipgoci_wpscan_report_end(
VIPGOCI_ADDON_PLUGIN,
$wpscan_api_report_end_msg
);
} elseif ( 'wpscan_api_themes_body' === $key ) {
$postfields_body_start = vipgoci_wpscan_report_start(
VIPGOCI_ADDON_THEME,
$name_to_use
);
$postfields_body_end = vipgoci_wpscan_report_end(
VIPGOCI_ADDON_THEME,
$wpscan_api_report_end_msg
);
}
/*
* Construct final postfield body.
*/
$github_postfields = array(
'body' => $postfields_body_start .
$postfields_bodies[ $key ] .
$postfields_body_end,
);
unset( $postfields_body_start );
unset( $postfields_body_end );
vipgoci_markdown_comment_add_pagebreak(
$github_postfields['body']
);
/*
* If we have informational URL, append that.
*/
if ( ! empty( $informational_msg ) ) {
$github_postfields['body'] .=
$informational_msg .
"\n\r";
}
/*
* Append scan details message if we have that.
*/
if ( ! empty( $scan_details_msg ) ) {
$github_postfields['body'] .= $scan_details_msg;
}
// Post to GitHub API.
vipgoci_http_api_post_url(
$github_url,
$github_postfields,
$github_token
);
// Indicate internally that feedback was submitted.
vipgoci_report_feedback_to_github_was_submitted(
$repo_owner,
$repo_name,
$pr_number,
true
);
unset( $github_postfields );
}
}
}
/**
* Submit a review on GitHub for a particular commit,
* and pull-request using the access-token provided.
*
* @param string $repo_owner Repository owner.
* @param string $repo_name Repository name.
* @param string $github_token GitHub token to use to make GitHub API requests.
* @param string $commit_id Commit-ID of current commit.
* @param array $results Results of scanning.
* @param string $informational_msg Informational message for end-users.
* @param string $scan_details_msg Details of scan message for end-users.
* @param int $github_review_comments_max How many comments to submit in each GitHub review.
* @param bool $github_review_comments_include_severity If to include severity in GitHub review comments.
* @param int $skip_large_files_limit The maximum number of lines of files we scan.
* @param string $name_to_use Name to use in reports to identify the bot.
*
* @return void
*/
function vipgoci_report_submit_pr_review_from_results(
string $repo_owner,
string $repo_name,
string $github_token,
string $commit_id,
array $results,
string $informational_msg,
string $scan_details_msg,
int $github_review_comments_max,
bool $github_review_comments_include_severity,
int $skip_large_files_limit,
string $name_to_use
) :void {
$stats_types_to_process = array(
VIPGOCI_STATS_PHPCS,
);
vipgoci_log(
'About to submit review and comment(s) to GitHub about issue(s)',
array(
'repo_owner' => $repo_owner,
'repo_name' => $repo_name,
'commit_id' => $commit_id,
)
);
/*
* Reverse results before starting processing,
* so that results are shown in correct order
* after posting.
*/
foreach (
array_keys(
$results['issues']
) as $pr_number
) {
$results['issues'][ $pr_number ] = array_reverse(
$results['issues'][ $pr_number ]
);
}
foreach (
// The $results array is keyed by pull request number.
array_keys(