]> git.sur5r.net Git - bacula/bacula/blobdiff - bacula/src/lib/runscript.h
Remove old bdb files + change DQUEUE to use dlist
[bacula/bacula] / bacula / src / lib / runscript.h
index 85538059d8c8aac45cbf07a40e0d09e57f396971..a7ccf4ab0567c1e8b15fdc34ad52125bd663b343 100644 (file)
@@ -1,27 +1,42 @@
 /*
- * Bacula RUNSCRIPT Structure definition for FileDaemon and Director
- * Eric Bollengier May 2006
- * Version $Id$
- */
-/*
-   Copyright (C) 2000-2006 Kern Sibbald
+   Bacula® - The Network Backup Solution
 
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public License
-   version 2 as amended with additional clauses defined in the
-   file LICENSE in the main source directory.
+   Copyright (C) 2006-2008 Free Software Foundation Europe e.V.
 
-   This program 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 
-   the file LICENSE for additional details.
+   The main author of Bacula is Kern Sibbald, with contributions from
+   many others, a complete list can be found in the file AUTHORS.
+   This program is Free Software; you can redistribute it and/or
+   modify it under the terms of version two of the GNU General Public
+   License as published by the Free Software Foundation and included
+   in the file LICENSE.
 
- */
+   This program 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 this program; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+   02110-1301, USA.
+
+   Bacula® is a registered trademark of Kern Sibbald.
+   The licensor of Bacula is the Free Software Foundation Europe
+   (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
+   Switzerland, email:ftf@fsfeurope.org.
+*/
+/*
+ * Bacula RUNSCRIPT Structure definition for FileDaemon and Director
+ * Eric Bollengier May 2006
+ * Version $Id$
+ */
 
 #ifndef __RUNSCRIPT_H_
 #define __RUNSCRIPT_H_ 1
 
+#include "protos.h"
+
 /* Usage:
  *
  * #define USE_RUNSCRIPT
  * script->on_failure = true;
  * script->when = SCRIPT_After;
  * 
- * script->run("Label");
+ * script->run("LabelBefore");  // the label must contain "Before" or "After" special keyword
  * free_runscript(script);
  */
 
 /* 
- * RUNSCRIPT->when can take following value : 
+ * RUNSCRIPT->when can take following bit values:
  */
 enum {
-   SCRIPT_Never  = 1,
-   SCRIPT_After  = 2,           /* AfterJob */
-   SCRIPT_Before = 3,           /* BeforeJob */
-   SCRIPT_Any    = 4            /* Before and After */
+   SCRIPT_Never  = 0,
+   SCRIPT_After  = (1<<0),      /* AfterJob */
+   SCRIPT_Before = (1<<1),      /* BeforeJob */
+   SCRIPT_AfterVSS = (1<<2),   /* BeforeJob and After VSS */
+   SCRIPT_Any    = SCRIPT_Before | SCRIPT_After
+};
+
+enum {
+   SHELL_CMD   = '|',
+   CONSOLE_CMD = '@' 
 };
 
 /*
@@ -53,19 +74,26 @@ class RUNSCRIPT {
 public:
    POOLMEM *command;            /* command string */
    POOLMEM *target;             /* host target */
-   char level;                  /* Base|Full|Incr...|All (NYI) */
-   bool on_success;             /* executre command on job success (After) */
-   bool on_failure;             /* executre command on job failure (After) */
-   bool abort_on_error;         /* abort job on error (Before) */
    int  when;                   /* SCRIPT_Before|Script_After BEFORE/AFTER JOB*/
-
-   int run(JCR *job, const char *name="");
+   int  cmd_type;               /* Command type -- Shell, Console */
+   char level;                  /* Base|Full|Incr...|All (NYI) */
+   bool on_success;             /* execute command on job success (After) */
+   bool on_failure;             /* execute command on job failure (After) */
+   bool fail_on_error;         /* abort job on error (Before) */
+   /* TODO : drop this with bacula 1.42 */
+   bool old_proto;              /* used by old 1.3X protocol */
+   job_code_callback_t job_code_callback;
+                                /* Optional callback function passed to edit_job_code */
+   alist *commands;             /* Use during parsing */
+   bool run(JCR *job, const char *name=""); /* name must contain "Before" or "After" keyword */
    bool can_run_at_level(int JobLevel) { return true;};        /* TODO */
-   void set_command(const POOLMEM *cmd);
-   void set_target(const POOLMEM *client_name);
+   void set_command(const char *cmd, int cmd_type = SHELL_CMD);
+   void set_target(const char *client_name);
    void reset_default(bool free_string = false);
    bool is_local();             /* true if running on local host */
    void debug();
+
+   void set_job_code_callback(job_code_callback_t job_code_callback);
 };
 
 /* create new RUNSCRIPT (set all value to 0) */
@@ -83,4 +111,6 @@ void free_runscript(RUNSCRIPT *script);
 /* foreach_alist free RUNSCRIPT */
 void free_runscripts(alist *runscripts); /* you have to free alist */
 
+extern DLL_IMP_EXP bool (*console_command)(JCR *jcr, const char *cmd);
+
 #endif /* __RUNSCRIPT_H_ */