3 # Copyright 2007 Liblime Ltd
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
21 #use warnings; FIXME - Bug 2505
23 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
28 # set the version for version checking
32 qw(get_jobs get_at_jobs get_at_job add_at_job remove_at_job);
37 C4::Scheduler - Module for running jobs with the unix at command
51 This will return all scheduled jobs
56 my $jobs = get_at_jobs();
57 # add call to get cron jobs here too
63 This will return all At scheduled jobs
68 my %jobs = Schedule::At::getJobs();
72 =head2 get_at_job($id)
74 This will return the At job with the given id
80 my %jobs = Schedule::At::getJobs(JOBID => $id);
83 =head2 add_at_job ($time,$command)
85 Given a timestamp and a command this will schedule the job to run at that time.
87 Returns true if the job is added to the queue and false otherwise.
92 my ($time,$command) = @_;
93 # FIXME - a description of the task to be run
94 # may be a better tag, since the tag is displayed
95 # in the job list that the administrator sees - e.g.,
96 # "run report foo, send to foo@bar.com"
97 Schedule::At::add(TIME => $time, COMMAND => $command, TAG => $command);
99 # FIXME - this method of checking whether the job was added
100 # to the queue is less than perfect:
102 # 1. Since the command is the tag, it is possible that there is
103 # already a job in the queue with the same tag. However, since
104 # the tag is what displays in the job list, we can't just
105 # give it a unique ID.
106 # 2. Schedule::At::add() is supposed to return a non-zero
107 # value if it fails to add a job - however, it does
108 # not check all error conditions - in particular, it does
109 # not check the return value of the "at" run; it basically
110 # complains only if it can't find at.
111 # 3. Similary, Schedule::At::add() does not do something more useful,
112 # such as returning the job ID. To be fair, it is possible
113 # that 'at' does not allow this in any portable way.
114 # 4. Although unlikely, it is possible that a job could be added
115 # and completed instantly, thus dropping off the queue.
118 my %jobs = Schedule::At::getJobs(TAG => $command);
119 $job_found = scalar(keys %jobs) > 0;
130 Schedule::At::remove(JOBID => $jobid);
138 At some point C<C4::Scheduler> should be refactored:
142 =item At and C<Schedule::At> does not work on Win32.
144 =item At is not installed by default on all platforms.
146 =item The At queue used by Koha is owned by the httpd user. If multiple
147 Koha databases share an Apache instance on a server, everybody can
148 see everybody's jobs.
150 =item There is no support for scheduling a job to run more than once.
156 Chris Cormack <crc@liblime.com>