ece9d7b6c8f39b4680710e2ca2d2e15e54e22fa7
[blender.git] / source / gameengine / GameLogic / SCA_PythonController.cpp
1 /*
2  * Execute Python scripts
3  *
4  *
5  * ***** BEGIN GPL LICENSE BLOCK *****
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
22  * All rights reserved.
23  *
24  * The Original Code is: all of this file.
25  *
26  * Contributor(s): none yet.
27  *
28  * ***** END GPL LICENSE BLOCK *****
29  */
30
31 /** \file gameengine/GameLogic/SCA_PythonController.cpp
32  *  \ingroup gamelogic
33  */
34
35
36 #include <stddef.h>
37
38 #include "SCA_PythonController.h"
39 #include "SCA_LogicManager.h"
40 #include "SCA_ISensor.h"
41 #include "SCA_IActuator.h"
42 #include "PyObjectPlus.h"
43
44 #ifdef WITH_PYTHON
45 #include "compile.h"
46 #include "eval.h"
47 #endif // WITH_PYTHON
48
49 #include <algorithm>
50
51
52 // initialize static member variables
53 SCA_PythonController* SCA_PythonController::m_sCurrentController = NULL;
54
55
56 SCA_PythonController::SCA_PythonController(SCA_IObject* gameobj, int mode)
57         : SCA_IController(gameobj),
58 #ifdef WITH_PYTHON
59         m_bytecode(NULL),
60         m_function(NULL),
61 #endif
62         m_function_argc(0),
63         m_bModified(true),
64         m_debug(false),
65         m_mode(mode)
66 #ifdef WITH_PYTHON
67         , m_pythondictionary(NULL)
68 #endif
69
70 {
71         
72 }
73
74 #if 0
75 //debugging
76 CValue *SCA_PythonController::AddRef()
77 {
78         //printf("AddRef refcount = %i\n",GetRefCount());
79         return CValue::AddRef();
80 }
81 int SCA_PythonController::Release()
82 {
83         //printf("Release refcount = %i\n",GetRefCount());
84         return CValue::Release();
85 }
86 #endif
87
88 SCA_PythonController::~SCA_PythonController()
89 {
90
91 #ifdef WITH_PYTHON
92         //printf("released python byte script\n");
93         
94         Py_XDECREF(m_bytecode);
95         Py_XDECREF(m_function);
96         
97         if (m_pythondictionary) {
98                 // break any circular references in the dictionary
99                 PyDict_Clear(m_pythondictionary);
100                 Py_DECREF(m_pythondictionary);
101         }
102 #endif
103 }
104
105
106
107 CValue* SCA_PythonController::GetReplica()
108 {
109         SCA_PythonController* replica = new SCA_PythonController(*this);
110
111 #ifdef WITH_PYTHON
112         /* why is this needed at all??? - m_bytecode is NULL'd below so this doesnt make sense
113          * but removing it crashes blender (with YoFrankie). so leave in for now - Campbell */
114         Py_XINCREF(replica->m_bytecode);
115         
116         Py_XINCREF(replica->m_function); // this is ok since its not set to NULL
117         replica->m_bModified = replica->m_bytecode == NULL;
118         
119         // The replica->m_pythondictionary is stolen - replace with a copy.
120         if (m_pythondictionary)
121                 replica->m_pythondictionary = PyDict_Copy(m_pythondictionary);
122                 
123 #if 0
124         // The other option is to incref the replica->m_pythondictionary -
125         // the replica objects can then share data.
126         if (m_pythondictionary)
127                 Py_INCREF(replica->m_pythondictionary);
128 #endif
129
130 #endif /* WITH_PYTHON */
131         
132         // this will copy properties and so on...
133         replica->ProcessReplica();
134
135         return replica;
136 }
137
138
139
140 void SCA_PythonController::SetScriptText(const STR_String& text)
141
142         m_scriptText = text;
143         m_bModified = true;
144 }
145
146
147
148 void SCA_PythonController::SetScriptName(const STR_String& name)
149 {
150         m_scriptName = name;
151 }
152
153
154 #ifdef WITH_PYTHON
155 void SCA_PythonController::SetNamespace(PyObject*       pythondictionary)
156 {
157         if (m_pythondictionary)
158         {
159                 PyDict_Clear(m_pythondictionary);
160                 Py_DECREF(m_pythondictionary);
161         }
162         m_pythondictionary = PyDict_Copy(pythondictionary); /* new reference */
163         
164         /* Without __file__ set the sys.argv[0] is used for the filename
165          * which ends up with lines from the blender binary being printed in the console */
166         PyDict_SetItemString(m_pythondictionary, "__file__", PyUnicode_From_STR_String(m_scriptName));
167         
168 }
169 #endif
170
171 int SCA_PythonController::IsTriggered(class SCA_ISensor* sensor)
172 {
173         if (std::find(m_triggeredSensors.begin(), m_triggeredSensors.end(), sensor) != 
174                 m_triggeredSensors.end())
175                 return 1;
176         return 0;
177 }
178
179 #ifdef WITH_PYTHON
180
181 /* warning, self is not the SCA_PythonController, its a PyObjectPlus_Proxy */
182 PyObject *SCA_PythonController::sPyGetCurrentController(PyObject *self)
183 {
184         if (m_sCurrentController==NULL)
185         {
186                 PyErr_SetString(PyExc_SystemError, "bge.logic.getCurrentController(), this function is being run outside the python controllers context, or blenders internal state is corrupt.");
187                 return NULL;
188         }
189         return m_sCurrentController->GetProxy();
190 }
191
192 SCA_IActuator* SCA_PythonController::LinkedActuatorFromPy(PyObject *value)
193 {
194         // for safety, todo: only allow for registered actuators (pointertable)
195         // we don't want to crash gameengine/blender by python scripts
196         std::vector<SCA_IActuator*> lacts =  m_sCurrentController->GetLinkedActuators();
197         std::vector<SCA_IActuator*>::iterator it;
198         
199         if (PyUnicode_Check(value)) {
200                 /* get the actuator from the name */
201                 const char *name= _PyUnicode_AsString(value);
202                 for (it = lacts.begin(); it!= lacts.end(); ++it) {
203                         if ( name == (*it)->GetName() ) {
204                                 return *it;
205                         }
206                 }
207         }
208         else if (PyObject_TypeCheck(value, &SCA_IActuator::Type)) {
209                 PyObjectPlus *value_plus= BGE_PROXY_REF(value);
210                 for (it = lacts.begin(); it!= lacts.end(); ++it) {
211                         if (static_cast<SCA_IActuator*>(value_plus) == (*it)) {
212                                 return *it;
213                         }
214                 }
215         }
216
217         /* set the exception */
218         PyErr_Format(PyExc_ValueError,
219                      "%R not in this python controllers actuator list", value);
220
221         return NULL;
222 }
223
224 const char* SCA_PythonController::sPyGetCurrentController__doc__ = "getCurrentController()";
225
226 PyTypeObject SCA_PythonController::Type = {
227         PyVarObject_HEAD_INIT(NULL, 0)
228         "SCA_PythonController",
229         sizeof(PyObjectPlus_Proxy),
230         0,
231         py_base_dealloc,
232         0,
233         0,
234         0,
235         0,
236         py_base_repr,
237         0,0,0,0,0,0,0,0,0,
238         Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
239         0,0,0,0,0,0,0,
240         Methods,
241         0,
242         0,
243         &SCA_IController::Type,
244         0,0,0,0,0,0,
245         py_base_new
246 };
247
248 PyMethodDef SCA_PythonController::Methods[] = {
249         {"activate", (PyCFunction) SCA_PythonController::sPyActivate, METH_O},
250         {"deactivate", (PyCFunction) SCA_PythonController::sPyDeActivate, METH_O},
251         {NULL,NULL} //Sentinel
252 };
253
254 PyAttributeDef SCA_PythonController::Attributes[] = {
255         KX_PYATTRIBUTE_RW_FUNCTION("script", SCA_PythonController, pyattr_get_script, pyattr_set_script),
256         KX_PYATTRIBUTE_INT_RO("mode", SCA_PythonController, m_mode),
257         { NULL }        //Sentinel
258 };
259
260 void SCA_PythonController::ErrorPrint(const char *error_msg)
261 {
262         printf("%s - object '%s', controller '%s':\n", error_msg, GetParent()->GetName().Ptr(), GetName().Ptr());
263         PyErr_Print();
264         
265         /* Added in 2.48a, the last_traceback can reference Objects for example, increasing
266          * their user count. Not to mention holding references to wrapped data.
267          * This is especially bad when the PyObject for the wrapped data is freed, after blender
268          * has already dealocated the pointer */
269         PySys_SetObject( (char *)"last_traceback", NULL);
270         PyErr_Clear(); /* just to be sure */
271 }
272
273 bool SCA_PythonController::Compile()
274 {
275         //printf("py script modified '%s'\n", m_scriptName.Ptr());
276         m_bModified= false;
277         
278         // if a script already exists, decref it before replace the pointer to a new script
279         if (m_bytecode) {
280                 Py_DECREF(m_bytecode);
281                 m_bytecode=NULL;
282         }
283         
284         // recompile the scripttext into bytecode
285         m_bytecode = Py_CompileString(m_scriptText.Ptr(), m_scriptName.Ptr(), Py_file_input);
286         
287         if (m_bytecode) {
288                 return true;
289         } else {
290                 ErrorPrint("Python error compiling script");
291                 return false;
292         }
293 }
294
295 bool SCA_PythonController::Import()
296 {
297         //printf("py module modified '%s'\n", m_scriptName.Ptr());
298         m_bModified= false;
299
300         /* in case we re-import */
301         Py_XDECREF(m_function);
302         m_function= NULL;
303         
304         STR_String mod_path_str= m_scriptText; /* just for storage, use C style string access */
305         char *mod_path= mod_path_str.Ptr();
306         char *function_string;
307
308         function_string= strrchr(mod_path, '.');
309
310         if (function_string == NULL) {
311                 printf("Python module name formatting error in object '%s', controller '%s':\n\texpected 'SomeModule.Func', got '%s'\n", GetParent()->GetName().Ptr(), GetName().Ptr(), m_scriptText.Ptr());
312                 return false;
313         }
314
315         *function_string= '\0';
316         function_string++;
317
318         // Import the module and print an error if it's not found
319         PyObject *mod = PyImport_ImportModule(mod_path);
320
321         if (mod == NULL) {
322                 ErrorPrint("Python module can't be imported");
323                 return false;
324         }
325
326         if (m_debug)
327                 mod = PyImport_ReloadModule(mod);
328
329         if (mod == NULL) {
330                 ErrorPrint("Python module can't be reloaded");
331                 return false;
332         }
333
334         // Get the function object
335         m_function = PyObject_GetAttrString(mod, function_string);
336
337         // DECREF the module as we don't need it anymore
338         Py_DECREF(mod);
339
340         if (m_function==NULL) {
341                 if (PyErr_Occurred())
342                         ErrorPrint("Python controller found the module but could not access the function");
343                 else
344                         printf("Python module error in object '%s', controller '%s':\n '%s' module found but function missing\n", GetParent()->GetName().Ptr(), GetName().Ptr(), m_scriptText.Ptr());
345                 return false;
346         }
347         
348         if (!PyCallable_Check(m_function)) {
349                 Py_DECREF(m_function);
350                 m_function = NULL;
351                 printf("Python module function error in object '%s', controller '%s':\n '%s' not callable\n", GetParent()->GetName().Ptr(), GetName().Ptr(), m_scriptText.Ptr());
352                 return false;
353         }
354         
355         m_function_argc = 0; /* rare cases this could be a function that isn't defined in python, assume zero args */
356         if (PyFunction_Check(m_function)) {
357                 m_function_argc= ((PyCodeObject *)PyFunction_GET_CODE(m_function))->co_argcount;
358         }
359         
360         if (m_function_argc > 1) {
361                 Py_DECREF(m_function);
362                 m_function = NULL;
363                 printf("Python module function in object '%s', controller '%s':\n '%s' takes %d args, should be zero or 1 controller arg\n", GetParent()->GetName().Ptr(), GetName().Ptr(), m_scriptText.Ptr(), m_function_argc);
364                 return false;
365         }
366         
367         return true;
368 }
369
370
371 void SCA_PythonController::Trigger(SCA_LogicManager* logicmgr)
372 {
373         m_sCurrentController = this;
374         m_sCurrentLogicManager = logicmgr;
375         
376         PyObject *excdict=              NULL;
377         PyObject *resultobj=    NULL;
378         
379         switch (m_mode) {
380                 case SCA_PYEXEC_SCRIPT:
381                 {
382                         if (m_bModified)
383                                 if (Compile()==false) // sets m_bModified to false
384                                         return;
385                         if (!m_bytecode)
386                                 return;
387
388                         /*
389                          * This part here with excdict is a temporary patch
390                          * to avoid python/gameengine crashes when python
391                          * inadvertently holds references to game objects
392                          * in global variables.
393                          *
394                          * The idea is always make a fresh dictionary, and
395                          * destroy it right after it is used to make sure
396                          * python won't hold any gameobject references.
397                          *
398                          * Note that the PyDict_Clear _is_ necessary before
399                          * the Py_DECREF() because it is possible for the
400                          * variables inside the dictionary to hold references
401                          * to the dictionary (ie. generate a cycle), so we
402                          * break it by hand, then DECREF (which in this case
403                          * should always ensure excdict is cleared).
404                          */
405
406                         excdict= PyDict_Copy(m_pythondictionary);
407
408                         resultobj = PyEval_EvalCode((PyObject *)m_bytecode, excdict, excdict);
409
410                         /* PyRun_SimpleString(m_scriptText.Ptr()); */
411                         break;
412                 }
413                 case SCA_PYEXEC_MODULE:
414                 {
415                         if (m_bModified || m_debug)
416                                 if (Import()==false) // sets m_bModified to false
417                                         return;
418                         if (!m_function)
419                                 return;
420
421                         PyObject *args= NULL;
422
423                         if (m_function_argc==1) {
424                                 args = PyTuple_New(1);
425                                 PyTuple_SET_ITEM(args, 0, GetProxy());
426                         }
427
428                         resultobj = PyObject_CallObject(m_function, args);
429                         Py_XDECREF(args);
430                         break;
431                 }
432
433         } /* end switch */
434
435
436         /* Free the return value and print the error */
437         if (resultobj)
438                 Py_DECREF(resultobj);
439         else
440                 ErrorPrint("Python script error");
441         
442         if (excdict) /* Only for SCA_PYEXEC_SCRIPT types */
443         {
444                 /* clear after PyErrPrint - seems it can be using
445                  * something in this dictionary and crash? */
446                 // This doesn't appear to be needed anymore
447                 //PyDict_Clear(excdict);
448                 Py_DECREF(excdict);
449         }
450         
451         m_triggeredSensors.clear();
452         m_sCurrentController = NULL;
453 }
454
455 PyObject *SCA_PythonController::PyActivate(PyObject *value)
456 {
457         if (m_sCurrentController != this) {
458                 PyErr_SetString(PyExc_SystemError, "Cannot add an actuator from a non-active controller");
459                 return NULL;
460         }
461         
462         SCA_IActuator* actu = LinkedActuatorFromPy(value);
463         if (actu==NULL)
464                 return NULL;
465         
466         m_sCurrentLogicManager->AddActiveActuator((SCA_IActuator*)actu, true);
467         Py_RETURN_NONE;
468 }
469
470 PyObject *SCA_PythonController::PyDeActivate(PyObject *value)
471 {
472         if (m_sCurrentController != this) {
473                 PyErr_SetString(PyExc_SystemError, "Cannot add an actuator from a non-active controller");
474                 return NULL;
475         }
476         
477         SCA_IActuator* actu = LinkedActuatorFromPy(value);
478         if (actu==NULL)
479                 return NULL;
480         
481         m_sCurrentLogicManager->AddActiveActuator((SCA_IActuator*)actu, false);
482         Py_RETURN_NONE;
483 }
484
485 PyObject *SCA_PythonController::pyattr_get_script(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef)
486 {
487         //SCA_PythonController* self = static_cast<SCA_PythonController*>(static_cast<SCA_IController*>(static_cast<SCA_ILogicBrick*>(static_cast<CValue*>(static_cast<PyObjectPlus*>(self_v)))));
488         // static_cast<void *>(dynamic_cast<Derived *>(obj)) - static_cast<void *>(obj)
489
490         SCA_PythonController* self = static_cast<SCA_PythonController*>(self_v);
491         return PyUnicode_From_STR_String(self->m_scriptText);
492 }
493
494
495
496 int SCA_PythonController::pyattr_set_script(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value)
497 {
498         SCA_PythonController* self = static_cast<SCA_PythonController*>(self_v);
499         
500         const char *scriptArg = _PyUnicode_AsString(value);
501         
502         if (scriptArg==NULL) {
503                 PyErr_SetString(PyExc_TypeError, "controller.script = string: Python Controller, expected a string script text");
504                 return PY_SET_ATTR_FAIL;
505         }
506
507         /* set scripttext sets m_bModified to true, 
508          * so next time the script is needed, a reparse into byte code is done */
509         self->SetScriptText(scriptArg);
510                 
511         return PY_SET_ATTR_SUCCESS;
512 }
513
514 #else // WITH_PYTHON
515
516 void SCA_PythonController::Trigger(SCA_LogicManager* logicmgr)
517 {
518         /* intentionally blank */
519 }
520
521 #endif // WITH_PYTHON
522
523 /* eof */