Merged revision(s) 57908-57978 from trunk/blender into soc-2013-dingto.
[blender.git] / release / scripts / startup / bl_operators / wm.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 import bpy
22 from bpy.types import Menu, Operator
23 from bpy.props import (StringProperty,
24                        BoolProperty,
25                        IntProperty,
26                        FloatProperty,
27                        EnumProperty,
28                        )
29
30 from bpy.app.translations import pgettext_tip as tip_
31
32
33 rna_path_prop = StringProperty(
34         name="Context Attributes",
35         description="RNA context string",
36         maxlen=1024,
37         )
38
39 rna_reverse_prop = BoolProperty(
40         name="Reverse",
41         description="Cycle backwards",
42         default=False,
43         )
44
45 rna_relative_prop = BoolProperty(
46         name="Relative",
47         description="Apply relative to the current value (delta)",
48         default=False,
49         )
50
51
52 def context_path_validate(context, data_path):
53     try:
54         value = eval("context.%s" % data_path) if data_path else Ellipsis
55     except AttributeError as e:
56         if str(e).startswith("'NoneType'"):
57             # One of the items in the rna path is None, just ignore this
58             value = Ellipsis
59         else:
60             # We have a real error in the rna path, don't ignore that
61             raise
62
63     return value
64
65
66 def operator_value_is_undo(value):
67     if value in {None, Ellipsis}:
68         return False
69
70     # typical properties or objects
71     id_data = getattr(value, "id_data", Ellipsis)
72
73     if id_data is None:
74         return False
75     elif id_data is Ellipsis:
76         # handle mathutils types
77         id_data = getattr(getattr(value, "owner", None), "id_data", None)
78
79         if id_data is None:
80             return False
81
82     # return True if its a non window ID type
83     return (isinstance(id_data, bpy.types.ID) and
84             (not isinstance(id_data, (bpy.types.WindowManager,
85                                       bpy.types.Screen,
86                                       bpy.types.Brush,
87                                       ))))
88
89
90 def operator_path_is_undo(context, data_path):
91     # note that if we have data paths that use strings this could fail
92     # luckily we don't do this!
93     #
94     # When we cant find the data owner assume no undo is needed.
95     data_path_head = data_path.rpartition(".")[0]
96
97     if not data_path_head:
98         return False
99
100     value = context_path_validate(context, data_path_head)
101
102     return operator_value_is_undo(value)
103
104
105 def operator_path_undo_return(context, data_path):
106     return {'FINISHED'} if operator_path_is_undo(context, data_path) else {'CANCELLED'}
107
108
109 def operator_value_undo_return(value):
110     return {'FINISHED'} if operator_value_is_undo(value) else {'CANCELLED'}
111
112
113 def execute_context_assign(self, context):
114     data_path = self.data_path
115     if context_path_validate(context, data_path) is Ellipsis:
116         return {'PASS_THROUGH'}
117
118     if getattr(self, "relative", False):
119         exec("context.%s += self.value" % data_path)
120     else:
121         exec("context.%s = self.value" % data_path)
122
123     return operator_path_undo_return(context, data_path)
124
125
126 class BRUSH_OT_active_index_set(Operator):
127     """Set active sculpt/paint brush from it's number"""
128     bl_idname = "brush.active_index_set"
129     bl_label = "Set Brush Number"
130
131     mode = StringProperty(
132             name="Mode",
133             description="Paint mode to set brush for",
134             maxlen=1024,
135             )
136     index = IntProperty(
137             name="Number",
138             description="Brush number",
139             )
140
141     _attr_dict = {"sculpt": "use_paint_sculpt",
142                   "vertex_paint": "use_paint_vertex",
143                   "weight_paint": "use_paint_weight",
144                   "image_paint": "use_paint_image",
145                   }
146
147     def execute(self, context):
148         attr = self._attr_dict.get(self.mode)
149         if attr is None:
150             return {'CANCELLED'}
151
152         toolsettings = context.tool_settings
153         for i, brush in enumerate((cur for cur in bpy.data.brushes if getattr(cur, attr))):
154             if i == self.index:
155                 getattr(toolsettings, self.mode).brush = brush
156                 return {'FINISHED'}
157
158         return {'CANCELLED'}
159
160
161 class WM_OT_context_set_boolean(Operator):
162     """Set a context value"""
163     bl_idname = "wm.context_set_boolean"
164     bl_label = "Context Set Boolean"
165     bl_options = {'UNDO', 'INTERNAL'}
166
167     data_path = rna_path_prop
168     value = BoolProperty(
169             name="Value",
170             description="Assignment value",
171             default=True,
172             )
173
174     execute = execute_context_assign
175
176
177 class WM_OT_context_set_int(Operator):  # same as enum
178     """Set a context value"""
179     bl_idname = "wm.context_set_int"
180     bl_label = "Context Set"
181     bl_options = {'UNDO', 'INTERNAL'}
182
183     data_path = rna_path_prop
184     value = IntProperty(
185             name="Value",
186             description="Assign value",
187             default=0,
188             )
189     relative = rna_relative_prop
190
191     execute = execute_context_assign
192
193
194 class WM_OT_context_scale_int(Operator):
195     """Scale an int context value"""
196     bl_idname = "wm.context_scale_int"
197     bl_label = "Context Set"
198     bl_options = {'UNDO', 'INTERNAL'}
199
200     data_path = rna_path_prop
201     value = FloatProperty(
202             name="Value",
203             description="Assign value",
204             default=1.0,
205             )
206     always_step = BoolProperty(
207             name="Always Step",
208             description="Always adjust the value by a minimum of 1 when 'value' is not 1.0",
209             default=True,
210             )
211
212     def execute(self, context):
213         data_path = self.data_path
214         if context_path_validate(context, data_path) is Ellipsis:
215             return {'PASS_THROUGH'}
216
217         value = self.value
218
219         if value == 1.0:  # nothing to do
220             return {'CANCELLED'}
221
222         if getattr(self, "always_step", False):
223             if value > 1.0:
224                 add = "1"
225                 func = "max"
226             else:
227                 add = "-1"
228                 func = "min"
229             exec("context.%s = %s(round(context.%s * value), context.%s + %s)" %
230                  (data_path, func, data_path, data_path, add))
231         else:
232             exec("context.%s *= value" % data_path)
233
234         return operator_path_undo_return(context, data_path)
235
236
237 class WM_OT_context_set_float(Operator):  # same as enum
238     """Set a context value"""
239     bl_idname = "wm.context_set_float"
240     bl_label = "Context Set Float"
241     bl_options = {'UNDO', 'INTERNAL'}
242
243     data_path = rna_path_prop
244     value = FloatProperty(
245             name="Value",
246             description="Assignment value",
247             default=0.0,
248             )
249     relative = rna_relative_prop
250
251     execute = execute_context_assign
252
253
254 class WM_OT_context_set_string(Operator):  # same as enum
255     """Set a context value"""
256     bl_idname = "wm.context_set_string"
257     bl_label = "Context Set String"
258     bl_options = {'UNDO', 'INTERNAL'}
259
260     data_path = rna_path_prop
261     value = StringProperty(
262             name="Value",
263             description="Assign value",
264             maxlen=1024,
265             )
266
267     execute = execute_context_assign
268
269
270 class WM_OT_context_set_enum(Operator):
271     """Set a context value"""
272     bl_idname = "wm.context_set_enum"
273     bl_label = "Context Set Enum"
274     bl_options = {'UNDO', 'INTERNAL'}
275
276     data_path = rna_path_prop
277     value = StringProperty(
278             name="Value",
279             description="Assignment value (as a string)",
280             maxlen=1024,
281             )
282
283     execute = execute_context_assign
284
285
286 class WM_OT_context_set_value(Operator):
287     """Set a context value"""
288     bl_idname = "wm.context_set_value"
289     bl_label = "Context Set Value"
290     bl_options = {'UNDO', 'INTERNAL'}
291
292     data_path = rna_path_prop
293     value = StringProperty(
294             name="Value",
295             description="Assignment value (as a string)",
296             maxlen=1024,
297             )
298
299     def execute(self, context):
300         data_path = self.data_path
301         if context_path_validate(context, data_path) is Ellipsis:
302             return {'PASS_THROUGH'}
303         exec("context.%s = %s" % (data_path, self.value))
304         return operator_path_undo_return(context, data_path)
305
306
307 class WM_OT_context_toggle(Operator):
308     """Toggle a context value"""
309     bl_idname = "wm.context_toggle"
310     bl_label = "Context Toggle"
311     bl_options = {'UNDO', 'INTERNAL'}
312
313     data_path = rna_path_prop
314
315     def execute(self, context):
316         data_path = self.data_path
317
318         if context_path_validate(context, data_path) is Ellipsis:
319             return {'PASS_THROUGH'}
320
321         exec("context.%s = not (context.%s)" % (data_path, data_path))
322
323         return operator_path_undo_return(context, data_path)
324
325
326 class WM_OT_context_toggle_enum(Operator):
327     """Toggle a context value"""
328     bl_idname = "wm.context_toggle_enum"
329     bl_label = "Context Toggle Values"
330     bl_options = {'UNDO', 'INTERNAL'}
331
332     data_path = rna_path_prop
333     value_1 = StringProperty(
334             name="Value",
335             description="Toggle enum",
336             maxlen=1024,
337             )
338     value_2 = StringProperty(
339             name="Value",
340             description="Toggle enum",
341             maxlen=1024,
342             )
343
344     def execute(self, context):
345         data_path = self.data_path
346
347         if context_path_validate(context, data_path) is Ellipsis:
348             return {'PASS_THROUGH'}
349
350         exec("context.%s = ('%s', '%s')[context.%s != '%s']" %
351              (data_path, self.value_1,
352               self.value_2, data_path,
353               self.value_2,
354               ))
355
356         return operator_path_undo_return(context, data_path)
357
358
359 class WM_OT_context_cycle_int(Operator):
360     """Set a context value (useful for cycling active material, """ \
361     """vertex keys, groups, etc.)"""
362     bl_idname = "wm.context_cycle_int"
363     bl_label = "Context Int Cycle"
364     bl_options = {'UNDO', 'INTERNAL'}
365
366     data_path = rna_path_prop
367     reverse = rna_reverse_prop
368
369     def execute(self, context):
370         data_path = self.data_path
371         value = context_path_validate(context, data_path)
372         if value is Ellipsis:
373             return {'PASS_THROUGH'}
374
375         if self.reverse:
376             value -= 1
377         else:
378             value += 1
379
380         exec("context.%s = value" % data_path)
381
382         if value != eval("context.%s" % data_path):
383             # relies on rna clamping integers out of the range
384             if self.reverse:
385                 value = (1 << 31) - 1
386             else:
387                 value = -1 << 31
388
389             exec("context.%s = value" % data_path)
390
391         return operator_path_undo_return(context, data_path)
392
393
394 class WM_OT_context_cycle_enum(Operator):
395     """Toggle a context value"""
396     bl_idname = "wm.context_cycle_enum"
397     bl_label = "Context Enum Cycle"
398     bl_options = {'UNDO', 'INTERNAL'}
399
400     data_path = rna_path_prop
401     reverse = rna_reverse_prop
402
403     def execute(self, context):
404         data_path = self.data_path
405         value = context_path_validate(context, data_path)
406         if value is Ellipsis:
407             return {'PASS_THROUGH'}
408
409         orig_value = value
410
411         # Have to get rna enum values
412         rna_struct_str, rna_prop_str = data_path.rsplit('.', 1)
413         i = rna_prop_str.find('[')
414
415         # just in case we get "context.foo.bar[0]"
416         if i != -1:
417             rna_prop_str = rna_prop_str[0:i]
418
419         rna_struct = eval("context.%s.rna_type" % rna_struct_str)
420
421         rna_prop = rna_struct.properties[rna_prop_str]
422
423         if type(rna_prop) != bpy.types.EnumProperty:
424             raise Exception("expected an enum property")
425
426         enums = rna_struct.properties[rna_prop_str].enum_items.keys()
427         orig_index = enums.index(orig_value)
428
429         # Have the info we need, advance to the next item
430         if self.reverse:
431             if orig_index == 0:
432                 advance_enum = enums[-1]
433             else:
434                 advance_enum = enums[orig_index - 1]
435         else:
436             if orig_index == len(enums) - 1:
437                 advance_enum = enums[0]
438             else:
439                 advance_enum = enums[orig_index + 1]
440
441         # set the new value
442         exec("context.%s = advance_enum" % data_path)
443         return operator_path_undo_return(context, data_path)
444
445
446 class WM_OT_context_cycle_array(Operator):
447     """Set a context array value """ \
448     """(useful for cycling the active mesh edit mode)"""
449     bl_idname = "wm.context_cycle_array"
450     bl_label = "Context Array Cycle"
451     bl_options = {'UNDO', 'INTERNAL'}
452
453     data_path = rna_path_prop
454     reverse = rna_reverse_prop
455
456     def execute(self, context):
457         data_path = self.data_path
458         value = context_path_validate(context, data_path)
459         if value is Ellipsis:
460             return {'PASS_THROUGH'}
461
462         def cycle(array):
463             if self.reverse:
464                 array.insert(0, array.pop())
465             else:
466                 array.append(array.pop(0))
467             return array
468
469         exec("context.%s = cycle(context.%s[:])" % (data_path, data_path))
470
471         return operator_path_undo_return(context, data_path)
472
473
474 class WM_MT_context_menu_enum(Menu):
475     bl_label = ""
476     data_path = ""  # BAD DESIGN, set from operator below.
477
478     def draw(self, context):
479         data_path = self.data_path
480         value = context_path_validate(context, data_path)
481         if value is Ellipsis:
482             return {'PASS_THROUGH'}
483         base_path, prop_string = data_path.rsplit(".", 1)
484         value_base = context_path_validate(context, base_path)
485         prop = value_base.bl_rna.properties[prop_string]
486
487         layout = self.layout
488         layout.label(prop.name, icon=prop.icon)
489         layout.prop(value_base, prop_string, expand=True)
490
491
492 class WM_OT_context_menu_enum(Operator):
493     bl_idname = "wm.context_menu_enum"
494     bl_label = "Context Enum Menu"
495     bl_options = {'UNDO', 'INTERNAL'}
496     data_path = rna_path_prop
497
498     def execute(self, context):
499         data_path = self.data_path
500         WM_MT_context_menu_enum.data_path = data_path
501         bpy.ops.wm.call_menu(name="WM_MT_context_menu_enum")
502         return {'PASS_THROUGH'}
503
504
505 class WM_OT_context_set_id(Operator):
506     """Toggle a context value"""
507     bl_idname = "wm.context_set_id"
508     bl_label = "Set Library ID"
509     bl_options = {'UNDO', 'INTERNAL'}
510
511     data_path = rna_path_prop
512     value = StringProperty(
513             name="Value",
514             description="Assign value",
515             maxlen=1024,
516             )
517
518     def execute(self, context):
519         value = self.value
520         data_path = self.data_path
521
522         # match the pointer type from the target property to bpy.data.*
523         # so we lookup the correct list.
524         data_path_base, data_path_prop = data_path.rsplit(".", 1)
525         data_prop_rna = eval("context.%s" % data_path_base).rna_type.properties[data_path_prop]
526         data_prop_rna_type = data_prop_rna.fixed_type
527
528         id_iter = None
529
530         for prop in bpy.data.rna_type.properties:
531             if prop.rna_type.identifier == "CollectionProperty":
532                 if prop.fixed_type == data_prop_rna_type:
533                     id_iter = prop.identifier
534                     break
535
536         if id_iter:
537             value_id = getattr(bpy.data, id_iter).get(value)
538             exec("context.%s = value_id" % data_path)
539
540         return operator_path_undo_return(context, data_path)
541
542
543 doc_id = StringProperty(
544         name="Doc ID",
545         maxlen=1024,
546         options={'HIDDEN'},
547         )
548
549 doc_new = StringProperty(
550         name="Edit Description",
551         maxlen=1024,
552         )
553
554 data_path_iter = StringProperty(
555         description="The data path relative to the context, must point to an iterable")
556
557 data_path_item = StringProperty(
558         description="The data path from each iterable to the value (int or float)")
559
560
561 class WM_OT_context_collection_boolean_set(Operator):
562     """Set boolean values for a collection of items"""
563     bl_idname = "wm.context_collection_boolean_set"
564     bl_label = "Context Collection Boolean Set"
565     bl_options = {'UNDO', 'REGISTER', 'INTERNAL'}
566
567     data_path_iter = data_path_iter
568     data_path_item = data_path_item
569
570     type = EnumProperty(
571             name="Type",
572             items=(('TOGGLE', "Toggle", ""),
573                    ('ENABLE', "Enable", ""),
574                    ('DISABLE', "Disable", ""),
575                    ),
576             )
577
578     def execute(self, context):
579         data_path_iter = self.data_path_iter
580         data_path_item = self.data_path_item
581
582         items = list(getattr(context, data_path_iter))
583         items_ok = []
584         is_set = False
585         for item in items:
586             try:
587                 value_orig = eval("item." + data_path_item)
588             except:
589                 continue
590
591             if value_orig is True:
592                 is_set = True
593             elif value_orig is False:
594                 pass
595             else:
596                 self.report({'WARNING'}, "Non boolean value found: %s[ ].%s" %
597                             (data_path_iter, data_path_item))
598                 return {'CANCELLED'}
599
600             items_ok.append(item)
601
602         # avoid undo push when nothing to do
603         if not items_ok:
604             return {'CANCELLED'}
605
606         if self.type == 'ENABLE':
607             is_set = True
608         elif self.type == 'DISABLE':
609             is_set = False
610         else:
611             is_set = not is_set
612
613         exec_str = "item.%s = %s" % (data_path_item, is_set)
614         for item in items_ok:
615             exec(exec_str)
616
617         return operator_value_undo_return(item)
618
619
620 class WM_OT_context_modal_mouse(Operator):
621     """Adjust arbitrary values with mouse input"""
622     bl_idname = "wm.context_modal_mouse"
623     bl_label = "Context Modal Mouse"
624     bl_options = {'GRAB_POINTER', 'BLOCKING', 'UNDO', 'INTERNAL'}
625
626     data_path_iter = data_path_iter
627     data_path_item = data_path_item
628     header_text = StringProperty(
629             name="Header Text",
630             description="Text to display in header during scale",
631             )
632
633     input_scale = FloatProperty(
634             description="Scale the mouse movement by this value before applying the delta",
635             default=0.01,
636             )
637     invert = BoolProperty(
638             description="Invert the mouse input",
639             default=False,
640             )
641     initial_x = IntProperty(options={'HIDDEN'})
642
643     def _values_store(self, context):
644         data_path_iter = self.data_path_iter
645         data_path_item = self.data_path_item
646
647         self._values = values = {}
648
649         for item in getattr(context, data_path_iter):
650             try:
651                 value_orig = eval("item." + data_path_item)
652             except:
653                 continue
654
655             # check this can be set, maybe this is library data.
656             try:
657                 exec("item.%s = %s" % (data_path_item, value_orig))
658             except:
659                 continue
660
661             values[item] = value_orig
662
663     def _values_delta(self, delta):
664         delta *= self.input_scale
665         if self.invert:
666             delta = - delta
667
668         data_path_item = self.data_path_item
669         for item, value_orig in self._values.items():
670             if type(value_orig) == int:
671                 exec("item.%s = int(%d)" % (data_path_item, round(value_orig + delta)))
672             else:
673                 exec("item.%s = %f" % (data_path_item, value_orig + delta))
674
675     def _values_restore(self):
676         data_path_item = self.data_path_item
677         for item, value_orig in self._values.items():
678             exec("item.%s = %s" % (data_path_item, value_orig))
679
680         self._values.clear()
681
682     def _values_clear(self):
683         self._values.clear()
684
685     def modal(self, context, event):
686         event_type = event.type
687
688         if event_type == 'MOUSEMOVE':
689             delta = event.mouse_x - self.initial_x
690             self._values_delta(delta)
691             header_text = self.header_text
692             if header_text:
693                 if len(self._values) == 1:
694                     (item, ) = self._values.keys()
695                     header_text = header_text % eval("item.%s" % self.data_path_item)
696                 else:
697                     header_text = (self.header_text % delta) + " (delta)"
698                 context.area.header_text_set(header_text)
699
700         elif 'LEFTMOUSE' == event_type:
701             item = next(iter(self._values.keys()))
702             self._values_clear()
703             context.area.header_text_set()
704             return operator_value_undo_return(item)
705
706         elif event_type in {'RIGHTMOUSE', 'ESC'}:
707             self._values_restore()
708             context.area.header_text_set()
709             return {'CANCELLED'}
710
711         return {'RUNNING_MODAL'}
712
713     def invoke(self, context, event):
714         self._values_store(context)
715
716         if not self._values:
717             self.report({'WARNING'}, "Nothing to operate on: %s[ ].%s" %
718                         (self.data_path_iter, self.data_path_item))
719
720             return {'CANCELLED'}
721         else:
722             self.initial_x = event.mouse_x
723
724             context.window_manager.modal_handler_add(self)
725             return {'RUNNING_MODAL'}
726
727
728 class WM_OT_url_open(Operator):
729     "Open a website in the web-browser"
730     bl_idname = "wm.url_open"
731     bl_label = ""
732
733     url = StringProperty(
734             name="URL",
735             description="URL to open",
736             )
737
738     def execute(self, context):
739         import webbrowser
740         webbrowser.open(self.url)
741         return {'FINISHED'}
742
743
744 class WM_OT_path_open(Operator):
745     "Open a path in a file browser"
746     bl_idname = "wm.path_open"
747     bl_label = ""
748
749     filepath = StringProperty(
750             subtype='FILE_PATH',
751             options={'SKIP_SAVE'},
752             )
753
754     def execute(self, context):
755         import sys
756         import os
757         import subprocess
758
759         filepath = self.filepath
760
761         if not filepath:
762             self.report({'ERROR'}, "File path was not set")
763             return {'CANCELLED'}
764
765         filepath = bpy.path.abspath(filepath)
766         filepath = os.path.normpath(filepath)
767
768         if not os.path.exists(filepath):
769             self.report({'ERROR'}, "File '%s' not found" % filepath)
770             return {'CANCELLED'}
771
772         if sys.platform[:3] == "win":
773             os.startfile(filepath)
774         elif sys.platform == "darwin":
775             subprocess.Popen(["open", filepath])
776         else:
777             try:
778                 subprocess.Popen(["xdg-open", filepath])
779             except OSError:
780                 # xdg-open *should* be supported by recent Gnome, KDE, Xfce
781                 pass
782
783         return {'FINISHED'}
784
785
786 def _wm_doc_get_id(doc_id, do_url=True, url_prefix=""):
787     id_split = doc_id.split(".")
788     url = rna = None
789
790     if len(id_split) == 1:  # rna, class
791         if do_url:
792             url = "%s/bpy.types.%s.html" % (url_prefix, id_split[0])
793         else:
794             rna = "bpy.types.%s" % id_split[0]
795
796     elif len(id_split) == 2:  # rna, class.prop
797         class_name, class_prop = id_split
798
799         # an operator (common case - just button referencing an op)
800         if hasattr(bpy.types, class_name.upper() + "_OT_" + class_prop):
801             if do_url:
802                 url = ("%s/bpy.ops.%s.html#bpy.ops.%s.%s" % (url_prefix, class_name, class_name, class_prop))
803             else:
804                 rna = "bpy.ops.%s.%s" % (class_name, class_prop)
805         else:
806             rna_class = getattr(bpy.types, class_name)
807
808             # an operator setting (selected from a running operator), rare case
809             # note: Py defined operators are subclass of Operator,
810             #       C defined operators are subclass of OperatorProperties.
811             #       we may need to check on this at some point.
812             if issubclass(rna_class, (bpy.types.Operator, bpy.types.OperatorProperties)):
813                 # note: ignore the prop name since we don't have a way to link into it
814                 class_name, class_prop = class_name.split("_OT_", 1)
815                 class_name = class_name.lower()
816                 if do_url:
817                     url = ("%s/bpy.ops.%s.html#bpy.ops.%s.%s" % (url_prefix, class_name, class_name, class_prop))
818                 else:
819                     rna = "bpy.ops.%s.%s" % (class_name, class_prop)
820             else:
821                 # an RNA setting, common case
822
823                 # detect if this is a inherited member and use that name instead
824                 rna_parent = rna_class.bl_rna
825                 rna_prop = rna_parent.properties[class_prop]
826                 rna_parent = rna_parent.base
827                 while rna_parent and rna_prop == rna_parent.properties.get(class_prop):
828                     class_name = rna_parent.identifier
829                     rna_parent = rna_parent.base
830
831                 if do_url:
832                     url = ("%s/bpy.types.%s.html#bpy.types.%s.%s" % (url_prefix, class_name, class_name, class_prop))
833                 else:
834                     rna = ("bpy.types.%s.%s" % (class_name, class_prop))
835
836     return url if do_url else rna
837
838
839 class WM_OT_doc_view_manual(Operator):
840     """Load online manual"""
841     bl_idname = "wm.doc_view_manual"
842     bl_label = "View Manual"
843
844     doc_id = doc_id
845
846     @staticmethod
847     def _find_reference(rna_id, url_mapping, verbose=True):
848         if verbose:
849             print("online manual check for: '%s'... " % rna_id)
850         from fnmatch import fnmatch
851         for pattern, url_suffix in url_mapping:
852             if fnmatch(rna_id, pattern):
853                 if verbose:
854                     print("            match found: '%s' --> '%s'" % (pattern, url_suffix))
855                 return url_suffix
856         if verbose:
857             print("match not found")
858         return None
859
860     @staticmethod
861     def _lookup_rna_url(rna_id, verbose=True):
862         for prefix, url_manual_mapping in bpy.utils.manual_map():
863             rna_ref = WM_OT_doc_view_manual._find_reference(rna_id, url_manual_mapping, verbose=verbose)
864             if rna_ref is not None:
865                 url = prefix + rna_ref
866                 return url
867
868     def execute(self, context):
869         rna_id = _wm_doc_get_id(self.doc_id, do_url=False)
870         if rna_id is None:
871             return {'PASS_THROUGH'}
872
873         url = self._lookup_rna_url(rna_id)
874
875         if url is None:
876             self.report({'WARNING'}, "No reference available %r, "
877                                      "Update info in 'rna_wiki_reference.py' "
878                                      " or callback to bpy.utils.manual_map()" %
879                                      self.doc_id)
880             return {'CANCELLED'}
881         else:
882             import webbrowser
883             webbrowser.open(url)
884             return {'FINISHED'}
885
886
887 class WM_OT_doc_view(Operator):
888     """Load online reference docs"""
889     bl_idname = "wm.doc_view"
890     bl_label = "View Documentation"
891
892     doc_id = doc_id
893     if bpy.app.version_cycle == "release":
894         _prefix = ("http://www.blender.org/documentation/blender_python_api_%s%s_release" %
895                    ("_".join(str(v) for v in bpy.app.version[:2]), bpy.app.version_char))
896     else:
897         _prefix = ("http://www.blender.org/documentation/blender_python_api_%s" %
898                    "_".join(str(v) for v in bpy.app.version))
899
900     def execute(self, context):
901         url = _wm_doc_get_id(self.doc_id, do_url=True, url_prefix=self._prefix)
902         if url is None:
903             return {'PASS_THROUGH'}
904
905         import webbrowser
906         webbrowser.open(url)
907
908         return {'FINISHED'}
909
910
911 class WM_OT_doc_edit(Operator):
912     """Load online reference docs"""
913     bl_idname = "wm.doc_edit"
914     bl_label = "Edit Documentation"
915
916     doc_id = doc_id
917     doc_new = doc_new
918
919     _url = "http://www.mindrones.com/blender/svn/xmlrpc.php"
920
921     def _send_xmlrpc(self, data_dict):
922         print("sending data:", data_dict)
923
924         import xmlrpc.client
925         user = "blenderuser"
926         pwd = "blender>user"
927
928         docblog = xmlrpc.client.ServerProxy(self._url)
929         docblog.metaWeblog.newPost(1, user, pwd, data_dict, 1)
930
931     def execute(self, context):
932
933         doc_id = self.doc_id
934         doc_new = self.doc_new
935
936         class_name, class_prop = doc_id.split('.')
937
938         if not doc_new:
939             self.report({'ERROR'}, "No input given for '%s'" % doc_id)
940             return {'CANCELLED'}
941
942         # check if this is an operator
943         op_name = class_name.upper() + '_OT_' + class_prop
944         op_class = getattr(bpy.types, op_name, None)
945
946         # Upload this to the web server
947         upload = {}
948
949         if op_class:
950             rna = op_class.bl_rna
951             doc_orig = rna.description
952             if doc_orig == doc_new:
953                 return {'RUNNING_MODAL'}
954
955             print("op - old:'%s' -> new:'%s'" % (doc_orig, doc_new))
956             upload["title"] = 'OPERATOR %s:%s' % (doc_id, doc_orig)
957         else:
958             rna = getattr(bpy.types, class_name).bl_rna
959             doc_orig = rna.properties[class_prop].description
960             if doc_orig == doc_new:
961                 return {'RUNNING_MODAL'}
962
963             print("rna - old:'%s' -> new:'%s'" % (doc_orig, doc_new))
964             upload["title"] = 'RNA %s:%s' % (doc_id, doc_orig)
965
966         upload["description"] = doc_new
967
968         self._send_xmlrpc(upload)
969
970         return {'FINISHED'}
971
972     def draw(self, context):
973         layout = self.layout
974         layout.label(text="Descriptor ID: '%s'" % self.doc_id)
975         layout.prop(self, "doc_new", text="")
976
977     def invoke(self, context, event):
978         wm = context.window_manager
979         return wm.invoke_props_dialog(self, width=600)
980
981
982 rna_path = StringProperty(
983         name="Property Edit",
984         description="Property data_path edit",
985         maxlen=1024,
986         options={'HIDDEN'},
987         )
988
989 rna_value = StringProperty(
990         name="Property Value",
991         description="Property value edit",
992         maxlen=1024,
993         )
994
995 rna_property = StringProperty(
996         name="Property Name",
997         description="Property name edit",
998         maxlen=1024,
999         )
1000
1001 rna_min = FloatProperty(
1002         name="Min",
1003         default=0.0,
1004         precision=3,
1005         )
1006
1007 rna_max = FloatProperty(
1008         name="Max",
1009         default=1.0,
1010         precision=3,
1011         )
1012
1013
1014 class WM_OT_properties_edit(Operator):
1015     bl_idname = "wm.properties_edit"
1016     bl_label = "Edit Property"
1017     # register only because invoke_props_popup requires.
1018     bl_options = {'REGISTER', 'INTERNAL'}
1019
1020     data_path = rna_path
1021     property = rna_property
1022     value = rna_value
1023     min = rna_min
1024     max = rna_max
1025     description = StringProperty(
1026             name="Tooltip",
1027             )
1028
1029     def execute(self, context):
1030         from rna_prop_ui import rna_idprop_ui_prop_get, rna_idprop_ui_prop_clear
1031
1032         data_path = self.data_path
1033         value = self.value
1034         prop = self.property
1035
1036         prop_old = getattr(self, "_last_prop", [None])[0]
1037
1038         if prop_old is None:
1039             self.report({'ERROR'}, "Direct execution not supported")
1040             return {'CANCELLED'}
1041
1042         try:
1043             value_eval = eval(value)
1044             # assert else None -> None, not "None", see [#33431]
1045             assert(type(value_eval) in {str, float, int, bool, tuple, list})
1046         except:
1047             value_eval = value
1048
1049         # First remove
1050         item = eval("context.%s" % data_path)
1051
1052         rna_idprop_ui_prop_clear(item, prop_old)
1053         exec_str = "del item['%s']" % prop_old
1054         # print(exec_str)
1055         exec(exec_str)
1056
1057         # Reassign
1058         exec_str = "item['%s'] = %s" % (prop, repr(value_eval))
1059         # print(exec_str)
1060         exec(exec_str)
1061         self._last_prop[:] = [prop]
1062
1063         prop_type = type(item[prop])
1064
1065         prop_ui = rna_idprop_ui_prop_get(item, prop)
1066
1067         if prop_type in {float, int}:
1068             prop_ui["soft_min"] = prop_ui["min"] = prop_type(self.min)
1069             prop_ui["soft_max"] = prop_ui["max"] = prop_type(self.max)
1070
1071         prop_ui["description"] = self.description
1072
1073         # otherwise existing buttons which reference freed
1074         # memory may crash blender [#26510]
1075         # context.area.tag_redraw()
1076         for win in context.window_manager.windows:
1077             for area in win.screen.areas:
1078                 area.tag_redraw()
1079
1080         return {'FINISHED'}
1081
1082     def invoke(self, context, event):
1083         from rna_prop_ui import rna_idprop_ui_prop_get
1084
1085         data_path = self.data_path
1086
1087         if not data_path:
1088             self.report({'ERROR'}, "Data path not set")
1089             return {'CANCELLED'}
1090
1091         self._last_prop = [self.property]
1092
1093         item = eval("context.%s" % data_path)
1094
1095         # setup defaults
1096         prop_ui = rna_idprop_ui_prop_get(item, self.property, False)  # don't create
1097         if prop_ui:
1098             self.min = prop_ui.get("min", -1000000000)
1099             self.max = prop_ui.get("max", 1000000000)
1100             self.description = prop_ui.get("description", "")
1101
1102         wm = context.window_manager
1103         return wm.invoke_props_dialog(self)
1104
1105
1106 class WM_OT_properties_add(Operator):
1107     bl_idname = "wm.properties_add"
1108     bl_label = "Add Property"
1109     bl_options = {'UNDO', 'INTERNAL'}
1110
1111     data_path = rna_path
1112
1113     def execute(self, context):
1114         from rna_prop_ui import rna_idprop_ui_prop_get
1115
1116         data_path = self.data_path
1117         item = eval("context.%s" % data_path)
1118
1119         def unique_name(names):
1120             prop = "prop"
1121             prop_new = prop
1122             i = 1
1123             while prop_new in names:
1124                 prop_new = prop + str(i)
1125                 i += 1
1126
1127             return prop_new
1128
1129         prop = unique_name(item.keys())
1130
1131         item[prop] = 1.0
1132
1133         # not essential, but without this we get [#31661]
1134         prop_ui = rna_idprop_ui_prop_get(item, prop)
1135         prop_ui["soft_min"] = prop_ui["min"] = 0.0
1136         prop_ui["soft_max"] = prop_ui["max"] = 1.0
1137
1138         return {'FINISHED'}
1139
1140
1141 class WM_OT_properties_context_change(Operator):
1142     "Jump to a different tab inside the properties editor"
1143     bl_idname = "wm.properties_context_change"
1144     bl_label = ""
1145     bl_options = {'INTERNAL'}
1146
1147     context = StringProperty(
1148             name="Context",
1149             maxlen=64,
1150             )
1151
1152     def execute(self, context):
1153         context.space_data.context = self.context
1154         return {'FINISHED'}
1155
1156
1157 class WM_OT_properties_remove(Operator):
1158     """Internal use (edit a property data_path)"""
1159     bl_idname = "wm.properties_remove"
1160     bl_label = "Remove Property"
1161     bl_options = {'UNDO', 'INTERNAL'}
1162
1163     data_path = rna_path
1164     property = rna_property
1165
1166     def execute(self, context):
1167         data_path = self.data_path
1168         item = eval("context.%s" % data_path)
1169         del item[self.property]
1170         return {'FINISHED'}
1171
1172
1173 class WM_OT_keyconfig_activate(Operator):
1174     bl_idname = "wm.keyconfig_activate"
1175     bl_label = "Activate Keyconfig"
1176
1177     filepath = StringProperty(
1178             subtype='FILE_PATH',
1179             )
1180
1181     def execute(self, context):
1182         if bpy.utils.keyconfig_set(self.filepath, report=self.report):
1183             return {'FINISHED'}
1184         else:
1185             return {'CANCELLED'}
1186
1187
1188 class WM_OT_appconfig_default(Operator):
1189     bl_idname = "wm.appconfig_default"
1190     bl_label = "Default Application Configuration"
1191
1192     def execute(self, context):
1193         import os
1194
1195         context.window_manager.keyconfigs.active = context.window_manager.keyconfigs.default
1196
1197         filepath = os.path.join(bpy.utils.preset_paths("interaction")[0], "blender.py")
1198
1199         if os.path.exists(filepath):
1200             bpy.ops.script.execute_preset(filepath=filepath, menu_idname="USERPREF_MT_interaction_presets")
1201
1202         return {'FINISHED'}
1203
1204
1205 class WM_OT_appconfig_activate(Operator):
1206     bl_idname = "wm.appconfig_activate"
1207     bl_label = "Activate Application Configuration"
1208
1209     filepath = StringProperty(
1210             subtype='FILE_PATH',
1211             )
1212
1213     def execute(self, context):
1214         import os
1215         bpy.utils.keyconfig_set(self.filepath)
1216
1217         filepath = self.filepath.replace("keyconfig", "interaction")
1218
1219         if os.path.exists(filepath):
1220             bpy.ops.script.execute_preset(filepath=filepath, menu_idname="USERPREF_MT_interaction_presets")
1221
1222         return {'FINISHED'}
1223
1224
1225 class WM_OT_sysinfo(Operator):
1226     """Generate System Info"""
1227     bl_idname = "wm.sysinfo"
1228     bl_label = "System Info"
1229
1230     def execute(self, context):
1231         import sys_info
1232         sys_info.write_sysinfo(self)
1233         return {'FINISHED'}
1234
1235
1236 class WM_OT_copy_prev_settings(Operator):
1237     """Copy settings from previous version"""
1238     bl_idname = "wm.copy_prev_settings"
1239     bl_label = "Copy Previous Settings"
1240
1241     def execute(self, context):
1242         import os
1243         import shutil
1244         ver = bpy.app.version
1245         ver_old = ((ver[0] * 100) + ver[1]) - 1
1246         path_src = bpy.utils.resource_path('USER', ver_old // 100, ver_old % 100)
1247         path_dst = bpy.utils.resource_path('USER')
1248
1249         if os.path.isdir(path_dst):
1250             self.report({'ERROR'}, "Target path %r exists" % path_dst)
1251         elif not os.path.isdir(path_src):
1252             self.report({'ERROR'}, "Source path %r exists" % path_src)
1253         else:
1254             shutil.copytree(path_src, path_dst, symlinks=True)
1255
1256             # reload recent-files.txt
1257             bpy.ops.wm.read_history()
1258
1259             # don't loose users work if they open the splash later.
1260             if bpy.data.is_saved is bpy.data.is_dirty is False:
1261                 bpy.ops.wm.read_homefile()
1262             else:
1263                 self.report({'INFO'}, "Reload Start-Up file to restore settings")
1264
1265             return {'FINISHED'}
1266
1267         return {'CANCELLED'}
1268
1269
1270 class WM_OT_blenderplayer_start(Operator):
1271     """Launch the blender-player with the current blend-file"""
1272     bl_idname = "wm.blenderplayer_start"
1273     bl_label = "Start Game In Player"
1274
1275     def execute(self, context):
1276         import os
1277         import sys
1278         import subprocess
1279
1280         # these remain the same every execution
1281         blender_bin_path = bpy.app.binary_path
1282         blender_bin_dir = os.path.dirname(blender_bin_path)
1283         ext = os.path.splitext(blender_bin_path)[-1]
1284         player_path = os.path.join(blender_bin_dir, "blenderplayer" + ext)
1285         # done static vars
1286
1287         if sys.platform == "darwin":
1288             player_path = os.path.join(blender_bin_dir, "../../../blenderplayer.app/Contents/MacOS/blenderplayer")
1289
1290         if not os.path.exists(player_path):
1291             self.report({'ERROR'}, "Player path: %r not found" % player_path)
1292             return {'CANCELLED'}
1293
1294         filepath = os.path.join(bpy.app.tempdir, "game.blend")
1295         bpy.ops.wm.save_as_mainfile('EXEC_DEFAULT', filepath=filepath, copy=True)
1296         subprocess.call([player_path, filepath])
1297         return {'FINISHED'}
1298
1299
1300 class WM_OT_keyconfig_test(Operator):
1301     "Test key-config for conflicts"
1302     bl_idname = "wm.keyconfig_test"
1303     bl_label = "Test Key Configuration for Conflicts"
1304
1305     def execute(self, context):
1306         from bpy_extras import keyconfig_utils
1307
1308         wm = context.window_manager
1309         kc = wm.keyconfigs.default
1310
1311         if keyconfig_utils.keyconfig_test(kc):
1312             print("CONFLICT")
1313
1314         return {'FINISHED'}
1315
1316
1317 class WM_OT_keyconfig_import(Operator):
1318     "Import key configuration from a python script"
1319     bl_idname = "wm.keyconfig_import"
1320     bl_label = "Import Key Configuration..."
1321
1322     filepath = StringProperty(
1323             subtype='FILE_PATH',
1324             default="keymap.py",
1325             )
1326     filter_folder = BoolProperty(
1327             name="Filter folders",
1328             default=True,
1329             options={'HIDDEN'},
1330             )
1331     filter_text = BoolProperty(
1332             name="Filter text",
1333             default=True,
1334             options={'HIDDEN'},
1335             )
1336     filter_python = BoolProperty(
1337             name="Filter python",
1338             default=True,
1339             options={'HIDDEN'},
1340             )
1341     keep_original = BoolProperty(
1342             name="Keep original",
1343             description="Keep original file after copying to configuration folder",
1344             default=True,
1345             )
1346
1347     def execute(self, context):
1348         import os
1349         from os.path import basename
1350         import shutil
1351
1352         if not self.filepath:
1353             self.report({'ERROR'}, "Filepath not set")
1354             return {'CANCELLED'}
1355
1356         config_name = basename(self.filepath)
1357
1358         path = bpy.utils.user_resource('SCRIPTS', os.path.join("presets", "keyconfig"), create=True)
1359         path = os.path.join(path, config_name)
1360
1361         try:
1362             if self.keep_original:
1363                 shutil.copy(self.filepath, path)
1364             else:
1365                 shutil.move(self.filepath, path)
1366         except Exception as e:
1367             self.report({'ERROR'}, "Installing keymap failed: %s" % e)
1368             return {'CANCELLED'}
1369
1370         # sneaky way to check we're actually running the code.
1371         if bpy.utils.keyconfig_set(path, report=self.report):
1372             return {'FINISHED'}
1373         else:
1374             return {'CANCELLED'}
1375
1376     def invoke(self, context, event):
1377         wm = context.window_manager
1378         wm.fileselect_add(self)
1379         return {'RUNNING_MODAL'}
1380
1381 # This operator is also used by interaction presets saving - AddPresetBase
1382
1383
1384 class WM_OT_keyconfig_export(Operator):
1385     "Export key configuration to a python script"
1386     bl_idname = "wm.keyconfig_export"
1387     bl_label = "Export Key Configuration..."
1388
1389     filepath = StringProperty(
1390             subtype='FILE_PATH',
1391             default="keymap.py",
1392             )
1393     filter_folder = BoolProperty(
1394             name="Filter folders",
1395             default=True,
1396             options={'HIDDEN'},
1397             )
1398     filter_text = BoolProperty(
1399             name="Filter text",
1400             default=True,
1401             options={'HIDDEN'},
1402             )
1403     filter_python = BoolProperty(
1404             name="Filter python",
1405             default=True,
1406             options={'HIDDEN'},
1407             )
1408
1409     def execute(self, context):
1410         from bpy_extras import keyconfig_utils
1411
1412         if not self.filepath:
1413             raise Exception("Filepath not set")
1414
1415         if not self.filepath.endswith(".py"):
1416             self.filepath += ".py"
1417
1418         wm = context.window_manager
1419
1420         keyconfig_utils.keyconfig_export(wm,
1421                                          wm.keyconfigs.active,
1422                                          self.filepath,
1423                                          )
1424
1425         return {'FINISHED'}
1426
1427     def invoke(self, context, event):
1428         wm = context.window_manager
1429         wm.fileselect_add(self)
1430         return {'RUNNING_MODAL'}
1431
1432
1433 class WM_OT_keymap_restore(Operator):
1434     "Restore key map(s)"
1435     bl_idname = "wm.keymap_restore"
1436     bl_label = "Restore Key Map(s)"
1437
1438     all = BoolProperty(
1439             name="All Keymaps",
1440             description="Restore all keymaps to default",
1441             )
1442
1443     def execute(self, context):
1444         wm = context.window_manager
1445
1446         if self.all:
1447             for km in wm.keyconfigs.user.keymaps:
1448                 km.restore_to_default()
1449         else:
1450             km = context.keymap
1451             km.restore_to_default()
1452
1453         return {'FINISHED'}
1454
1455
1456 class WM_OT_keyitem_restore(Operator):
1457     "Restore key map item"
1458     bl_idname = "wm.keyitem_restore"
1459     bl_label = "Restore Key Map Item"
1460
1461     item_id = IntProperty(
1462             name="Item Identifier",
1463             description="Identifier of the item to remove",
1464             )
1465
1466     @classmethod
1467     def poll(cls, context):
1468         keymap = getattr(context, "keymap", None)
1469         return keymap
1470
1471     def execute(self, context):
1472         km = context.keymap
1473         kmi = km.keymap_items.from_id(self.item_id)
1474
1475         if (not kmi.is_user_defined) and kmi.is_user_modified:
1476             km.restore_item_to_default(kmi)
1477
1478         return {'FINISHED'}
1479
1480
1481 class WM_OT_keyitem_add(Operator):
1482     "Add key map item"
1483     bl_idname = "wm.keyitem_add"
1484     bl_label = "Add Key Map Item"
1485
1486     def execute(self, context):
1487         km = context.keymap
1488
1489         if km.is_modal:
1490             km.keymap_items.new_modal("", 'A', 'PRESS')
1491         else:
1492             km.keymap_items.new("none", 'A', 'PRESS')
1493
1494         # clear filter and expand keymap so we can see the newly added item
1495         if context.space_data.filter_text != "":
1496             context.space_data.filter_text = ""
1497             km.show_expanded_items = True
1498             km.show_expanded_children = True
1499
1500         return {'FINISHED'}
1501
1502
1503 class WM_OT_keyitem_remove(Operator):
1504     "Remove key map item"
1505     bl_idname = "wm.keyitem_remove"
1506     bl_label = "Remove Key Map Item"
1507
1508     item_id = IntProperty(
1509             name="Item Identifier",
1510             description="Identifier of the item to remove",
1511             )
1512
1513     @classmethod
1514     def poll(cls, context):
1515         return hasattr(context, "keymap")
1516
1517     def execute(self, context):
1518         km = context.keymap
1519         kmi = km.keymap_items.from_id(self.item_id)
1520         km.keymap_items.remove(kmi)
1521         return {'FINISHED'}
1522
1523
1524 class WM_OT_keyconfig_remove(Operator):
1525     "Remove key config"
1526     bl_idname = "wm.keyconfig_remove"
1527     bl_label = "Remove Key Config"
1528
1529     @classmethod
1530     def poll(cls, context):
1531         wm = context.window_manager
1532         keyconf = wm.keyconfigs.active
1533         return keyconf and keyconf.is_user_defined
1534
1535     def execute(self, context):
1536         wm = context.window_manager
1537         keyconfig = wm.keyconfigs.active
1538         wm.keyconfigs.remove(keyconfig)
1539         return {'FINISHED'}
1540
1541
1542 class WM_OT_operator_cheat_sheet(Operator):
1543     bl_idname = "wm.operator_cheat_sheet"
1544     bl_label = "Operator Cheat Sheet"
1545
1546     def execute(self, context):
1547         op_strings = []
1548         tot = 0
1549         for op_module_name in dir(bpy.ops):
1550             op_module = getattr(bpy.ops, op_module_name)
1551             for op_submodule_name in dir(op_module):
1552                 op = getattr(op_module, op_submodule_name)
1553                 text = repr(op)
1554                 if text.split("\n")[-1].startswith("bpy.ops."):
1555                     op_strings.append(text)
1556                     tot += 1
1557
1558             op_strings.append('')
1559
1560         textblock = bpy.data.texts.new("OperatorList.txt")
1561         textblock.write('# %d Operators\n\n' % tot)
1562         textblock.write('\n'.join(op_strings))
1563         self.report({'INFO'}, "See OperatorList.txt textblock")
1564         return {'FINISHED'}
1565
1566
1567 # -----------------------------------------------------------------------------
1568 # Addon Operators
1569
1570 class WM_OT_addon_enable(Operator):
1571     "Enable an addon"
1572     bl_idname = "wm.addon_enable"
1573     bl_label = "Enable Addon"
1574
1575     module = StringProperty(
1576             name="Module",
1577             description="Module name of the addon to enable",
1578             )
1579
1580     def execute(self, context):
1581         import addon_utils
1582
1583         err_str = ""
1584
1585         def err_cb():
1586             import traceback
1587             nonlocal err_str
1588             err_str = traceback.format_exc()
1589             print(err_str)
1590
1591         mod = addon_utils.enable(self.module, handle_error=err_cb)
1592
1593         if mod:
1594             info = addon_utils.module_bl_info(mod)
1595
1596             info_ver = info.get("blender", (0, 0, 0))
1597
1598             if info_ver > bpy.app.version:
1599                 self.report({'WARNING'}, ("This script was written Blender "
1600                                           "version %d.%d.%d and might not "
1601                                           "function (correctly), "
1602                                           "though it is enabled") %
1603                                          info_ver)
1604             return {'FINISHED'}
1605         else:
1606
1607             if err_str:
1608                 self.report({'ERROR'}, err_str)
1609
1610             return {'CANCELLED'}
1611
1612
1613 class WM_OT_addon_disable(Operator):
1614     "Disable an addon"
1615     bl_idname = "wm.addon_disable"
1616     bl_label = "Disable Addon"
1617
1618     module = StringProperty(
1619             name="Module",
1620             description="Module name of the addon to disable",
1621             )
1622
1623     def execute(self, context):
1624         import addon_utils
1625
1626         err_str = ""
1627
1628         def err_cb():
1629             import traceback
1630             nonlocal err_str
1631             err_str = traceback.format_exc()
1632             print(err_str)
1633
1634         addon_utils.disable(self.module, handle_error=err_cb)
1635
1636         if err_str:
1637             self.report({'ERROR'}, err_str)
1638
1639         return {'FINISHED'}
1640
1641
1642 class WM_OT_theme_install(Operator):
1643     "Load and apply a Blender XML theme file"
1644     bl_idname = "wm.theme_install"
1645     bl_label = "Install Theme..."
1646
1647     overwrite = BoolProperty(
1648             name="Overwrite",
1649             description="Remove existing theme file if exists",
1650             default=True,
1651             )
1652     filepath = StringProperty(
1653             subtype='FILE_PATH',
1654             )
1655     filter_folder = BoolProperty(
1656             name="Filter folders",
1657             default=True,
1658             options={'HIDDEN'},
1659             )
1660     filter_glob = StringProperty(
1661             default="*.xml",
1662             options={'HIDDEN'},
1663             )
1664
1665     def execute(self, context):
1666         import os
1667         import shutil
1668         import traceback
1669
1670         xmlfile = self.filepath
1671
1672         path_themes = bpy.utils.user_resource('SCRIPTS', "presets/interface_theme", create=True)
1673
1674         if not path_themes:
1675             self.report({'ERROR'}, "Failed to get themes path")
1676             return {'CANCELLED'}
1677
1678         path_dest = os.path.join(path_themes, os.path.basename(xmlfile))
1679
1680         if not self.overwrite:
1681             if os.path.exists(path_dest):
1682                 self.report({'WARNING'}, "File already installed to %r\n" % path_dest)
1683                 return {'CANCELLED'}
1684
1685         try:
1686             shutil.copyfile(xmlfile, path_dest)
1687             bpy.ops.script.execute_preset(filepath=path_dest, menu_idname="USERPREF_MT_interface_theme_presets")
1688
1689         except:
1690             traceback.print_exc()
1691             return {'CANCELLED'}
1692
1693         return {'FINISHED'}
1694
1695     def invoke(self, context, event):
1696         wm = context.window_manager
1697         wm.fileselect_add(self)
1698         return {'RUNNING_MODAL'}
1699
1700
1701 class WM_OT_addon_install(Operator):
1702     "Install an addon"
1703     bl_idname = "wm.addon_install"
1704     bl_label = "Install from File..."
1705
1706     overwrite = BoolProperty(
1707             name="Overwrite",
1708             description="Remove existing addons with the same ID",
1709             default=True,
1710             )
1711     target = EnumProperty(
1712             name="Target Path",
1713             items=(('DEFAULT', "Default", ""),
1714                    ('PREFS', "User Prefs", "")),
1715             )
1716
1717     filepath = StringProperty(
1718             subtype='FILE_PATH',
1719             )
1720     filter_folder = BoolProperty(
1721             name="Filter folders",
1722             default=True,
1723             options={'HIDDEN'},
1724             )
1725     filter_python = BoolProperty(
1726             name="Filter python",
1727             default=True,
1728             options={'HIDDEN'},
1729             )
1730     filter_glob = StringProperty(
1731             default="*.py;*.zip",
1732             options={'HIDDEN'},
1733             )
1734
1735     @staticmethod
1736     def _module_remove(path_addons, module):
1737         import os
1738         module = os.path.splitext(module)[0]
1739         for f in os.listdir(path_addons):
1740             f_base = os.path.splitext(f)[0]
1741             if f_base == module:
1742                 f_full = os.path.join(path_addons, f)
1743
1744                 if os.path.isdir(f_full):
1745                     os.rmdir(f_full)
1746                 else:
1747                     os.remove(f_full)
1748
1749     def execute(self, context):
1750         import addon_utils
1751         import traceback
1752         import zipfile
1753         import shutil
1754         import os
1755
1756         pyfile = self.filepath
1757
1758         if self.target == 'DEFAULT':
1759             # don't use bpy.utils.script_paths("addons") because we may not be able to write to it.
1760             path_addons = bpy.utils.user_resource('SCRIPTS', "addons", create=True)
1761         else:
1762             path_addons = context.user_preferences.filepaths.script_directory
1763             if path_addons:
1764                 path_addons = os.path.join(path_addons, "addons")
1765
1766         if not path_addons:
1767             self.report({'ERROR'}, "Failed to get addons path")
1768             return {'CANCELLED'}
1769
1770         # create dir is if missing.
1771         try:
1772             os.makedirs(path_addons, exist_ok=True)
1773         except:
1774             import traceback
1775             traceback.print_exc()
1776
1777         # Check if we are installing from a target path,
1778         # doing so causes 2+ addons of same name or when the same from/to
1779         # location is used, removal of the file!
1780         addon_path = ""
1781         pyfile_dir = os.path.dirname(pyfile)
1782         for addon_path in addon_utils.paths():
1783             if os.path.samefile(pyfile_dir, addon_path):
1784                 self.report({'ERROR'}, "Source file is in the addon search path: %r" % addon_path)
1785                 return {'CANCELLED'}
1786         del addon_path
1787         del pyfile_dir
1788         # done checking for exceptional case
1789
1790         addons_old = {mod.__name__ for mod in addon_utils.modules(addon_utils.addons_fake_modules)}
1791
1792         #check to see if the file is in compressed format (.zip)
1793         if zipfile.is_zipfile(pyfile):
1794             try:
1795                 file_to_extract = zipfile.ZipFile(pyfile, 'r')
1796             except:
1797                 traceback.print_exc()
1798                 return {'CANCELLED'}
1799
1800             if self.overwrite:
1801                 for f in file_to_extract.namelist():
1802                     WM_OT_addon_install._module_remove(path_addons, f)
1803             else:
1804                 for f in file_to_extract.namelist():
1805                     path_dest = os.path.join(path_addons, os.path.basename(f))
1806                     if os.path.exists(path_dest):
1807                         self.report({'WARNING'}, "File already installed to %r\n" % path_dest)
1808                         return {'CANCELLED'}
1809
1810             try:  # extract the file to "addons"
1811                 file_to_extract.extractall(path_addons)
1812             except:
1813                 traceback.print_exc()
1814                 return {'CANCELLED'}
1815
1816         else:
1817             path_dest = os.path.join(path_addons, os.path.basename(pyfile))
1818
1819             if self.overwrite:
1820                 WM_OT_addon_install._module_remove(path_addons, os.path.basename(pyfile))
1821             elif os.path.exists(path_dest):
1822                 self.report({'WARNING'}, "File already installed to %r\n" % path_dest)
1823                 return {'CANCELLED'}
1824
1825             #if not compressed file just copy into the addon path
1826             try:
1827                 shutil.copyfile(pyfile, path_dest)
1828
1829             except:
1830                 traceback.print_exc()
1831                 return {'CANCELLED'}
1832
1833         addons_new = {mod.__name__ for mod in addon_utils.modules(addon_utils.addons_fake_modules)} - addons_old
1834         addons_new.discard("modules")
1835
1836         # disable any addons we may have enabled previously and removed.
1837         # this is unlikely but do just in case. bug [#23978]
1838         for new_addon in addons_new:
1839             addon_utils.disable(new_addon)
1840
1841         # possible the zip contains multiple addons, we could disallow this
1842         # but for now just use the first
1843         for mod in addon_utils.modules(addon_utils.addons_fake_modules):
1844             if mod.__name__ in addons_new:
1845                 info = addon_utils.module_bl_info(mod)
1846
1847                 # show the newly installed addon.
1848                 context.window_manager.addon_filter = 'All'
1849                 context.window_manager.addon_search = info["name"]
1850                 break
1851
1852         # in case a new module path was created to install this addon.
1853         bpy.utils.refresh_script_paths()
1854
1855         # print message
1856         msg = tip_("Modules Installed from %r into %r (%s)") % (pyfile, path_addons, ", ".join(sorted(addons_new)))
1857         print(msg)
1858         self.report({'INFO'}, msg)
1859
1860         return {'FINISHED'}
1861
1862     def invoke(self, context, event):
1863         wm = context.window_manager
1864         wm.fileselect_add(self)
1865         return {'RUNNING_MODAL'}
1866
1867
1868 class WM_OT_addon_remove(Operator):
1869     "Disable an addon"
1870     bl_idname = "wm.addon_remove"
1871     bl_label = "Remove Addon"
1872
1873     module = StringProperty(
1874             name="Module",
1875             description="Module name of the addon to remove",
1876             )
1877
1878     @staticmethod
1879     def path_from_addon(module):
1880         import os
1881         import addon_utils
1882
1883         for mod in addon_utils.modules(addon_utils.addons_fake_modules):
1884             if mod.__name__ == module:
1885                 filepath = mod.__file__
1886                 if os.path.exists(filepath):
1887                     if os.path.splitext(os.path.basename(filepath))[0] == "__init__":
1888                         return os.path.dirname(filepath), True
1889                     else:
1890                         return filepath, False
1891         return None, False
1892
1893     def execute(self, context):
1894         import addon_utils
1895         import os
1896
1897         path, isdir = WM_OT_addon_remove.path_from_addon(self.module)
1898         if path is None:
1899             self.report({'WARNING'}, "Addon path %r could not be found" % path)
1900             return {'CANCELLED'}
1901
1902         # in case its enabled
1903         addon_utils.disable(self.module)
1904
1905         import shutil
1906         if isdir:
1907             shutil.rmtree(path)
1908         else:
1909             os.remove(path)
1910
1911         context.area.tag_redraw()
1912         return {'FINISHED'}
1913
1914     # lame confirmation check
1915     def draw(self, context):
1916         self.layout.label(text="Remove Addon: %r?" % self.module)
1917         path, isdir = WM_OT_addon_remove.path_from_addon(self.module)
1918         self.layout.label(text="Path: %r" % path)
1919
1920     def invoke(self, context, event):
1921         wm = context.window_manager
1922         return wm.invoke_props_dialog(self, width=600)
1923
1924
1925 class WM_OT_addon_expand(Operator):
1926     "Display more information on this addon"
1927     bl_idname = "wm.addon_expand"
1928     bl_label = ""
1929
1930     module = StringProperty(
1931             name="Module",
1932             description="Module name of the addon to expand",
1933             )
1934
1935     def execute(self, context):
1936         import addon_utils
1937
1938         module_name = self.module
1939
1940         # unlikely to fail, module should have already been imported
1941         try:
1942             # mod = __import__(module_name)
1943             mod = addon_utils.addons_fake_modules.get(module_name)
1944         except:
1945             import traceback
1946             traceback.print_exc()
1947             return {'CANCELLED'}
1948
1949         info = addon_utils.module_bl_info(mod)
1950         info["show_expanded"] = not info["show_expanded"]
1951         return {'FINISHED'}