nserver 1.0.1 → 1.1.0

data/History.txt

@@ -1,3 +1,10 @@
+== 1.1.0 / 2007-11.07
+
+* Major feature - accept connections from any host
+ * Bind to any address on machine
+ * Allow access based on IPs or Ranges
+ * Reject access if not explicitly permitted.
+
 == 1.0.1 / 2007-11-06
 
 * Minor enhancement

data/README.txt

@@ -22,6 +22,10 @@ If you have the Daemons ruby gem installed, simply run:
 
 This starts a persistent NServer::Server instance on port 10001.
 
+If you want to customize the bind ip or port:
+
+  % nserver start --bind-ip x.x.x.x --allow y.y.y.y,z.z.z.z/24
+
 === Client Example:
 
 Assuming you have a NServer::Server instance running, you can use the client like this:
@@ -39,6 +43,10 @@ or
 
   % nclient "Urgent message" -p critical
 
+If you're NServer is listening on another mahcine, you can:
+
+  % nclient --host y.y.y.y "My message"
+
 == REQUIREMENTS:
 
 * daemons

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake'
 require 'spec/rake/spectask'
 require './lib/nserver.rb'
 
-Hoe.new('nserver', NServer::Server::VERSION) do |p|
+Hoe.new('nserver', NServer::VERSION) do |p|
   p.rubyforge_name = 'burningbush'
   p.author = 'Jon Moses'
   p.email = 'jon@burningbush.us'

data/bin/nclient

@@ -5,10 +5,12 @@ require 'nserver'
 require 'getoptlong'
 
 opts = GetoptLong.new(
-  [ '--priority', '-p', GetoptLong::REQUIRED_ARGUMENT ]
+  [ '--priority', '-p', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '--host', GetoptLong::REQUIRED_ARGUMENT ]
 )
 
 priority = :normal
+host_ip = '127.0.0.1'
 msg = nil
 
 opts.each do |opt,arg|
@@ -20,6 +22,8 @@ opts.each do |opt,arg|
         exit 1
       end
       priority = p
+    when '--host'
+      host_ip = arg
   end
 end
 
@@ -31,7 +35,8 @@ end
 msg = ARGV[0]
 
 begin
-  NServer::Client.notify( msg, priority )
+  client = NServer::Client.new(:host => host_ip)
+  client.notify(msg, priority )
 rescue NServer::NoServerAvailable
   STDERR.puts("No server available.")
   exit 1

data/bin/nserver

@@ -3,10 +3,37 @@
 require 'rubygems'
 require 'daemons'
 require 'nserver'
+require 'getoptlong'
+
+bind_ip = nil
+allowed_client_ips = nil
+port = nil
+
+opts = GetoptLong.new(
+  ['--bind-ip', GetoptLong::REQUIRED_ARGUMENT ],
+  ['--allowed-client-ips', GetoptLong::REQUIRED_ARGUMENT ],
+  ['--port', GetoptLong::REQUIRED_ARGUMENT ]
+)
+
+opts.each do |opt,arg|
+  case opt
+    when '--bind-ip'
+      bind_ip = arg
+    when '--allowed-client-ips'
+      allowed_client_ips = arg
+    when '--port'
+      port = arg
+  end
+end
+
 
 Daemons.run_proc("nserver", :dir => "/tmp", :dir_mode => :normal) do 
 
-  server = NServer::Server.new
+  server = NServer::Server.new(
+    :host => bind_ip,
+    :port => port,
+    :allow => allowed_client_ips
+  )
   server.start
   server.join
 

data/lib/nserver.rb

@@ -1,44 +1,56 @@
 require 'RNotify'
 require 'gserver'
 require 'socket'
+require 'ipaddr'
 
 module NServer
-  class NoServerAvailable < StandardError
-    def initialize
-      super("No server available.")
-    end
-  end
-
-  class Message
-    PRIORITIES = [:low, :normal, :critical]
-
-    attr :text, :writable => true
-    attr :priority, :writable => true
-
-    def initialize( text = "", priority = :normal )
-      @text = text
-      @priority = ( PRIORITIES.index( priority ) or 1 )
-    end
-  end
-
+  VERSION = '1.1.0'
   class Server < GServer
-    VERSION = '1.0.1'
 
-    def initialize( port = 10001, *args )
-      super(port, *args)
+    # Create a NServer::Server instance
+    #
+    # Options:
+    # 
+    # port::
+    #  Port for the server to listen on.  Default is 10001
+    # host::
+    #  Host (IP) for the server to listen on.  Default is 127.0.0.1
+    #  Note that if you specify a non-localhost IP here you *must* specifiy
+    #  an allow list.  Also accepts 0.0.0.0 to listen on all available
+    #  interfaces.
+    # allow::
+    #   Comma seperated list of IPs to accept connections from.  Default is
+    #   only 127.0.0.1  IP ranges are allowed, in a x.x.x.x/y format.
+    # check_interval::
+    #  Interval to check for messages.  Default is 10s.
+    # tray_icon::
+    #  GTK Icon name to use for the systray icon. Default is 'gnome-gmush'.
+    # msg_timeout::
+    #  Message display timeout.  Default is 5000ms (5s).
+    def initialize( opts = {} )
+      opts[:port] ||= 10001
+      opts[:host] ||= "127.0.0.1"
       
-      @check_interval = 10
+      super(opts[:port], opts[:host])
+
+      opts[:check_interval] ||= 10
+      opts[:tray_icon] ||= "gnome-gmush"
+      opts[:msg_timeout] ||= 5000
+      opts[:allow] = ( opts[:allow] or "127.0.0.1" ).split(',').collect {|i| IPAddr.new( i ) }
+
+      @check_interval = opts[:check_interval]
 
       @msg_list = [ Message.new("NServer Ready.") ]
+      @allowed_clients = opts[:allow]
 
       Notify.init("Notification Server")
       tray_icon = Gtk::StatusIcon.new
-      tray_icon.icon_name = "gnome-gmush"
+      tray_icon.icon_name = opts[:tray_icon]
       #tray_icon.file = File.join( File.dirname(__FILE__), 'icons', 'default.png')
       tray_icon.tooltip = "NServer"
 
       @notification = Notify::Notification::new("X", nil, nil, tray_icon)
-      @notification.timeout = 5000
+      @notification.timeout = opts[:msg_timeout]
 
       Thread.new { Gtk.main }
       sleep 5
@@ -53,24 +65,29 @@ module NServer
       end
     end
 
+    # Display the message
     def notify(msg)
       @notification.update("Message Received", msg.text, nil)
       @notification.urgency = msg.priority
       @notification.show
     end
 
+    # Add a message to the message queue
     def add_message(msg, priority = :normal)
       @msg_list << Message.new(msg, priority)
     end
 
+    # Display the next message, if any.
     def process
       if @msg_list.size > 0
         notify(@msg_list.shift)
       end
     end
 
+    # Get and add a message to the list.  GServer method.
     def serve(io)
-      unless io.addr.last == "127.0.0.1"
+      unless @allowed_clients.include?( IPAddr.new(io.peeraddr.last) )
+        io.puts "#{io.addr.last} is not allowed."
         return
       end
       io.puts("Enter message, terminate with line break.")
@@ -92,6 +109,7 @@ module NServer
       end
     end
 
+    # On server shutdown, also do GUI shutdown stuff.
     def shutdown
       Notify.uninit
       Gtk.main_quit
@@ -100,9 +118,25 @@ module NServer
   end
 
   class Client
-    def Client.notify( msg, priority = :normal )
+    attr :host_ip, :writable => true
+    attr :host_port, :writable => true
+
+    # Create a new client
+    #
+    # Options:
+    #
+    # host::
+    #  The host to connect to.  Default is 127.0.0.1
+    # post::
+    #  The port to connect to.  Default is 10001.
+    def initialize( opts = {} )
+      @host_ip = ( opts[:host] or '127.0.0.1' )
+      @host_port = ( opts[:port] or '10001' ).to_i
+    end
+
+    def notify( msg, priority = :normal )
       begin
-        sock = TCPSocket.new('127.0.0.1', 10001)
+        sock = TCPSocket.new(@host_ip, @host_port)
         sleep(0.1) ## Needs delay, or wait until prompt.
         sock.write("#{priority.to_s.upcase}:#{msg}\n")
         sock.close
@@ -111,7 +145,8 @@ module NServer
       end
     end
 
-    def Client.try_notify( msg, priority = :normal )
+
+    def try_notify(msg, priority = :normal )
       begin
         notify(msg, priority)
       rescue NoServerAvailable
@@ -120,9 +155,47 @@ module NServer
       return true
     end
 
+    def with_notification( msg )
+      yield
+      notify(msg)
+    end
+
+    # Connect to the currently running NServer instance and add the
+    # message to the queue.  If no server, raise a NoServerAvailable
+    # error.
+    def Client.notify( msg, priority = :normal )
+      Client.new.notify(msg, priority)
+    end
+
+    # Connect to the currently running NServer, if any, and add the 
+    # message.  If no server is available, just return false.
+    def Client.try_notify( msg, priority = :normal )
+      Client.new.try_notify(msg, priority)
+    end
+    
+    # Run the block, then notify (with errors).
     def Client.with_notification( msg )
       yield
       notify( msg )
     end
   end
+
+  class NoServerAvailable < StandardError
+    def initialize
+      super("No server available.")
+    end
+  end
+
+  class Message
+    PRIORITIES = [:low, :normal, :critical]
+
+    attr :text, :writable => true
+    attr :priority, :writable => true
+
+    def initialize( text = "", priority = :normal )
+      @text = text
+      @priority = ( PRIORITIES.index( priority ) or 1 )
+    end
+  end
+
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4.5
 specification_version: 2
 name: nserver
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
-date: 2007-11-06 00:00:00 -05:00
+  version: 1.1.0
+date: 2007-11-07 00:00:00 -05:00
 summary: Notification server for ruby using libnotify
 require_paths: 
 - lib