fix [#36835] Removing an addon has strange behavior
[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_OT_context_menu_enum(Operator):
475     bl_idname = "wm.context_menu_enum"
476     bl_label = "Context Enum Menu"
477     bl_options = {'UNDO', 'INTERNAL'}
478     data_path = rna_path_prop
479
480     def execute(self, context):
481         data_path = self.data_path
482         value = context_path_validate(context, data_path)
483
484         if value is Ellipsis:
485             return {'PASS_THROUGH'}
486
487         base_path, prop_string = data_path.rsplit(".", 1)
488         value_base = context_path_validate(context, base_path)
489         prop = value_base.bl_rna.properties[prop_string]
490
491         def draw_cb(self, context):
492             layout = self.layout
493             layout.prop(value_base, prop_string, expand=True)
494
495         context.window_manager.popup_menu(draw_func=draw_cb, title=prop.name, icon=prop.icon)
496
497         return {'PASS_THROUGH'}
498
499
500 class WM_OT_context_set_id(Operator):
501     """Set a context value to an ID data-block"""
502     bl_idname = "wm.context_set_id"
503     bl_label = "Set Library ID"
504     bl_options = {'UNDO', 'INTERNAL'}
505
506     data_path = rna_path_prop
507     value = StringProperty(
508             name="Value",
509             description="Assign value",
510             maxlen=1024,
511             )
512
513     def execute(self, context):
514         value = self.value
515         data_path = self.data_path
516
517         # match the pointer type from the target property to bpy.data.*
518         # so we lookup the correct list.
519         data_path_base, data_path_prop = data_path.rsplit(".", 1)
520         data_prop_rna = eval("context.%s" % data_path_base).rna_type.properties[data_path_prop]
521         data_prop_rna_type = data_prop_rna.fixed_type
522
523         id_iter = None
524
525         for prop in bpy.data.rna_type.properties:
526             if prop.rna_type.identifier == "CollectionProperty":
527                 if prop.fixed_type == data_prop_rna_type:
528                     id_iter = prop.identifier
529                     break
530
531         if id_iter:
532             value_id = getattr(bpy.data, id_iter).get(value)
533             exec("context.%s = value_id" % data_path)
534
535         return operator_path_undo_return(context, data_path)
536
537
538 doc_id = StringProperty(
539         name="Doc ID",
540         maxlen=1024,
541         options={'HIDDEN'},
542         )
543
544 doc_new = StringProperty(
545         name="Edit Description",
546         maxlen=1024,
547         )
548
549 data_path_iter = StringProperty(
550         description="The data path relative to the context, must point to an iterable")
551
552 data_path_item = StringProperty(
553         description="The data path from each iterable to the value (int or float)")
554
555
556 class WM_OT_context_collection_boolean_set(Operator):
557     """Set boolean values for a collection of items"""
558     bl_idname = "wm.context_collection_boolean_set"
559     bl_label = "Context Collection Boolean Set"
560     bl_options = {'UNDO', 'REGISTER', 'INTERNAL'}
561
562     data_path_iter = data_path_iter
563     data_path_item = data_path_item
564
565     type = EnumProperty(
566             name="Type",
567             items=(('TOGGLE', "Toggle", ""),
568                    ('ENABLE', "Enable", ""),
569                    ('DISABLE', "Disable", ""),
570                    ),
571             )
572
573     def execute(self, context):
574         data_path_iter = self.data_path_iter
575         data_path_item = self.data_path_item
576
577         items = list(getattr(context, data_path_iter))
578         items_ok = []
579         is_set = False
580         for item in items:
581             try:
582                 value_orig = eval("item." + data_path_item)
583             except:
584                 continue
585
586             if value_orig is True:
587                 is_set = True
588             elif value_orig is False:
589                 pass
590             else:
591                 self.report({'WARNING'}, "Non boolean value found: %s[ ].%s" %
592                             (data_path_iter, data_path_item))
593                 return {'CANCELLED'}
594
595             items_ok.append(item)
596
597         # avoid undo push when nothing to do
598         if not items_ok:
599             return {'CANCELLED'}
600
601         if self.type == 'ENABLE':
602             is_set = True
603         elif self.type == 'DISABLE':
604             is_set = False
605         else:
606             is_set = not is_set
607
608         exec_str = "item.%s = %s" % (data_path_item, is_set)
609         for item in items_ok:
610             exec(exec_str)
611
612         return operator_value_undo_return(item)
613
614
615 class WM_OT_context_modal_mouse(Operator):
616     """Adjust arbitrary values with mouse input"""
617     bl_idname = "wm.context_modal_mouse"
618     bl_label = "Context Modal Mouse"
619     bl_options = {'GRAB_POINTER', 'BLOCKING', 'UNDO', 'INTERNAL'}
620
621     data_path_iter = data_path_iter
622     data_path_item = data_path_item
623     header_text = StringProperty(
624             name="Header Text",
625             description="Text to display in header during scale",
626             )
627
628     input_scale = FloatProperty(
629             description="Scale the mouse movement by this value before applying the delta",
630             default=0.01,
631             )
632     invert = BoolProperty(
633             description="Invert the mouse input",
634             default=False,
635             )
636     initial_x = IntProperty(options={'HIDDEN'})
637
638     def _values_store(self, context):
639         data_path_iter = self.data_path_iter
640         data_path_item = self.data_path_item
641
642         self._values = values = {}
643
644         for item in getattr(context, data_path_iter):
645             try:
646                 value_orig = eval("item." + data_path_item)
647             except:
648                 continue
649
650             # check this can be set, maybe this is library data.
651             try:
652                 exec("item.%s = %s" % (data_path_item, value_orig))
653             except:
654                 continue
655
656             values[item] = value_orig
657
658     def _values_delta(self, delta):
659         delta *= self.input_scale
660         if self.invert:
661             delta = - delta
662
663         data_path_item = self.data_path_item
664         for item, value_orig in self._values.items():
665             if type(value_orig) == int:
666                 exec("item.%s = int(%d)" % (data_path_item, round(value_orig + delta)))
667             else:
668                 exec("item.%s = %f" % (data_path_item, value_orig + delta))
669
670     def _values_restore(self):
671         data_path_item = self.data_path_item
672         for item, value_orig in self._values.items():
673             exec("item.%s = %s" % (data_path_item, value_orig))
674
675         self._values.clear()
676
677     def _values_clear(self):
678         self._values.clear()
679
680     def modal(self, context, event):
681         event_type = event.type
682
683         if event_type == 'MOUSEMOVE':
684             delta = event.mouse_x - self.initial_x
685             self._values_delta(delta)
686             header_text = self.header_text
687             if header_text:
688                 if len(self._values) == 1:
689                     (item, ) = self._values.keys()
690                     header_text = header_text % eval("item.%s" % self.data_path_item)
691                 else:
692                     header_text = (self.header_text % delta) + " (delta)"
693                 context.area.header_text_set(header_text)
694
695         elif 'LEFTMOUSE' == event_type:
696             item = next(iter(self._values.keys()))
697             self._values_clear()
698             context.area.header_text_set()
699             return operator_value_undo_return(item)
700
701         elif event_type in {'RIGHTMOUSE', 'ESC'}:
702             self._values_restore()
703             context.area.header_text_set()
704             return {'CANCELLED'}
705
706         return {'RUNNING_MODAL'}
707
708     def invoke(self, context, event):
709         self._values_store(context)
710
711         if not self._values:
712             self.report({'WARNING'}, "Nothing to operate on: %s[ ].%s" %
713                         (self.data_path_iter, self.data_path_item))
714
715             return {'CANCELLED'}
716         else:
717             self.initial_x = event.mouse_x
718
719             context.window_manager.modal_handler_add(self)
720             return {'RUNNING_MODAL'}
721
722
723 class WM_OT_url_open(Operator):
724     "Open a website in the web-browser"
725     bl_idname = "wm.url_open"
726     bl_label = ""
727
728     url = StringProperty(
729             name="URL",
730             description="URL to open",
731             )
732
733     def execute(self, context):
734         import webbrowser
735         webbrowser.open(self.url)
736         return {'FINISHED'}
737
738
739 class WM_OT_path_open(Operator):
740     "Open a path in a file browser"
741     bl_idname = "wm.path_open"
742     bl_label = ""
743
744     filepath = StringProperty(
745             subtype='FILE_PATH',
746             options={'SKIP_SAVE'},
747             )
748
749     def execute(self, context):
750         import sys
751         import os
752         import subprocess
753
754         filepath = self.filepath
755
756         if not filepath:
757             self.report({'ERROR'}, "File path was not set")
758             return {'CANCELLED'}
759
760         filepath = bpy.path.abspath(filepath)
761         filepath = os.path.normpath(filepath)
762
763         if not os.path.exists(filepath):
764             self.report({'ERROR'}, "File '%s' not found" % filepath)
765             return {'CANCELLED'}
766
767         if sys.platform[:3] == "win":
768             os.startfile(filepath)
769         elif sys.platform == "darwin":
770             subprocess.Popen(["open", filepath])
771         else:
772             try:
773                 subprocess.Popen(["xdg-open", filepath])
774             except OSError:
775                 # xdg-open *should* be supported by recent Gnome, KDE, Xfce
776                 pass
777
778         return {'FINISHED'}
779
780
781 def _wm_doc_get_id(doc_id, do_url=True, url_prefix=""):
782     id_split = doc_id.split(".")
783     url = rna = None
784
785     if len(id_split) == 1:  # rna, class
786         if do_url:
787             url = "%s/bpy.types.%s.html" % (url_prefix, id_split[0])
788         else:
789             rna = "bpy.types.%s" % id_split[0]
790
791     elif len(id_split) == 2:  # rna, class.prop
792         class_name, class_prop = id_split
793
794         # an operator (common case - just button referencing an op)
795         if hasattr(bpy.types, class_name.upper() + "_OT_" + class_prop):
796             if do_url:
797                 url = ("%s/bpy.ops.%s.html#bpy.ops.%s.%s" % (url_prefix, class_name, class_name, class_prop))
798             else:
799                 rna = "bpy.ops.%s.%s" % (class_name, class_prop)
800         else:
801             rna_class = getattr(bpy.types, class_name)
802
803             # an operator setting (selected from a running operator), rare case
804             # note: Py defined operators are subclass of Operator,
805             #       C defined operators are subclass of OperatorProperties.
806             #       we may need to check on this at some point.
807             if issubclass(rna_class, (bpy.types.Operator, bpy.types.OperatorProperties)):
808                 # note: ignore the prop name since we don't have a way to link into it
809                 class_name, class_prop = class_name.split("_OT_", 1)
810                 class_name = class_name.lower()
811                 if do_url:
812                     url = ("%s/bpy.ops.%s.html#bpy.ops.%s.%s" % (url_prefix, class_name, class_name, class_prop))
813                 else:
814                     rna = "bpy.ops.%s.%s" % (class_name, class_prop)
815             else:
816                 # an RNA setting, common case
817
818                 # detect if this is a inherited member and use that name instead
819                 rna_parent = rna_class.bl_rna
820                 rna_prop = rna_parent.properties[class_prop]
821                 rna_parent = rna_parent.base
822                 while rna_parent and rna_prop == rna_parent.properties.get(class_prop):
823                     class_name = rna_parent.identifier
824                     rna_parent = rna_parent.base
825
826                 if do_url:
827                     url = ("%s/bpy.types.%s.html#bpy.types.%s.%s" % (url_prefix, class_name, class_name, class_prop))
828                 else:
829                     rna = ("bpy.types.%s.%s" % (class_name, class_prop))
830
831     return url if do_url else rna
832
833
834 class WM_OT_doc_view_manual(Operator):
835     """Load online manual"""
836     bl_idname = "wm.doc_view_manual"
837     bl_label = "View Manual"
838
839     doc_id = doc_id
840
841     @staticmethod
842     def _find_reference(rna_id, url_mapping, verbose=True):
843         if verbose:
844             print("online manual check for: '%s'... " % rna_id)
845         from fnmatch import fnmatch
846         for pattern, url_suffix in url_mapping:
847             if fnmatch(rna_id, pattern):
848                 if verbose:
849                     print("            match found: '%s' --> '%s'" % (pattern, url_suffix))
850                 return url_suffix
851         if verbose:
852             print("match not found")
853         return None
854
855     @staticmethod
856     def _lookup_rna_url(rna_id, verbose=True):
857         for prefix, url_manual_mapping in bpy.utils.manual_map():
858             rna_ref = WM_OT_doc_view_manual._find_reference(rna_id, url_manual_mapping, verbose=verbose)
859             if rna_ref is not None:
860                 url = prefix + rna_ref
861                 return url
862
863     def execute(self, context):
864         rna_id = _wm_doc_get_id(self.doc_id, do_url=False)
865         if rna_id is None:
866             return {'PASS_THROUGH'}
867
868         url = self._lookup_rna_url(rna_id)
869
870         if url is None:
871             self.report({'WARNING'}, "No reference available %r, "
872                                      "Update info in 'rna_wiki_reference.py' "
873                                      " or callback to bpy.utils.manual_map()" %
874                                      self.doc_id)
875             return {'CANCELLED'}
876         else:
877             import webbrowser
878             webbrowser.open(url)
879             return {'FINISHED'}
880
881
882 class WM_OT_doc_view(Operator):
883     """Load online reference docs"""
884     bl_idname = "wm.doc_view"
885     bl_label = "View Documentation"
886
887     doc_id = doc_id
888     if bpy.app.version_cycle == "release":
889         _prefix = ("http://www.blender.org/documentation/blender_python_api_%s%s_release" %
890                    ("_".join(str(v) for v in bpy.app.version[:2]), bpy.app.version_char))
891     else:
892         _prefix = ("http://www.blender.org/documentation/blender_python_api_%s" %
893                    "_".join(str(v) for v in bpy.app.version))
894
895     def execute(self, context):
896         url = _wm_doc_get_id(self.doc_id, do_url=True, url_prefix=self._prefix)
897         if url is None:
898             return {'PASS_THROUGH'}
899
900         import webbrowser
901         webbrowser.open(url)
902
903         return {'FINISHED'}
904
905
906 '''
907 class WM_OT_doc_edit(Operator):
908     """Edit online reference docs"""
909     bl_idname = "wm.doc_edit"
910     bl_label = "Edit Documentation"
911
912     doc_id = doc_id
913     doc_new = doc_new
914
915     _url = "http://www.mindrones.com/blender/svn/xmlrpc.php"
916
917     def _send_xmlrpc(self, data_dict):
918         print("sending data:", data_dict)
919
920         import xmlrpc.client
921         user = "blenderuser"
922         pwd = "blender>user"
923
924         docblog = xmlrpc.client.ServerProxy(self._url)
925         docblog.metaWeblog.newPost(1, user, pwd, data_dict, 1)
926
927     def execute(self, context):
928
929         doc_id = self.doc_id
930         doc_new = self.doc_new
931
932         class_name, class_prop = doc_id.split('.')
933
934         if not doc_new:
935             self.report({'ERROR'}, "No input given for '%s'" % doc_id)
936             return {'CANCELLED'}
937
938         # check if this is an operator
939         op_name = class_name.upper() + '_OT_' + class_prop
940         op_class = getattr(bpy.types, op_name, None)
941
942         # Upload this to the web server
943         upload = {}
944
945         if op_class:
946             rna = op_class.bl_rna
947             doc_orig = rna.description
948             if doc_orig == doc_new:
949                 return {'RUNNING_MODAL'}
950
951             print("op - old:'%s' -> new:'%s'" % (doc_orig, doc_new))
952             upload["title"] = 'OPERATOR %s:%s' % (doc_id, doc_orig)
953         else:
954             rna = getattr(bpy.types, class_name).bl_rna
955             doc_orig = rna.properties[class_prop].description
956             if doc_orig == doc_new:
957                 return {'RUNNING_MODAL'}
958
959             print("rna - old:'%s' -> new:'%s'" % (doc_orig, doc_new))
960             upload["title"] = 'RNA %s:%s' % (doc_id, doc_orig)
961
962         upload["description"] = doc_new
963
964         self._send_xmlrpc(upload)
965
966         return {'FINISHED'}
967
968     def draw(self, context):
969         layout = self.layout
970         layout.label(text="Descriptor ID: '%s'" % self.doc_id)
971         layout.prop(self, "doc_new", text="")
972
973     def invoke(self, context, event):
974         wm = context.window_manager
975         return wm.invoke_props_dialog(self, width=600)
976 '''
977
978
979 rna_path = StringProperty(
980         name="Property Edit",
981         description="Property data_path edit",
982         maxlen=1024,
983         options={'HIDDEN'},
984         )
985
986 rna_value = StringProperty(
987         name="Property Value",
988         description="Property value edit",
989         maxlen=1024,
990         )
991
992 rna_property = StringProperty(
993         name="Property Name",
994         description="Property name edit",
995         maxlen=1024,
996         )
997
998 rna_min = FloatProperty(
999         name="Min",
1000         default=0.0,
1001         precision=3,
1002         )
1003
1004 rna_max = FloatProperty(
1005         name="Max",
1006         default=1.0,
1007         precision=3,
1008         )
1009
1010
1011 class WM_OT_properties_edit(Operator):
1012     bl_idname = "wm.properties_edit"
1013     bl_label = "Edit Property"
1014     # register only because invoke_props_popup requires.
1015     bl_options = {'REGISTER', 'INTERNAL'}
1016
1017     data_path = rna_path
1018     property = rna_property
1019     value = rna_value
1020     min = rna_min
1021     max = rna_max
1022     description = StringProperty(
1023             name="Tooltip",
1024             )
1025
1026     def execute(self, context):
1027         from rna_prop_ui import rna_idprop_ui_prop_get, rna_idprop_ui_prop_clear
1028
1029         data_path = self.data_path
1030         value = self.value
1031         prop = self.property
1032
1033         prop_old = getattr(self, "_last_prop", [None])[0]
1034
1035         if prop_old is None:
1036             self.report({'ERROR'}, "Direct execution not supported")
1037             return {'CANCELLED'}
1038
1039         try:
1040             value_eval = eval(value)
1041             # assert else None -> None, not "None", see [#33431]
1042             assert(type(value_eval) in {str, float, int, bool, tuple, list})
1043         except:
1044             value_eval = value
1045
1046         # First remove
1047         item = eval("context.%s" % data_path)
1048
1049         rna_idprop_ui_prop_clear(item, prop_old)
1050         exec_str = "del item['%s']" % prop_old
1051         # print(exec_str)
1052         exec(exec_str)
1053
1054         # Reassign
1055         exec_str = "item['%s'] = %s" % (prop, repr(value_eval))
1056         # print(exec_str)
1057         exec(exec_str)
1058         self._last_prop[:] = [prop]
1059
1060         prop_type = type(item[prop])
1061
1062         prop_ui = rna_idprop_ui_prop_get(item, prop)
1063
1064         if prop_type in {float, int}:
1065             prop_ui["soft_min"] = prop_ui["min"] = prop_type(self.min)
1066             prop_ui["soft_max"] = prop_ui["max"] = prop_type(self.max)
1067
1068         prop_ui["description"] = self.description
1069
1070         # otherwise existing buttons which reference freed
1071         # memory may crash blender [#26510]
1072         # context.area.tag_redraw()
1073         for win in context.window_manager.windows:
1074             for area in win.screen.areas:
1075                 area.tag_redraw()
1076
1077         return {'FINISHED'}
1078
1079     def invoke(self, context, event):
1080         from rna_prop_ui import rna_idprop_ui_prop_get
1081
1082         data_path = self.data_path
1083
1084         if not data_path:
1085             self.report({'ERROR'}, "Data path not set")
1086             return {'CANCELLED'}
1087
1088         self._last_prop = [self.property]
1089
1090         item = eval("context.%s" % data_path)
1091
1092         # setup defaults
1093         prop_ui = rna_idprop_ui_prop_get(item, self.property, False)  # don't create
1094         if prop_ui:
1095             self.min = prop_ui.get("min", -1000000000)
1096             self.max = prop_ui.get("max", 1000000000)
1097             self.description = prop_ui.get("description", "")
1098
1099         wm = context.window_manager
1100         return wm.invoke_props_dialog(self)
1101
1102
1103 class WM_OT_properties_add(Operator):
1104     bl_idname = "wm.properties_add"
1105     bl_label = "Add Property"
1106     bl_options = {'UNDO', 'INTERNAL'}
1107
1108     data_path = rna_path
1109
1110     def execute(self, context):
1111         from rna_prop_ui import rna_idprop_ui_prop_get
1112
1113         data_path = self.data_path
1114         item = eval("context.%s" % data_path)
1115
1116         def unique_name(names):
1117             prop = "prop"
1118             prop_new = prop
1119             i = 1
1120             while prop_new in names:
1121                 prop_new = prop + str(i)
1122                 i += 1
1123
1124             return prop_new
1125
1126         prop = unique_name(item.keys())
1127
1128         item[prop] = 1.0
1129
1130         # not essential, but without this we get [#31661]
1131         prop_ui = rna_idprop_ui_prop_get(item, prop)
1132         prop_ui["soft_min"] = prop_ui["min"] = 0.0
1133         prop_ui["soft_max"] = prop_ui["max"] = 1.0
1134
1135         return {'FINISHED'}
1136
1137
1138 class WM_OT_properties_context_change(Operator):
1139     "Jump to a different tab inside the properties editor"
1140     bl_idname = "wm.properties_context_change"
1141     bl_label = ""
1142     bl_options = {'INTERNAL'}
1143
1144     context = StringProperty(
1145             name="Context",
1146             maxlen=64,
1147             )
1148
1149     def execute(self, context):
1150         context.space_data.context = self.context
1151         return {'FINISHED'}
1152
1153
1154 class WM_OT_properties_remove(Operator):
1155     """Internal use (edit a property data_path)"""
1156     bl_idname = "wm.properties_remove"
1157     bl_label = "Remove Property"
1158     bl_options = {'UNDO', 'INTERNAL'}
1159
1160     data_path = rna_path
1161     property = rna_property
1162
1163     def execute(self, context):
1164         data_path = self.data_path
1165         item = eval("context.%s" % data_path)
1166         del item[self.property]
1167         return {'FINISHED'}
1168
1169
1170 class WM_OT_keyconfig_activate(Operator):
1171     bl_idname = "wm.keyconfig_activate"
1172     bl_label = "Activate Keyconfig"
1173
1174     filepath = StringProperty(
1175             subtype='FILE_PATH',
1176             )
1177
1178     def execute(self, context):
1179         if bpy.utils.keyconfig_set(self.filepath, report=self.report):
1180             return {'FINISHED'}
1181         else:
1182             return {'CANCELLED'}
1183
1184
1185 class WM_OT_appconfig_default(Operator):
1186     bl_idname = "wm.appconfig_default"
1187     bl_label = "Default Application Configuration"
1188
1189     def execute(self, context):
1190         import os
1191
1192         context.window_manager.keyconfigs.active = context.window_manager.keyconfigs.default
1193
1194         filepath = os.path.join(bpy.utils.preset_paths("interaction")[0], "blender.py")
1195
1196         if os.path.exists(filepath):
1197             bpy.ops.script.execute_preset(filepath=filepath, menu_idname="USERPREF_MT_interaction_presets")
1198
1199         return {'FINISHED'}
1200
1201
1202 class WM_OT_appconfig_activate(Operator):
1203     bl_idname = "wm.appconfig_activate"
1204     bl_label = "Activate Application Configuration"
1205
1206     filepath = StringProperty(
1207             subtype='FILE_PATH',
1208             )
1209
1210     def execute(self, context):
1211         import os
1212         bpy.utils.keyconfig_set(self.filepath)
1213
1214         filepath = self.filepath.replace("keyconfig", "interaction")
1215
1216         if os.path.exists(filepath):
1217             bpy.ops.script.execute_preset(filepath=filepath, menu_idname="USERPREF_MT_interaction_presets")
1218
1219         return {'FINISHED'}
1220
1221
1222 class WM_OT_sysinfo(Operator):
1223     """Generate System Info"""
1224     bl_idname = "wm.sysinfo"
1225     bl_label = "System Info"
1226
1227     def execute(self, context):
1228         import sys_info
1229         sys_info.write_sysinfo(self)
1230         return {'FINISHED'}
1231
1232
1233 class WM_OT_copy_prev_settings(Operator):
1234     """Copy settings from previous version"""
1235     bl_idname = "wm.copy_prev_settings"
1236     bl_label = "Copy Previous Settings"
1237
1238     def execute(self, context):
1239         import os
1240         import shutil
1241         ver = bpy.app.version
1242         ver_old = ((ver[0] * 100) + ver[1]) - 1
1243         path_src = bpy.utils.resource_path('USER', ver_old // 100, ver_old % 100)
1244         path_dst = bpy.utils.resource_path('USER')
1245
1246         if os.path.isdir(path_dst):
1247             self.report({'ERROR'}, "Target path %r exists" % path_dst)
1248         elif not os.path.isdir(path_src):
1249             self.report({'ERROR'}, "Source path %r exists" % path_src)
1250         else:
1251             shutil.copytree(path_src, path_dst, symlinks=True)
1252
1253             # reload recent-files.txt
1254             bpy.ops.wm.read_history()
1255
1256             # don't loose users work if they open the splash later.
1257             if bpy.data.is_saved is bpy.data.is_dirty is False:
1258                 bpy.ops.wm.read_homefile()
1259             else:
1260                 self.report({'INFO'}, "Reload Start-Up file to restore settings")
1261
1262             return {'FINISHED'}
1263
1264         return {'CANCELLED'}
1265
1266
1267 class WM_OT_blenderplayer_start(Operator):
1268     """Launch the blender-player with the current blend-file"""
1269     bl_idname = "wm.blenderplayer_start"
1270     bl_label = "Start Game In Player"
1271
1272     def execute(self, context):
1273         import os
1274         import sys
1275         import subprocess
1276
1277         gs = context.scene.game_settings
1278
1279         # these remain the same every execution
1280         blender_bin_path = bpy.app.binary_path
1281         blender_bin_dir = os.path.dirname(blender_bin_path)
1282         ext = os.path.splitext(blender_bin_path)[-1]
1283         player_path = os.path.join(blender_bin_dir, "blenderplayer" + ext)
1284         # done static vars
1285
1286         if sys.platform == "darwin":
1287             player_path = os.path.join(blender_bin_dir, "../../../blenderplayer.app/Contents/MacOS/blenderplayer")
1288
1289         if not os.path.exists(player_path):
1290             self.report({'ERROR'}, "Player path: %r not found" % player_path)
1291             return {'CANCELLED'}
1292
1293         filepath = bpy.data.filepath + '~' if bpy.data.is_saved else os.path.join(bpy.app.tempdir, "game.blend")
1294         bpy.ops.wm.save_as_mainfile('EXEC_DEFAULT', filepath=filepath, copy=True)
1295
1296         # start the command line call with the player path
1297         args = [player_path]
1298
1299         # handle some UI options as command line arguments
1300         args.extend([
1301             "-g", "show_framerate=%d" % gs.show_framerate_profile,
1302             "-g", "show_profile=%d" % gs.show_framerate_profile,
1303             "-g", "show_properties=%d" % gs.show_debug_properties,
1304             "-g", "ignore_deprecation_warnings=%d" % (not gs.use_deprecation_warnings),
1305             ])
1306
1307         # finish the call with the path to the blend file
1308         args.append(filepath)
1309
1310         subprocess.call(args)
1311         os.remove(filepath)
1312         return {'FINISHED'}
1313
1314
1315 class WM_OT_keyconfig_test(Operator):
1316     "Test key-config for conflicts"
1317     bl_idname = "wm.keyconfig_test"
1318     bl_label = "Test Key Configuration for Conflicts"
1319
1320     def execute(self, context):
1321         from bpy_extras import keyconfig_utils
1322
1323         wm = context.window_manager
1324         kc = wm.keyconfigs.default
1325
1326         if keyconfig_utils.keyconfig_test(kc):
1327             print("CONFLICT")
1328
1329         return {'FINISHED'}
1330
1331
1332 class WM_OT_keyconfig_import(Operator):
1333     "Import key configuration from a python script"
1334     bl_idname = "wm.keyconfig_import"
1335     bl_label = "Import Key Configuration..."
1336
1337     filepath = StringProperty(
1338             subtype='FILE_PATH',
1339             default="keymap.py",
1340             )
1341     filter_folder = BoolProperty(
1342             name="Filter folders",
1343             default=True,
1344             options={'HIDDEN'},
1345             )
1346     filter_text = BoolProperty(
1347             name="Filter text",
1348             default=True,
1349             options={'HIDDEN'},
1350             )
1351     filter_python = BoolProperty(
1352             name="Filter python",
1353             default=True,
1354             options={'HIDDEN'},
1355             )
1356     keep_original = BoolProperty(
1357             name="Keep original",
1358             description="Keep original file after copying to configuration folder",
1359             default=True,
1360             )
1361
1362     def execute(self, context):
1363         import os
1364         from os.path import basename
1365         import shutil
1366
1367         if not self.filepath:
1368             self.report({'ERROR'}, "Filepath not set")
1369             return {'CANCELLED'}
1370
1371         config_name = basename(self.filepath)
1372
1373         path = bpy.utils.user_resource('SCRIPTS', os.path.join("presets", "keyconfig"), create=True)
1374         path = os.path.join(path, config_name)
1375
1376         try:
1377             if self.keep_original:
1378                 shutil.copy(self.filepath, path)
1379             else:
1380                 shutil.move(self.filepath, path)
1381         except Exception as e:
1382             self.report({'ERROR'}, "Installing keymap failed: %s" % e)
1383             return {'CANCELLED'}
1384
1385         # sneaky way to check we're actually running the code.
1386         if bpy.utils.keyconfig_set(path, report=self.report):
1387             return {'FINISHED'}
1388         else:
1389             return {'CANCELLED'}
1390
1391     def invoke(self, context, event):
1392         wm = context.window_manager
1393         wm.fileselect_add(self)
1394         return {'RUNNING_MODAL'}
1395
1396 # This operator is also used by interaction presets saving - AddPresetBase
1397
1398
1399 class WM_OT_keyconfig_export(Operator):
1400     "Export key configuration to a python script"
1401     bl_idname = "wm.keyconfig_export"
1402     bl_label = "Export Key Configuration..."
1403
1404     filepath = StringProperty(
1405             subtype='FILE_PATH',
1406             default="keymap.py",
1407             )
1408     filter_folder = BoolProperty(
1409             name="Filter folders",
1410             default=True,
1411             options={'HIDDEN'},
1412             )
1413     filter_text = BoolProperty(
1414             name="Filter text",
1415             default=True,
1416             options={'HIDDEN'},
1417             )
1418     filter_python = BoolProperty(
1419             name="Filter python",
1420             default=True,
1421             options={'HIDDEN'},
1422             )
1423
1424     def execute(self, context):
1425         from bpy_extras import keyconfig_utils
1426
1427         if not self.filepath:
1428             raise Exception("Filepath not set")
1429
1430         if not self.filepath.endswith(".py"):
1431             self.filepath += ".py"
1432
1433         wm = context.window_manager
1434
1435         keyconfig_utils.keyconfig_export(wm,
1436                                          wm.keyconfigs.active,
1437                                          self.filepath,
1438                                          )
1439
1440         return {'FINISHED'}
1441
1442     def invoke(self, context, event):
1443         wm = context.window_manager
1444         wm.fileselect_add(self)
1445         return {'RUNNING_MODAL'}
1446
1447
1448 class WM_OT_keymap_restore(Operator):
1449     "Restore key map(s)"
1450     bl_idname = "wm.keymap_restore"
1451     bl_label = "Restore Key Map(s)"
1452
1453     all = BoolProperty(
1454             name="All Keymaps",
1455             description="Restore all keymaps to default",
1456             )
1457
1458     def execute(self, context):
1459         wm = context.window_manager
1460
1461         if self.all:
1462             for km in wm.keyconfigs.user.keymaps:
1463                 km.restore_to_default()
1464         else:
1465             km = context.keymap
1466             km.restore_to_default()
1467
1468         return {'FINISHED'}
1469
1470
1471 class WM_OT_keyitem_restore(Operator):
1472     "Restore key map item"
1473     bl_idname = "wm.keyitem_restore"
1474     bl_label = "Restore Key Map Item"
1475
1476     item_id = IntProperty(
1477             name="Item Identifier",
1478             description="Identifier of the item to remove",
1479             )
1480
1481     @classmethod
1482     def poll(cls, context):
1483         keymap = getattr(context, "keymap", None)
1484         return keymap
1485
1486     def execute(self, context):
1487         km = context.keymap
1488         kmi = km.keymap_items.from_id(self.item_id)
1489
1490         if (not kmi.is_user_defined) and kmi.is_user_modified:
1491             km.restore_item_to_default(kmi)
1492
1493         return {'FINISHED'}
1494
1495
1496 class WM_OT_keyitem_add(Operator):
1497     "Add key map item"
1498     bl_idname = "wm.keyitem_add"
1499     bl_label = "Add Key Map Item"
1500
1501     def execute(self, context):
1502         km = context.keymap
1503
1504         if km.is_modal:
1505             km.keymap_items.new_modal("", 'A', 'PRESS')
1506         else:
1507             km.keymap_items.new("none", 'A', 'PRESS')
1508
1509         # clear filter and expand keymap so we can see the newly added item
1510         if context.space_data.filter_text != "":
1511             context.space_data.filter_text = ""
1512             km.show_expanded_items = True
1513             km.show_expanded_children = True
1514
1515         return {'FINISHED'}
1516
1517
1518 class WM_OT_keyitem_remove(Operator):
1519     "Remove key map item"
1520     bl_idname = "wm.keyitem_remove"
1521     bl_label = "Remove Key Map Item"
1522
1523     item_id = IntProperty(
1524             name="Item Identifier",
1525             description="Identifier of the item to remove",
1526             )
1527
1528     @classmethod
1529     def poll(cls, context):
1530         return hasattr(context, "keymap")
1531
1532     def execute(self, context):
1533         km = context.keymap
1534         kmi = km.keymap_items.from_id(self.item_id)
1535         km.keymap_items.remove(kmi)
1536         return {'FINISHED'}
1537
1538
1539 class WM_OT_keyconfig_remove(Operator):
1540     "Remove key config"
1541     bl_idname = "wm.keyconfig_remove"
1542     bl_label = "Remove Key Config"
1543
1544     @classmethod
1545     def poll(cls, context):
1546         wm = context.window_manager
1547         keyconf = wm.keyconfigs.active
1548         return keyconf and keyconf.is_user_defined
1549
1550     def execute(self, context):
1551         wm = context.window_manager
1552         keyconfig = wm.keyconfigs.active
1553         wm.keyconfigs.remove(keyconfig)
1554         return {'FINISHED'}
1555
1556
1557 class WM_OT_operator_cheat_sheet(Operator):
1558     bl_idname = "wm.operator_cheat_sheet"
1559     bl_label = "Operator Cheat Sheet"
1560
1561     def execute(self, context):
1562         op_strings = []
1563         tot = 0
1564         for op_module_name in dir(bpy.ops):
1565             op_module = getattr(bpy.ops, op_module_name)
1566             for op_submodule_name in dir(op_module):
1567                 op = getattr(op_module, op_submodule_name)
1568                 text = repr(op)
1569                 if text.split("\n")[-1].startswith("bpy.ops."):
1570                     op_strings.append(text)
1571                     tot += 1
1572
1573             op_strings.append('')
1574
1575         textblock = bpy.data.texts.new("OperatorList.txt")
1576         textblock.write('# %d Operators\n\n' % tot)
1577         textblock.write('\n'.join(op_strings))
1578         self.report({'INFO'}, "See OperatorList.txt textblock")
1579         return {'FINISHED'}
1580
1581
1582 # -----------------------------------------------------------------------------
1583 # Addon Operators
1584
1585 class WM_OT_addon_enable(Operator):
1586     "Enable an addon"
1587     bl_idname = "wm.addon_enable"
1588     bl_label = "Enable Addon"
1589
1590     module = StringProperty(
1591             name="Module",
1592             description="Module name of the addon to enable",
1593             )
1594
1595     def execute(self, context):
1596         import addon_utils
1597
1598         err_str = ""
1599
1600         def err_cb():
1601             import traceback
1602             nonlocal err_str
1603             err_str = traceback.format_exc()
1604             print(err_str)
1605
1606         mod = addon_utils.enable(self.module, handle_error=err_cb)
1607
1608         if mod:
1609             info = addon_utils.module_bl_info(mod)
1610
1611             info_ver = info.get("blender", (0, 0, 0))
1612
1613             if info_ver > bpy.app.version:
1614                 self.report({'WARNING'},
1615                             ("This script was written Blender "
1616                              "version %d.%d.%d and might not "
1617                              "function (correctly), "
1618                              "though it is enabled" %
1619                              info_ver))
1620             return {'FINISHED'}
1621         else:
1622
1623             if err_str:
1624                 self.report({'ERROR'}, err_str)
1625
1626             return {'CANCELLED'}
1627
1628
1629 class WM_OT_addon_disable(Operator):
1630     "Disable an addon"
1631     bl_idname = "wm.addon_disable"
1632     bl_label = "Disable Addon"
1633
1634     module = StringProperty(
1635             name="Module",
1636             description="Module name of the addon to disable",
1637             )
1638
1639     def execute(self, context):
1640         import addon_utils
1641
1642         err_str = ""
1643
1644         def err_cb():
1645             import traceback
1646             nonlocal err_str
1647             err_str = traceback.format_exc()
1648             print(err_str)
1649
1650         addon_utils.disable(self.module, handle_error=err_cb)
1651
1652         if err_str:
1653             self.report({'ERROR'}, err_str)
1654
1655         return {'FINISHED'}
1656
1657
1658 class WM_OT_theme_install(Operator):
1659     "Load and apply a Blender XML theme file"
1660     bl_idname = "wm.theme_install"
1661     bl_label = "Install Theme..."
1662
1663     overwrite = BoolProperty(
1664             name="Overwrite",
1665             description="Remove existing theme file if exists",
1666             default=True,
1667             )
1668     filepath = StringProperty(
1669             subtype='FILE_PATH',
1670             )
1671     filter_folder = BoolProperty(
1672             name="Filter folders",
1673             default=True,
1674             options={'HIDDEN'},
1675             )
1676     filter_glob = StringProperty(
1677             default="*.xml",
1678             options={'HIDDEN'},
1679             )
1680
1681     def execute(self, context):
1682         import os
1683         import shutil
1684         import traceback
1685
1686         xmlfile = self.filepath
1687
1688         path_themes = bpy.utils.user_resource('SCRIPTS', "presets/interface_theme", create=True)
1689
1690         if not path_themes:
1691             self.report({'ERROR'}, "Failed to get themes path")
1692             return {'CANCELLED'}
1693
1694         path_dest = os.path.join(path_themes, os.path.basename(xmlfile))
1695
1696         if not self.overwrite:
1697             if os.path.exists(path_dest):
1698                 self.report({'WARNING'}, "File already installed to %r\n" % path_dest)
1699                 return {'CANCELLED'}
1700
1701         try:
1702             shutil.copyfile(xmlfile, path_dest)
1703             bpy.ops.script.execute_preset(filepath=path_dest, menu_idname="USERPREF_MT_interface_theme_presets")
1704
1705         except:
1706             traceback.print_exc()
1707             return {'CANCELLED'}
1708
1709         return {'FINISHED'}
1710
1711     def invoke(self, context, event):
1712         wm = context.window_manager
1713         wm.fileselect_add(self)
1714         return {'RUNNING_MODAL'}
1715
1716
1717 class WM_OT_addon_refresh(Operator):
1718     "Scan addon directories for new modules"
1719     bl_idname = "wm.addon_refresh"
1720     bl_label = "Refresh"
1721
1722     def execute(self, context):
1723         import addon_utils
1724
1725         addon_utils.modules_refresh()
1726
1727         return {'FINISHED'}
1728
1729
1730 class WM_OT_addon_install(Operator):
1731     "Install an addon"
1732     bl_idname = "wm.addon_install"
1733     bl_label = "Install from File..."
1734
1735     overwrite = BoolProperty(
1736             name="Overwrite",
1737             description="Remove existing addons with the same ID",
1738             default=True,
1739             )
1740     target = EnumProperty(
1741             name="Target Path",
1742             items=(('DEFAULT', "Default", ""),
1743                    ('PREFS', "User Prefs", "")),
1744             )
1745
1746     filepath = StringProperty(
1747             subtype='FILE_PATH',
1748             )
1749     filter_folder = BoolProperty(
1750             name="Filter folders",
1751             default=True,
1752             options={'HIDDEN'},
1753             )
1754     filter_python = BoolProperty(
1755             name="Filter python",
1756             default=True,
1757             options={'HIDDEN'},
1758             )
1759     filter_glob = StringProperty(
1760             default="*.py;*.zip",
1761             options={'HIDDEN'},
1762             )
1763
1764     @staticmethod
1765     def _module_remove(path_addons, module):
1766         import os
1767         module = os.path.splitext(module)[0]
1768         for f in os.listdir(path_addons):
1769             f_base = os.path.splitext(f)[0]
1770             if f_base == module:
1771                 f_full = os.path.join(path_addons, f)
1772
1773                 if os.path.isdir(f_full):
1774                     os.rmdir(f_full)
1775                 else:
1776                     os.remove(f_full)
1777
1778     def execute(self, context):
1779         import addon_utils
1780         import traceback
1781         import zipfile
1782         import shutil
1783         import os
1784
1785         pyfile = self.filepath
1786
1787         if self.target == 'DEFAULT':
1788             # don't use bpy.utils.script_paths("addons") because we may not be able to write to it.
1789             path_addons = bpy.utils.user_resource('SCRIPTS', "addons", create=True)
1790         else:
1791             path_addons = context.user_preferences.filepaths.script_directory
1792             if path_addons:
1793                 path_addons = os.path.join(path_addons, "addons")
1794
1795         if not path_addons:
1796             self.report({'ERROR'}, "Failed to get addons path")
1797             return {'CANCELLED'}
1798
1799         if not os.path.isdir(path_addons):
1800             try:
1801                 os.makedirs(path_addons, exist_ok=True)
1802             except:
1803                 import traceback
1804                 traceback.print_exc()
1805
1806         # Check if we are installing from a target path,
1807         # doing so causes 2+ addons of same name or when the same from/to
1808         # location is used, removal of the file!
1809         addon_path = ""
1810         pyfile_dir = os.path.dirname(pyfile)
1811         for addon_path in addon_utils.paths():
1812             if os.path.samefile(pyfile_dir, addon_path):
1813                 self.report({'ERROR'}, "Source file is in the addon search path: %r" % addon_path)
1814                 return {'CANCELLED'}
1815         del addon_path
1816         del pyfile_dir
1817         # done checking for exceptional case
1818
1819         addons_old = {mod.__name__ for mod in addon_utils.modules()}
1820
1821         #check to see if the file is in compressed format (.zip)
1822         if zipfile.is_zipfile(pyfile):
1823             try:
1824                 file_to_extract = zipfile.ZipFile(pyfile, 'r')
1825             except:
1826                 traceback.print_exc()
1827                 return {'CANCELLED'}
1828
1829             if self.overwrite:
1830                 for f in file_to_extract.namelist():
1831                     WM_OT_addon_install._module_remove(path_addons, f)
1832             else:
1833                 for f in file_to_extract.namelist():
1834                     path_dest = os.path.join(path_addons, os.path.basename(f))
1835                     if os.path.exists(path_dest):
1836                         self.report({'WARNING'}, "File already installed to %r\n" % path_dest)
1837                         return {'CANCELLED'}
1838
1839             try:  # extract the file to "addons"
1840                 file_to_extract.extractall(path_addons)
1841             except:
1842                 traceback.print_exc()
1843                 return {'CANCELLED'}
1844
1845         else:
1846             path_dest = os.path.join(path_addons, os.path.basename(pyfile))
1847
1848             if self.overwrite:
1849                 WM_OT_addon_install._module_remove(path_addons, os.path.basename(pyfile))
1850             elif os.path.exists(path_dest):
1851                 self.report({'WARNING'}, "File already installed to %r\n" % path_dest)
1852                 return {'CANCELLED'}
1853
1854             #if not compressed file just copy into the addon path
1855             try:
1856                 shutil.copyfile(pyfile, path_dest)
1857
1858             except:
1859                 traceback.print_exc()
1860                 return {'CANCELLED'}
1861
1862         addons_new = {mod.__name__ for mod in addon_utils.modules()} - addons_old
1863         addons_new.discard("modules")
1864
1865         # disable any addons we may have enabled previously and removed.
1866         # this is unlikely but do just in case. bug [#23978]
1867         for new_addon in addons_new:
1868             addon_utils.disable(new_addon)
1869
1870         # possible the zip contains multiple addons, we could disallow this
1871         # but for now just use the first
1872         for mod in addon_utils.modules(refresh=False):
1873             if mod.__name__ in addons_new:
1874                 info = addon_utils.module_bl_info(mod)
1875
1876                 # show the newly installed addon.
1877                 context.window_manager.addon_filter = 'All'
1878                 context.window_manager.addon_search = info["name"]
1879                 break
1880
1881         # in case a new module path was created to install this addon.
1882         bpy.utils.refresh_script_paths()
1883
1884         # print message
1885         msg = tip_("Modules Installed from %r into %r (%s)") % (pyfile, path_addons, ", ".join(sorted(addons_new)))
1886         print(msg)
1887         self.report({'INFO'}, msg)
1888
1889         return {'FINISHED'}
1890
1891     def invoke(self, context, event):
1892         wm = context.window_manager
1893         wm.fileselect_add(self)
1894         return {'RUNNING_MODAL'}
1895
1896
1897 class WM_OT_addon_remove(Operator):
1898     "Delete the addon from the filesystem"
1899     bl_idname = "wm.addon_remove"
1900     bl_label = "Remove Addon"
1901
1902     module = StringProperty(
1903             name="Module",
1904             description="Module name of the addon to remove",
1905             )
1906
1907     @staticmethod
1908     def path_from_addon(module):
1909         import os
1910         import addon_utils
1911
1912         for mod in addon_utils.modules():
1913             if mod.__name__ == module:
1914                 filepath = mod.__file__
1915                 if os.path.exists(filepath):
1916                     if os.path.splitext(os.path.basename(filepath))[0] == "__init__":
1917                         return os.path.dirname(filepath), True
1918                     else:
1919                         return filepath, False
1920         return None, False
1921
1922     def execute(self, context):
1923         import addon_utils
1924         import os
1925
1926         path, isdir = WM_OT_addon_remove.path_from_addon(self.module)
1927         if path is None:
1928             self.report({'WARNING'}, "Addon path %r could not be found" % path)
1929             return {'CANCELLED'}
1930
1931         # in case its enabled
1932         addon_utils.disable(self.module)
1933
1934         import shutil
1935         if isdir:
1936             shutil.rmtree(path)
1937         else:
1938             os.remove(path)
1939
1940         addon_utils.modules_refresh()
1941
1942         context.area.tag_redraw()
1943         return {'FINISHED'}
1944
1945     # lame confirmation check
1946     def draw(self, context):
1947         self.layout.label(text="Remove Addon: %r?" % self.module)
1948         path, isdir = WM_OT_addon_remove.path_from_addon(self.module)
1949         self.layout.label(text="Path: %r" % path)
1950
1951     def invoke(self, context, event):
1952         wm = context.window_manager
1953         return wm.invoke_props_dialog(self, width=600)
1954
1955
1956 class WM_OT_addon_expand(Operator):
1957     "Display more information on this addon"
1958     bl_idname = "wm.addon_expand"
1959     bl_label = ""
1960
1961     module = StringProperty(
1962             name="Module",
1963             description="Module name of the addon to expand",
1964             )
1965
1966     def execute(self, context):
1967         import addon_utils
1968
1969         module_name = self.module
1970
1971         # unlikely to fail, module should have already been imported
1972         try:
1973             # mod = __import__(module_name)
1974             mod = addon_utils.addons_fake_modules.get(module_name)
1975         except:
1976             import traceback
1977             traceback.print_exc()
1978             return {'CANCELLED'}
1979
1980         info = addon_utils.module_bl_info(mod)
1981         info["show_expanded"] = not info["show_expanded"]
1982         return {'FINISHED'}