blib/lib/POE/Wheel/FollowTail.pm

filter: Statementstmt 85.0% 244 / 287 Branchbran 59.3% 95 / 160 Conditioncond 41.8% 23 / 55 MC/DCmcdc 3.4% 1 / 29 Subroutinesub 91.3% 21 / 23 Podpod 80.0% 4 / 5 totaltotal 69.4% 388 / 559 CC 102 SCAR 38.9
CC
102
Cov
72%
new
98.3
__ANON__
73.3
__ANON__
32.0
CRAP 48.7
« blib/lib/POE/Wheel/Run.pm ↑ Summary blib/lib/POE/Component/Server/TCP.pm »
1 package POE::Wheel::FollowTail;
2  
3 21 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4  
5 21 ▶use vars qw($VERSION @ISA);
Subroutine BEGIN: called CC=1 SCAR=0.0
6 21 $VERSION = '1.370'; # NOTE - Should be #.### (three decimal places)
7  
8 21 ▶use Carp qw( croak carp );
Subroutine BEGIN: called CC=1 SCAR=0.0
9 21 ▶use Symbol qw( gensym );
Subroutine BEGIN: called CC=1 SCAR=0.0
10 21 ▶use POSIX qw(SEEK_SET SEEK_CUR SEEK_END S_ISCHR S_ISBLK);
Subroutine BEGIN: called CC=1 SCAR=0.0
11 21 ▶use POE qw(Wheel Driver::SysRW Filter::Line);
Subroutine BEGIN: called CC=1 SCAR=0.0
12 21 push @ISA, qw(POE::Wheel);
13 21 ▶use IO::Handle ();
Subroutine BEGIN: called CC=1 SCAR=0.0
14 21 ▶use Errno qw(ENOENT);
Subroutine BEGIN: called CC=1 SCAR=0.0
15  
16 0 ▶sub CRIMSON_SCOPE_HACK ($) { 0 }
Subroutine CRIMSON_SCOPE_HACK: not called CC=1 SCAR=6.9
Pod undocumented
17  
18 sub SELF_HANDLE () { 0 }
19 sub SELF_FILENAME () { 1 }
20 sub SELF_DRIVER () { 2 }
21 sub SELF_FILTER () { 3 }
22 sub SELF_INTERVAL () { 4 }
23 sub SELF_EVENT_INPUT () { 5 }
24 sub SELF_EVENT_ERROR () { 6 }
25 sub SELF_EVENT_RESET () { 7 }
26 sub SELF_UNIQUE_ID () { 8 }
27 sub SELF_STATE_READ () { 9 }
28 sub SELF_LAST_STAT () { 10 }
29 sub SELF_FOLLOW_MODE () { 11 }
30 sub SELF_EVENT_IDLE () { 12 }
31  
32 sub MODE_TIMER () { 0x01 } # Follow on a timer loop.
33 sub MODE_SELECT () { 0x02 } # Follow via select().
34  
35 # Turn on tracing. A lot of debugging occurred just after 0.11.
36 sub TRACE_POLL () { 0 }
37 sub TRACE_RESET () { 0 }
38 sub TRACE_STAT () { 0 }
39 sub TRACE_STAT_VERBOSE () { 0 }
40  
41 # Tk doesn't provide a SEEK method, as of 800.022
42 21 ▶BEGIN {
Subroutine BEGIN: called CC=2 SCAR=9.2
43 21 ▶ if (exists $INC{'Tk.pm'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $INC{"Tk.pm"}) 0 21 21
44 0 eval <<' EOE';
45 sub Tk::Event::IO::SEEK {
46 my $o = shift;
47 $o->wait(Tk::Event::IO::READABLE);
48 my $h = $o->handle;
49 sysseek($h, shift, shift);
50 }
51 EOE
52 }
53 }
54  
55 #------------------------------------------------------------------------------
56  
57 99 ▶sub new {
Subroutine new: called CC=34 SCAR=45.9
Pod documented
58 99 my $type = shift;
59 99 my %params = @_;
60  
61 99 ▶ croak "wheels no longer require a kernel reference as their first parameter"
Branch: 1 branch
BranchTrueFalseTotal
if @_ and ref $_[0] eq "POE::Kernel" 0 99 99
Condition33%1/3
@_ and ref $_[0] eq "POE::Kernel"
!ll&&!rl&&r
0990
MC/DC0%0/2
@_ and ref $_[0] eq "POE::Kernel"
@_ ref $_[0] eq "POE::Kernel"
Truth table33%1/3
A and B
A= @_B= ref $_[0] eq "POE::Kernel"
ABresult
0X0
100
111
62 if @_ and (ref($_[0]) eq 'POE::Kernel');
63  
64 99 ▶ croak "$type requires a working Kernel" unless (defined $poe_kernel);
Branch: 1 branch
BranchTrueFalseTotal
unless defined $POE::Wheel::FollowTail::poe_kernel 0 99 99
65  
66 croak "FollowTail requires a Handle or Filename parameter, but not both"
67 99 ▶ unless $params{Handle} xor defined $params{Filename};
Branch: 1 branch
BranchTrueFalseTotal
unless $params{"Handle"} xor defined $params{"Filename"} 0 99 99
Condition50%2/4
$params{"Handle"} xor defined $params{"Filename"}
l&&rl&&!r!l&&r!l&&!r
09270
MC/DC0%0/2
$params{"Handle"} xor defined $params{"Filename"}
$params{"Handle"} defined $params{"Filename"}
Truth table50%2/4
A xor B
A= $params{"Handle"}B= defined $params{"Filename"}
ABresult
110
101
011
000
68  
69 99 my $driver = delete $params{Driver};
70 99 ▶ $driver = POE::Driver::SysRW->new() unless defined $driver;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $driver 97 2 99
71  
72 99 my $filter = delete $params{Filter};
73 99 ▶ $filter = POE::Filter::Line->new() unless defined $filter;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $filter 94 5 99
74  
75 99 ▶ croak "InputEvent required" unless defined $params{InputEvent};
Branch: 1 branch
BranchTrueFalseTotal
unless defined $params{"InputEvent"} 0 99 99
76  
77 99 my $handle = $params{Handle};
78 99 my $filename = $params{Filename};
79  
80 my $poll_interval = (
81 defined($params{PollInterval})
82 ? $params{PollInterval}
83 99 ▶ : 1
Branch: 1 branch
BranchTrueFalseTotal
defined $params{'PollInterval'} ? : 5 94 99
84 );
85  
86 99 my $seek;
87 99 ▶ if (exists $params{SeekBack}) {
Branch: 2 branches
BranchTrueFalseTotal
if (exists $params{'SeekBack'}) { } 0 99 99
elsif (exists $params{'Seek'}) { } 0 99 99
88 0 $seek = $params{SeekBack} * -1;
89 0 ▶ if (exists $params{Seek}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $params{"Seek"}) 0 0 0
90 0 croak "can't have Seek and SeekBack at the same time";
91 }
92 }
93 elsif (exists $params{Seek}) {
94 0 $seek = $params{Seek};
95 }
96 else {
97 99 $seek = -4096;
98 }
99  
100 my $self = bless [
101 $handle, # SELF_HANDLE
102 $filename, # SELF_FILENAME
103 $driver, # SELF_DRIVER
104 $filter, # SELF_FILTER
105 $poll_interval, # SELF_INTERVAL
106 delete $params{InputEvent}, # SELF_EVENT_INPUT
107 delete $params{ErrorEvent}, # SELF_EVENT_ERROR
108 delete $params{ResetEvent}, # SELF_EVENT_RESET
109 &POE::Wheel::allocate_wheel_id(), # SELF_UNIQUE_ID
110 undef, # SELF_STATE_READ
111 [ (-1) x 8 ], # SELF_LAST_STAT
112 undef, # SELF_FOLLOW_MODE
113 delete $params{IdleEvent}, # SELF_EVENT_IDLE
114 99 ], $type;
115  
116 99 ▶ if (defined $filename) {
Branch: 2 branches
BranchTrueFalseTotal
if (defined $filename) { } 7 92 99
elsif (defined $handle) { } 92 0 92
117 7 $handle = $self->[SELF_HANDLE] = _open_file($filename);
118 7 ▶ $self->[SELF_LAST_STAT] = [ (stat $filename)[0..7] ] if $handle;
Branch: 1 branch
BranchTrueFalseTotal
if $handle 4 3 7
119 }
120 elsif (defined $handle) {
121 92 $self->[SELF_LAST_STAT] = [ (stat $handle)[0..7] ];
122 }
123  
124 # Honor SeekBack and discard partial input if we have a plain file
125 # that is successfully open at this point.
126 #
127 # SeekBack attempts to position the file pointer somewhere before
128 # the end of the file. If it's specified, we assume the user knows
129 # where a record begins. Otherwise we just seek back and discard
130 # everything to EOF so we can frame the input record.
131  
132 99 ▶ if (defined $handle) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $handle) 96 3 99
133  
134 # Handle is a plain file. Honor SeekBack and PollInterval.
135  
136 96 ▶ if (-f $handle) {
Branch: 1 branch
BranchTrueFalseTotal
if (-f $handle) 93 3 96
137 93 my $end = sysseek($self->[SELF_HANDLE], 0, SEEK_END);
138  
139 # Seeking back from EOF.
140 93 ▶ if ($seek < 0) {
Branch: 4 branches
BranchTrueFalseTotal
if ($seek < 0) { } 93 0 93
elsif ($seek > 0) { } 0 0 0
elsif (exists $params{'Seek'}) { } 0 0 0
elsif (exists $params{'SeekBack'}) { } 0 0 0
141 93 ▶ if (defined($end) and ($end < -$seek)) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $end and $end < -$seek) { } 93 0 93
Condition33%1/3
defined $end and $end < -$seek
!ll&&!rl&&r
0093
MC/DC0%0/2
defined $end and $end < -$seek
defined $end $end < -$seek
Truth table33%1/3
A and B
A= defined $endB= $end < -$seek
ABresult
0X0
100
111
142 93 sysseek($self->[SELF_HANDLE], 0, SEEK_SET);
143 }
144 else {
145 0 sysseek($self->[SELF_HANDLE], $seek, SEEK_END);
146 }
147 }
148  
149 # Seeking forward from the beginning of the file.
150 elsif ($seek > 0) {
151 0 ▶ if ($seek > $end) {
Branch: 1 branch
BranchTrueFalseTotal
if ($seek > $end) { } 0 0 0
152 0 sysseek($self->[SELF_HANDLE], 0, SEEK_END);
153 }
154 else {
155 0 sysseek($self->[SELF_HANDLE], $seek, SEEK_SET);
156 }
157 }
158  
159 # If they set Seek to 0, we start at the beginning of the file.
160 # If it was SeekBack, we start at the end.
161 elsif (exists $params{Seek}) {
162 0 sysseek($self->[SELF_HANDLE], 0, SEEK_SET);
163 }
164 elsif (exists $params{SeekBack}) {
165 0 sysseek($self->[SELF_HANDLE], 0, SEEK_END);
166 }
167 else {
168 0 die; # Should never happen.
169 }
170  
171 # Discard partial input chunks unless a SeekBack was specified.
172 93 ▶ unless (defined $params{SeekBack} or defined $params{Seek}) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $params{"SeekBack"} or defined $params{"Seek"}) 93 0 93
Condition33%1/3
defined $params{"SeekBack"} or defined $params{"Seek"}
l!l&&r!l&&!r
0093
MC/DC0%0/2
defined $params{"SeekBack"} or defined $params{"Seek"}
defined $params{"SeekBack"} defined $params{"Seek"}
Truth table33%1/3
A or B
A= defined $params{"SeekBack"}B= defined $params{"Seek"}
ABresult
1X1
011
000
173 93 ▶ while (defined(my $raw_input = $driver->get($self->[SELF_HANDLE]))) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined(my $raw_input = $driver->get($self->[0]))) 1 93 94
174 # Skip out if there's no more input.
175 1 ▶ last unless @$raw_input;
Branch: 1 branch
BranchTrueFalseTotal
unless @$raw_input 0 1 1
176 1 $filter->get($raw_input);
177 }
178 }
179  
180 # Start the timer loop.
181 93 $self->[SELF_FOLLOW_MODE] = MODE_TIMER;
182 93 $self->_define_timer_states();
183  
184 93 return $self;
185 }
186  
187 # Strange things that ought not be tailed? Directories...
188  
189 3 ▶ if (-d $self->[SELF_HANDLE]) {
Branch: 1 branch
BranchTrueFalseTotal
if (-d $self->[0]) 0 3 3
190 0 croak "FollowTail does not tail directories";
191 }
192  
193 # Handle is not a plain file.
194 # Can only honor SeekBack if it's zero.
195  
196 carp "POE::Wheel::FollowTail can't SeekBack special files"
197 3 ▶ if $params{SeekBack};
Branch: 1 branch
BranchTrueFalseTotal
if $params{"SeekBack"} 0 3 3
198  
199 # The handle isn't legal to multiplex on this platform.
200 3 ▶ if (POE::Kernel::RUNNING_IN_HELL and not -S $handle) {
Branch: 1 branch
BranchTrueFalseTotal
if (POE::Kernel::RUNNING_IN_HELL() and not -S $handle) 0 3 3
Condition33%1/3
POE::Kernel::RUNNING_IN_HELL() and not -S $handle
!ll&&!rl&&r
300
MC/DC0%0/2
POE::Kernel::RUNNING_IN_HELL() and not -S $handle
POE::Kernel::RUNNING_IN_HELL() not -S $handle
Truth table33%1/3
A and not(B)
A= POE::Kernel::RUNNING_IN_HELL()B= not -S $handle
ABresult
0X0
100
111
201 0 $self->[SELF_FOLLOW_MODE] = MODE_TIMER;
202 0 $self->_define_timer_states();
203 0 return $self;
204 }
205  
206 # Multiplexing should be more efficient where it's supported.
207  
208 carp "FollowTail does not need PollInterval for special files"
209 3 ▶ if defined $params{PollInterval};
Branch: 1 branch
BranchTrueFalseTotal
if defined $params{"PollInterval"} 0 3 3
210  
211 3 $self->[SELF_FOLLOW_MODE] = MODE_SELECT;
212 3 $self->_define_select_states();
213 3 return $self;
214 }
215  
216 # We don't have an open filehandle yet. We can't tell whether
217 # multiplexing is legal, and we can't seek back yet. Don't honor
218 # either.
219  
220 3 $self->[SELF_FOLLOW_MODE] = MODE_TIMER;
221 3 $self->_define_timer_states();
222 3 return $self;
223 }
224  
225 ### Define the select based polling loop. This relies on stupid
226 ### closure tricks to keep references to $self out of anonymous
227 ### coderefs. Otherwise a circular reference would occur, and the
228 ### wheel would never self-destruct.
229  
230 3 ▶sub _define_select_states {
Subroutine _define_select_states: called CC=1 SCAR=0.1
231 3 my $self = shift;
232  
233 3 my $filter = $self->[SELF_FILTER];
234 3 my $driver = $self->[SELF_DRIVER];
235 3 my $handle = \$self->[SELF_HANDLE];
236 3 my $unique_id = $self->[SELF_UNIQUE_ID];
237 3 my $event_input = \$self->[SELF_EVENT_INPUT];
238 3 my $event_error = \$self->[SELF_EVENT_ERROR];
239 3 my $event_reset = \$self->[SELF_EVENT_RESET];
240 3 my $event_idle = \$self->[SELF_EVENT_IDLE];
241  
242 3 TRACE_POLL and warn "<poll> defining select state";
243  
244 $poe_kernel->state(
245 $self->[SELF_STATE_READ] = ref($self) . "($unique_id) -> select read",
246 23 ▶ sub {
Subroutine __ANON__: called CC=9 SCAR=22.9
247  
248 # Protects against coredump on older perls.
249 23 0 && CRIMSON_SCOPE_HACK('<');
250  
251 # The actual code starts here.
252 23 my ($k, $ses) = @_[KERNEL, SESSION];
253  
254 # Reset position.
255 23 eval { sysseek($$handle, 0, SEEK_CUR) };
256 23 $! = 0;
257  
258 23 TRACE_POLL and warn "<poll> " . time . " read ok";
259  
260 # Read the next chunk, and return its data. Go around again.
261 23 ▶ if (defined(my $raw_input = $driver->get($$handle))) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined(my $raw_input = $driver->get($$handle))) { } 21 2 23
262 21 TRACE_POLL and warn "<poll> " . time . " raw input";
263 21 $filter->get_one_start($raw_input);
264 21 my $cooked_array;
265 21 ▶ while (@{$cooked_array = $filter->get_one()}) {
Branch: 1 branch
BranchTrueFalseTotal
if (@{$cooked_array = $filter->get_one;}) 24 21 45
266 24 foreach my $cooked_input (@$cooked_array) {
267 24 TRACE_POLL and warn "<poll> " . time . " cooked input";
268 24 $k->call($ses, $$event_input, $cooked_input, $unique_id);
269 }
270 }
271  
272 # Clear the filehandle's EOF status, if any.
273 21 IO::Handle::clearerr($$handle);
274  
275 21 return;
276 }
277  
278 # Error reading. Report the error if it's not EOF, or if it's
279 # EOF on a socket or TTY. Shut down the select, too.
280 else {
281 2 ▶ if ($! or (-S $$handle) or (-t $$handle)) {
Branch: 2 branches
BranchTrueFalseTotal
if ($! or -S $$handle or -t $$handle) { } 2 0 2
elsif (defined $$event_idle) { } 0 0 0
Condition33%2/6
$! or -S $$handle or -t $$handle
l!l&&r!l&&!r
200
$! or -S $$handle
l!l&&r!l&&!r
020
MC/DC0%0/3
$! or -S $$handle or -t $$handle
$! -S $$handle -t $$handle
Truth table25%1/4
A or B or C
A= $!B= -S $$handleC= -t $$handle
ABCresult
1XX1
01X1
0011
0000
282 2 TRACE_POLL and warn "<poll> " . time . " error: $!";
283 2 ▶ $$event_error and
Branch: 1 branch
BranchTrueFalseTotal
$$event_error and $k->call($ses, $$event_error, "read", $! + 0, $!, $unique_id) 2 0 2
284 $k->call($ses, $$event_error, 'read', ($!+0), $!, $unique_id);
285 }
286 elsif (defined $$event_idle) {
287 0 $k->call($ses, $$event_idle, $unique_id);
288 }
289  
290 2 $k->select_read($$handle => undef);
291 2 eval { IO::Handle::clearerr($$handle) }; # could be a globref
292 }
293 }
294 3 );
295  
296 3 $poe_kernel->select_read($$handle, $self->[SELF_STATE_READ]);
297 }
298  
299 ### Define the timer based polling loop. This also relies on stupid
300 ### closure tricks.
301  
302 96 ▶sub _define_timer_states {
Subroutine _define_timer_states: called CC=2 SCAR=6.9
303 96 my $self = shift;
304  
305 # Tail by filename.
306 96 ▶ if (defined $self->[SELF_FILENAME]) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $self->[1]) { } 6 90 96
307 6 TRACE_POLL and warn "<poll> defining timer state for filename tail";
308 6 $self->_generate_filename_timer();
309 }
310 else {
311 90 TRACE_POLL and warn "<poll> defining timer state for handle tail";
312 90 $self->_generate_filehandle_timer();
313 }
314  
315 # Fire up the loop. The delay() aspect of the loop will prevent
316 # duplicate events from being significant for long.
317 96 $poe_kernel->delay($self->[SELF_STATE_READ], 0);
318 }
319  
320 90 ▶sub _generate_filehandle_timer {
Subroutine _generate_filehandle_timer: called CC=1 SCAR=0.6
321 90 my $self = shift;
322  
323 90 my $filter = $self->[SELF_FILTER];
324 90 my $driver = $self->[SELF_DRIVER];
325 90 my $unique_id = $self->[SELF_UNIQUE_ID];
326 90 my $poll_interval = $self->[SELF_INTERVAL];
327 90 my $last_stat = $self->[SELF_LAST_STAT];
328  
329 90 my $filename = \$self->[SELF_FILENAME];
330 90 my $handle = \$self->[SELF_HANDLE];
331 90 my $event_input = \$self->[SELF_EVENT_INPUT];
332 90 my $event_error = \$self->[SELF_EVENT_ERROR];
333 90 my $event_reset = \$self->[SELF_EVENT_RESET];
334 90 my $event_idle = \$self->[SELF_EVENT_IDLE];
335  
336 90 $self->[SELF_STATE_READ] = ref($self) . "($unique_id) -> handle timer read";
337 90 my $state_read = \$self->[SELF_STATE_READ];
338  
339 $poe_kernel->state(
340 $$state_read,
341 410 ▶ sub {
Subroutine __ANON__: called CC=23 SCAR=42.9
342  
343 # Protects against coredump on older perls.
344 410 0 && CRIMSON_SCOPE_HACK('<');
345  
346 # The actual code starts here.
347 410 my ($k, $ses) = @_[KERNEL, SESSION];
348  
349 # File isn't open? We're done.
350 410 ▶ unless (defined $$handle and fileno $$handle) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $$handle and fileno $$handle) 0 410 410
Condition33%1/3
defined $$handle and fileno $$handle
!ll&&!rl&&r
00410
MC/DC0%0/2
defined $$handle and fileno $$handle
defined $$handle fileno $$handle
Truth table33%1/3
A and B
A= defined $$handleB= fileno $$handle
ABresult
0X0
100
111
351 0 TRACE_POLL and warn "<poll> ", time, " $$handle closed";
352 0 ▶ $$event_error and
Branch: 1 branch
BranchTrueFalseTotal
$$event_error and $k->call($ses, $$event_error, "read", 0, "", $unique_id) 0 0 0
353 $k->call($ses, $$event_error, 'read', 0, "", $unique_id);
354 0 return;
355 }
356  
357 # Reset position.
358 410 eval { sysseek($$handle, 0, SEEK_CUR) };
359 410 $! = 0;
360  
361 # Read the next chunk, and return its data. Go around again.
362 410 ▶ if (defined(my $raw_input = $driver->get($$handle))) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined(my $raw_input = $driver->get($$handle))) 163 247 410
363 163 TRACE_POLL and warn "<poll> " . time . " raw input";
364 163 $filter->get_one_start($raw_input);
365 163 while (1) {
366 2180 my $next_rec = $filter->get_one();
367 2180 ▶ last unless @$next_rec;
Branch: 1 branch
BranchTrueFalseTotal
unless @$next_rec 152 2028 2180
368 2028 foreach my $cooked_input (@$next_rec) {
369 2028 TRACE_POLL and warn "<poll> " . time . " cooked input";
370 2028 $k->call($ses, $$event_input, $cooked_input, $unique_id);
371 }
372 }
373  
374 # Clear the filehandle's EOF status, if any.
375 152 IO::Handle::clearerr($$handle);
376  
377 # Must use a timer so that it can be cleared in DESTROY.
378 152 ▶ $k->delay($$state_read, 0) if defined $$state_read;
Branch: 1 branch
BranchTrueFalseTotal
if defined $$state_read 85 67 152
379 152 return;
380 }
381  
382 # Some kind of important error?
383 247 ▶ if ($!) {
Branch: 1 branch
BranchTrueFalseTotal
if ($!) 0 247 247
384 0 TRACE_POLL and warn "<poll> ", time, " $$handle error: $!";
385 0 ▶ $$event_error and
Branch: 1 branch
BranchTrueFalseTotal
$$event_error and $k->call($ses, $$event_error, "read", $! + 0, "$!", $unique_id) 0 0 0
386 $k->call($ses, $$event_error, 'read', ($!+0), "$!", $unique_id);
387 0 return;
388 }
389  
390 # Merely EOF. Check for file rotation.
391  
392 247 ▶ my @new_stat = (
Branch: 1 branch
BranchTrueFalseTotal
defined $$filename ? : 0 247 247
393 (defined $$filename)
394 ? ((stat $$filename)[0..7])
395 : ((stat $$handle)[0..7])
396 );
397  
398 247 ▶ unless (@new_stat) {
Branch: 1 branch
BranchTrueFalseTotal
unless (@new_stat) 0 247 247
399 0 TRACE_POLL and warn "<poll> ", time, " $$handle stat error";
400 0 ▶ $$event_error and
Branch: 1 branch
BranchTrueFalseTotal
$$event_error and $k->call($ses, $$event_error, "stat", $! + 0, "$!", $unique_id) 0 0 0
401 $k->call($ses, $$event_error, 'stat', ($!+0), "$!", $unique_id);
402 0 return;
403 }
404  
405 247 TRACE_STAT_VERBOSE and do {
406 my @test_new = @new_stat;
407 my @test_old = @$last_stat;
408 warn "<stat> from: @test_old\n<stat> to : @test_new" if (
409 "@test_new" ne "@test_old"
410 );
411 };
412  
413 # Ignore rdev changes for non-device files
414 247 eval {
415 247 ▶ if (!S_ISBLK($new_stat[2]) and !S_ISCHR($new_stat[2])) {
Branch: 1 branch
BranchTrueFalseTotal
unless (S_ISBLK($new_stat[2]) or S_ISCHR($new_stat[2])) 247 0 247
Condition33%1/3
S_ISBLK($new_stat[2]) or S_ISCHR($new_stat[2])
l!l&&r!l&&!r
00247
MC/DC0%0/2
S_ISBLK($new_stat[2]) or S_ISCHR($new_stat[2])
S_ISBLK($new_stat[2]) S_ISCHR($new_stat[2])
Truth table33%1/3
A or B
A= S_ISBLK($new_stat[2])B= S_ISCHR($new_stat[2])
ABresult
1X1
011
000
416 247 $last_stat->[6] = $new_stat[6];
417 }
418 };
419  
420 # Something fundamental about the file changed.
421 # Consider it a reset, and try to rewind to the top of the file.
422 247 ▶ if (
Branch: 2 branches
BranchTrueFalseTotal
if ($new_stat[1] != $last_stat->[1] or $new_stat[0] != $last_stat->[0] or $new_stat[6] != $last_stat->[6] or $new_stat[3] != $last_stat->[3] or $new_stat[7] < $last_stat->[7]) { } 0 247 247
elsif (defined $$event_idle) { } 0 247 247
Condition33%4/12
$new_stat[1] != $last_stat->[1] or $new_stat[0] != $last_stat->[0] or $new_stat[6] != $last_stat->[6] or $new_stat[3] != $last_stat->[3] or $new_stat[7] < $last_stat->[7]
l!l&&r!l&&!r
00247
$new_stat[1] != $last_stat->[1] or $new_stat[0] != $last_stat->[0] or $new_stat[6] != $last_stat->[6] or $new_stat[3] != $last_stat->[3]
l!l&&r!l&&!r
00247
$new_stat[1] != $last_stat->[1] or $new_stat[0] != $last_stat->[0] or $new_stat[6] != $last_stat->[6]
l!l&&r!l&&!r
00247
$new_stat[1] != $last_stat->[1] or $new_stat[0] != $last_stat->[0]
l!l&&r!l&&!r
00247
MC/DC0%0/5
$new_stat[1] != $last_stat->[1] or $new_stat[0] != $last_stat->[0] or $new_stat[6] != $last_stat->[6] or $new_stat[3] != $last_stat->[3] or $new_stat[7] < $last_stat->[7]
$new_stat[1] != $last_stat->[1] $new_stat[0] != $last_stat->[0] $new_stat[6] != $last_stat->[6] $new_stat[3] != $last_stat->[3] $new_stat[7] < $last_stat->[7]
Truth table16%1/6
A or B or C or D or E
A= $new_stat[1] != $last_stat->[1]B= $new_stat[0] != $last_stat->[0]C= $new_stat[6] != $last_stat->[6]D= $new_stat[3] != $last_stat->[3]E= $new_stat[7] < $last_stat->[7]
ABCDEresult
1XXXX1
01XXX1
001XX1
0001X1
000011
000000
423 $new_stat[1] != $last_stat->[1] or # inode's number
424 $new_stat[0] != $last_stat->[0] or # inode's device
425 $new_stat[6] != $last_stat->[6] or # device type
426 $new_stat[3] != $last_stat->[3] or # number of links
427 $new_stat[7] < $last_stat->[7] # size reduced
428 ) {
429 0 TRACE_STAT and do {
430 warn "<stat> inode $new_stat[1] != old $last_stat->[1]"
431 if $new_stat[1] != $last_stat->[1];
432 warn "<stat> inode device $new_stat[0] != old $last_stat->[0]"
433 if $new_stat[0] != $last_stat->[0];
434 warn "<stat> device type $new_stat[6] != old $last_stat->[6]"
435 if $new_stat[6] != $last_stat->[6];
436 warn "<stat> link count $new_stat[3] != old $last_stat->[3]"
437 if $new_stat[3] != $last_stat->[3];
438 warn "<stat> file size $new_stat[7] < old $last_stat->[7]"
439 if $new_stat[7] < $last_stat->[7];
440 };
441  
442 # File has reset.
443 0 TRACE_RESET and warn "<reset> filehandle has reset";
444 0 ▶ $$event_reset and $k->call($ses, $$event_reset, $unique_id);
Branch: 1 branch
BranchTrueFalseTotal
$$event_reset and $k->call($ses, $$event_reset, $unique_id) 0 0 0
445  
446 0 sysseek($$handle, 0, SEEK_SET);
447 }
448 elsif (defined $$event_idle) {
449 0 $k->call($ses, $$event_idle, $unique_id);
450 }
451  
452 # The file didn't roll. Try again shortly.
453 247 @$last_stat = @new_stat;
454 247 IO::Handle::clearerr($$handle);
455 247 ▶ $k->delay($$state_read, $poll_interval) if defined $$state_read;
Branch: 1 branch
BranchTrueFalseTotal
if defined $$state_read 247 0 247
456 247 return;
457 }
458 90 );
459 }
460  
461 6 ▶sub _generate_filename_timer {
Subroutine _generate_filename_timer: called CC=1 SCAR=0.1
462 6 my $self = shift;
463  
464 6 my $filter = $self->[SELF_FILTER];
465 6 my $driver = $self->[SELF_DRIVER];
466 6 my $unique_id = $self->[SELF_UNIQUE_ID];
467 6 my $poll_interval = $self->[SELF_INTERVAL];
468 6 my $filename = $self->[SELF_FILENAME];
469 6 my $last_stat = $self->[SELF_LAST_STAT];
470  
471 6 my $handle = \$self->[SELF_HANDLE];
472 6 my $event_input = \$self->[SELF_EVENT_INPUT];
473 6 my $event_error = \$self->[SELF_EVENT_ERROR];
474 6 my $event_reset = \$self->[SELF_EVENT_RESET];
475 6 my $event_idle = \$self->[SELF_EVENT_IDLE];
476  
477 6 $self->[SELF_STATE_READ] = ref($self) . "($unique_id) -> name timer read";
478 6 my $state_read = \$self->[SELF_STATE_READ];
479  
480 $poe_kernel->state(
481 $$state_read,
482 33 ▶ sub {
Subroutine __ANON__: called CC=25 SCAR=34.6
483  
484 # Protects against coredump on older perls.
485 33 0 && CRIMSON_SCOPE_HACK('<');
486  
487 # The actual code starts here.
488 33 my ($k, $ses) = @_[KERNEL, SESSION];
489  
490 # File isn't open? Try to open it.
491 33 ▶ unless ($$handle) {
Branch: 1 branch
BranchTrueFalseTotal
if ($$handle) { } 22 11 33
492 11 $$handle = _open_file($filename);
493  
494 # Couldn't open yet.
495 11 ▶ unless ($$handle) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($$handle) 5 6 11
496 5 ▶ $k->call($ses, $$event_idle, $unique_id) if defined $$event_idle;
Branch: 1 branch
BranchTrueFalseTotal
if defined $$event_idle 5 0 5
497 5 ▶ $k->delay($$state_read, $poll_interval) if defined $$state_read;
Branch: 1 branch
BranchTrueFalseTotal
if defined $$state_read 5 0 5
498 5 return;
499 }
500  
501 # File has reset.
502 6 TRACE_RESET and warn "<reset> file name has reset";
503 6 ▶ $$event_reset and $k->call($ses, $$event_reset, $unique_id);
Branch: 1 branch
BranchTrueFalseTotal
$$event_reset and $k->call($ses, $$event_reset, $unique_id) 6 0 6
504  
505 6 @$last_stat = (stat $filename)[0..7];
506 }
507 else {
508 # Reset position.
509 22 eval { sysseek($$handle, 0, SEEK_CUR) };
510 22 $! = 0;
511 }
512  
513 # Read the next chunk, and return its data. Go around again.
514 28 ▶ if (defined(my $raw_input = $driver->get($$handle))) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined(my $raw_input = $driver->get($$handle))) 17 11 28
515 17 TRACE_POLL and warn "<poll> " . time . " raw input";
516 17 $filter->get_one_start($raw_input);
517 17 my $cooked_array;
518 17 ▶ while (@{$cooked_array = $filter->get_one()}) {
Branch: 1 branch
BranchTrueFalseTotal
if (@{$cooked_array = $filter->get_one;}) 21 17 38
519 21 foreach my $cooked_input (@$cooked_array) {
520 21 TRACE_POLL and warn "<poll> " . time . " cooked input";
521 21 $k->call($ses, $$event_input, $cooked_input, $unique_id);
522 }
523 }
524  
525 # Clear the filehandle's EOF status, if any.
526 17 IO::Handle::clearerr($$handle);
527  
528 # Must use a timer so that it can be cleared in DESTROY.
529 17 ▶ $k->delay($$state_read, 0) if defined $$state_read;
Branch: 1 branch
BranchTrueFalseTotal
if defined $$state_read 12 5 17
530 17 return;
531 }
532  
533 # Some kind of important error?
534 11 ▶ if ($!) {
Branch: 1 branch
BranchTrueFalseTotal
if ($!) 0 11 11
535 0 TRACE_POLL and warn "<poll> ", time, " $$handle error: $!";
536 0 ▶ $$event_error and
Branch: 1 branch
BranchTrueFalseTotal
$$event_error and $k->call($ses, $$event_error, "read", $! + 0, "$!", $unique_id) 0 0 0
537 $k->call($ses, $$event_error, 'read', ($!+0), "$!", $unique_id);
538 0 return;
539 }
540  
541 # Merely EOF. Check for file rotation.
542 11 my @new_stat = (stat $filename)[0..7];
543 11 ▶ unless (@new_stat) {
Branch: 1 branch
BranchTrueFalseTotal
unless (@new_stat) 2 9 11
544 2 TRACE_POLL and warn "<poll> ", time, " $filename stat error: $!";
545 2 ▶ if ($! != ENOENT) {
Branch: 1 branch
BranchTrueFalseTotal
if ($! != 2) 0 2 2
546 0 ▶ $$event_error and
Branch: 1 branch
BranchTrueFalseTotal
$$event_error and $k->call($ses, $$event_error, "stat", $! + 0, "$!", $unique_id) 0 0 0
547 $k->call($ses, $$event_error, 'stat', ($!+0), "$!", $unique_id);
548 0 return;
549 }
550 2 @new_stat = (-1) x 8;
551 }
552  
553 11 TRACE_STAT_VERBOSE and do {
554 my @test_new = @new_stat;
555 my @test_old = @$last_stat;
556 warn "<stat> from: @test_old\n<stat> to : @test_new" if (
557 "@test_new" ne "@test_old"
558 );
559 };
560  
561 # Ignore rdev changes for non-device files
562 11 eval {
563 11 ▶ if (!S_ISBLK($new_stat[2]) and !S_ISCHR($new_stat[2])) {
Branch: 1 branch
BranchTrueFalseTotal
unless (S_ISBLK($new_stat[2]) or S_ISCHR($new_stat[2])) 11 0 11
Condition33%1/3
S_ISBLK($new_stat[2]) or S_ISCHR($new_stat[2])
l!l&&r!l&&!r
0011
MC/DC0%0/2
S_ISBLK($new_stat[2]) or S_ISCHR($new_stat[2])
S_ISBLK($new_stat[2]) S_ISCHR($new_stat[2])
Truth table33%1/3
A or B
A= S_ISBLK($new_stat[2])B= S_ISCHR($new_stat[2])
ABresult
1X1
011
000
564 11 $last_stat->[6] = $new_stat[6];
565 }
566 };
567  
568 # Something fundamental about the file changed.
569 # Consider it a reset, and close the file.
570 11 ▶ if (
Branch: 2 branches
BranchTrueFalseTotal
if ($new_stat[1] != $last_stat->[1] or $new_stat[0] != $last_stat->[0] or $new_stat[6] != $last_stat->[6] or $new_stat[3] != $last_stat->[3] or $new_stat[7] < $last_stat->[7]) { } 3 8 11
elsif (defined $$event_idle) { } 2 6 8
Condition66%8/12
$new_stat[1] != $last_stat->[1] or $new_stat[0] != $last_stat->[0] or $new_stat[6] != $last_stat->[6] or $new_stat[3] != $last_stat->[3] or $new_stat[7] < $last_stat->[7]
l!l&&r!l&&!r
308
$new_stat[1] != $last_stat->[1] or $new_stat[0] != $last_stat->[0] or $new_stat[6] != $last_stat->[6] or $new_stat[3] != $last_stat->[3]
l!l&&r!l&&!r
308
$new_stat[1] != $last_stat->[1] or $new_stat[0] != $last_stat->[0] or $new_stat[6] != $last_stat->[6]
l!l&&r!l&&!r
308
$new_stat[1] != $last_stat->[1] or $new_stat[0] != $last_stat->[0]
l!l&&r!l&&!r
308
MC/DC20%1/5
$new_stat[1] != $last_stat->[1] or $new_stat[0] != $last_stat->[0] or $new_stat[6] != $last_stat->[6] or $new_stat[3] != $last_stat->[3] or $new_stat[7] < $last_stat->[7]
$new_stat[1] != $last_stat->[1] $new_stat[0] != $last_stat->[0] $new_stat[6] != $last_stat->[6] $new_stat[3] != $last_stat->[3] $new_stat[7] < $last_stat->[7]
Truth table33%2/6
A or B or C or D or E
A= $new_stat[1] != $last_stat->[1]B= $new_stat[0] != $last_stat->[0]C= $new_stat[6] != $last_stat->[6]D= $new_stat[3] != $last_stat->[3]E= $new_stat[7] < $last_stat->[7]
ABCDEresult
1XXXX1
01XXX1
001XX1
0001X1
000011
000000
571 $new_stat[1] != $last_stat->[1] or # inode's number
572 $new_stat[0] != $last_stat->[0] or # inode's device
573 $new_stat[6] != $last_stat->[6] or # device type
574 $new_stat[3] != $last_stat->[3] or # number of links
575 $new_stat[7] < $last_stat->[7] # size reduced
576 ) {
577 3 TRACE_STAT and do {
578 warn "<stat> inode $new_stat[1] != old $last_stat->[1]"
579 if $new_stat[1] != $last_stat->[1];
580 warn "<stat> inode device $new_stat[0] != old $last_stat->[0]"
581 if $new_stat[0] != $last_stat->[0];
582 warn "<stat> device type $new_stat[6] != old $last_stat->[6]"
583 if $new_stat[6] != $last_stat->[6];
584 warn "<stat> link count $new_stat[3] != old $last_stat->[3]"
585 if $new_stat[3] != $last_stat->[3];
586 warn "<stat> file size $new_stat[7] < old $last_stat->[7]"
587 if $new_stat[7] < $last_stat->[7];
588 };
589  
590 3 $$handle = undef;
591 3 @$last_stat = @new_stat;
592  
593 # Must use a timer so that it can be cleared in DESTROY.
594 3 ▶ $k->delay($$state_read, 0) if defined $$state_read;
Branch: 1 branch
BranchTrueFalseTotal
if defined $$state_read 3 0 3
595 3 return;
596 }
597 elsif (defined $$event_idle) {
598 2 $k->call($ses, $$event_idle, $unique_id);
599 }
600  
601 # The file didn't roll. Try again shortly.
602 8 @$last_stat = @new_stat;
603 8 IO::Handle::clearerr($$handle);
604 8 ▶ $k->delay($$state_read, $poll_interval) if defined $$state_read;
Branch: 1 branch
BranchTrueFalseTotal
if defined $$state_read 8 0 8
605 8 return;
606 }
607 6 );
608 }
609  
610 #------------------------------------------------------------------------------
611  
612 8 ▶sub event {
Subroutine event: called CC=8 SCAR=22.2
Pod documented
613 8 my $self = shift;
614 8 ▶ push(@_, undef) if (scalar(@_) & 1);
Branch: 1 branch
BranchTrueFalseTotal
if scalar @_ & 1 0 8 8
615  
616 8 ▶ while (@_) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_) 10 8 18
617 10 my ($name, $event) = splice(@_, 0, 2);
618  
619 10 ▶ if ($name eq 'InputEvent') {
Branch: 4 branches
BranchTrueFalseTotal
if ($name eq 'InputEvent') { } 2 8 10
elsif ($name eq 'ErrorEvent') { } 2 6 8
elsif ($name eq 'ResetEvent') { } 0 6 6
elsif ($name eq 'IdleEvent') { } 6 0 6
620 2 ▶ if (defined $event) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $event) { } 2 0 2
621 2 $self->[SELF_EVENT_INPUT] = $event;
622 }
623 else {
624 0 carp "InputEvent requires an event name. ignoring undef";
625 }
626 }
627 elsif ($name eq 'ErrorEvent') {
628 2 $self->[SELF_EVENT_ERROR] = $event;
629 }
630 elsif ($name eq 'ResetEvent') {
631 0 $self->[SELF_EVENT_RESET] = $event;
632 }
633 elsif ($name eq 'IdleEvent') {
634 6 $self->[SELF_EVENT_IDLE] = $event;
635 }
636 else {
637 0 carp "ignoring unknown FollowTail parameter '$name'";
638 }
639 }
640 }
641  
642 #------------------------------------------------------------------------------
643  
644 87 ▶sub DESTROY {
Subroutine DESTROY: called CC=3 SCAR=11.2
645 87 my $self = shift;
646  
647 # Remove our tentacles from our owner.
648 87 ▶ $poe_kernel->select_read($self->[SELF_HANDLE] => undef) if (
Branch: 1 branch
BranchTrueFalseTotal
if defined $self->[0] 87 0 87
649 defined $self->[SELF_HANDLE]
650 );
651  
652 87 ▶ if ($self->[SELF_STATE_READ]) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->[9]) 87 0 87
653 87 $poe_kernel->delay($self->[SELF_STATE_READ]);
654 87 $poe_kernel->state($self->[SELF_STATE_READ]);
655 87 undef $self->[SELF_STATE_READ];
656 }
657  
658 87 &POE::Wheel::free_wheel_id($self->[SELF_UNIQUE_ID]);
659 }
660  
661 #------------------------------------------------------------------------------
662  
663 2 ▶sub ID {
Subroutine ID: called CC=1 SCAR=0.0
Pod documented
664 2 return $_[0]->[SELF_UNIQUE_ID];
665 }
666  
667 0 ▶sub tell {
Subroutine tell: not called CC=1 SCAR=6.9
Pod documented
668 0 my $self = shift;
669 0 return sysseek($self->[SELF_HANDLE], 0, SEEK_CUR);
670 }
671  
672 18 ▶sub _open_file {
Subroutine _open_file: called CC=4 SCAR=14.0
673 18 my $filename = shift;
674  
675 18 my $handle = gensym();
676  
677 # FIFOs (named pipes) are opened R/W so they don't report EOF.
678 # Everything else is opened read-only.
679 18 ▶ if (-p $filename) {
Branch: 1 branch
BranchTrueFalseTotal
if (-p $filename) 1 17 18
680 1 ▶ return $handle if open $handle, "+<", $filename;
Branch: 1 branch
BranchTrueFalseTotal
if open $handle, "+<", $filename 1 0 1
681 0 return;
682 }
683  
684 17 ▶ return $handle if open $handle, "<", $filename;
Branch: 1 branch
BranchTrueFalseTotal
if open $handle, "<", $filename 9 8 17
685 8 return;
686 }
687  
688 21 1;
689  
690 __END__
« blib/lib/POE/Wheel/Run.pm ↑ Summary blib/lib/POE/Component/Server/TCP.pm »