pione 0.1.0

data/lib/pione/agent/tuple-space-client.rb

@@ -0,0 +1,146 @@
+module Pione
+  module Agent
+    module TupleSpaceClientOperation
+      # Sends a bye message to the tuple space servers and terminate myself.
+      def finalize
+        unless current_state == :terminated
+          bye
+          terminate
+        end
+      end
+
+      # Send a hello message to the tuple space server.
+      def hello
+        write(to_agent_tuple)
+      end
+
+      # Send a bye message to the tuple space server.
+      def bye
+        Util.ignore_exception do
+          write(to_bye_tuple)
+        end
+      end
+
+      # Makes the agent tuple.
+      # @return [Tuple::Agent]
+      #   the agent tuple
+      def to_agent_tuple
+        Tuple[:agent].new(agent_type: agent_type, uuid: uuid)
+      end
+
+      # Makes the bye tuple.
+      # @return [Tuple::Bye]
+      #   the bye tuple
+      def to_bye_tuple
+        Tuple[:bye].new(agent_type: agent_type, uuid: uuid)
+      end
+
+      # Notify the agent happened a exception.
+      def notify_exception(e)
+        # ignore exception because the exception caused tuple server is down...
+        Util.ignore_exception do
+          write(Tuple[:exception].new(uuid, agent_type, e))
+        end
+      end
+
+      # Protected take.
+      def take(*args)
+        tuple = super(*args, &method(:set_current_tuple_entry))
+        set_current_tuple_entry(nil)
+        return tuple
+      end
+
+      # Protected read.
+      def read(*args)
+        tuple = super(*args, &method(:set_current_tuple_entry))
+        set_current_tuple_entry(nil)
+        return tuple
+      end
+
+      private
+
+      # Return current tuple's entry.
+      def current_tuple_entry
+        @__current_tuple_entry__
+      end
+
+      # Set current operating tuple entry.
+      def set_current_tuple_entry(entry)
+        @__current_tuple_entry__ = entry
+        entry.instance_eval {if @place then def @place.to_s; ""; end; end }
+      end
+
+      # Cancel current tuple's entry.
+      def cancel_current_tuple_entry
+        current_tuple_entry.cancel if current_tuple_entry
+      end
+    end
+
+    class TupleSpaceClient < BasicAgent
+      include TupleSpaceServerInterface
+      include TupleSpaceClientOperation
+
+      # Initialize agent's state.
+      def initialize(tuple_space_server)
+        super()
+        set_tuple_space_server(tuple_space_server)
+      end
+
+      def start
+        super()
+        return self
+      end
+
+      # State initialized.
+      def transit_to_initialized
+        hello
+      end
+
+      # State terminated
+      def transit_to_terminated
+        Util.ignore_exception { bye }
+        cancel_current_tuple_entry
+      end
+
+      # State error
+      def transit_to_error(e)
+        if e
+          $stderr.puts e
+          $stderr.puts e.backtrace
+        end
+        notify_exception(e)
+        terminate
+      end
+
+      # Redefine hello method with logging.
+      def hello
+        log do |msg|
+          msg.add_record(agent_type, "action", "hello")
+          msg.add_record(agent_type, "uuid", uuid)
+        end
+        super
+      end
+
+      # Redefine bye method with logging.
+      def bye
+        log do |msg|
+          msg.add_record(agent_type, "action", "bye")
+          msg.add_record(agent_type, "uuid", uuid)
+        end
+        super
+      end
+
+      # Redefine call transition method with logging.
+      def call_transition_method(*args)
+        unless [:logger, :command_listener].include?(agent_type)
+          log do |msg|
+            msg.add_record(agent_type, "action", "transit")
+            msg.add_record(agent_type, "state", args.first)
+            msg.add_record(agent_type, "uuid", uuid)
+          end
+        end
+        super
+      end
+    end
+  end
+end

data/lib/pione/agent/tuple-space-server-client-life-checker.rb

@@ -0,0 +1,29 @@
+module Pione
+  module Agent
+    class TupleSpaceServerClientLifeChecker < BasicAgent
+      include TupleSpaceServerInterface
+
+      define_state :checking_bye
+      define_state :cleaning_agent
+      define_state :sleeping
+
+      define_state_transition :initialized => :checking_bye
+      define_state_transition :checking_bye => :cleaning_agent
+      define_state_transition :cleaning_agent => :checking_bye
+
+      def initialize(tuple_space_server)
+        super()
+        set_tuple_space_server(tuple_space_server)
+      end
+
+      def transit_to_checking_bye
+        return take(Tuple[:bye].any)
+      end
+
+      def transit_to_cleaning_agent(bye)
+        take(Tuple[:agent].new(uuid: bye.uuid))
+        return nil
+      end
+    end
+  end
+end

data/lib/pione/command-option/basic-option.rb

@@ -0,0 +1,42 @@
+module Pione
+  module CommandOption
+    module OptionInterface
+      # @api private
+      def self.extended(klass)
+        klass.instance_variable_set(:@command_options, {})
+      end
+
+      # Defines an option for the command.
+      # @return [void]
+      def define_option(*args, &b)
+        @command_options[args.first] = [args, b]
+      end
+
+      # Removes the option.
+      # @return [void]
+      def remove_option(name)
+        @command_options.delete(name)
+      end
+
+      # Returns the command options.
+      # @return [Array]
+      def command_options
+        @command_options
+      end
+
+      # Installs the option module.
+      # @return [void]
+      def use_option_module(mod)
+        @command_options = @command_options.update(mod.command_options)
+      end
+    end
+
+    class BasicOption
+      extend OptionInterface
+
+      def self.inherited(klass)
+        klass.instance_variable_set(:@command_options, command_options.clone)
+      end
+    end
+  end
+end

data/lib/pione/command-option/child-process-option.rb

@@ -0,0 +1,17 @@
+module Pione
+  module CommandOption
+    module ChildProcessOption
+      extend OptionInterface
+
+      # --parent-front
+      define_option('--parent-front=URI', 'set parent front URI') do |uri|
+        @parent_front = DRbObject.new_with_uri(uri)
+      end
+
+      # --no-parent
+      define_option('--no-parent', 'turn on no parent mode') do
+        @no_parent_mode = true
+      end
+    end
+  end
+end

data/lib/pione/command-option/common-option.rb

@@ -0,0 +1,29 @@
+module Pione
+  module CommandOption
+    module CommonOption
+      extend OptionInterface
+
+      # --debug
+      define_option('-d', '--debug', "turn on debug mode") do |name|
+        Pione.debug_mode = true
+      end
+
+      # --show-communication
+      define_option('--show-communication', "show object communication") do |show|
+        Global.show_communication = true
+      end
+
+      # --color
+      define_option('--[no-]color', 'turn on/off color mode') do |str|
+        bool = nil
+        bool = true if str == "true"
+        bool = false if str == "false"
+        if bool.nil?
+          puts "invalid color option: %s" % bool
+          exit
+        end
+        Terminal.color_mode = bool
+      end
+    end
+  end
+end

data/lib/pione/command-option/daemon-option.rb

@@ -0,0 +1,12 @@
+module Pione
+  module CommandOption
+    module DaemonOption
+      extend OptionInterface
+
+      # --daemon
+      define_option("--daemon", "turn on daemon mode") do
+        @daemon = true
+      end
+    end
+  end
+end

data/lib/pione/command-option/presence-notifier-option.rb

@@ -0,0 +1,15 @@
+module Pione
+  module CommandOption
+    module PresenceNotifierOption
+      extend OptionInterface
+
+      # --show-presence-notifier
+      define_option(
+        "--show-presence-notifier",
+        "show presence notifier informations"
+      ) do
+        Global.show_presence_notifier = true
+      end
+    end
+  end
+end

data/lib/pione/command-option/task-worker-owner-option.rb

@@ -0,0 +1,17 @@
+module Pione
+  module CommandOption
+    module TaskWorkerOwnerOption
+      extend OptionInterface
+
+      # --task-worker
+      define_option('-t N', '--task-worker=N', 'set task worker number that this process creates') do |n|
+        @task_worker = n.to_i
+      end
+
+      # --features
+      define_option('--features="FEATURES"', 'set features') do |features|
+        @features = features
+      end
+    end
+  end
+end

data/lib/pione/command-option/tuple-space-provider-option.rb

@@ -0,0 +1,26 @@
+module Pione
+  module CommandOption
+    module TupleSpaceProviderOption
+      extend OptionInterface
+      use_option_module PresenceNotifierOption
+
+      # --presence-notification-address
+      define_option(
+        "--presence-notification-address=255.255.255.255:%s" % Global.presence_port,
+        "set the address for sending presence notifier"
+      ) do |address|
+        # clear addresses at first time
+        unless @__option_notifier_address__
+          @__option_notifier_address__ = true
+          Global.presence_notification_addresses = []
+        end
+        # add the address
+        address = address =~ /^broadcast/ ? address : "broadcast://%s" % address
+        uri = URI.parse(address)
+        uri.host = "255.255.255.255" if uri.host.nil?
+        uri.port = Global.presence_port if uri.port.nil?
+        Global.presence_notification_addresses << uri
+      end
+    end
+  end
+end

data/lib/pione/command-option/tuple-space-provider-owner-option.rb

@@ -0,0 +1,16 @@
+module Pione
+  module CommandOption
+    class TupleSpaceProviderOwnerOption
+      extend OptionInterface
+      use_option_module TupleSpaceProviderOption
+
+      # --without-tuple-space-provider
+      define_option(
+        '--without-tuple-space-provider',
+        'process without tuple space provider'
+      ) do
+        @without_tuple_space_provider = true
+      end
+    end
+  end
+end

data/lib/pione/command-option/tuple-space-receiver-option.rb

@@ -0,0 +1,12 @@
+module Pione
+  module CommandOption
+    module TupleSpaceReceiverOption
+      extend OptionInterface
+      use_option_module PresenceNotifierOption
+
+      define_option("--presence-port=PORT", "set presence port number") do |port|
+        Global.presence_port = port.to_i
+      end
+    end
+  end
+end

data/lib/pione/command/basic-command.rb

@@ -0,0 +1,126 @@
+module Pione
+  module Command
+    # OptionInterface provides methods for defining options.
+    module ClassInterface
+      # Returns the program name.
+      def program_name
+        [@program_name, @program_name_block]
+      end
+
+      # Sets progaram name and visible options.
+      def set_program_name(program_name, &b)
+        @program_name = program_name
+        @program_name_block = block_given? ? b : Proc.new{""}
+      end
+
+      # Returns the program message.
+      def program_message
+        @program_message
+      end
+
+      # Sets program message.
+      def set_program_message(message)
+        @program_message = message
+      end
+    end
+
+    module InstanceInterface
+      # Returns program name.
+      # @return [String]
+      #   program name
+      def program_name
+        name, b = self.class.program_name
+        tail = self.instance_exec(&b)
+        "%s %s" % [name, tail]
+      end
+
+      # Returns program message.
+      # @return [String]
+      #   program message
+      def program_message
+        self.class.program_message
+      end
+    end
+
+    # BasicCommand is a base class for PIONE commands.
+    class BasicCommand < PioneObject
+      extend ClassInterface
+      include InstanceInterface
+      extend CommandOption::OptionInterface
+      use_option_module CommandOption::CommonOption
+
+      # @api private
+      def self.inherited(subclass)
+        opts = command_options.clone
+        subclass.instance_eval { @command_options = opts }
+      end
+
+      # Runs the command.
+      def self.run(*args)
+        self.new(*args).run
+      end
+
+      # Runs the command.
+      def run
+        parse_options
+        validate_options
+        prepare
+        $PROGRAM_NAME = program_name
+        start
+      end
+
+      private
+
+      # Parses options.
+      # @return [void]
+      def parse_options
+        parser = OptionParser.new do |opt|
+          opt.banner = "Usage: %s [options]" % opt.program_name
+          opt.banner << "\n" + program_message if program_message
+
+          self.class.command_options.values.sort.each do |args, b|
+            opt.on(*args, Proc.new{|*args| self.instance_exec(*args, &b)})
+          end
+          opt.version = Pione::VERSION
+        end
+
+        parser.parse!(ARGV)
+      rescue OptionParser::InvalidOption => e
+        e.args.each {|arg| $stderr.puts "Unknown option: #{arg}" }
+        abort
+      rescue OptionParser::MissingArgument => e
+        abort(e.message)
+      end
+
+      # Validates options. Override this method if subclasses should check
+      # options.
+      # @return [void]
+      def validate_options
+        # do nothing
+      end
+
+      # Prepares for activity. Override this method if subclass should prepare
+      # before command activity.
+      # @return [void]
+      def prepare
+        Signal.trap(:INT) do
+          begin
+            terminate
+          rescue DRb::ReplyReaderThreadError
+            # ignore reply reader error
+          end
+        end
+      end
+
+      # Starts the command activity. This method should be overridden in subclasses.
+      # @return [void]
+      def start
+        raise NotImplementedError
+      end
+
+      def terminate
+        exit
+      end
+    end
+  end
+end