root/lib/cyborghood/cyborg/interface.rb @ 45333094
| d1e614b5 | Marc Dequènes (Duck) | #--
|
|
# CyborgHood, a distributed system management software.
|
|||
# Copyright (c) 2009-2010 Marc Dequènes (Duck) <Duck@DuckCorp.org>
|
|||
#
|
|||
# This program 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 3 of the License, or
|
|||
# (at your option) any later version.
|
|||
#
|
|||
# This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
|
|||
#++
|
|||
require 'singleton'
|
|||
module CyborgHood
|
|||
| b7f7d214 | Marc Dequènes (Duck) | # the base mixin (not intended to be used directly, but...)
|
|
| 8fcaacd6 | Marc Dequènes (Duck) | module CyborgServerInterfaceBase
|
|
| 2c547ffe | Marc Dequènes (Duck) | NODE_PATTERN = "((?:\/|(?:\/[a-zA-Z0-9._]+)+[?=]?))"
|
|
| 8fcaacd6 | Marc Dequènes (Duck) | ||
def self.included(base)
|
|||
| bc473567 | Marc Dequènes (Duck) | base.extend(ClassMethods)
|
|
end
|
|||
| d1e614b5 | Marc Dequènes (Duck) | ||
| 1c89625f | Marc Dequènes (Duck) | module ClassMethods
|
|
| a3483167 | Marc Dequènes (Duck) | attr_accessor :exported_methods
|
|
attr_accessor :auto_export_public_instance_methods
|
|||
| d5495a1e | Marc Dequènes (Duck) | def export_method(*syms)
|
|
| a3483167 | Marc Dequènes (Duck) | syms = [syms] unless syms.is_a? Array
|
|
self.exported_methods ||= []
|
|||
self.exported_methods += syms.collect{|m| m.to_s }
|
|||
end
|
|||
| 8fcaacd6 | Marc Dequènes (Duck) | ||
| d5495a1e | Marc Dequènes (Duck) | def unexport_method(*syms)
|
|
| 8fcaacd6 | Marc Dequènes (Duck) | syms = [syms] unless syms.is_a? Array
|
|
self.exported_methods ||= []
|
|||
self.exported_methods -= syms.collect{|m| m.to_s }
|
|||
end
|
|||
def export_parent_methods
|
|||
| d5495a1e | Marc Dequènes (Duck) | self.export_method *self.superclass.public_instance_methods(false)
|
|
| 8fcaacd6 | Marc Dequènes (Duck) | end
|
|
| 69a12fdb | Marc Dequènes (Duck) | ||
def is_node?(node)
|
|||
(node =~ NODE_PATTERN) ? true : false
|
|||
end
|
|||
| ce98dac2 | Marc Dequènes (Duck) | end
|
|
| 8fcaacd6 | Marc Dequènes (Duck) | def initialize(*args)
|
|
super(*args)
|
|||
| d1e614b5 | Marc Dequènes (Duck) | @config = Config.instance
|
|
| a3483167 | Marc Dequènes (Duck) | ||
self.class.exported_methods ||= []
|
|||
self.class.auto_export_public_instance_methods = true
|
|||
| d1e614b5 | Marc Dequènes (Duck) | end
|
|
| 69a12fdb | Marc Dequènes (Duck) | # convenience method
|
|
def is_node?(node)
|
|||
self.class.is_node?(node)
|
|||
end
|
|||
| 1c89625f | Marc Dequènes (Duck) | def api_klasses
|
|
list = self.class.constants.collect do |c|
|
|||
| d1e614b5 | Marc Dequènes (Duck) | cc = self.class.const_get(c)
|
|
| 8fcaacd6 | Marc Dequènes (Duck) | (cc.class == Class and cc.ancestors.include? CyborgHood::CyborgServerInterfaceBase) ? [c, cc] : nil
|
|
| 1c89625f | Marc Dequènes (Duck) | end.compact
|
|
Hash[list]
|
|||
| d1e614b5 | Marc Dequènes (Duck) | end
|
|
def api_methods
|
|||
| a3483167 | Marc Dequènes (Duck) | methods = self.class.exported_methods
|
|
methods += self.class.public_instance_methods(false) if self.class.auto_export_public_instance_methods
|
|||
| e82a264b | Marc Dequènes (Duck) | methods -= ["initialize", "__destroy", "method_missing"]
|
|
| a3483167 | Marc Dequènes (Duck) | methods & self.methods
|
|
| d1e614b5 | Marc Dequènes (Duck) | end
|
|
| 23b2305f | Marc Dequènes (Duck) | def api_container_methods
|
|
[]
|
|||
end
|
|||
def api_containers
|
|||
(api_klasses.keys + api_container_methods).sort
|
|||
end
|
|||
def api_leafs
|
|||
(api_methods - api_container_methods).sort
|
|||
end
|
|||
| 1c89625f | Marc Dequènes (Duck) | def api_nodes
|
|
(api_klasses.keys + api_methods).sort
|
|||
end
|
|||
| e82a264b | Marc Dequènes (Duck) | def find_node_action(session, node_name)
|
|
| 2c547ffe | Marc Dequènes (Duck) | node_name.gsub!(/^\//, "")
|
|
| 8fcaacd6 | Marc Dequènes (Duck) | next_node_name, other_nodes_names = node_name.split('/', 2)
|
|
| 41802ec1 | Marc Dequènes (Duck) | ||
| 2c547ffe | Marc Dequènes (Duck) | next_node_klass = next_node_name.nil? ? self.class : api_klasses[next_node_name]
|
|
| 8fcaacd6 | Marc Dequènes (Duck) | # inner class or method ?
|
|
| 41802ec1 | Marc Dequènes (Duck) | if next_node_klass.nil?
|
|
| 8fcaacd6 | Marc Dequènes (Duck) | # method is declared ?
|
|
| 41802ec1 | Marc Dequènes (Duck) | if api_methods.include? next_node_name
|
|
| 8fcaacd6 | Marc Dequènes (Duck) | # final node ?
|
|
| f9971af0 | Marc Dequènes (Duck) | if other_nodes_names.blank?
|
|
| 8fcaacd6 | Marc Dequènes (Duck) | # cannot use method(), as this method may not exist at all (but still
|
|
# be usuable through metaprogramming
|
|||
return lambda do |*args|
|
|||
| e82a264b | Marc Dequènes (Duck) | r = child_node(next_node_name, session, *args)
|
|
| 8fcaacd6 | Marc Dequènes (Duck) | # dynamic tree construction: method may return a node
|
|
| e82a264b | Marc Dequènes (Duck) | if r.is_a? CyborgHood::CyborgServerInterfaceBase
|
|
| 8fcaacd6 | Marc Dequènes (Duck) | r.api_nodes
|
|
else
|
|||
r
|
|||
end
|
|||
end
|
|||
end
|
|||
| 23b2305f | Marc Dequènes (Duck) | # not a container, leaving
|
|
return unless self.api_container_methods.include? next_node_name
|
|||
| e82a264b | Marc Dequènes (Duck) | next_node = child_node(next_node_name, session)
|
|
| 41802ec1 | Marc Dequènes (Duck) | else
|
|
| 8fcaacd6 | Marc Dequènes (Duck) | # unknown method
|
|
| 41802ec1 | Marc Dequènes (Duck) | return
|
|
end
|
|||
else
|
|||
next_node = next_node_klass.instance
|
|||
| 8fcaacd6 | Marc Dequènes (Duck) | # final node ?
|
|
| f9971af0 | Marc Dequènes (Duck) | return next_node.method('api_nodes') if other_nodes_names.blank?
|
|
| 41802ec1 | Marc Dequènes (Duck) | end
|
|
| 8fcaacd6 | Marc Dequènes (Duck) | # search deeper
|
|
| e82a264b | Marc Dequènes (Duck) | if next_node.is_a? CyborgHood::CyborgServerInterfaceBase
|
|
next_node.find_node_action(session, other_nodes_names)
|
|||
| 8fcaacd6 | Marc Dequènes (Duck) | else
|
|
# it is not a node, so there are no children
|
|||
return
|
|||
end
|
|||
| 41802ec1 | Marc Dequènes (Duck) | end
|
|
| e82a264b | Marc Dequènes (Duck) | def child_node(next_node_name, session, *args)
|
|
args.unshift session if self.is_a? CyborgHood::CyborgServerStatefulInterface
|
|||
self.send(next_node_name, *args)
|
|||
end
|
|||
| 41802ec1 | Marc Dequènes (Duck) | def has_node?(cmd)
|
|
| e82a264b | Marc Dequènes (Duck) | not find_node_action(nil, cmd).nil?
|
|
| 41802ec1 | Marc Dequènes (Duck) | end
|
|
| d1e614b5 | Marc Dequènes (Duck) | # preliminary incoming message handling
|
|
| e82a264b | Marc Dequènes (Duck) | def call(session, cmd, data)
|
|
action = find_node_action(session, cmd)
|
|||
| 69a12fdb | Marc Dequènes (Duck) | raise "unknown node" if action.nil?
|
|
| d1e614b5 | Marc Dequènes (Duck) | ||
| 69a12fdb | Marc Dequènes (Duck) | raise "wrong format for arguments" unless data.is_a? Array
|
|
| f94d64b1 | Marc Dequènes (Duck) | ||
| d1e614b5 | Marc Dequènes (Duck) | begin
|
|
| 69a12fdb | Marc Dequènes (Duck) | action.call(*data)
|
|
| d1e614b5 | Marc Dequènes (Duck) | rescue
|
|
| ca79e27e | Marc Dequènes (Duck) | logger.debug "node action error message: " + $!
|
|
logger.debug "node action error backtrace: " + $!.backtrace.join("\n")
|
|||
| 69a12fdb | Marc Dequènes (Duck) | raise "method call failed: " + $!
|
|
| d1e614b5 | Marc Dequènes (Duck) | end
|
|
end
|
|||
end
|
|||
| b7f7d214 | Marc Dequènes (Duck) | # structural mixins
|
|
module CyborgServerInterface
|
|||
def self.included(base)
|
|||
base.class_eval("include CyborgServerInterfaceBase")
|
|||
base.class_eval("include Singleton")
|
|||
base.extend(ClassMethods)
|
|||
end
|
|||
module ClassMethods
|
|||
def dynamic_interface(&resource_generator)
|
|||
class_eval do
|
|||
class_inheritable_reader :resource_generator
|
|||
def method_missing(method_name, *args)
|
|||
node_name = method_name.to_s
|
|||
if api_methods.include?(node_name)
|
|||
self.resource_generator.call(node_name)
|
|||
else
|
|||
super
|
|||
end
|
|||
end
|
|||
end
|
|||
write_inheritable_attribute(:resource_generator, resource_generator)
|
|||
end
|
|||
end
|
|||
end
|
|||
module CyborgServerEmbeddedInterface
|
|||
def self.included(base)
|
|||
base.class_eval("include CyborgServerInterfaceBase")
|
|||
base.export_parent_methods
|
|||
end
|
|||
end
|
|||
module CyborgServerStatefulInterface
|
|||
def self.included(base)
|
|||
base.class_eval("include CyborgServerInterfaceBase")
|
|||
| 6d0df946 | Marc Dequènes (Duck) | base.class_eval("include Singleton")
|
|
| b7f7d214 | Marc Dequènes (Duck) | base.extend(ClassMethods)
|
|
end
|
|||
module ClassMethods
|
|||
def stateful_dynamic_interface(resource_key_pattern, &resource_generator)
|
|||
class_eval do
|
|||
class_inheritable_reader :resource_key_pattern, :resource_generator
|
|||
def method_missing(method_name, *args)
|
|||
session = args.shift
|
|||
node_name = method_name.to_s
|
|||
if api_methods.include?(node_name)
|
|||
resource_key = self.resource_key_pattern.gsub("#NODE#", node_name)
|
|||
session.store.get(resource_key) { self.resource_generator.call(node_name) }
|
|||
else
|
|||
super
|
|||
end
|
|||
end
|
|||
end
|
|||
write_inheritable_attribute(:resource_key_pattern, resource_key_pattern)
|
|||
write_inheritable_attribute(:resource_generator, resource_generator)
|
|||
end
|
|||
end
|
|||
end
|
|||
# additional mixin
|
|||
module CyborgServerRootInterfaceAddon
|
|||
| ce98dac2 | Marc Dequènes (Duck) | PROTOCOL_VERSION = "0.1~"
|
|
| d1e614b5 | Marc Dequènes (Duck) | ||
| a3483167 | Marc Dequènes (Duck) | def self.included(base)
|
|
list = self.public_instance_methods(false)
|
|||
base.class_eval do
|
|||
export_method list
|
|||
end
|
|||
end
|
|||
def product_name
|
|||
| d1e614b5 | Marc Dequènes (Duck) | PRODUCT
|
|
end
|
|||
| a3483167 | Marc Dequènes (Duck) | def product_version
|
|
| d1e614b5 | Marc Dequènes (Duck) | VERSION
|
|
end
|
|||
| a3483167 | Marc Dequènes (Duck) | def protocol_version
|
|
| ce98dac2 | Marc Dequènes (Duck) | PROTOCOL_VERSION
|
|
| d1e614b5 | Marc Dequènes (Duck) | end
|
|
| a3483167 | Marc Dequènes (Duck) | def bot_name
|
|
| d1e614b5 | Marc Dequènes (Duck) | @config.bot_name
|
|
end
|
|||
end
|
|||
end
|