/*
- *
- * Bacula common code library interface to Python
- *
- * Kern Sibbald, November MMIV
- *
- * Version $Id$
- *
- */
+ Bacula® - The Network Backup Solution
-/*
- Copyright (C) 2004-2005 Kern Sibbald
+ Copyright (C) 2004-2008 Free Software Foundation Europe e.V.
- This program 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 2 of
- the License, or (at your option) any later version.
+ 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
+ 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., 59 Temple Place - Suite 330, Boston,
- MA 02111-1307, USA.
+ 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 common code library interface to Python
+ *
+ * Kern Sibbald, November MMIV
+ *
+ * Version $Id$
+ *
*/
#include "bacula.h"
#undef _POSIX_C_SOURCE
#include <Python.h>
-/* Imported subroutines */
-extern PyMethodDef JobMethods[];
+#include "pythonlib.h"
+
+/* Forward referenced subroutines */
+static void init_python_lock();
+static void term_python_lock();
static PyObject *bacula_module = NULL; /* We create this */
static PyObject *StartUp_module = NULL; /* We import this */
{NULL, NULL, 0, NULL} /* last item */
};
+static char my_version[] = VERSION " " BDATE;
/*
* This is a Bacula Job type as defined in Python. We store a pointer
- * to the jcr. That is all we need, but the user's script may keep
- * local data attached to this.
+ * to the jcr. That is all we need, but the user's script may keep
+ * local data attached to this.
*/
typedef struct s_JobObject {
PyObject_HEAD
static PyTypeObject JobType = {
PyObject_HEAD_INIT(NULL)
- 0, /*ob_size*/
- "bacula.jcr", /*tp_name*/
- sizeof(JobObject), /*tp_basicsize*/
- 0, /*tp_itemsize*/
- 0, /*tp_dealloc*/
- 0, /*tp_print*/
- 0, /*tp_getattr*/
- 0, /*tp_setattr*/
- 0, /*tp_compare*/
- 0, /*tp_repr*/
- 0, /*tp_as_number*/
- 0, /*tp_as_sequence*/
- 0, /*tp_as_mapping*/
- 0, /*tp_hash */
- 0, /*tp_call*/
- 0, /*tp_str*/
- 0, /*tp_getattro*/
- 0, /*tp_setattro*/
- 0, /*tp_as_buffer*/
- Py_TPFLAGS_DEFAULT, /*tp_flags*/
- "Job objects", /* tp_doc */
- 0, /* tp_traverse */
- 0, /* tp_clear */
- 0, /* tp_richcompare */
- 0, /* tp_weaklistoffset */
- 0, /* tp_iter */
- 0, /* tp_iternext */
- JobMethods, /* tp_methods */
- 0, /* tp_members */
- 0, /* tp_getset */
- 0, /* tp_base */
- 0, /* tp_dict */
- 0, /* tp_descr_get */
- 0, /* tp_descr_set */
- 0, /* tp_dictoffset */
- 0, /* tp_init */
- 0, /* tp_alloc */
- 0, /* tp_new */
+ /* Other items filled in in code below */
};
/* Return the JCR pointer from the JobObject */
JCR *get_jcr_from_PyObject(PyObject *self)
{
+ if (!self) {
+ return NULL;
+ }
return ((JobObject *)self)->jcr;
}
-
/* Start the interpreter */
-void init_python_interpreter(const char *progname, const char *scripts,
- const char *module)
+void init_python_interpreter(init_python_interpreter_args *args)
{
char buf[MAXSTRING];
- if (!scripts || scripts[0] == 0) {
+ if (!args->scriptdir || args->scriptdir[0] == 0) {
+ Dmsg1(100, "No script dir. prog=%s\n", args->modulename);
return;
}
+ Dmsg2(100, "Script dir=%s prog=%s\n", args->scriptdir, args->modulename);
- Py_SetProgramName((char *)progname);
+ Py_SetProgramName((char *)args->progname);
Py_Initialize();
PyEval_InitThreads();
bacula_module = Py_InitModule("bacula", BaculaMethods);
+ PyModule_AddStringConstant(bacula_module, "Name", my_name);
+ PyModule_AddStringConstant(bacula_module, "Version", my_version);
+ PyModule_AddStringConstant(bacula_module, "ConfigFile", (char *)args->configfile);
+ PyModule_AddStringConstant(bacula_module, "WorkingDir", (char *)args->workingdir);
if (!bacula_module) {
- Jmsg0(NULL, M_ERROR_TERM, 0, "Could not initialize Python\n");
+ Jmsg0(NULL, M_ERROR_TERM, 0, _("Could not initialize Python\n"));
}
bsnprintf(buf, sizeof(buf), "import sys\n"
- "sys.path.append('%s')\n", scripts);
+ "sys.path.append('%s')\n", args->scriptdir);
if (PyRun_SimpleString(buf) != 0) {
- Jmsg1(NULL, M_ERROR_TERM, 0, "Could not Run Python string %s\n", buf);
+ Jmsg1(NULL, M_ERROR_TERM, 0, _("Could not Run Python string %s\n"), buf);
}
- JobType.tp_methods = JobMethods;
- if(PyType_Ready(&JobType) != 0) {
- Jmsg0(NULL, M_ERROR_TERM, 0, "Could not initialize Python Job type.\n");
+
+ /* Explicitly set values we want */
+ JobType.tp_name = "Bacula.Job";
+ JobType.tp_basicsize = sizeof(JobObject);
+ JobType.tp_flags = Py_TPFLAGS_DEFAULT;
+ JobType.tp_doc = "Bacula Job object";
+ JobType.tp_getattr = args->job_getattr;
+ JobType.tp_setattr = args->job_setattr;
+
+ if (PyType_Ready(&JobType) != 0) {
+ Jmsg0(NULL, M_ERROR_TERM, 0, _("Could not initialize Python Job type.\n"));
PyErr_Print();
}
- StartUp_module = PyImport_ImportModule((char *)module);
+ StartUp_module = PyImport_ImportModule((char *)args->modulename);
if (!StartUp_module) {
- Emsg2(M_ERROR, 0, "Could not import Python script %s/%s. Python disabled.\n",
- scripts, module);
+ Emsg2(M_ERROR, 0, _("Could not import Python script %s/%s. Python disabled.\n"),
+ args->scriptdir, args->modulename);
if (PyErr_Occurred()) {
PyErr_Print();
Dmsg0(000, "Python Import error.\n");
}
}
PyEval_ReleaseLock();
+ init_python_lock();
}
-
void term_python_interpreter()
{
if (StartUp_module) {
Py_XDECREF(StartUp_module);
Py_Finalize();
}
+ term_python_lock();
}
static PyObject *set_bacula_events(PyObject *self, PyObject *args)
return Py_None;
}
-
/*
* Check that a method exists and is callable.
*/
PyObject *pJob;
int stat = -1;
PyObject *result = NULL;
+ char *obj_fmt = (char *)"O";
if (!StartUp_module) {
+ Dmsg0(100, "No startup module.\n");
return 0;
}
- PyEval_AcquireLock();
+ Dmsg1(100, "event=%s\n", event);
+ lock_python();
+// PyEval_AcquireLock();
if (strcmp(event, "JobStart") == 0) {
if (!JobStart_method) {
stat = 0;
/* Create JCR argument to send to function */
pJob = (PyObject *)PyObject_New(JobObject, &JobType);
if (!pJob) {
- Jmsg(jcr, M_ERROR, 0, "Could not create Python Job Object.\n");
+ Jmsg(jcr, M_ERROR, 0, _("Could not create Python Job Object.\n"));
goto bail_out;
}
((JobObject *)pJob)->jcr = jcr;
bstrncpy(jcr->event, event, sizeof(jcr->event));
- result = PyObject_CallFunction(JobStart_method, "O", pJob);
+ result = PyObject_CallFunction(JobStart_method, obj_fmt, pJob);
jcr->event[0] = 0; /* no event in progress */
if (result == NULL) {
JobStart_method = NULL;
PyErr_Print();
Dmsg0(000, "Python JobStart error.\n");
}
- Jmsg(jcr, M_ERROR, 0, "Python function \"%s\" not found.\n", event);
+ Jmsg(jcr, M_ERROR, 0, _("Python function \"%s\" not found.\n"), event);
Py_XDECREF(pJob);
goto bail_out;
}
goto jobstart_ok;
} else if (strcmp(event, "JobEnd") == 0) {
- if (!JobEnd_method) {
- stat = 0;
+ if (!JobEnd_method || !jcr->Python_job) {
+ stat = 0; /* probably already here */
goto bail_out;
}
bstrncpy(jcr->event, event, sizeof(jcr->event));
- result = PyObject_CallFunction(JobEnd_method, "O", jcr->Python_job);
+ Dmsg1(100, "Call daemon event=%s\n", event);
+ result = PyObject_CallFunction(JobEnd_method, obj_fmt, jcr->Python_job);
jcr->event[0] = 0; /* no event in progress */
if (result == NULL) {
- JobEnd_method = NULL;
if (PyErr_Occurred()) {
PyErr_Print();
- Dmsg1(000, "Python JobEnd error. JobId=%d\n", jcr->JobId);
+ Dmsg2(000, "Python JobEnd error. job=%p JobId=%d\n", jcr->Python_job,
+ jcr->JobId);
+ JobEnd_method = NULL;
}
- Jmsg(jcr, M_ERROR, 0, "Python function \"%s\" not found.\n", event);
+ Jmsg(jcr, M_ERROR, 0, _("Python function \"%s\" not found.\n"), event);
goto bail_out;
}
stat = 1; /* OK */
stat = 0;
goto bail_out;
}
- result = PyObject_CallFunction(JobEnd_method, NULL);
+ result = PyObject_CallFunction(Exit_method, NULL);
if (result == NULL) {
goto bail_out;
}
stat = 1; /* OK */
} else {
- Emsg1(M_ABORT, 0, "Unknown Python daemon event %s\n", event);
+ Jmsg1(jcr, M_ABORT, 0, _("Unknown Python daemon event %s\n"), event);
}
bail_out:
- Py_XDECREF((PyObject *)jcr->Python_job);
- jcr->Python_job = NULL;
- Py_XDECREF((PyObject *)jcr->Python_events);
- jcr->Python_events = NULL;
+ if (jcr) {
+ Py_XDECREF((PyObject *)jcr->Python_job);
+ jcr->Python_job = NULL;
+ Py_XDECREF((PyObject *)jcr->Python_events);
+ jcr->Python_events = NULL;
+ }
/* Fall through */
jobstart_ok:
Py_XDECREF(result);
- PyEval_ReleaseLock();
+ unlock_python();
+// PyEval_ReleaseLock();
return stat;
}
-#ifdef xxx
- PyObject *pName, *pModule, *pDict, *pFunc;
- PyObject *pArgs, *pJCR, *pCall;
-
- Dmsg1(100, "Generate event %s\n", event);
- pName = PyString_FromString(event);
- if (!pName) {
- Jmsg(jcr, M_ERROR, 0, "Could not convert \"%s\" to Python string.\n", event);
- return -1; /* Could not convert string */
+static brwlock_t python_rwlock;
+
+static void init_python_lock()
+{
+ int errstat;
+ if ((errstat=rwl_init(&python_rwlock)) != 0) {
+ berrno be;
+ Emsg1(M_ABORT, 0, _("Unable to initialize the Python lock. ERR=%s\n"),
+ be.bstrerror(errstat));
}
- pModule = PyImport_Import(pName);
- Py_DECREF(pName); /* release pName */
-
- if (pModule != NULL) {
- pDict = PyModule_GetDict(pModule);
- /* pDict is a borrowed reference */
-
- pFunc = PyDict_GetItemString(pDict, (char *)event);
- /* pFun: Borrowed reference */
-
- if (pFunc && PyCallable_Check(pFunc)) {
- /* Create JCR argument to send to function */
- pArgs = PyTuple_New(1);
- pJCR = (PyObject *)PyObject_New(JCRObject, &JCRType);
- ((JCRObject *)pJCR)->jcr = jcr;
- if (!pJCR) {
- Py_DECREF(pArgs);
- Py_DECREF(pModule);
- Jmsg0(jcr, M_ERROR, 0, "Could not create JCR Python Object.\n");
- return -1;
- }
- Py_INCREF(pJCR);
- /* pJCR reference stolen here: */
- PyTuple_SetItem(pArgs, 0, pJCR);
-
- /* Finally, we call the module here */
- bstrncpy(jcr->event, event, sizeof(jcr->event));
- pCall = PyObject_CallObject(pFunc, pArgs);
- jcr->event[0] = 0; /* no event in progress */
- Py_DECREF(pArgs);
- Py_DECREF(pJCR);
- if (pCall != NULL) {
- Py_DECREF(pCall);
- } else {
- Py_DECREF(pModule);
- PyErr_Print();
- Jmsg1(jcr, M_ERROR, 0, "Error running Python module: %s\n", event);
- return 0; /* error running function */
- }
- /* pDict and pFunc are borrowed and must not be Py_DECREF-ed */
- } else {
- if (PyErr_Occurred()) {
- PyErr_Print();
- Dmsg1(000, "Python event %s function not callable.\n", event);
- }
- Jmsg1(jcr, M_ERROR, 0, "Python function \"%s\" not found in module.\n", event);
- return -1; /* function not found */
- }
- Py_DECREF(pModule);
- } else {
- return 0; /* Module not present */
+}
+
+static void term_python_lock()
+{
+ rwl_destroy(&python_rwlock);
+}
+
+/* This applies to a drive and to Volumes */
+void lock_python()
+{
+ int errstat;
+ if ((errstat=rwl_writelock(&python_rwlock)) != 0) {
+ berrno be;
+ Emsg2(M_ABORT, 0, "Python rwl_writelock failure. stat=%d: ERR=%s\n",
+ errstat, be.bstrerror(errstat));
+ }
+}
+
+void unlock_python()
+{
+ int errstat;
+ if ((errstat=rwl_writeunlock(&python_rwlock)) != 0) {
+ berrno be;
+ Emsg2(M_ABORT, 0, "Python rwl_writeunlock failure. stat=%d: ERR=%s\n",
+ errstat, be.bstrerror(errstat));
}
- Dmsg0(100, "Generate event OK\n");
- return 1;
}
-#endif
#else
* problems even if it is not configured.
*/
int generate_daemon_event(JCR *jcr, const char *event) { return 0; }
-void init_python_interpreter(const char *progname, const char *scripts,
- const char *module) { }
-void term_python_interpreter() { }
#endif /* HAVE_PYTHON */
projects / bacula / bacula / blobdiff