fix [#26803] Libs paths are case sensitive in windows
[blender.git] / source / blender / python / intern / bpy.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Campbell Barton
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file blender/python/intern/bpy.c
26  *  \ingroup pythonintern
27  */
28
29  
30 /* This file defines the '_bpy' module which is used by python's 'bpy' package.
31  * a script writer should never directly access this module */
32  
33 #define WITH_PYTHON /* for AUD_PyInit.h, possibly others */
34
35 #include <Python.h>
36
37 #include "bpy.h" 
38 #include "bpy_util.h" 
39 #include "bpy_rna.h"
40 #include "bpy_app.h"
41 #include "bpy_props.h"
42 #include "bpy_operator.h"
43
44 #include "BLI_path_util.h"
45 #include "BLI_bpath.h"
46 #include "BLI_utildefines.h"
47
48
49 #include "BKE_global.h" /* XXX, G.main only */
50
51 #include "RNA_access.h"
52
53 #include "MEM_guardedalloc.h"
54
55  /* external util modules */
56 #include "../generic/mathutils.h"
57 #include "../generic/bgl.h"
58 #include "../generic/blf_py_api.h"
59 #include "../generic/IDProp.h"
60
61 #include "AUD_PyInit.h"
62
63 PyObject *bpy_package_py= NULL;
64
65 static char bpy_script_paths_doc[] =
66 ".. function:: script_paths()\n"
67 "\n"
68 "   Return 2 paths to blender scripts directories.\n"
69 "\n"
70 "   :return: (system, user) strings will be empty when not found.\n"
71 "   :rtype: tuple of strigs\n";
72
73 static PyObject *bpy_script_paths(PyObject *UNUSED(self))
74 {
75         PyObject *ret= PyTuple_New(2);
76         char *path;
77     
78         path= BLI_get_folder(BLENDER_USER_SCRIPTS, NULL);
79         PyTuple_SET_ITEM(ret, 0, PyUnicode_FromString(path?path:""));
80         path= BLI_get_folder(BLENDER_SYSTEM_SCRIPTS, NULL);
81         PyTuple_SET_ITEM(ret, 1, PyUnicode_FromString(path?path:""));
82     
83         return ret;
84 }
85
86 static char bpy_blend_paths_doc[] =
87 ".. function:: blend_paths(absolute=False)\n"
88 "\n"
89 "   Returns a list of paths to external files referenced by the loaded .blend file.\n"
90 "\n"
91 "   :arg absolute: When true the paths returned are made absolute.\n"
92 "   :type absolute: boolean\n"
93 "   :return: path list.\n"
94 "   :rtype: list of strigs\n";
95 static PyObject *bpy_blend_paths(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
96 {
97         struct BPathIterator *bpi;
98         PyObject *list, *st; /* stupidly big string to be safe */
99         /* be sure there is low chance of the path being too short */
100         char filepath_expanded[1024];
101         const char *lib;
102
103         int absolute= 0;
104         static const char *kwlist[]= {"absolute", NULL};
105
106         if (!PyArg_ParseTupleAndKeywords(args, kw, "|i:blend_paths", (char **)kwlist, &absolute))
107                 return NULL;
108
109         list= PyList_New(0);
110
111         for(BLI_bpathIterator_init(&bpi, G.main, NULL, 0); !BLI_bpathIterator_isDone(bpi); BLI_bpathIterator_step(bpi)) {
112                 /* build the list */
113                 if (absolute) {
114                         BLI_bpathIterator_getPathExpanded(bpi, filepath_expanded);
115                 }
116                 else {
117                         lib= BLI_bpathIterator_getLib(bpi);
118                         if (lib && (BLI_path_cmp(lib, BLI_bpathIterator_getBasePath(bpi)))) { /* relative path to the library is NOT the same as our blendfile path, return an absolute path */
119                                 BLI_bpathIterator_getPathExpanded(bpi, filepath_expanded);
120                         }
121                         else {
122                                 BLI_bpathIterator_getPath(bpi, filepath_expanded);
123                         }
124                 }
125                 st= PyUnicode_DecodeFSDefault(filepath_expanded);
126
127                 PyList_Append(list, st);
128                 Py_DECREF(st);
129         }
130
131         BLI_bpathIterator_free(bpi);
132
133         return list;
134 }
135
136
137 // static char bpy_user_resource_doc[]= // now in bpy/utils.py
138 static PyObject *bpy_user_resource(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
139 {
140         char *type;
141         char *subdir= NULL;
142         int folder_id;
143         static const char *kwlist[]= {"type", "subdir", NULL};
144
145         char *path;
146
147         if (!PyArg_ParseTupleAndKeywords(args, kw, "s|s:user_resource", (char **)kwlist, &type, &subdir))
148                 return NULL;
149         
150         /* stupid string compare */
151         if     (!strcmp(type, "DATAFILES"))     folder_id= BLENDER_USER_DATAFILES;
152         else if(!strcmp(type, "CONFIG"))        folder_id= BLENDER_USER_CONFIG;
153         else if(!strcmp(type, "SCRIPTS"))       folder_id= BLENDER_USER_SCRIPTS;
154         else if(!strcmp(type, "AUTOSAVE"))      folder_id= BLENDER_USER_AUTOSAVE;
155         else {
156                 PyErr_SetString(PyExc_ValueError, "invalid resource argument");
157                 return NULL;
158         }
159         
160         /* same logic as BLI_get_folder_create(), but best leave it up to the script author to create */
161         path= BLI_get_folder(folder_id, subdir);
162
163         if (!path)
164                 path= BLI_get_user_folder_notest(folder_id, subdir);
165
166         return PyUnicode_DecodeFSDefault(path ? path : "");
167 }
168
169 static PyMethodDef meth_bpy_script_paths= {"script_paths", (PyCFunction)bpy_script_paths, METH_NOARGS, bpy_script_paths_doc};
170 static PyMethodDef meth_bpy_blend_paths= {"blend_paths", (PyCFunction)bpy_blend_paths, METH_VARARGS|METH_KEYWORDS, bpy_blend_paths_doc};
171 static PyMethodDef meth_bpy_user_resource= {"user_resource", (PyCFunction)bpy_user_resource, METH_VARARGS|METH_KEYWORDS, NULL};
172
173 static PyObject *bpy_import_test(const char *modname)
174 {
175         PyObject *mod= PyImport_ImportModuleLevel((char *)modname, NULL, NULL, NULL, 0);
176         if(mod) {
177                 Py_DECREF(mod);
178         }
179         else {
180                 PyErr_Print();
181                 PyErr_Clear();
182         }
183
184         return mod;
185 }
186
187 /*****************************************************************************
188 * Description: Creates the bpy module and adds it to sys.modules for importing
189 *****************************************************************************/
190 void BPy_init_modules( void )
191 {
192         extern BPy_StructRNA *bpy_context_module;
193         extern int bpy_lib_init(PyObject *);
194         PointerRNA ctx_ptr;
195         PyObject *mod;
196
197         /* Needs to be first since this dir is needed for future modules */
198         char *modpath= BLI_get_folder(BLENDER_SCRIPTS, "modules");
199         if(modpath) {
200                 // printf("bpy: found module path '%s'.\n", modpath);
201                 PyObject *sys_path= PySys_GetObject("path"); /* borrow */
202                 PyObject *py_modpath= PyUnicode_FromString(modpath);
203                 PyList_Insert(sys_path, 0, py_modpath); /* add first */
204                 Py_DECREF(py_modpath);
205         }
206         else {
207                 printf("bpy: couldnt find 'scripts/modules', blender probably wont start.\n");
208         }
209         /* stand alone utility modules not related to blender directly */
210         IDProp_Init_Types(); /* not actually a submodule, just types */
211
212         mod= PyModule_New("_bpy");
213
214         /* add the module so we can import it */
215         PyDict_SetItemString(PyImport_GetModuleDict(), "_bpy", mod);
216         Py_DECREF(mod);
217
218         /* run first, initializes rna types */
219         BPY_rna_init();
220
221         PyModule_AddObject( mod, "types", BPY_rna_types() ); /* needs to be first so bpy_types can run */
222         PyModule_AddObject(mod, "StructMetaPropGroup", (PyObject *)&pyrna_struct_meta_idprop_Type); /* metaclass for idprop types, bpy_types.py needs access */
223
224         bpy_lib_init(mod); /* adds '_bpy._library_load', must be called before 'bpy_types' which uses it */
225
226         bpy_import_test("bpy_types");
227         PyModule_AddObject( mod, "data", BPY_rna_module() ); /* imports bpy_types by running this */
228         bpy_import_test("bpy_types");
229         PyModule_AddObject( mod, "props", BPY_rna_props() );
230         PyModule_AddObject( mod, "ops", BPY_operator_module() ); /* ops is now a python module that does the conversion from SOME_OT_foo -> some.foo */
231         PyModule_AddObject( mod, "app", BPY_app_struct() );
232
233         /* bpy context */
234         RNA_pointer_create(NULL, &RNA_Context, (void *)BPy_GetContext(), &ctx_ptr);
235         bpy_context_module= (BPy_StructRNA *)pyrna_struct_CreatePyObject(&ctx_ptr);
236         /* odd that this is needed, 1 ref on creation and another for the module
237          * but without we get a crash on exit */
238         Py_INCREF(bpy_context_module);
239
240         PyModule_AddObject(mod, "context", (PyObject *)bpy_context_module);
241
242         /* utility func's that have nowhere else to go */
243         PyModule_AddObject(mod, meth_bpy_script_paths.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_script_paths, NULL));
244         PyModule_AddObject(mod, meth_bpy_blend_paths.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_blend_paths, NULL));
245         PyModule_AddObject(mod, meth_bpy_user_resource.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_user_resource, NULL));
246
247         /* register funcs (bpy_rna.c) */
248         PyModule_AddObject(mod, meth_bpy_register_class.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_register_class, NULL));
249         PyModule_AddObject(mod, meth_bpy_unregister_class.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_unregister_class, NULL));
250
251         /* add our own modules dir, this is a python package */
252         bpy_package_py= bpy_import_test("bpy");
253 }