ruby-dbus 0.18.0.beta1 → 0.18.0.beta2

data/lib/dbus/raw_message.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# This file is part of the ruby-dbus project
+# Copyright (C) 2022 Martin Vidner
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License, version 2.1 as published by the Free Software Foundation.
+# See the file "COPYING" for the exact licensing terms.
+
+module DBus
+  # A message while it is being parsed: a binary string,
+  # with a position cursor (*pos*), and an *endianness* tag.
+  class RawMessage
+    # @return [String]
+    # attr_reader :bytes
+
+    # @return [Integer] position in the byte buffer
+    attr_reader :pos
+
+    # @return [:little,:big]
+    attr_reader :endianness
+
+    # @param bytes [String]
+    # @param endianness [:little,:big,nil]
+    #    if not given, read the 1st byte of *bytes*
+    def initialize(bytes, endianness = nil)
+      @bytes = bytes
+      @pos = 0
+      @endianness = endianness || self.class.endianness(@bytes[0])
+    end
+
+    # Get the endiannes switch as a Symbol,
+    # which will make using it slightly more efficient
+    # @param tag_char [String]
+    # @return [:little,:big]
+    def self.endianness(tag_char)
+      case tag_char
+      when LIL_END
+        :little
+      when BIG_END
+        :big
+      else
+        raise InvalidPacketException, "Incorrect endianness #{tag_char.inspect}"
+      end
+    end
+
+    # @return [void]
+    # @raise IncompleteBufferException if there are not enough bytes remaining
+    def want!(size)
+      raise IncompleteBufferException if @pos + size > @bytes.bytesize
+    end
+
+    # @return [String]
+    # @raise IncompleteBufferException if there are not enough bytes remaining
+    # TODO: stress test this with encodings. always binary?
+    def read(size)
+      want!(size)
+      ret = @bytes.slice(@pos, size)
+      @pos += size
+      ret
+    end
+
+    # @return [String]
+    # @api private
+    def remaining_bytes
+      # This returns "" if pos is just past the end of the string,
+      # and nil if it is further.
+      @bytes[@pos..-1]
+    end
+
+    # Align the *pos* index on a multiple of *alignment*
+    # @param alignment [Integer] must be 1, 2, 4 or 8
+    # @return [void]
+    def align(alignment)
+      case alignment
+      when 1
+        nil
+      when 2, 4, 8
+        bits = alignment - 1
+        pad_size = ((@pos + bits) & ~bits) - @pos
+        pad = read(pad_size)
+        unless pad.bytes.all?(&:zero?)
+          raise InvalidPacketException, "Alignment bytes are not NUL"
+        end
+      else
+        raise ArgumentError, "Unsupported alignment #{alignment}"
+      end
+    end
+  end
+end

data/lib/dbus/type.rb

@@ -33,7 +33,11 @@ module DBus
   #
   # This module containts the constants of the types specified in the D-Bus
   # protocol.
-  module Type
+  #
+  # Corresponds to {SingleCompleteType}.
+  #
+  # See also {DBus::Data::Signature}
+  class Type
     # Mapping from type number to name and alignment.
     TYPE_MAPPING = {
       0 => ["INVALID", nil],
@@ -64,91 +68,117 @@ module DBus
     class SignatureException < Exception
     end
 
-    # = D-Bus type conversion class
-    #
-    # Helper class for representing a D-Bus type.
-    class Type
-      # Returns the signature type number.
-      attr_reader :sigtype
-      # Return contained member types.
-      attr_reader :members
-
-      # Create a new type instance for type number _sigtype_.
-      def initialize(sigtype)
-        if !TYPE_MAPPING.keys.member?(sigtype)
-          raise SignatureException, "Unknown key in signature: #{sigtype.chr}"
-        end
+    # Formerly this was a Module and there was a DBus::Type::Type class
+    # but the class got too prominent to keep its double double name.
+    # This is for backward compatibility.
+    Type = self # rubocop:disable Naming/ConstantName
 
-        @sigtype = sigtype
-        @members = []
-      end
+    # @return [String] the signature type character, eg "s" or "e".
+    attr_reader :sigtype
+    # @return [Array<Type>] contained member types.
+    attr_reader :members
 
-      # Return the required alignment for the type.
-      def alignment
-        TYPE_MAPPING[@sigtype].last
+    # Use {DBus.type} instead, because this allows constructing
+    # incomplete or invalid types, for backward compatibility.
+    #
+    # @param abstract [Boolean] allow abstract types "r" and "e"
+    #   (Enabled for internal usage by {Parser}.)
+    def initialize(sigtype, abstract: false)
+      if !TYPE_MAPPING.keys.member?(sigtype)
+        case sigtype
+        when ")"
+          raise SignatureException, "STRUCT unexpectedly closed: )"
+        when "}"
+          raise SignatureException, "DICT_ENTRY unexpectedly closed: }"
+        else
+          raise SignatureException, "Unknown type code #{sigtype.inspect}"
+        end
       end
 
-      # Return a string representation of the type according to the
-      # D-Bus specification.
-      def to_s
-        case @sigtype
+      unless abstract
+        case sigtype
         when STRUCT
-          "(#{@members.collect(&:to_s).join})"
-        when ARRAY
-          "a#{child}"
+          raise SignatureException, "Abstract STRUCT, use \"(...)\" instead of \"#{STRUCT}\""
         when DICT_ENTRY
-          "{#{@members.collect(&:to_s).join}}"
-        else
-          if !TYPE_MAPPING.keys.member?(@sigtype)
-            raise NotImplementedError
-          end
-
-          @sigtype.chr
+          raise SignatureException, "Abstract DICT_ENTRY, use \"{..}\" instead of \"#{DICT_ENTRY}\""
         end
       end
 
-      # Add a new member type _item_.
-      def <<(item)
-        if ![STRUCT, ARRAY, DICT_ENTRY].member?(@sigtype)
-          raise SignatureException
-        end
-        raise SignatureException if @sigtype == ARRAY && !@members.empty?
-
-        if @sigtype == DICT_ENTRY
-          case @members.size
-          when 2
-            raise SignatureException, "Dict entries have exactly two members"
-          when 0
-            if [STRUCT, ARRAY, DICT_ENTRY].member?(item.sigtype)
-              raise SignatureException, "Dict entry keys must be basic types"
-            end
-          end
+      @sigtype = sigtype
+      @members = []
+    end
+
+    # Return the required alignment for the type.
+    def alignment
+      TYPE_MAPPING[@sigtype].last
+    end
+
+    # Return a string representation of the type according to the
+    # D-Bus specification.
+    def to_s
+      case @sigtype
+      when STRUCT
+        "(#{@members.collect(&:to_s).join})"
+      when ARRAY
+        "a#{child}"
+      when DICT_ENTRY
+        "{#{@members.collect(&:to_s).join}}"
+      else
+        if !TYPE_MAPPING.keys.member?(@sigtype)
+          raise NotImplementedError
         end
-        @members << item
+
+        @sigtype.chr
       end
+    end
 
-      # Return the first contained member type.
-      def child
-        @members[0]
+    # Add a new member type _item_.
+    def <<(item)
+      if ![STRUCT, ARRAY, DICT_ENTRY].member?(@sigtype)
+        raise SignatureException
       end
+      raise SignatureException if @sigtype == ARRAY && !@members.empty?
 
-      def inspect
-        s = TYPE_MAPPING[@sigtype].first
-        if [STRUCT, ARRAY].member?(@sigtype)
-          s += ": #{@members.inspect}"
+      if @sigtype == DICT_ENTRY
+        case @members.size
+        when 2
+          raise SignatureException, "DICT_ENTRY must have 2 subtypes, found 3 or more in #{@signature}"
+        when 0
+          if [STRUCT, ARRAY, DICT_ENTRY, VARIANT].member?(item.sigtype)
+            raise SignatureException, "DICT_ENTRY key must be basic (non-container)"
+          end
         end
-        s
       end
+      @members << item
+    end
+
+    # Return the first contained member type.
+    def child
+      @members[0]
+    end
+
+    def inspect
+      s = TYPE_MAPPING[@sigtype].first
+      if [STRUCT, ARRAY].member?(@sigtype)
+        s += ": #{@members.inspect}"
+      end
+      s
     end
 
     # = D-Bus type parser class
     #
     # Helper class to parse a type signature in the protocol.
+    # @api private
     class Parser
       # Create a new parser for the given _signature_.
       # @param signature [Signature]
       def initialize(signature)
         @signature = signature
+        if signature.size > 255
+          msg = "Potential signature is longer than 255 characters (#{@signature.size}): #{@signature}"
+          raise SignatureException, msg
+        end
+
         @idx = 0
       end
 
@@ -160,28 +190,45 @@ module DBus
       end
 
       # Parse one character _char_ of the signature.
-      def parse_one(char)
+      # @param for_array [Boolean] are we parsing an immediate child of an ARRAY
+      # @return [Type]
+      def parse_one(char, for_array: false)
         res = nil
         case char
         when "a"
           res = Type.new(ARRAY)
           char = nextchar
-          raise SignatureException, "Parse error in #{@signature}" if char.nil?
+          raise SignatureException, "Empty ARRAY in #{@signature}" if char.nil?
 
-          child = parse_one(char)
+          child = parse_one(char, for_array: true)
           res << child
         when "("
-          res = Type.new(STRUCT)
+          res = Type.new(STRUCT, abstract: true)
           while (char = nextchar) && char != ")"
             res << parse_one(char)
           end
-          raise SignatureException, "Parse error in #{@signature}" if char.nil?
+          raise SignatureException, "STRUCT not closed in #{@signature}" if char.nil?
+          raise SignatureException, "Empty STRUCT in #{@signature}" if res.members.empty?
         when "{"
-          res = Type.new(DICT_ENTRY)
-          while (char = nextchar) && char != "}"
+          raise SignatureException, "DICT_ENTRY not an immediate child of an ARRAY" unless for_array
+
+          res = Type.new(DICT_ENTRY, abstract: true)
+
+          # key type, value type
+          2.times do |i|
+            char = nextchar
+            raise SignatureException, "DICT_ENTRY not closed in #{@signature}" if char.nil?
+
+            raise SignatureException, "DICT_ENTRY must have 2 subtypes, found #{i} in #{@signature}" if char == "}"
+
             res << parse_one(char)
           end
-          raise SignatureException, "Parse error in #{@signature}" if char.nil?
+
+          # closing "}"
+          char = nextchar
+          raise SignatureException, "DICT_ENTRY not closed in #{@signature}" if char.nil?
+
+          raise SignatureException, "DICT_ENTRY must have 2 subtypes, found 3 or more in #{@signature}" if char != "}"
         else
           res = Type.new(char)
         end
@@ -189,6 +236,7 @@ module DBus
       end
 
       # Parse the entire signature, return a DBus::Type object.
+      # @return [Array<Type>]
       def parse
         @idx = 0
         ret = []
@@ -197,18 +245,47 @@ module DBus
         end
         ret
       end
+
+      # Parse one {SingleCompleteType}
+      # @return [Type]
+      def parse1
+        c = nextchar
+        raise SignatureException, "Empty signature, expecting a Single Complete Type" if c.nil?
+
+        t = parse_one(c)
+        raise SignatureException, "Has more than a Single Complete Type: #{@signature}" unless nextchar.nil?
+
+        t
+      end
     end
   end
 
   # shortcuts
 
-  # Parse a String to a DBus::Type::Type
+  # Parse a String to a valid {DBus::Type}.
+  # This is prefered to {Type#initialize} which allows
+  # incomplete or invalid types.
+  # @param string_type [SingleCompleteType]
+  # @return [DBus::Type]
+  # @raise SignatureException
   def type(string_type)
-    Type::Parser.new(string_type).parse[0]
+    Type::Parser.new(string_type).parse1
   end
   module_function :type
 
+  # Parse a String to zero or more {DBus::Type}s.
+  # @param string_type [Signature]
+  # @return [Array<DBus::Type>]
+  # @raise SignatureException
+  def types(string_type)
+    Type::Parser.new(string_type).parse
+  end
+  module_function :types
+
   # Make an explicit [Type, value] pair
+  # @param string_type [SingleCompleteType]
+  # @param value [::Object]
+  # @return [Array(DBus::Type::Type,::Object)]
   def variant(string_type, value)
     [type(string_type), value]
   end

data/lib/dbus.rb

@@ -14,6 +14,7 @@ require_relative "dbus/api_options"
 require_relative "dbus/auth"
 require_relative "dbus/bus"
 require_relative "dbus/bus_name"
+require_relative "dbus/data"
 require_relative "dbus/error"
 require_relative "dbus/introspect"
 require_relative "dbus/logger"
@@ -26,6 +27,7 @@ require_relative "dbus/object_path"
 require_relative "dbus/proxy_object"
 require_relative "dbus/proxy_object_factory"
 require_relative "dbus/proxy_object_interface"
+require_relative "dbus/raw_message"
 require_relative "dbus/type"
 require_relative "dbus/xml"
 
@@ -49,6 +51,10 @@ module DBus
                BIG_END
              end
 
+  # Comparing symbols is faster than strings
+  # @return [:little,:big]
+  HOST_ENDIANNESS = RawMessage.endianness(HOST_END)
+
   # General exceptions.
 
   # Exception raised when there is a problem with a type (may be unknown or