WebSocket/PMCE/deflate/Data.pm

filter: Statementstmt 90.4% 76 / 84 Branchbran 55.5% 10 / 18 Conditioncond 44.4% 8 / 18 MC/DCmcdc 0.0% 0 / 12 Subroutinesub 89.4% 17 / 19 Podpod 100% 4 / 4 totaltotal 74.1% 115 / 155 CC 16 SCAR 9.5
CC
16
Cov
78%
create_message
6.0
_compress
4.0
_create_inflate_obj
3.2
CRAP 2.6
« WebSocket/X/BadArg.pm ↑ Summary WebSocket/HTTP_R.pm »
1 package Net::WebSocket::PMCE::deflate::Data;
2  
3 3 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 3 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
5  
6 3 ▶use parent qw( Net::WebSocket::PMCE::Data );
Subroutine BEGIN: called CC=1 SCAR=0.0
7  
8 3 ▶use Net::WebSocket::FrameTypeName ();
Subroutine BEGIN: called CC=1 SCAR=0.0
9 3 ▶use Net::WebSocket::Message ();
Subroutine BEGIN: called CC=1 SCAR=0.0
10 3 ▶use Net::WebSocket::PMCE::deflate::Constants ();
Subroutine BEGIN: called CC=1 SCAR=0.0
11  
12 3 ▶use constant {
Subroutine BEGIN: called CC=1 SCAR=0.0
13 3 _ZLIB_SYNC_TAIL => "\0\0\xff\xff",
14 _DEBUG => 0,
15 3 };
16  
17 =encoding utf-8
18  
19 =head2 I<CLASS>->new( %OPTS )
20  
21 %OPTS is:
22  
23 =over
24  
25 =item C<deflate_max_window_bits> - optional; the number of window bits to use
26 for compressing messages. This should correspond with the local endpoint’s
27 behavior; i.e., for a server, this should match the C<server_max_window_bits>
28 extension parameter in the WebSocket handshake.
29  
30 =item C<inflate_max_window_bits> - optional; the number of window bits to use
31 for decompressing messages. This should correspond with the remote peer’s
32 behavior; i.e., for a server, this should match the C<client_max_window_bits>
33 extension parameter in the WebSocket handshake.
34  
35 =item C<deflate_no_context_takeover> - corresponds to either the
36 C<client_no_context_takeover> or C<server_no_context_takeover> parameter,
37 to match the local endpoint’s role. When this flag is set, the object
38 will do a full flush at the end of each C<compress()> call.
39  
40 =back
41  
42 =cut
43  
44 3 ▶sub new {
Subroutine new: called CC=2 SCAR=6.9
Pod documented
45 3 my ($class, %opts) = @_;
46  
47 #Validate deflate_max_window_bits/inflate_max_window_bits?
48  
49 3 my $compress_func = '_compress_';
50 3 ▶ $compress_func .= $opts{'deflate_no_context_takeover'} ? 'full' : 'sync';
Branch: 1 branch
BranchTrueFalseTotal
$opts{'deflate_no_context_takeover'} ? : 2 1 3
51 3 $compress_func .= '_flush_chomp';
52  
53 3 $opts{'final_frame_compress_func'} = $compress_func;
54  
55 3 return bless \%opts, $class;
56 }
57  
58 #----------------------------------------------------------------------
59  
60 =head2 $msg = I<OBJ>->create_message( FRAME_TYPE, PAYLOAD )
61  
62 Creates an unfragmented, compressed message. The message will be an
63 instance of L<Net::WebSocket::Message>.
64  
65 FRAME_TYPE can be either C<text> or C<binary> (for Net::WebSocket’s
66 default frame classes) or full package names (e.g., to use a custom
67 frame class).
68  
69 This method cannot be called while a streamer object has yet to create its
70 final frame.
71  
72 B<NOTE:> This function alters PAYLOAD.
73  
74 =cut
75  
76 0 ▶sub create_message {
Subroutine create_message: not called CC=2 SCAR=17.9
Pod documented
77 0 my ($self, $frame_type) = @_; #$_[2] = payload
78  
79 0 ▶ die "A streamer is active!" if $self->{'_streamer_mode'};
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"_streamer_mode"} 0 0 0
80  
81 0 my $compress_func = $self->{'final_frame_compress_func'};
82  
83 0 my $payload_sr = \($self->$compress_func( $_[2] ));
84  
85 0 my $frame_class = Net::WebSocket::FrameTypeName::get_module($frame_type);
86  
87 0 return Net::WebSocket::Message->new(
88 $frame_class->new(
89 payload => $payload_sr,
90 rsv => $self->INITIAL_FRAME_RSV(),
91 $self->FRAME_MASK_ARGS(),
92 ),
93 );
94 }
95  
96 #----------------------------------------------------------------------
97  
98 =head2 $msg = I<OBJ>->create_streamer( FRAME_TYPE )
99  
100 FRAME_TYPE can be either C<text> or C<binary> (for Net::WebSocket’s
101 default frame classes) or full package names (e.g., to use a custom
102 frame class).
103  
104 Returns an instance of L<Net::WebSocket::PMCE::deflate::Data::Streamer> based
105 on this object.
106  
107 =cut
108  
109 5 ▶sub create_streamer {
Subroutine create_streamer: called CC=1 SCAR=0.0
Pod documented
110 5 my ($self, $frame_type) = @_;
111  
112 5 $self->{'_streamer_mode'} = 1;
113  
114 5 require Net::WebSocket::PMCE::deflate::Data::Streamer;
115  
116 5 my $frame_class = Net::WebSocket::FrameTypeName::get_module($frame_type);
117  
118 5 return Net::WebSocket::PMCE::deflate::Data::Streamer->new($self, $frame_class);
119 }
120  
121 #----------------------------------------------------------------------
122  
123 =head2 $decompressed = I<OBJ>->decompress( COMPRESSED_PAYLOAD )
124  
125 Decompresses the given string and returns the result.
126  
127 B<NOTE:> This function alters COMPRESSED_PAYLOAD, such that
128 it’s probably not useful afterward.
129  
130 =cut
131  
132 #cf. RFC 7692, 7.2.2
133 5 ▶sub decompress {
Subroutine decompress: called CC=3 SCAR=11.1
Pod documented
134 5 my ($self) = @_; #$_[1] = payload
135  
136 5 ▶ $self->{'i'} ||= $self->_create_inflate_obj();
Condition66%2/3
$self->{"i"} ||= $self->_create_inflate_obj
l!l&&r!l&&!r
230
MC/DC0%0/2
$self->{"i"} ||= $self->_create_inflate_obj
$self->{"i"} $self->_create_inflate_obj
Truth table66%2/3
A ||= B
A= $self->{"i"}B= $self->_create_inflate_obj
ABresult
1X1
011
000
137  
138 5 _DEBUG && _debug(sprintf "inflating: %v.02x\n", $_[1]);
139  
140 5 $_[1] .= _ZLIB_SYNC_TAIL;
141  
142 5 my $status = $self->{'i'}->inflate($_[1], my $v);
143 5 ▶ die $status if $status != Compress::Raw::Zlib::Z_OK();
Branch: 1 branch
BranchTrueFalseTotal
if $status != Compress::Raw::Zlib::Z_OK() 0 5 5
144  
145 5 _DEBUG && _debug(sprintf "inflate output: [%v.02x]\n", $v);
146  
147 5 return $v;
148 }
149  
150 #----------------------------------------------------------------------
151  
152 3 my $_payload_sr;
153  
154 #cf. RFC 7692, 7.2.1
155 #Use for non-final fragments.
156 58 ▶sub _compress_non_final_fragment {
Subroutine _compress_non_final_fragment: called CC=2 SCAR=7.1
157 58 ▶ $_[0]->{'d'} ||= $_[0]->_create_deflate_obj();
Condition66%2/3
$_[0]{"d"} ||= $_[0]->_create_deflate_obj
l!l&&r!l&&!r
5530
MC/DC0%0/2
$_[0]{"d"} ||= $_[0]->_create_deflate_obj
$_[0]{"d"} $_[0]->_create_deflate_obj
Truth table66%2/3
A ||= B
A= $_[0]{"d"}B= $_[0]->_create_deflate_obj
ABresult
1X1
011
000
158  
159 58 return $_[0]->_compress( $_[1] );
160 }
161  
162 #Preserves sliding window to the next message.
163 #Use for final fragments when deflate_no_context_takeover is OFF
164 2 ▶sub _compress_sync_flush_chomp {
Subroutine _compress_sync_flush_chomp: called CC=2 SCAR=8.1
165 2 ▶ $_[0]->{'d'} ||= $_[0]->_create_deflate_obj();
Condition33%1/3
$_[0]{"d"} ||= $_[0]->_create_deflate_obj
l!l&&r!l&&!r
200
MC/DC0%0/2
$_[0]{"d"} ||= $_[0]->_create_deflate_obj
$_[0]{"d"} $_[0]->_create_deflate_obj
Truth table33%1/3
A ||= B
A= $_[0]{"d"}B= $_[0]->_create_deflate_obj
ABresult
1X1
011
000
166  
167 2 return _chomp_0000ffff_or_die( $_[0]->_compress( $_[1], Compress::Raw::Zlib::Z_SYNC_FLUSH() ) );
168 }
169  
170 #Flushes the sliding window.
171 #Use for final fragments when deflate_no_context_takeover is ON
172 3 ▶sub _compress_full_flush_chomp {
Subroutine _compress_full_flush_chomp: called CC=2 SCAR=8.1
173 3 ▶ $_[0]->{'d'} ||= $_[0]->_create_deflate_obj();
Condition33%1/3
$_[0]{"d"} ||= $_[0]->_create_deflate_obj
l!l&&r!l&&!r
300
MC/DC0%0/2
$_[0]{"d"} ||= $_[0]->_create_deflate_obj
$_[0]{"d"} $_[0]->_create_deflate_obj
Truth table33%1/3
A ||= B
A= $_[0]{"d"}B= $_[0]->_create_deflate_obj
ABresult
1X1
011
000
174  
175 3 return _chomp_0000ffff_or_die( $_[0]->_compress( $_[1], Compress::Raw::Zlib::Z_FULL_FLUSH() ) );
176 }
177  
178 5 ▶sub _chomp_0000ffff_or_die {
Subroutine _chomp_0000ffff_or_die: called CC=2 SCAR=7.6
179 5 ▶ if ( rindex( $_[0], _ZLIB_SYNC_TAIL ) == length($_[0]) - 4 ) {
Branch: 1 branch
BranchTrueFalseTotal
if (rindex($_[0], "\000\000\377\377") == length($_[0]) - 4) { } 5 0 5
180 5 substr($_[0], -4) = q<>;
181 }
182 else {
183 0 die sprintf('deflate/flush didn’t end with expected SYNC tail (00.00.ff.ff): %v.02x', $_[0]);
184 }
185  
186 5 return $_[0];
187 }
188  
189 63 ▶sub _compress {
Subroutine _compress: called CC=4 SCAR=13.9
190 63 my ($self) = @_; # $_[1] = payload; $_[2] = flush method
191  
192 63 $_payload_sr = \$_[1];
193  
194 63 _DEBUG && _debug(sprintf "to deflate: [%v.02x]", $$_payload_sr);
195  
196 63 my $out;
197  
198 63 my $dstatus = $self->{'d'}->deflate( $$_payload_sr, $out );
199 63 ▶ die "deflate: $dstatus" if $dstatus != Compress::Raw::Zlib::Z_OK();
Branch: 1 branch
BranchTrueFalseTotal
if $dstatus != Compress::Raw::Zlib::Z_OK() 0 63 63
200  
201 63 _DEBUG && _debug(sprintf "post-deflate output: [%v.02x]", $out);
202  
203 63 ▶ if ($_[2]) {
Branch: 1 branch
BranchTrueFalseTotal
if ($_[2]) 5 58 63
204 5 $dstatus = $self->{'d'}->flush($out, $_[2]);
205 5 ▶ die "deflate flush: $dstatus" if $dstatus != Compress::Raw::Zlib::Z_OK();
Branch: 1 branch
BranchTrueFalseTotal
if $dstatus != Compress::Raw::Zlib::Z_OK() 0 5 5
206  
207 5 undef $self->{'_streamer_mode'};
208  
209 5 _DEBUG && _debug(sprintf "post-flush output: [%v.02x]", $out);
210 }
211  
212 #NB: The RFC directs at this point that:
213 #
214 #If the resulting data does not end with an empty DEFLATE block
215 #with no compression (the "BTYPE" bits are set to 00), append an
216 #empty DEFLATE block with no compression to the tail end.
217 #
218 #… but I don’t know the protocol well enough to detect that??
219 #
220 #NB:
221 #> perl -MCompress::Raw::Zlib -e' my $deflate = Compress::Raw::Zlib::Deflate->new( -WindowBits => -8, -AppendOutput => 1, -Level => Compress::Raw::Zlib::Z_NO_COMPRESSION ); $deflate->deflate( "", my $out ); $deflate->flush( $out, Compress::Raw::Zlib::Z_SYNC_FLUSH()); print $out' | xxd
222 #00000000: 0000 00ff ff .....
223  
224 # if ( $_[2] == Compress::Raw::Zlib::Z_FULL_FLUSH() ) {
225 # if ( substr($out, -4) eq _ZLIB_SYNC_TAIL ) {
226 # substr($out, -4) = q<>;
227 # }
228 # else {
229 # die sprintf('deflate/flush didn’t end with expected SYNC tail (00.00.ff.ff): %v.02x', $out);
230 # }
231 # }
232  
233 63 return $out;
234 }
235  
236 #----------------------------------------------------------------------
237  
238 3 ▶sub _create_inflate_obj {
Subroutine _create_inflate_obj: called CC=3 SCAR=11.6
239 3 my ($self) = @_;
240  
241 3 ▶ my $window_bits = $self->{'inflate_max_window_bits'} || ( Net::WebSocket::PMCE::deflate::Constants::VALID_MAX_WINDOW_BITS() )[-1];
Condition33%1/3
$self->{'inflate_max_window_bits'} || (8..15)[-1]
l!l&&r!l&&!r
030
MC/DC0%0/2
$self->{'inflate_max_window_bits'} || (8..15)[-1]
$self->{'inflate_max_window_bits'} (8..15)[-1]
Truth table33%1/3
A || B
A= $self->{'inflate_max_window_bits'}B= (8..15)[-1]
ABresult
1X1
011
000
242  
243 3 require Compress::Raw::Zlib;
244  
245 3 my ($inflate, $istatus) = Compress::Raw::Zlib::Inflate->new(
246 -WindowBits => -$window_bits,
247 -AppendOutput => 1,
248 );
249 3 ▶ die "Inflate: $istatus" if $istatus != Compress::Raw::Zlib::Z_OK();
Branch: 1 branch
BranchTrueFalseTotal
if $istatus != Compress::Raw::Zlib::Z_OK() 0 3 3
250  
251 3 return $inflate;
252 }
253  
254 3 ▶sub _create_deflate_obj {
Subroutine _create_deflate_obj: called CC=3 SCAR=11.6
255 3 my ($self) = @_;
256  
257 3 ▶ my $window_bits = $self->{'deflate_max_window_bits'} || ( Net::WebSocket::PMCE::deflate::Constants::VALID_MAX_WINDOW_BITS() )[-1];
Condition33%1/3
$self->{'deflate_max_window_bits'} || (8..15)[-1]
l!l&&r!l&&!r
030
MC/DC0%0/2
$self->{'deflate_max_window_bits'} || (8..15)[-1]
$self->{'deflate_max_window_bits'} (8..15)[-1]
Truth table33%1/3
A || B
A= $self->{'deflate_max_window_bits'}B= (8..15)[-1]
ABresult
1X1
011
000
258  
259 3 require Compress::Raw::Zlib;
260  
261 3 my ($deflate, $dstatus) = Compress::Raw::Zlib::Deflate->new(
262 -WindowBits => -$window_bits,
263 -AppendOutput => 1,
264 );
265 3 ▶ die "Deflate: $dstatus" if $dstatus != Compress::Raw::Zlib::Z_OK();
Branch: 1 branch
BranchTrueFalseTotal
if $dstatus != Compress::Raw::Zlib::Z_OK() 0 3 3
266  
267 3 return $deflate;
268 }
269  
270 0 ▶sub _debug {
Subroutine _debug: not called CC=1 SCAR=6.9
271 0 print STDERR "$_[0]$/";
272 }
273  
274 3 1;
« WebSocket/X/BadArg.pm ↑ Summary WebSocket/HTTP_R.pm »