summaryrefslogtreecommitdiff
path: root/plugins/python/scripting/core.py
blob: 135edb424129213eb81676277c6865c25adf1076 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

import gi
gi.require_version('Gtk', '3.0')

from gi.repository import GLib, Gtk
import os

from pychrysalide import core
from pychrysalide.gui import core as gcore
from pychrysalide.gui import MenuBar
from pychrysalide.gtkext import EasyGtk
from pychrysalide.plugins import PluginModule

from .panel import ScriptPanel


class ScriptingEngine(PluginModule):
    """Extend the GUI to run external Python scripts."""

    _name = 'ScriptingEngine'
    _desc = 'Run external Python scripts on demand'
    _version = '0.1'
    _url = 'https://www.chrysalide.re/'

    _actions = ( PluginModule.PluginAction.PLUGIN_LOADED, PluginModule.PluginAction.PANEL_CREATION )

    _manager = None


    def __init__(self):
        """Initialize the plugin for Chrysalide."""

        super(ScriptingEngine, self).__init__()

        # Scripts panel

        gcore.register_panel(ScriptPanel)

        # Insert the new menu item into 'File' submenu

        builder = gcore.get_editor_builder()

        if builder:

            file_menu = builder.get_object('file').get_submenu()
            sep_item = builder.get_object('file_sep_1')
            save_item = builder.get_object('file_save_project')

            index = EasyGtk.find_contained_child_index(file_menu, save_item)

            if index == -1:
                raise RuntimeError('file menu not found')

            prev = EasyGtk.get_nth_contained_child(file_menu, index - 1)

            if sep_item == prev:

                sep = Gtk.SeparatorMenuItem()
                sep.show()

                file_menu.insert(sep, index)

            item = Gtk.MenuItem(label='Run Python script...')
            item.connect("activate", self._on_file_run_script_activate)
            item.show()

            file_menu.insert(item, index)


    def _manage(self, action):
        """Ack the full loading of all plugins."""

        if action == PluginModule.PluginAction.PLUGIN_LOADED:

            xbel = self.build_config_filename('recents.xbel', True)

            ScriptingEngine._manager = Gtk.RecentManager(filename=xbel)

        return True


    def _on_panel_creation(self, action, item):
        """Get notified of a new panel creation."""

        if type(item) == ScriptPanel:

            item.attach_manager(ScriptingEngine._manager)

            item.connect('run-requested', self._on_run_requested)
            item.connect('ask-for-new-script', lambda x: self._on_file_run_script_activate(None))


    def _on_file_run_script_activate(self, widget):
        """Look for a new script to run."""

        dialog = Gtk.FileChooserDialog(title='Please choose a Python script to execute',
                                       transient_for=gcore.get_editor_window(),
                                       action=Gtk.FileChooserAction.OPEN)

        dialog.add_buttons(Gtk.STOCK_CANCEL,
                           Gtk.ResponseType.CANCEL,
                           Gtk.STOCK_OPEN,
                           Gtk.ResponseType.OK)

        ffilter = Gtk.FileFilter()
        ffilter.set_name('Python files')
        ffilter.add_mime_type('text/x-python')
        dialog.add_filter(ffilter)

        response = dialog.run()

        if response == Gtk.ResponseType.OK:
            filename = dialog.get_filename()
        else:
            filename = None

        dialog.destroy()

        if filename:
            self._run_script_file(filename)


    def _run_script_file(self, filename):
        """Run a given script file."""

        self.log_message(core.LogMessageType.INFO, 'Execute the script file \'%s\'' % filename)

        uri = GLib.filename_to_uri(filename)

        recent_data = Gtk.RecentData()
        recent_data.app_name = 'Chrysalide Python plugin'
        recent_data.app_exec = 'chrysalide'
        recent_data.display_name = os.path.basename(filename)
        recent_data.description = 'Python script run inside Chrysalide'
        recent_data.mime_type = 'text/x-python'

        ScriptingEngine._manager.add_full(uri, recent_data)

        try:
            with open(filename, 'r') as fd:
                content = fd.read()

            code = compile(content, '<string>', 'exec')

            eval(code)

        except Exception as e:
            self.log_message(core.LogMessageType.EXT_ERROR, 'Error while running the script: %s' % str(e))


    def _on_run_requested(self, panel, filename):
        """Run a script file from the recents panel."""

        self._run_script_file(filename)