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