neerfri-ramf 0.1.0

data/LICENSE

@@ -0,0 +1,166 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+

data/README

@@ -0,0 +1,3 @@
+RAMF - An amf serializer and deserializer for ruby.
+
+(c) Neer Friedman, neerfri@gmail.com, www.neerfri.com

data/Rakefile

@@ -0,0 +1,17 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+require 'rake'
+
+RAKE_BASE = File.dirname(__FILE__)
+CURRENT_VERSION = File.open(File.join(RAKE_BASE, "GEM_VERSION")) do |f|
+  version = nil
+  f.each_line { |l| version = $1 if  l=~/^(\d+\.\d+\.\d+)/ }
+  version ? version : raise("could not find gem version in #{File.join(RAKE_BASE, 'GEM_VERSION')}")
+end
+
+
+Dir["#{File.dirname(__FILE__)}/tasks/**/*.rake"].sort.each { |ext| load ext }
+ 
+
+
+
+

data/lib/ramf/amf_header.rb

@@ -0,0 +1,9 @@
+module RAMF
+  class AMFHeader
+    attr_accessor :name, :value, :must_understand, :length
+    
+    def initialize(name,value,must_understand, length = -1)
+      @name, @value, @must_understand, @length = name, value, must_understand, length
+    end
+  end
+end

data/lib/ramf/amf_message.rb

@@ -0,0 +1,26 @@
+module RAMF
+  class AMFMessage
+    attr_accessor :target_uri, :response_uri, :value, :length, :amf_version
+    KNOWN_MESSAGE_OBJECTS = ["RAMF::FlexObjects::CommandMessage","RAMF::FlexObjects::RemotingMessage"]
+    
+    def initialize(options)
+      @target_uri = options[:target_uri]
+      @response_uri = options[:response_uri]
+      @value = options[:value]
+      @length = options[:length] || -1
+      @amf_version = options[:amf_version] || 3
+    end
+    
+    def to_operation(options = {})
+      if KNOWN_MESSAGE_OBJECTS.include?(@value.first.class.name)
+        @value.first.to_operation
+      else
+        RAMF::OperationRequest.new :method=>RAMF::Util.method_name(target_uri),
+                                   :service=>RAMF::Util.service_name(target_uri),
+                                   :args=>Array(value),
+                                   :credentials=>options[:credentials]
+      end
+    end
+    
+  end
+end

data/lib/ramf/amf_object.rb

@@ -0,0 +1,54 @@
+module RAMF
+  class AMFObject
+    
+    AMF0_VERSION = 0x00
+    AMF3_VERSION = 0x03
+    
+    FP_CLIENT = 0x01 #for Flash Player 8
+    FLASH_COM = 0x01 #for FlashCom/FMS
+    FP9_CLIENT =0x03 #for Flash Player 9
+
+    attr_accessor :version, :client, :headers, :messages
+    
+    def initialize(options={})
+      @version     = options[:version] || AMF3_VERSION
+      @client   = options[:client] || FP9_CLIENT
+      @headers  = options[:headers] || []
+      @messages = options[:messages] || []
+    end
+    
+    def add_header(header)
+      @headers << header
+    end
+    
+    def add_message(message)
+      @messages << message
+    end
+    
+    def get_header_by_key(key)
+      @headers.find {|v| v.name == key.to_s}
+    end
+    
+    def credentials_header
+      (header = get_header_by_key("Credentials")) ? header.value : {:userid => nil, :password => nil}
+    end
+    
+    def process(*processor_args)
+      returning(RAMF::AMFObject.new(:version=>version)) do |response|
+        response.messages = messages.map do |incoming_message|
+          operation = incoming_message.to_operation(:credentials=>credentials_header)
+          begin
+            RAMF::AMFMessage.new :target_uri=>incoming_message.response_uri + "/onResult",
+                                 :response_uri=>"",
+                                 :value=>RAMF::OperationProcessorsManager.process(operation, *processor_args)
+          rescue RAMF::OperationProcessorsManager::ErrorWhileProcessing => e
+            RAMF::AMFMessage.new :target_uri=>incoming_message.response_uri + "/onStatus",
+                                 :response_uri=>"",
+                                 :value=> operation.exception_response(e.original_exception)
+          end
+        end
+      end
+    end
+    
+  end
+end

data/lib/ramf/configuration.rb

@@ -0,0 +1,8 @@
+#this class should hold the different configuration options for RAMF
+module RAMF
+  class Configuration
+    
+    DEFAULT_SCOPE = :default
+    
+  end
+end

data/lib/ramf/default_operation_processor.rb

@@ -0,0 +1,20 @@
+class RAMF::DefaultOperationProcessor
+  class OperationProcessorNotDefined <StandardError; end;
+  
+  #Add self to the operation processors manger list
+  RAMF::OperationProcessorsManager.add_operation_processor(self)
+  
+  
+  class << self
+    
+    #This processor answers all requests, so it will always return true
+    def will_process?(operation, *args)
+      true
+    end
+    
+    #raise a fault saying there is no processor to handle the operation. 
+    def process(operation, *args)
+      raise(OperationProcessorNotDefined, "No Operation processor found to process #{operation.inspect}")
+    end
+  end
+end

data/lib/ramf/deserializer/amf0_reader.rb

@@ -0,0 +1,61 @@
+module RAMF
+  module Deserializer
+    class AMF0Reader
+      include RAMF::IO::Constants
+      include RAMF::IO::CommonReadWrite
+      include RAMF::IO::ReferenceTableUser
+      
+      def initialize(reference_table = nil)
+        register_reference_table(reference_table)
+      end
+      
+      def read_value_type(stream)
+        marker = readU8(stream)
+        case marker
+          when AMF3_TYPE
+            AMF3Reader.new(@reference_table).read_value_type(stream)
+          when AMF0_NUMBER
+            read_double(stream)
+          when AMF0_BOOLEAN
+            (readU8(stream) == 0) ? false : true
+          when AMF0_STRING
+            readUTF8(stream)
+          when AMF0_OBJECT
+            #TODO: implement this
+            readObject(stream)
+          when AMF0_ARRAY
+            read_strict_array(stream)
+          else
+            raise "unknown amf0 value marker 0x%02X" % marker
+        end
+      end
+      
+      
+      
+      def read_strict_array(stream)
+        array_length = readU32(stream)
+        array = []
+        array_length.times do
+          array << read_value_type(stream)
+        end
+        array
+      end
+      
+      def readObject(stream)
+        obj = Object.new
+        member_name = readUTF8(stream)
+        while (member_name != "") do #run until we get to the empty-string marker
+          obj.eval do
+            class << self
+              attr_accessor member_name.to_sym
+            end
+            self.send(member_name+"=",readUTF_8_vr(stream))
+          end
+        end
+      end
+    
+    
+    end
+  end
+end
+    

data/lib/ramf/deserializer/amf3_reader.rb

@@ -0,0 +1,242 @@
+module RAMF
+  module Deserializer
+    class AMF3Reader
+      include RAMF::IO::Constants
+      include RAMF::IO::CommonReadWrite
+      include RAMF::IO::ReferenceTableUser
+      
+      def initialize(reference_table = nil)
+        register_reference_table(reference_table)
+      end
+      
+      def read_value_type(stream)
+        marker = readU8(stream)
+        case marker
+        when AMF3_UNDEFINED
+          nil
+        when AMF3_NULL
+          nil
+        when AMF3_FALSE
+          false
+        when AMF3_TRUE
+          true
+        when AMF3_INTEGER
+          readU29(stream)
+        when AMF3_DOUBLE
+          read_double(stream)
+        when AMF3_STRING
+          readUTF_8_vr(stream)
+        when AMF3_XML_DOC
+          readU29X(stream)
+        when AMF3_XML
+          readU29X(stream)
+        when AMF3_DATE
+          readU29D(stream)
+        when AMF3_ARRAY
+          readU29A(stream)
+        when AMF3_OBJECT
+          readU29O(stream)
+        when AMF3_BYTE_ARRAY
+          readU29B(stream)
+        else
+          raise "unknown amf3 value marker 0x%02X" % marker
+        end
+      end
+
+      private
+      #reads an integer encoded as U29
+      def readU29(stream)
+        result = 0
+        4.times do |i|
+          part = readU8(stream)
+          result = readU29_part(part, i==3, result)
+          break if (part & 0x080)==0
+        end
+        result
+      end
+    
+      def readU29_part(part, is_last, rest)
+        if is_last
+          (rest << 8) | part
+        else
+          (rest << 7) | (part & 0x7f)
+        end
+      end
+      
+      # U29 Strings:
+      def readU29S_value(length,stream)
+        (str = stream.read(length)) == "" ? str : store(:string){str}
+      end
+      
+      def readU29S_ref(ref,stream)
+        #retrive string from reference tables
+        retrive :string, ref
+      end
+      
+      def readU29S(stream)
+        length_or_ref = readU29(stream)
+        #check if the string is a reference or value.
+        (length_or_ref & 0x01) == 0 ? readU29S_ref(length_or_ref>>1, stream) : readU29S_value(length_or_ref>>1, stream)
+      end
+      
+      #U29 Objects:
+      def readU29O(stream)
+        member_count_or_ref = readU29(stream)
+        if (member_count_or_ref & 0x01) == 0
+          readU29O_ref(member_count_or_ref>>1) #The object is a reference
+        elsif (member_count_or_ref & 0x02) == 0
+          readU29O_traits_ref(stream, member_count_or_ref>>2) #the class is a reference, the object is new.
+        elsif (member_count_or_ref & 0x04) == 0x04
+          raise "can't read IExternalizable yet"
+        elsif (member_count_or_ref & 0x08) == 0
+          #new object of a non dynamic class 
+          readU29O_traits(stream, member_count_or_ref>>4, false)
+        else
+          #new object of a dynamic class 
+          readU29O_traits(stream, member_count_or_ref>>4, true)
+        end
+      end
+      
+      def readU29O_ref(ref_id)
+        retrive :object, ref_id
+      end
+      
+      def readU29O_traits_ref(stream,ref_id)
+        flex_class = retrive :class, ref_id
+        readU29O_object_values(stream,flex_class)
+      end
+      
+      def read_object_dynamic_members(stream, obj)
+        member_name = readUTF_8_vr(stream)
+        while (member_name != "") do #run until we get to the empty-string marker
+          obj.class.flex_remoting.dynamic_members_writer.call(obj, member_name, read_value_type(stream))
+          member_name = readUTF_8_vr(stream)
+        end
+        obj
+      end
+      
+      
+      def readU29O_traits(stream, member_count,is_dynamic)
+        class_signature = store :class do
+          RAMF::IO::FlexClassSignature.new(readUTF_8_vr(stream), is_dynamic, read_object_member_names(stream,member_count))
+        end
+#        RAMF::DEBUG_LOG.debug "Created new class signature: #{class_signature.inspect}"
+        readU29O_object_values(stream,class_signature)
+      end
+      
+      def readU29O_object_values(stream,class_signature)
+        store :object do
+          object = load_or_create_object(class_signature)
+          read_object_member_values(stream,class_signature,object)
+          read_object_dynamic_members(stream, object) if class_signature.is_dynamic
+          object
+        end
+      end
+      
+      def load_or_create_object(class_signature)
+        load_or_create_class(class_signature).new
+      end
+      
+      def load_or_create_class(class_signature)
+        return RAMF::FlexClassTraits.find_ruby_class(class_signature.name) if RAMF::FlexClassTraits.find_ruby_class(class_signature.name)
+        class_name = class_signature.name.to_s.split(".").each{|s| s[0,1]=s[0,1].upcase}.join("::")
+        unless class_name=="" || (/\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ class_name)
+         raise NameError, "#{class_name.inspect} is not a valid constant name!"
+        end
+        RAMF::FlexClassTraits.find_ruby_class(class_name) || (Object.module_eval(class_name) rescue create_class(class_signature))
+      end
+      
+      def create_class(class_signature)
+        class_name = class_signature.name.to_s.split(".").each{|s| s[0,1]=s[0,1].upcase}.join("::")
+        begin
+          Object.module_eval("class #{class_name};end;", __FILE__, __LINE__)
+        rescue NameError=>e
+          raise(NameError, "Could not create #{class_name}: #{e.message}")
+        end
+        klass = Object.module_eval(class_name, __FILE__, __LINE__)
+        klass.class_eval do
+          class_signature.members.each {|m| attr_accessor m}
+        end
+#        puts "Created new class:#{klass} with members:#{class_signature.members.join(',')}"
+        klass
+      end
+      
+      def read_object_member_names(stream,member_count)
+        members = []
+        member_count.times do
+          members << readUTF_8_vr(stream)
+        end
+        members
+      end
+      
+      def read_object_member_values(stream,flex_class,obj)
+        flex_class.members.each do|key|
+          value = read_value_type(stream)
+          obj.class.flex_remoting.members_writer.call(obj, key, value)
+        end
+        obj
+      end
+      
+      def readU29X(stream)
+        length_or_ref = readU29(stream)
+        #check if the XML is a reference or value.
+        #XML references are stored in the object reference table. 
+        (length_or_ref & 0x01) == 0 ? readU29O_ref(length_or_ref>>1, stream) : readU29X_value(length_or_ref>>1, stream)
+      end
+      
+      def readU29X_value(length, stream)
+        store :object do
+          defined?(REXML::Document) ? REXML::Document.new(stream.read(length)) : stream.read(length)
+        end
+      end
+      
+      def readU29D(stream)
+        is_ref = readU29(stream)
+        #check if the Date is a reference or value.
+        #Date references are stored in the object reference table. 
+        (is_ref & 0x01) == 0 ? readU29O_ref(is_ref>>1) : readU29D_value(stream)
+      end
+      
+      def readU29D_value(stream)
+        store :object do
+          milisec_value = read_double(stream).to_f
+          Time.at(milisec_value/1000)
+        end
+      end
+      
+      def readU29A(stream)
+        ref_or_length = readU29(stream)
+        #check if the Array is a reference or value.
+        #Array references are stored in the object reference table. 
+        (ref_or_length & 0x01) == 0 ? readU29O_ref(ref_or_length>>1) : readU29A_value(ref_or_length>>1, stream)
+      end
+      
+      def readU29A_value(dense_member_count, stream)
+        store :object do
+          obj = {}
+          read_object_dynamic_members(stream, obj)
+          obj = [] if obj.empty?
+          dense_member_count.times {|i| obj[i] = read_value_type(stream)}
+          obj
+        end
+      end
+      
+      def readU29B(stream)
+        ref_or_length = readU29(stream)
+        #check if the ByteArray is a reference or value.
+        #ByteArray references are stored in the object reference table. 
+        (ref_or_length & 0x01) == 0 ? readU29O_ref(ref_or_length>>1) : readU29B_value(ref_or_length>>1, stream)
+      end
+      
+      def readU29B_value(length,stream)
+        RAMF::FlexObjects::ByteArray.new(stream.read(length))
+      end
+      
+      def readUTF_8_vr(stream)
+        readU29S(stream)
+      end
+      
+    
+    end
+  end
+end

data/lib/ramf/deserializer/base.rb

@@ -0,0 +1,76 @@
+module RAMF
+  module Deserializer
+    class Base
+      include RAMF::IO::CommonReadWrite
+      include RAMF::IO::ReferenceTableUser
+      
+      class UnknowAMFVersion <StandardError; end;
+      
+      def initialize(stream)
+        @stream = stream
+        @amf_object = RAMF::AMFObject.new
+      end
+      
+      def process
+        read_preamble
+        read_headers
+        read_messages
+        @amf_object
+      end
+      
+      def read_preamble
+        version = readU8(@stream)
+        raise UnknowAMFVersion, "Unknow amf version: #{version}" if version != 0 && version != 3 
+        client = readU8(@stream)
+        @amf_object.version, @amf_object.client = version, client
+      end
+      
+      def read_headers
+        header_count = readU16(@stream)
+        header_count.times do
+          @amf_object.add_header(read_header)
+        end
+      end
+      
+      def read_header
+        register_reference_table
+        #Read header's name
+        name = readUTF8(@stream)
+        #Read the 'must-understand' flag
+        must_understand = readU8(@stream)
+        #Read the header's length
+        length = readU32(@stream)
+        
+        #Read header's value
+        value = AMF0Reader.new.read_value_type(@stream)
+        AMFHeader.new(name,value,must_understand, length)
+      end
+      
+      def read_messages
+        message_count = readU16(@stream)
+        message_count.times do
+          @amf_object.add_message(read_message)
+        end
+      end
+      
+      def read_message
+        
+        #Read message's target_uri
+        target_uri = readUTF8(@stream)
+        #Read message's response_uri
+        response_uri = readUTF8(@stream)
+        #Read the message's length
+        length = readU32(@stream)
+        
+        #Read message's value
+        value = AMF0Reader.new.read_value_type(@stream)
+        AMFMessage.new :target_uri=> target_uri,
+                       :response_uri=> response_uri,
+                       :value=> value,
+                       :length=>length
+      end
+          
+    end
+  end
+end
+