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);
108 if (runscripts == NULL) {
109 Dmsg0(100, "runscript: WARNING RUNSCRIPTS list is NULL\n");
113 foreach_alist(script, runscripts) {
114 Dmsg2(200, "runscript: try to run %s:%s\n", NPRT(script->target), NPRT(script->command));
117 if ((script->when & SCRIPT_Before) && (jcr->JobStatus == JS_Created)) {
118 Dmsg0(200, "runscript: Run it because SCRIPT_Before\n");
122 if ((script->when & SCRIPT_Before) && (jcr->JobStatus == JS_Running)) {
123 Dmsg0(200, "runscript: Run it because SCRIPT_Before\n");
127 if (script->when & SCRIPT_After) {
128 if ( (script->on_success && (jcr->JobStatus == JS_Terminated))
130 (script->on_failure && job_canceled(jcr))
133 Dmsg4(200, "runscript: Run it because SCRIPT_After (%s,%i,%i,%c)\n", script->command,
141 if (!script->is_local()) {
147 status = script->run(jcr, label);
149 /* cancel running job properly */
150 if ( script->abort_on_error
152 && (jcr->JobStatus == JS_Created || jcr->JobStatus == JS_Running)
155 set_jcr_job_status(jcr, JS_ErrorTerminated);
162 bool RUNSCRIPT::is_local()
164 if (!target || (strcmp(target, "") == 0)) {
171 /* set this->command to cmd */
172 void RUNSCRIPT::set_command(const POOLMEM *cmd)
174 Dmsg1(500, "runscript: setting command = %s\n", NPRT(cmd));
181 command = get_pool_memory(PM_FNAME);
184 pm_strcpy(command, cmd);
187 /* set this->target to client_name */
188 void RUNSCRIPT::set_target(const POOLMEM *client_name)
190 Dmsg1(500, "runscript: setting target\n", NPRT(client_name));
197 target = get_pool_memory(PM_FNAME);
200 pm_strcpy(target, client_name);
203 int RUNSCRIPT::run(JCR *jcr, const char *name)
205 Dmsg0(200, "runscript: running a RUNSCRIPT object\n");
206 POOLMEM *ecmd = get_pool_memory(PM_FNAME);
209 char line[MAXSTRING];
211 ecmd = edit_job_codes(jcr, ecmd, this->command, "");
212 Dmsg1(100, "runscript: running '%s'...\n", ecmd);
213 Jmsg(jcr, M_INFO, 0, _("%s: run command \"%s\"\n"), name, ecmd);
215 bpipe = open_bpipe(ecmd, 0, "r");
216 free_pool_memory(ecmd);
219 Jmsg(jcr, M_ERROR, 0, _("Runscript: %s could not execute. ERR=%s\n"), name,
223 while (fgets(line, sizeof(line), bpipe->rfd)) {
224 int len = strlen(line);
225 if (len > 0 && line[len-1] == '\n') {
228 Jmsg(jcr, M_INFO, 0, _("%s: %s\n"), name, line);
230 status = close_bpipe(bpipe);
233 Jmsg(jcr, M_ERROR, 0, _("Runscript: %s returned non-zero status=%d. ERR=%s\n"), name,
234 be.code(status), be.strerror(status));
240 void free_runscripts(alist *runscripts)
242 Dmsg0(500, "runscript: freeing all RUNSCRIPTS object\n");
245 foreach_alist(elt, runscripts) {
250 void RUNSCRIPT::debug()
252 Dmsg0(200, "runscript: debug\n");
253 Dmsg0(200, _(" --> RunScript\n"));
254 Dmsg1(200, _(" --> Command=%s\n"), NPRT(command));
255 Dmsg1(200, _(" --> Target=%s\n"), NPRT(target));
256 Dmsg1(200, _(" --> RunOnSuccess=%u\n"), on_success);
257 Dmsg1(200, _(" --> RunOnFailure=%u\n"), on_failure);
258 Dmsg1(200, _(" --> AbortJobOnError=%u\n"), abort_on_error);
259 Dmsg1(200, _(" --> RunWhen=%u\n"), when);