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