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