bugfix [#24087] Blender can not install add-ons unless running with root priviledges
[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 /* This file defines the '_bpy' module which is used by python's 'bpy' package.
26  * a script writer should never directly access this module */
27  
28
29 #include "bpy_util.h" 
30 #include "bpy_rna.h"
31 #include "bpy_app.h"
32 #include "bpy_props.h"
33 #include "bpy_operator.h"
34
35 #include "BLI_path_util.h"
36 #include "BLI_bpath.h"
37  
38  /* external util modules */
39 #include "../generic/geometry.h"
40 #include "../generic/bgl.h"
41 #include "../generic/blf_api.h"
42 #include "../generic/IDProp.h"
43
44 #include "AUD_PyInit.h"
45
46 static char bpy_script_paths_doc[] =
47 ".. function:: script_paths()\n"
48 "\n"
49 "   Return 2 paths to blender scripts directories.\n"
50 "\n"
51 "   :return: (system, user) strings will be empty when not found.\n"
52 "   :rtype: tuple of strigs\n";
53
54 PyObject *bpy_script_paths(PyObject *self)
55 {
56         PyObject *ret= PyTuple_New(2);
57         char *path;
58     
59         path= BLI_get_folder(BLENDER_USER_SCRIPTS, NULL);
60         PyTuple_SET_ITEM(ret, 0, PyUnicode_FromString(path?path:""));
61         path= BLI_get_folder(BLENDER_SYSTEM_SCRIPTS, NULL);
62         PyTuple_SET_ITEM(ret, 1, PyUnicode_FromString(path?path:""));
63     
64         return ret;
65 }
66
67 static char bpy_blend_paths_doc[] =
68 ".. function:: blend_paths(absolute=False)\n"
69 "\n"
70 "   Returns a list of paths to external files referenced by the loaded .blend file.\n"
71 "\n"
72 "   :arg absolute: When true the paths returned are made absolute.\n"
73 "   :type absolute: boolean\n"
74 "   :return: path list.\n"
75 "   :rtype: list of strigs\n";
76 static PyObject *bpy_blend_paths(PyObject * self, PyObject *args, PyObject *kw)
77 {
78         struct BPathIterator bpi;
79         PyObject *list = PyList_New(0), *st; /* stupidly big string to be safe */
80         /* be sure there is low chance of the path being too short */
81         char filepath_expanded[1024];
82         char *lib;
83
84         int absolute = 0;
85         static char *kwlist[] = {"absolute", NULL};
86
87         if (!PyArg_ParseTupleAndKeywords(args, kw, "|i:blend_paths", kwlist, &absolute))
88                 return NULL;
89
90         for(BLI_bpathIterator_init(&bpi, NULL); !BLI_bpathIterator_isDone(&bpi); BLI_bpathIterator_step(&bpi)) {
91                 /* build the list */
92                 if (absolute) {
93                         BLI_bpathIterator_getPathExpanded(&bpi, filepath_expanded);
94                 }
95                 else {
96                         lib = BLI_bpathIterator_getLib(&bpi);
97                         if (lib && (strcmp(lib, bpi.base_path))) { /* relative path to the library is NOT the same as our blendfile path, return an absolute path */
98                                 BLI_bpathIterator_getPathExpanded(&bpi, filepath_expanded);
99                         }
100                         else {
101                                 BLI_bpathIterator_getPath(&bpi, filepath_expanded);
102                         }
103                 }
104                 st = PyUnicode_FromString(filepath_expanded);
105
106                 PyList_Append(list, st);
107                 Py_DECREF(st);
108         }
109
110         BLI_bpathIterator_free(&bpi);
111
112         return list;
113 }
114
115
116 static char bpy_user_resource_doc[] =
117 ".. function:: user_resource(type, subdir)\n"
118 "\n"
119 "   Returns a list of paths to external files referenced by the loaded .blend file.\n"
120 "\n"
121 "   :arg type: Resource type in ['DATAFILES', 'CONFIG', 'SCRIPTS', 'AUTOSAVE'].\n"
122 "   :type type: string\n"
123 "   :arg subdir: Optional subdirectory.\n"
124 "   :type subdir: string\n"
125 "   :return: a path.\n"
126 "   :rtype: string\n";
127 static PyObject *bpy_user_resource(PyObject * self, PyObject *args, PyObject *kw)
128 {
129         char *type;
130         char *subdir= NULL;
131         int folder_id;
132         static char *kwlist[] = {"type", "subdir", NULL};
133
134         char *path;
135
136         if (!PyArg_ParseTupleAndKeywords(args, kw, "s|s:user_resource", kwlist, &type, &subdir))
137                 return NULL;
138         
139         /* stupid string compare */
140         if     (!strcmp(type, "DATAFILES"))     folder_id= BLENDER_USER_DATAFILES;
141         else if(!strcmp(type, "CONFIG"))        folder_id= BLENDER_USER_CONFIG;
142         else if(!strcmp(type, "SCRIPTS"))       folder_id= BLENDER_USER_SCRIPTS;
143         else if(!strcmp(type, "AUTOSAVE"))      folder_id= BLENDER_USER_AUTOSAVE;
144         else {
145                 PyErr_SetString(PyExc_ValueError, "invalid resource argument");
146                 return NULL;
147         }
148         
149         /* same logic as BLI_get_folder_create(), but best leave it up to the script author to create */
150         path= BLI_get_folder(folder_id, subdir);
151
152         if (!path)
153                 path = BLI_get_user_folder_notest(folder_id, subdir);
154
155         return PyUnicode_FromString(path ? path : "");
156 }
157
158 static PyMethodDef meth_bpy_script_paths = {"script_paths", (PyCFunction)bpy_script_paths, METH_NOARGS, bpy_script_paths_doc};
159 static PyMethodDef meth_bpy_blend_paths = {"blend_paths", (PyCFunction)bpy_blend_paths, METH_VARARGS|METH_KEYWORDS, bpy_blend_paths_doc};
160 static PyMethodDef meth_bpy_user_resource = {"user_resource", (PyCFunction)bpy_user_resource, METH_VARARGS|METH_KEYWORDS, bpy_user_resource_doc};
161
162 static void bpy_import_test(char *modname)
163 {
164         PyObject *mod= PyImport_ImportModuleLevel(modname, NULL, NULL, NULL, 0);
165         if(mod) {
166                 Py_DECREF(mod);
167         }
168         else {
169                 PyErr_Print();
170                 PyErr_Clear();
171         }       
172 }
173
174 /*****************************************************************************
175 * Description: Creates the bpy module and adds it to sys.modules for importing
176 *****************************************************************************/
177 void BPy_init_modules( void )
178 {
179         extern BPy_StructRNA *bpy_context_module;
180         PointerRNA ctx_ptr;
181         PyObject *mod;
182
183         /* Needs to be first since this dir is needed for future modules */
184         char *modpath= BLI_get_folder(BLENDER_SCRIPTS, "modules");
185         if(modpath) {
186                 // printf("bpy: found module path '%s'.\n", modpath);
187                 PyObject *sys_path= PySys_GetObject("path"); /* borrow */
188                 PyObject *py_modpath= PyUnicode_FromString(modpath);
189                 PyList_Insert(sys_path, 0, py_modpath); /* add first */
190                 Py_DECREF(py_modpath);
191         }
192         else {
193                 printf("bpy: couldnt find 'scripts/modules', blender probably wont start.\n");
194         }
195         /* stand alone utility modules not related to blender directly */
196         Geometry_Init();
197         Mathutils_Init();
198         Noise_Init();
199         BGL_Init();
200         BLF_Init();
201         IDProp_Init_Types();
202         AUD_initPython();
203
204         mod = PyModule_New("_bpy");
205
206         /* add the module so we can import it */
207         PyDict_SetItemString(PyImport_GetModuleDict(), "_bpy", mod);
208         Py_DECREF(mod);
209
210         /* run first, initializes rna types */
211         BPY_rna_init();
212
213         PyModule_AddObject( mod, "types", BPY_rna_types() ); /* needs to be first so bpy_types can run */
214         PyModule_AddObject(mod, "StructMetaIDProp", (PyObject *)&pyrna_struct_meta_idprop_Type); /* metaclass for idprop types, bpy_types.py needs access */
215                         
216         bpy_import_test("bpy_types");
217         PyModule_AddObject( mod, "data", BPY_rna_module() ); /* imports bpy_types by running this */
218         bpy_import_test("bpy_types");
219         PyModule_AddObject( mod, "props", BPY_rna_props() );
220         PyModule_AddObject( mod, "ops", BPY_operator_module() ); /* ops is now a python module that does the conversion from SOME_OT_foo -> some.foo */
221         PyModule_AddObject( mod, "app", BPY_app_struct() );
222
223         /* bpy context */
224         RNA_pointer_create(NULL, &RNA_Context, BPy_GetContext(), &ctx_ptr);
225         bpy_context_module= (BPy_StructRNA *)pyrna_struct_CreatePyObject(&ctx_ptr);
226         /* odd that this is needed, 1 ref on creation and another for the module
227          * but without we get a crash on exit */
228         Py_INCREF(bpy_context_module);
229
230         PyModule_AddObject(mod, "context", (PyObject *)bpy_context_module);
231
232         /* utility func's that have nowhere else to go */
233         PyModule_AddObject(mod, meth_bpy_script_paths.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_script_paths, NULL));
234         PyModule_AddObject(mod, meth_bpy_blend_paths.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_blend_paths, NULL));
235         PyModule_AddObject(mod, meth_bpy_user_resource.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_user_resource, NULL));
236
237         /* add our own modules dir, this is a python package */
238         bpy_import_test("bpy");
239 }