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