starting blenderplater wasnt flipping use_deprecation_warnings when it should, also...
[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     """Toggle a context value"""
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 class WM_OT_doc_edit(Operator):
907     """Load online reference docs"""
908     bl_idname = "wm.doc_edit"
909     bl_label = "Edit Documentation"
910
911     doc_id = doc_id
912     doc_new = doc_new
913
914     _url = "http://www.mindrones.com/blender/svn/xmlrpc.php"
915
916     def _send_xmlrpc(self, data_dict):
917         print("sending data:", data_dict)
918
919         import xmlrpc.client
920         user = "blenderuser"
921         pwd = "blender>user"
922
923         docblog = xmlrpc.client.ServerProxy(self._url)
924         docblog.metaWeblog.newPost(1, user, pwd, data_dict, 1)
925
926     def execute(self, context):
927
928         doc_id = self.doc_id
929         doc_new = self.doc_new
930
931         class_name, class_prop = doc_id.split('.')
932
933         if not doc_new:
934             self.report({'ERROR'}, "No input given for '%s'" % doc_id)
935             return {'CANCELLED'}
936
937         # check if this is an operator
938         op_name = class_name.upper() + '_OT_' + class_prop
939         op_class = getattr(bpy.types, op_name, None)
940
941         # Upload this to the web server
942         upload = {}
943
944         if op_class:
945             rna = op_class.bl_rna
946             doc_orig = rna.description
947             if doc_orig == doc_new:
948                 return {'RUNNING_MODAL'}
949
950             print("op - old:'%s' -> new:'%s'" % (doc_orig, doc_new))
951             upload["title"] = 'OPERATOR %s:%s' % (doc_id, doc_orig)
952         else:
953             rna = getattr(bpy.types, class_name).bl_rna
954             doc_orig = rna.properties[class_prop].description
955             if doc_orig == doc_new:
956                 return {'RUNNING_MODAL'}
957
958             print("rna - old:'%s' -> new:'%s'" % (doc_orig, doc_new))
959             upload["title"] = 'RNA %s:%s' % (doc_id, doc_orig)
960
961         upload["description"] = doc_new
962
963         self._send_xmlrpc(upload)
964
965         return {'FINISHED'}
966
967     def draw(self, context):
968         layout = self.layout
969         layout.label(text="Descriptor ID: '%s'" % self.doc_id)
970         layout.prop(self, "doc_new", text="")
971
972     def invoke(self, context, event):
973         wm = context.window_manager
974         return wm.invoke_props_dialog(self, width=600)
975
976
977 rna_path = StringProperty(
978         name="Property Edit",
979         description="Property data_path edit",
980         maxlen=1024,
981         options={'HIDDEN'},
982         )
983
984 rna_value = StringProperty(
985         name="Property Value",
986         description="Property value edit",
987         maxlen=1024,
988         )
989
990 rna_property = StringProperty(
991         name="Property Name",
992         description="Property name edit",
993         maxlen=1024,
994         )
995
996 rna_min = FloatProperty(
997         name="Min",
998         default=0.0,
999         precision=3,
1000         )
1001
1002 rna_max = FloatProperty(
1003         name="Max",
1004         default=1.0,
1005         precision=3,
1006         )
1007
1008
1009 class WM_OT_properties_edit(Operator):
1010     bl_idname = "wm.properties_edit"
1011     bl_label = "Edit Property"
1012     # register only because invoke_props_popup requires.
1013     bl_options = {'REGISTER', 'INTERNAL'}
1014
1015     data_path = rna_path
1016     property = rna_property
1017     value = rna_value
1018     min = rna_min
1019     max = rna_max
1020     description = StringProperty(
1021             name="Tooltip",
1022             )
1023
1024     def execute(self, context):
1025         from rna_prop_ui import rna_idprop_ui_prop_get, rna_idprop_ui_prop_clear
1026
1027         data_path = self.data_path
1028         value = self.value
1029         prop = self.property
1030
1031         prop_old = getattr(self, "_last_prop", [None])[0]
1032
1033         if prop_old is None:
1034             self.report({'ERROR'}, "Direct execution not supported")
1035             return {'CANCELLED'}
1036
1037         try:
1038             value_eval = eval(value)
1039             # assert else None -> None, not "None", see [#33431]
1040             assert(type(value_eval) in {str, float, int, bool, tuple, list})
1041         except:
1042             value_eval = value
1043
1044         # First remove
1045         item = eval("context.%s" % data_path)
1046
1047         rna_idprop_ui_prop_clear(item, prop_old)
1048         exec_str = "del item['%s']" % prop_old
1049         # print(exec_str)
1050         exec(exec_str)
1051
1052         # Reassign
1053         exec_str = "item['%s'] = %s" % (prop, repr(value_eval))
1054         # print(exec_str)
1055         exec(exec_str)
1056         self._last_prop[:] = [prop]
1057
1058         prop_type = type(item[prop])
1059
1060         prop_ui = rna_idprop_ui_prop_get(item, prop)
1061
1062         if prop_type in {float, int}:
1063             prop_ui["soft_min"] = prop_ui["min"] = prop_type(self.min)
1064             prop_ui["soft_max"] = prop_ui["max"] = prop_type(self.max)
1065
1066         prop_ui["description"] = self.description
1067
1068         # otherwise existing buttons which reference freed
1069         # memory may crash blender [#26510]
1070         # context.area.tag_redraw()
1071         for win in context.window_manager.windows:
1072             for area in win.screen.areas:
1073                 area.tag_redraw()
1074
1075         return {'FINISHED'}
1076
1077     def invoke(self, context, event):
1078         from rna_prop_ui import rna_idprop_ui_prop_get
1079
1080         data_path = self.data_path
1081
1082         if not data_path:
1083             self.report({'ERROR'}, "Data path not set")
1084             return {'CANCELLED'}
1085
1086         self._last_prop = [self.property]
1087
1088         item = eval("context.%s" % data_path)
1089
1090         # setup defaults
1091         prop_ui = rna_idprop_ui_prop_get(item, self.property, False)  # don't create
1092         if prop_ui:
1093             self.min = prop_ui.get("min", -1000000000)
1094             self.max = prop_ui.get("max", 1000000000)
1095             self.description = prop_ui.get("description", "")
1096
1097         wm = context.window_manager
1098         return wm.invoke_props_dialog(self)
1099
1100
1101 class WM_OT_properties_add(Operator):
1102     bl_idname = "wm.properties_add"
1103     bl_label = "Add Property"
1104     bl_options = {'UNDO', 'INTERNAL'}
1105
1106     data_path = rna_path
1107
1108     def execute(self, context):
1109         from rna_prop_ui import rna_idprop_ui_prop_get
1110
1111         data_path = self.data_path
1112         item = eval("context.%s" % data_path)
1113
1114         def unique_name(names):
1115             prop = "prop"
1116             prop_new = prop
1117             i = 1
1118             while prop_new in names:
1119                 prop_new = prop + str(i)
1120                 i += 1
1121
1122             return prop_new
1123
1124         prop = unique_name(item.keys())
1125
1126         item[prop] = 1.0
1127
1128         # not essential, but without this we get [#31661]
1129         prop_ui = rna_idprop_ui_prop_get(item, prop)
1130         prop_ui["soft_min"] = prop_ui["min"] = 0.0
1131         prop_ui["soft_max"] = prop_ui["max"] = 1.0
1132
1133         return {'FINISHED'}
1134
1135
1136 class WM_OT_properties_context_change(Operator):
1137     "Jump to a different tab inside the properties editor"
1138     bl_idname = "wm.properties_context_change"
1139     bl_label = ""
1140     bl_options = {'INTERNAL'}
1141
1142     context = StringProperty(
1143             name="Context",
1144             maxlen=64,
1145             )
1146
1147     def execute(self, context):
1148         context.space_data.context = self.context
1149         return {'FINISHED'}
1150
1151
1152 class WM_OT_properties_remove(Operator):
1153     """Internal use (edit a property data_path)"""
1154     bl_idname = "wm.properties_remove"
1155     bl_label = "Remove Property"
1156     bl_options = {'UNDO', 'INTERNAL'}
1157
1158     data_path = rna_path
1159     property = rna_property
1160
1161     def execute(self, context):
1162         data_path = self.data_path
1163         item = eval("context.%s" % data_path)
1164         del item[self.property]
1165         return {'FINISHED'}
1166
1167
1168 class WM_OT_keyconfig_activate(Operator):
1169     bl_idname = "wm.keyconfig_activate"
1170     bl_label = "Activate Keyconfig"
1171
1172     filepath = StringProperty(
1173             subtype='FILE_PATH',
1174             )
1175
1176     def execute(self, context):
1177         if bpy.utils.keyconfig_set(self.filepath, report=self.report):
1178             return {'FINISHED'}
1179         else:
1180             return {'CANCELLED'}
1181
1182
1183 class WM_OT_appconfig_default(Operator):
1184     bl_idname = "wm.appconfig_default"
1185     bl_label = "Default Application Configuration"
1186
1187     def execute(self, context):
1188         import os
1189
1190         context.window_manager.keyconfigs.active = context.window_manager.keyconfigs.default
1191
1192         filepath = os.path.join(bpy.utils.preset_paths("interaction")[0], "blender.py")
1193
1194         if os.path.exists(filepath):
1195             bpy.ops.script.execute_preset(filepath=filepath, menu_idname="USERPREF_MT_interaction_presets")
1196
1197         return {'FINISHED'}
1198
1199
1200 class WM_OT_appconfig_activate(Operator):
1201     bl_idname = "wm.appconfig_activate"
1202     bl_label = "Activate Application Configuration"
1203
1204     filepath = StringProperty(
1205             subtype='FILE_PATH',
1206             )
1207
1208     def execute(self, context):
1209         import os
1210         bpy.utils.keyconfig_set(self.filepath)
1211
1212         filepath = self.filepath.replace("keyconfig", "interaction")
1213
1214         if os.path.exists(filepath):
1215             bpy.ops.script.execute_preset(filepath=filepath, menu_idname="USERPREF_MT_interaction_presets")
1216
1217         return {'FINISHED'}
1218
1219
1220 class WM_OT_sysinfo(Operator):
1221     """Generate System Info"""
1222     bl_idname = "wm.sysinfo"
1223     bl_label = "System Info"
1224
1225     def execute(self, context):
1226         import sys_info
1227         sys_info.write_sysinfo(self)
1228         return {'FINISHED'}
1229
1230
1231 class WM_OT_copy_prev_settings(Operator):
1232     """Copy settings from previous version"""
1233     bl_idname = "wm.copy_prev_settings"
1234     bl_label = "Copy Previous Settings"
1235
1236     def execute(self, context):
1237         import os
1238         import shutil
1239         ver = bpy.app.version
1240         ver_old = ((ver[0] * 100) + ver[1]) - 1
1241         path_src = bpy.utils.resource_path('USER', ver_old // 100, ver_old % 100)
1242         path_dst = bpy.utils.resource_path('USER')
1243
1244         if os.path.isdir(path_dst):
1245             self.report({'ERROR'}, "Target path %r exists" % path_dst)
1246         elif not os.path.isdir(path_src):
1247             self.report({'ERROR'}, "Source path %r exists" % path_src)
1248         else:
1249             shutil.copytree(path_src, path_dst, symlinks=True)
1250
1251             # reload recent-files.txt
1252             bpy.ops.wm.read_history()
1253
1254             # don't loose users work if they open the splash later.
1255             if bpy.data.is_saved is bpy.data.is_dirty is False:
1256                 bpy.ops.wm.read_homefile()
1257             else:
1258                 self.report({'INFO'}, "Reload Start-Up file to restore settings")
1259
1260             return {'FINISHED'}
1261
1262         return {'CANCELLED'}
1263
1264
1265 class WM_OT_blenderplayer_start(Operator):
1266     """Launch the blender-player with the current blend-file"""
1267     bl_idname = "wm.blenderplayer_start"
1268     bl_label = "Start Game In Player"
1269
1270     def execute(self, context):
1271         import os
1272         import sys
1273         import subprocess
1274
1275         gs = context.scene.game_settings
1276
1277         # these remain the same every execution
1278         blender_bin_path = bpy.app.binary_path
1279         blender_bin_dir = os.path.dirname(blender_bin_path)
1280         ext = os.path.splitext(blender_bin_path)[-1]
1281         player_path = os.path.join(blender_bin_dir, "blenderplayer" + ext)
1282         # done static vars
1283
1284         if sys.platform == "darwin":
1285             player_path = os.path.join(blender_bin_dir, "../../../blenderplayer.app/Contents/MacOS/blenderplayer")
1286
1287         if not os.path.exists(player_path):
1288             self.report({'ERROR'}, "Player path: %r not found" % player_path)
1289             return {'CANCELLED'}
1290
1291         filepath = bpy.data.filepath + '~' if bpy.data.is_saved else os.path.join(bpy.app.tempdir, "game.blend")
1292         bpy.ops.wm.save_as_mainfile('EXEC_DEFAULT', filepath=filepath, copy=True)
1293
1294         # start the command line call with the player path
1295         args = [player_path]
1296
1297         # handle some UI options as command line arguments
1298         args.extend([
1299             "-g", "show_framerate=%d" % gs.show_framerate_profile,
1300             "-g", "show_profile=%d" % gs.show_framerate_profile,
1301             "-g", "show_properties=%d" % gs.show_debug_properties,
1302             "-g", "ignore_deprecation_warnings=%d" % (not gs.use_deprecation_warnings),
1303             ])
1304
1305         # finish the call with the path to the blend file
1306         args.append(filepath)
1307
1308         subprocess.call(args)
1309         os.remove(filepath)
1310         return {'FINISHED'}
1311
1312
1313 class WM_OT_keyconfig_test(Operator):
1314     "Test key-config for conflicts"
1315     bl_idname = "wm.keyconfig_test"
1316     bl_label = "Test Key Configuration for Conflicts"
1317
1318     def execute(self, context):
1319         from bpy_extras import keyconfig_utils
1320
1321         wm = context.window_manager
1322         kc = wm.keyconfigs.default
1323
1324         if keyconfig_utils.keyconfig_test(kc):
1325             print("CONFLICT")
1326
1327         return {'FINISHED'}
1328
1329
1330 class WM_OT_keyconfig_import(Operator):
1331     "Import key configuration from a python script"
1332     bl_idname = "wm.keyconfig_import"
1333     bl_label = "Import Key Configuration..."
1334
1335     filepath = StringProperty(
1336             subtype='FILE_PATH',
1337             default="keymap.py",
1338             )
1339     filter_folder = BoolProperty(
1340             name="Filter folders",
1341             default=True,
1342             options={'HIDDEN'},
1343             )
1344     filter_text = BoolProperty(
1345             name="Filter text",
1346             default=True,
1347             options={'HIDDEN'},
1348             )
1349     filter_python = BoolProperty(
1350             name="Filter python",
1351             default=True,
1352             options={'HIDDEN'},
1353             )
1354     keep_original = BoolProperty(
1355             name="Keep original",
1356             description="Keep original file after copying to configuration folder",
1357             default=True,
1358             )
1359
1360     def execute(self, context):
1361         import os
1362         from os.path import basename
1363         import shutil
1364
1365         if not self.filepath:
1366             self.report({'ERROR'}, "Filepath not set")
1367             return {'CANCELLED'}
1368
1369         config_name = basename(self.filepath)
1370
1371         path = bpy.utils.user_resource('SCRIPTS', os.path.join("presets", "keyconfig"), create=True)
1372         path = os.path.join(path, config_name)
1373
1374         try:
1375             if self.keep_original:
1376                 shutil.copy(self.filepath, path)
1377             else:
1378                 shutil.move(self.filepath, path)
1379         except Exception as e:
1380             self.report({'ERROR'}, "Installing keymap failed: %s" % e)
1381             return {'CANCELLED'}
1382
1383         # sneaky way to check we're actually running the code.
1384         if bpy.utils.keyconfig_set(path, report=self.report):
1385             return {'FINISHED'}
1386         else:
1387             return {'CANCELLED'}
1388
1389     def invoke(self, context, event):
1390         wm = context.window_manager
1391         wm.fileselect_add(self)
1392         return {'RUNNING_MODAL'}
1393
1394 # This operator is also used by interaction presets saving - AddPresetBase
1395
1396
1397 class WM_OT_keyconfig_export(Operator):
1398     "Export key configuration to a python script"
1399     bl_idname = "wm.keyconfig_export"
1400     bl_label = "Export Key Configuration..."
1401
1402     filepath = StringProperty(
1403             subtype='FILE_PATH',
1404             default="keymap.py",
1405             )
1406     filter_folder = BoolProperty(
1407             name="Filter folders",
1408             default=True,
1409             options={'HIDDEN'},
1410             )
1411     filter_text = BoolProperty(
1412             name="Filter text",
1413             default=True,
1414             options={'HIDDEN'},
1415             )
1416     filter_python = BoolProperty(
1417             name="Filter python",
1418             default=True,
1419             options={'HIDDEN'},
1420             )
1421
1422     def execute(self, context):
1423         from bpy_extras import keyconfig_utils
1424
1425         if not self.filepath:
1426             raise Exception("Filepath not set")
1427
1428         if not self.filepath.endswith(".py"):
1429             self.filepath += ".py"
1430
1431         wm = context.window_manager
1432
1433         keyconfig_utils.keyconfig_export(wm,
1434                                          wm.keyconfigs.active,
1435                                          self.filepath,
1436                                          )
1437
1438         return {'FINISHED'}
1439
1440     def invoke(self, context, event):
1441         wm = context.window_manager
1442         wm.fileselect_add(self)
1443         return {'RUNNING_MODAL'}
1444
1445
1446 class WM_OT_keymap_restore(Operator):
1447     "Restore key map(s)"
1448     bl_idname = "wm.keymap_restore"
1449     bl_label = "Restore Key Map(s)"
1450
1451     all = BoolProperty(
1452             name="All Keymaps",
1453             description="Restore all keymaps to default",
1454             )
1455
1456     def execute(self, context):
1457         wm = context.window_manager
1458
1459         if self.all:
1460             for km in wm.keyconfigs.user.keymaps:
1461                 km.restore_to_default()
1462         else:
1463             km = context.keymap
1464             km.restore_to_default()
1465
1466         return {'FINISHED'}
1467
1468
1469 class WM_OT_keyitem_restore(Operator):
1470     "Restore key map item"
1471     bl_idname = "wm.keyitem_restore"
1472     bl_label = "Restore Key Map Item"
1473
1474     item_id = IntProperty(
1475             name="Item Identifier",
1476             description="Identifier of the item to remove",
1477             )
1478
1479     @classmethod
1480     def poll(cls, context):
1481         keymap = getattr(context, "keymap", None)
1482         return keymap
1483
1484     def execute(self, context):
1485         km = context.keymap
1486         kmi = km.keymap_items.from_id(self.item_id)
1487
1488         if (not kmi.is_user_defined) and kmi.is_user_modified:
1489             km.restore_item_to_default(kmi)
1490
1491         return {'FINISHED'}
1492
1493
1494 class WM_OT_keyitem_add(Operator):
1495     "Add key map item"
1496     bl_idname = "wm.keyitem_add"
1497     bl_label = "Add Key Map Item"
1498
1499     def execute(self, context):
1500         km = context.keymap
1501
1502         if km.is_modal:
1503             km.keymap_items.new_modal("", 'A', 'PRESS')
1504         else:
1505             km.keymap_items.new("none", 'A', 'PRESS')
1506
1507         # clear filter and expand keymap so we can see the newly added item
1508         if context.space_data.filter_text != "":
1509             context.space_data.filter_text = ""
1510             km.show_expanded_items = True
1511             km.show_expanded_children = True
1512
1513         return {'FINISHED'}
1514
1515
1516 class WM_OT_keyitem_remove(Operator):
1517     "Remove key map item"
1518     bl_idname = "wm.keyitem_remove"
1519     bl_label = "Remove Key Map Item"
1520
1521     item_id = IntProperty(
1522             name="Item Identifier",
1523             description="Identifier of the item to remove",
1524             )
1525
1526     @classmethod
1527     def poll(cls, context):
1528         return hasattr(context, "keymap")
1529
1530     def execute(self, context):
1531         km = context.keymap
1532         kmi = km.keymap_items.from_id(self.item_id)
1533         km.keymap_items.remove(kmi)
1534         return {'FINISHED'}
1535
1536
1537 class WM_OT_keyconfig_remove(Operator):
1538     "Remove key config"
1539     bl_idname = "wm.keyconfig_remove"
1540     bl_label = "Remove Key Config"
1541
1542     @classmethod
1543     def poll(cls, context):
1544         wm = context.window_manager
1545         keyconf = wm.keyconfigs.active
1546         return keyconf and keyconf.is_user_defined
1547
1548     def execute(self, context):
1549         wm = context.window_manager
1550         keyconfig = wm.keyconfigs.active
1551         wm.keyconfigs.remove(keyconfig)
1552         return {'FINISHED'}
1553
1554
1555 class WM_OT_operator_cheat_sheet(Operator):
1556     bl_idname = "wm.operator_cheat_sheet"
1557     bl_label = "Operator Cheat Sheet"
1558
1559     def execute(self, context):
1560         op_strings = []
1561         tot = 0
1562         for op_module_name in dir(bpy.ops):
1563             op_module = getattr(bpy.ops, op_module_name)
1564             for op_submodule_name in dir(op_module):
1565                 op = getattr(op_module, op_submodule_name)
1566                 text = repr(op)
1567                 if text.split("\n")[-1].startswith("bpy.ops."):
1568                     op_strings.append(text)
1569                     tot += 1
1570
1571             op_strings.append('')
1572
1573         textblock = bpy.data.texts.new("OperatorList.txt")
1574         textblock.write('# %d Operators\n\n' % tot)
1575         textblock.write('\n'.join(op_strings))
1576         self.report({'INFO'}, "See OperatorList.txt textblock")
1577         return {'FINISHED'}
1578
1579
1580 # -----------------------------------------------------------------------------
1581 # Addon Operators
1582
1583 class WM_OT_addon_enable(Operator):
1584     "Enable an addon"
1585     bl_idname = "wm.addon_enable"
1586     bl_label = "Enable Addon"
1587
1588     module = StringProperty(
1589             name="Module",
1590             description="Module name of the addon to enable",
1591             )
1592
1593     def execute(self, context):
1594         import addon_utils
1595
1596         err_str = ""
1597
1598         def err_cb():
1599             import traceback
1600             nonlocal err_str
1601             err_str = traceback.format_exc()
1602             print(err_str)
1603
1604         mod = addon_utils.enable(self.module, handle_error=err_cb)
1605
1606         if mod:
1607             info = addon_utils.module_bl_info(mod)
1608
1609             info_ver = info.get("blender", (0, 0, 0))
1610
1611             if info_ver > bpy.app.version:
1612                 self.report({'WARNING'},
1613                             ("This script was written Blender "
1614                              "version %d.%d.%d and might not "
1615                              "function (correctly), "
1616                              "though it is enabled" %
1617                              info_ver))
1618             return {'FINISHED'}
1619         else:
1620
1621             if err_str:
1622                 self.report({'ERROR'}, err_str)
1623
1624             return {'CANCELLED'}
1625
1626
1627 class WM_OT_addon_disable(Operator):
1628     "Disable an addon"
1629     bl_idname = "wm.addon_disable"
1630     bl_label = "Disable Addon"
1631
1632     module = StringProperty(
1633             name="Module",
1634             description="Module name of the addon to disable",
1635             )
1636
1637     def execute(self, context):
1638         import addon_utils
1639
1640         err_str = ""
1641
1642         def err_cb():
1643             import traceback
1644             nonlocal err_str
1645             err_str = traceback.format_exc()
1646             print(err_str)
1647
1648         addon_utils.disable(self.module, handle_error=err_cb)
1649
1650         if err_str:
1651             self.report({'ERROR'}, err_str)
1652
1653         return {'FINISHED'}
1654
1655
1656 class WM_OT_theme_install(Operator):
1657     "Load and apply a Blender XML theme file"
1658     bl_idname = "wm.theme_install"
1659     bl_label = "Install Theme..."
1660
1661     overwrite = BoolProperty(
1662             name="Overwrite",
1663             description="Remove existing theme file if exists",
1664             default=True,
1665             )
1666     filepath = StringProperty(
1667             subtype='FILE_PATH',
1668             )
1669     filter_folder = BoolProperty(
1670             name="Filter folders",
1671             default=True,
1672             options={'HIDDEN'},
1673             )
1674     filter_glob = StringProperty(
1675             default="*.xml",
1676             options={'HIDDEN'},
1677             )
1678
1679     def execute(self, context):
1680         import os
1681         import shutil
1682         import traceback
1683
1684         xmlfile = self.filepath
1685
1686         path_themes = bpy.utils.user_resource('SCRIPTS', "presets/interface_theme", create=True)
1687
1688         if not path_themes:
1689             self.report({'ERROR'}, "Failed to get themes path")
1690             return {'CANCELLED'}
1691
1692         path_dest = os.path.join(path_themes, os.path.basename(xmlfile))
1693
1694         if not self.overwrite:
1695             if os.path.exists(path_dest):
1696                 self.report({'WARNING'}, "File already installed to %r\n" % path_dest)
1697                 return {'CANCELLED'}
1698
1699         try:
1700             shutil.copyfile(xmlfile, path_dest)
1701             bpy.ops.script.execute_preset(filepath=path_dest, menu_idname="USERPREF_MT_interface_theme_presets")
1702
1703         except:
1704             traceback.print_exc()
1705             return {'CANCELLED'}
1706
1707         return {'FINISHED'}
1708
1709     def invoke(self, context, event):
1710         wm = context.window_manager
1711         wm.fileselect_add(self)
1712         return {'RUNNING_MODAL'}
1713
1714
1715 class WM_OT_addon_refresh(Operator):
1716     "Scan addon directories for new modules"
1717     bl_idname = "wm.addon_refresh"
1718     bl_label = "Refresh"
1719
1720     def execute(self, context):
1721         import addon_utils
1722
1723         addon_utils.modules_refresh()
1724
1725         return {'FINISHED'}
1726
1727
1728 class WM_OT_addon_install(Operator):
1729     "Install an addon"
1730     bl_idname = "wm.addon_install"
1731     bl_label = "Install from File..."
1732
1733     overwrite = BoolProperty(
1734             name="Overwrite",
1735             description="Remove existing addons with the same ID",
1736             default=True,
1737             )
1738     target = EnumProperty(
1739             name="Target Path",
1740             items=(('DEFAULT', "Default", ""),
1741                    ('PREFS', "User Prefs", "")),
1742             )
1743
1744     filepath = StringProperty(
1745             subtype='FILE_PATH',
1746             )
1747     filter_folder = BoolProperty(
1748             name="Filter folders",
1749             default=True,
1750             options={'HIDDEN'},
1751             )
1752     filter_python = BoolProperty(
1753             name="Filter python",
1754             default=True,
1755             options={'HIDDEN'},
1756             )
1757     filter_glob = StringProperty(
1758             default="*.py;*.zip",
1759             options={'HIDDEN'},
1760             )
1761
1762     @staticmethod
1763     def _module_remove(path_addons, module):
1764         import os
1765         module = os.path.splitext(module)[0]
1766         for f in os.listdir(path_addons):
1767             f_base = os.path.splitext(f)[0]
1768             if f_base == module:
1769                 f_full = os.path.join(path_addons, f)
1770
1771                 if os.path.isdir(f_full):
1772                     os.rmdir(f_full)
1773                 else:
1774                     os.remove(f_full)
1775
1776     def execute(self, context):
1777         import addon_utils
1778         import traceback
1779         import zipfile
1780         import shutil
1781         import os
1782
1783         pyfile = self.filepath
1784
1785         if self.target == 'DEFAULT':
1786             # don't use bpy.utils.script_paths("addons") because we may not be able to write to it.
1787             path_addons = bpy.utils.user_resource('SCRIPTS', "addons", create=True)
1788         else:
1789             path_addons = context.user_preferences.filepaths.script_directory
1790             if path_addons:
1791                 path_addons = os.path.join(path_addons, "addons")
1792
1793         if not path_addons:
1794             self.report({'ERROR'}, "Failed to get addons path")
1795             return {'CANCELLED'}
1796
1797         if not os.path.isdir(path_addons):
1798             try:
1799                 os.makedirs(path_addons, exist_ok=True)
1800             except:
1801                 import traceback
1802                 traceback.print_exc()
1803
1804         # Check if we are installing from a target path,
1805         # doing so causes 2+ addons of same name or when the same from/to
1806         # location is used, removal of the file!
1807         addon_path = ""
1808         pyfile_dir = os.path.dirname(pyfile)
1809         for addon_path in addon_utils.paths():
1810             if os.path.samefile(pyfile_dir, addon_path):
1811                 self.report({'ERROR'}, "Source file is in the addon search path: %r" % addon_path)
1812                 return {'CANCELLED'}
1813         del addon_path
1814         del pyfile_dir
1815         # done checking for exceptional case
1816
1817         addons_old = {mod.__name__ for mod in addon_utils.modules()}
1818
1819         #check to see if the file is in compressed format (.zip)
1820         if zipfile.is_zipfile(pyfile):
1821             try:
1822                 file_to_extract = zipfile.ZipFile(pyfile, 'r')
1823             except:
1824                 traceback.print_exc()
1825                 return {'CANCELLED'}
1826
1827             if self.overwrite:
1828                 for f in file_to_extract.namelist():
1829                     WM_OT_addon_install._module_remove(path_addons, f)
1830             else:
1831                 for f in file_to_extract.namelist():
1832                     path_dest = os.path.join(path_addons, os.path.basename(f))
1833                     if os.path.exists(path_dest):
1834                         self.report({'WARNING'}, "File already installed to %r\n" % path_dest)
1835                         return {'CANCELLED'}
1836
1837             try:  # extract the file to "addons"
1838                 file_to_extract.extractall(path_addons)
1839             except:
1840                 traceback.print_exc()
1841                 return {'CANCELLED'}
1842
1843         else:
1844             path_dest = os.path.join(path_addons, os.path.basename(pyfile))
1845
1846             if self.overwrite:
1847                 WM_OT_addon_install._module_remove(path_addons, os.path.basename(pyfile))
1848             elif os.path.exists(path_dest):
1849                 self.report({'WARNING'}, "File already installed to %r\n" % path_dest)
1850                 return {'CANCELLED'}
1851
1852             #if not compressed file just copy into the addon path
1853             try:
1854                 shutil.copyfile(pyfile, path_dest)
1855
1856             except:
1857                 traceback.print_exc()
1858                 return {'CANCELLED'}
1859
1860         addons_new = {mod.__name__ for mod in addon_utils.modules()} - addons_old
1861         addons_new.discard("modules")
1862
1863         # disable any addons we may have enabled previously and removed.
1864         # this is unlikely but do just in case. bug [#23978]
1865         for new_addon in addons_new:
1866             addon_utils.disable(new_addon)
1867
1868         # possible the zip contains multiple addons, we could disallow this
1869         # but for now just use the first
1870         for mod in addon_utils.modules(refresh=False):
1871             if mod.__name__ in addons_new:
1872                 info = addon_utils.module_bl_info(mod)
1873
1874                 # show the newly installed addon.
1875                 context.window_manager.addon_filter = 'All'
1876                 context.window_manager.addon_search = info["name"]
1877                 break
1878
1879         # in case a new module path was created to install this addon.
1880         bpy.utils.refresh_script_paths()
1881
1882         # print message
1883         msg = tip_("Modules Installed from %r into %r (%s)") % (pyfile, path_addons, ", ".join(sorted(addons_new)))
1884         print(msg)
1885         self.report({'INFO'}, msg)
1886
1887         return {'FINISHED'}
1888
1889     def invoke(self, context, event):
1890         wm = context.window_manager
1891         wm.fileselect_add(self)
1892         return {'RUNNING_MODAL'}
1893
1894
1895 class WM_OT_addon_remove(Operator):
1896     "Disable an addon"
1897     bl_idname = "wm.addon_remove"
1898     bl_label = "Remove Addon"
1899
1900     module = StringProperty(
1901             name="Module",
1902             description="Module name of the addon to remove",
1903             )
1904
1905     @staticmethod
1906     def path_from_addon(module):
1907         import os
1908         import addon_utils
1909
1910         for mod in addon_utils.modules():
1911             if mod.__name__ == module:
1912                 filepath = mod.__file__
1913                 if os.path.exists(filepath):
1914                     if os.path.splitext(os.path.basename(filepath))[0] == "__init__":
1915                         return os.path.dirname(filepath), True
1916                     else:
1917                         return filepath, False
1918         return None, False
1919
1920     def execute(self, context):
1921         import addon_utils
1922         import os
1923
1924         path, isdir = WM_OT_addon_remove.path_from_addon(self.module)
1925         if path is None:
1926             self.report({'WARNING'}, "Addon path %r could not be found" % path)
1927             return {'CANCELLED'}
1928
1929         # in case its enabled
1930         addon_utils.disable(self.module)
1931
1932         import shutil
1933         if isdir:
1934             shutil.rmtree(path)
1935         else:
1936             os.remove(path)
1937
1938         context.area.tag_redraw()
1939         return {'FINISHED'}
1940
1941     # lame confirmation check
1942     def draw(self, context):
1943         self.layout.label(text="Remove Addon: %r?" % self.module)
1944         path, isdir = WM_OT_addon_remove.path_from_addon(self.module)
1945         self.layout.label(text="Path: %r" % path)
1946
1947     def invoke(self, context, event):
1948         wm = context.window_manager
1949         return wm.invoke_props_dialog(self, width=600)
1950
1951
1952 class WM_OT_addon_expand(Operator):
1953     "Display more information on this addon"
1954     bl_idname = "wm.addon_expand"
1955     bl_label = ""
1956
1957     module = StringProperty(
1958             name="Module",
1959             description="Module name of the addon to expand",
1960             )
1961
1962     def execute(self, context):
1963         import addon_utils
1964
1965         module_name = self.module
1966
1967         # unlikely to fail, module should have already been imported
1968         try:
1969             # mod = __import__(module_name)
1970             mod = addon_utils.addons_fake_modules.get(module_name)
1971         except:
1972             import traceback
1973             traceback.print_exc()
1974             return {'CANCELLED'}
1975
1976         info = addon_utils.module_bl_info(mod)
1977         info["show_expanded"] = not info["show_expanded"]
1978         return {'FINISHED'}