Finnigan/OLE2File.pm

filter: Statementstmt 90.3% 131 / 145 Branchbran 52.9% 18 / 34 Conditioncond 16.6% 1 / 6 MC/DCmcdc 0.0% 0 / 4 Subroutinesub 89.4% 17 / 19 Podpod 100% 13 / 13 totaltotal 81.4% 180 / 221 CC 24 SCAR 19.8
CC
24
Cov
81%
sector_size
14.8
decode
12.5
get_chain
6.3
CRAP 7.2
« Finnigan/OLE2DirectoryEntry.pm ↑ Summary Finnigan/Peaks.pm »
1 package Finnigan::OLE2File;
2  
3 2 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 2 ▶use warnings FATAL => qw( all );
Subroutine BEGIN: called CC=1 SCAR=0.0
5 2 our $VERSION = 0.0206;
6  
7 2 ▶use Finnigan;
Subroutine BEGIN: called CC=1 SCAR=0.0
8 2 ▶use base 'Finnigan::Decoder';
Subroutine BEGIN: called CC=1 SCAR=0.0
9 2 ▶use Carp qw/confess/;
Subroutine BEGIN: called CC=1 SCAR=0.0
10  
11 2 ▶use overload ('""' => 'stringify');
Subroutine BEGIN: called CC=1 SCAR=0.0
12  
13 2 my $NDIF = 109;
14 2 my $FAT_POINTER_SIZE = 4; # 32 bits
15 2 my $PROPERTY_SIZE = 128;
16 2 my $UNUSED = 0xFFFFFFFF; # -1
17 2 my $END_OF_CHAIN = 0xFFFFFFFE; # -2
18 2 my $FAT_SECTOR = 0xFFFFFFFD; # -3
19 2 my $DIF_SECTOR = 0xFFFFFFFC; # -4
20  
21 2 my %SPECIAL = ($END_OF_CHAIN => 1, $UNUSED => 1, $FAT_SECTOR => 1, $DIF_SECTOR => 1);
22  
23 1 ▶sub decode {
Subroutine decode: called CC=12 SCAR=25.3
Pod documented
24 1 my ($class, $stream, $version) = @_;
25  
26 1 my @fields = (
27 "magic" => ['a8', 'RawBytes'],
28 "header" => ['object', 'Finnigan::OLE2Header'],
29 );
30  
31 1 my $self = Finnigan::Decoder->read($stream, \@fields, $version);
32 1 bless $self, $class;
33  
34 1 ▶ die "incorect OLE2 id" unless $self->magic eq "\xD0\xCF\x11\xE0\xA1\xB1\x1A\xE1";
Branch: 1 branch
BranchTrueFalseTotal
unless $self->magic eq "\320\317\21\340\241\261\32\341" 0 1 1
35  
36 # configure values
37 1 $self->{stream} = $stream;
38 1 $self->{"sector size"} = (1 << $self->header->bb_log);
39 1 $self->{"fat count"} = $self->header->bb_count;
40 1 $self->{"items per fat"} = $self->{"sector size"} / 4; # (size of sector pointer)
41 1 $self->{"ss size"} = (1 << $self->header->sb_log);
42 1 $self->{"items per minifat"} = $self->{"items per fat"};
43  
44 # read the DIF (Double-Indirect FAT)
45 1 $self->SUPER::decode(
46 $stream,
47 ["dif" => ['object', 'Finnigan::OLE2DIF']],
48 [$self->header->dif_start, $self->header->dif_count],
49 );
50  
51 $self->{"block ref addr"} =
52 $self->{addr}
53 + $self->{data}->{magic}->{size}
54 + $self->{data}->{header}->{size}
55 1 + $NDIF * $FAT_POINTER_SIZE;
56  
57 # read the big FAT
58 1 $self->{fat} = [];
59 1 my $start = 0;
60 1 my $count = $self->{"items per fat"};
61 1 for my $index ( 0 .. scalar @{$self->dif->sect} - 1 ) {
62 2 my $block = $self->dif->sect->[$index];
63 2 ▶ last if $block == $UNUSED;
Branch: 1 branch
BranchTrueFalseTotal
if $block == $UNUSED 1 1 2
64 1 $self->seek_block($block);
65 1 $self->SUPER::decode(
66 $stream,
67 ["fat[$block]" => ['object', 'Finnigan::OLE2FAT']],
68 [$start, $count],
69 );
70 1 push @{$self->{fat}}, $self->{data}->{"fat[$block]"}->{value};
71 }
72  
73 # Read the mini-FAT
74 1 $self->{minifat} = [];
75 1 my @chain = $self->get_chain($self->header->sb_start, 'big');
76 1 $start = 0;
77 1 $count = $self->{"items per minifat"};
78 1 for my $index ( 0 .. $#chain ) {
79 1 my $block = $chain[$index];
80 1 $self->seek_block($block);
81 1 $self->SUPER::decode(
82 $stream,
83 ["minifat[$block]" => ['object', 'Finnigan::OLE2FAT']],
84 [$start, $count],
85 );
86 1 push @{$self->{minifat}}, $self->{data}->{"minifat[$block]"}->{value};
87 1 $start += $count;
88 }
89
90 # Read properties
91 1 @chain = $self->get_chain($self->header->bb_start, 'big');
92 1 my $prop_per_sector = int( $self->{"sector size"} / $PROPERTY_SIZE );
93 1 $self->{properties} = [];
94 1 foreach my $block ( @chain ) {
95 2 $self->seek_block($block);
96 2 foreach my $index ( 1 .. $prop_per_sector ) {
97 # read the property name and return to start
98 6 my $addr = tell $stream;
99 6 my $bytes_to_read = 64;
100 6 my $rec;
101 6 my $nbytes = CORE::read $stream, $rec, $bytes_to_read;
102 6 ▶ $nbytes == $bytes_to_read
Branch: 1 branch
BranchTrueFalseTotal
$nbytes == $bytes_to_read or die "could not read the $bytes_to_read bytes of property name at $addr" 6 0 6
103 or die "could not read the $bytes_to_read bytes of property name at $addr";
104 6 seek $stream, $addr, 0;
105  
106 6 my $charset;
107 6 ▶ if ( $rec =~ /^\w\0\w\0/ ) {
Branch: 3 branches
BranchTrueFalseTotal
if ($rec =~ /^\w\0\w\0/) { } 5 1 6
elsif ($rec =~ /^\0\w\0\w/) { } 0 1 1
elsif ($rec =~ /^\0{64}/) { } 1 0 1
108 5 $charset = "UTF-16-LE";
109 }
110 elsif ( $rec =~ /^\0\w\0\w/ ) {
111 0 $charset = "UTF-16-BE";
112 }
113 elsif ( $rec =~ /^\0{64}/ ) {
114 1 last; # a null entry indicates the end of directory
115 }
116 else {
117 0 ▶ my @hex = map { if (/[A-z]/) {$_} else { sprintf "%2.2x", ord($_) } } split("", $rec);
Branch: 1 branch
BranchTrueFalseTotal
if (/[A-z]/) { } 0 0 0
118 0 confess "unknown encoding or not a string at $addr (@hex)";
119 }
120  
121 5 $self->SUPER::decode(
122 $stream,
123 ["property[$block][$index]" => ['object', 'Finnigan::OLE2Property']],
124 [$self->header->bb_log, $charset]
125 );
126 5 push @{$self->{properties}}, $self->{data}->{"property[$block][$index]"}->{value};
127 }
128 }
129  
130 # read the small block depot (which resides in the root entry's data stream)
131 1 my $dir = new Finnigan::OLE2DirectoryEntry($self, 0);
132 1 $self->{rootdir} = $dir;
133 1 $self->{sbd} = $dir->data;
134  
135 1 return $self;
136 }
137  
138 0 ▶sub list {
Subroutine list: not called CC=1 SCAR=6.9
Pod documented
139 0 shift->{rootdir}->list();
140 }
141  
142 6 ▶sub stream {
Subroutine stream: called CC=1 SCAR=0.0
Pod documented
143 6 shift->{stream};
144 }
145  
146 1 ▶sub magic {
Subroutine magic: called CC=1 SCAR=0.0
Pod documented
147 1 shift->{data}->{magic}->{value};
148 }
149  
150 16 ▶sub header {
Subroutine header: called CC=1 SCAR=0.0
Pod documented
151 16 shift->{data}->{header}->{value};
152 }
153  
154 6 ▶sub dif {
Subroutine dif: called CC=1 SCAR=0.0
Pod documented
155 6 shift->{data}->{dif}->{value};
156 }
157  
158 0 ▶sub fat {
Subroutine fat: not called CC=1 SCAR=6.9
Pod documented
159 0 my ( $self, $block ) = @_;
160 0 shift->{data}->{"fat[$block]"}->{value};
161 }
162  
163 1 ▶sub stringify {
Subroutine stringify: called CC=1 SCAR=0.0
Pod documented
164 1 my $self = shift;
165  
166 1 my $n = scalar @{$self->{properties}};
167 1 return "Windows Compound Binary File: $n nodes";
168 }
169  
170 51 ▶sub sector_size {
Subroutine sector_size: called CC=6 SCAR=26.9
Pod documented
171 51 my ( $self, $stream_size ) = @_;
172 51 ▶ return $self->{"sector size"} unless $stream_size; # big by default
Branch: 1 branch
BranchTrueFalseTotal
unless $stream_size 0 51 51
173 51 ▶ return $self->{"sector size"} if $stream_size and $stream_size eq 'big';
Branch: 1 branch
BranchTrueFalseTotal
if $stream_size and $stream_size eq "big" 51 0 51
Condition33%1/3
$stream_size and $stream_size eq "big"
!ll&&!rl&&r
0051
MC/DC0%0/2
$stream_size and $stream_size eq "big"
$stream_size $stream_size eq "big"
Truth table33%1/3
A and B
A= $stream_sizeB= $stream_size eq "big"
ABresult
0X0
100
111
174 0 ▶ return $self->{"ss size"} if $stream_size and $stream_size eq 'mini';
Branch: 1 branch
BranchTrueFalseTotal
if $stream_size and $stream_size eq "mini" 0 0 0
Condition0%0/3
$stream_size and $stream_size eq "mini"
!ll&&!rl&&r
000
MC/DC0%0/2
$stream_size and $stream_size eq "mini"
$stream_size $stream_size eq "mini"
Truth table0%0/3
A and B
A= $stream_sizeB= $stream_size eq "mini"
ABresult
0X0
100
111
175 }
176  
177 7 ▶sub seek_block {
Subroutine seek_block: called CC=1 SCAR=0.0
Pod documented
178 7 my ($self, $block) = @_;
179 7 seek $self->{stream}, $self->{"block ref addr"} + $block * $self->sector_size('big'), 0;
180 }
181  
182 3 ▶sub read {
Subroutine read: called CC=3 SCAR=11.2
Pod documented
183 3 my ($self, $stream_size, $start, $blocks_to_read) = @_;
184 3 my $sector_size = $self->sector_size($stream_size);
185 3 ▶ if ( $stream_size eq 'big' ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($stream_size eq 'big') { } 3 0 3
186 3 my $rec;
187 3 my $addr = tell $self->stream;
188 3 my $bytes_to_read = $blocks_to_read * $sector_size;
189 3 $self->seek_block($start);
190 3 my $nbytes = CORE::read $self->stream, $rec, $bytes_to_read;
191 3 ▶ $nbytes == $bytes_to_read
Branch: 1 branch
BranchTrueFalseTotal
$nbytes == $bytes_to_read or die "could not read $bytes_to_read bytes of property name at $addr" 3 0 3
192 or die "could not read $bytes_to_read bytes of property name at $addr";
193 3 return $rec;
194 }
195 else {
196 0 return substr $self->{sbd}, $start*$sector_size, $blocks_to_read*$sector_size;
197 }
198 }
199  
200 6 ▶sub get_chain {
Subroutine get_chain: called CC=6 SCAR=18.5
Pod documented
201 6 my ($self, $start, $stream_size) = @_;
202  
203 6 my ($fat, $items_per_fat, $err_prefix);
204 6 my @result;
205 6 ▶ if ( $stream_size eq 'mini' ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($stream_size eq 'mini') { } 0 6 6
206 0 $fat = $self->{minifat};
207 0 $items_per_fat = $self->{"items per minifat"};
208 0 $err_prefix = "SFAT chain";
209 }
210 else {
211 6 $fat = $self->{fat};
212 6 $items_per_fat = $self->{"items per fat"};
213 6 $err_prefix = "FAT chain";
214 }
215  
216 6 my $block = $start;
217 6 my %block_set;
218 6 my $previous = $block;
219 6 ▶ while ( $block != $END_OF_CHAIN ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($block != $END_OF_CHAIN) 47 6 53
220 die (
221 sprintf "%s: Invalid block index (0x%08x), previous=%s", $err_prefix, $block, $previous
222 47 ▶ ) if $SPECIAL{$block};
Branch: 1 branch
BranchTrueFalseTotal
if $SPECIAL{$block} 0 47 47
223 die ( sprintf "%s: Found a loop (%s=>%s)", $err_prefix, $previous, $block )
224 47 ▶ if $block_set{$block};
Branch: 1 branch
BranchTrueFalseTotal
if $block_set{$block} 0 47 47
225 47 $block_set{$block}++;
226 47 push @result, $block;
227 47 $previous = $block;
228 47 my $index = int($block / $items_per_fat);
229 47 $block = $fat->[$index]->sect->[$block];
230 47 ▶ last unless defined $block;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $block 0 47 47
231 }
232  
233 6 return @result;
234 }
235  
236 1 ▶sub find {
Subroutine find: called CC=1 SCAR=0.0
Pod documented
237 1 my ($self, $path) = @_;
238 1 $self->{rootdir}->find($path);
239 }
240  
241 2 1;
242 __END__
« Finnigan/OLE2DirectoryEntry.pm ↑ Summary Finnigan/Peaks.pm »