forked from backdrop-contrib/coder_review
-
Notifications
You must be signed in to change notification settings - Fork 0
/
coder_review.common.inc
1765 lines (1641 loc) · 55 KB
/
coder_review.common.inc
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
/**
* @file
* Common functions used by both the drush and form interfaces.
*/
/**
* Specifies the Minor severity level.
*/
define('SEVERITY_MINOR', 1);
/**
* Specifies the Normal severity level.
*/
define('SEVERITY_NORMAL', 5);
/**
* Specifies the Critical severity level.
*/
define('SEVERITY_CRITICAL', 9);
/**
* Creates a list of all modules that implement hook_reviews().
*
* @return array
* An array of return values of the from hook_reviews() implementations.
*/
function _coder_review_reviews() {
static $cache = array();
if (!$cache) {
// Always get the coder review.
$cache = coder_review_reviews();
// When Backdrop is bootstrapped, also get all reviews.
if (function_exists('module_invoke_all')) {
$cache = array_merge($cache, module_invoke_all('reviews'));
}
}
return $cache;
}
/**
* Implements hook_reviews().
*
* This creates an array of all of the reviews that are implemented by the
* coder_review module.
*
* @see hook_reviews()
*
* @todo Add an abbreviated explanation of what is coder_review.api.php.
*/
function coder_review_reviews() {
static $cache = array();
if (!$cache) {
$path = _coder_review_file_path() . '/includes';
foreach (scandir($path) as $file) {
$pathinfo = pathinfo("$path/$file");
if ($pathinfo['extension'] == 'inc') {
require_once "$path/$file";
$function = $pathinfo['filename'] . '_reviews';
if (function_exists($function)) {
$review = $function();
if ($review) {
foreach (array_keys($review) as $review_name) {
$review[$review_name]['#file'] = "$path/$file";
}
$cache += $review;
}
}
}
}
}
return $cache;
}
/**
* Returns a default list of reviews to perform a coder_review analysis upon.
*
* @return array
* An associative array with keys set to the names of the reviews to perform.
* The values are set to ???
*
* @see _coder_review_get_default_settings()
*/
function _coder_review_default_reviews() {
// Do not use backdrop_map_assoc() so that this will run without Backdrop
// being bootstraped.
return array(
'style' => 'style',
'sql' => 'sql',
'comment' => 'comment',
'security' => 'security',
'i18n' => 'i18n',
'sniffer' => 'sniffer',
);
}
/**
* Creates a list of required filename extensions the included in default list.
*
* @param array $defaults
* An array of default filename extensions.
* @param array $reviews
* An array of available coder reviews.
*
* @return array
* An array of file extensions, which are required to perform any of the
* reviews, but arenot part of the default filename extension list.
*
* @see coder_review_page_form()
* @see coder_review_test_case.tinc::runTest()
*/
function _coder_review_get_reviews_extensions(array $defaults, array $reviews) {
$extensions = array();
foreach ($reviews as $key => $review) {
foreach ($review['#rules'] as $rule) {
if (isset($rule['#filename'])) {
foreach ($rule['#filename'] as $ext) {
if (!in_array($ext, $defaults) && !in_array($ext, $extensions)) {
$extensions[] = $ext;
}
}
}
}
}
return $extensions;
}
/**
* Determines most recent modification timestamp of key coder_review code files.
*
* @return int
* A Unix timestamp that represents the latest time that any of the key code
* files that are part of the coder_review module was modified.
*/
function _coder_review_modified() {
static $cached_mtime = 0;
if (!$cached_mtime) {
// Create a list of all files whose timestamps are worth checking.
$files[] = _coder_review_file_path() . '/coder_review.module';
$files[] = _coder_review_file_path() . '/coder_review.common.inc';
foreach (coder_review_reviews() as $review) {
$files[] = $review['#file'];
}
// Find the newest filetime.
foreach ($files as $file) {
$mtime = filemtime($file);
if ($mtime > $cached_mtime) {
$cached_mtime = $mtime;
}
}
}
return $cached_mtime;
}
/**
* Performs coder reviews for multiple code review definition files.
*
* @param array $coder_args
* An associative array of coder arguments. The valid arguments are:
* - #reviews => An array list of reviews to perform. For more information,
* see _coder_review_reviews().
* - #severity => An integer magic number. See the constants SEVERITY_*, as
* defined at the top of coder_review.common.inc.
* - #filename => A string with the filename to check.
* - #patch => A string with the patch lines to perform a review on.
*
* @return array
* An associative array of results, in the form:
* - #stats => An array with error counts for all severities, in the form:
* - 'minor' => An integer count.
* - 'normal' => An integer count.
* - 'critical' => An integer count.
* - integer ID => An HTML error message string for display.
*
* @see _coder_review_reviews()
*/
function do_coder_reviews(array $coder_args) {
// Load the cached results if they exist, but not for patches.
if (empty($coder_args['#patch']) && empty($coder_args['#test']) && $coder_args['#cache']) {
// @todo Replace md5() with with sha256(). See [#723802] for more info.
$cache_key = 'coder:' . md5(implode(':', array_keys($coder_args['#reviews']))) . $coder_args['#severity'] . ':' . $coder_args['#filename'];
if (_drush()) {
if (drush_get_option('checkstyle')) {
$cache_key .= ':drushcheckstyle';
}
elseif (drush_get_option('xml')) {
$cache_key .= ':drushxml';
}
}
$filepath = realpath($coder_args['#filename']);
if (file_exists($filepath)) {
$cache_mtime = filemtime($filepath);
$cache_results = _cache_get($cache_key, 'cache_coder');
if ($cache_results && $cache_results->data['mtime'] == $cache_mtime && _coder_review_modified() < $cache_results->created) {
return $cache_results->data['results'];
}
}
}
$results['#stats'] = array(
'minor' => 0,
'normal' => 0,
'critical' => 0,
'ignored' => 0,
);
// Skip PHP include files when the user requested severity is above minor.
if (isset($coder_args['#php_minor']) && _substr($coder_args['#filename'], -4) == '.php') {
if ($coder_args['#severity'] > 1) {
return $results;
}
}
// Read the file.
if (_coder_review_read_and_parse_file($coder_args)) {
// Do all of the code reviews.
$errors = array();
foreach ($coder_args['#reviews'] as $review_name => $review) {
$review['#review_name'] = $review_name;
$result = do_coder_review($coder_args, $review);
if ($result) {
// Keep track of severity and "ignored" statistics.
foreach (array('critical', 'normal', 'minor', 'ignored') as $severity_level) {
if (isset($result['#stats'][$severity_level])) {
$results['#stats'][$severity_level] += $result['#stats'][$severity_level];
}
}
$errors += $result;
}
}
// Theme the error messages.
foreach ($errors as $key => $error) {
if (is_numeric($key)) {
$error['warning'] = _coder_review_warning($error['rule']);
$results[$key] = theme_coder_review_warning($error);
}
}
// Sort the results.
ksort($results, SORT_NUMERIC);
}
else {
$results[] = theme('coder_review_warning', array('warning' => _t('Could not read the file'), 'severity_name' => 'critical'));
}
// Save the results in the cache if we're not reviewing a patch.
if (empty($coder_args['#patch']) && empty($coder_args['#test']) && $coder_args['#cache'] && isset($cache_mtime)) {
$cache_results = array(
'mtime' => $cache_mtime,
'results' => $results,
);
_cache_set($cache_key, $cache_results, 'cache_coder');
}
return $results;
}
/**
* Returns HTML for a coder_review warning to be included in results.
*
* @param array $variables
* An associative array, which includes the following keys:
* - warning: Either summary warning description, or an array in format:
* - #warning: A summary warning description.
* - #description: A detailed warning description.
* - #link: A link to an explanatory document.
* - severity_name: The severity name as a string.
* - lineno: An integer line number on which error was detected.
* - line: A string with the contents of line.
* - review_name: A string with the review name.
* - rule_name: A string with the rule name.
*
* @ingroup themeable
*/
function theme_coder_review_warning($variables) {
// Theme the output for the Backdrop shell.
if (_drush()) {
return theme_drush_coder_review_warning($variables);
}
$warning = $variables['warning'];
$severity_name = $variables['severity_name'];
$review_name = $variables['review_name'];
$rule_name = $variables['rule_name'];
$lineno = $variables['lineno'];
$line = $variables['line'];
// Extract description from warning.
if (is_array($warning)) {
$description = isset($warning['#description']) ? _t($warning['#description']) : '';
if (isset($warning['#warning'])) {
$warning_msg = _t($warning['#warning']);
}
elseif (isset($warning['#text'])) {
$warning += array('#args' => array());
$warning_msg = _t($warning['#text'], $warning['#args']);
}
if (isset($warning['#link'])) {
$warning_msg .= ' (' . l(_t('Backdrop Docs'), $warning['#link']) . ')';
}
$warning = $warning_msg;
}
if ($lineno) {
if ($lineno > 0) {
$warning = _t('Line @number: !warning [@review_@rule]', array(
'@number' => $lineno,
'!warning' => $warning,
'@review' => $review_name,
'@rule' => $rule_name,
));
}
else {
$warning = _t('File: !warning [@review_@rule]', array(
'!warning' => $warning,
'@review' => $review_name,
'@rule' => $rule_name,
));
}
if ($line) {
$warning .= '<pre>' . check_plain($line) . '</pre>';
}
}
// Add informative images and classes to the output.
$class = 'coder-warning';
if ($severity_name) {
$class .= " coder-$severity_name";
}
$path = _coder_review_path();
$title = _t('severity: @severity', array('@severity' => $severity_name));
$img = theme('image', array(
'uri' => $path . "/images/$severity_name.png",
'alt' => $title,
'title' => $title,
'attributes' => array('align' => 'right', 'class' => 'coder'),
'getsize' => FALSE,
));
$avail_reviews = _coder_review_reviews();
if (isset($avail_reviews[$review_name]['#image'])) {
$title = _t('review: @review_@rule', array('@review' => $review_name, '@rule' => $rule_name));
$review_image = $avail_reviews[$review_name]['#image'];
$img .= theme('image', array(
'uri' => (substr($review_image, 0, 7) == 'images/' ? "$path/" : '') . $review_image,
'alt' => $title,
'title' => $title,
'attributes' => array('align' => 'right', 'class' => 'coder-review'),
'getsize' => FALSE,
));
}
if (!empty($description)) {
$img .= theme('image', array(
'uri' => $path . '/images/more.png',
'alt' => t('click to read more'),
'atributes' => array('align' => 'right', 'class' => 'coder-more'),
'getsize' => FALSE,
));
$warning .= '<div class="coder-description">' . t('Explanation: @description', array('@description' => $description)) . '</div>';
}
return '<div class="' . $class . '">' . $img . $warning . '</div>';
}
/**
* Parses and reads source files into a format for easier review validation.
*
* For each source file, the following file lines of code (with trailing
* newlines) will be added to the Coder arguments array:
* - #all_array_lines:
* - #all_lines:
* - #allphp_array_lines:
* - #comment_array_lines:
* - #doublequote_array_lines:
* - #html_array_lines:
* - #php_array_lines:
* - #quote_array_lines:
*
* The _array_ variants are multidimensional arrays, the first index for the
* line number, and the second index for each occurance within the line.
* #all_lines is a simple array, with each line from the source file as an
* index.
*
* @param array $coder_args
* A Coder arguments array, passed by reference.
*
* @return int
* Integer 1 if success.
*/
function _coder_review_read_and_parse_file(array &$coder_args) {
// Determine the file extension type.
// Set all allowed PHP extensions to 'php'.
$pathinfo = pathinfo($coder_args['#filename']);
$allowed_extensions = array_merge(
$coder_args['#php_extensions'],
$coder_args['#include_extensions'],
array('module', 'theme')
);
// If the file extension is any of the allowed extensions (other than 'js')
// then set $ext to 'php', otherwise use the actual extension.
$ext = in_array($pathinfo['extension'], array_diff($allowed_extensions, array('js'))) ? 'php' : $pathinfo['extension'];
/* The use of variables with 'php' in them ($in_php, $in_all_php, $php_lines,
* etc.) is misleading. All references to such should be renamed 'code'
* because we also are using this engine to read 'js' files.
*/
// Get the path to the module file.
$filepath = realpath($coder_args['#filename']);
if (!empty($coder_args['#patch']) || !empty($coder_args['#test']) || file_exists($filepath)) {
$in_php = ($ext == 'js') ? 1 : 0;
$in_allphp = $in_php;
$in_comment = 0;
if (!empty($coder_args['#patch'])) {
$content = $coder_args['#patch'];
if (preg_match('/^\s*\*/', $content)) {
$in_comment = '*';
}
else {
$content = preg_replace('/^(function\s.*?(\r\n|\n)+)(\s*\*)/', '${1}/*', $content);
$in_php = 1;
$in_allphp = 1;
}
}
elseif (!empty($coder_args['#test'])) {
$content = $coder_args['#test'];
$in_php = 1;
$in_allphp = 1;
}
else {
$content = file_get_contents($filepath);
}
$content .= "\n";
$content_length = strlen($content);
$in_comment = 0;
$in_quote_html = 0;
$in_backslash = 0;
$in_quote = 0;
$in_heredoc = 0;
$in_heredoc_length = 0;
$in_heredoc_html = '';
$beginning_of_line = 0;
$this_all_lines = '';
$this_php_lines = '';
$this_allphp_lines = '';
$this_html_lines = '';
$this_quote_lines = array('');
$this_quote_index = -1;
$this_quote_sep = FALSE;
$this_doublequote_lines = array('');
$this_doublequote_index = -1;
$this_comment_lines = '';
// Parse the file:
// - Strip comments,
// - Strip quote content,
// - Strip stuff not in php,
// - Break into lines.
$lineno = 1;
for ($pos = 0; $pos < $content_length; ++$pos) {
// Get the current character.
$char = $content[$pos];
// Look ahead to the next character, to cater for \r\n line ends.
$next_char = isset($content[$pos + 1]) ? $content[$pos + 1] : '';
if ($char == "\n" || $char . $next_char == "\r\n") {
// End C++ style comments on newline.
if ($in_comment === '/' || $in_comment === '#') {
$in_comment = 0;
}
// Assume that html inside quotes doesn't span newlines.
$in_quote_html = 0;
// Remove coder's simpletests assertions as they validly contain bad
// code, for testing the review rules.
if (preg_match('/assertCoderReview(Fail|Pass)/', $this_all_lines)) {
++$lineno;
$this_all_lines = '';
$this_php_lines = '';
$this_allphp_lines = '';
$this_html_lines = '';
$this_comment_lines = '';
$this_quote_lines = array('');
continue;
}
// Remove blank lines now, so we avoid processing them over-and-over.
if ($this_all_lines != '') {
if (trim($this_all_lines, "\r\n") != '') {
$all_lines[$lineno] = array($this_all_lines);
$full_lines[$lineno] = $this_all_lines;
}
if (trim($this_php_lines, "\r\n") != '') {
$php_lines[$lineno] = array($this_php_lines);
}
if (trim($this_allphp_lines, "\r\n") != '') {
$allphp_lines[$lineno] = array($this_allphp_lines);
}
if (trim($this_html_lines, "\r\n") != '') {
$html_lines[$lineno] = array($this_html_lines);
}
$quotes = array();
foreach ($this_quote_lines as $quote_line) {
if (trim($quote_line, "\r\n") != '') {
$quotes[] = $quote_line;
}
}
if ($quotes) {
$quote_lines[$lineno] = $quotes;
}
$quotes = array();
foreach ($this_doublequote_lines as $quote_line) {
if (trim($quote_line, "\r\n") != '') {
$quotes[] = $quote_line;
}
}
if ($quotes) {
$doublequote_lines[$lineno] = $quotes;
}
if (trim($this_comment_lines, "\r\n") != '') {
$comment_lines[$lineno] = array($this_comment_lines);
}
}
// Increment $pos by an extra one if the newline was indicated by the
// two-character CRLF 'carriage return line feed'.
$pos += ($char . $next_char == "\r\n");
// Save this line and start a new line.
++$lineno;
$this_all_lines = '';
$this_php_lines = '';
$this_allphp_lines = '';
$this_html_lines = '';
$this_quote_lines = array('');
$this_doublequote_lines = array('');
$this_quote_index = -1;
$this_quote_sep = FALSE;
$this_doublequote_index = -1;
$this_comment_lines = '';
$beginning_of_line = 1;
continue;
}
if ($this_all_lines != '') {
$beginning_of_line = 0;
}
$this_all_lines .= $char;
if ($in_php || $in_allphp) {
// When in a quoted string, look for the trailing quote; strip the
// characters in the string and replace with '' or "".
if ($in_quote) {
if ($in_backslash) {
$in_backslash = 0;
}
elseif ($char == '\\') {
$in_backslash = 1;
}
elseif ($char == $in_quote && !$in_backslash) {
$in_quote = 0;
}
elseif ($char == '<') {
$in_quote_html = '>';
}
if ($in_quote) {
if ($this_quote_index == -1) {
$this_quote_index = 0;
}
$this_quote_lines[$this_quote_index] .= $char;
if ($in_quote == '"') {
if ($this_doublequote_index == -1) {
$this_doublequote_index = 0;
}
$this_doublequote_lines[$this_doublequote_index] .= $char;
}
if ($in_quote_html) {
$this_html_lines .= $char;
}
}
if ($char == $in_quote_html) {
$in_quote_html = 0;
}
$this_allphp_lines .= $char;
// @note: Trailing char output with starting one.
unset($char);
}
elseif ($in_heredoc) {
// @note: backdrop_substr does not properly handle multi-byte
// characters in this string.
// @todo: check other places where the backdrop_ string functions
// fail.
if ($beginning_of_line && $char == $in_heredoc[0] && substr($content, $pos, $in_heredoc_length) == $in_heredoc) {
$this_all_lines .= _substr($content, $pos + 1, $in_heredoc_length - 1);
$in_heredoc = 0;
$pos += $in_heredoc_length;
}
elseif ($char == '<') {
$in_heredoc_html = '>';
}
if ($in_heredoc && $in_heredoc_html) {
$this_html_lines .= $char;
}
if ($in_heredoc_html && $char == $in_heredoc_html) {
$in_heredoc_html = '';
}
unset($char);
}
// Look for the ending php tag.
elseif ($ext == 'php' && $char == '?' && $content[$pos + 1] == '>' && $in_comment !== '*') {
unset($char);
$in_php = 0;
$in_allphp = 0;
$this_all_lines .= '>';
++$pos;
}
// When in a comment, look for the trailing comment.
elseif ($in_comment) {
$this_comment_lines .= $char;
if ($in_comment == '*' && $char == '*' && $content[$pos + 1] == '/') {
$in_comment = 0;
$this_all_lines .= '/';
$this_comment_lines .= '/';
++$pos;
}
// Do not add comments to php output.
unset($char);
}
else {
switch ($char) {
case ',':
case ')':
case '(':
// For 'foo' => 'bar' type syntax.
case '>':
case ':':
// Look for separators which force a new quote string.
if ($this_quote_index < 0 || !empty($this_quote_lines[$this_quote_index])) {
$this_quote_sep = TRUE;
}
break;
case '\'':
case '"':
// If the previous char is a backslash then we have not found the
// ending-quote as this one is internal to the string. Keep going.
if ($pos == 0 || $content[$pos - 1] != '\\') {
$this_php_lines .= $char;
$in_quote = $char;
if ($this_quote_sep) {
$this_quote_lines[++$this_quote_index] = '';
if ($char == '"') {
$this_doublequote_lines[++$this_doublequote_index] = '';
}
}
$this_quote_sep = FALSE;
}
break;
case '#':
$this_comment_lines .= $char;
$in_comment = $char;
unset($char);
break;
case '/':
$next_char = $content[$pos + 1];
if ($next_char == '/' || $next_char == '*') {
unset($char);
$in_comment = $next_char;
$this_all_lines .= $next_char;
$this_comment_lines .= '/' . $next_char;
++$pos;
}
break;
case '<':
if ($content[$pos + 1] == '<' && $content[$pos + 2] == '<') {
unset($char);
$this_all_lines .= '<<';
// Get the heredoc word.
// Read until the end-of-line.
$heredoc = '';
for ($pos += 3; $pos < $content_length; ++$pos) {
$char = $content[$pos];
if ($char == "\n") {
$pos--;
if (preg_match('/^\s*(\w+)/', $heredoc, $match)) {
$in_heredoc = $match[1];
$in_heredoc_length = _strlen($in_heredoc);
}
break;
}
$this_all_lines .= $char;
$heredoc .= $char;
}
// Replace heredoc's with an empty string.
$this_php_lines .= '\'\'';
$this_allphp_lines .= '\'\'';
unset($char);
}
break;
}
}
if (isset($char)) {
$this_php_lines .= $char;
$this_allphp_lines .= $char;
}
}
else {
switch ($char) {
case '<':
if ($ext == 'php' && $content[$pos + 1] == '?') {
if ($content[$pos + 2] == ' ') {
$in_php = 1;
$in_allphp = 1;
$this_all_lines .= '? ';
$pos += 2;
}
elseif (_substr($content, $pos + 2, 3) == 'php') {
$in_php = 1;
$in_allphp = 1;
$this_all_lines .= '?php';
$pos += 4;
}
break;
}
// Purposefully fall through.
default:
$this_html_lines .= $char;
break;
}
}
}
// Add the files lines to the arguments.
$coder_args['#all_array_lines'] = isset($all_lines) ? $all_lines : array();
$coder_args['#php_array_lines'] = isset($php_lines) ? $php_lines : array();
$coder_args['#allphp_array_lines'] = isset($allphp_lines) ? $allphp_lines : array();
$coder_args['#html_array_lines'] = isset($html_lines) ? $html_lines : array();
$coder_args['#quote_array_lines'] = isset($quote_lines) ? $quote_lines : array();
$coder_args['#doublequote_array_lines'] = isset($doublequote_lines) ? $doublequote_lines : array();
$coder_args['#comment_array_lines'] = isset($comment_lines) ? $comment_lines : array();
$coder_args['#all_lines'] = isset($full_lines) ? $full_lines : array();
$coder_args['#raw_contents'] = $content;
$coder_args['#num_lines'] = isset($full_lines) ? key(array_slice($full_lines, -1, 1, TRUE)) : 0;
// Given the sanitized PHP lines, determine the class and function for each
// line.
$stack = array();
$class_stack = $class_stack_paren = array();
$function_stack = $function_stack_paren = array();
$paren_depth = 0;
foreach ($coder_args['#php_array_lines'] as $lineno => $line_array) {
foreach ($line_array as $line) {
// Check if this line is the beginning of a function definition.
if (preg_match('/function (\w+)\s*\(/', $line, $match) && !preg_match('/;/', $line)) {
array_unshift($function_stack, $match[1]);
array_unshift($function_stack_paren, $paren_depth);
}
// Check if this line is the beginning of a class definition.
if (preg_match('/class (\w+)/', $line, $match) || preg_match('/interface (\w+)/', $line, $match)) {
array_unshift($class_stack, $match[1]);
array_unshift($class_stack_paren, $paren_depth);
}
// Check if this line changes the parenthesis depth.
if (preg_match_all('/([{}])/', $line, $match)) {
foreach ($match[0] as $paren_match) {
$paren_depth += ($paren_match == '{') ? 1 : -1;
}
// If the depth is now less than then current function depth, pop the
// function from the stack.
if ($function_stack_paren && $paren_depth <= $function_stack_paren[0]) {
array_shift($function_stack);
array_shift($function_stack_paren);
}
// If the depth is now less than the current class depth, pop the
// class from the stack.
if ($class_stack_paren && $paren_depth <= $class_stack_paren[0]) {
array_shift($class_stack);
array_shift($class_stack_paren);
}
}
// Cache the current function and class for each line of each file.
$stack[$lineno] = array($class_stack ? $class_stack[0] : '', $function_stack ? $function_stack[0] : '');
}
}
$coder_args['#stack'] = $stack;
// Read the coder warning directives in the comments.
foreach ($coder_args['#comment_array_lines'] as $lineno => $line_array) {
foreach ($line_array as $line) {
$pos = strpos($line, '@ignore ');
if ($pos !== FALSE && preg_match_all('/([\w:]+)[\s,]*/', _substr($line, $pos + 8), $matches)) {
foreach ($matches[1] as $ignore) {
list($rule_name, $scope) = explode(':', "$ignore:1");
if ($scope == 'file') {
// Find the end of the file.
$scope = $coder_args['#num_lines'] - $lineno;
}
elseif ($scope == 'class' || $scope == 'function') {
// What scope are we looking for?
// #stack is an array($class_name, $function_name).
$stack_index = $scope == 'class' ? 0 : 1;
// Find the current scope.
$current_scope = NULL;
foreach (array(0, 1) as $current_lineno) {
if (!empty($stack[$lineno + $current_lineno][$stack_index])) {
$current_scope = $stack[$lineno + $current_lineno][$stack_index];
break;
}
}
// Find the end of the class or function.
if ($current_scope) {
for ($scope = 1; !isset($stack[$lineno + $scope]) || $stack[$lineno + $scope][$stack_index] == $current_scope; ++$scope) {
if ($lineno + $scope > $coder_args['#num_lines']) {
break;
}
}
}
}
elseif ($scope == 'comment') {
// Find the next line that is not a comment.
for ($scope = 0; !empty($comment_lines[$lineno + $scope + 1]); ++$scope) {
}
}
if (is_numeric($scope)) {
for ($line_offset = 0; $line_offset <= $scope; ++$line_offset) {
$ignores[$lineno + $line_offset][$rule_name] = $rule_name;
}
}
}
}
}
}
$coder_args['#ignores'] = isset($ignores) && $coder_args['#settings_ignore'] ? $ignores : array();
return 1;
}
}
/**
* Determines the integer severity magic number for a severity string.
*
* @param string $severity_name
* The name of severity string, e.g., 'minor', 'normal', or 'critical'.
* @param int $default_value
* (optional) An integer magic number to use if severity string is not
* recognized. Defaults to SEVERITY_NORMAL.
*
* @return int
* An integer magic number, see SEVERITY_* constants.
*/
function _coder_review_severity($severity_name, $default_value = SEVERITY_NORMAL) {
// @note: Implemented this way in hopes that it is faster than a PHP switch.
static $severity_names = array();
if (!$severity_names) {
$severity_names = array(
'minor' => SEVERITY_MINOR,
'normal' => SEVERITY_NORMAL,
'critical' => SEVERITY_CRITICAL,
);
}
return isset($severity_names[$severity_name]) ? $severity_names[$severity_name] : $default_value;
}
/**
* Return string severity for a given error.
*
* @param array $coder_args
* A Coder settings array. See do_coder_reviews() for format information.
* @param array $review
* Review array that contains rule arrays. See hook_reviews() for details.
* @param array $rule
* Rule array that was triggered. See individual entries from hook_reviews().
*
* @return string
* A string describing the severity of the error.
*
* @see do_coder_reviews()
* @see hook_review()
*/
function _coder_review_severity_name(array $coder_args, array $review, array $rule) {
// NOTE: Warnings in php includes are suspicious because
// PHP includes are frequently 3rd party products.
if (isset($coder_args['#php_minor']) && _substr($coder_args['#filename'], -4) == '.php') {
return 'minor';
}
// Get the severity as defined by the rule.
if (isset($rule['#severity'])) {
return $rule['#severity'];
}
// If it's not defined in the rule, then it can be defined by the review.
if (isset($review['#severity'])) {
return $review['#severity'];
}
// Use the default.
return 'normal';
}
/**
* Performs a code review for a review array.
*
* @param array $coder_args
* An array of coder_review settings, which must have been prepared with
* _coder_review_read_and_parse_file(). See do_coder_reviews() for more
* information on the array format.
* @param array $review
* A review array. See hook_review() for format details.
*
* @return array
* An array of coder_review results. See do_coder_reviews() return value for
* more information on the format.
*
* @see do_coder_reviews()
* @see hook_review()
* @see _coder_review_read_and_parse_file()
*/
function do_coder_review(array $coder_args, array $review) {
$results = array(
'#stats' => array(
'minor' => 0,
'normal' => 0,
'critical' => 0,
'ignored' => 0,
),
);
$allowed_extensions = array_merge(
$coder_args['#php_extensions'],
$coder_args['#include_extensions'],
array('module', 'theme')
);
if (!empty($review['#js'])) {
$allowed_extensions[] = 'js';
}
if ($review['#rules']) {
// Get the review's severity, used when the rule severity is not defined.
$default_severity = isset($review['#severity']) ? _coder_review_severity($review['#severity']) : SEVERITY_NORMAL;
// Get filename of current file.
$filename = empty($coder_args['#patch']) ? $coder_args['#filename'] : 'coder_review.patch';
$is_patch = 0;
// Handle special case filename for patch files, if available.
if (!empty($coder_args['#patch']) && preg_match('/(.+?):/', $coder_args['#filename'], $matches)) {
$filename = empty($matches) ? 'coder_review.patch' : $matches[1];
$is_patch = 1;
}
foreach ($review['#rules'] as $rule_name => $rule) {
$rule += array(
'#rule_name' => $rule_name,
'#review_name' => $review['#review_name'],
);
// Ignore rules that don't match the file extension.
$filename_includes = isset($rule['#filename']) ? $rule['#filename'] : (isset($rule['#filename-not']) ? $allowed_extensions : NULL);
if ($filename_includes) {
$regex = '/(' . implode('|', $filename_includes) . ')$/i';
if (!preg_match($regex, $filename, $matches)) {
continue;
}
}
// Ignore rules that do match the file extension, javascript files are
// excluded by default.
$not = isset($rule['#filename-not']) ? $rule['#filename-not'] : (isset($rule['#filename']) ? NULL : $coder_args['#include_extensions']);
if ($not) {
$regex = '/(' . implode('|', $not) . ')$/i';
// Check filename. If a patch, also check the .patch extension.
if (preg_match($regex, $filename, $matches) || ($is_patch && preg_match($regex, 'coder_review.patch', $matches))) {
continue;
}
}
// If it's a patch, it can contain any sort of file, so ensure the file
// being processed is either PHP or one of the supported extensions.
if ($is_patch) {
$regex = '/(' . implode('|', $allowed_extensions) . ')$/i';