ruby-dbus 0.16.0 → 0.18.1

data/lib/dbus/marshall.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # dbus.rb - Module containing the low-level D-Bus implementation
 #
 # This file is part of the ruby-dbus project
@@ -10,6 +12,8 @@
 
 require "socket"
 
+require_relative "../dbus/type"
+
 # = D-Bus main module
 #
 # Module containing all the D-Bus modules and classes.
@@ -21,211 +25,134 @@ module DBus
   # = D-Bus packet unmarshaller class
   #
   # Class that handles the conversion (unmarshalling) of payload data
-  # to Array.
+  # to #{::Object}s (in **plain** mode) or to {Data::Base} (in **exact** mode)
+  #
+  # Spelling note: this codebase always uses a double L
+  # in the "marshall" word and its inflections.
   class PacketUnmarshaller
-    # Index pointer that points to the byte in the data that is
-    # currently being processed.
-    #
-    # Used to kown what part of the buffer has been consumed by unmarshalling.
-    # FIXME: Maybe should be accessed with a "consumed_size" method.
-    attr_reader :idx
-
-    # Create a new unmarshaller for the given data _buffer_ and _endianness_.
+    # Create a new unmarshaller for the given data *buffer*.
+    # @param buffer [String]
+    # @param endianness [:little,:big]
     def initialize(buffer, endianness)
-      @buffy = buffer.dup
-      @endianness = endianness
-      if @endianness == BIG_END
-        @uint32 = "N"
-        @uint16 = "n"
-        @double = "G"
-      elsif @endianness == LIL_END
-        @uint32 = "V"
-        @uint16 = "v"
-        @double = "E"
-      else
-        raise InvalidPacketException, "Incorrect endianness #{@endianness}"
-      end
-      @idx = 0
+      # TODO: this dup can be avoided if we can prove
+      # that an IncompleteBufferException leaves the original *buffer* intact
+      buffer = buffer.dup
+      @raw_msg = RawMessage.new(buffer, endianness)
     end
 
     # Unmarshall the buffer for a given _signature_ and length _len_.
-    # Return an array of unmarshalled objects
-    def unmarshall(signature, len = nil)
-      if !len.nil?
-        if @buffy.bytesize < @idx + len
-          raise IncompleteBufferException
-        end
-      end
+    # Return an array of unmarshalled objects.
+    # @param signature [Signature]
+    # @param len [Integer,nil] if given, and there is not enough data
+    #   in the buffer, raise {IncompleteBufferException}
+    # @param mode [:plain,:exact]
+    # @return [Array<::Object,DBus::Data::Base>]
+    #    Objects in `:plain` mode, {DBus::Data::Base} in `:exact` mode
+    #    The array size corresponds to the number of types in *signature*.
+    # @raise IncompleteBufferException
+    # @raise InvalidPacketException
+    def unmarshall(signature, len = nil, mode: :plain)
+      @raw_msg.want!(len) if len
+
       sigtree = Type::Parser.new(signature).parse
       ret = []
       sigtree.each do |elem|
-        ret << do_parse(elem)
+        ret << do_parse(elem, mode: mode)
       end
       ret
     end
 
-    # Align the pointer index on a byte index of _a_, where a
-    # must be 1, 2, 4 or 8.
-    def align(a)
-      case a
-      when 1
-        nil
-      when 2, 4, 8
-        bits = a - 1
-        @idx = @idx + bits & ~bits
-        raise IncompleteBufferException if @idx > @buffy.bytesize
-      else
-        raise "Unsupported alignment #{a}"
-      end
+    # after the headers, the body starts 8-aligned
+    def align_body
+      @raw_msg.align(8)
     end
 
-    ###############################################################
-    # FIXME: does anyone except the object itself call the above methods?
-    # Yes : Message marshalling code needs to align "body" to 8 byte boundary
-    private
-
-    # Retrieve the next _nbytes_ number of bytes from the buffer.
-    def read(nbytes)
-      raise IncompleteBufferException if @idx + nbytes > @buffy.bytesize
-      ret = @buffy.slice(@idx, nbytes)
-      @idx += nbytes
-      ret
+    # @return [Integer]
+    def consumed_size
+      @raw_msg.pos
     end
 
-    # Read the string length and string itself from the buffer.
-    # Return the string.
-    def read_string
-      align(4)
-      str_sz = read(4).unpack(@uint32)[0]
-      ret = @buffy.slice(@idx, str_sz)
-      raise IncompleteBufferException if @idx + str_sz + 1 > @buffy.bytesize
-      @idx += str_sz
-      if @buffy[@idx].ord != 0
-        raise InvalidPacketException, "String is not nul-terminated"
-      end
-      @idx += 1
-      # no exception, see check above
-      ret
-    end
+    private
 
-    # Read the signature length and signature itself from the buffer.
-    # Return the signature.
-    def read_signature
-      str_sz = read(1).unpack("C")[0]
-      ret = @buffy.slice(@idx, str_sz)
-      raise IncompleteBufferException if @idx + str_sz + 1 >= @buffy.bytesize
-      @idx += str_sz
-      if @buffy[@idx].ord != 0
-        raise InvalidPacketException, "Type is not nul-terminated"
-      end
-      @idx += 1
-      # no exception, see check above
-      ret
+    # @param data_class [Class] a subclass of Data::Base (specific?)
+    # @return [::Integer,::Float]
+    def aligned_read_value(data_class)
+      @raw_msg.align(data_class.alignment)
+      bytes = @raw_msg.read(data_class.alignment)
+      bytes.unpack1(data_class.format[@raw_msg.endianness])
     end
 
     # Based on the _signature_ type, retrieve a packet from the buffer
     # and return it.
-    def do_parse(signature)
+    # @param signature [Type]
+    # @param mode [:plain,:exact]
+    # @return [Data::Base]
+    def do_parse(signature, mode: :plain)
+      # FIXME: better naming for packet vs value
       packet = nil
-      case signature.sigtype
-      when Type::BYTE
-        packet = read(1).unpack("C")[0]
-      when Type::UINT16
-        align(2)
-        packet = read(2).unpack(@uint16)[0]
-      when Type::INT16
-        align(2)
-        packet = read(2).unpack(@uint16)[0]
-        if (packet & 0x8000) != 0
-          packet -= 0x10000
-        end
-      when Type::UINT32, Type::UNIX_FD
-        align(4)
-        packet = read(4).unpack(@uint32)[0]
-      when Type::INT32
-        align(4)
-        packet = read(4).unpack(@uint32)[0]
-        if (packet & 0x80000000) != 0
-          packet -= 0x100000000
-        end
-      when Type::UINT64
-        align(8)
-        packet_l = read(4).unpack(@uint32)[0]
-        packet_h = read(4).unpack(@uint32)[0]
-        packet = if @endianness == LIL_END
-                   packet_l + packet_h * 2**32
-                 else
-                   packet_l * 2**32 + packet_h
-                 end
-      when Type::INT64
-        align(8)
-        packet_l = read(4).unpack(@uint32)[0]
-        packet_h = read(4).unpack(@uint32)[0]
-        packet = if @endianness == LIL_END
-                   packet_l + packet_h * 2**32
-                 else
-                   packet_l * 2**32 + packet_h
-                 end
-        if (packet & 0x8000000000000000) != 0
-          packet -= 0x10000000000000000
-        end
-      when Type::DOUBLE
-        align(8)
-        packet = read(8).unpack(@double)[0]
-      when Type::BOOLEAN
-        align(4)
-        v = read(4).unpack(@uint32)[0]
-        raise InvalidPacketException if ![0, 1].member?(v)
-        packet = (v == 1)
-      when Type::ARRAY
-        align(4)
-        # checks please
-        array_sz = read(4).unpack(@uint32)[0]
-        raise InvalidPacketException if array_sz > 67_108_864
-
-        align(signature.child.alignment)
-        raise IncompleteBufferException if @idx + array_sz > @buffy.bytesize
-
-        packet = []
-        start_idx = @idx
-        while @idx - start_idx < array_sz
-          packet << do_parse(signature.child)
-        end
+      data_class = Data::BY_TYPE_CODE[signature.sigtype]
 
-        if signature.child.sigtype == Type::DICT_ENTRY
-          packet = Hash[packet]
-        end
-      when Type::STRUCT
-        align(8)
-        packet = []
-        signature.members.each do |elem|
-          packet << do_parse(elem)
-        end
-      when Type::VARIANT
-        string = read_signature
-        # error checking please
-        sig = Type::Parser.new(string).parse[0]
-        align(sig.alignment)
-        packet = do_parse(sig)
-      when Type::OBJECT_PATH
-        packet = read_string
-      when Type::STRING
-        packet = read_string
-        packet.force_encoding("UTF-8")
-      when Type::SIGNATURE
-        packet = read_signature
-      when Type::DICT_ENTRY
-        align(8)
-        key = do_parse(signature.members[0])
-        value = do_parse(signature.members[1])
-        packet = [key, value]
-      else
+      if data_class.nil?
         raise NotImplementedError,
               "sigtype: #{signature.sigtype} (#{signature.sigtype.chr})"
       end
+
+      if data_class.fixed?
+        value = aligned_read_value(data_class)
+        packet = data_class.from_raw(value, mode: mode)
+      elsif data_class.basic?
+        size = aligned_read_value(data_class.size_class)
+        # @raw_msg.align(data_class.alignment)
+        # ^ is not necessary because we've just read a suitably-aligned *size*
+        value = @raw_msg.read(size)
+        nul = @raw_msg.read(1)
+        if nul != "\u0000"
+          raise InvalidPacketException, "#{data_class} is not NUL-terminated"
+        end
+
+        packet = data_class.from_raw(value, mode: mode)
+      else
+        @raw_msg.align(data_class.alignment)
+        case signature.sigtype
+        when Type::STRUCT, Type::DICT_ENTRY
+          values = signature.members.map do |child_sig|
+            do_parse(child_sig, mode: mode)
+          end
+          packet = data_class.from_items(values, mode: mode, type: signature)
+
+        when Type::VARIANT
+          data_sig = do_parse(Data::Signature.type, mode: :exact) # -> Data::Signature
+          types = Type::Parser.new(data_sig.value).parse # -> Array<Type>
+          unless types.size == 1
+            raise InvalidPacketException, "VARIANT must contain 1 value, #{types.size} found"
+          end
+
+          type = types.first
+          value = do_parse(type, mode: mode)
+          packet = data_class.from_items(value, mode: mode, member_type: type)
+
+        when Type::ARRAY
+          array_bytes = aligned_read_value(Data::UInt32)
+          if array_bytes > 67_108_864
+            raise InvalidPacketException, "ARRAY body longer than 64MiB"
+          end
+
+          # needed here because of empty arrays
+          @raw_msg.align(signature.child.alignment)
+
+          items = []
+          end_pos = @raw_msg.pos + array_bytes
+          while @raw_msg.pos < end_pos
+            item = do_parse(signature.child, mode: mode)
+            items << item
+          end
+          is_hash = signature.child.sigtype == Type::DICT_ENTRY
+          packet = data_class.from_items(items, mode: mode, type: signature, hash: is_hash)
+        end
+      end
       packet
-    end # def do_parse
-  end # class PacketUnmarshaller
+    end
+  end
 
   # D-Bus packet marshaller class
   #
@@ -234,40 +161,35 @@ module DBus
   class PacketMarshaller
     # The current or result packet.
     # FIXME: allow access only when marshalling is finished
+    # @return [String]
     attr_reader :packet
 
+    # @return [:little,:big]
+    attr_reader :endianness
+
     # Create a new marshaller, setting the current packet to the
     # empty packet.
-    def initialize(offset = 0)
+    def initialize(offset = 0, endianness: HOST_ENDIANNESS)
+      @endianness = endianness
       @packet = ""
       @offset = offset # for correct alignment of nested marshallers
     end
 
-    # Round _n_ up to the specified power of two, _a_
-    def num_align(n, a)
-      case a
+    # Round _num_ up to the specified power of two, _alignment_
+    def num_align(num, alignment)
+      case alignment
       when 1, 2, 4, 8
-        bits = a - 1
-        n + bits & ~bits
+        bits = alignment - 1
+        num + bits & ~bits
       else
-        raise "Unsupported alignment"
+        raise ArgumentError, "Unsupported alignment #{alignment}"
       end
     end
 
-    # Align the buffer with NULL (\0) bytes on a byte length of _a_.
-    def align(a)
-      @packet = @packet.ljust(num_align(@offset + @packet.bytesize, a) - @offset, 0.chr)
-    end
-
-    # Append the the string _str_ itself to the packet.
-    def append_string(str)
-      align(4)
-      @packet += [str.bytesize].pack("L") + [str].pack("Z*")
-    end
-
-    # Append the the signature _signature_ itself to the packet.
-    def append_signature(str)
-      @packet += str.bytesize.chr + str + "\0"
+    # Align the buffer with NULL (\0) bytes on a byte length of _alignment_.
+    def align(alignment)
+      pad_count = num_align(@offset + @packet.bytesize, alignment) - @offset
+      @packet = @packet.ljust(pad_count, 0.chr)
     end
 
     # Append the array type _type_ to the packet and allow for appending
@@ -282,7 +204,9 @@ module DBus
       yield
       sz = @packet.bytesize - contentidx
       raise InvalidPacketException if sz > 67_108_864
-      @packet[sizeidx...sizeidx + 4] = [sz].pack("L")
+
+      sz_data = Data::UInt32.new(sz)
+      @packet[sizeidx...sizeidx + 4] = sz_data.marshall(endianness)
     end
 
     # Align and allow for appending struct fields.
@@ -294,110 +218,129 @@ module DBus
     # Append a value _val_ to the packet based on its _type_.
     #
     # Host native endianness is used, declared in Message#marshall
+    #
+    # @param type [SingleCompleteType] (or Integer or {Type})
+    # @param val [::Object]
     def append(type, val)
       raise TypeException, "Cannot send nil" if val.nil?
 
       type = type.chr if type.is_a?(Integer)
       type = Type::Parser.new(type).parse[0] if type.is_a?(String)
-      case type.sigtype
-      when Type::BYTE
-        @packet += val.chr
-      when Type::UINT32, Type::UNIX_FD
-        align(4)
-        @packet += [val].pack("L")
-      when Type::UINT64
-        align(8)
-        @packet += [val].pack("Q")
-      when Type::INT64
-        align(8)
-        @packet += [val].pack("q")
-      when Type::INT32
-        align(4)
-        @packet += [val].pack("l")
-      when Type::UINT16
-        align(2)
-        @packet += [val].pack("S")
-      when Type::INT16
-        align(2)
-        @packet += [val].pack("s")
-      when Type::DOUBLE
-        align(8)
-        @packet += [val].pack("d")
-      when Type::BOOLEAN
-        align(4)
-        @packet += if val
-                     [1].pack("L")
-                   else
-                     [0].pack("L")
-                   end
-      when Type::OBJECT_PATH
-        append_string(val)
-      when Type::STRING
-        append_string(val)
-      when Type::SIGNATURE
-        append_signature(val)
-      when Type::VARIANT
-        vartype = nil
-        if val.is_a?(Array) && val.size == 2
-          if val[0].is_a?(DBus::Type::Type)
-            vartype, vardata = val
-          elsif val[0].is_a?(String)
-            begin
-              parsed = Type::Parser.new(val[0]).parse
-              vartype = parsed[0] if parsed.size == 1
-              vardata = val[1]
-            rescue Type::SignatureException
-              # no assignment
+      # type is [Type] now
+      data_class = Data::BY_TYPE_CODE[type.sigtype]
+      if data_class.nil?
+        raise NotImplementedError,
+              "sigtype: #{type.sigtype} (#{type.sigtype.chr})"
+      end
+
+      if data_class.fixed?
+        align(data_class.alignment)
+        data = data_class.new(val)
+        @packet += data.marshall(endianness)
+      elsif data_class.basic?
+        val = val.value if val.is_a?(Data::Basic)
+        align(data_class.size_class.alignment)
+        size_data = data_class.size_class.new(val.bytesize)
+        @packet += size_data.marshall(endianness)
+        # Z* makes a binary string, as opposed to interpolation
+        @packet += [val].pack("Z*")
+      else
+        case type.sigtype
+
+        when Type::VARIANT
+          append_variant(val)
+        when Type::ARRAY
+          val = val.exact_value if val.is_a?(Data::Array)
+          append_array(type.child, val)
+        when Type::STRUCT, Type::DICT_ENTRY
+          val = val.exact_value if val.is_a?(Data::Struct) || val.is_a?(Data::DictEntry)
+          unless val.is_a?(Array) || val.is_a?(Struct)
+            type_name = Type::TYPE_MAPPING[type.sigtype].first
+            raise TypeException, "#{type_name} expects an Array or Struct, seen #{val.class}"
+          end
+
+          if type.sigtype == Type::DICT_ENTRY && val.size != 2
+            raise TypeException, "DICT_ENTRY expects a pair"
+          end
+
+          if type.members.size != val.size
+            type_name = Type::TYPE_MAPPING[type.sigtype].first
+            raise TypeException, "#{type_name} has #{val.size} elements but type info for #{type.members.size}"
+          end
+
+          struct do
+            type.members.zip(val).each do |t, v|
+              append(t, v)
             end
           end
+        else
+          raise NotImplementedError,
+                "sigtype: #{type.sigtype} (#{type.sigtype.chr})"
         end
-        if vartype.nil?
-          vartype, vardata = PacketMarshaller.make_variant(val)
-          vartype = Type::Parser.new(vartype).parse[0]
-        end
+      end
+    end
 
-        append_signature(vartype.to_s)
-        align(vartype.alignment)
-        sub = PacketMarshaller.new(@offset + @packet.bytesize)
-        sub.append(vartype, vardata)
-        @packet += sub.packet
-      when Type::ARRAY
-        if val.is_a?(Hash)
-          raise TypeException, "Expected an Array but got a Hash" if type.child.sigtype != Type::DICT_ENTRY
-          # Damn ruby rocks here
-          val = val.to_a
-        end
-        # If string is recieved and ay is expected, explode the string
-        if val.is_a?(String) && type.child.sigtype == Type::BYTE
-          val = val.bytes
-        end
-        if !val.is_a?(Enumerable)
-          raise TypeException, "Expected an Enumerable of #{type.child.inspect} but got a #{val.class}"
-        end
-        array(type.child) do
-          val.each do |elem|
-            append(type.child, elem)
+    def append_variant(val)
+      vartype = nil
+      if val.is_a?(DBus::Data::Variant)
+        vartype = val.member_type
+        vardata = val.exact_value
+      elsif val.is_a?(DBus::Data::Container)
+        vartype = val.type
+        vardata = val.exact_value
+      elsif val.is_a?(DBus::Data::Base)
+        vartype = val.type
+        vardata = val.value
+      elsif val.is_a?(Array) && val.size == 2
+        case val[0]
+        when Type
+          vartype, vardata = val
+        # Ambiguous but easy to use, because Type
+        # cannot construct "as" "a{sv}" easily
+        when String
+          begin
+            parsed = Type::Parser.new(val[0]).parse
+            vartype = parsed[0] if parsed.size == 1
+            vardata = val[1]
+          rescue Type::SignatureException
+            # no assignment
           end
         end
-      when Type::STRUCT, Type::DICT_ENTRY
-        # TODO: use duck typing, val.respond_to?
-        raise TypeException, "Struct/DE expects an Array" if !val.is_a?(Array)
-        if type.sigtype == Type::DICT_ENTRY && val.size != 2
-          raise TypeException, "Dict entry expects a pair"
-        end
-        if type.members.size != val.size
-          raise TypeException, "Struct/DE has #{val.size} elements but type info for #{type.members.size}"
-        end
-        struct do
-          type.members.zip(val).each do |t, v|
-            append(t, v)
-          end
+      end
+      if vartype.nil?
+        vartype, vardata = PacketMarshaller.make_variant(val)
+        vartype = Type::Parser.new(vartype).parse[0]
+      end
+
+      append(Data::Signature.type, vartype.to_s)
+      align(vartype.alignment)
+      sub = PacketMarshaller.new(@offset + @packet.bytesize, endianness: endianness)
+      sub.append(vartype, vardata)
+      @packet += sub.packet
+    end
+
+    # @param child_type [Type]
+    def append_array(child_type, val)
+      if val.is_a?(Hash)
+        raise TypeException, "Expected an Array but got a Hash" if child_type.sigtype != Type::DICT_ENTRY
+
+        # Damn ruby rocks here
+        val = val.to_a
+      end
+      # If string is recieved and ay is expected, explode the string
+      if val.is_a?(String) && child_type.sigtype == Type::BYTE
+        val = val.bytes
+      end
+      if !val.is_a?(Enumerable)
+        raise TypeException, "Expected an Enumerable of #{child_type.inspect} but got a #{val.class}"
+      end
+
+      array(child_type) do
+        val.each do |elem|
+          append(child_type, elem)
         end
-      else
-        raise NotImplementedError,
-              "sigtype: #{type.sigtype} (#{type.sigtype.chr})"
       end
-    end # def append
+    end
 
     # Make a [signature, value] pair for a variant
     def self.make_variant(value)
@@ -417,17 +360,25 @@ module DBus
       elsif value.is_a? Hash
         h = {}
         value.each_key { |k| h[k] = make_variant(value[k]) }
-        ["a{sv}", h]
+        key_type = if value.empty?
+                     "s"
+                   else
+                     t, = make_variant(value.first.first)
+                     t
+                   end
+        ["a{#{key_type}v}", h]
       elsif value.respond_to? :to_str
         ["s", value.to_str]
       elsif value.respond_to? :to_int
         i = value.to_int
-        if -2_147_483_648 <= i && i < 2_147_483_648
+        if Data::Int32.range.cover?(i)
           ["i", i]
-        else
+        elsif Data::Int64.range.cover?(i)
           ["x", i]
+        else
+          ["t", i]
         end
       end
     end
-  end # class PacketMarshaller
-end # module DBus
+  end
+end