xscreen_usb_unlocker 0.90.2 → 0.91.0

data/README.md

@@ -10,31 +10,31 @@ This will work best with a device that presents a unique serial number, and you
 
 ## Usage
 
-To make sure it's not any device plugged or unpluged, you have to supply either a serial or a device id to scan for.
+### Automatic
 
-For now, the serial can be found with:
+To try to detect devices do:
 
-		$ lsusb -v |grep Serial
+		$ xscreen_usb_unlocker --select-device
 
-Once you find the device (if it has a serial, most phone's do.)
+Obviously, the device has to be plugged in for this to work.  Give it a try and let me know if anything doesn't work.  It's interactive and will save a config file for you.
 
-		$ xscreen_usb_unlocker -s SERIAL
+### Manual
 
-If it doesn't provide a serial, you can also use a device id.  Either the vendor, device or both can be supplied in a `vendor:device` format.
+You can also do all this by hand via methods like this via the output of lsusb.
 
-To find these just run `lsusb` and look for the `1234:ABCD` piece, that is your device id.
+Once you find the device (if it has a serial, most phone's do.)
 
-		$ xscreen_usb_unlocker -d 1234:ABCD
+		$ xscreen_usb_unlocker -s SERIAL
 
 You can also save these so you don't have to retype them, or have them in your history:
 
 		$ xscreen_usb_unlocker -s SERIAL -d 1234:ABCD --save-config
 
-Last, it can be daemonized, if this happens it will write a log to your homedirectory in: `~/.logs/xscreen_usb_unlocker.log`.  After you've saved your config, this is the simplest way to enable/disable it.
+### Running
 
-		$ xscreen_usb_unlocker -D
+Last, it can be daemonized, if this happens it will write a log to your homedirectory in: `~/.logs/xscreen_usb_unlocker.log`.
 
-You can control logging and the logfile as well, likely I will disable the log for the 1.0 release.
+		$ xscreen_usb_unlocker -D
 
 If you unlock xscreensaver by hand, you are not disabling this, the next time you plug/unplug your usb device, it will lock again.  This is useful if for some reason your usb device isn't available, you can still use your system as normal.
 
@@ -48,7 +48,6 @@ All it does is start/kill (safely) xscreensaver based on scanning for usb device
 
 ## TODO:
 
-* Add a --kill option to remove the other daemonizes.
 * Add a --name to trap for the device name (regex? substring?)
 * Add basic device detection to print out a pretty table to help configure it (offer options and save automatically?)
 

data/RELEASE.md

@@ -0,0 +1,10 @@
+# Release Notes
+
+#### 0.91.0
+
+* Added a way to select devices interactively.  Try --select-device to see.
+* Added -(-k)ill-daemon to stop a background copy of xscreen_usb_unlocker
+* Dropped auto daemonize when a config file is found.
+* Updated the README with clearer examples.
+* Added this RELEASE file.
+

data/bin/xscreen_usb_unlocker

@@ -5,79 +5,69 @@ Options.banner = "Usage: Used to lock/unlock xscreensaver based on usb device id
 Options.on("-s", "--serial SERIAL", "make sure the device matches this serial.") { |s| Options[:serial] = s}
 Options.on("-d", "--device DEVICE", "make sure it is this specific device.") { |d| Options[:device] = d}
 Options.on("-D", "--daemonize", "Daemonize this process in the background.") { |d| Options[:daemonize] = true}
+Options.on("-k", "--kill-daemon", "Kill any pids available in memory.") { |d| Options[:kill_daemon] = true }
+Options.on("--select-device", "Select a device to lock the screen with..") { |d| Options[:select_device] = true}
 Options.on("--save-config", "Save the device and serial to a XscreenUsbUnlocker::Config file and exit.") { |d| Options[:save_config] = true}
 Options.parse!
 
-if !Options[:device] && !Options[:serial]
-  puts 'Must supply a device or serial to look for.'
-  exit
-end
-
-def lock_screen
-  Log.info 'locking'
-  p = spawn "xscreensaver -no-splash"
-  Process.detach p
-  %x[xscreensaver-command -lock]
-end
-
-def unlock_screen
-  Log.info 'unlocking'
-
-  if xscreensaver_pids
-    xscreensaver_pids.each do |p|
-      Log.info "Appears to be pid: #{p.pid}"
-      Process.kill "QUIT", p.pid
-    end
-  end
-end
-
-def xscreensaver_running?
-  xscreensaver_pids.any?
-end
-
-def xscreensaver_pids
-  Sys::ProcTable.ps.select{|x| x.cmdline.include?("xscreensaver") && !x.cmdline.include?("ruby")}
-end
 
-def plugged_in?
+if Options[:select_device]
   usb = LIBUSB::Context.new
-  options_hash = {}
+  devices = usb.devices.select{|x| x.bDeviceClass != 9} # this probably doesn't need to be a '9' but I haven't looked it up yet.
+  if devices.any?
+    devices.each do |d|
+      puts "(#{devices.index d}) #{d.manufacturer} #{d.product}"
+    end
+    puts "Which device would you like to lock with?"
 
-  if Options[:device]
-    v, p = Options[:device].split(":")
-    options_hash[:idVendor] = v.hex if v && !v.empty?
-    options_hash[:idProduct] = p.hex if p && !p.empty?
-  end
+    print "-> "
+    c = STDIN.getc
 
-  devices = usb.devices(options_hash)
-  return true if devices.select { |d| d.serial_number == Options[:serial]}.any?
-  false
-end
+    d = devices[c.to_i]
+    if !d
+      puts "No such selection #{c}"
+      exit
+    end
+    puts "Using #{d.product} to lock/unlock."
+    new_config = XscreenUsbUnlocker::ConfigBlob.new(load = false)
 
-def toggle_lock
-  if plugged_in?
-    Log.info 'unlock requested'
-    unlock_screen
+    if d.serial_number == "?"
+      puts "Warning, this device doesn't appear to have a serial number, anybody with the same device will be able to unlock your screen."
+    else
+      new_config["serial"] = d.serial_number
+    end
+    new_config["device"] = "%04x:%04x" % [d.idVendor, d.idProduct]
+    new_config.save!
+    puts "Saved configuration to #{new_config.file}"
+    exit
   else
-    Log.info 'lock request'
-    lock_screen
+    puts "You don't have anything plugged in via USB, is that even possible nowadays?"
   end
+  exit
 end
 
-# did we pry?
-Options.on_pry
+if !Options[:device] && !Options[:serial]
+  puts 'Must supply a device or serial to look for.'
+  exit
+end
 
 # should we save our config and bail?
 if Options[:save_config]
   XscreenUsbUnlocker::Config["serial"] = Options[:serial] if Options[:serial]
   XscreenUsbUnlocker::Config["device"] = Options[:device] if Options[:device]
   XscreenUsbUnlocker::Config.save!
-  puts "Saved configuration to #{Config.file}"
+  puts "Saved configuration to #{XscreenUsbUnlocker::Config.file}"
+  exit
+end
+
+if Options[:kill_daemon]
+  App.kill_daemon
+  puts "Killing daemon."
   exit
 end
 
 # kill a running copy of xscreensaver
-if xscreensaver_running?
+if XscreenUsbUnlocker.xscreensaver_running?
   Log.info "xscreensaver appears to be running, killing so we can trap it."
   %x[killall -QUIT xscreensaver]
 end
@@ -86,15 +76,15 @@ end
 Notifier = INotify::Notifier.new
 Dir.glob("/dev/bus/usb/*").each do |d|
   Notifier.watch(d, :delete, :create) do
-    toggle_lock
+    XscreenUsbUnlocker.toggle_lock
   end
 end
 
 # fire off the lock cycle once.
-toggle_lock
+XscreenUsbUnlocker.toggle_lock
 
 # start the notifier, which will fire off callbacks as needed.
-if Options[:daemonize] || File.file?(XscreenUsbUnlocker::Config.file)
+if Options[:daemonize]
   Log.debug "Opening logfile."
   Log.filename "/home/ebrodeur/.logs/xscreensaver_unlocker.log"
   Log.debug "Daemonizing."
@@ -102,3 +92,4 @@ if Options[:daemonize] || File.file?(XscreenUsbUnlocker::Config.file)
 else
   Notifier.run
 end
+

data/lib/xscreen_usb_unlocker.rb

@@ -10,5 +10,54 @@ require 'xscreen_usb_unlocker/optparser'
 require "xscreen_usb_unlocker/version"
 
 module XscreenUsbUnlocker
-  # Your code goes here...
+  def self.lock_screen
+    Log.info 'locking'
+    p = spawn "xscreensaver -no-splash"
+    Process.detach p
+    %x[xscreensaver-command -lock]
+  end
+
+  def self.unlock_screen
+    Log.info 'unlocking'
+
+    if xscreensaver_pids
+      xscreensaver_pids.each do |p|
+        Log.info "Appears to be pid: #{p.pid}"
+        Process.kill "QUIT", p.pid
+      end
+    end
+  end
+
+  def self.xscreensaver_running?
+    xscreensaver_pids.any?
+  end
+
+  def self.xscreensaver_pids
+    Sys::ProcTable.ps.select{|x| x.cmdline.include?("xscreensaver") && !x.cmdline.include?("ruby")}
+  end
+
+  def self.plugged_in?
+    usb = LIBUSB::Context.new
+    options_hash = {}
+
+    if Options[:device]
+      v, p = Options[:device].split(":")
+      options_hash[:idVendor] = v.hex if v && !v.empty?
+      options_hash[:idProduct] = p.hex if p && !p.empty?
+    end
+
+    devices = usb.devices(options_hash)
+    return true if devices.select { |d| d.serial_number == Options[:serial]}.any?
+    false
+  end
+
+  def self.toggle_lock
+    if plugged_in?
+      Log.info 'unlock requested'
+      unlock_screen
+    else
+      Log.info 'lock request'
+      lock_screen
+    end
+  end
 end

data/lib/xscreen_usb_unlocker/config.rb

@@ -2,11 +2,11 @@ require 'fileutils'
 
 module XscreenUsbUnlocker
   class ConfigBlob < Hash
-    BaseDir = "/home/ebrodeur/.config/erniebrodeur"
+    BaseDir = "/home/ebrodeur/.config"
 
-    def initialize
+    def initialize(load = true)
       FileUtils.mkdir_p BaseDir if !Dir.exist? BaseDir
-      load
+      load if load
     end
 
     def file

data/lib/xscreen_usb_unlocker/log.rb

@@ -69,7 +69,10 @@ module XscreenUsbUnlocker
     end
 
     def create_logger
-      FileUtils.mkdir_p File.dirname @options[:filename] if File.file? @options[:filename]
+      if @options[:filename] != STDOUT && !File.file?(@options[:filename])
+        FileUtils.mkdir_p File.dirname @options[:filename]
+      end
+
       @l = ::Logger.new(@options[:filename])
       @l.level = @options[:level]
 
@@ -86,11 +89,11 @@ end
 
 # better way to do this with: Kernel.module_eval def puts ...
 module Kernel
-  def puts (s)
+  def puts (*args)
     if Log.override_puts?
       Log.info s
     else
-      Kernel::puts s
+      Kernel::puts args
     end
   end
 end

data/lib/xscreen_usb_unlocker/optparser.rb

@@ -38,13 +38,6 @@ module XscreenUsbUnlocker
       end
     end
 
-    def on_pry
-      if @options[:pry]
-        require 'pry'
-        binding.pry
-      end
-    end
-
     def [](k)
       @options[k]
     end

data/lib/xscreen_usb_unlocker/version.rb

@@ -1,3 +1,3 @@
 module XscreenUsbUnlocker
-  VERSION = "0.90.2"
+  VERSION = "0.91.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xscreen_usb_unlocker
 version: !ruby/object:Gem::Version
-  version: 0.90.2
+  version: 0.91.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-14 00:00:00.000000000 Z
+date: 2012-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb-inotify
@@ -104,6 +104,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- RELEASE.md
 - Rakefile
 - bin/xscreen_usb_unlocker
 - lib/xscreen_usb_unlocker.rb