Merge branch 'blender2.7'
[blender.git] / source / blender / python / generic / bpy_internal_import.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file blender/python/generic/bpy_internal_import.c
18  *  \ingroup pygen
19  *
20  * This file defines replacements for pythons '__import__' and 'imp.reload'
21  * functions which can import from blender textblocks.
22  *
23  * \note
24  * This should eventually be replaced by import hooks (pep 302).
25  */
26
27
28 #include <Python.h>
29 #include <stddef.h>
30
31 #include "MEM_guardedalloc.h"
32
33 #include "DNA_text_types.h"
34
35 #include "BLI_listbase.h"
36 #include "BLI_path_util.h"
37 #include "BLI_string.h"
38 #include "BLI_utildefines.h"
39
40 #include "BKE_main.h"
41 /* UNUSED */
42 #include "BKE_text.h"  /* txt_to_buf */
43
44 #include "py_capi_utils.h"
45
46 #include "bpy_internal_import.h"  /* own include */
47
48 static Main *bpy_import_main = NULL;
49 static ListBase bpy_import_main_list;
50
51 static PyMethodDef bpy_import_meth;
52 static PyMethodDef bpy_reload_meth;
53 static PyObject   *imp_reload_orig = NULL;
54
55 /* 'builtins' is most likely PyEval_GetBuiltins() */
56
57 /**
58  * \note to the discerning developer, yes - this is nasty
59  * monkey-patching our own import into Python's builtin 'imp' module.
60  *
61  * However Python's alternative is to use import hooks,
62  * which are implemented in a way that we can't use our own importer as a
63  * fall-back (instead we must try and fail - raise an exception every time).
64  * Since importing from blenders text-blocks is not the common case
65  * I prefer to use Pythons import by default and fall-back to
66  * Blenders - which we can only do by intercepting import calls I'm afraid.
67  * - Campbell
68  */
69 void bpy_import_init(PyObject *builtins)
70 {
71         PyObject *item;
72         PyObject *mod;
73
74         PyDict_SetItemString(builtins, "__import__", item = PyCFunction_New(&bpy_import_meth, NULL)); Py_DECREF(item);
75
76         /* move reload here
77          * XXX, use import hooks */
78         mod = PyImport_ImportModuleLevel("importlib", NULL, NULL, NULL, 0);
79         if (mod) {
80                 PyObject *mod_dict = PyModule_GetDict(mod);
81
82                 /* blender owns the function */
83                 imp_reload_orig = PyDict_GetItemString(mod_dict, "reload");
84                 Py_INCREF(imp_reload_orig);
85
86                 PyDict_SetItemString(mod_dict, "reload", item = PyCFunction_New(&bpy_reload_meth, NULL)); Py_DECREF(item);
87                 Py_DECREF(mod);
88         }
89         else {
90                 BLI_assert(!"unable to load 'importlib' module.");
91         }
92 }
93
94
95 static void free_compiled_text(Text *text)
96 {
97         if (text->compiled) {
98                 Py_DECREF((PyObject *)text->compiled);
99         }
100         text->compiled = NULL;
101 }
102
103 struct Main *bpy_import_main_get(void)
104 {
105         return bpy_import_main;
106 }
107
108 void bpy_import_main_set(struct Main *maggie)
109 {
110         bpy_import_main = maggie;
111 }
112
113 /* returns a dummy filename for a textblock so we can tell what file a text block comes from */
114 void bpy_text_filename_get(char *fn, size_t fn_len, Text *text)
115 {
116         BLI_snprintf(fn, fn_len, "%s%c%s", ID_BLEND_PATH(bpy_import_main, &text->id), SEP, text->id.name + 2);
117 }
118
119 bool bpy_text_compile(Text *text)
120 {
121         char fn_dummy[FILE_MAX];
122         PyObject *fn_dummy_py;
123         char *buf;
124
125         bpy_text_filename_get(fn_dummy, sizeof(fn_dummy), text);
126
127         /* if previously compiled, free the object */
128         free_compiled_text(text);
129
130         fn_dummy_py = PyC_UnicodeFromByte(fn_dummy);
131
132         buf = txt_to_buf(text);
133         text->compiled = Py_CompileStringObject(buf, fn_dummy_py, Py_file_input, NULL, -1);
134         MEM_freeN(buf);
135
136         Py_DECREF(fn_dummy_py);
137
138         if (PyErr_Occurred()) {
139                 PyErr_Print();
140                 PyErr_Clear();
141                 PySys_SetObject("last_traceback", NULL);
142                 free_compiled_text(text);
143                 return false;
144         }
145         else {
146                 return true;
147         }
148 }
149
150 PyObject *bpy_text_import(Text *text)
151 {
152         char modulename[MAX_ID_NAME + 2];
153         int len;
154
155         if (!text->compiled) {
156                 if (bpy_text_compile(text) == false) {
157                         return NULL;
158                 }
159         }
160
161         len = strlen(text->id.name + 2);
162         BLI_strncpy(modulename, text->id.name + 2, len);
163         modulename[len - 3] = '\0'; /* remove .py */
164         return PyImport_ExecCodeModule(modulename, text->compiled);
165 }
166
167 PyObject *bpy_text_import_name(const char *name, int *found)
168 {
169         Text *text;
170         char txtname[MAX_ID_NAME - 2];
171         int namelen = strlen(name);
172 //XXX   Main *maggie = bpy_import_main ? bpy_import_main : G_MAIN;
173         Main *maggie = bpy_import_main;
174
175         *found = 0;
176
177         if (!maggie) {
178                 printf("ERROR: bpy_import_main_set() was not called before running python. this is a bug.\n");
179                 return NULL;
180         }
181
182         /* we know this cant be importable, the name is too long for blender! */
183         if (namelen >= (MAX_ID_NAME - 2) - 3)
184                 return NULL;
185
186         memcpy(txtname, name, namelen);
187         memcpy(&txtname[namelen], ".py", 4);
188
189         text = BLI_findstring(&maggie->text, txtname, offsetof(ID, name) + 2);
190
191         if (text) {
192                 *found = 1;
193                 return bpy_text_import(text);
194         }
195
196         /* If we still haven't found the module try additional modules form bpy_import_main_list */
197         maggie = bpy_import_main_list.first;
198         while (maggie && !text) {
199                 text = BLI_findstring(&maggie->text, txtname, offsetof(ID, name) + 2);
200                 maggie = maggie->next;
201         }
202
203         if (!text)
204                 return NULL;
205         else
206                 *found = 1;
207
208         return bpy_text_import(text);
209 }
210
211
212 /*
213  * find in-memory module and recompile
214  */
215
216 PyObject *bpy_text_reimport(PyObject *module, int *found)
217 {
218         Text *text;
219         const char *name;
220         const char *filepath;
221 //XXX   Main *maggie = bpy_import_main ? bpy_import_main : G_MAIN;
222         Main *maggie = bpy_import_main;
223
224         if (!maggie) {
225                 printf("ERROR: bpy_import_main_set() was not called before running python. this is a bug.\n");
226                 return NULL;
227         }
228
229         *found = 0;
230
231         /* get name, filename from the module itself */
232         if ((name = PyModule_GetName(module)) == NULL)
233                 return NULL;
234
235         {
236                 PyObject *module_file = PyModule_GetFilenameObject(module);
237                 if (module_file == NULL) {
238                         return NULL;
239                 }
240                 filepath = _PyUnicode_AsString(module_file);
241                 Py_DECREF(module_file);
242                 if (filepath == NULL) {
243                         return NULL;
244                 }
245         }
246
247         /* look up the text object */
248         text = BLI_findstring(&maggie->text, BLI_path_basename(filepath), offsetof(ID, name) + 2);
249
250         /* uh-oh.... didn't find it */
251         if (!text)
252                 return NULL;
253         else
254                 *found = 1;
255
256         if (bpy_text_compile(text) == false) {
257                 return NULL;
258         }
259
260         /* make into a module */
261         return PyImport_ExecCodeModule(name, text->compiled);
262 }
263
264
265 static PyObject *blender_import(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
266 {
267         PyObject *exception, *err, *tb;
268         const char *name;
269         int found = 0;
270         PyObject *globals = NULL, *locals = NULL, *fromlist = NULL;
271         int level = 0; /* relative imports */
272         PyObject *newmodule;
273
274         static const char *_keywords[] = {"name", "globals", "locals", "fromlist", "level", NULL};
275         static _PyArg_Parser _parser = {"s|OOOi:bpy_import_meth", _keywords, 0};
276         if (!_PyArg_ParseTupleAndKeywordsFast(
277                 args, kw, &_parser,
278                 &name, &globals, &locals, &fromlist, &level))
279         {
280                 return NULL;
281         }
282
283         /* import existing builtin modules or modules that have been imported already */
284         newmodule = PyImport_ImportModuleLevel(name, globals, locals, fromlist, level);
285
286         if (newmodule)
287                 return newmodule;
288
289         PyErr_Fetch(&exception, &err, &tb); /* get the python error in case we cant import as blender text either */
290
291         /* importing from existing modules failed, see if we have this module as blender text */
292         newmodule = bpy_text_import_name(name, &found);
293
294         if (newmodule) { /* found module as blender text, ignore above exception */
295                 PyErr_Clear();
296                 Py_XDECREF(exception);
297                 Py_XDECREF(err);
298                 Py_XDECREF(tb);
299                 /* printf("imported from text buffer...\n"); */
300         }
301         else if (found == 1) { /* blender text module failed to execute but was found, use its error message */
302                 Py_XDECREF(exception);
303                 Py_XDECREF(err);
304                 Py_XDECREF(tb);
305                 return NULL;
306         }
307         else {
308                 /* no blender text was found that could import the module
309                  * reuse the original error from PyImport_ImportModuleEx */
310                 PyErr_Restore(exception, err, tb);
311         }
312         return newmodule;
313 }
314
315
316 /*
317  * our reload() module, to handle reloading in-memory scripts
318  */
319
320 static PyObject *blender_reload(PyObject *UNUSED(self), PyObject *module)
321 {
322         PyObject *exception, *err, *tb;
323         PyObject *newmodule = NULL;
324         int found = 0;
325
326         /* try reimporting from file */
327
328         /* in Py3.3 this just calls imp.reload() which we overwrite, causing recursive calls */
329         //newmodule = PyImport_ReloadModule(module);
330
331         newmodule = PyObject_CallFunctionObjArgs(imp_reload_orig, module, NULL);
332
333         if (newmodule)
334                 return newmodule;
335
336         /* no file, try importing from memory */
337         PyErr_Fetch(&exception, &err, &tb); /*restore for probable later use */
338
339         newmodule = bpy_text_reimport(module, &found);
340         if (newmodule) { /* found module as blender text, ignore above exception */
341                 PyErr_Clear();
342                 Py_XDECREF(exception);
343                 Py_XDECREF(err);
344                 Py_XDECREF(tb);
345                 /* printf("imported from text buffer...\n"); */
346         }
347         else if (found == 1) { /* blender text module failed to execute but was found, use its error message */
348                 Py_XDECREF(exception);
349                 Py_XDECREF(err);
350                 Py_XDECREF(tb);
351                 return NULL;
352         }
353         else {
354                 /* no blender text was found that could import the module
355                  * reuse the original error from PyImport_ImportModuleEx */
356                 PyErr_Restore(exception, err, tb);
357         }
358
359         return newmodule;
360 }
361
362 static PyMethodDef bpy_import_meth = {"bpy_import_meth", (PyCFunction)blender_import, METH_VARARGS | METH_KEYWORDS, "blenders import"};
363 static PyMethodDef bpy_reload_meth = {"bpy_reload_meth", (PyCFunction)blender_reload, METH_O, "blenders reload"};