CFPropertyList 2.0.14 → 3.0.0

data/lib/{rbCFTypes.rb → cfpropertylist/rbCFTypes.rb}

@@ -10,66 +10,129 @@
 require 'base64'
 
 module CFPropertyList
+  ##
+  # Blob is intended to distinguish between a Ruby String instance that should
+  # be converted to a CFString type and a Ruby String instance that should be
+  # converted to a CFData type
+  class Blob < String
+  end
+
+  ##
+  # UidFixnum is intended to distinguish between a Ruby Integer
+  # instance that should be converted to a CFInteger/CFReal type and a
+  # Ruby Integer instance that should be converted to a CFUid type.
+  class UidFixnum < Integer
+  end
+
   # This class defines the base class for all CFType classes
   #
   class CFType
     # value of the type
     attr_accessor :value
 
-
-    # set internal value to parameter value by default
     def initialize(value=nil)
       @value = value
     end
 
-    # convert type to XML
-    def to_xml
+    def to_xml(parser)
     end
 
-    # convert type to binary
     def to_binary(bplist)
     end
+
+    def to_plain(plist)
+    end
   end
 
   # This class holds string values, both, UTF-8 and UTF-16BE
   # It will convert the value to UTF-16BE if necessary (i.e. if non-ascii char contained)
   class CFString < CFType
     # convert to XML
-    def to_xml
-      n = LibXML::XML::Node.new('string')
-      n << LibXML::XML::Node.new_text(@value) unless @value.nil?
-      return n
+    def to_xml(parser)
+      n = parser.new_node('string')
+      n = parser.append_node(n, parser.new_text(@value)) unless @value.nil?
+      n
     end
 
     # convert to binary
     def to_binary(bplist)
-      return bplist.string_to_binary(@value);
+      bplist.string_to_binary(@value);
+    end
+
+    def to_plain(plist)
+      if @value =~ /^\w+$/
+        @value
+      else
+        quoted
+      end
+    end
+
+    def quoted
+      str = '"'
+      @value.each_char do |c|
+        str << case c
+        when '"'
+          '\\"'
+        when '\\'
+          '\\'
+        when "\a"
+          "\\a"
+        when "\b"
+          "\\b"
+        when "\f"
+          "\\f"
+        when "\n"
+          "\n"
+        when "\v"
+          "\\v"
+        when "\r"
+          "\\r"
+        when "\t"
+          "\\t"
+        else
+          c
+        end
+      end
+
+      str << '"'
     end
   end
 
   # This class holds integer/fixnum values
   class CFInteger < CFType
     # convert to XML
-    def to_xml
-      return LibXML::XML::Node.new('integer') << LibXML::XML::Node.new_text(@value.to_s)
+    def to_xml(parser)
+      n = parser.new_node('integer')
+      n = parser.append_node(n, parser.new_text(@value.to_s))
+      n
     end
 
     # convert to binary
     def to_binary(bplist)
-      return bplist.num_to_binary(self)
+      bplist.num_to_binary(self)
+    end
+
+    def to_plain(plist)
+      @value.to_s
     end
   end
 
   # This class holds float values
   class CFReal < CFType
     # convert to XML
-    def to_xml
-      return LibXML::XML::Node.new('real') << LibXML::XML::Node.new_text(@value.to_s)
+    def to_xml(parser)
+      n = parser.new_node('real')
+      n = parser.append_node(n, parser.new_text(@value.to_s))
+      n
     end
 
     # convert to binary
     def to_binary(bplist)
-      return bplist.num_to_binary(self)
+      bplist.num_to_binary(self)
+    end
+
+    def to_plain(plist)
+      @value.to_s
     end
   end
 
@@ -79,7 +142,7 @@ module CFPropertyList
   # geht the timestamp or the Apple timestamp
   class CFDate < CFType
     TIMESTAMP_APPLE = 0
-    TIMESTAMP_UNIX  = 1;
+    TIMESTAMP_UNIX  = 1
     DATE_DIFF_APPLE_UNIX = 978307200
 
     # create a XML date strimg from a time object
@@ -100,6 +163,10 @@ module CFPropertyList
     def initialize(value = nil,format=CFDate::TIMESTAMP_UNIX)
       if(value.is_a?(Time) || value.nil?) then
         @value = value.nil? ? Time.now : value
+      elsif value.instance_of? Date
+        @value = Time.utc(value.year, value.month, value.day, 0, 0, 0)
+      elsif value.instance_of? DateTime
+        @value = value.to_time.utc
       else
         set_value(value,format)
       end
@@ -117,33 +184,43 @@ module CFPropertyList
     # get timestamp, either UNIX or Apple timestamp
     def get_value(format=CFDate::TIMESTAMP_UNIX)
       if(format == CFDate::TIMESTAMP_UNIX) then
-        return @value.to_i
+        @value.to_i
       else
-        return @value.to_f - CFDate::DATE_DIFF_APPLE_UNIX
+        @value.to_f - CFDate::DATE_DIFF_APPLE_UNIX
       end
     end
 
     # convert to XML
-    def to_xml
-      return LibXML::XML::Node.new('date') << LibXML::XML::Node.new_text(CFDate::date_string(@value))
+    def to_xml(parser)
+      n = parser.new_node('date')
+      n = parser.append_node(n, parser.new_text(CFDate::date_string(@value)))
+      n
     end
 
     # convert to binary
     def to_binary(bplist)
-      return bplist.date_to_binary(@value)
+      bplist.date_to_binary(@value)
+    end
+
+    def to_plain(plist)
+      @value.strftime("%Y-%m-%d %H:%M:%S %z")
     end
   end
 
   # This class contains a boolean value
   class CFBoolean < CFType
     # convert to XML
-    def to_xml
-      return LibXML::XML::Node.new(@value ? 'true' : 'false')
+    def to_xml(parser)
+      parser.new_node(@value ? 'true' : 'false')
     end
 
     # convert to binary
     def to_binary(bplist)
-      return bplist.bool_to_binary(@value);
+      bplist.bool_to_binary(@value);
+    end
+
+    def to_plain(plist)
+      @value ? "true" : "false"
     end
   end
 
@@ -156,9 +233,8 @@ module CFPropertyList
 
     # set value to defined state, either base64 encoded or raw
     def initialize(value=nil,format=DATA_BASE64)
-      if(format == DATA_RAW) then
+      if(format == DATA_RAW)
         @raw_value = value
-        @raw_value.blob = true
       else
         @value = value
       end
@@ -171,19 +247,23 @@ module CFPropertyList
 
     # get base64 decoded value
     def decoded_value
-      @raw_value ||= String.new(Base64.decode64(@value))
-      @raw_value.blob = true
-      @raw_value
+      @raw_value ||= Blob.new(Base64.decode64(@value))
     end
 
     # convert to XML
-    def to_xml
-      return LibXML::XML::Node.new('data') << LibXML::XML::Node.new_text(encoded_value())
+    def to_xml(parser)
+      n = parser.new_node('data')
+      n = parser.append_node(n, parser.new_text(encoded_value()))
+      n
     end
 
     # convert to binary
     def to_binary(bplist)
-      return bplist.data_to_binary(decoded_value())
+      bplist.data_to_binary(decoded_value())
+    end
+
+    def to_plain(plist)
+      "<" + decoded_value.unpack("H*").join("") + ">"
     end
   end
 
@@ -195,19 +275,22 @@ module CFPropertyList
     end
 
     # convert to XML
-    def to_xml
-      n = LibXML::XML::Node.new('array')
-      @value.each do
-        |v|
-        n << v.to_xml
+    def to_xml(parser)
+      n = parser.new_node('array')
+      @value.each do |v|
+        n = parser.append_node(n, v.to_xml(parser))
       end
-
-      return n
+      n
     end
 
     # convert to binary
     def to_binary(bplist)
-      return bplist.array_to_binary(self)
+      bplist.array_to_binary(self)
+    end
+
+    def to_plain(plist)
+      ary = @value.map { |v| v.to_plain(plist) }
+      "( " + ary.join(", ") + " )"
     end
   end
 
@@ -219,21 +302,46 @@ module CFPropertyList
     end
 
     # convert to XML
-    def to_xml
-      n = LibXML::XML::Node.new('dict')
-      @value.each_pair do
-        |key,value|
-        k = LibXML::XML::Node.new('key') << LibXML::XML::Node.new_text(key)
-        n << k
-        n << value.to_xml
+    def to_xml(parser)
+      n = parser.new_node('dict')
+      @value.each_pair do |key, value|
+        k = parser.append_node(parser.new_node('key'), parser.new_text(key.to_s))
+        n = parser.append_node(n, k)
+        n = parser.append_node(n, value.to_xml(parser))
+      end
+      n
+    end
+
+    # convert to binary
+    def to_binary(bplist)
+      bplist.dict_to_binary(self)
+    end
+
+    def to_plain(plist)
+      str = "{ "
+      cfstr = CFString.new()
+
+      @value.each do |k,v|
+        cfstr.value = k
+        str << cfstr.to_plain(plist) + " = " + v.to_plain(plist) + "; "
       end
 
-      return n
+      str << "}"
+    end
+  end
+
+  class CFUid < CFType
+    def to_xml(parser)
+      CFDictionary.new({'CF$UID' => CFInteger.new(@value)}).to_xml(parser)
     end
 
     # convert to binary
     def to_binary(bplist)
-      return bplist.dict_to_binary(self)
+      bplist.uid_to_binary(@value)
+    end
+
+    def to_plain(plist)
+      CFDictionary.new({'CF$UID' => CFInteger.new(@value)}).to_plain(plist)
     end
   end
 end

data/lib/{rbXMLCFPropertyList.rb → cfpropertylist/rbLibXMLParser.rb}

@@ -1,21 +1,29 @@
 # -*- coding: utf-8 -*-
 
+require 'libxml'
+
 module CFPropertyList
   # XML parser
-  class XML < ParserInterface
+  class LibXMLParser < XMLParserInterface
     # read a XML file
     # opts::
     # * :file - The filename of the file to load
     # * :data - The data to parse
     def load(opts)
+      doc = nil
+
       if(opts.has_key?(:file)) then
         doc = LibXML::XML::Document.file(opts[:file],:options => LibXML::XML::Parser::Options::NOBLANKS|LibXML::XML::Parser::Options::NOENT)
       else
         doc = LibXML::XML::Document.string(opts[:data],:options => LibXML::XML::Parser::Options::NOBLANKS|LibXML::XML::Parser::Options::NOENT)
       end
 
-      root = doc.root.first
-      return import_xml(root)
+      if doc
+        root = doc.root.first
+        return import_xml(root)
+      end
+    rescue LibXML::XML::Error => e
+      raise CFFormatError.new('invalid XML: ' + e.message)
     end
 
     # serialize CFPropertyList object to XML
@@ -27,14 +35,13 @@ module CFPropertyList
       doc.encoding = LibXML::XML::Encoding::UTF_8
 
       doc.root['version'] = '1.0'
-      doc.root << opts[:root].to_xml()
+      doc.root << opts[:root].to_xml(self)
 
       # ugly hack, but there's no other possibility I know
       str = doc.to_s(:indent => opts[:formatted])
       str1 = String.new
       first = false
-      str.each_line do
-        |line|
+      str.each_line do |line|
         str1 << line
         unless(first) then
           str1 << "<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n" if line =~ /^\s*<\?xml/
@@ -47,6 +54,18 @@ module CFPropertyList
       return str1
     end
 
+    def new_node(name)
+      LibXML::XML::Node.new(name)
+    end
+
+    def new_text(val)
+      LibXML::XML::Node.new_text(val)
+    end
+
+    def append_node(parent, child)
+      parent << child
+    end
+
     protected
 
     # get the value of a DOM node
@@ -56,7 +75,7 @@ module CFPropertyList
       else
         n.content
       end
-      
+
       content.force_encoding('UTF-8') if content.respond_to?(:force_encoding)
       content
     end
@@ -71,9 +90,9 @@ module CFPropertyList
         key = nil
 
         if node.children? then
-          node.children.each do
-            |n|
+          node.children.each do |n|
             next if n.text? # avoid a bug of libxml
+            next if n.comment?
 
             if n.name == "key" then
               key = get_value(n)
@@ -85,14 +104,19 @@ module CFPropertyList
           end
         end
 
-        ret = CFDictionary.new(hsh)
+        if hsh['CF$UID'] and hsh.keys.length == 1
+          ret = CFUid.new(hsh['CF$UID'].value)
+        else
+          ret = CFDictionary.new(hsh)
+        end
 
       when 'array'
         ary = Array.new
 
         if node.children? then
-          node.children.each do
-            |n|
+          node.children.each do |n|
+            next if n.text? # avoid a bug of libxml
+            next if n.comment?
             ary.push import_xml(n)
           end
         end

data/lib/cfpropertylist/rbNokogiriParser.rb

@@ -0,0 +1,151 @@
+# -*- coding: utf-8 -*-
+
+require 'nokogiri'
+
+module CFPropertyList
+  # XML parser
+  class NokogiriXMLParser < ParserInterface
+    # read a XML file
+    # opts::
+    # * :file - The filename of the file to load
+    # * :data - The data to parse
+    def load(opts)
+      doc = nil
+      if(opts.has_key?(:file)) then
+        File.open(opts[:file], "rb") { |fd| doc = Nokogiri::XML::Document.parse(fd, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS|Nokogiri::XML::ParseOptions::NOENT) }
+      else
+        doc = Nokogiri::XML::Document.parse(opts[:data], nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS|Nokogiri::XML::ParseOptions::NOENT)
+      end
+
+      if doc
+        root = doc.root.children.first
+        return import_xml(root)
+      end
+    rescue Nokogiri::XML::SyntaxError => e
+      raise CFFormatError.new('invalid XML: ' + e.message)
+    end
+
+    # serialize CFPropertyList object to XML
+    # opts = {}:: Specify options: :formatted - Use indention and line breaks
+    def to_str(opts={})
+      doc = Nokogiri::XML::Document.new
+      @doc = doc
+
+      doc.root = doc.create_element 'plist', :version => '1.0'
+      doc.encoding = 'UTF-8'
+
+      doc.root << opts[:root].to_xml(self)
+
+      # ugly hack, but there's no other possibility I know
+      s_opts = Nokogiri::XML::Node::SaveOptions::AS_XML
+      s_opts |= Nokogiri::XML::Node::SaveOptions::FORMAT if opts[:formatted]
+
+      str = doc.serialize(:save_with => s_opts)
+      str1 = String.new
+      first = false
+      str.each_line do |line|
+        str1 << line
+        unless(first) then
+          str1 << "<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n" if line =~ /^\s*<\?xml/
+        end
+
+        first = true
+      end
+
+      str1.force_encoding('UTF-8') if str1.respond_to?(:force_encoding)
+      return str1
+    end
+
+    def new_node(name)
+      @doc.create_element name
+    end
+
+    def new_text(val)
+      @doc.create_text_node val
+    end
+
+    def append_node(parent, child)
+      parent << child
+    end
+
+    protected
+
+    # get the value of a DOM node
+    def get_value(n)
+      content = if n.children.empty?
+        n.content
+      else
+        n.children.first.content
+      end
+
+      content.force_encoding('UTF-8') if content.respond_to?(:force_encoding)
+      content
+    end
+
+    # import the XML values
+    def import_xml(node)
+      ret = nil
+
+      case node.name
+      when 'dict'
+        hsh = Hash.new
+        key = nil
+        children = node.children
+
+        unless children.empty? then
+          children.each do |n|
+            next if n.text? # avoid a bug of libxml
+            next if n.comment?
+
+            if n.name == "key" then
+              key = get_value(n)
+            else
+              raise CFFormatError.new("Format error!") if key.nil?
+              hsh[key] = import_xml(n)
+              key = nil
+            end
+          end
+        end
+
+        if hsh['CF$UID'] and hsh.keys.length == 1
+          ret = CFUid.new(hsh['CF$UID'].value)
+        else
+          ret = CFDictionary.new(hsh)
+        end
+
+      when 'array'
+        ary = Array.new
+        children = node.children
+
+        unless children.empty? then
+          children.each do |n|
+            next if n.text? # avoid a bug of libxml
+            next if n.comment?
+            ary.push import_xml(n)
+          end
+        end
+
+        ret = CFArray.new(ary)
+
+      when 'true'
+        ret = CFBoolean.new(true)
+      when 'false'
+        ret = CFBoolean.new(false)
+      when 'real'
+        ret = CFReal.new(get_value(node).to_f)
+      when 'integer'
+        ret = CFInteger.new(get_value(node).to_i)
+      when 'string'
+        ret = CFString.new(get_value(node))
+      when 'data'
+        ret = CFData.new(get_value(node))
+      when 'date'
+        ret = CFDate.new(CFDate.parse_date(get_value(node)))
+      end
+
+      return ret
+    end
+  end
+end
+
+# eof