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