svn merge ^/trunk/blender -r41150:41175
[blender.git] / release / scripts / modules / addon_utils.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8-80 compliant>
20
21 __all__ = (
22     "paths",
23     "modules",
24     "check",
25     "enable",
26     "disable",
27     "reset_all",
28     "module_bl_info",
29     )
30
31 import bpy as _bpy
32
33
34 error_duplicates = False
35 error_encoding = False
36 addons_fake_modules = {}
37
38
39 def paths():
40     # RELEASE SCRIPTS: official scripts distributed in Blender releases
41     paths = _bpy.utils.script_paths("addons")
42
43     # CONTRIB SCRIPTS: good for testing but not official scripts yet
44     # if folder addons_contrib/ exists, scripts in there will be loaded too
45     paths += _bpy.utils.script_paths("addons_contrib")
46
47     # EXTERN SCRIPTS: external projects scripts
48     # if folder addons_extern/ exists, scripts in there will be loaded too
49     paths += _bpy.utils.script_paths("addons_extern")
50
51     return paths
52
53
54 def modules(module_cache):
55     global error_duplicates
56     global error_encoding
57     import os
58
59     error_duplicates = False
60     error_encoding = False
61
62     path_list = paths()
63
64     # fake module importing
65     def fake_module(mod_name, mod_path, speedy=True):
66         global error_encoding
67
68         if _bpy.app.debug:
69             print("fake_module", mod_path, mod_name)
70         import ast
71         ModuleType = type(ast)
72         file_mod = open(mod_path, "r", encoding='UTF-8')
73         if speedy:
74             lines = []
75             line_iter = iter(file_mod)
76             l = ""
77             while not l.startswith("bl_info"):
78                 try:
79                     l = line_iter.readline()
80                 except UnicodeDecodeError as e:
81                     if not error_encoding:
82                         error_encoding = True
83                         print("Error reading file as UTF-8:", mod_path, e)
84                     file_mod.close()
85                     return None
86
87                 if len(l) == 0:
88                     break
89             while l.rstrip():
90                 lines.append(l)
91                 try:
92                     l = line_iter.readline()
93                 except UnicodeDecodeError as e:
94                     if not error_encoding:
95                         error_encoding = True
96                         print("Error reading file as UTF-8:", mod_path, e)
97                     file_mod.close()
98                     return None
99
100             data = "".join(lines)
101
102         else:
103             data = file_mod.read()
104
105         file_mod.close()
106
107         try:
108             ast_data = ast.parse(data, filename=mod_path)
109         except:
110             print("Syntax error 'ast.parse' can't read %r" % mod_path)
111             import traceback
112             traceback.print_exc()
113             ast_data = None
114
115         body_info = None
116
117         if ast_data:
118             for body in ast_data.body:
119                 if body.__class__ == ast.Assign:
120                     if len(body.targets) == 1:
121                         if getattr(body.targets[0], "id", "") == "bl_info":
122                             body_info = body
123                             break
124
125         if body_info:
126             try:
127                 mod = ModuleType(mod_name)
128                 mod.bl_info = ast.literal_eval(body.value)
129                 mod.__file__ = mod_path
130                 mod.__time__ = os.path.getmtime(mod_path)
131             except:
132                 print("AST error in module %s" % mod_name)
133                 import traceback
134                 traceback.print_exc()
135                 raise
136
137             return mod
138         else:
139             return None
140
141     modules_stale = set(module_cache.keys())
142
143     for path in path_list:
144         for mod_name, mod_path in _bpy.path.module_names(path):
145             modules_stale -= {mod_name}
146             mod = module_cache.get(mod_name)
147             if mod:
148                 if mod.__file__ != mod_path:
149                     print("multiple addons with the same name:\n  %r\n  %r" %
150                           (mod.__file__, mod_path))
151                     error_duplicates = True
152
153                 elif mod.__time__ != os.path.getmtime(mod_path):
154                     print("reloading addon:",
155                           mod_name,
156                           mod.__time__,
157                           os.path.getmtime(mod_path),
158                           mod_path,
159                           )
160                     del module_cache[mod_name]
161                     mod = None
162
163             if mod is None:
164                 mod = fake_module(mod_name, mod_path)
165                 if mod:
166                     module_cache[mod_name] = mod
167
168     # just in case we get stale modules, not likely
169     for mod_stale in modules_stale:
170         del module_cache[mod_stale]
171     del modules_stale
172
173     mod_list = list(module_cache.values())
174     mod_list.sort(key=lambda mod: (mod.bl_info['category'],
175                                    mod.bl_info['name'],
176                                    ))
177     return mod_list
178
179
180 def check(module_name):
181     """
182     Returns the loaded state of the addon.
183
184     :arg module_name: The name of the addon and module.
185     :type module_name: string
186     :return: (loaded_default, loaded_state)
187     :rtype: tuple of booleans
188     """
189     import sys
190     loaded_default = module_name in _bpy.context.user_preferences.addons
191
192     mod = sys.modules.get(module_name)
193     loaded_state = mod and getattr(mod, "__addon_enabled__", Ellipsis)
194
195     if loaded_state is Ellipsis:
196         print("Warning: addon-module %r found module "
197                "but without __addon_enabled__ field, "
198                "possible name collision from file: %r" %
199                (module_name, getattr(mod, "__file__", "<unknown>")))
200
201         loaded_state = False
202
203     return loaded_default, loaded_state
204
205
206 def enable(module_name, default_set=True):
207     """
208     Enables an addon by name.
209
210     :arg module_name: The name of the addon and module.
211     :type module_name: string
212     :return: the loaded module or None on failure.
213     :rtype: module
214     """
215
216     import os
217     import sys
218     import imp
219
220     def handle_error():
221         import traceback
222         traceback.print_exc()
223
224     # reload if the mtime changes
225     mod = sys.modules.get(module_name)
226     if mod:
227         mod.__addon_enabled__ = False
228         mtime_orig = getattr(mod, "__time__", 0)
229         mtime_new = os.path.getmtime(mod.__file__)
230         if mtime_orig != mtime_new:
231             print("module changed on disk:", mod.__file__, "reloading...")
232
233             try:
234                 imp.reload(mod)
235             except:
236                 handle_error()
237                 del sys.modules[module_name]
238                 return None
239             mod.__addon_enabled__ = False
240
241     # Split registering up into 3 steps so we can undo
242     # if it fails par way through.
243     # 1) try import
244     try:
245         mod = __import__(module_name)
246         mod.__time__ = os.path.getmtime(mod.__file__)
247         mod.__addon_enabled__ = False
248     except:
249         handle_error()
250         return None
251
252     # 2) try register collected modules
253     # removed, addons need to handle own registration now.
254
255     # 3) try run the modules register function
256     try:
257         mod.register()
258     except:
259         handle_error()
260         del sys.modules[module_name]
261         return None
262
263     # * OK loaded successfully! *
264     if default_set:
265         # just in case its enabled already
266         ext = _bpy.context.user_preferences.addons.get(module_name)
267         if not ext:
268             ext = _bpy.context.user_preferences.addons.new()
269             ext.module = module_name
270
271     mod.__addon_enabled__ = True
272
273     if _bpy.app.debug:
274         print("\taddon_utils.enable", mod.__name__)
275
276     return mod
277
278
279 def disable(module_name, default_set=True):
280     """
281     Disables an addon by name.
282
283     :arg module_name: The name of the addon and module.
284     :type module_name: string
285     """
286     import sys
287     mod = sys.modules.get(module_name)
288
289     # possible this addon is from a previous session and didn't load a
290     # module this time. So even if the module is not found, still disable
291     # the addon in the user prefs.
292     if mod:
293         mod.__addon_enabled__ = False
294
295         try:
296             mod.unregister()
297         except:
298             import traceback
299             traceback.print_exc()
300     else:
301         print("addon_utils.disable", module_name, "not loaded")
302
303     # could be in more then once, unlikely but better do this just in case.
304     addons = _bpy.context.user_preferences.addons
305
306     if default_set:
307         while module_name in addons:
308             addon = addons.get(module_name)
309             if addon:
310                 addons.remove(addon)
311
312     if _bpy.app.debug:
313         print("\taddon_utils.disable", module_name)
314
315
316 def reset_all(reload_scripts=False):
317     """
318     Sets the addon state based on the user preferences.
319     """
320     import sys
321     import imp
322
323     # RELEASE SCRIPTS: official scripts distributed in Blender releases
324     paths_list = paths()
325
326     for path in paths_list:
327         _bpy.utils._sys_path_ensure(path)
328         for mod_name, mod_path in _bpy.path.module_names(path):
329             is_enabled, is_loaded = check(mod_name)
330
331             # first check if reload is needed before changing state.
332             if reload_scripts:
333                 mod = sys.modules.get(mod_name)
334                 if mod:
335                     imp.reload(mod)
336
337             if is_enabled == is_loaded:
338                 pass
339             elif is_enabled:
340                 enable(mod_name)
341             elif is_loaded:
342                 print("\taddon_utils.reset_all unloading", mod_name)
343                 disable(mod_name)
344
345
346 def module_bl_info(mod, info_basis={"name": "",
347                                     "author": "",
348                                     "version": (),
349                                     "blender": (),
350                                     "api": 0,
351                                     "location": "",
352                                     "description": "",
353                                     "wiki_url": "",
354                                     "tracker_url": "",
355                                     "support": 'COMMUNITY',
356                                     "category": "",
357                                     "warning": "",
358                                     "show_expanded": False,
359                                     }
360                    ):
361
362     addon_info = getattr(mod, "bl_info", {})
363
364     # avoid re-initializing
365     if "_init" in addon_info:
366         return addon_info
367
368     if not addon_info:
369         mod.bl_info = addon_info
370
371     for key, value in info_basis.items():
372         addon_info.setdefault(key, value)
373
374     if not addon_info["name"]:
375         addon_info["name"] = mod.__name__
376
377     addon_info["_init"] = None
378     return addon_info