/usr/share/perl5/Config/Model/Backend/DpkgSyntax.pm is in libconfig-model-dpkg-perl 2.044.
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 | package Config::Model::Backend::DpkgSyntax ;
use Mouse::Role;
use Carp;
use Config::Model::Exception ;
use Log::Log4perl qw(get_logger :levels);
use base qw/Config::Model::Backend::Any/;
my $logger = get_logger("Backend::DpkgSyntax") ;
sub parse_dpkg_file {
my $self = shift ;
my $fh = shift;
my $check = shift || 'yes' ;
my $comment_allowed = shift || 0 ;
my @lines = $fh->getlines ;
chomp @lines ;
$fh->close ;
$self->parse_dpkg_lines (\@lines, $check, $comment_allowed);
}
#
# New subroutine "parse_dpkg_lines" extracted - Tue Jul 19 17:47:58 2011.
#
sub parse_dpkg_lines {
my ($self, $lines, $check, $comment_allowed, $handle_garbage) = @_ ;
my $field;
my $store_ref ; # hold field data
my @comments; # hold comment data
my $store_list = [] ; # holds sections
my $key = '';
my $line_nb = 1 ;
my $section_line = 1 ;
# list of list ( $line_nb_nb, section, ... ) where section is
# [keyword, [ value, line_nb, altered , comment ] ])
my @res ;
foreach (@$lines) {
$logger->trace("Parsing line $line_nb '$_'");
if (/^#/) { # comment are always located before the keyword (hopefully)
Config::Model::Exception::Syntax->throw (
object => $self,
parsed_line => $line_nb,
message => "Comments are not allowed",
) unless $comment_allowed;
my $c = $_ ;
$c =~ s/#\s// ;
push @comments, $c ;
}
elsif (/^([\w\-]+)\s*:/) { # keyword:
my ($field,$text) = split /\s*:\s*/,$_,2 ;
$key = $field ;
$logger->trace("line $line_nb start new field $key with '$text'");
# @$store_list will be used in a hash, where the $field is key
# store value found, file line number, is value altered (used later, o for now)
# and comments
push @$store_list, $field, [ $text , $line_nb, '', @comments ] ;
@comments = () ;
$store_ref = \$store_list->[$#$store_list][0] ;
}
elsif ($key and /^\s*$/) { # first empty line after a section
$logger->trace("empty line: starting new section");
$key = '';
push @res, $section_line, $store_list if @$store_list ; # don't store empty sections
$store_list = [] ;
$section_line = $line_nb + 1; # next line, will be clobbered if next line is empty
chomp $$store_ref if defined $$store_ref; # remove trailing \n
undef $store_ref ; # to ensure that next line contains a keyword
}
elsif (/^\s*$/) { # "extra" empty line
$handle_garbage->($_) if $handle_garbage ;
$logger->trace("extra empty line: skipped");
# just skip it
}
elsif (/^\s+\.$/) { # line with a single dot
$logger->trace("dot line: adding blank line to field $key");
_store_line($store_ref,"",$check,$line_nb) ;
}
elsif (s/^\s//) { # non empty line
$logger->trace("text line: adding '$_' to field $key");
_store_line($store_ref,$_ , $check,$line_nb);
}
elsif ($handle_garbage) {
$handle_garbage->($_) ;
}
else {
my $msg = "DpkgSyntax error: Invalid line (missing ':' ?) : $_" ;
Config::Model::Exception::Syntax -> throw ( message => $msg, parsed_line => $line_nb )
if $check eq 'yes' ;
$logger->error($msg) if $check eq 'skip';
}
$line_nb++;
}
# remove trailing \n of last stored value
chomp $$store_ref if defined $$store_ref;
# store last section if not empty
push @res, $section_line, $store_list if @$store_list;
if ($logger->is_debug ) {
for (my $i = 0 ; 2*$i < $#res ; $i++ ) {
my $l = $res[$i*2];
my $s = $res[$i*2 + 1];
my %section_data = @$s;
$logger->debug("Parse result section $i, found:") ;
foreach my $key (keys %section_data) {
$logger->debug( "$key: ". substr ($section_data{$key}[0],0,35)) ;
}
}
}
$logger->warn("No section found") unless @res ;
return wantarray ? @res : \@res ;
}
sub _store_line {
my ($store_ref,$line,$check,$line_nb) = @_ ;
if (defined $store_ref) {
$$store_ref .= "\n$line" ;
}
else {
my $msg = "Did not find a keyword before: '$line''";
Config::Model::Exception::Syntax -> throw ( message => $msg, parsed_line => $line_nb )
if $check eq 'yes' ;
$logger->error($msg) if $check eq 'skip';
}
}
# input is [ section [ keyword => value | value_list_ref ] ]
sub write_dpkg_file {
my ($self, $ioh, $array_ref,$list_sep) = @_ ;
my @lines = $self->format_dpkg_section(shift @$array_ref,$list_sep) ;
foreach my $section (@$array_ref) {
push @lines, '', $self->format_dpkg_section($section,$list_sep) ;
}
$ioh->print ( join("\n", @lines ), "\n");
}
# input is [ may_be_comment, keyword => value | value_list_ref, ... ]
sub format_dpkg_section {
my ($self, $array_ref,$list_sep) = @_ ;
my @lines ;
my $i = 0;
foreach (my $i=0; $i < @$array_ref; $i += 2 ) {
while ($array_ref->[$i] =~ /^#/) {
# print comment
push @lines, $array_ref->[$i++] ;
}
my $name = $array_ref->[$i] ;
my $value = $array_ref->[$i + 1];
if (ref ($value)) {
my $sep = $list_sep // ",\n" ;
$sep .= ' ' x (length ($name) + 2) if $sep =~ /\n$/ ;
my $line0 = $self->format_label_line($name, shift @$value);
push @lines, join ($sep, $line0, @$value ) ;
}
else {
push @lines, $self->format_dpkg_text($name, $value) ;
}
}
return @lines;
}
sub write_dpkg_text {
my ($self, $ioh, $text) = @_ ;
$ioh->print ( join("\n", $self->format_dpkg_text('',$text)), "\n" );
}
sub format_dpkg_text {
my ($self, $name, $text) = @_ ;
return unless $text ;
my @lines = split /\n/,$text ;
my $label_line = $self->format_label_line($name, shift @lines);
foreach (@lines) {
s/^/ /gm; # insert leading white space
s/^\s*$/ ./gm ; # insert dot for empty lines
}
return ($label_line, @lines) ;
}
sub format_label_line {
my ($self, $name, $v0) = @_ ;
return $v0 unless $name;
my $label_line = $name.":";
$label_line .= ' '.$v0 if $v0 =~ /\S/;
return $label_line;
}
1;
__END__
=head1 NAME
Config::Model::Backend::DpkgSyntax - Role to read and write files with Dpkg syntax
=head1 SYNOPSIS
package MyParser ;
use Log::Log4perl qw(:easy);
Log::Log4perl->easy_init($WARN);
use Mouse ;
with 'Config::Model::Backend::DpkgSyntax';
package main ;
use IO::File ;
use Data::Dumper ;
my $data = [ [ qw/Name Foo Version 1.2/ ],
[ qw/Name Bar Version 1.3/ ,
Files => [qw/file1 file2/] ,
Description => "A very\n\nlong description"
]
] ;
my $fhw = IO::File->new ;
$fhw -> open ( 'dpkg_file' ,'>' ) ;
my $parser = MyParser->new() ;
$parser->write_dpkg_file($fhw,$data) ;
C<dpkg_file> will contain:
Name: Foo
Version: 1.2
Name: Bar
Version: 1.3
Files: file1,
file2
Description: A very
.
long description
=head1 DESCRIPTION
This module is a Moose role to read and write dpkg control files.
Debian control file are read and transformed in a list of list
matching the control file. The top level list of a list of section.
Each section is mapped to a list made of keywords and values. Since
this explanation is probably too abstract, here's an example of a file
written with Dpkg syntax:
Name: Foo
Version: 1.1
Name: Bar
# boy, new version
Version: 1.2
Description: A very
.
long description
Once parsed, this file will be stored in the following list of list :
(
[ Name => 'Foo', Version => '1.1' ],
[ Name => 'Bar', Version => [ '1.2' 'boy, new version' ],
Description => "A very\n\nlong description"
]
)
Note: The description is changed into a paragraph without the Dpkg
syntax idiosyncrasies. The leading white space is removed and the single
dot is transformed in to a "\n". These characters will be restored
when the file is written back.
Last not but not least, this module can be re-used outside of C<Config::Model> with some
small modifications in exception handing. Ask the author
if you want this module shipped in its own distribution.
=head1
=head2 parse_dpkg_file ( file_handle, check, comment_allowed )
Read a control file from the file_handle and returns a nested list (or a list
ref) containing data from the file.
The returned list is of the form :
[
# section 1
[ keyword1 => value1, # for text or simple values
keyword2 => value2, # etc
],
# section 2
[ ... ]
# etc ...
]
check is C<yes>, C<skip> or C<no>. C<comment_allowed> is boolean (default 0)
When comments are provided in the dpkg files, the returned list is of
the form :
[
[
keyword1 => [ value1, 'value1 comment']
keyword2 => value2, # no comment
],
[ ... ]
]
=head2 parse_dpkg_lines (lines, check, comment_allowed )
Parse the dpkg date from lines (which is an array ref) and return a data
structure like L<parse_dpkg_file>.
=head2 write_dpkg_file ( io_handle, list_ref, list_sep )
Munge the passed list ref into a string compatible with control files
and write it in the passed file handle.
The input is a list of list in a form similar to the one generated by
L<parse_dpkg_file>:
[ section [ keyword => value | value_list ] ]
Except that the value may be a SCALAR or a list ref. In case, of a list ref, the list
items will be joined with the value C<list_sep> before being written. Values will be aligned
in case of multi-line output of a list.
For instance the following code :
my $ref = [ [ Foo => 'foo value' , Bar => [ qw/v1 v2/ ] ];
write_dpkg_file ( $ioh, $ref, ', ' )
will yield:
Foo: foo value
Bar: v1, v2
=head1 AUTHOR
Dominique Dumont, (ddumont at cpan dot org)
=head1 SEE ALSO
L<Config::Model>,
L<Config::Model::AutoRead>,
L<Config::Model::Backend::Any>,
=cut
|