ADD: Remote control via Socket.IO (#282)

* ADD: Remote control via Socket.IO

- Add a command line option (--remote-host) to connect to
  a remote server via Socket.IO.

- Add a hook to send all internal events to the remote server using
  `from_neuronavigation` event.

- Add a Socket.IO event listener for `to_neuronavigation` events, send
  publish those events internally.

* FIX: WxPython-UI modifying Socket.IO messages not working

* FIX: Allow sending message to neuronavigation with data None

* Review comments: Create RemoteControl class under invesalius/net

* Review comments: Move invesalius_pubsub dir to invesalius/pubsub

* ADD: Python modules needed by Socket.IO to requirements.txt

* MOD: Move python-socketio to optional-requirements.txt

- Also, change the requirement name from python-socketio to
  python-socketio[client], causing all dependencies needed by the Socket.IO
  client (e.g., requests) to be installed

- Due to that, remove explicit 'requests' library from the requirements

Co-authored-by: Olli-Pekka Kahilakoski <olli-pekka.kahilakoski@aalto.fi>

app.py

@@ -51,7 +51,7 @@
 except ImportError:
     from wx import SplashScreen
 
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 #import wx.lib.agw.advancedsplash as agw
 #if sys.platform.startswith('linux'):
@@ -323,6 +323,10 @@ def parse_comand_line():
 
     parser.add_option("--import-folder", action="store", dest="import_folder")
 
+    parser.add_option("--remote-host",
+                      action="store",
+                      dest="remote_host")
+
     parser.add_option("-s", "--save",
                       help="Save the project after an import.")
 
@@ -503,6 +507,12 @@ def main():
     """
     options, args = parse_comand_line()
 
+    if options.remote_host is not None:
+        from invesalius.net.remote_control import RemoteControl
+
+        remote_control = RemoteControl(options.remote_host)
+        remote_control.connect()
+
     if options.no_gui:
         non_gui_startup(options, args)
     else:

docs/devel/example_pubsub.py

@@ -3,7 +3,7 @@
 # More information about this design pattern can be found at:
 # http://wiki.wxpython.org/ModelViewController
 # http://wiki.wxpython.org/PubSub
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 # The maintainer of Pubsub module is Oliver Schoenborn.
 # Since the end of 2006 Pubsub is now maintained separately on SourceForge at:

docs/devel/example_singleton_pubsub.py

@@ -1,6 +1,6 @@
 # Singleton and Publisher-Subscriber design patterns example.
 
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 class Singleton(type):
     # This is a Gary Robinson implementation:

invesalius/control.py

@@ -24,7 +24,7 @@
 import wx
 import numpy as np
 
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import invesalius.constants as const
 import invesalius.data.imagedata_utils as image_utils

invesalius/data/coordinates.py

@@ -26,7 +26,7 @@
 
 from time import sleep
 from random import uniform
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 
 def GetCoordinates(trck_init, trck_id, ref_mode):

invesalius/data/editor.py

@@ -18,7 +18,7 @@
 #--------------------------------------------------------------------------
 
 import math
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 import vtk
 
 AXIAL = 2

invesalius/data/geometry.py

@@ -22,7 +22,7 @@
 
 import numpy as np
 import vtk
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import invesalius.constants as const
 import invesalius.utils as utils

invesalius/data/imagedata_utils.py

@@ -27,7 +27,8 @@
 import numpy
 import numpy as np
 import vtk
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
+
 from scipy.ndimage import shift, zoom
 from vtk.util import numpy_support
 

invesalius/data/mask.py

@@ -33,7 +33,7 @@
 import numpy as np
 import vtk
 from invesalius_cy import floodfill
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 from scipy import ndimage
 from vtk.util import numpy_support
 

invesalius/data/measures.py

@@ -4,7 +4,7 @@
 import random
 import sys
 
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import numpy as np
 import vtk

invesalius/data/polydata_utils.py

@@ -21,7 +21,7 @@
 
 import vtk
 import wx
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import invesalius.constants as const
 import invesalius.data.vtk_utils as vu

invesalius/data/record_coords.py

@@ -23,7 +23,7 @@
 import wx
 from numpy import array, savetxt, hstack,vstack, asarray
 import invesalius.gui.dialogs as dlg
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 
 class Record(threading.Thread):

invesalius/data/slice_.py

@@ -22,7 +22,7 @@
 import numpy as np
 import vtk
 from scipy import ndimage
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import invesalius.constants as const
 import invesalius.data.converters as converters

invesalius/data/styles.py

@@ -31,7 +31,7 @@
 from imageio import imsave
 from scipy.ndimage import generate_binary_structure, watershed_ift
 from skimage.morphology import watershed
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import invesalius.constants as const
 import invesalius.data.converters as converters

invesalius/data/styles_3d.py

@@ -23,7 +23,7 @@
 import invesalius.constants as const
 import invesalius.project as prj
 
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 
 PROP_MEASURE = 0.8

invesalius/data/surface.py

@@ -38,7 +38,7 @@
 import wx
 import wx.lib.agw.genericmessagedialog as GMD
 
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 if sys.platform == 'win32':
     try:

invesalius/data/tractography.py

@@ -28,7 +28,7 @@
 
 import numpy as np
 import queue
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 from scipy.stats import norm
 import vtk
 

invesalius/data/trigger.py

@@ -21,7 +21,7 @@
 from time import sleep
 
 import wx
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 
 class Trigger(threading.Thread):

invesalius/data/viewer_slice.py

@@ -31,7 +31,7 @@
 import invesalius.data.styles as styles
 import wx
 import sys
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 try:
     from agw import floatspin as FS

invesalius/data/viewer_volume.py

@@ -29,7 +29,7 @@
 import wx
 import vtk
 from vtk.wx.wxVTKRenderWindowInteractor import wxVTKRenderWindowInteractor
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 import random
 from scipy.spatial import distance
 
@@ -622,6 +622,7 @@ def AddMarker(self, ball_id, size, colour, coord):
 
         self.ren.AddActor(self.staticballs[self.ball_id])
         self.ball_id = self.ball_id + 1
+
         #self.UpdateRender()
         self.Refresh()
 

invesalius/data/volume.py

@@ -24,7 +24,7 @@
 import numpy
 import vtk
 import wx
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import invesalius.constants as const
 import invesalius.project as prj

invesalius/data/vtk_utils.py

@@ -20,7 +20,7 @@
 
 import vtk
 import wx
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 import invesalius.constants as const
 from invesalius.gui.dialogs import ProgressDialog
 

invesalius/gui/bitmap_preview_panel.py

@@ -5,7 +5,7 @@
 
 from vtk.util import  numpy_support
 from vtk.wx.wxVTKRenderWindowInteractor import wxVTKRenderWindowInteractor
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import invesalius.constants as const
 import invesalius.data.vtk_utils as vtku

invesalius/gui/brain_seg_dialog.py

@@ -12,7 +12,7 @@
 
 import numpy as np
 import wx
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import invesalius.data.slice_ as slc
 from invesalius.segmentation.brain import segment, utils

invesalius/gui/data_notebook.py

@@ -34,7 +34,7 @@
     import wx.lib.flatnotebook as fnb
 
 import wx.lib.platebtn as pbtn
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import invesalius.constants as const
 import invesalius.data.slice_ as slice_

invesalius/gui/default_tasks.py

@@ -22,7 +22,7 @@
     import wx.lib.agw.foldpanelbar as fpb
 except ModuleNotFoundError:
     import wx.lib.foldpanelbar as fpb
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import invesalius.constants as const
 import invesalius.gui.data_notebook as nb

invesalius/gui/default_viewers.py

@@ -21,7 +21,7 @@
 
 import wx
 import wx.lib.agw.fourwaysplitter as fws
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import invesalius.data.viewer_slice as slice_viewer
 import invesalius.data.viewer_volume as volume_viewer
@@ -316,7 +316,7 @@ def _Exit(self):
 
 import wx.lib.platebtn as pbtn
 import wx.lib.buttons as btn
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 import wx.lib.colourselect as csel
 
 RAYCASTING_TOOLS = wx.NewId()

invesalius/gui/dialogs.py

@@ -47,7 +47,7 @@
 from wx.lib import masked
 from wx.lib.agw import floatspin
 from wx.lib.wordwrap import wordwrap
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 try:
     from wx.adv import AboutDialogInfo, AboutBox

invesalius/gui/dicom_preview_panel.py

@@ -29,7 +29,7 @@
 
 from vtk.util import  numpy_support
 from vtk.wx.wxVTKRenderWindowInteractor import wxVTKRenderWindowInteractor
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import invesalius.constants as const
 import invesalius.reader.dicom_reader as dicom_reader

invesalius/gui/frame.py

@@ -43,7 +43,7 @@
 from invesalius import inv_paths
 from invesalius.gui import project_properties
 from wx.lib.agw.aui.auibar import AUI_TB_PLAIN_BACKGROUND, AuiToolBar
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 try:
     from wx.adv import TaskBarIcon as wx_TaskBarIcon

invesalius/gui/import_bitmap_panel.py

@@ -18,7 +18,7 @@
 #--------------------------------------------------------------------------
 import wx
 import wx.gizmos as gizmos
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 import wx.lib.splitter as spl
 
 import invesalius.constants as const

invesalius/gui/import_network_panel.py

@@ -19,7 +19,7 @@
 import wx
 import sys
 import wx.gizmos as gizmos
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 import wx.lib.splitter as spl
 
 import invesalius.constants as const

invesalius/gui/import_panel.py

@@ -18,7 +18,7 @@
 #--------------------------------------------------------------------------
 import wx
 import wx.gizmos as gizmos
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 import wx.lib.splitter as spl
 
 import invesalius.constants as const

invesalius/gui/preferences.py

@@ -4,7 +4,7 @@
 import invesalius.session as ses
 import wx
 from invesalius.gui.language_dialog import ComboBoxLanguage
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 
 class Preferences(wx.Dialog):

invesalius/gui/project_properties.py

@@ -19,7 +19,7 @@
 
 import wx
 import invesalius.project as prj
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 from invesalius.gui import utils
 from invesalius import constants as const
 

invesalius/gui/task_exporter.py

@@ -29,7 +29,7 @@
     import wx.lib.hyperlink as hl
 
 import wx.lib.platebtn as pbtn
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import invesalius.constants as const
 import invesalius.gui.dialogs as dlg

invesalius/gui/task_importer.py

@@ -26,7 +26,7 @@
     import wx.lib.hyperlink as hl
 import wx.lib.platebtn as pbtn
 
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import invesalius.constants as const
 import invesalius.gui.dialogs as dlg

invesalius/gui/task_navigator.py

@@ -42,7 +42,7 @@
 
 import wx.lib.colourselect as csel
 import wx.lib.masked.numctrl
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 from time import sleep
 
 import invesalius.constants as const

invesalius/gui/task_slice.py

@@ -31,7 +31,7 @@
 
 import wx.lib.platebtn as pbtn
 import wx.lib.colourselect as csel
-from pubsub import pub as Publisher
+from invesalius.pubsub import pub as Publisher
 
 import invesalius.data.mask as mask
 import invesalius.data.slice_ as slice_