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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
| | ;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2024 Giacomo Leidi <goodoldpaul@autistici.org>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix 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 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix 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 GNU Guix. If not, see <http://www.gnu.org/licenses/>.
(define-module (gnu services backup)
#:use-module (gnu packages backup)
#:use-module (gnu services)
#:use-module (gnu services configuration)
#:use-module (gnu services mcron)
#:use-module (guix build-system copy)
#:use-module (guix gexp)
#:use-module ((guix licenses)
#:prefix license:)
#:use-module (guix modules)
#:use-module (guix packages)
#:use-module (srfi srfi-1)
#:export (restic-backup-job
restic-backup-job?
restic-backup-job-fields
restic-backup-job-restic
restic-backup-job-user
restic-backup-job-name
restic-backup-job-repository
restic-backup-job-password-file
restic-backup-job-schedule
restic-backup-job-files
restic-backup-job-verbose?
restic-backup-job-extra-flags
restic-backup-configuration
restic-backup-configuration?
restic-backup-configuration-fields
restic-backup-configuration-jobs
restic-action-program
restic-backup-job->mcron-job
restic-guix
restic-guix-wrapper-package
restic-backup-service-profile
restic-backup-service-type))
(define (gexp-or-string? value)
(or (gexp? value)
(string? value)))
(define (lowerable? value)
(or (file-like? value)
(gexp-or-string? value)))
(define list-of-lowerables?
(list-of lowerable?))
(define-configuration/no-serialization restic-backup-job
(restic
(package restic)
"The restic package to be used for the current job.")
(user
(string "root")
"The user used for running the current job.")
(name
(string)
"A string denoting a name for this job.")
(repository
(string)
"The restic repository target of this job.")
(password-file
(string)
"Name of the password file, readable by the configured @code{user}, that
will be used to set the @code{RESTIC_PASSWORD} environment variable for the
current job.")
(schedule
(gexp-or-string)
"A string or a gexp that will be passed as time specification in the mcron
job specification (@pxref{Syntax, mcron job specifications,, mcron,
GNU@tie{}mcron}).")
(files
(list-of-lowerables '())
"The list of files or directories to be backed up. It must be a list of
values that can be lowered to strings.")
(verbose?
(boolean #f)
"Whether to enable verbose output for the current backup job.")
(extra-flags
(list-of-lowerables '())
"A list of values that are lowered to strings. These will be passed as
command-line arguments to the current job @command{restic backup} invokation."))
(define list-of-restic-backup-jobs?
(list-of restic-backup-job?))
(define-configuration/no-serialization restic-backup-configuration
(jobs
(list-of-restic-backup-jobs '())
"The list of backup jobs for the current system."))
(define %restic-guix-supported-actions
'("backup" "mount" "prune" "restore" "run" "unlock"))
(define* (restic-action-program config action)
(let ((restic
(file-append (restic-backup-job-restic config) "/bin/restic"))
(name
(restic-backup-job-name config))
(repository
(restic-backup-job-repository config))
(password-file
(restic-backup-job-password-file config))
(extra-flags
(restic-backup-job-extra-flags config))
(verbose
(if (restic-backup-job-verbose? config)
'("--verbose")
'())))
(program-file
(string-append "restic-" action "-" name "-program.scm")
#~(begin
(use-modules (ice-9 popen)
(ice-9 rdelim)
(srfi srfi-1))
(define cli-arguments
(let* ((cl (command-line))
(argc (length cl)))
(if (> argc 1)
(take-right cl (- argc 1))
'())))
(setenv "RESTIC_PASSWORD"
(with-input-from-file #$password-file read-line))
(apply execlp `(#$restic #$restic #$@verbose
"-r" #$repository
#$@extra-flags
#$action ,@cli-arguments))))))
(define* (restic-guix jobs #:key (supported-actions
%restic-guix-supported-actions))
(define action-table
(map
(lambda (action)
(list action
(map (lambda (job)
(list (restic-backup-job-name job)
(restic-action-program job action)))
jobs)))
;; run is an alias for backup
(filter (lambda (a) (not (string=? a "run"))) supported-actions)))
(program-file
"restic-guix"
#~(begin
(use-modules (ice-9 match)
(srfi srfi-1))
(define action-table '#$action-table)
(define (assoc-table key table)
(first
(filter-map
(match-lambda
((k v)
(and (string=? key k) v)))
table)))
(define names '#$(map restic-backup-job-name jobs))
(define backup-files
'#$(map restic-backup-job-files jobs))
(define (get-program action name)
(assoc-table name (assoc-table action action-table)))
(define (get-backup-files name)
(define idx
(list-index (lambda (n) (string=? n name)) names))
(list-ref backup-files idx))
(define (validate-args args)
(unless (>= (length args) 2)
(error (string-append "Usage: " (basename (first args))
" ACTION [ARGS]\n\nSupported actions are: "
#$(string-join supported-actions ", ") ".")))
(unless (member (second args) '#$supported-actions)
(error (string-append "Unknown action: " (second args) ". Supported"
"actions are: "
#$(string-join supported-actions ", ") "."))))
(define (validate-action-args action args)
(define argc (length args))
(when (not (>= argc 3))
(error (string-append "Usage: " (basename (first args))
" " action " JOB_NAME [ARGS]\n\nPossible job "
"names are: " (string-join names ", ") ".")))
(define job-name (third args))
(unless (member job-name names)
(error (string-append "Unknown job name: " job-name ". Possible job "
"names are: " (string-join names ", ") ".")))
(let ((program
(get-program
;; run is just backup called with restic-backup-job-files
(if (string=? action "run") "backup" action)
job-name))
(rest (if (> argc 3)
(take-right args (- argc 3))
'())))
(values program
(if (string=? action "run")
(append rest (get-backup-files job-name))
rest))))
(define (main args)
(validate-args args)
(define action (second args))
(define-values (program action-args) (validate-action-args action args))
(apply execlp (append (list program program) action-args)))
(main (command-line)))))
(define (restic-backup-job->mcron-job config)
(let ((user
(restic-backup-job-user config))
(schedule
(restic-backup-job-schedule config))
(name
(restic-backup-job-name config)))
#~(job #$schedule
#$(string-append "restic-guix run " name)
#:user #$user)))
(define (restic-guix-wrapper-package jobs)
(package
(name "restic-backup-service-wrapper")
(version "0.0.0")
(source (restic-guix jobs))
(build-system copy-build-system)
(arguments
(list #:install-plan #~'(("./" "/bin"))))
(home-page "https://restic.net")
(synopsis
"Easily interact from the CLI with Guix configured backups")
(description
"This package provides a simple wrapper around @code{restic}, handled
by the @code{restic-backup-service-type}. It allows for easily interacting
with Guix configured backup jobs, for example for manually triggering a backup
without waiting for the scheduled job to run.")
(license license:gpl3+)))
(define restic-backup-service-profile
(lambda (config)
(define jobs (restic-backup-configuration-jobs config))
(if (> (length jobs) 0)
(list
(restic-guix-wrapper-package jobs))
'())))
(define restic-backup-service-type
(service-type (name 'restic-backup)
(extensions
(list
(service-extension profile-service-type
restic-backup-service-profile)
(service-extension mcron-service-type
(lambda (config)
(map restic-backup-job->mcron-job
(restic-backup-configuration-jobs
config))))))
(compose concatenate)
(extend
(lambda (config jobs)
(restic-backup-configuration
(inherit config)
(jobs (append (restic-backup-configuration-jobs config)
jobs)))))
(default-value (restic-backup-configuration))
(description
"This service configures @code{mcron} jobs for running backups
with @code{restic}.")))
|