Made minor revisions (no functional changes).
[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, force_support=None):
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             if force_support is not None:
138                 mod.bl_info["support"] = force_support
139
140             return mod
141         else:
142             return None
143
144     modules_stale = set(module_cache.keys())
145
146     for path in path_list:
147
148         # force all contrib addons to be 'TESTING'
149         force_support = 'TESTING' if path.endswith("addons_contrib") else None
150
151         for mod_name, mod_path in _bpy.path.module_names(path):
152             modules_stale -= {mod_name}
153             mod = module_cache.get(mod_name)
154             if mod:
155                 if mod.__file__ != mod_path:
156                     print("multiple addons with the same name:\n  %r\n  %r" %
157                           (mod.__file__, mod_path))
158                     error_duplicates = True
159
160                 elif mod.__time__ != os.path.getmtime(mod_path):
161                     print("reloading addon:",
162                           mod_name,
163                           mod.__time__,
164                           os.path.getmtime(mod_path),
165                           mod_path,
166                           )
167                     del module_cache[mod_name]
168                     mod = None
169
170             if mod is None:
171                 mod = fake_module(mod_name, mod_path, force_support=force_support)
172                 if mod:
173                     module_cache[mod_name] = mod
174
175     # just in case we get stale modules, not likely
176     for mod_stale in modules_stale:
177         del module_cache[mod_stale]
178     del modules_stale
179
180     mod_list = list(module_cache.values())
181     mod_list.sort(key=lambda mod: (mod.bl_info['category'],
182                                    mod.bl_info['name'],
183                                    ))
184     return mod_list
185
186
187 def check(module_name):
188     """
189     Returns the loaded state of the addon.
190
191     :arg module_name: The name of the addon and module.
192     :type module_name: string
193     :return: (loaded_default, loaded_state)
194     :rtype: tuple of booleans
195     """
196     import sys
197     loaded_default = module_name in _bpy.context.user_preferences.addons
198
199     mod = sys.modules.get(module_name)
200     loaded_state = mod and getattr(mod, "__addon_enabled__", Ellipsis)
201
202     if loaded_state is Ellipsis:
203         print("Warning: addon-module %r found module "
204                "but without __addon_enabled__ field, "
205                "possible name collision from file: %r" %
206                (module_name, getattr(mod, "__file__", "<unknown>")))
207
208         loaded_state = False
209
210     return loaded_default, loaded_state
211
212
213 def enable(module_name, default_set=True):
214     """
215     Enables an addon by name.
216
217     :arg module_name: The name of the addon and module.
218     :type module_name: string
219     :return: the loaded module or None on failure.
220     :rtype: module
221     """
222
223     import os
224     import sys
225     import imp
226
227     def handle_error():
228         import traceback
229         traceback.print_exc()
230
231     # reload if the mtime changes
232     mod = sys.modules.get(module_name)
233     if mod:
234         mod.__addon_enabled__ = False
235         mtime_orig = getattr(mod, "__time__", 0)
236         mtime_new = os.path.getmtime(mod.__file__)
237         if mtime_orig != mtime_new:
238             print("module changed on disk:", mod.__file__, "reloading...")
239
240             try:
241                 imp.reload(mod)
242             except:
243                 handle_error()
244                 del sys.modules[module_name]
245                 return None
246             mod.__addon_enabled__ = False
247
248     # Split registering up into 3 steps so we can undo
249     # if it fails par way through.
250     # 1) try import
251     try:
252         mod = __import__(module_name)
253         mod.__time__ = os.path.getmtime(mod.__file__)
254         mod.__addon_enabled__ = False
255     except:
256         handle_error()
257         return None
258
259     # 2) try register collected modules
260     # removed, addons need to handle own registration now.
261
262     # 3) try run the modules register function
263     try:
264         mod.register()
265     except:
266         handle_error()
267         del sys.modules[module_name]
268         return None
269
270     # * OK loaded successfully! *
271     if default_set:
272         # just in case its enabled already
273         ext = _bpy.context.user_preferences.addons.get(module_name)
274         if not ext:
275             ext = _bpy.context.user_preferences.addons.new()
276             ext.module = module_name
277
278     mod.__addon_enabled__ = True
279
280     if _bpy.app.debug:
281         print("\taddon_utils.enable", mod.__name__)
282
283     return mod
284
285
286 def disable(module_name, default_set=True):
287     """
288     Disables an addon by name.
289
290     :arg module_name: The name of the addon and module.
291     :type module_name: string
292     """
293     import sys
294     mod = sys.modules.get(module_name)
295
296     # possible this addon is from a previous session and didn't load a
297     # module this time. So even if the module is not found, still disable
298     # the addon in the user prefs.
299     if mod:
300         mod.__addon_enabled__ = False
301
302         try:
303             mod.unregister()
304         except:
305             import traceback
306             traceback.print_exc()
307     else:
308         print("addon_utils.disable", module_name, "not loaded")
309
310     # could be in more then once, unlikely but better do this just in case.
311     addons = _bpy.context.user_preferences.addons
312
313     if default_set:
314         while module_name in addons:
315             addon = addons.get(module_name)
316             if addon:
317                 addons.remove(addon)
318
319     if _bpy.app.debug:
320         print("\taddon_utils.disable", module_name)
321
322
323 def reset_all(reload_scripts=False):
324     """
325     Sets the addon state based on the user preferences.
326     """
327     import sys
328     import imp
329
330     # RELEASE SCRIPTS: official scripts distributed in Blender releases
331     paths_list = paths()
332
333     for path in paths_list:
334         _bpy.utils._sys_path_ensure(path)
335         for mod_name, mod_path in _bpy.path.module_names(path):
336             is_enabled, is_loaded = check(mod_name)
337
338             # first check if reload is needed before changing state.
339             if reload_scripts:
340                 mod = sys.modules.get(mod_name)
341                 if mod:
342                     imp.reload(mod)
343
344             if is_enabled == is_loaded:
345                 pass
346             elif is_enabled:
347                 enable(mod_name)
348             elif is_loaded:
349                 print("\taddon_utils.reset_all unloading", mod_name)
350                 disable(mod_name)
351
352
353 def module_bl_info(mod, info_basis={"name": "",
354                                     "author": "",
355                                     "version": (),
356                                     "blender": (),
357                                     "api": 0,
358                                     "location": "",
359                                     "description": "",
360                                     "wiki_url": "",
361                                     "tracker_url": "",
362                                     "support": 'COMMUNITY',
363                                     "category": "",
364                                     "warning": "",
365                                     "show_expanded": False,
366                                     }
367                    ):
368
369     addon_info = getattr(mod, "bl_info", {})
370
371     # avoid re-initializing
372     if "_init" in addon_info:
373         return addon_info
374
375     if not addon_info:
376         mod.bl_info = addon_info
377
378     for key, value in info_basis.items():
379         addon_info.setdefault(key, value)
380
381     if not addon_info["name"]:
382         addon_info["name"] = mod.__name__
383
384     addon_info["_init"] = None
385     return addon_info