Commit | Line | Data |
---|---|---|
c311089b | 1 | ;;; GNU Guix --- Functional package management for GNU |
6a7c4636 | 2 | ;;; Copyright © 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org> |
c311089b LC |
3 | ;;; |
4 | ;;; This file is part of GNU Guix. | |
5 | ;;; | |
6 | ;;; GNU Guix is free software; you can redistribute it and/or modify it | |
7 | ;;; under the terms of the GNU General Public License as published by | |
8 | ;;; the Free Software Foundation; either version 3 of the License, or (at | |
9 | ;;; your option) any later version. | |
10 | ;;; | |
11 | ;;; GNU Guix is distributed in the hope that it will be useful, but | |
12 | ;;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | ;;; GNU General Public License for more details. | |
15 | ;;; | |
16 | ;;; You should have received a copy of the GNU General Public License | |
17 | ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>. | |
18 | ||
19 | (define-module (gnu services mcron) | |
20 | #:use-module (gnu services) | |
c311089b | 21 | #:use-module (gnu services shepherd) |
6a7c4636 | 22 | #:use-module (gnu packages guile-xyz) |
84a2de36 | 23 | #:use-module (guix deprecation) |
c311089b LC |
24 | #:use-module (guix records) |
25 | #:use-module (guix gexp) | |
26 | #:use-module (srfi srfi-1) | |
27 | #:use-module (ice-9 match) | |
28 | #:use-module (ice-9 vlist) | |
29 | #:export (mcron-configuration | |
30 | mcron-configuration? | |
31 | mcron-configuration-mcron | |
32 | mcron-configuration-jobs | |
33 | ||
34 | mcron-service-type | |
35 | mcron-service)) | |
36 | ||
37 | ;;; Commentary: | |
38 | ;;; | |
39 | ;;; This module implements a service that to run instances of GNU mcron, a | |
40 | ;;; periodic job execution daemon. Example of a service: | |
41 | ;; | |
42 | ;; (service mcron-service-type | |
43 | ;; (mcron-configuration | |
44 | ;; (jobs (list #~(job next-second-from | |
45 | ;; (lambda () | |
46 | ;; (call-with-output-file "/dev/console" | |
47 | ;; (lambda (port) | |
48 | ;; (display "hello!\n" port))))))))) | |
49 | ;;; | |
50 | ;;; Code: | |
51 | ||
52 | (define-record-type* <mcron-configuration> mcron-configuration | |
53 | make-mcron-configuration | |
54 | mcron-configuration? | |
55 | (mcron mcron-configuration-mcron ;package | |
cfbf6de1 | 56 | (default mcron)) |
c311089b LC |
57 | (jobs mcron-configuration-jobs ;list of <mcron-job> |
58 | (default '()))) | |
59 | ||
949672c9 LC |
60 | (define (job-files mcron jobs) |
61 | "Return a list of file-like object for JOBS, a list of gexps." | |
62 | (define (validated-file job) | |
63 | ;; This procedure behaves like 'scheme-file' but it runs 'mcron | |
64 | ;; --schedule' to detect any error in JOB. | |
65 | (computed-file "mcron-job" | |
66 | (with-imported-modules '((guix build utils)) | |
67 | #~(begin | |
68 | (use-modules (guix build utils)) | |
69 | ||
ef5ddb0e LC |
70 | (call-with-output-file "prologue" |
71 | (lambda (port) | |
72 | ;; This prologue allows 'mcron --schedule' to | |
73 | ;; proceed no matter what #:user option is passed | |
74 | ;; to 'job'. | |
75 | (write '(set! getpw | |
76 | (const (getpwuid (getuid)))) | |
77 | port))) | |
78 | ||
949672c9 LC |
79 | (call-with-output-file "job" |
80 | (lambda (port) | |
81 | (write '#$job port))) | |
82 | ||
83 | (invoke #+(file-append mcron "/bin/mcron") | |
ef5ddb0e | 84 | "--schedule=20" "prologue" "job") |
949672c9 LC |
85 | (copy-file "job" #$output))) |
86 | #:options '(#:env-vars (("COLUMNS" . "150"))))) | |
87 | ||
88 | (map validated-file jobs)) | |
c311089b | 89 | |
147c5aa5 LC |
90 | (define (shepherd-schedule-action mcron files) |
91 | "Return a Shepherd action that runs MCRON with '--schedule' for the given | |
92 | files." | |
93 | (shepherd-action | |
94 | (name 'schedule) | |
95 | (documentation | |
96 | "Display jobs that are going to be scheduled.") | |
97 | (procedure | |
98 | #~(lambda* (_ #:optional (n "5")) | |
99 | ;; XXX: This is a global side effect. | |
100 | (setenv "GUILE_AUTO_COMPILE" "0") | |
101 | ||
102 | ;; Run 'mcron' in a pipe so we can explicitly redirect its output to | |
103 | ;; 'current-output-port', which at this stage is bound to the client | |
104 | ;; connection. | |
105 | (let ((pipe (open-pipe* OPEN_READ | |
106 | #$(file-append mcron "/bin/mcron") | |
107 | (string-append "--schedule=" n) | |
108 | #$@files))) | |
109 | (let loop () | |
110 | (match (read-line pipe 'concat) | |
111 | ((? eof-object?) | |
112 | (catch 'system-error | |
113 | (lambda () | |
114 | (zero? (close-pipe pipe))) | |
115 | (lambda args | |
19087774 | 116 | ;; There's a race with the SIGCHLD handler, which |
147c5aa5 LC |
117 | ;; could call 'waitpid' before 'close-pipe' above does. If |
118 | ;; we get ECHILD, that means we lost the race, but that's | |
119 | ;; fine. | |
120 | (or (= ECHILD (system-error-errno args)) | |
121 | (apply throw args))))) | |
122 | (line | |
123 | (display line) | |
124 | (loop))))))))) | |
125 | ||
c311089b LC |
126 | (define mcron-shepherd-services |
127 | (match-lambda | |
128 | (($ <mcron-configuration> mcron ()) ;nothing to do! | |
129 | '()) | |
130 | (($ <mcron-configuration> mcron jobs) | |
949672c9 | 131 | (let ((files (job-files mcron jobs))) |
147c5aa5 LC |
132 | (list (shepherd-service |
133 | (provision '(mcron)) | |
134 | (requirement '(user-processes)) | |
135 | (modules `((srfi srfi-1) | |
136 | (srfi srfi-26) | |
137 | (ice-9 popen) ;for the 'schedule' action | |
138 | (ice-9 rdelim) | |
139 | (ice-9 match) | |
140 | ,@%default-modules)) | |
141 | (start #~(make-forkexec-constructor | |
142 | (list (string-append #$mcron "/bin/mcron") #$@files) | |
143 | ||
144 | ;; Disable auto-compilation of the job files and set a | |
145 | ;; sane value for 'PATH'. | |
146 | #:environment-variables | |
147 | (cons* "GUILE_AUTO_COMPILE=0" | |
148 | "PATH=/run/current-system/profile/bin" | |
149 | (remove (cut string-prefix? "PATH=" <>) | |
f8cd07e8 CB |
150 | (environ))) |
151 | ||
152 | #:log-file "/var/log/mcron.log")) | |
147c5aa5 | 153 | (stop #~(make-kill-destructor)) |
c311089b | 154 | |
147c5aa5 LC |
155 | (actions |
156 | (list (shepherd-schedule-action mcron files))))))))) | |
c311089b LC |
157 | |
158 | (define mcron-service-type | |
159 | (service-type (name 'mcron) | |
e7d45693 RV |
160 | (description |
161 | "Run the mcron job scheduling daemon.") | |
c311089b LC |
162 | (extensions |
163 | (list (service-extension shepherd-root-service-type | |
164 | mcron-shepherd-services) | |
165 | (service-extension profile-service-type | |
166 | (compose list | |
167 | mcron-configuration-mcron)))) | |
168 | (compose concatenate) | |
169 | (extend (lambda (config jobs) | |
170 | (mcron-configuration | |
171 | (inherit config) | |
172 | (jobs (append (mcron-configuration-jobs config) | |
3d3c5650 LC |
173 | jobs))))) |
174 | (default-value (mcron-configuration)))) ;empty job list | |
c311089b | 175 | |
84a2de36 LC |
176 | (define-deprecated (mcron-service jobs #:optional (mcron mcron)) |
177 | mcron-service-type | |
c311089b LC |
178 | "Return an mcron service running @var{mcron} that schedules @var{jobs}, a |
179 | list of gexps denoting mcron job specifications. | |
180 | ||
181 | This is a shorthand for: | |
182 | @example | |
183 | (service mcron-service-type | |
184 | (mcron-configuration (mcron mcron) (jobs jobs))) | |
185 | @end example | |
186 | " | |
187 | (service mcron-service-type | |
188 | (mcron-configuration (mcron mcron) (jobs jobs)))) | |
189 | ||
190 | ;;; mcron.scm ends here |