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
|
package Echolot::Scheduler;
#
# $Id$
#
# This file is part of Echolot - a Pinger for anonymous remailers.
#
# Copyright (c) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2012, 2014 Peter Palfrader <peter@palfrader.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.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#
=pod
=head1 Name
Echolot::Scheduler - Task selector/scheduler for echolot
=head1 DESCRIPTION
This package provides several functions for scheduling tasks within
the ping daemon.
=over
=cut
use strict;
use English;
use Echolot::Log;
my $ORDER = 1;
=item B<new> ()
Creates a new scheduler object.
=cut
sub new {
my ($class, %params) = @_;
my $self = {};
bless $self, $class;
return $self;
};
=item B<add> (I<name>, I<interval>, I<offset>, I<missok>, I<what>)
Adds a task with I<name> to the list of tasks. Every I<interval> seconds
I<what> is called. If for example I<interval> is 3600 - meaning I<what>
should be executed hourly - setting I<offset> to 600 would mean that
it get's called 10 minutes after the hour.
I<missok> indicates that it is ok to miss one run of this job. This can happen
if we run behind schedule for instance.
=cut
sub add($$$$$$) {
my ($self, $name, $interval, $offset, $missok, $what) = @_;
Echolot::Log::logdie("Must not add zero intervall for job $name.")
unless $interval;
if (defined $self->{'tasks'}->{$name}) {
@{ $self->{'schedule'} } = grep { $_->{'name'} ne $name } @{ $self->{'schedule'} };
};
$self->{'tasks'}->{$name} =
{
interval => $interval,
offset => $offset,
what => $what,
order => $ORDER++,
missok => $missok,
};
$self->schedule($name, 1);
return 1;
};
=item B<schedule> (I<name>, I<reschedule>, [ I<for>, [I<arguments>]] )
Schedule execution of I<name> for I<for>. If I<for> is not given it is calculated
from I<interval> and I<offset> passed to B<new>. if I<reschedule> is set
the task will be rescheduled when it's done (according to its interval).
You may also give arguments to passed to the task.
=cut
sub schedule($$$;$$) {
my ($self, $name, $reschedule, $for, $arguments) = @_;
(defined $self->{'tasks'}->{$name}) or
Echolot::Log::warn("Task $name is not defined."),
return 0;
my $interval = $self->{'tasks'}->{$name}->{'interval'};
my $offset = $self->{'tasks'}->{$name}->{'offset'};
unless (defined $for) {
($interval < 0) and
return 1;
my $now = time();
$for = $now - $now % $interval + $offset;
($for <= $now) and $for += $interval;
my $cnt = 0;
while ($self->{'tasks'}->{$name}->{'missok'} && ($for <= $now)) {
$for += $interval;
$cnt ++;
};
Echolot::Log::debug("Skipping $cnt runs of $name.") if $cnt;
};
$arguments = [] unless defined $arguments;
push @{ $self->{'schedule'} },
{
start => $for,
order => $self->{'tasks'}->{$name}->{'order'},
name => $name,
arguments => $arguments,
reschedule => $reschedule
};
@{ $self->{'schedule'} } = sort { $a->{'start'} <=> $b->{'start'} or $a->{'order'} <=> $b->{'order'} }
@{ $self->{'schedule'} };
return 1;
};
=item B<run> ()
Start the scheduling run.
It will run forever or until a task with I<what> == 'exit' is executed.
=cut
sub run($) {
my ($self) = @_;
(defined $self->{'schedule'}->[0]) or
Echolot::Log::warn("Scheduler is empty."),
return 0;
while(1) {
my $now = time();
my $task = $self->{'schedule'}->[0];
if ($task->{'start'} < $now) {
Echolot::Log::warn("Task $task->{'name'} could not be started on time.")
unless ($task->{'start'} == 0);
} else {
Echolot::Log::debug("zZzZZzz.");
$PROGRAM_NAME = "pingd [sleeping]";
sleep ($task->{'start'} - $now);
};
(time() < $task->{'start'}) and
next;
$now = $task->{'start'};
do {
$task = shift @{ $self->{'schedule'} };
my $name = $task->{'name'};
$PROGRAM_NAME = "pingd [executing $name]";
(defined $self->{'tasks'}->{$name}) or
Echolot::Log::cluck("Task $task->{'name'} is not defined.");
my $what = $self->{'tasks'}->{$name}->{'what'};
Echolot::Log::debug("Running $name (was scheduled for ".(time()-$now)." seconds ago).");
last if ($what eq 'exit');
&$what( $now, @{ $task->{'arguments'} } );
$self->schedule($name, 1, $now + $self->{'tasks'}->{$name}->{'interval'}) if
($task->{'reschedule'} && $self->{'tasks'}->{$name}->{'interval'} > 0);
(defined $self->{'schedule'}->[0]) or
Echolot::Log::warn("Scheduler is empty."),
return 0;
} while ($now >= $self->{'schedule'}->[0]->{'start'});
};
return 1;
};
# vim: set ts=4 shiftwidth=4:
|
