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