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