mwotton-apnd 0.1.8

data/lib/apnd/cli.rb

@@ -0,0 +1,195 @@
+require 'daemons'
+require 'optparse'
+
+module APND
+  class CLI #:nodoc: all
+
+    #
+    # Run apnd push
+    #
+    def self.push(argv)
+      help = <<-HELP
+Usage:
+  apnd push [OPTIONS] --token <token>
+
+      HELP
+
+      options = {}
+
+      opts = OptionParser.new do |opt|
+        opt.banner = help
+
+        opt.separator "Required Arguments:\n"
+
+        opt.on('--token  [TOKEN]', "Set Notification's iPhone token to TOKEN") do |token|
+          options[:token] = token
+        end
+
+        opt.separator "\nOptional Arguments:\n"
+
+        opt.on('--alert  [MESSAGE]', "Set Notification's alert to MESSAGE") do |alert|
+          options[:alert] = alert
+        end
+
+        opt.on('--sound  [SOUND]', "Set Notification's sound to SOUND") do |sound|
+          options[:sound] = sound
+        end
+
+        opt.on('--badge  [NUMBER]', "Set Notification's badge number to NUMBER") do |badge|
+          options[:badge] = badge.to_i
+        end
+
+        opt.on('--custom [JSON]', "Set Notification's custom data to JSON") do |custom|
+          begin
+            options[:custom] = JSON.parse(custom)
+          rescue JSON::ParserError => e
+            puts "Invalid JSON: #{e}"
+            exit -1
+          end
+        end
+
+        opt.on('--host   [HOST]', "Send Notification to HOST, usually the one running APND (default is 'localhost')") do |host|
+          options[:host] = host
+        end
+
+        opt.on('--port   [PORT]', 'Send Notification on PORT (default is 22195)') do |port|
+          options[:port] = port.to_i
+        end
+
+        opt.separator "\nHelp:\n"
+
+        opt.on('--help', 'Show this message') do
+          puts opt
+          exit
+        end
+      end
+
+      begin
+        opts.parse!
+        if options.empty?
+          puts opts
+          exit
+        end
+
+        unless options[:token]
+          raise OptionParser::MissingArgument, "must specify --token"
+        end
+      rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+        puts "#{$0}: #{$!.message}"
+        puts "#{$0}: try '#{$0} --help' for more information"
+        exit
+      end
+
+      # Configure Notification upstream host/port
+      APND::Notification.upstream_host = options.delete(:host) if options[:host]
+      APND::Notification.upstream_port = options.delete(:port) if options[:port]
+
+      APND::Notification.create(options)
+    end
+
+    #
+    # Run apnd daemon
+    #
+    def self.daemon(argv)
+      help = <<-HELP
+Usage:
+  apnd daemon --apple-cert </path/to/cert>
+
+      HELP
+
+      options = {}
+
+      opts = OptionParser.new do |opt|
+        opt.banner = help
+
+        opt.separator "Required Arguments:\n"
+
+        opt.on('--apple-cert      [PATH]', 'PATH to APN certificate from Apple') do |cert|
+          options[:apple_cert] = cert
+        end
+
+        opt.separator "\nOptional Arguments:\n"
+
+        opt.on('--apple-host      [HOST]', "Connect to Apple at HOST (default is gateway.sandbox.push.apple.com)") do |host|
+          options[:apple_host] = host
+        end
+
+        opt.on('--apple-port      [PORT]', 'Connect to Apple on PORT (default is 2195)') do |port|
+          options[:apple_port] = port.to_i
+        end
+
+        opt.on('--apple-cert-pass [PASSWORD]', 'PASSWORD for APN certificate from Apple') do |pass|
+          options[:apple_cert_pass] = pass
+        end
+
+        opt.on('--daemon-port     [PORT]', 'Run APND on PORT (default is 22195)') do |port|
+          options[:daemon_port] = port.to_i
+        end
+
+        opt.on('--daemon-bind     [ADDRESS]', 'Bind APND to ADDRESS (default is 0.0.0.0)') do |bind|
+          options[:daemon_bind] = bind
+        end
+
+        opt.on('--daemon-log-file [PATH]', 'PATH to APND log file (default is /var/log/apnd.log)') do |log|
+          options[:daemon_log_file] = log
+        end
+
+        opt.on('--daemon-timer    [SECONDS]', 'Set APND queue refresh time to SECONDS (default is 30)') do |seconds|
+          options[:daemon_timer] = seconds.to_i
+        end
+
+        opt.on('--foreground', 'Run APND in foreground without daemonizing') do
+          options[:foreground] = true
+        end
+
+        opt.separator "\nHelp:\n"
+
+        opt.on('--help', 'Show this message') do
+          puts opt
+          exit
+        end
+      end
+
+      begin
+        opts.parse!
+        if options.empty?
+          puts opts
+          exit
+        end
+
+        unless options[:apple_cert]
+          raise OptionParser::MissingArgument, "must specify --apple-cert"
+        end
+      rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+        puts "#{$0}: #{$!.message}"
+        puts "#{$0}: try '#{$0} --help' for more information"
+        exit
+      end
+
+      APND.configure do |config|
+        # Setup AppleConnection
+        config.apple.cert      = options[:apple_cert]      if options[:apple_cert]
+        config.apple.cert_pass = options[:apple_cert_pass] if options[:apple_cert_pass]
+        config.apple.host      = options[:apple_host]      if options[:apple_host]
+        config.apple.port      = options[:apple_port]      if options[:apple_port]
+
+        # Setup Daemon
+        config.daemon.bind     = options[:daemon_bind]     if options[:daemon_bind]
+        config.daemon.port     = options[:daemon_port]     if options[:daemon_port]
+        config.daemon.log_file = options[:daemon_log_file] if options[:daemon_log_file]
+        config.daemon.timer    = options[:daemon_timer]    if options[:daemon_timer]
+      end
+
+      if APND.settings.apple.cert.nil?
+        puts opts
+        exit
+      else
+        unless options[:foreground]
+          Daemonize.daemonize(APND.settings.daemon.log_file, 'apnd')
+        end
+        APND::Daemon.run!
+      end
+
+    end
+  end
+end

data/lib/apnd/daemon.rb

@@ -0,0 +1,78 @@
+require 'eventmachine'
+
+module APND
+  #
+  # The APND::Daemon maintains a persistent secure connection with Apple,
+  # (APND::Daemon::AppleConnection). Notifications are queued and periodically
+  # writen to the AppleConnection
+  #
+  class Daemon
+    autoload :Protocol,         'apnd/daemon/protocol'
+    autoload :AppleConnection,  'apnd/daemon/apple_connection'
+    autoload :ServerConnection, 'apnd/daemon/server_connection'
+
+    #
+    # Create a new Daemon and run it
+    #
+    def self.run!
+      server = APND::Daemon.new
+      server.run!
+    end
+
+    #
+    # Create a connection to Apple and a new EM queue
+    #
+    def initialize
+      @queue = EM::Queue.new
+      @apple = APND::Daemon::AppleConnection.new
+      @bind  = APND.settings.daemon.bind
+      @port  = APND.settings.daemon.port
+      @timer = APND.settings.daemon.timer
+    end
+
+    #
+    # Run the daemon
+    #
+    def run!
+      EventMachine::run do
+        APND.logger "Starting APND Daemon v#{APND::Version} on #{@bind}:#{@port}"
+        EventMachine::start_server(@bind, @port, APND::Daemon::ServerConnection) do |server|
+          server.queue = @queue
+        end
+
+        EventMachine::PeriodicTimer.new(@timer) do
+          process_notifications!
+        end
+      end
+    end
+
+  private
+
+    #
+    # Sends each notification in the queue upstream to Apple
+    #
+    def process_notifications!
+      count = @queue.size
+      if count > 0
+        APND.logger "Queue has #{count} item#{count == 1 ? '' : 's'}"
+        @apple.connect!
+        count.times do
+          @queue.pop do |notification|
+            begin
+              APND.logger "Sending notification for #{notification.token}"
+              @apple.write(notification.to_bytes)
+            rescue Errno::EPIPE, OpenSSL::SSL::SSLError
+              APND.logger "Error, notification has been added back to the queue"
+              @queue.push(notification)
+              @apple.reconnect!
+            rescue RuntimeError => error
+              APND.logger "Error: #{error}"
+            end
+          end
+        end
+        @apple.disconnect!
+      end
+    end
+
+  end
+end

data/lib/apnd/daemon/apple_connection.rb

@@ -0,0 +1,84 @@
+require 'openssl'
+require 'socket'
+
+module APND
+  #
+  # Daemon::AppleConnection handles the persistent connection between
+  # APND and Apple
+  #
+  class Daemon::AppleConnection
+    attr_reader :ssl, :sock
+
+    #
+    # Setup a new connection
+    #
+    def initialize(params = {})
+      @options = {
+        :cert      => APND.settings.apple.cert,
+        :cert_pass => APND.settings.apple.cert_pass,
+        :host      => APND.settings.apple.host,
+        :port      => APND.settings.apple.port.to_i
+      }.merge(params)
+    end
+
+    #
+    # Returns true if the connection to Apple is open
+    #
+    def connected?
+      ! @ssl.nil?
+    end
+
+    #
+    # Connect to Apple over SSL
+    #
+    def connect!
+      cert         = File.read(@options[:cert])
+      context      = OpenSSL::SSL::SSLContext.new
+      context.key  = OpenSSL::PKey::RSA.new(cert, @options[:cert_pass])
+      context.cert = OpenSSL::X509::Certificate.new(cert)
+
+      @sock = TCPSocket.new(@options[:host], @options[:port])
+      @ssl  = OpenSSL::SSL::SSLSocket.new(@sock, context)
+      @ssl.sync = true
+      @ssl.connect
+    end
+
+    #
+    # Close connection
+    #
+    def disconnect!
+      @ssl.close
+      @sock.close
+      @ssl = nil
+      @sock = nil
+    end
+
+    #
+    # Disconnect/connect to Apple
+    #
+    def reconnect!
+      disconnect!
+      connect!
+    end
+
+    #
+    # Establishes a connection if needed and yields it
+    #
+    # Ex: open { |conn| conn.write('write to socket') }
+    #
+    def open(&block)
+      unless connected?
+        connect!
+      end
+
+      yield @ssl
+    end
+
+    #
+    # Write to the connection socket
+    #
+    def write(raw)
+      open { |conn| conn.write(raw) }
+    end
+  end
+end

data/lib/apnd/daemon/protocol.rb

@@ -0,0 +1,54 @@
+require 'socket'
+
+module APND
+  #
+  # Daemon::Protocol handles incoming APNs
+  #
+  module Daemon::Protocol
+
+    #
+    # Called when a client connection is opened
+    #
+    def post_init
+      @address = ::Socket.unpack_sockaddr_in(self.get_peername)
+      APND.logger "#{@address.last}:#{@address.first} opened connection"
+    end
+
+    #
+    # Called when a client connection is closed
+    #
+    # Checks @buffer for any pending notifications to be
+    # queued
+    #
+    def unbind
+      # totally broken.
+      @buffer.chomp!
+      while(@buffer.length > 0) do
+        # 3 bytes for header
+        # 32 bytes for token
+        # 2 bytes for json length
+        
+        # taking the last is acceptable because we know it's never
+        # longer than 256 bytes from the apple documentation.
+        json_length = @buffer.slice(35,37).unpack('CC').last
+        chunk = @buffer.slice!(0,json_length + 3 + 32 + 2)
+        if notification = APND::Notification.valid?(chunk)
+          APND.logger "#{@address.last}:#{@address.first} added new Notification to queue"
+          queue.push(notification)
+        else
+          APND.logger "#{@address.last}:#{@address.first} submitted invalid Notification"
+        end
+        @buffer.strip!
+      end
+      APND.logger "#{@address.last}:#{@address.first} closed connection"
+    end
+
+    #
+    # Add incoming notification(s) to @buffer
+    #
+    def receive_data(data)
+      APND.logger "#{@address.last}:#{@address.first} buffering data"
+      (@buffer ||= "") << data
+    end
+  end
+end

data/lib/apnd/daemon/server_connection.rb

@@ -0,0 +1,15 @@
+module APND
+  #
+  # Daemon::ServerConnection links APND::Daemon::Protocol to EM
+  #
+  class Daemon::ServerConnection < ::EventMachine::Connection
+
+    include APND::Daemon::Protocol
+
+    #
+    # Queue should be the EventMachine queue, see APND::Daemon
+    #
+    attr_accessor :queue
+
+  end
+end

data/lib/apnd/errors.rb

@@ -0,0 +1,22 @@
+module APND
+  module Errors #:nodoc: all
+
+    #
+    # Raised if APN payload is larger than 256 bytes
+    #
+    class InvalidPayload < StandardError
+      def initialize(message)
+        super("Payload is larger than 256 bytes: '#{message}'")
+      end
+    end
+
+    #
+    # Raised when parsing a Notification with an invalid header
+    #
+    class InvalidNotificationHeader < StandardError
+      def initialize(header)
+        super("Invalid Notification header: #{header.inspect}")
+      end
+    end
+  end
+end