svn merge -r38753:38813 https://svn.blender.org/svnroot/bf-blender/trunk/blender .
[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 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
36
37 def paths():
38     # RELEASE SCRIPTS: official scripts distributed in Blender releases
39     paths = _bpy.utils.script_paths("addons")
40
41     # CONTRIB SCRIPTS: good for testing but not official scripts yet
42     # if folder addons_contrib/ exists, scripts in there will be loaded too
43     paths += _bpy.utils.script_paths("addons_contrib")
44
45     # EXTERN SCRIPTS: external projects scripts
46     # if folder addons_extern/ exists, scripts in there will be loaded too
47     paths += _bpy.utils.script_paths("addons_extern")
48
49     return paths
50
51
52 def modules(module_cache):
53     global error_duplicates
54     import os
55
56     error_duplicates = False
57
58     path_list = paths()
59
60     # fake module importing
61     def fake_module(mod_name, mod_path, speedy=True):
62         if _bpy.app.debug:
63             print("fake_module", mod_path, mod_name)
64         import ast
65         ModuleType = type(ast)
66         file_mod = open(mod_path, "r", encoding='UTF-8')
67         if speedy:
68             lines = []
69             line_iter = iter(file_mod)
70             l = ""
71             while not l.startswith("bl_info"):
72                 l = line_iter.readline()
73                 if len(l) == 0:
74                     break
75             while l.rstrip():
76                 lines.append(l)
77                 l = line_iter.readline()
78             data = "".join(lines)
79
80         else:
81             data = file_mod.read()
82
83         file_mod.close()
84
85         try:
86             ast_data = ast.parse(data, filename=mod_path)
87         except:
88             print("Syntax error 'ast.parse' can't read %r" % mod_path)
89             import traceback
90             traceback.print_exc()
91             ast_data = None
92
93         body_info = None
94
95         if ast_data:
96             for body in ast_data.body:
97                 if body.__class__ == ast.Assign:
98                     if len(body.targets) == 1:
99                         if getattr(body.targets[0], "id", "") == "bl_info":
100                             body_info = body
101                             break
102
103         if body_info:
104             try:
105                 mod = ModuleType(mod_name)
106                 mod.bl_info = ast.literal_eval(body.value)
107                 mod.__file__ = mod_path
108                 mod.__time__ = os.path.getmtime(mod_path)
109             except:
110                 print("AST error in module %s" % mod_name)
111                 import traceback
112                 traceback.print_exc()
113                 raise
114
115             return mod
116         else:
117             return None
118
119     modules_stale = set(module_cache.keys())
120
121     for path in path_list:
122         for mod_name, mod_path in _bpy.path.module_names(path):
123             modules_stale -= {mod_name}
124             mod = module_cache.get(mod_name)
125             if mod:
126                 if mod.__file__ != mod_path:
127                     print("multiple addons with the same name:\n  %r\n  %r" %
128                           (mod.__file__, mod_path))
129                     error_duplicates = True
130
131                 elif mod.__time__ != os.path.getmtime(mod_path):
132                     print("reloading addon:", mod_name, mod.__time__, os.path.getmtime(mod_path), mod_path)
133                     del module_cache[mod_name]
134                     mod = None
135
136             if mod is None:
137                 mod = fake_module(mod_name, mod_path)
138                 if mod:
139                     module_cache[mod_name] = mod
140
141     # just incase we get stale modules, not likely
142     for mod_stale in modules_stale:
143         del module_cache[mod_stale]
144     del modules_stale
145
146     mod_list = list(module_cache.values())
147     mod_list.sort(key=lambda mod: (mod.bl_info['category'], mod.bl_info['name']))
148     return mod_list
149
150
151 def check(module_name):
152     """
153     Returns the loaded state of the addon.
154
155     :arg module_name: The name of the addon and module.
156     :type module_name: string
157     :return: (loaded_default, loaded_state)
158     :rtype: tuple of booleans
159     """
160     import sys
161     loaded_default = module_name in _bpy.context.user_preferences.addons
162
163     mod = sys.modules.get(module_name)
164     loaded_state = mod and getattr(mod, "__addon_enabled__", Ellipsis)
165
166     if loaded_state is Ellipsis:
167         print("Warning: addon-module %r found module but without"
168                " __addon_enabled__ field, possible name collision from file: %r" %
169                (module_name, getattr(mod, "__file__", "<unknown>")))
170
171         loaded_state = False
172
173     return loaded_default, loaded_state
174
175
176 def enable(module_name, default_set=True):
177     """
178     Enables an addon by name.
179
180     :arg module_name: The name of the addon and module.
181     :type module_name: string
182     :return: the loaded module or None on failier.
183     :rtype: module
184     """
185
186     import os
187     import sys
188     import imp
189
190     def handle_error():
191         import traceback
192         traceback.print_exc()
193
194     # reload if the mtime changes
195     mod = sys.modules.get(module_name)
196     if mod:
197         mod.__addon_enabled__ = False
198         mtime_orig = getattr(mod, "__time__", 0)
199         mtime_new = os.path.getmtime(mod.__file__)
200         if mtime_orig != mtime_new:
201             print("module changed on disk:", mod.__file__, "reloading...")
202
203             try:
204                 imp.reload(mod)
205             except:
206                 handle_error()
207                 del sys.modules[module_name]
208                 return None
209             mod.__addon_enabled__ = False
210
211     # Split registering up into 3 steps so we can undo if it fails par way through
212     # 1) try import
213     try:
214         mod = __import__(module_name)
215         mod.__time__ = os.path.getmtime(mod.__file__)
216         mod.__addon_enabled__ = False
217     except:
218         handle_error()
219         return None
220
221     # 2) try register collected modules
222     # removed, addons need to handle own registration now.
223
224     # 3) try run the modules register function
225     try:
226         mod.register()
227     except:
228         handle_error()
229         del sys.modules[module_name]
230         return None
231
232     # * OK loaded successfully! *
233     if default_set:
234         # just incase its enabled alredy
235         ext = _bpy.context.user_preferences.addons.get(module_name)
236         if not ext:
237             ext = _bpy.context.user_preferences.addons.new()
238             ext.module = module_name
239
240     mod.__addon_enabled__ = True
241
242     if _bpy.app.debug:
243         print("\taddon_utils.enable", mod.__name__)
244
245     return mod
246
247
248 def disable(module_name, default_set=True):
249     """
250     Disables an addon by name.
251
252     :arg module_name: The name of the addon and module.
253     :type module_name: string
254     """
255     import sys
256     mod = sys.modules.get(module_name)
257
258     # possible this addon is from a previous session and didnt load a module this time.
259     # so even if the module is not found, still disable the addon in the user prefs.
260     if mod:
261         mod.__addon_enabled__ = False
262
263         try:
264             mod.unregister()
265         except:
266             import traceback
267             traceback.print_exc()
268     else:
269         print("addon_utils.disable", module_name, "not loaded")
270
271     # could be in more then once, unlikely but better do this just incase.
272     addons = _bpy.context.user_preferences.addons
273
274     if default_set:
275         while module_name in addons:
276             addon = addons.get(module_name)
277             if addon:
278                 addons.remove(addon)
279
280     if _bpy.app.debug:
281         print("\taddon_utils.disable", module_name)
282
283
284 def reset_all(reload_scripts=False):
285     """
286     Sets the addon state based on the user preferences.
287     """
288     import sys
289     import imp
290
291     # RELEASE SCRIPTS: official scripts distributed in Blender releases
292     paths_list = paths()
293
294     for path in paths_list:
295         _bpy.utils._sys_path_ensure(path)
296         for mod_name, mod_path in _bpy.path.module_names(path):
297             is_enabled, is_loaded = check(mod_name)
298
299             # first check if reload is needed before changing state.
300             if reload_scripts:
301                 mod = sys.modules.get(mod_name)
302                 if mod:
303                     imp.reload(mod)
304
305             if is_enabled == is_loaded:
306                 pass
307             elif is_enabled:
308                 enable(mod_name)
309             elif is_loaded:
310                 print("\taddon_utils.reset_all unloading", mod_name)
311                 disable(mod_name)
312
313
314 def module_bl_info(mod, info_basis={"name": "", "author": "", "version": (), "blender": (), "api": 0, "location": "", "description": "", "wiki_url": "", "tracker_url": "", "support": 'COMMUNITY', "category": "", "warning": "", "show_expanded": False}):
315     addon_info = getattr(mod, "bl_info", {})
316
317     # avoid re-initializing
318     if "_init" in addon_info:
319         return addon_info
320
321     if not addon_info:
322         mod.bl_info = addon_info
323
324     for key, value in info_basis.items():
325         addon_info.setdefault(key, value)
326
327     if not addon_info["name"]:
328         addon_info["name"] = mod.__name__
329
330     addon_info["_init"] = None
331     return addon_info