Merge branch 'master' into blender2.8
[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     "disable_all",
28     "reset_all",
29     "module_bl_info",
30 )
31
32 import bpy as _bpy
33 _user_preferences = _bpy.context.user_preferences
34
35 error_encoding = False
36 # (name, file, path)
37 error_duplicates = []
38 addons_fake_modules = {}
39
40
41 # called only once at startup, avoids calling 'reset_all', correct but slower.
42 def _initialize():
43     path_list = paths()
44     for path in path_list:
45         _bpy.utils._sys_path_ensure(path)
46     for addon in _user_preferences.addons:
47         enable(addon.module)
48
49
50 def paths():
51     # RELEASE SCRIPTS: official scripts distributed in Blender releases
52     addon_paths = _bpy.utils.script_paths("addons")
53
54     # CONTRIB SCRIPTS: good for testing but not official scripts yet
55     # if folder addons_contrib/ exists, scripts in there will be loaded too
56     addon_paths += _bpy.utils.script_paths("addons_contrib")
57
58     return addon_paths
59
60
61 def modules_refresh(module_cache=addons_fake_modules):
62     global error_encoding
63     import os
64
65     error_encoding = False
66     error_duplicates.clear()
67
68     path_list = paths()
69
70     # fake module importing
71     def fake_module(mod_name, mod_path, speedy=True, force_support=None):
72         global error_encoding
73
74         if _bpy.app.debug_python:
75             print("fake_module", mod_path, mod_name)
76         import ast
77         ModuleType = type(ast)
78         try:
79             file_mod = open(mod_path, "r", encoding='UTF-8')
80         except OSError as e:
81             print("Error opening file %r: %s" % (mod_path, e))
82             return None
83
84         with file_mod:
85             if speedy:
86                 lines = []
87                 line_iter = iter(file_mod)
88                 l = ""
89                 while not l.startswith("bl_info"):
90                     try:
91                         l = line_iter.readline()
92                     except UnicodeDecodeError as e:
93                         if not error_encoding:
94                             error_encoding = True
95                             print("Error reading file as UTF-8:", mod_path, e)
96                         return None
97
98                     if len(l) == 0:
99                         break
100                 while l.rstrip():
101                     lines.append(l)
102                     try:
103                         l = line_iter.readline()
104                     except UnicodeDecodeError as e:
105                         if not error_encoding:
106                             error_encoding = True
107                             print("Error reading file as UTF-8:", mod_path, e)
108                         return None
109
110                 data = "".join(lines)
111
112             else:
113                 data = file_mod.read()
114         del file_mod
115
116         try:
117             ast_data = ast.parse(data, filename=mod_path)
118         except:
119             print("Syntax error 'ast.parse' can't read %r" % mod_path)
120             import traceback
121             traceback.print_exc()
122             ast_data = None
123
124         body_info = None
125
126         if ast_data:
127             for body in ast_data.body:
128                 if body.__class__ == ast.Assign:
129                     if len(body.targets) == 1:
130                         if getattr(body.targets[0], "id", "") == "bl_info":
131                             body_info = body
132                             break
133
134         if body_info:
135             try:
136                 mod = ModuleType(mod_name)
137                 mod.bl_info = ast.literal_eval(body.value)
138                 mod.__file__ = mod_path
139                 mod.__time__ = os.path.getmtime(mod_path)
140             except:
141                 print("AST error parsing bl_info for %s" % mod_name)
142                 import traceback
143                 traceback.print_exc()
144                 raise
145
146             if force_support is not None:
147                 mod.bl_info["support"] = force_support
148
149             return mod
150         else:
151             print("fake_module: addon missing 'bl_info' "
152                   "gives bad performance!: %r" % mod_path)
153             return None
154
155     modules_stale = set(module_cache.keys())
156
157     for path in path_list:
158
159         # force all contrib addons to be 'TESTING'
160         if path.endswith(("addons_contrib", )):
161             force_support = 'TESTING'
162         else:
163             force_support = None
164
165         for mod_name, mod_path in _bpy.path.module_names(path):
166             modules_stale.discard(mod_name)
167             mod = module_cache.get(mod_name)
168             if mod:
169                 if mod.__file__ != mod_path:
170                     print("multiple addons with the same name:\n  %r\n  %r" %
171                           (mod.__file__, mod_path))
172                     error_duplicates.append((mod.bl_info["name"], mod.__file__, mod_path))
173
174                 elif mod.__time__ != os.path.getmtime(mod_path):
175                     print("reloading addon:",
176                           mod_name,
177                           mod.__time__,
178                           os.path.getmtime(mod_path),
179                           mod_path,
180                           )
181                     del module_cache[mod_name]
182                     mod = None
183
184             if mod is None:
185                 mod = fake_module(mod_name,
186                                   mod_path,
187                                   force_support=force_support)
188                 if mod:
189                     module_cache[mod_name] = mod
190
191     # just in case we get stale modules, not likely
192     for mod_stale in modules_stale:
193         del module_cache[mod_stale]
194     del modules_stale
195
196
197 def modules(module_cache=addons_fake_modules, *, refresh=True):
198     if refresh or ((module_cache is addons_fake_modules) and modules._is_first):
199         modules_refresh(module_cache)
200         modules._is_first = False
201
202     mod_list = list(module_cache.values())
203     mod_list.sort(key=lambda mod: (mod.bl_info["category"],
204                                    mod.bl_info["name"],
205                                    ))
206     return mod_list
207 modules._is_first = True
208
209
210 def check(module_name):
211     """
212     Returns the loaded state of the addon.
213
214     :arg module_name: The name of the addon and module.
215     :type module_name: string
216     :return: (loaded_default, loaded_state)
217     :rtype: tuple of booleans
218     """
219     import sys
220     loaded_default = module_name in _user_preferences.addons
221
222     mod = sys.modules.get(module_name)
223     loaded_state = ((mod is not None) and
224                     getattr(mod, "__addon_enabled__", Ellipsis))
225
226     if loaded_state is Ellipsis:
227         print("Warning: addon-module %r found module "
228               "but without __addon_enabled__ field, "
229               "possible name collision from file: %r" %
230               (module_name, getattr(mod, "__file__", "<unknown>")))
231
232         loaded_state = False
233
234     if mod and getattr(mod, "__addon_persistent__", False):
235         loaded_default = True
236
237     return loaded_default, loaded_state
238
239 # utility functions
240
241
242 def _addon_ensure(module_name):
243     addons = _user_preferences.addons
244     addon = addons.get(module_name)
245     if not addon:
246         addon = addons.new()
247         addon.module = module_name
248
249
250 def _addon_remove(module_name):
251     addons = _user_preferences.addons
252
253     while module_name in addons:
254         addon = addons.get(module_name)
255         if addon:
256             addons.remove(addon)
257
258
259 def enable(module_name, *, default_set=False, persistent=False, handle_error=None):
260     """
261     Enables an addon by name.
262
263     :arg module_name: the name of the addon and module.
264     :type module_name: string
265     :arg default_set: Set the user-preference.
266     :type default_set: bool
267     :arg persistent: Ensure the addon is enabled for the entire session (after loading new files).
268     :type persistent: bool
269     :arg handle_error: Called in the case of an error, taking an exception argument.
270     :type handle_error: function
271     :return: the loaded module or None on failure.
272     :rtype: module
273     """
274
275     import os
276     import sys
277     from bpy_restrict_state import RestrictBlend
278
279     if handle_error is None:
280         def handle_error(ex):
281             import traceback
282             traceback.print_exc()
283
284     # reload if the mtime changes
285     mod = sys.modules.get(module_name)
286     # chances of the file _not_ existing are low, but it could be removed
287     if mod and os.path.exists(mod.__file__):
288
289         if getattr(mod, "__addon_enabled__", False):
290             # This is an unlikely situation,
291             # re-register if the module is enabled.
292             # Note: the UI doesn't allow this to happen,
293             # in most cases the caller should 'check()' first.
294             try:
295                 mod.unregister()
296             except Exception as ex:
297                 print("Exception in module unregister(): %r" %
298                       getattr(mod, "__file__", module_name))
299                 handle_error(ex)
300                 return None
301
302         mod.__addon_enabled__ = False
303         mtime_orig = getattr(mod, "__time__", 0)
304         mtime_new = os.path.getmtime(mod.__file__)
305         if mtime_orig != mtime_new:
306             import importlib
307             print("module changed on disk:", mod.__file__, "reloading...")
308
309             try:
310                 importlib.reload(mod)
311             except Exception as ex:
312                 handle_error(ex)
313                 del sys.modules[module_name]
314                 return None
315             mod.__addon_enabled__ = False
316
317     # add the addon first it may want to initialize its own preferences.
318     # must remove on fail through.
319     if default_set:
320         _addon_ensure(module_name)
321
322     # Split registering up into 3 steps so we can undo
323     # if it fails par way through.
324
325     # disable the context, using the context at all is
326     # really bad while loading an addon, don't do it!
327     with RestrictBlend():
328
329         # 1) try import
330         try:
331             mod = __import__(module_name)
332             mod.__time__ = os.path.getmtime(mod.__file__)
333             mod.__addon_enabled__ = False
334         except Exception as ex:
335             # if the addon doesn't exist, dont print full traceback
336             if type(ex) is ImportError and ex.name == module_name:
337                 print("addon not found: %r" % module_name)
338             else:
339                 handle_error(ex)
340
341             if default_set:
342                 _addon_remove(module_name)
343             return None
344
345         # 2) try register collected modules
346         # removed, addons need to handle own registration now.
347
348         # 3) try run the modules register function
349         try:
350             mod.register()
351         except Exception as ex:
352             print("Exception in module register(): %r" %
353                   getattr(mod, "__file__", module_name))
354             handle_error(ex)
355             del sys.modules[module_name]
356             if default_set:
357                 _addon_remove(module_name)
358             return None
359
360     # * OK loaded successfully! *
361     mod.__addon_enabled__ = True
362     mod.__addon_persistent__ = persistent
363
364     if _bpy.app.debug_python:
365         print("\taddon_utils.enable", mod.__name__)
366
367     return mod
368
369
370 def disable(module_name, *, default_set=False, handle_error=None):
371     """
372     Disables an addon by name.
373
374     :arg module_name: The name of the addon and module.
375     :type module_name: string
376     :arg default_set: Set the user-preference.
377     :type default_set: bool
378     :arg handle_error: Called in the case of an error, taking an exception argument.
379     :type handle_error: function
380     """
381     import sys
382
383     if handle_error is None:
384         def handle_error(ex):
385             import traceback
386             traceback.print_exc()
387
388     mod = sys.modules.get(module_name)
389
390     # possible this addon is from a previous session and didn't load a
391     # module this time. So even if the module is not found, still disable
392     # the addon in the user prefs.
393     if mod and getattr(mod, "__addon_enabled__", False) is not False:
394         mod.__addon_enabled__ = False
395         mod.__addon_persistent = False
396
397         try:
398             mod.unregister()
399         except Exception as ex:
400             print("Exception in module unregister(): %r" %
401                   getattr(mod, "__file__", module_name))
402             handle_error(ex)
403     else:
404         print("addon_utils.disable: %s not %s." %
405               (module_name, "disabled" if mod is None else "loaded"))
406
407     # could be in more than once, unlikely but better do this just in case.
408     if default_set:
409         _addon_remove(module_name)
410
411     if _bpy.app.debug_python:
412         print("\taddon_utils.disable", module_name)
413
414
415 def reset_all(*, reload_scripts=False):
416     """
417     Sets the addon state based on the user preferences.
418     """
419     import sys
420
421     # initializes addons_fake_modules
422     modules_refresh()
423
424     # RELEASE SCRIPTS: official scripts distributed in Blender releases
425     paths_list = paths()
426
427     for path in paths_list:
428         _bpy.utils._sys_path_ensure(path)
429         for mod_name, mod_path in _bpy.path.module_names(path):
430             is_enabled, is_loaded = check(mod_name)
431
432             # first check if reload is needed before changing state.
433             if reload_scripts:
434                 import importlib
435                 mod = sys.modules.get(mod_name)
436                 if mod:
437                     importlib.reload(mod)
438
439             if is_enabled == is_loaded:
440                 pass
441             elif is_enabled:
442                 enable(mod_name)
443             elif is_loaded:
444                 print("\taddon_utils.reset_all unloading", mod_name)
445                 disable(mod_name)
446
447
448 def disable_all():
449     import sys
450     for mod_name, mod in sys.modules.items():
451         if getattr(mod, "__addon_enabled__", False):
452             disable(mod_name)
453
454
455 def module_bl_info(mod, info_basis=None):
456     if info_basis is None:
457         info_basis = {
458             "name": "",
459             "author": "",
460             "version": (),
461             "blender": (),
462             "location": "",
463             "description": "",
464             "wiki_url": "",
465             "support": 'COMMUNITY',
466             "category": "",
467             "warning": "",
468             "show_expanded": False,
469         }
470
471     addon_info = getattr(mod, "bl_info", {})
472
473     # avoid re-initializing
474     if "_init" in addon_info:
475         return addon_info
476
477     if not addon_info:
478         mod.bl_info = addon_info
479
480     for key, value in info_basis.items():
481         addon_info.setdefault(key, value)
482
483     if not addon_info["name"]:
484         addon_info["name"] = mod.__name__
485
486     addon_info["_init"] = None
487     return addon_info