This file is indexed.

/usr/share/perl5/Debian/L10n/Debconf.pm is in dl10n 3.00.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
#!/usr/bin/perl -w

##  Copyright (C) 2001  Denis Barbier <barbier@debian.org>
##  Copyright (C) 2004  Martin Quinson
##
##  This program is free software; you can redistribute it and/or modify
##  it under the terms of the GNU General Public License as published by
##  the Free Software Foundation; either version 2 of the License, or
##  (at your option) any later version.

=head1 NAME

Debian::L10n::Debconf - translation status of Debconf templates

=head1 SYNOPSIS

 use Debian::L10n::Debconf;
 my $tmpl = Debian::L10n::Debconf->new();
 $tmpl->read_compact($file);
 my @languages = $tmpl->langs();
 foreach (sort @languages) {
        my ($t,$f,$u) = $tmpl->stats($_);
        print "$_:${t}t${f}f${u}u\n";
 }

=head1 DESCRIPTION

This module extracts informations about translation status of Debconf
templates files.

=head1 METHODS

=over 4

=cut

package Debian::L10n::Debconf;

use strict;

=item new

This is the constructor.

   my $tmpl = Debian::L10n::Debconf->new();

=cut

sub new {
        my $proto = shift;
        my $class = ref($proto) || $proto;
        my $self = {};
        bless ($self, $class);
        $self->_init();
        return $self;
}

sub _init {
        my $self = shift;

        $self->{orig}  = {};
        $self->{count} = 0;
        $self->{trans} = {};
        $self->{langs} = {};
        $self->{files} = {};
}

=item read_compact

Read a templates file containing all translations.  An optional second
argument may be used, any non-zero value tells that this file comes with
translations in other files.  In such a case no warning is raised if this
file contains translated fields, because maintainer is assumed to be
responsible for such translations.

   $tmpl->read_compact($file);

=cut

sub read_compact {
        my $self = shift;
        my $file = shift;
        my $safe = shift || 0;
        my ($lang, $msg);

        $self->_init();
        open (TMPL, "< $file")
                || die "Unable to read file $file\n";

        my $tmpl = '';
        my $line = 0;
        while (<TMPL>) {
                chomp;
                $line ++;
                if (m/^[A-Z][a-z]*-[A-Za-z_]+-fuzzy:/) {
                        warn "$file:$line: fuzzy-fields-in-templates\n";
                        goto SKIP;
                }
                if ((!$safe) && m/^[A-Z][a-z]*-[A-Za-z_]+:/) {
                        warn "$file:$line: translated-fields-in-master-templates\n";
                        #   Display this message only once
                        $safe = 1;
                }
                if (s/^Template:\s*//) {
                        $tmpl = $_;
                        $self->{orig}->{$tmpl} = {};
                } elsif (s/^(Choices):\s*//) {
                        if ($tmpl eq '') {
                                warn "$file:$line: \`$1' field found before \`Template'\n";
                                goto SKIP;
                        }
                        $self->{orig}->{$tmpl}->{choices} = $_;
                        $self->{count} ++;
                } elsif (s/^(Description):\s*//) {
                        if ($tmpl eq '') {
                                warn "$file:$line: \`$1' field found before \`Template'\n";
                                goto SKIP;
                        }
                        $msg = $_ . "\n";
                        while (<TMPL>) {
                                $line ++;
                                last if (!defined($_) || m/^\S/ || m/^$/m);
                                $msg .= $_;
                        }
                        $msg =~ s/^\s+//gm;
                        $msg =~ s/\s+$//gm;
                        $msg =~ tr/ \t\n/ /s;
                        $self->{orig}->{$tmpl}->{description} = $msg;
                        $self->{count} ++;
                        last unless defined($_);
                        $line --;
                        redo;
                } elsif (s/^(Choices-(.*?)):\s*//) {
                        if ($tmpl eq '') {
                                warn "$file:$line: \`$1' field found before \`Template'\n";
                                goto SKIP;
                        }
                        $lang = $2;
                        unless (defined($self->{langs}->{$lang})) {
                                $self->{langs}->{$lang} = 1;
                                $self->{trans}->{$lang}->{count} = 0;
                                $self->{trans}->{$lang}->{fuzzy} = 0;
                        }
                        $self->{trans}->{$lang}->{count} ++;
                } elsif (s/^(Description-(.*?)):\s+//) {
                        if ($tmpl eq '') {
                                warn "$file:$line: \`$1' field found before \`Template'\n";
                                goto SKIP;
                        }
                        $lang = $2;
                        unless (defined($self->{langs}->{$lang})) {
                                $self->{langs}->{$lang} = 1;
                                $self->{trans}->{$lang}->{count} = 0;
                                $self->{trans}->{$lang}->{fuzzy} = 0;
                        }
                        do {
                                $_ = <TMPL>;
                                $line ++;
                        } until (!defined($_) || m/^\S/ || m/^$/m);
                        $self->{trans}->{$lang}->{count} ++;
                        last unless defined($_);
                        $line --;
                        redo;
                } elsif (m/^\s*$/) {
                        $tmpl = '';
                } elsif (m/^(Type|Default)/) {
                        #   Ignored fields
                } else {
                        warn "$file:$line: Wrong input line:\n $_\n";
                }
                next;

                SKIP:
                        while (<TMPL>) {
                                $line ++;
                                last if (!defined($_) || m/^\S/ || m/^$/m);
                        }
                        last unless defined($_);
                        $line --;
                        redo;
        }
        close(TMPL);
}

=item read_dispatched

Read templates contained in several files.  First argument is the English file,
all other arguments are translated templates files.

   @trans = qw(templates.de templates.fr templates.ja templates.nl);
   $tmpl->read_dispatched('templates', @trans);

=cut

sub read_dispatched {
        my $self = shift;
        my $file = shift;

        $self->_init();
        $self->read_compact($file, 1);
        $self->{trans} = {};
        $self->{langs} = {};
        foreach my $trans (@_) {
                $self->_read_dispatched($trans);
        }
}

sub _read_dispatched {
        my $self = shift;
        my $file = shift;
        my ($lang, $msg, $status_c, $status_d);

        open (TMPL, "< $file")
                || die "Unable to read file $file\n";

        my $tmpl = '';
        my $line = 0;
        my $ext = $file;
        $ext =~ s/.*\.//;
        while (<TMPL>) {
                chomp;
                $line ++;
                if (m/^[A-Z][a-z]*-[A-Za-z_]+-fuzzy:/) {
                        warn "$file:$line: fuzzy-fields-in-templates\n";
                        goto SKIP;
                }
                if (s/^Template:\s*//) {
                        $tmpl = $_;
                        $status_c = $status_d = '';
                        unless (defined $self->{orig}->{$tmpl}) {
                                warn "$file:$line: translated-templates-not-in-original $_\n";
                                while (<TMPL>) {
                                        $line ++;
                                        last if (!defined($_) || m/^$/);
                                }
                                last unless defined($_);
                                $line --;
                                redo;
                        }
                } elsif (s/^(Choices):\s*//) {
                        if ($tmpl eq '') {
                                warn "$file:$line: \`$1' field found before \`Template'\n";
                                goto SKIP;
                        }
                        next unless defined $self->{orig}->{$tmpl};
                        if (defined($self->{orig}->{$tmpl}->{choices}) &&
                            $_ eq $self->{orig}->{$tmpl}->{choices}) {
                                $status_c = 'count';
                        } else {
                                $status_c = 'fuzzy';
                        }
                } elsif (s/^(Choices-(.*?)):\s*//) {
                        if ($tmpl eq '') {
                                warn "$file:$line: \`$1' field found before \`Template'\n";
                                goto SKIP;
                        }
                        $lang = $2;
                        if ($lang ne $ext) {
                                warn "$file:$line: lang-mismatch-in-translated-templates\n"
                        } else {
                                unless (defined($self->{langs}->{$lang})) {
                                        $self->{langs}->{$lang} = 1;
                                        $self->{trans}->{$lang}->{count} = 0;
                                        $self->{trans}->{$lang}->{fuzzy} = 0;
                                }
                                if ($status_c) {
                                        $self->{trans}->{$lang}->{$status_c} ++;
                                } else {
                                        warn "$file:$line: original-fields-removed-in-translated-templates\n";
                                }
                                $status_c = '';
                        }
                } elsif (s/^(Description):\s*//) {
                        if ($tmpl eq '') {
                                warn "$file:$line: \`$1' field found before \`Template'\n";
                                goto SKIP;
                        }
                        next unless defined $self->{orig}->{$tmpl};
                        $msg = $_ . "\n";
                        while (<TMPL>) {
                                $line ++;
                                last if (!defined($_) || m/^\S/ || m/^$/m);
                                $msg .= $_;
                        }
                        $msg =~ s/^\s+//gm;
                        $msg =~ s/\s+$//gm;
                        $msg =~ tr/ \t\n/ /s;
                        if (defined($self->{orig}->{$tmpl}->{description}) &&
                            $msg eq $self->{orig}->{$tmpl}->{description}) {
                                $status_d = 'count';
                        } else {
                                $status_d = 'fuzzy';
                        }
                        last unless defined($_);
                        $line --;
                        redo;
                } elsif (s/^(Description-(.*?)):\s+//) {
                        if ($tmpl eq '') {
                                warn "$file:$line: \`$1' field found before \`Template'\n";
                                goto SKIP;
                        }
                        $lang = $2;
                        if ($lang ne $ext) {
                                warn "$file:$line: lang-mismatch-in-translated-templates\n";
                                do {
                                        $_ = <TMPL>;
                                        $line ++;
                                } until (!defined($_) || m/^\S/ || m/^$/m);
                        } else {
                                if (defined($self->{files}->{$lang})) {
                                        die "Lang \`$lang' found in \`$file' and \`$self->{files}->{$lang}'\n"
                                                unless $self->{files}->{$lang} eq $file;
                                } else {
                                        $self->{files}->{$lang} = $file;
                                }
                                unless (defined($self->{langs}->{$lang})) {
                                        $self->{langs}->{$lang} = 1;
                                        $self->{trans}->{$lang}->{count} = 0;
                                        $self->{trans}->{$lang}->{fuzzy} = 0;
                                }
                                do {
                                        $_ = <TMPL>;
                                        $line ++;
                                } until (!defined($_) || m/^\S/ || m/^$/m);
                                if ($status_d) {
                                        $self->{trans}->{$lang}->{$status_d} ++;
                                } else {
                                        warn "$file:$line: original-fields-removed-in-translated-templates\n";
                                }
                                $status_d = '';
                        }
                        last unless defined($_);
                        $line --;
                        redo;
                } elsif (m/^\s*$/) {
                        $tmpl = '';
                        $status_c = $status_d = '';
                } elsif (m/^(Type|Default)/) {
                        #   Ignored fields
                } else {
                        warn "$file:$line: Wrong input line:\n $_\n";
                }
                next;

                SKIP:
                        while (<TMPL>) {
                                $line ++;
                                last if (!defined($_) || m/^\S/ || m/^$/);
                        }
                        last unless defined($_);
                        $line --;
                        redo;
        }
        close(TMPL);
}

=item langs

Return the languages in which this templates file is translated.

   my @list = $tmpl->langs();

=cut

sub langs {
        my $self = shift;
        return keys %{$self->{langs}};
}

=item filename

When templates are dispatched into several files, return the filename in
which the language passed as argument is found.

   my $filename = $tmpl->filename("de");

=cut

sub filename {
        my $self = shift;
        my $lang = shift;
        return (defined($self->{files}->{$lang}) ? 
                        $self->{files}->{$lang}  : '');
}

=item count

Return the number of translatable strings in this templates file.

   my $number = $tmpl->count();

=cut

sub count {
        my $self = shift;
        return $self->{count};
}

=item stats

With an argument, return an array consisting of the number of
translated, fuzzy and untranslated strings for the language given as
argument.
Without argument, return a hash array indexed by language and returning
an array of the number of translated, fuzzy and untranslated strings.

   my ($t, $f, $u) = $tmpl->stats("de");
   my %stats  = $tmpl->stats();
   foreach (keys %stats) {
           print $_.':'. $stats{$_}->[0].'t'.$stats{$_}->[1].'f'.
                $stats{$_}->[2]."u\n";
   }

=cut

sub stats {
        my $self = shift;
        my $lang;
        if (@_) {
                $lang = shift;
                if (defined($self->{langs}->{$lang})) {
                        return ($self->{trans}->{$lang}->{count},
                                $self->{trans}->{$lang}->{fuzzy},
                                $self->{count} -
                                        $self->{trans}->{$lang}->{fuzzy} -
                                        $self->{trans}->{$lang}->{count});
                } else {
                        return (0,0,0);
                }
        } else {
                my %stats = ();
                foreach $lang (keys %{$self->{langs}}) {
                        $stats{$lang} = [
                                $self->{trans}->{$lang}->{count},
                                $self->{trans}->{$lang}->{fuzzy},
                                $self->{count} -
                                        $self->{trans}->{$lang}->{fuzzy} -
                                        $self->{trans}->{$lang}->{count}
                        ];
                }
                return %stats;
        }
}

=item entries

Return an array containing all Debconf ids found in this templates file.

   my @ids = $tmpl->entries();

=cut

sub entries {
        my $self = shift;
        return keys %{$self->{orig}};
}

=back

=head1 AUTHOR

Copyright (C) 2001  Denis Barbier <barbier@debian.org>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

=cut

1;