New action, RunScriptAction, which runs a user script.

fsl/data/strings.py

@@ -93,6 +93,9 @@ messages = TypeDict({
     'actions.loadcolourmap.installerror'     : 'An error occurred while '
                                                'installing the colour map',
 
+    'RunScriptAction.runScript' : 'Choose a FSLeyes script to run',
+    'RunScriptAction.crash'     : 'The script {} has crashed! Reason: {}',
+
     'AtlasPanel.loadingAtlas' : 'Loading {} atlas ...',
 
     'AtlasOverlayPanel.loadRegions'   : 'Loading region descriptions '
@@ -261,6 +264,7 @@ actions = TypeDict({
     'SavePerspectiveAction'   : 'Save current perspective',
     'ClearPerspectiveAction'  : 'Clear all perspectives',
     'DiagnosticReportAction'  : 'Diagnostic report',
+    'RunScriptAction'         : 'Run script',
     'AboutAction'             : 'About FSLeyes',
 
     'FSLEyesFrame.closeViewPanel' : 'Close',

fsl/fsleyes/actions/__init__.py

@@ -126,6 +126,7 @@ import copyoverlay
 import openfile
 import opendir
 import openstandard
+import runscript
 import saveoverlay
 import reloadoverlay
 import removeoverlay
@@ -145,6 +146,7 @@ CopyOverlayAction        = copyoverlay       .CopyOverlayAction
 OpenFileAction           = openfile          .OpenFileAction
 OpenDirAction            = opendir           .OpenDirAction
 OpenStandardAction       = openstandard      .OpenStandardAction
+RunScriptAction          = runscript         .RunScriptAction
 SaveOverlayAction        = saveoverlay       .SaveOverlayAction
 ReloadOverlayAction      = reloadoverlay     .ReloadOverlayAction
 RemoveOverlayAction      = removeoverlay     .RemoveOverlayAction

fsl/fsleyes/actions/runscript.py

+#!/usr/bin/env python
+#
+# runscript.py - The RunScriptAction class.
+#
+# Author: Paul McCarthy <pauldmccarthy@gmail.com>
+#
+"""This module provides the :class:`RunScriptAction` class, which allows
+the user to run a custom Python script.
+"""
+
+
+from __future__ import print_function
+
+import __future__         as futures
+import                       os
+import os.path            as op
+import                       logging
+
+import fsl.utils.settings as fslsettings
+import fsl.data.strings   as strings
+from . import                action
+
+
+log = logging.getLogger(__name__)
+
+
+class RunScriptAction(action.Action):
+    """The ``RunScriptAction`` class is an :class:`.Actuion` which allows the
+    user to run a custom Python script to control *FSLeyes*. The user is
+    prompted to select a script, and then the script is compiled and exceuted.
+    """
+
+
+    def __init__(self, overlayList, displayCtx, frame):
+        """Create a ``RunScriptAction``.
+
+        :arg overlayList: The :class:`.OverlayList`.
+        :arg displayCtx:  The top-level :class:`.DisplayContext`.
+        :arg overlayList: The :class:`.FSLEyesFrame`.
+        """
+        action.Action.__init__(self, self.__doAction)
+
+        self.__frame       = frame
+        self.__overlayList = overlayList
+        self.__displayCtx  = displayCtx
+        
+
+    def __doAction(self):
+        """Called when this :class:`.Action` is invoked. Prompts the user to
+        select a script file, then compiles and runs the script.
+        """
+
+        import wx
+
+        lastDir = fslsettings.read('runScriptLastDir')
+
+        if lastDir is None:
+            lastDir = os.getcwd()
+
+        msg = strings.messages[self, 'runScript']
+
+        # Ask the user what script
+        # they want to run
+        dlg    = wx.FileDialog(self.__frame,
+                               message=msg,
+                               defaultDir=lastDir,
+                               wildcard='*.py',
+                               style=wx.FD_OPEN)
+
+        if dlg.ShowModal() != wx.ID_OK:
+            return
+
+        script = dlg.GetPath()
+        
+        try:
+            self.__runScript(script)
+            
+        except Exception as e:
+            log.warning('Script ({}) could not be executed: {}'.format(
+                        script,
+                        str(e)),
+                        exc_info=True)
+
+            msg = strings.messages[self, 'crash'].format(
+                script,
+                str(e))
+
+            wx.MessageDialog(self.__frame,
+                             message=msg,
+                             style=wx.OK | wx.ICON_ERROR).ShowModal()
+            
+            return
+
+        # Save the script directory
+        # for the next time the user
+        # is prompted 
+        fslsettings.write('runScriptLastDir', op.dirname(script))
+
+        
+    def __runScript(self, script):
+        """Compiles and executes the given file, assumed to be a Python script.
+        An ``Error`` is raised if the script cannot be compiled or executed.
+        """
+
+        # Set up the script environment. It's
+        # quite difficult to truly sand-box an
+        # eval'ed piece of code, but setting
+        # __builtins__ to None will deter simple
+        # attack attempts.
+        _globals = {
+            '__builtins__' : None
+        }
+        
+        _locals = {
+            'overlayList' : self.__overlayList,
+            'displayCtx'  : self.__displayCtx,
+            'frame'       : self.__frame,
+            'viewPanels'  : self.__frame.getViewPanels()
+        }
+
+        # We want scripts to be Python3-like
+        flags = (futures.print_function  .compiler_flag |
+                 futures.absolute_import .compiler_flag |
+                 futures.division        .compiler_flag | 
+                 futures.unicode_literals.compiler_flag)
+
+        # Compile the script
+        with open(script, 'rt') as f:
+            log.debug('Compiling {}...'.format(script))
+            code = f.read()
+            code = compile(code,
+                           script,
+                           mode='exec',
+                           flags=flags,
+                           dont_inherit=True)
+
+        # Run the script
+        log.debug('Running {}...'.format(script))
+        eval(code, _globals, _locals)

fsl/fsleyes/frame.py

@@ -82,6 +82,7 @@ class FSLEyesFrame(wx.Frame):
        removeAllViewPanels
        getAuiManager
        refreshPerspectiveMenu
+       runScript
     """
 
     
@@ -403,6 +404,11 @@ class FSLEyesFrame(wx.Frame):
         self.__makePerspectiveMenu()
 
 
+    def runScript(self):
+        """Runs a custom python script, via a :class:`.RunScriptAction`. """
+        actions.RunScriptAction(self.__overlayList, self.__displayCtx, self)()
+
+        
     def __addViewPanelMenu(self, panel, title):
         """Called by :meth:`addViewPanel`. Adds a menu item for the newly
         created :class:`.ViewPanel` instance.
@@ -775,6 +781,7 @@ class FSLEyesFrame(wx.Frame):
         actionz = [actions.OpenFileAction,
                    actions.OpenDirAction,
                    actions.OpenStandardAction,
+                   actions.RunScriptAction,
                    'sep',
                    actions.CopyOverlayAction,
                    actions.SaveOverlayAction,