v1.0: functionality ready.

Author: suurjaak

inputscope/conf.py

@@ -16,11 +16,11 @@
 ServerIP = 0.0.0.0
 
 save() retains only the DEFAULT section, and writes only values diverging from
-the declared ones in source code.
+the declared ones in source code. File is deleted if all values are at default.
 
 @author      Erki Suurjaak
 @created     26.03.2015
-@modified    14.04.2015
+@modified    29.04.2015
 ------------------------------------------------------------------------------
 """
 try: import ConfigParser as configparser # Py2
@@ -36,37 +36,34 @@
 
 """Program title, version number and version date."""
 Title = "InputScope"
-Version = "0.0.1"
-VersionDate = "14.04.2015"
+Version = "1.0"
+VersionDate = "29.04.2015"
 
 """TCP port of the web user interface."""
 WebHost = "localhost"
 WebPort = 8099
 WebUrl = "http://%s:%s" % (WebHost, WebPort)
 
-HomepageUrl = "https://github.com/suurjaak/inputscope"
+HomepageUrl = "https://github.com/suurjaak/InputScope"
 
 """Size of the heatmaps, in pixels."""
 MouseHeatmapSize = (640, 360)
 KeyboardHeatmapSize = (680, 180)
 
-"""Default desktop size used for scaling, if size not available from system."""
+"""Default desktop size for scaling, if not available from system, in pixels."""
 DefaultScreenSize = (1920, 1080)
 
 """Whether mouse or keyboard logging is enabled."""
 MouseEnabled = True
 KeyboardEnabled = True
 
-"""Maximum interval between key presses to count as one typing session."""
+"""Maximum keypress interval to count as one typing session, in seconds."""
 KeyboardSessionMaxDelta = 3
 
 """Physical length of a pixel, in meters."""
 PixelLength = 0.00024825
 
-
-"""
-@todo siin üks variant 
-"""
+"""Key positions in keyboard heatmap."""
 KeyPositions = {
   "Escape": (12, 12),
   "F1": (72, 12),
@@ -223,7 +220,6 @@
 """Path for application icon file."""
 IconPath = os.path.join(StaticPath, "icon.ico")
 
-
 """Statements to execute in database at startup, like CREATE TABLE."""
 DbStatements = (
   "CREATE TABLE IF NOT EXISTS moves (id INTEGER NOT NULL PRIMARY KEY, dt TIMESTAMP, x INTEGER, y INTEGER)",

inputscope/db.py

@@ -6,8 +6,8 @@
 for i in range(5): db.insert("test", [("val", "venividivici")])
 db.insert("test", val=None)
 db.select("test", val=None, limit=[0, 3]).fetchone()
-db.update("test", values=[("val", "something")], val=None)
-db.update("test", values=[("val", "arrivederci")], where=[("val", ("IS NOT", None))])
+db.update("test", values=[("val", "arrivederci")], val=None)
+db.update("test", values=[("val", "ciao")], where=[("val", ("IS NOT", None))])
 db.select("test", order=["val", ("id", "DESC")], limit=[0, 4]).fetchall()
 db.delete("test", val="something")
 db.execute("DROP TABLE test")

inputscope/listener.py

@@ -4,10 +4,9 @@
 
 @author      Erki Suurjaak
 @created     06.04.2015
-@modified    24.04.2015
+@modified    29.04.2015
 """
 from __future__ import print_function
-import collections
 import datetime
 import multiprocessing
 import Queue
@@ -19,6 +18,8 @@
 import conf
 import db
 
+DEBUG = False
+
 
 class Listener(object):
     """Runs mouse and keyboard listeners, and handles incoming commands."""
@@ -63,7 +64,7 @@ class DataHandler(threading.Thread):
     """Output thread, inserts events to database and to output function."""
     def __init__(self, output):
         threading.Thread.__init__(self)
-        self.counts = collections.defaultdict(int) # {type: count}
+        self.counts = {} # {type: count}
         self.output = output
         self.inqueue = Queue.Queue()
         self.lasts = {"moves": None}
@@ -84,6 +85,7 @@ def run(self):
                 if self.lasts[event] == pos: continue # while self.running
                 self.lasts[event] = pos
 
+            if event not in self.counts: self.counts[event] = 0
             self.counts[event] += 1
             dbqueue.append((event, data))
             try:
@@ -124,10 +126,10 @@ def scroll(self, x, y, wheel):
 
 class KeyHandler(pykeyboard.PyKeyboardEvent):
     """Listens to keyboard events and forwards to output."""
-    CONTROLCODES = {"\x00": "Nul", "\x01": "Start-Of-Header", "\x02": "Start-Of-Text", "\x03": "Break", "\x04": "End-Of-Transmission", "\x05": "Enquiry", "\x06": "Ack", "\x07": "Bell", "\x08": "Backspace", "\x09": "Tab", "\x09": "Tab", "\x0a": "Linefeed", "\x0b": "Vertical-Tab", "\x0c": "Form-Fe", "\x0d": "Enter", "\x0e": "Shift-In", "\x0f": "Shift-Out", "\x10": "Data-Link-Escape", "\x11": "Devicecontrol1", "\x12": "Devicecontrol2", "\x13": "Devicecontrol3", "\x14": "Devicecontrol4", "\x15": "Nak", "\x16": "Syn", "\x17": "End-Of-Transmission-Block", "\x18": "Break", "\x19": "End-Of-Medium", "\x1a": "Substitute", "\x1b": "Escape", "\x1c": "File-Separator", "\x1d": "Group-Separator", "\x1e": "Record-Separator", "\x1f": "Unit-Separator", "\x20": "Space", "\x7f": "Del", "\xa0": "Non-Breaking Space"}
+    CONTROLCODES = {"\x00": "Nul", "\x01": "Start-Of-Header", "\x02": "Start-Of-Text", "\x03": "Break", "\x04": "End-Of-Transmission", "\x05": "Enquiry", "\x06": "Ack", "\x07": "Bell", "\x08": "Backspace", "\x09": "Tab", "\x0a": "Linefeed", "\x0b": "Vertical-Tab", "\x0c": "Form-Fe", "\x0d": "Enter", "\x0e": "Shift-In", "\x0f": "Shift-Out", "\x10": "Data-Link-Escape", "\x11": "Devicecontrol1", "\x12": "Devicecontrol2", "\x13": "Devicecontrol3", "\x14": "Devicecontrol4", "\x15": "Nak", "\x16": "Syn", "\x17": "End-Of-Transmission-Block", "\x18": "Break", "\x19": "End-Of-Medium", "\x1a": "Substitute", "\x1b": "Escape", "\x1c": "File-Separator", "\x1d": "Group-Separator", "\x1e": "Record-Separator", "\x1f": "Unit-Separator", "\x20": "Space", "\x7f": "Del", "\xa0": "Non-Breaking Space"}
     NUMPAD_SPECIALS = [("Insert", False), ("Delete", False), ("Home", False), ("End", False), ("PageUp", False), ("PageDown", False), ("Up", False), ("Down", False), ("Left", False), ("Right", False), ("Clear", False), ("Enter", True)]
     MODIFIERNAMES = {"Lcontrol": "Ctrl", "Rcontrol": "Ctrl", "Lshift": "Shift", "Rshift": "Shift", "Alt": "Alt", "AltGr": "Alt", "Lwin": "Win", "Rwin": "Win"}
-    RENAMES = {"Prior": "PageUp", "Next": "PageDown", "Lmenu": "Alt", "Rmenu": "AltGr", "Apps": "Menu", "Return": "Enter", "Back": "Backspace", "Capital": "CapsLock", "Numlock": "NumLock", "Snapshot": "PrintScreen", "Scroll": "ScrollLock", "Decimal": "Numpad-Decimal", "Divide": "Numpad-Divide", "Subtract": "Numpad-Subtract", "Multiply": "Numpad-Multiply", "Add": "Numpad-Add"}
+    RENAMES = {"Prior": "PageUp", "Next": "PageDown", "Lmenu": "Alt", "Rmenu": "AltGr", "Apps": "Menu", "Return": "Enter", "Back": "Backspace", "Capital": "CapsLock", "Numlock": "NumLock", "Snapshot": "PrintScreen", "Scroll": "ScrollLock", "Decimal": "Numpad-Decimal", "Divide": "Numpad-Divide", "Subtract": "Numpad-Subtract", "Multiply": "Numpad-Multiply", "Add": "Numpad-Add", "Cancel": "Break"}
     KEYS_DOWN = (0x0100, 0x0104) # [WM_KEYDOWN, WM_SYSKEYDOWN]
     KEYS_UP   = (0x0101, 0x0105) # [WM_KEYUP, WM_SYSKEYUP]
     ALT_GRS   = (36, 64, 91, 92, 93, 123, 124, 125, 128, 163, 208, 222, 240, 254) # $@[\]{|}€£ŠŽšž
@@ -137,9 +139,11 @@ class KeyHandler(pykeyboard.PyKeyboardEvent):
     def __init__(self, output):
         pykeyboard.PyKeyboardEvent.__init__(self)
         self.output = output
-        HANDLERS = {"win32": self.handle_windows, "darwin": self.handle_mac}
-        self.handler = HANDLERS.get(sys.platform, self.handle_linux) # Override
-        self.modifiers = {"Ctrl": False, "Alt": False, "Shift": False, "Win": False}
+        NAMES = {"win32": "handler", "linux2": "tap", "darwin": "keypress"}
+        HANDLERS = {"win32": self.handle_windows, "linux2": self.handle_linux,
+                    "darwin": self.handle_mac}
+        setattr(self, NAMES[sys.platform], HANDLERS[sys.platform])
+        self.modifiers = dict((x, False) for x in self.MODIFIERNAMES.values())
         self.realmodifiers = dict((x, False) for x in self.MODIFIERNAMES)
         self.start()
 
@@ -152,13 +156,11 @@ def keyname(self, key):
 
     def handle_windows(self, event):
         """Windows key event handler."""
-        if event.IsInjected(): return True # Programmatically generated event
-
         vkey = self.keyname(event.GetKey())
         if event.Message in self.KEYS_UP + self.KEYS_DOWN:
             if vkey in self.MODIFIERNAMES:
-                self.modifiers[self.MODIFIERNAMES[vkey]] = event.Message in self.KEYS_DOWN
                 self.realmodifiers[vkey] = event.Message in self.KEYS_DOWN
+                self.modifiers[self.MODIFIERNAMES[vkey]] = self.realmodifiers[vkey]
         if event.Message not in self.KEYS_DOWN:
             return True
 
@@ -171,18 +173,33 @@ def handle_windows(self, event):
             is_altgr = event.Ascii in self.ALT_GRS
             key = self.keyname(unichr(event.Ascii))
 
+        if DEBUG: print("Adding key %s (real %s)" % (key.encode("utf-8"), vkey.encode("utf-8")))
         self.output(type="keys", key=key, realkey=vkey)
 
         if vkey not in self.MODIFIERNAMES and not is_altgr:
-            modifier = "-".join(k for k, v in self.modifiers.items() if v)
+            modifier = "-".join(k for k in ["Ctrl", "Alt", "Shift", "Win"]
+                                if self.modifiers[k])
             if modifier and modifier != "Shift": # Shift-X is not a combo
                 if self.modifiers["Ctrl"] and event.Ascii:
                     key = self.keyname(unichr(event.KeyID))
                 realmodifier = "-".join(k for k, v in self.realmodifiers.items() if v)
                 realkey = "%s-%s" % (realmodifier, key)
                 key = "%s-%s" % (modifier, key)
+                if DEBUG: print("Adding combo %s (real %s)" % (key.encode("utf-8"), realkey.encode("utf-8")))
                 self.output(type="combos", key=key, realkey=realkey)
 
+        if DEBUG:
+            print("CHARACTER: %r" % key)
+            print('GetKey: {0}'.format(event.GetKey()))  # Name of the virtual keycode, str
+            print('IsAlt: {0}'.format(event.IsAlt()))  # Was the alt key depressed?, bool
+            print('IsExtended: {0}'.format(event.IsExtended()))  # Is this an extended key?, bool
+            print('IsInjected: {0}'.format(event.IsInjected()))  # Was this event generated programmatically?, bool
+            print('IsTransition: {0}'.format(event.IsTransition()))  #Is this a transition from up to down or vice versa?, bool
+            print('ASCII: {0}'.format(event.Ascii))  # ASCII value, if one exists, str
+            print('KeyID: {0}'.format(event.KeyID))  # Virtual key code, int
+            print('ScanCode: {0}'.format(event.ScanCode))  # Scan code, int
+            print('Message: {0}'.format(event.Message))  # Name of the virtual keycode, str
+            print()
         return True
 
 
@@ -201,11 +218,15 @@ def escape(self, event):
         return False
 
 
-
-if "__main__" == __name__:
+def main():
+    """Entry point for stand-alone execution."""
     conf.init(), db.init(conf.DbPath)
     inqueue = multiprocessing.Queue()
     outqueue = type("PrintQueue", (), {"put": lambda self, x: print(x)})()
     if conf.MouseEnabled:    inqueue.put("mouse_start")
     if conf.KeyboardEnabled: inqueue.put("keyboard_start")
     Listener(inqueue, outqueue).run()
+
+
+if "__main__" == __name__:
+    main()

inputscope/main.py

@@ -5,7 +5,7 @@
 
 @author      Erki Suurjaak
 @created     05.05.2015
-@modified    24.04.2015
+@modified    29.04.2015
 """
 import multiprocessing
 import multiprocessing.forking
@@ -14,12 +14,14 @@
 import sys
 import threading
 import webbrowser
-try: import Tkinter as tk   # For getting screen size if wx unavailable
-except ImportError: tk = None
 try: import win32com.client # For creating startup shortcut
 except ImportError: pass
+tk = None
 try: import wx, wx.lib.sized_controls, wx.py.shell
-except ImportError: wx = None
+except ImportError:
+    wx = None
+    try: import Tkinter as tk   # For getting screen size if wx unavailable
+    except ImportError: pass
 
 import conf
 import db
@@ -50,7 +52,6 @@ def __init__(self, messagehandler=None):
         self.webqueue      = multiprocessing.Queue() # Out-queue to webui
         self.inqueue       = multiprocessing.Queue() # In-queue from listener
 
-
     def toggle(self, input):
         if "mouse" == input:
             enabled = conf.MouseEnabled = not conf.MouseEnabled
@@ -59,6 +60,11 @@ def toggle(self, input):
         self.listenerqueue.put("%s_%s" % (input, "start" if enabled else "stop"))
         conf.save()
 
+    def stop(self):
+        self.running = False
+        self.listenerqueue.put("exit"), self.webqueue.put("exit")
+        self.inqueue.put(None) # Wake up thread waiting on queue
+
     def log_resolution(self, size):
         if size: db.insert("screen_sizes", x=size[0], y=size[1])
 
@@ -80,57 +86,40 @@ def run(self):
             if not data: continue
             self.messagehandler and self.messagehandler(data)
 
-    def stop(self):
-        self.running = False
-        self.listenerqueue.put("exit"), self.webqueue.put("exit")
-        self.inqueue.put(None) # Wake up thread waiting on queue
-
 
-
-class MainWindow(getattr(wx, "Frame", object)):
-    def __init__(self):
-        wx.Frame.__init__(self, parent=None,
-                          title="%s %s" % (conf.Title, conf.Version))
-
-        handler = lambda x: wx.CallAfter(lambda: log and log.SetValue(str(x)))
-        self.model = Model(handler)
+class MainApp(getattr(wx, "App", object)):
+    def OnInit(self):
+        self.model = Model()
         self.startupservice = StartupService()
 
-        self.frame_console = wx.py.shell.ShellFrame(self)
+        self.frame_console = wx.py.shell.ShellFrame(None)
         self.trayicon = wx.TaskBarIcon()
 
         if os.path.exists(conf.IconPath):
             icons = wx.IconBundle()
             icons.AddIconFromFile(conf.IconPath, wx.BITMAP_TYPE_ICO)
-            self.SetIcons(icons)
             self.frame_console.SetIcons(icons)
-            self.trayicon.SetIcon(icons.GetIconOfExactSize((16, 16)), conf.Title)
-
-        panel = wx.lib.sized_controls.SizedPanel(self)
-        log = self.log = wx.TextCtrl(panel, style=wx.TE_MULTILINE)
+            icon = (icons.GetIconOfExactSize((16, 16))
+                    if "win32" == sys.platform else icons.GetIcon((24, 24)))
+            self.trayicon.SetIcon(icon, conf.Title)
 
-        log.SetEditable(False)
-        log.BackgroundColour = wx.SystemSettings.GetColour(wx.SYS_COLOUR_WINDOW)
-        log.ForegroundColour = wx.SystemSettings.GetColour(wx.SYS_COLOUR_GRAYTEXT)
         self.frame_console.Title = "%s Console" % conf.Title
 
-        panel.SetSizerType("vertical")
-        log.SetSizerProps(expand=True, proportion=1)
-
         self.Bind(wx.EVT_CLOSE, self.OnClose)
         self.Bind(wx.EVT_DISPLAY_CHANGED, self.OnDisplayChanged)
         self.trayicon.Bind(wx.EVT_TASKBAR_LEFT_DCLICK, self.OnOpenUI)
         self.trayicon.Bind(wx.EVT_TASKBAR_RIGHT_DOWN, self.OnOpenMenu)
         self.frame_console.Bind(wx.EVT_CLOSE, self.OnToggleConsole)
 
-        self.Show()
+        self.model.log_resolution(wx.GetDisplaySize())
         self.model.start()
+        return True
 
 
     def OnOpenMenu(self, event):
         """Creates and opens a popup menu for the tray icon."""
         menu = wx.Menu()
-        item_ui = wx.MenuItem(menu, -1, "&Open user interface")
+        item_ui = wx.MenuItem(menu, -1, "&Open statistics")
         item_startup = wx.MenuItem(menu, -1, "&Start with Windows", 
             kind=wx.ITEM_CHECK) if self.startupservice.can_start() else None
         item_mouse = wx.MenuItem(menu, -1, "Stop &mouse logging",
@@ -143,8 +132,6 @@ def OnOpenMenu(self, event):
 
         font = item_ui.Font
         font.SetWeight(wx.FONTWEIGHT_BOLD)
-        font.SetFaceName(self.Font.FaceName)
-        font.SetPointSize(self.Font.PointSize)
         item_ui.Font = font
 
         menu.AppendItem(item_ui)
@@ -261,15 +248,14 @@ def start_listener(inqueue, outqueue):
     runner.run()
 
 
-
-if "__main__" == __name__:
+def main():
+    """Entry point for stand-alone execution."""
     multiprocessing.freeze_support()
     conf.init()
     db.init(conf.DbPath, conf.DbStatements)
 
     if wx:
-        app = wx.App(redirect=True) # stdout and stderr redirected to wx popup
-        app.SetTopWindow(MainWindow()) # stdout/stderr popup closes with window
+        app = MainApp(redirect=True) # stdout and stderr redirected to wx popup
         app.MainLoop()
     else:
         model = Model(lambda x: sys.stderr.write("\r%s" % x))
@@ -283,3 +269,7 @@ def start_listener(inqueue, outqueue):
             model.run()
         except KeyboardInterrupt:
             model.stop()
+
+
+if "__main__" == __name__:
+    main()