File Coverage

File:lib/CheckSpelling/UnknownWordSplitter.pm
Coverage:87.9%

linestmtbrancondsubtimecode
1#! -*-perl-*-
2
3# ~/bin/w
4# Search for potentially misspelled words
5# Output is:
6# misspellled
7# woord (WOORD, Woord, woord, woord's)
8package CheckSpelling::UnknownWordSplitter;
9
10
1
1
1
96864
3
use 5.022;
11
1
1
1
1
1
1
48
use feature 'unicode_strings';
12
1
1
1
1
2
2
7
use strict;
13
1
1
1
1
2
0
19
use warnings;
14
1
1
1
1
2
0
14
no warnings qw(experimental::vlb);
15
1
1
1
1
1
1
3
use utf8;
16
1
1
1
1
11
0
24
use Encode qw/decode_utf8 encode FB_DEFAULT/;
17
1
1
1
1
2
1
26
use File::Basename;
18
1
1
1
1
1
1
11
use Cwd 'abs_path';
19
1
1
1
1
2
0
17
use File::Temp qw/ tempfile tempdir /;
20
1
1
1
1
221
1
2839
use CheckSpelling::Util;
21our $VERSION='0.1.0';
22
23my ($longest_word, $shortest_word, $word_match, $forbidden_re, $patterns_re, $candidates_re, $disable_word_collating, $check_file_names);
24my ($ignore_pattern, $upper_pattern, $lower_pattern, $not_lower_pattern, $not_upper_or_lower_pattern, $punctuation_pattern);
25my ($shortest, $longest) = (255, 0);
26my @forbidden_re_list;
27my %forbidden_re_descriptions;
28my @candidates_re_list;
29my $hunspell_dictionary_path;
30my @hunspell_dictionaries;
31my %dictionary = ();
32my $base_dict;
33my %unique;
34my %unique_unrecognized;
35my ($last_file, $words, $unrecognized) = ('', 0, 0);
36
37my $disable_flags;
38
39sub test_re {
40
14
14
10
  my ($expression) = @_;
41
14
14
7
102
  return eval { qr /$expression/ };
42}
43
44sub quote_re {
45
14
14
9
  my ($expression) = @_;
46
14
50
13
  return $expression if $expression =~ /\?\{/;
47
14
33
  $expression =~ s/
48   \G
49   (
50      (?:[^\\]|\\[^Q])*
51   )
52   (?:
53      \\Q
54      (?:[^\\]|\\[^E])*
55      (?:\\E)?
56   )?
57/
58
28
50
43
   $1 . (defined($2) ? quotemeta($2) : '')
59/xge;
60
14
15
  return $expression;
61}
62
63sub file_to_lists {
64
3
3
3
  my ($re) = @_;
65
3
4
  my @patterns;
66  my %hints;
67
3
0
  my $fh;
68
3
50
19
  if (open($fh, '<:utf8', $re)) {
69
3
5
    local $/=undef;
70
3
14
    my $file=<$fh>;
71
3
7
    close $fh;
72
3
11
    my $line_number = 0;
73
3
3
    my $hint = '';
74
3
14
    for (split /\R/, $file) {
75
17
12
      ++$line_number;
76
17
5
      chomp;
77
17
100
20
      if (/^#(?:\s(.+)|)/) {
78
6
100
67
14
        $hint = $1 if ($hint eq '' && defined $1);
79
6
7
        next;
80      }
81
11
100
11
      $hint = '' unless $_ ne '';
82
11
7
      my $pattern = $_;
83
11
100
25
      next unless s/^(.+)/(?:$1)/;
84
7
9
      my $quoted = quote_re($1);
85
7
100
6
      unless (test_re $quoted) {
86
1
1
        my $error = $@;
87
1
53
        my $home = dirname(__FILE__);
88
1
25
        $error =~ s/$home.*?\.pm line \d+\./$re line $line_number (bad-regex)/;
89
1
9
        print STDERR $error;
90
1
1
        $_ = '(?:\$^ - skipped because bad-regex)';
91
1
1
        $hint = '';
92      }
93
7
100
10
      if (defined $hints{$_}) {
94
1
2
        my $pattern_length = length $pattern;
95
1
1
        my $wrapped = CheckSpelling::Util::wrap_in_backticks($pattern);
96
1
12
        print STDERR "$re:$line_number:1 ... $pattern_length, Warning - duplicate pattern: $wrapped (duplicate-pattern)\n";
97
1
2
        $_ = '(?:\$^ - skipped because duplicate-pattern on $line_number)';
98      } else {
99
6
6
        push @patterns, $_;
100
6
8
        $hints{$_} = $hint;
101      }
102
7
10
      $hint = '';
103    }
104  }
105
106  return {
107
3
12
    patterns => \@patterns,
108    hints => \%hints,
109  };
110}
111
112sub file_to_list {
113
2
2
1123
  my ($re) = @_;
114
2
5
  my $lists = file_to_lists($re);
115
116
2
2
1
7
  return @{$lists->{'patterns'}};
117}
118
119sub list_to_re {
120
2
2
2
  my (@list) = @_;
121
2
5
5
50
2
4
4
  @list = map { my $quoted = quote_re($_); test_re($quoted) ? $quoted : '' } @list;
122
2
5
2
5
  @list = grep { $_ ne '' } @list;
123
2
50
2
  return '$^' unless scalar @list;
124
2
6
  return join "|", (@list);
125}
126
127sub not_empty {
128
51
51
39
  my ($thing) = @_;
129
51
100
159
  return defined $thing && $thing ne ''
130}
131
132sub valid_word {
133  # shortest_word is an absolute
134
22
22
10
  our ($shortest, $longest, $shortest_word, $longest_word);
135
22
50
17
  $shortest = $shortest_word if $shortest_word;
136
22
100
100
21
  if ($longest_word) {
137    # longest_word is an absolute
138
20
24
    $longest = $longest_word;
139  } elsif (not_empty($longest)) {
140    # we allow for some sloppiness (a couple of stuck keys per word)
141    # it's possible that this should scale with word length
142
1
1
    $longest += 2;
143  }
144
22
17
  our ($upper_pattern, $lower_pattern, $punctuation_pattern);
145
22
66
100
15
133
  my $word_pattern = join '|', (grep { defined $_ && /./ } ($upper_pattern, $lower_pattern, $punctuation_pattern));
146
22
100
15
  $word_pattern = q<\\w|'> unless $word_pattern;
147
22
50
50
41
  if ((defined $shortest && not_empty($longest)) &&
148      ($shortest > $longest)) {
149
0
0
    $word_pattern = "(?:$word_pattern){3}";
150
0
0
    return qr/$word_pattern/;
151  }
152
22
100
22
  $shortest = 3 unless defined $shortest;
153
22
100
22
  $longest = '' unless defined $longest;
154
22
70
  $word_match = "(?:$word_pattern){$shortest,$longest}";
155
22
163
  return qr/\b$word_match\b/;
156}
157
158sub load_dictionary {
159
12
12
1652
  my ($dict) = @_;
160
12
8
  our ($word_match, $longest, $shortest, $longest_word, $shortest_word, %dictionary);
161
12
9
  $longest_word = CheckSpelling::Util::get_val_from_env('INPUT_LONGEST_WORD', undef);
162
12
11
  $shortest_word = CheckSpelling::Util::get_val_from_env('INPUT_SHORTEST_WORD', undef);
163
12
5
  our ($ignore_pattern, $upper_pattern, $lower_pattern, $not_lower_pattern, $not_upper_or_lower_pattern, $punctuation_pattern);
164
12
15
  $ignore_pattern = CheckSpelling::Util::get_file_from_env_utf8('INPUT_IGNORE_PATTERN', q<[^a-zA-Z']>);
165
12
38
  $upper_pattern = CheckSpelling::Util::get_file_from_env_utf8('INPUT_UPPER_PATTERN', '[A-Z]');
166
12
24
  $lower_pattern = CheckSpelling::Util::get_file_from_env_utf8('INPUT_LOWER_PATTERN', '[a-z]');
167
12
21
  $not_lower_pattern = CheckSpelling::Util::get_file_from_env_utf8('INPUT_NOT_LOWER_PATTERN', '[^a-z]');
168
12
17
  $not_upper_or_lower_pattern = CheckSpelling::Util::get_file_from_env_utf8('INPUT_NOT_UPPER_OR_LOWER_PATTERN', '[^A-Za-z]');
169
12
14
  $punctuation_pattern = CheckSpelling::Util::get_file_from_env_utf8('INPUT_PUNCTUATION_PATTERN', q<'>);
170
12
24
  %dictionary = ();
171
172
12
634
  open(DICT, '<:utf8', $dict);
173
12
49
  while (!eof(DICT)) {
174
31
30
    my $word = <DICT>;
175
31
23
    chomp $word;
176
31
100
68
    next unless $word =~ $word_match;
177
28
22
    my $l = length $word;
178
28
100
18
    $longest = -1 unless not_empty($longest);
179
28
100
23
    $longest = $l if $l > $longest;
180
28
100
31
    $shortest = $l if $l < $shortest;
181
28
45
    $dictionary{$word}=1;
182  }
183
12
25
  close DICT;
184
185
12
10
  $word_match = valid_word();
186}
187
188sub hunspell_dictionary {
189
3
3
3
  my ($dict) = @_;
190
3
3
  my $name = $dict;
191
3
5
  $name =~ s{/src/index/hunspell/index\.dic$}{};
192
3
9
  $name =~ s{.*/}{};
193
3
4
  my $aff = $dict;
194
3
1
  my $encoding;
195
3
9
  $aff =~ s/\.dic$/.aff/;
196
3
50
20
  if (open AFF, '<', $aff) {
197
3
19
    while (<AFF>) {
198
0
0
0
      next unless /^SET\s+(\S+)/;
199
0
0
0
      $encoding = $1 if ($1 !~ /utf-8/i);
200
0
0
      last;
201    }
202
3
5
    close AFF;
203  }
204  return {
205
3
292
    name => $name,
206    dict => $dict,
207    aff => $aff,
208    encoding => $encoding,
209    engine => Text::Hunspell->new($aff, $dict),
210  }
211}
212
213sub init {
214
9
9
9364
  my ($configuration) = @_;
215
9
7
  our ($word_match, %unique, $patterns_re, @forbidden_re_list, $forbidden_re, @candidates_re_list, $candidates_re);
216
9
23
  our $sandbox = CheckSpelling::Util::get_file_from_env('sandbox', '');
217
9
9
  our $hunspell_dictionary_path = CheckSpelling::Util::get_file_from_env('hunspell_dictionary_path', '');
218
9
13
  our $timeout = CheckSpelling::Util::get_val_from_env('splitter_timeout', 30);
219
9
6
  our %forbidden_re_descriptions;
220
9
100
11
  if ($hunspell_dictionary_path) {
221
3
30
    our @hunspell_dictionaries = ();
222
1
1
1
1
1
1
1
1
1
3
50
1
1
1
144
785
23
4
1
16
6
2
17
147
    if (eval 'use Text::Hunspell; 1') {
223
3
88
      my @hunspell_dictionaries_list = glob("$hunspell_dictionary_path/*.dic");
224
3
5
      for my $hunspell_dictionary_file (@hunspell_dictionaries_list) {
225
3
9
        push @hunspell_dictionaries, hunspell_dictionary($hunspell_dictionary_file);
226      }
227    } else {
228
0
0
      print STDERR "Could not load Text::Hunspell for dictionaries (hunspell-unavailable)\n";
229    }
230  }
231
9
13
  my (@patterns_re_list, %in_patterns_re_list);
232
9
50
48
  if (-e "$configuration/patterns.txt") {
233
0
0
    @patterns_re_list = file_to_list "$configuration/patterns.txt";
234
0
0
    $patterns_re = list_to_re @patterns_re_list;
235
0
0
0
0
    %in_patterns_re_list = map {$_ => 1} @patterns_re_list;
236  } else {
237
9
10
    $patterns_re = undef;
238  }
239
240
9
100
18
  if (-e "$configuration/forbidden.txt") {
241
1
1
    my $forbidden_re_info = file_to_lists "$configuration/forbidden.txt";
242
1
1
2
1
    @forbidden_re_list = @{$forbidden_re_info->{'patterns'}};
243
1
1
1
2
    %forbidden_re_descriptions = %{$forbidden_re_info->{'hints'}};
244
1
2
    $forbidden_re = list_to_re @forbidden_re_list;
245  } else {
246
8
8
    $forbidden_re = undef;
247  }
248
249
9
100
27
  if (-e "$configuration/candidates.txt") {
250
1
2
    @candidates_re_list = file_to_list "$configuration/candidates.txt";
251
1
2
2
50
33
1
2
4
    @candidates_re_list = map { my $quoted = quote_re($_); $in_patterns_re_list{$_} || !test_re($quoted) ? '' : $quoted } @candidates_re_list;
252
1
1
    $candidates_re = list_to_re @candidates_re_list;
253  } else {
254
8
5
    $candidates_re = undef;
255  }
256
257
9
9
  our $largest_file = CheckSpelling::Util::get_val_from_env('INPUT_LARGEST_FILE', 1024*1024);
258
259
9
9
  my $disable_flags = CheckSpelling::Util::get_file_from_env('INPUT_DISABLE_CHECKS', '');
260
9
10
  our $disable_word_collating = $disable_flags =~ /(?:^|,|\s)word-collating(?:,|\s|$)/;
261
9
3
  our $disable_minified_file = $disable_flags =~ /(?:^|,|\s)minified-file(?:,|\s|$)/;
262
9
7
  our $disable_single_line_file = $disable_flags =~ /(?:^|,|\s)single-line-file(?:,|\s|$)/;
263
264
9
4
  our $check_file_names = CheckSpelling::Util::get_file_from_env('check_file_names', '');
265
266
9
7
  our $use_magic_file = CheckSpelling::Util::get_val_from_env('INPUT_USE_MAGIC_FILE', '');
267
268
9
10
  $word_match = valid_word();
269
270
9
12
  our $base_dict = CheckSpelling::Util::get_file_from_env('dict', "$configuration/words");
271
9
100
23
  $base_dict = '/usr/share/dict/words' unless -e $base_dict;
272
9
9
  load_dictionary($base_dict);
273}
274
275sub split_line {
276
1164
1164
432
  our (%dictionary, $word_match, $disable_word_collating);
277
1164
479
  our ($ignore_pattern, $upper_pattern, $lower_pattern, $not_lower_pattern, $not_upper_or_lower_pattern, $punctuation_pattern);
278
1164
414
  our @hunspell_dictionaries;
279
1164
435
  our $shortest;
280
1164
540
  my $pattern = '.';
281  # $pattern = "(?:$upper_pattern){$shortest,}|$upper_pattern(?:$lower_pattern){2,}\n";
282
283  # https://www.fileformat.info/info/unicode/char/2019/
284
1164
481
  my $rsqm = "\xE2\x80\x99";
285
286
1164
615
  my ($words, $unrecognized) = (0, 0);
287
1164
744
  my ($line, $unique_ref, $unique_unrecognized_ref, $unrecognized_line_items_ref) = @_;
288
1164
5362
    $line =~ s/(?:$rsqm|&apos;|&#39;|\%27|&#8217;|&#x2019;|&rsquo;|\\u2019|\x{2019}|')+/'/g;
289
1164
2393
    $line =~ s/(?:$ignore_pattern)+/ /g;
290
1164
1560
    while ($line =~ s/($upper_pattern{2,})($upper_pattern$lower_pattern{2,})/ $1 $2 /g) {}
291
1164
3805
    while ($line =~ s/((?:$lower_pattern|$punctuation_pattern)+)($upper_pattern)/$1 $2/g) {}
292
1164
1431
    for my $token (split /\s+/, $line) {
293
5857
100
5104
      next unless $token =~ /$pattern/;
294
4695
3438
      $token =~ s/^(?:'|$rsqm)+//g;
295
4695
4326
      $token =~ s/(?:'|$rsqm)+s?$//g;
296
4695
2546
      my $raw_token = $token;
297
4695
2658
      $token =~ s/^[^Ii]?'+(.*)/$1/;
298
4695
2214
      $token =~ s/(.*?)'+$/$1/;
299
4695
100
6365
      next unless $token =~ $word_match;
300
4554
100
3985
      if (defined $dictionary{$token}) {
301
1028
462
        ++$words;
302
1028
513
        $unique_ref->{$token}=1;
303
1028
827
        next;
304      }
305
3526
100
2260
      if (@hunspell_dictionaries) {
306
3504
1500
        my $found = 0;
307
3504
1749
        for my $hunspell_dictionary (@hunspell_dictionaries) {
308          my $token_encoded = defined $hunspell_dictionary->{'encoding'} ?
309
3504
50
2428
            encode($hunspell_dictionary->{'encoding'}, $token) : $token;
310
3504
50
5362
          next unless ($hunspell_dictionary->{'engine'}->check($token_encoded));
311
0
0
          ++$words;
312
0
0
          $dictionary{$token} = 1;
313
0
0
          $unique_ref->{$token}=1;
314
0
0
          $found = 1;
315
0
0
          last;
316        }
317
3504
50
2378
        next if $found;
318      }
319
3526
2253
      my $key = lc $token;
320
3526
100
2771
      if (defined $dictionary{$key}) {
321
3
2
        ++$words;
322
3
3
        $unique_ref->{$key}=1;
323
3
4
        next;
324      }
325
3523
50
2219
      unless ($disable_word_collating) {
326
3523
1887
        $key =~ s/''+/'/g;
327
3523
1981
        $key =~ s/'[sd]$//;
328      }
329
3523
50
2501
      if (defined $dictionary{$key}) {
330
0
0
        ++$words;
331
0
0
        $unique_ref->{$key}=1;
332
0
0
        next;
333      }
334
3523
1576
      ++$unrecognized;
335
3523
1880
      $unique_unrecognized_ref->{$raw_token}=1;
336
3523
4172
      $unrecognized_line_items_ref->{$raw_token}=1;
337    }
338
1164
1496
    return ($words, $unrecognized);
339}
340
341sub skip_file {
342
15
15
27
  my ($temp_dir, $reason) = @_;
343
15
331
  open(SKIPPED, '>:utf8', "$temp_dir/skipped");
344
15
80
  print SKIPPED $reason;
345
15
276
  close SKIPPED;
346}
347
348sub split_file {
349
15
15
9453
  my ($file) = @_;
350  our (
351
15
11
    $unrecognized, $shortest, $largest_file, $words,
352    $word_match, %unique, %unique_unrecognized, $forbidden_re,
353    @forbidden_re_list, $patterns_re, %dictionary,
354    $candidates_re, @candidates_re_list, $check_file_names, $use_magic_file, $disable_minified_file,
355    $disable_single_line_file,
356    $sandbox,
357  );
358
15
5
  our %forbidden_re_descriptions;
359
15
9
  our ($ignore_pattern, $upper_pattern, $lower_pattern, $not_lower_pattern, $not_upper_or_lower_pattern, $punctuation_pattern);
360
361  # https://www.fileformat.info/info/unicode/char/2019/
362
15
7
  my $rsqm = "\xE2\x80\x99";
363
364
15
20
  my @candidates_re_hits = (0) x scalar @candidates_re_list;
365
15
9
  my @candidates_re_lines = (0) x scalar @candidates_re_list;
366
15
14
  my @forbidden_re_hits = (0) x scalar @forbidden_re_list;
367
15
15
  my @forbidden_re_lines = (0) x scalar @forbidden_re_list;
368
15
22
  my $temp_dir = tempdir(DIR=>$sandbox);
369
15
50
1997
  print STDERR "checking file: $file\n" if defined $ENV{'DEBUG'};
370
15
198
  open(NAME, '>', "$temp_dir/name");
371
15
29
    print NAME $file;
372
15
106
  close NAME;
373
15
28
  my $file_size = -s $file;
374
15
50
16
  if (defined $largest_file) {
375
15
50
17
    unless ($check_file_names eq $file) {
376
15
100
17
      if ($file_size > $largest_file) {
377
1
2
        skip_file($temp_dir, "size `$file_size` exceeds limit `$largest_file` (large-file)\n");
378
1
2
        return $temp_dir;
379      }
380    }
381  }
382
14
100
12
  if ($use_magic_file) {
383
8
50
10469
    if (open(my $file_fh, '-|',
384              '/usr/bin/file',
385              '-b',
386              '--mime',
387              '-e', 'cdf',
388              '-e', 'compress',
389              '-e', 'csv',
390              '-e', 'elf',
391              '-e', 'json',
392              '-e', 'tar',
393              $file)) {
394
8
25663
      my $file_kind = <$file_fh>;
395
8
3852
      close $file_fh;
396
8
100
112
      if ($file_kind =~ /^(.*?); charset=binary/) {
397
2
24
        skip_file($temp_dir, "it appears to be a binary file (`$1`) (binary-file)\n");
398
2
34
        return $temp_dir;
399      }
400    }
401  }
402
12
94
  open FILE, '<', $file;
403
12
11
  binmode FILE;
404
12
9
  my $head;
405
12
84
  read(FILE, $head, 4096);
406
12
766
  $head =~ s/(?:\r|\n)+$//;
407
12
55
  my $dos_new_lines = () = $head =~ /\r\n/gi;
408
12
37
  my $unix_new_lines = () = $head =~ /\n/gi;
409
12
109
  my $mac_new_lines = () = $head =~ /\r/gi;
410
12
53
  local $/;
411
12
100
100
100
100
100
72
  if ($unix_new_lines == 0 && $mac_new_lines == 0) {
412
3
11
    $/ = "\n";
413  } elsif ($dos_new_lines >= $unix_new_lines && $dos_new_lines >= $mac_new_lines) {
414
1
7
    $/ = "\r\n";
415  } elsif ($mac_new_lines > $unix_new_lines) {
416
2
6
    $/ = "\r";
417  } else {
418
6
7
    $/ = "\n";
419  }
420
12
19
  seek(FILE, 0, 0);
421
12
15
  ($words, $unrecognized) = (0, 0);
422
12
34
  %unique = ();
423
12
28
  %unique_unrecognized = ();
424
425  local $SIG{__WARN__} = sub {
426
0
0
0
    my $message = shift;
427
0
0
    $message =~ s/> line/> in $file - line/;
428
0
0
    chomp $message;
429
0
0
    print STDERR "$message\n";
430
12
127
  };
431
432
12
229
  open(WARNINGS, '>:utf8', "$temp_dir/warnings");
433
12
7
  our $timeout;
434
12
11
  eval {
435
12
0
0
81
0
    local $SIG{ALRM} = sub { die "alarm\n" }; # NB: \n required
436
12
31
    alarm $timeout;
437
438
12
9
    my $offset = 0;
439
12
71
    while (<FILE>) {
440
1167
100
996
      if ($. == 1) {
441
12
50
15
        unless ($disable_minified_file) {
442
12
100
100
49
          if ($file_size >= 512 && length($_) == $file_size) {
443
1
11
            skip_file($temp_dir, "file only has a single line (single-line-file)\n");
444
1
3
            last;
445          }
446        }
447      }
448
1166
1921
      $_ = decode_utf8($_, FB_DEFAULT);
449
1166
50
2389
      if (/[\x{D800}-\x{DFFF}]/) {
450
0
0
        skip_file($temp_dir, "file contains a UTF-16 surrogate -- UTF-16 surrogates are not supported (utf16-surrogate-file)\n");
451
0
0
        last;
452      }
453
1166
1238
      s/\R$//;
454
1166
100
932
      s/^\x{FEFF}// if $. == 1;
455
1166
100
1041
      next unless /./;
456
1164
739
      my $raw_line = $_;
457
458      # hook for custom line based text exclusions:
459
1164
100
767
      if (defined $patterns_re) {
460
2
6
11
7
        s/($patterns_re)/"="x length($1)/ge;
461      }
462
1164
637
      my $previous_line_state = $_;
463
1164
503
      my $line_flagged;
464
1164
100
716
      if ($forbidden_re) {
465
9
5
58
11
        while (s/($forbidden_re)/"="x length($1)/e) {
466
5
2
          $line_flagged = 1;
467
5
9
          my ($begin, $end, $match) = ($-[0] + 1, $+[0] + 1, $1);
468
5
3
          my $found_trigger_re;
469
5
5
          for my $i (0 .. $#forbidden_re_list) {
470
7
3
            my $forbidden_re_singleton = $forbidden_re_list[$i];
471
7
7
            my $test_line = $previous_line_state;
472
7
4
100
52
6
            if ($test_line =~ s/($forbidden_re_singleton)/"="x length($1)/e) {
473
4
50
4
              next unless $test_line eq $_;
474
4
8
              my ($begin_test, $end_test, $match_test) = ($-[0] + 1, $+[0] + 1, $1);
475
4
50
2
              next unless $begin == $begin_test;
476
4
50
4
              next unless $end == $end_test;
477
4
50
4
              next unless $match eq $match_test;
478
4
2
              $found_trigger_re = $forbidden_re_singleton;
479
4
7
              my $hit = "$.:$begin:$end";
480
4
3
              $forbidden_re_hits[$i]++;
481
4
100
5
              $forbidden_re_lines[$i] = $hit unless $forbidden_re_lines[$i];
482
4
7
              last;
483            }
484          }
485
5
5
          my $wrapped = CheckSpelling::Util::wrap_in_backticks($match);
486
5
100
5
          if ($found_trigger_re) {
487
4
100
9
            my $description = $forbidden_re_descriptions{$found_trigger_re} || '';
488
4
6
            $found_trigger_re =~ s/^\(\?:(.*)\)$/$1/;
489
4
4
            my $quoted_trigger_re = CheckSpelling::Util::truncate_with_ellipsis(CheckSpelling::Util::wrap_in_backticks($found_trigger_re), 99);
490
4
100
5
            if ($description ne '') {
491
3
14
              print WARNINGS ":$.:$begin ... $end, Warning - $wrapped matches a line_forbidden.patterns rule: $description - $quoted_trigger_re (forbidden-pattern)\n";
492            } else {
493
1
6
              print WARNINGS ":$.:$begin ... $end, Warning - $wrapped matches a line_forbidden.patterns entry: $quoted_trigger_re (forbidden-pattern)\n";
494            }
495          } else {
496
1
3
            print WARNINGS ":$.:$begin ... $end, Warning - $wrapped matches a line_forbidden.patterns entry (forbidden-pattern)\n";
497          }
498
5
23
          $previous_line_state = $_;
499        }
500      }
501      # This is to make it easier to deal w/ rules:
502
1164
973
      s/^/ /;
503
1164
581
      my %unrecognized_line_items = ();
504
1164
740
      my ($new_words, $new_unrecognized) = split_line($_, \%unique, \%unique_unrecognized, \%unrecognized_line_items);
505
1164
516
      $words += $new_words;
506
1164
556
      $unrecognized += $new_unrecognized;
507
1164
680
      my $line_length = length($raw_line);
508
1164
1300
      for my $token (sort CheckSpelling::Util::case_biased keys %unrecognized_line_items) {
509
1029
476
        my $found_token = 0;
510
1029
414
        my $raw_token = $token;
511
1029
579
        $token =~ s/'/(?:'|\x{2019}|\&apos;|\&#39;)+/g;
512
1029
371
        my $before;
513
1029
100
50
1348
        if ($token =~ /^$upper_pattern$lower_pattern/) {
514
5
3
          $before = '(?<=.)';
515        } elsif ($token =~ /^$upper_pattern/) {
516
0
0
          $before = "(?<!$upper_pattern)";
517        } else {
518
1024
516
          $before = "(?<=$not_lower_pattern)";
519        }
520
1029
50
1038
        my $after = ($token =~ /$upper_pattern$/) ? "(?=$not_upper_or_lower_pattern)|(?=$upper_pattern$lower_pattern)" : "(?=$not_lower_pattern)";
521
1029
1801
        while ($raw_line =~ /(?:\b|$before)($token)(?:\b|$after)/g) {
522
3520
1583
          $line_flagged = 1;
523
3520
1373
          $found_token = 1;
524
3520
4591
          my ($begin, $end, $match) = ($-[0] + 1, $+[0] + 1, $1);
525
3520
50
2889
          next unless $match =~ /./;
526
3520
1975
          my $wrapped = CheckSpelling::Util::wrap_in_backticks($match);
527
3520
11508
          print WARNINGS ":$.:$begin ... $end: $wrapped\n";
528        }
529
1029
100
1042
        unless ($found_token) {
530
3
50
33
26
          if ($raw_line !~ /$token.*$token/ && $raw_line =~ /($token)/) {
531
3
7
            my ($begin, $end, $match) = ($-[0] + 1, $+[0] + 1, $1);
532
3
2
            my $wrapped = CheckSpelling::Util::wrap_in_backticks($raw_token);
533
3
12
            print WARNINGS ":$.:$begin ... $end: $wrapped\n";
534          } else {
535
0
0
            my $offset = $line_length + 1;
536
0
0
            my $wrapped = CheckSpelling::Util::wrap_in_backticks($raw_token);
537
0
0
            print WARNINGS ":$.:1 ... $offset, Warning - Could not identify whole word $wrapped in line (token-is-substring)\n";
538          }
539        }
540      }
541
1164
100
100
1639
      if ($line_flagged && $candidates_re) {
542
1
1
        $_ = $previous_line_state;
543
1
1
18
19
        s/($candidates_re)/"="x length($1)/ge;
544
1
50
2
        if ($_ ne $previous_line_state) {
545
1
1
          $_ = $previous_line_state;
546
1
2
          for my $i (0 .. $#candidates_re_list) {
547
2
2
            my $candidate_re = $candidates_re_list[$i];
548
2
100
67
14
            next unless $candidate_re =~ /./ && $raw_line =~ /$candidate_re/;
549
1
1
50
6
5
            if (($_ =~ s/($candidate_re)/"="x length($1)/e)) {
550
1
2
              my ($begin, $end) = ($-[0] + 1, $+[0] + 1);
551
1
3
              my $hit = "$.:$begin:$end";
552
1
1
              $_ = $previous_line_state;
553
1
1
5
2
              my $replacements = ($_ =~ s/($candidate_re)/"="x length($1)/ge);
554
1
1
              $candidates_re_hits[$i] += $replacements;
555
1
50
2
              $candidates_re_lines[$i] = $hit unless $candidates_re_lines[$i];
556
1
2
              $_ = $previous_line_state;
557            }
558          }
559        }
560      }
561
1164
50
759
      unless ($disable_minified_file) {
562
1164
817
        s/={3,}//g;
563
1164
777
        $offset += length;
564
1164
932
        my $ratio = int($offset / $.);
565
1164
541
        my $ratio_threshold = 1000;
566
1164
100
2597
        if ($ratio > $ratio_threshold) {
567
11
23
          skip_file($temp_dir, "average line width ($ratio) exceeds the threshold ($ratio_threshold) (minified-file)\n");
568        }
569      }
570    }
571
572
12
65
    alarm 0;
573  };
574
12
50
11
  if ($@) {
575
0
0
0
    die unless $@ eq "alarm\n";
576
0
0
    print WARNINGS ":$.:1 ... 1, Warning - Could not parse file within time limit (slow-file)\n";
577
0
0
    skip_file($temp_dir, "it could not be parsed file within time limit (slow-file)\n");
578  }
579
580
12
35
  close FILE;
581
12
94
  close WARNINGS;
582
583
12
100
75
26
  if ($unrecognized || @candidates_re_hits || @forbidden_re_hits) {
584
11
232
    open(STATS, '>:utf8', "$temp_dir/stats");
585
11
100
100
100
100
181
      print STATS "{words: $words, unrecognized: $unrecognized, unknown: ".(keys %unique_unrecognized).
586      ", unique: ".(keys %unique).
587      (@candidates_re_hits ? ", candidates: [".(join ',', @candidates_re_hits)."]" : "").
588      (@candidates_re_lines ? ", candidate_lines: [".(join ',', @candidates_re_lines)."]" : "").
589      (@forbidden_re_hits ? ", forbidden: [".(join ',', @forbidden_re_hits)."]" : "").
590      (@forbidden_re_lines ? ", forbidden_lines: [".(join ',', @forbidden_re_lines)."]" : "").
591      "}";
592
11
89
    close STATS;
593
11
116
    open(UNKNOWN, '>:utf8', "$temp_dir/unknown");
594
11
19
33
40
      print UNKNOWN map { "$_\n" } sort CheckSpelling::Util::case_biased keys %unique_unrecognized;
595
11
46
    close UNKNOWN;
596  }
597
598
12
99
  return $temp_dir;
599}
600
601sub main {
602
2
2
318
  my ($configuration, @ARGV) = @_;
603
2
2
  our %dictionary;
604
2
100
2
  unless (%dictionary) {
605
1
2
    init($configuration);
606  }
607
608  # read all input
609
2
1
  my @reports;
610
611
2
2
  for my $file (@ARGV) {
612
2
2
    my $temp_dir = split_file($file);
613
2
4
    push @reports, "$temp_dir\n";
614  }
615
2
6
  print join '', @reports;
616}
617
6181;