2 * Manipulation routines for RunScript list
4 * Eric Bollengier, May 2006
10 Bacula® - The Network Backup Solution
12 Copyright (C) 2006-2006 Free Software Foundation Europe e.V.
14 The main author of Bacula is Kern Sibbald, with contributions from
15 many others, a complete list can be found in the file AUTHORS.
16 This program is Free Software; you can redistribute it and/or
17 modify it under the terms of version two of the GNU General Public
18 License as published by the Free Software Foundation plus additions
19 that are listed in the file LICENSE.
21 This program is distributed in the hope that it will be useful, but
22 WITHOUT ANY WARRANTY; without even the implied warranty of
23 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24 General Public License for more details.
26 You should have received a copy of the GNU General Public License
27 along with this program; if not, write to the Free Software
28 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
31 Bacula® is a registered trademark of John Walker.
32 The licensor of Bacula is the Free Software Foundation Europe
33 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
34 Switzerland, email:ftf@fsfeurope.org.
41 #include "runscript.h"
43 RUNSCRIPT *new_runscript()
45 Dmsg0(500, "runscript: creating new RUNSCRIPT object\n");
46 RUNSCRIPT *cmd = (RUNSCRIPT *)malloc(sizeof(RUNSCRIPT));
47 memset(cmd, 0, sizeof(RUNSCRIPT));
53 void RUNSCRIPT::reset_default(bool free_strings)
55 if (free_strings && command) {
56 free_pool_memory(command);
58 if (free_strings && target) {
59 free_pool_memory(target);
66 abort_on_error = true;
68 old_proto = false; /* TODO: drop this with bacula 1.42 */
71 RUNSCRIPT *copy_runscript(RUNSCRIPT *src)
73 Dmsg0(500, "runscript: creating new RUNSCRIPT object from other\n");
75 RUNSCRIPT *dst = (RUNSCRIPT *)malloc(sizeof(RUNSCRIPT));
76 memcpy(dst, src, sizeof(RUNSCRIPT));
81 dst->set_command(src->command);
82 dst->set_target(src->target);
87 void free_runscript(RUNSCRIPT *script)
89 Dmsg0(500, "runscript: freeing RUNSCRIPT object\n");
91 if (script->command) {
92 free_pool_memory(script->command);
95 free_pool_memory(script->target);
100 int run_scripts(JCR *jcr, alist *runscripts, const char *label)
102 Dmsg2(200, "runscript: running all RUNSCRIPT object (%s) JobStatus=%c\n", label, jcr->JobStatus);
110 if (strstr(label, NT_("Before"))) {
111 when = SCRIPT_Before;
116 if (runscripts == NULL) {
117 Dmsg0(100, "runscript: WARNING RUNSCRIPTS list is NULL\n");
121 foreach_alist(script, runscripts) {
122 Dmsg2(200, "runscript: try to run %s:%s\n", NPRT(script->target), NPRT(script->command));
125 if ((script->when & SCRIPT_Before) && (when & SCRIPT_Before)) {
126 if ( (script->on_success && (jcr->JobStatus == JS_Running || jcr->JobStatus == JS_Created))
128 (script->on_failure && job_canceled(jcr))
131 Dmsg4(200, "runscript: Run it because SCRIPT_Before (%s,%i,%i,%c)\n", script->command,
140 if ((script->when & SCRIPT_After) && (when & SCRIPT_After)) {
141 if ( (script->on_success && (jcr->JobStatus == JS_Terminated))
143 (script->on_failure && job_canceled(jcr))
146 Dmsg4(200, "runscript: Run it because SCRIPT_After (%s,%i,%i,%c)\n", script->command,
154 if (!script->is_local()) {
160 status = script->run(jcr, label);
162 /* cancel running job properly */
163 if ( script->abort_on_error
165 && (jcr->JobStatus == JS_Created || jcr->JobStatus == JS_Running)
168 set_jcr_job_status(jcr, JS_ErrorTerminated);
175 bool RUNSCRIPT::is_local()
177 if (!target || (strcmp(target, "") == 0)) {
184 /* set this->command to cmd */
185 void RUNSCRIPT::set_command(const POOLMEM *cmd)
187 Dmsg1(500, "runscript: setting command = %s\n", NPRT(cmd));
194 command = get_pool_memory(PM_FNAME);
197 pm_strcpy(command, cmd);
200 /* set this->target to client_name */
201 void RUNSCRIPT::set_target(const POOLMEM *client_name)
203 Dmsg1(500, "runscript: setting target = %s\n", NPRT(client_name));
210 target = get_pool_memory(PM_FNAME);
213 pm_strcpy(target, client_name);
216 int RUNSCRIPT::run(JCR *jcr, const char *name)
218 Dmsg0(200, "runscript: running a RUNSCRIPT object\n");
219 POOLMEM *ecmd = get_pool_memory(PM_FNAME);
222 char line[MAXSTRING];
224 ecmd = edit_job_codes(jcr, ecmd, this->command, "");
225 Dmsg1(100, "runscript: running '%s'...\n", ecmd);
226 Jmsg(jcr, M_INFO, 0, _("%s: run command \"%s\"\n"), name, ecmd);
228 bpipe = open_bpipe(ecmd, 0, "r");
229 free_pool_memory(ecmd);
232 Jmsg(jcr, M_ERROR, 0, _("Runscript: %s could not execute. ERR=%s\n"), name,
236 while (fgets(line, sizeof(line), bpipe->rfd)) {
237 int len = strlen(line);
238 if (len > 0 && line[len-1] == '\n') {
241 Jmsg(jcr, M_INFO, 0, _("%s: %s\n"), name, line);
243 status = close_bpipe(bpipe);
246 Jmsg(jcr, M_ERROR, 0, _("Runscript: %s returned non-zero status=%d. ERR=%s\n"), name,
247 be.code(status), be.strerror(status));
253 void free_runscripts(alist *runscripts)
255 Dmsg0(500, "runscript: freeing all RUNSCRIPTS object\n");
258 foreach_alist(elt, runscripts) {
263 void RUNSCRIPT::debug()
265 Dmsg0(200, "runscript: debug\n");
266 Dmsg0(200, _(" --> RunScript\n"));
267 Dmsg1(200, _(" --> Command=%s\n"), NPRT(command));
268 Dmsg1(200, _(" --> Target=%s\n"), NPRT(target));
269 Dmsg1(200, _(" --> RunOnSuccess=%u\n"), on_success);
270 Dmsg1(200, _(" --> RunOnFailure=%u\n"), on_failure);
271 Dmsg1(200, _(" --> AbortJobOnError=%u\n"), abort_on_error);
272 Dmsg1(200, _(" --> RunWhen=%u\n"), when);