3 * Bacula interface to Python for the Director
5 * Kern Sibbald, November MMIV
12 Copyright (C) 2004-2005 Kern Sibbald
14 This program is free software; you can redistribute it and/or
15 modify it under the terms of the GNU General Public License as
16 published by the Free Software Foundation; either version 2 of
17 the License, or (at your option) any later version.
19 This program is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 General Public License for more details.
24 You should have received a copy of the GNU General Public
25 License along with this program; if not, write to the Free
26 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
35 #undef _POSIX_C_SOURCE
38 extern JCR *get_jcr_from_PyObject(PyObject *self);
39 extern PyObject *find_method(PyObject *eventsObject, PyObject *method,
43 static int set_job_events(PyObject *self, PyObject *arg);
44 static int job_run(PyObject *self, PyObject *arg);
47 static PyObject *set_bacula_job_events(PyObject *self, PyObject *arg)
49 Dmsg2(000, "In set_bacula_job_events self=%p arg=%p\n",
54 PyMethodDef JobMethods[] = {
55 {"set_events", set_bacula_job_events, METH_VARARGS, "Define Bacula events."},
56 {NULL, NULL, 0, NULL} /* last item */
66 /* Read-only variables */
67 static struct s_vars getvars[] = {
69 { N_("DirName"), "s"},
74 { N_("NumVols"), "i"},
76 { N_("Storage"), "s"},
77 { N_("Catalog"), "s"},
78 { N_("MediaType"), "s"},
79 { N_("JobName"), "s"},
80 { N_("JobStatus"), "s"},
85 /* Writable variables */
86 static struct s_vars setvars[] = {
87 { N_("set_events"), NULL},
89 { N_("JobReport"), "s"},
91 { N_("VolumeName") , "s"},
97 /* Return Job variables */
98 /* Returns: NULL if error
99 * PyObject * return value if OK
101 PyObject *job_getattr(PyObject *self, char *attrname)
109 Dmsg0(100, "In job_getattr.\n");
110 jcr = get_jcr_from_PyObject(self);
112 bstrncpy(errmsg, "Job pointer not found.", sizeof(errmsg));
115 for (i=0; getvars[i].name; i++) {
116 if (strcmp(getvars[i].name, attrname) == 0) {
126 return Py_BuildValue(getvars[i].fmt, jcr->job->hdr.name);
127 case 1: /* Director's name */
128 return Py_BuildValue(getvars[i].fmt, my_name);
130 return Py_BuildValue(getvars[i].fmt, job_level_to_str(jcr->JobLevel));
132 return Py_BuildValue(getvars[i].fmt, job_type_to_str(jcr->JobType));
134 return Py_BuildValue(getvars[i].fmt, jcr->JobId);
136 return Py_BuildValue(getvars[i].fmt, jcr->client->hdr.name);
137 case 6: /* NumVols */
138 return Py_BuildValue(getvars[i].fmt, jcr->NumVols);
140 return Py_BuildValue(getvars[i].fmt, jcr->pool->hdr.name);
141 case 8: /* Storage */
142 return Py_BuildValue(getvars[i].fmt, jcr->store->hdr.name);
144 return Py_BuildValue(getvars[i].fmt, jcr->catalog->hdr.name);
145 case 10: /* MediaType */
146 return Py_BuildValue(getvars[i].fmt, jcr->store->media_type);
147 case 11: /* JobName */
148 return Py_BuildValue(getvars[i].fmt, jcr->Job);
149 case 12: /* JobStatus */
151 buf[0] = jcr->JobStatus;
152 return Py_BuildValue(getvars[i].fmt, buf);
155 bsnprintf(errmsg, sizeof(errmsg), "Attribute %s not found.", attrname);
157 PyErr_SetString(PyExc_AttributeError, errmsg);
162 /* Set Job variables */
166 int job_setattr(PyObject *self, char *attrname, PyObject *value)
173 Dmsg2(100, "In job_setattr=%s val=%p.\n", attrname, value);
174 if (value == NULL) { /* Cannot delete variables */
177 jcr = get_jcr_from_PyObject(self);
182 /* Find attribute name in list */
183 for (i=0; setvars[i].name; i++) {
184 if (strcmp(setvars[i].name, attrname) == 0) {
192 /* Get argument value ***FIXME*** handle other formats */
193 if (setvars[i].fmt != NULL) {
194 if (!PyArg_Parse(value, setvars[i].fmt, &strval)) {
195 PyErr_SetString(PyExc_TypeError, "Read-only attribute");
200 case 0: /* set_events */
201 return set_job_events(self, value);
203 return job_run(self, value);
204 case 2: /* JobReport */
206 Jmsg(jcr, M_INFO, 0, "%s", strval);
208 case 4: /* VolumeName */
209 /* Make sure VolumeName is valid and we are in VolumeName event */
210 if (strcmp("NewVolume", jcr->event) == 0 &&
211 is_volume_name_legal(NULL, strval)) {
212 pm_strcpy(jcr->VolumeName, strval);
213 Dmsg1(100, "Set Vol=%s\n", strval);
216 jcr->VolumeName[0] = 0;
220 PyErr_SetString(PyExc_AttributeError, attrname);
225 static PyObject *set_bacula_job_events(PyObject *self, PyObject *arg)
227 Dmsg2(000, "In set_bacula_job_events self=%p arg=%p\n",
235 static int set_job_events(PyObject *self, PyObject *arg)
240 Dmsg0(100, "In set_job_events.\n");
241 if (!PyArg_Parse(arg, "O", &eObject)) {
244 jcr = get_jcr_from_PyObject(self);
245 Py_XDECREF((PyObject *)jcr->Python_events);
247 jcr->Python_events = (void *)eObject;
248 return 0; /* good return */
251 /* Run a Bacula command */
252 static int job_run(PyObject *self, PyObject *arg)
258 if (!PyArg_Parse(arg, "s", &item)) {
261 jcr = get_jcr_from_PyObject(self);
262 UAContext *ua = new_ua_context(jcr);
264 pm_strcpy(ua->cmd, item); /* copy command */
265 parse_ua_args(ua); /* parse command */
266 stat = run_cmd(ua, ua->cmd);
268 /* ***FIXME*** check stat */
273 int generate_job_event(JCR *jcr, const char *event)
275 PyObject *method = NULL;
276 PyObject *Job = (PyObject *)jcr->Python_job;
277 PyObject *result = NULL;
284 PyEval_AcquireLock();
286 PyObject *events = (PyObject *)jcr->Python_events;
287 method = find_method(events, method, event);
292 bstrncpy(jcr->event, event, sizeof(jcr->event));
293 result = PyObject_CallFunction(method, "O", Job);
294 jcr->event[0] = 0; /* no event in progress */
295 if (result == NULL) {
296 if (PyErr_Occurred()) {
298 Dmsg1(000, "Error in Python method %s\n", event);
306 PyEval_ReleaseLock();
310 bool python_set_prog(JCR*, char const*) { return false; }
314 /* Dummy if Python not configured */
315 int generate_job_event(JCR *jcr, const char *event) { return 1; }
318 #endif /* HAVE_PYTHON */