tunecore-announcer 0.0.1

data/lib/tunecore-announcer/xmpp_connection.rb

@@ -0,0 +1,163 @@
+require 'singleton'
+require 'xmpp4r'
+require 'xmpp4r/vcard'
+
+
+class TunecoreAnnouncer::XmppConnection
+  include Singleton
+
+  attr_reader :server
+  attr_reader :name
+  attr_reader :port
+
+  def initialize
+    @logger = TunecoreAnnouncer::Logger.instance
+  end
+
+  def connect(opt)
+    @options = opt
+    @server = opt.jabber_server
+    @name = "#{opt.name_prefix}-#{TunecoreAnnouncer::Utils.random_word(2)}"
+    @password = opt.jabber_password
+    admin_jids = opt.admin_jids
+
+    register
+    @logger.info "Connected to XMPP server"
+    #@jabber.add(admin_jids)
+    add_admins
+    #@logger.debug "Added #{admin_jid} to roster"
+    @logger.debug "Launching listener"
+    admins(opt.hello_mesg) if opt.hello_mesg
+    set_vcard
+    listen
+  end
+
+
+   def disconnect
+     admins "Shutting down ... Sayonara!"
+     deregister
+     @jabber.disconnect
+     @listener_thread.join
+   end
+
+  def admins(mesg)
+    @options.admin_jids.each do |admin_jid|
+      @jabber.deliver admin_jid, mesg
+    end 
+  end
+
+  def status(presence, mesg)
+    pres = Jabber::Presence::new
+    set_avatar(pres) unless @options.avatar_file.nil?
+    pres.set_status mesg
+    @logger.debug "Setting presence: #{pres.to_s}, #{mesg}"
+    @jabber.send!(pres)
+  end
+
+
+private
+
+  def register
+    connection_string = "#{@name}@#{@server}"
+    @logger.debug "Registering #{connection_string}"
+    begin
+      @jabber  = Jabber::Simple.register(connection_string, @password)
+    rescue => e
+      @logger.fatal "XMPP connection refused: #{e.message}\n#{e.backtrace}"
+      puts "XMPP connection refused: #{e.inspect}\n#{e.backtrace}"
+      exit
+    end
+  end
+
+  def deregister
+    @logger.debug "Removing registration"
+    client = @jabber.client
+    client.remove_registration
+  end
+
+
+  def listen
+    @listener_thread = Thread.new{
+      @logger.debug "Listening for XMPP messages (connected=#{@jabber.connected?})"
+      while @jabber.connected? do
+        #@logger.debug "Polling for Jabber mesg"
+        @jabber.received_messages.each do |message|
+          process_incoming message
+          sleep 1
+        end
+      end
+    }
+    @listener_thread.run
+  end
+
+  def process_incoming(message)
+    @logger.debug "Jabber msg from #{message.from}: #{message.body}"
+    case message.body
+    when "uptime"
+      @jabber.deliver(message.from, `uptime`)
+    when "ps"
+      @jabber.deliver(message.from, `ps -ef`)
+    when "hostname"
+      @jabber.deliver(message.from, `hostname`)
+    else
+      @jabber.deliver(message.from, "Sorry, I don't know #{message.body}")
+    end
+  end
+
+  def set_vcard
+    # set vcard info
+     @avatar_sha1 = nil # this gets used later on
+       vcard = Jabber::Vcard::IqVcard.new
+       vcard["FN"] = @name # full name
+       vcard["NICKNAME"] = @name # nickname
+       # buddy icon stuff
+       unless @options.avatar_file.nil?
+        vcard["PHOTO/TYPE"] = "image/png"
+        # open buddy icon/avatar image file
+        image_file = File.new(@options.avatar_file, "r")
+        # Base64 encode the file contents
+        image_b64 = Base64.b64encode(image_file.read())
+        # process sha1 hash of photo contents
+        # this is used by the presence setting
+        image_file.rewind # must rewind the file to the beginning
+        @avatar_sha1 = Digest::SHA1.hexdigest(image_file.read())
+        vcard["PHOTO/BINVAL"] = image_b64 # set the BINVAL to the Base64 encoded contents of our image
+       end
+       begin
+         # create a vcard helper and immediately set the vcard info
+         @logger.info "Setting Vcard"
+         vcard_helper = Jabber::Vcard::Helper.new(@jabber.client).set(vcard)
+       rescue
+         @logger.error "Vcard operation timed out."
+       end
+    return true
+  end
+
+  def set_avatar(pres)
+    if not @avatar_sha1.nil?
+      # send the sha1 hash of the avatar to the server
+      # as per the RFC http://www.xmpp.org/extensions/xep-0153.html
+      x = REXML::Element::new("x")
+      x.add_namespace('vcard-temp:x:update')
+      photo = REXML::Element::new("photo")
+      # this is the avatar hash as computed in the vcard thread above
+      avatar_hash = REXML::Text.new(@avatar_sha1)
+      # add text to photo
+      photo.add(avatar_hash)
+      # add photo to x
+      x.add(photo)
+      # add x to presence
+      pres.add_element(x)
+    end
+  end
+
+  def add_admins
+    @options.admin_jids.each do |jid|
+      @jabber.add jid
+      @logger.debug "Added admin #{jid}"
+    end
+  end
+
+
+
+end

data/lib/tunecore-announcer.rb

@@ -0,0 +1,14 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module TunecoreAnnouncer
+  VERSION = '0.0.1'
+
+  require "optparse"
+  require 'ostruct'
+  require 'rubygems'
+  require 'xmpp4r-simple/xmpp4r-simple'
+  require 'tunecore-announcer/utils'
+  require 'tunecore-announcer/logger'
+  require 'tunecore-announcer/xmpp_connection'
+end

data/lib/xmpp4r-simple/xmpp4r-simple.rb

@@ -0,0 +1,528 @@
+# Jabber::Simple - An extremely easy-to-use Jabber client library.
+# Copyright 2006 Blaine Cook <blaine@obvious.com>, Obvious Corp.
+#
+# Jabber::Simple is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# Jabber::Simple is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Jabber::Simple; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+require 'rubygems'
+require 'xmpp4r'
+require 'xmpp4r/roster'
+require 'xmpp4r/vcard'
+
+module Jabber
+
+  class ConnectionError < StandardError #:nodoc:
+  end
+
+  class RegistrationError < StandardError #:nodoc:
+  end
+
+  class Contact #:nodoc:
+
+    include DRb::DRbUndumped if defined?(DRb::DRbUndumped)
+
+    def initialize(client, jid)
+      @jid = jid.respond_to?(:resource) ? jid : JID.new(jid)
+      @client = client
+    end
+
+    def inspect
+      "Jabber::Contact #{jid.to_s}"
+    end
+
+    def subscribed?
+      [:to, :both].include?(subscription)
+    end
+
+    def subscription
+      roster_item && roster_item.subscription
+    end
+
+    def ask_for_authorization!
+      subscription_request = Presence.new.set_type(:subscribe)
+      subscription_request.to = jid
+      client.send!(subscription_request)
+    end
+
+    def unsubscribe!
+      unsubscription_request = Presence.new.set_type(:unsubscribe)
+      unsubscription_request.to = jid
+      client.send!(unsubscription_request)
+      client.send!(unsubscription_request.set_type(:unsubscribed))
+    end
+
+    def jid(bare=true)
+      bare ? @jid.strip : @jid
+    end
+
+    private
+
+    def roster_item
+      client.roster.items[jid]
+    end
+
+    def client
+      @client
+    end
+  end
+
+  class Simple
+
+    include DRb::DRbUndumped if defined?(DRb::DRbUndumped)
+
+    def self.register(jid, password, status = nil, status_message = "Available")
+      new(jid, password, status, status_message, true)
+    end
+
+    # Create a new Jabber::Simple client. You will be automatically connected
+    # to the Jabber server and your status message will be set to the string
+    # passed in as the status_message argument.
+    #
+    # jabber = Jabber::Simple.new("me@example.com", "password", "Chat with me - Please!")
+    def initialize(jid, password, status = nil, status_message = "Available", register = false)
+      @jid = jid
+      @password = password
+      @disconnected = false
+      register!(password) if @register = register
+      status(status, status_message)
+      start_deferred_delivery_thread
+    end
+
+    def inspect #:nodoc:
+      "Jabber::Simple #{@jid}"
+    end
+
+    # Send a message to jabber user jid.
+    #
+    # Valid message types are:
+    #
+    #   * :normal (default): a normal message.
+    #   * :chat: a one-to-one chat message.
+    #   * :groupchat: a group-chat message.
+    #   * :headline: a "headline" message.
+    #   * :error: an error message.
+    #
+    # If the recipient is not in your contacts list, the message will be queued
+    # for later delivery, and the Contact will be automatically asked for
+    # authorization (see Jabber::Simple#add).
+    #
+    # message should be a string or a valid Jabber::Message object. In either case,
+    # the message recipient will be set to jid.
+    def deliver(jid, message, type=:chat)
+      contacts(jid) do |friend|
+        unless subscribed_to? friend
+          add(friend.jid)
+          return deliver_deferred(friend.jid, message, type)
+        end
+        if message.kind_of?(Jabber::Message)
+          msg = message
+          msg.to = friend.jid
+        else
+          msg = Message.new(friend.jid)
+          msg.type = type
+          msg.body = message
+        end
+        send!(msg)
+      end
+    end
+
+    # Set your presence, with a message.
+    #
+    # Available values for presence are:
+    #
+    #   * nil: online.
+    #   * :chat: free for chat.
+    #   * :away: away from the computer.
+    #   * :dnd: do not disturb.
+    #   * :xa: extended away.
+    #
+    # It's not possible to set an offline status - to do that, disconnect! :-)
+    def status(presence, message)
+      @presence = presence
+      @status_message = message
+      stat_msg = Presence.new(@presence, @status_message)
+      send!(stat_msg)
+    end
+
+    # Ask the users specified by jids for authorization (i.e., ask them to add
+    # you to their contact list). If you are already in the user's contact list,
+    # add() will not attempt to re-request authorization. In order to force
+    # re-authorization, first remove() the user, then re-add them.
+    #
+    # Example usage:
+    #
+    #   jabber_simple.add("friend@friendosaurus.com")
+    #
+    # Because the authorization process might take a few seconds, or might
+    # never happen depending on when (and if) the user accepts your
+    # request, results are placed in the Jabber::Simple#new_subscriptions queue.
+    def add(*jids)
+      contacts(*jids) do |friend|
+        next if subscribed_to? friend
+        friend.ask_for_authorization!
+      end
+    end
+
+    # Remove the jabber users specified by jids from the contact list.
+    def remove(*jids)
+      contacts(*jids) do |unfriend|
+        unfriend.unsubscribe!
+      end
+    end
+
+    # Returns true if this Jabber account is subscribed to status updates for
+    # the jabber user jid, false otherwise.
+    def subscribed_to?(jid)
+      contacts(jid) do |contact|
+        return contact.subscribed?
+      end
+    end
+
+    # If contacts is a single contact, returns a Jabber::Contact object
+    # representing that user; if contacts is an array, returns an array of
+    # Jabber::Contact objects.
+    #
+    # When called with a block, contacts will yield each Jabber::Contact object
+    # in turn. This is mainly used internally, but exposed as an utility
+    # function.
+    def contacts(*contacts, &block)
+      @contacts ||= {}
+      contakts = []
+      contacts.each do |contact|
+        jid = contact.to_s
+        unless @contacts[jid]
+          @contacts[jid] = contact.respond_to?(:ask_for_authorization!) ? contact : Contact.new(self, contact)
+        end
+        yield @contacts[jid] if block_given?
+        contakts << @contacts[jid]
+      end
+      contakts.size > 1 ? contakts : contakts.first
+    end
+
+    # Returns true if the Jabber client is connected to the Jabber server,
+    # false otherwise.
+    def connected?
+      @client ||= nil
+      connected = @client.respond_to?(:is_connected?) && @client.is_connected?
+      return connected
+    end
+
+    # Returns an array of messages received since the last time
+    # received_messages was called. Passing a block will yield each message in
+    # turn, allowing you to break part-way through processing (especially
+    # useful when your message handling code is not thread-safe (e.g.,
+    # ActiveRecord).
+    #
+    # e.g.:
+    #
+    #   jabber.received_messages do |message|
+    #     puts "Received message from #{message.from}: #{message.body}"
+    #   end
+    def received_messages(&block)
+      dequeue(:received_messages, &block)
+    end
+
+    # Returns true if there are unprocessed received messages waiting in the
+    # queue, false otherwise.
+    def received_messages?
+      !queue(:received_messages).empty?
+    end
+
+    # Returns an array of presence updates received since the last time
+    # presence_updates was called. Passing a block will yield each update in
+    # turn, allowing you to break part-way through processing (especially
+    # useful when your presence handling code is not thread-safe (e.g.,
+    # ActiveRecord).
+    #
+    # e.g.:
+    #
+    #   jabber.presence_updates do |friend, new_presence|
+    #     puts "Received presence update from #{friend}: #{new_presence}"
+    #   end
+    def presence_updates(&block)
+      updates = []
+      @presence_mutex.synchronize do
+        dequeue(:presence_updates) do |friend|
+          presence = @presence_updates[friend]
+          next unless presence
+          new_update = [friend, presence[0], presence[1]]
+          yield new_update if block_given?
+          updates << new_update
+          @presence_updates.delete(friend)
+        end
+      end
+      return updates
+    end
+
+    # Returns true if there are unprocessed presence updates waiting in the
+    # queue, false otherwise.
+    def presence_updates?
+      !queue(:presence_updates).empty?
+    end
+
+    # Returns an array of subscription notifications received since the last
+    # time new_subscriptions was called. Passing a block will yield each update
+    # in turn, allowing you to break part-way through processing (especially
+    # useful when your subscription handling code is not thread-safe (e.g.,
+    # ActiveRecord).
+    #
+    # e.g.:
+    #
+    #   jabber.new_subscriptions do |friend, presence|
+    #     puts "Received presence update from #{friend.to_s}: #{presence}"
+    #   end
+    def new_subscriptions(&block)
+      dequeue(:new_subscriptions, &block)
+    end
+
+    # Returns true if there are unprocessed presence updates waiting in the
+    # queue, false otherwise.
+    def new_subscriptions?
+      !queue(:new_subscriptions).empty?
+    end
+
+    # Returns an array of subscription notifications received since the last
+    # time subscription_requests was called. Passing a block will yield each update
+    # in turn, allowing you to break part-way through processing (especially
+    # useful when your subscription handling code is not thread-safe (e.g.,
+    # ActiveRecord).
+    #
+    # e.g.:
+    #
+    #   jabber.subscription_requests do |friend, presence|
+    #     puts "Received presence update from #{friend.to_s}: #{presence}"
+    #   end
+    def subscription_requests(&block)
+      dequeue(:subscription_requests, &block)
+    end
+
+    # Returns true if auto-accept subscriptions (friend requests) is enabled
+    # (default), false otherwise.
+    def accept_subscriptions?
+      @accept_subscriptions = true if @accept_subscriptions.nil?
+      @accept_subscriptions
+    end
+
+    # Change whether or not subscriptions (friend requests) are automatically accepted.
+    def accept_subscriptions=(accept_status)
+      @accept_subscriptions = accept_status
+    end
+
+    # Direct access to the underlying Roster helper.
+    def roster
+      return @roster if @roster
+      self.roster = Roster::Helper.new(client)
+    end
+
+    # Direct access to the underlying Jabber client.
+    def client
+      connect!() unless connected?
+      @client
+    end
+
+    def send!(msg)
+      attempt! {
+        client.send(msg)
+      }
+    end
+
+    def register!(password)
+      attempt! {
+        begin
+          client.register(password)
+          @register = false
+          disconnect
+          reconnect
+        rescue  => e
+          error_msg = "Error registering: #{e.error.text}\n\n"
+          if e.error.type == :modify
+            error_msg += "Accepted registration information:\n"
+            instructions, fields = client.register_info
+            fields.each { |info|
+              error_msg += "* #{info}\n"
+            }
+            error_msg += "(#{instructions})"
+          end
+          raise RegistrationError, error_msg
+        end
+      }
+    end
+
+    # Send a Jabber stanza over-the-wire.
+    def attempt!
+      attempts = 0
+      begin
+        attempts += 1
+        yield
+      rescue Errno::EPIPE, IOError => e
+        sleep 1
+        disconnect
+        reconnect
+        retry unless attempts > 3
+        raise e
+      rescue Errno::ECONNRESET => e
+        sleep (attempts^2) * 60 + 60
+        disconnect
+        reconnect
+        retry unless attempts > 3
+        raise e
+      end
+    end
+
+    # Use this to force the client to reconnect after a force_disconnect.
+    def reconnect
+      @disconnected = false
+      connect!
+    end
+
+    # Use this to force the client to disconnect and not automatically
+    # reconnect.
+    def disconnect
+      disconnect!
+    end
+
+    # Queue messages for delivery once a user has accepted our authorization
+    # request. Works in conjunction with the deferred delivery thread.
+    #
+    # You can use this method if you want to manually add friends and still
+    # have the message queued for later delivery.
+    def deliver_deferred(jid, message, type)
+      msg = {:to => jid, :message => message, :type => type}
+      queue(:pending_messages) << [msg]
+    end
+
+    private
+
+    def client=(client)
+      self.roster = nil # ensure we clear the roster, since that's now associated with a different client.
+      @client = client
+    end
+
+    def roster=(new_roster)
+      @roster = new_roster
+    end
+
+    def connect!
+      raise ConnectionError, "Connections are disabled - use Jabber::Simple::force_connect() to reconnect." if @disconnected
+      # Pre-connect
+      @connect_mutex ||= Mutex.new
+
+      # don't try to connect if another thread is already connecting.
+      return if @connect_mutex.locked?
+
+      @connect_mutex.lock
+      disconnect!(false) if connected?
+
+      # Connect
+      jid = JID.new(@jid)
+      my_client = Client.new(@jid)
+      my_client.connect
+      my_client.auth(@password) unless @register
+      self.client = my_client
+
+      # Post-connect
+      register_default_callbacks
+      status(@presence, @status_message) unless @register
+      @connect_mutex.unlock
+    end
+
+    def disconnect!(auto_reconnect = true)
+      if client.respond_to?(:is_connected?) && client.is_connected?
+        begin
+          client.close
+        rescue Errno::EPIPE, IOError => e
+          # probably should log this.
+          nil
+        end
+      end
+      client = nil
+      @disconnected = auto_reconnect
+    end
+
+    def register_default_callbacks
+      client.add_message_callback do |message|
+        queue(:received_messages) << message unless message.body.nil?
+      end
+
+      roster.add_subscription_callback do |roster_item, presence|
+        if presence.type == :subscribed
+          queue(:new_subscriptions) << [roster_item, presence]
+        end
+      end
+
+      roster.add_subscription_request_callback do |roster_item, presence|
+        if accept_subscriptions?
+          roster.accept_subscription(presence.from)
+        else
+          queue(:subscription_requests) << [roster_item, presence]
+        end
+      end
+
+      @presence_updates = {}
+      @presence_mutex = Mutex.new
+      roster.add_presence_callback do |roster_item, old_presence, new_presence|
+        simple_jid = roster_item.jid.strip.to_s
+        presence = case new_presence.type
+                   when nil: new_presence.show || :online
+                   when :unavailable: :unavailable
+                   else
+                     nil
+                   end
+
+        if presence && @presence_updates[simple_jid] != presence
+          queue(:presence_updates) << simple_jid
+          @presence_mutex.synchronize { @presence_updates[simple_jid] = [presence, new_presence.status] }
+        end
+      end
+    end
+
+    # This thread facilitates the delivery of messages to users who haven't yet
+    # accepted an invitation from us. When we attempt to deliver a message, if
+    # the user hasn't subscribed, we place the message in a queue for later
+    # delivery. Once a user has accepted our authorization request, we deliver
+    # any messages that have been queued up in the meantime.
+    def start_deferred_delivery_thread #:nodoc:
+      Thread.new {
+        loop {
+          messages = [queue(:pending_messages).pop].flatten
+          messages.each do |message|
+            if subscribed_to?(message[:to])
+              deliver(message[:to], message[:message], message[:type])
+            else
+              queue(:pending_messages) << message
+            end
+          end
+        }
+      }
+    end
+
+    def queue(queue)
+      @queues ||= Hash.new { |h,k| h[k] = Queue.new }
+      @queues[queue]
+    end
+
+    def dequeue(queue, non_blocking = true, max_items = 100, &block)
+      queue_items = []
+      max_items.times do
+        queue_item = queue(queue).pop(non_blocking) rescue nil
+        break if queue_item.nil?
+        queue_items << queue_item
+        yield queue_item if block_given?
+      end
+      queue_items
+    end
+  end
+end
+
+true

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/tunecore-announcer.rb'}"
+puts "Loading tunecore-announcer gem"
+exec "#{irb} #{libs} --simple-prompt"