global_hotkeys_manager 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e210552ed9e7cdb2861b2176b6dcd338e4239bac
+  data.tar.gz: 638412ee12c65e40ff94a5ff3a2e501c83addd69
+SHA512:
+  metadata.gz: 690284184197e08a9ab0c2d7eeb8c7dbe88ef42e7c05797407f4d9a583f44d868cefb034b4b872837baa1ac467b87a994d4e63e96959b64f8fc8b510f8b7f20f
+  data.tar.gz: b4ab0a3a36023d641e883cacb1803d0de934ae7f451bccafeca6fe23ba5579705d17f952c9ae89c31bf829056d37b9d831fd3389caae2c3f540675ac7fe7e897

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in global_hotkeys_manager.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rodrigo Rosenfeld Rosas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# Global Hotkeys Manager
+
+Global hotkeys management for Linux/X11 environments.
+
+## About
+
+I like to toggle the visibility of some common apps through global shortcuts/hotkeys, like the
+browser, terminal emulator, code editor, instant message client and so on. Too much open windows
+in my desktop feel like a mess to me and it's hard to switch among many of them by using Alt+Tab.
+
+Tools like kdocker allow us to send any window to the tray, but I wasn't able to find any tool
+that would allow me to assign the windows some shortcuts so that I wouldn't need the mouse to
+switch among them. I created [Ktrayshortcut](https://github.com/rosenfeld/ktrayshortcut) a while
+back to allow me to assign global hotkeys in addition to sending them to the tray. But after KDE
+moved from version 4 to KF5 lots of API changes made it hard to update the source-code as many
+things got much more complicated. I wasn't comfortable with having to spend too much time updating
+the source code everytime the API changed so today I was experimenting with some command line
+tools and decided to take another approach using tools I'm comfortable with, like Ruby, web
+development and command line tools.
+
+So, after a few hours I was able to put the pieces together and create a simple Sinatra web
+application with little of Ruby and plain JavaScript to get what I need done. After using
+Ktrayshorcut for a long time I realized I didn't really need any tray icons, just the hotkeys to
+toggle the applications, so this program does just that. It's simple to create and simple to
+maintain as long the required tools don't change too much.
+
+I thought about using Shoes to create the UI but I didn't like to add another big dependency
+(Java) and I'm not aware of any other GUI tool supporting Ruby that is lightweight, well
+documented and easy to use, so I decided to create a web app since I'm comfortable with maintaining
+them.
+
+## Requirements
+
+- xdotool
+- xbindkeys
+- xwininfo (from x11-utils package)
+- Ruby
+- sinatra and sinatra-contrib (installed from bundle)
+
+    sudo apt-get install xdotool x11-utils xbindkeys ruby
+    gem install global_hotkeys_manager
+
+## Usage
+
+    global_hotkeys_manager (simply start the daemon)
+
+Other commands:
+
+    global_hotkeys_manager help
+    global_hotkeys_manager status
+    global_hotkeys_manager stop
+    global_hotkeys_manager toggle window_id (used internally)
+    global_hotkeys_manager debug (like start but not in daemon mode)
+
+Access the UI through http://127.0.0.1:4242
+
+I also found useful to assign a global shortcut for accessing this address in Chrome any time I
+want to add a new window. Just add something like this to your ~/.xbindkeysrc:
+
+"google-chrome --app=http://127.0.0.1:4242 && sleep 0.2 && xdotool search "Global Hotkeys Manager" windowactivate "
+    m:0x19 + c:58
+    Shift+Alt+Mod2 + m
+
+All hotkeys managed by this application uses a separate configuration file rather than
+~/.xbindkeysrc (~/.config/global-hotkeys-manager/xbindkeysrc).

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "global_hotkeys_manager"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/global_hotkeys_manager

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'global_hotkeys_manager'
+require 'global_hotkeys_manager/web_app'
+
+unless ['xbindkeys', 'xwininfo', 'xdotool'].all?{|app| system "which #{app} > /dev/null"}
+  puts "The following tools are required to be installed for this app to work:
+  - xbindkeys
+  - xwininfo (from x11-utils package)
+  - xdotool"
+  exit -1
+end
+
+PID_FILE = "#{GlobalHotkeysManager::CONFIG_DIR}/server.pid"
+
+_pid = nil
+def pid
+  _pid ||= Integer(File.read PID_FILE)
+end
+
+def running?
+  return false unless File.exist? PID_FILE
+  Process.kill 0, pid
+  true
+rescue => e
+  puts "invalid PID: #{e.message} (deleted pid file)"
+  File.delete PID_FILE
+  false
+end
+
+def stop
+  GlobalHotkeysManager.stop
+  exit 0 unless running?
+  Process.kill 'SIGINT', pid
+end
+
+def start
+  exit 0 if running?
+  Process.daemon unless ARGV[0] == 'debug'
+  File.write PID_FILE, Process.pid
+  at_exit{ File.delete PID_FILE }
+  GlobalHotkeysManager.ensure_running
+  GlobalHotkeysManager::WebApp.run! environment: 'production'
+end
+
+case ARGV[0]
+when 'help'
+  puts %q{running without arguments will start the application daemons. Available commands:
+  status - report current status
+  stop - stop the daemon
+  toggle window_id - used internally
+  debug - start in no daemon mode
+  The default port is 4242 and can be overriden with the environment variable
+  HOTKEYS_MANAGER_PORT. Eg.: HOTKEYS_MANAGER_PORT=4444 global_hotkeys_manager}
+when 'toggle' then GlobalHotkeysManager.toggle Integer(ARGV[1])
+when 'status' then puts running? ? 'running' : 'stopped'
+when 'stop' then stop
+when 'restart' then (stop; sleep 1; start)
+when nil, 'debug', 'start' then start
+else
+  puts "unknown command: #{ARGV[0]}"
+end

data/global_hotkeys_manager.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'global_hotkeys_manager/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'global_hotkeys_manager'
+  spec.version       = GlobalHotkeysManager::VERSION
+  spec.authors       = ['Rodrigo Rosenfeld Rosas']
+  spec.email         = ['rr.rosas@gmail.com']
+
+  spec.summary       = %q{Global Hotkeys Management for Linux/X11 with a web interface}
+  spec.description   = %q{Integrates with command line tools like xbindkeys and xdotool to assign global hotkeys to toggle the visibility of any captured window}
+  spec.homepage      = 'https://github.com/rosenfeld/hotkeys-manager'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'sinatra', '1.4.7'
+  spec.add_dependency 'sinatra-contrib', '1.4.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/global_hotkeys_manager.rb

@@ -0,0 +1,115 @@
+require 'json'
+require 'fileutils'
+
+require_relative 'global_hotkeys_manager/version'
+
+module GlobalHotkeysManager
+  CONFIG_DIR = File.expand_path '~/.config/global-hotkeys-manager'
+  XBINDKEYSRC = "#{CONFIG_DIR}/xbindkeysrc"
+  HOTKEYS_JSON = "#{CONFIG_DIR}/hotkeys.json"
+  PORT = ENV['HOTKEYS_MANAGER_PORT'] || 4242
+  HOST = '127.0.0.1'
+  URL_BASE = "http://#{HOST}:#{PORT}"
+
+  FileUtils.mkdir_p CONFIG_DIR
+
+  def self.pid
+    return unless pid = `pgrep -o -f xbindkeys.*hotkeys`.split("\n").find{|p| system "kill -0 #{p}"}
+    system("kill -0 #{pid}") and pid.to_i
+  end
+
+  def self.ensure_running
+    id = pid and `kill #{id}`
+    `[ -f #{XBINDKEYSRC} ] && xbindkeys -f #{XBINDKEYSRC}`
+  end
+
+  def self.stop
+    pid and `kill #{pid}`
+  end
+
+  def self.hotkeys
+    return [] unless File.exist? HOTKEYS_JSON
+    JSON.parse(File.read HOTKEYS_JSON).find_all do |(id, name, key, mapped)|
+      valid_window_id?(id)
+    end
+  end
+
+  def self.valid_window_id?(id)
+    system "xwininfo -id #{id} > /dev/null 2>&1"
+  end
+
+  def self.map_all
+    hotkeys.each do |(id, name, key, mapped)|
+      `xdotool windowmap #{id}` rescue nil
+    end
+  end
+
+  def self.toggle(wid)
+    new_state = []
+    hotkeys.each do |(id, name, key, mapped)|
+      if id == wid
+        mapped = !mapped
+        if mapped
+          `xdotool windowmap #{id}`
+          `xdotool windowactivate #{id}`
+        else
+          `xdotool windowunmap #{id}`
+        end
+      end
+      new_state.push [id, name, key, mapped]
+    end
+    update_config new_state
+  end
+
+  def self.update_config(hotkeys)
+    hotkeys = hotkeys.find_all{|(id, name, key, mapped)| valid_window_id? id}
+    File.write HOTKEYS_JSON, JSON.unparse(hotkeys)
+    File.write XBINDKEYSRC, hotkeys.map{|(id, name, key, mapped)|
+      # webrick has a bug and require content-length to be sent
+      # using curl is faster but in case it's not installed we fall back to the command line
+      %Q{\##{name}\n"curl -H 'Content-Length: 0' -X POST #{URL_BASE}/toggle/#{id} || global_hotkeys_manager toggle #{id}"\n#{key}\n}
+    }.join("\n\n")
+    ensure_running
+  end
+
+  def self.update_name(wid, new_name)
+    new_state = []
+    hotkeys.each do |(id, name, key, mapped)|
+      name = new_name if id == wid
+      new_state.push [id, name, key, mapped]
+    end
+    update_config new_state
+  end
+
+  def self.update_key(wid)
+    new_key = ask_for_key
+    new_state = []
+    hotkeys.each do |(id, name, key, mapped)|
+      key = new_key if id == wid
+      new_state.push [id, name, key, mapped]
+    end
+    update_config new_state
+  end
+
+  def self.grab_window
+    wid = `xdotool selectwindow`.to_i
+    new_key = ask_for_key
+    new_name = `xdotool getwindowname #{wid}`
+    new_state = []
+    updated = false
+    hotkeys.each do |(id, name, key, mapped)|
+      if id == wid
+        updated = true
+        key = new_key
+      end
+      new_state.push [id, name, key, mapped]
+    end
+    new_state.push [wid, new_name, new_key, true] unless updated
+    update_config new_state
+  end
+
+  def self.ask_for_key
+    `xbindkeys -k`.split("\n").last
+  end
+end
+

data/lib/global_hotkeys_manager/public/index.js

@@ -0,0 +1,20 @@
+function live(id, type, handler) {
+  document.addEventListener(type, function(ev) {
+    if (ev.target.id == id || ev.target.className == id) handler.apply(this, arguments);
+  });
+}
+
+function post(path, data) {
+  var xhr = new XMLHttpRequest();
+  xhr.open('POST', path, true);
+  xhr.setRequestHeader('Content-type', 'application/x-www-form-urlencoded');
+  xhr.send(data);
+}
+
+function idFromEv(ev) { return ev.target.dataset.id }
+
+live('js-name', 'change', function(ev) {
+  var id = idFromEv(ev);
+  post('/update_name/' + id, 'name=' + encodeURIComponent(ev.target.value));
+});
+

data/lib/global_hotkeys_manager/version.rb

@@ -0,0 +1,3 @@
+module GlobalHotkeysManager
+  VERSION = '0.1.0'
+end

data/lib/global_hotkeys_manager/views/index.erb

@@ -0,0 +1,30 @@
+<!doctype html>
+<html>
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8">
+  
+    <title>Global Hotkeys Manager</title>
+    <style>form {display: inline; }</style>
+  </head>
+
+  <body>
+    <div id=list>
+      <% hotkeys.each do |(id, name, key, mapped)| %>
+        <div>
+          <input data-id=<%= id %> type=text class=js-name size=30 value="<%= name %>" />
+          <form method=post action="/update_key/<%= id %>">
+            <button type=submit >Change key</button>
+          </form>
+          (<%= key %>)
+        </div>
+      <% end %>
+    </div>
+    <div>
+      <form method=post action="/capture">
+        <button type=submit >Capture new window</button>
+      </form>
+    </div>
+
+    <script type="text/javascript" charset="utf-8" src="/index.js"></script>
+  </body>
+</html>

data/lib/global_hotkeys_manager/web_app.rb

@@ -0,0 +1,42 @@
+require 'sinatra/base'
+require 'sinatra/reloader'
+require 'tilt/erb'
+
+require_relative '../global_hotkeys_manager'
+
+module GlobalHotkeysManager
+  class WebApp < Sinatra::Base
+    configure :development do
+      register Sinatra::Reloader
+    end
+
+    configure do
+      set :port, GlobalHotkeysManager::PORT
+      set :bind, GlobalHotkeysManager::HOST
+    end
+
+    get '/' do
+      erb :index, layout: false, locals: { hotkeys: GlobalHotkeysManager.hotkeys }
+    end
+
+    post '/toggle/:id' do
+      GlobalHotkeysManager.toggle Integer(params[:id])
+      halt 200
+    end
+
+    post '/update_name/:id' do
+      GlobalHotkeysManager.update_name Integer(params[:id]), params[:name]
+      halt 200
+    end
+
+    post '/update_key/:id' do
+      GlobalHotkeysManager.update_key Integer(params[:id])
+      redirect '/'
+    end
+
+    post '/capture' do
+      GlobalHotkeysManager.grab_window
+      redirect '/'
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: global_hotkeys_manager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodrigo Rosenfeld Rosas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Integrates with command line tools like xbindkeys and xdotool to assign
+  global hotkeys to toggle the visibility of any captured window
+email:
+- rr.rosas@gmail.com
+executables:
+- global_hotkeys_manager
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/global_hotkeys_manager
+- global_hotkeys_manager.gemspec
+- lib/global_hotkeys_manager.rb
+- lib/global_hotkeys_manager/public/index.js
+- lib/global_hotkeys_manager/version.rb
+- lib/global_hotkeys_manager/views/index.erb
+- lib/global_hotkeys_manager/web_app.rb
+homepage: https://github.com/rosenfeld/hotkeys-manager
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Global Hotkeys Management for Linux/X11 with a web interface
+test_files: []