C4/Scheduler.pm

   1 package C4::Scheduler;
   2
   3 # Copyright 2007 Liblime Ltd
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 2 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along with
  17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  18 # Suite 330, Boston, MA  02111-1307 USA
  19
  20 use strict;
  21 require Exporter;
  22
  23 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  24 use C4::Context;
  25 use Smart::Comments;
  26 use Schedule::At;
  27 # set the version for version checking
  28 $VERSION = 0.01;
  29
  30 @ISA = qw(Exporter);
  31 @EXPORT =
  32   qw(get_jobs get_at_jobs get_at_job add_at_job remove_at_job);
  33
  34 =head1 NAME
  35
  36 C4::Scheduler - Module for running jobs with the unix at command
  37
  38 =head1 SYNOPSIS
  39
  40   use C4::Scheduler;
  41
  42 =head1 DESCRIPTION
  43
  44
  45 =head1 METHODS
  46
  47 =over 2
  48
  49 =cut
  50
  51 =item get_jobs();
  52
  53 This will return all scheduled jobs
  54
  55 =cut
  56
  57 sub get_jobs {
  58     my $jobs = get_at_jobs();
  59 # add call to get cron jobs here too
  60     return ($jobs);
  61 }
  62
  63 =item get_at_jobs();
  64
  65 This will return all At scheduled jobs
  66
  67 =cut
  68
  69 sub get_at_jobs {
  70         my %jobs = Schedule::At::getJobs();
  71         return (\%jobs);
  72 }
  73
  74 =item get_at_job($id)
  75
  76 This will return the At job with the given id
  77
  78 =cut
  79
  80 sub get_at_job {
  81         my ($id)=@_;
  82         my %jobs = chedule::At::getJobs(JOBID => $id);
  83 }
  84
  85 =item add_at_job ($time,$command)
  86
  87 Given a timestamp and a command this will schedule the job to run at that time
  88
  89 =cut
  90
  91 sub add_at_job {
  92         my ($time,$command) = @_;
  93         Schedule::At::add(TIME => $time, COMMAND => $command, TAG => $command);
  94 }
  95
  96 sub remove_at_job {
  97         my ($jobid)=@_;
  98         Schedule::At::remove(JOBID => $jobid);
  99 }
 100
 101 =head1 AUTHOR
 102
 103 Chris Cormack <crc@liblime.com>
 104
 105 =cut
 106
 107 1;