CFPropertyList 2.0.7

data/lib/rbCFPlistError.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+#
+# CFFormatError implementation
+#
+# Author::    Christian Kruse (mailto:cjk@wwwtech.de)
+# Copyright:: Copyright (c) 2010
+# License::   MIT License
+
+class CFPlistError < Exception
+end
+
+# Exception thrown when format errors occur
+class CFFormatError < CFPlistError
+end
+
+class CFTypeError < CFPlistError
+end
+
+# eof

data/lib/rbCFPropertyList.rb

@@ -0,0 +1,316 @@
+# -*- coding: utf-8 -*-
+#
+# CFPropertyList implementation
+# class to read, manipulate and write both XML and binary property list
+# files (plist(5)) as defined by Apple
+#
+# == Example
+#
+#   # create a arbitrary data structure of basic data types
+#   data = {
+#     'name' => 'John Doe',
+#     'missing' => true,
+#     'last_seen' => Time.now,
+#     'friends' => ['Jane Doe','Julian Doe'],
+#     'likes' => {
+#       'me' => false
+#     }
+#   }
+#
+#   # create CFPropertyList::List object
+#   plist = CFPropertyList::List.new
+#
+#   # call CFPropertyList.guess() to create corresponding CFType values
+#   # pass in optional :convert_unknown_to_string => true to convert things like symbols into strings.
+#   plist.value = CFPropertyList.guess(data)
+#
+#   # write plist to file
+#   plist.save("example.plist", CFPropertyList::List::FORMAT_BINARY)
+#
+#   # … later, read it again
+#   plist = CFPropertyList::List.new({:file => "example.plist"})
+#   data = CFPropertyList.native_types(plist.value)
+#
+# Author::    Christian Kruse (mailto:cjk@wwwtech.de)
+# Copyright:: Copyright (c) 2010
+# License::   Distributes under the same terms as Ruby
+
+require 'libxml'
+require 'kconv'
+require 'date'
+
+module CFPropertyList
+  # interface class for PList parsers
+  class ParserInterface
+    # load a plist
+    def load(opts={})
+      return ""
+    end
+
+    # convert a plist to string
+    def to_str(opts={})
+      return true
+    end
+  end
+end
+
+dirname = File.dirname(__FILE__)
+require dirname + '/rbCFPlistError.rb'
+require dirname + '/rbCFTypes.rb'
+require dirname + '/rbXMLCFPropertyList.rb'
+require dirname + '/rbBinaryCFPropertyList.rb'
+
+require 'iconv' unless "".respond_to?("encode")
+
+module CFPropertyList
+  # Create CFType hierarchy by guessing the correct CFType, e.g.
+  #
+  #  x = {
+  #    'a' => ['b','c','d']
+  #  }
+  #  cftypes = CFPropertyList.guess(x)
+  #
+  # pass optional options hash. Only possible value actually:
+  # +convert_unknown_to_string+::   Convert unknown objects to string calling to_str()
+  # +converter_method+::    Convert unknown objects to known objects calling +method_name+
+  #
+  #  cftypes = CFPropertyList.guess(x,:convert_unknown_to_string => true,:converter_method => :to_hash)
+  def guess(object, options = {})
+    if(object.is_a?(Fixnum) || object.is_a?(Integer)) then
+      return CFInteger.new(object)
+    elsif(object.is_a?(Float) || (Object.const_defined?('BigDecimal') and object.is_a?(BigDecimal))) then
+      return CFReal.new(object)
+    elsif(object.is_a?(TrueClass) || object.is_a?(FalseClass)) then
+      return CFBoolean.new(object)
+    elsif(object.is_a?(String)) then
+      return CFString.new(object)
+    elsif(object.is_a?(Time) || object.is_a?(DateTime)) then
+      return CFDate.new(object)
+    elsif(object.is_a?(IO)) then
+      return CFData.new(object.read, CFData::DATA_RAW)
+    elsif(object.is_a?(Array)) then
+      ary = Array.new
+      object.each do
+        |o|
+        ary.push CFPropertyList.guess(o, options)
+      end
+
+      return CFArray.new(ary)
+    elsif(object.is_a?(Hash)) then
+      hsh = Hash.new
+      object.each_pair do
+        |k,v|
+        k = k.to_s if k.is_a?(Symbol)
+        hsh[k] = CFPropertyList.guess(v, options)
+      end
+
+      return CFDictionary.new(hsh)
+    elsif options[:converter_method] and object.respond_to?(options[:converter_method]) then
+      return CFPropertyList.guess(object.send(options[:converter_method]))
+    elsif options[:convert_unknown_to_string] then
+      return CFString.new(object.to_s)
+    else
+      raise CFTypeError.new("Unknown class #{object.class.to_s}! Try using :convert_unknown_to_string if you want to use unknown object types!")
+    end
+  end
+
+  # Converts a CFType hiercharchy to native Ruby types
+  def native_types(object,keys_as_symbols=false)
+    return if object.nil?
+
+    if(object.is_a?(CFDate) || object.is_a?(CFString) || object.is_a?(CFInteger) || object.is_a?(CFReal) || object.is_a?(CFBoolean)) then
+      return object.value
+    elsif(object.is_a?(CFData)) then
+      return object.decoded_value
+    elsif(object.is_a?(CFArray)) then
+      ary = []
+      object.value.each do
+        |v|
+        ary.push CFPropertyList.native_types(v)
+      end
+
+      return ary
+    elsif(object.is_a?(CFDictionary)) then
+      hsh = {}
+      object.value.each_pair do
+        |k,v|
+        k = k.to_sym if keys_as_symbols
+        hsh[k] = CFPropertyList.native_types(v)
+      end
+
+      return hsh
+    end
+  end
+
+  module_function :guess, :native_types
+
+  class List
+    # Format constant for binary format
+    FORMAT_BINARY = 1
+
+    # Format constant for XML format
+    FORMAT_XML = 2
+
+    # Format constant for automatic format recognizing
+    FORMAT_AUTO = 0
+
+    @@parsers = [Binary,XML]
+
+    # Path of PropertyList
+    attr_accessor :filename
+    # Path of PropertyList
+    attr_accessor :format
+    # the root value in the plist file
+    attr_accessor :value
+
+    def initialize(opts={})
+      @filename = opts[:file]
+      @format = opts[:format] || FORMAT_AUTO
+      @data = opts[:data]
+
+      load(@filename) unless @filename.nil?
+      load_str(@data) unless @data.nil?
+    end
+
+    # Load an XML PropertyList
+    # filename = nil:: The filename to read from; if nil, read from the file defined by instance variable +filename+
+    def load_xml(filename=nil)
+      load(filename,List::FORMAT_XML)
+    end
+
+    # read a binary plist file
+    # filename = nil:: The filename to read from; if nil, read from the file defined by instance variable +filename+
+    def load_binary(filename=nil)
+      load(filename,List::FORMAT_BINARY)
+    end
+
+    # load a plist from a XML string
+    # str:: The string containing the plist
+    def load_xml_str(str=nil)
+      load_str(str,List::FORMAT_XML)
+    end
+
+    # load a plist from a binary string
+    # str:: The string containing the plist
+    def load_binary_str(str=nil)
+      load_str(str,List::FORMAT_BINARY)
+    end
+
+    # load a plist from a string
+    # str = nil:: The string containing the plist
+    # format = nil:: The format of the plist
+    def load_str(str=nil,format=nil)
+      str = @data if str.nil?
+      format = @format if format.nil?
+
+      @value = {}
+      case format
+      when List::FORMAT_BINARY, List::FORMAT_XML then
+        prsr = @@parsers[format-1].new
+        @value = prsr.load({:data => str})
+
+      when List::FORMAT_AUTO then # what we now do is ugly, but neccessary to recognize the file format
+        filetype = str[0..5]
+        version = str[6..7]
+
+        prsr = nil
+        if filetype == "bplist" then
+          raise CFFormatError.new("Wong file version #{version}") unless version == "00"
+          prsr = Binary.new
+        else
+          prsr = XML.new
+        end
+
+        @value = prsr.load({:data => str})
+      end
+    end
+
+    # Read a plist file
+    # file = nil:: The filename of the file to read. If nil, use +filename+ instance variable
+    # format = nil:: The format of the plist file. Auto-detect if nil
+    def load(file=nil,format=nil)
+      file = @filename if file.nil?
+      format = @format if format.nil?
+      @value = {}
+
+      raise IOError.new("File #{file} not readable!") unless File.readable? file
+
+      case format
+      when List::FORMAT_BINARY, List::FORMAT_XML then
+        prsr = @@parsers[format-1].new
+        @value = prsr.load({:file => file})
+
+      when List::FORMAT_AUTO then # what we now do is ugly, but neccessary to recognize the file format
+        magic_number = IO.read(file,8)
+        filetype = magic_number[0..5]
+        version = magic_number[6..7]
+
+        prsr = nil
+        if filetype == "bplist" then
+          raise CFFormatError.new("Wong file version #{version}") unless version == "00"
+          prsr = Binary.new
+        else
+          prsr = XML.new
+        end
+
+        @value = prsr.load({:file => file})
+      end
+    end
+
+    # Serialize CFPropertyList object to specified format and write it to file
+    # file = nil:: The filename of the file to write to. Uses +filename+ instance variable if nil
+    # format = nil:: The format to save in. Uses +format+ instance variable if nil
+    def save(file=nil,format=nil,opts={})
+      format = @format if format.nil?
+      file = @filename if file.nil?
+
+      raise CFFormatError.new("Format #{format} not supported, use List::FORMAT_BINARY or List::FORMAT_XML") if format != FORMAT_BINARY && format != FORMAT_XML
+
+      if(!File.exists?(file)) then
+        raise IOError.new("File #{file} not writable!") unless File.writable?(File.dirname(file))
+      elsif(!File.writable?(file)) then
+        raise IOError.new("File #{file} not writable!")
+      end
+
+      opts[:root] = @value
+      prsr = @@parsers[format-1].new
+      content = prsr.to_str(opts)
+
+      File.open(file, 'wb') {
+        |fd|
+        fd.write content
+      }
+    end
+
+    # convert plist to string
+    # format = List::FORMAT_BINARY:: The format to save the plist
+    # opts={}:: Pass parser options
+    def to_str(format=List::FORMAT_BINARY,opts={})
+      prsr = @@parsers[format-1].new
+      opts[:root] = @value
+      return prsr.to_str(opts)
+    end
+  end
+end
+
+class Array
+  def to_plist(options={})
+    options[:plist_format] ||= CFPropertyList::List::FORMAT_BINARY
+
+    plist = CFPropertyList::List.new
+    plist.value = CFPropertyList.guess(self, options)
+    plist.to_str(options[:plist_format])
+  end
+end
+
+class Hash
+  def to_plist(options={})
+    options[:plist_format] ||= CFPropertyList::List::FORMAT_BINARY
+
+    plist = CFPropertyList::List.new
+    plist.value = CFPropertyList.guess(self, options)
+    plist.to_str(options[:plist_format])
+  end
+end
+
+# eof

data/lib/rbCFTypes.rb

@@ -0,0 +1,233 @@
+# -*- coding: utf-8 -*-
+#
+# CFTypes, e.g. CFString, CFInteger
+# needed to create unambiguous plists
+#
+# Author::    Christian Kruse (mailto:cjk@wwwtech.de)
+# Copyright:: Copyright (c) 2009
+# License::   Distributes under the same terms as Ruby
+
+require 'base64'
+
+module CFPropertyList
+  # 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
+    end
+
+    # convert type to binary
+    def to_binary(bplist)
+    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
+    end
+
+    # convert to binary
+    def to_binary(bplist)
+      return bplist.string_to_binary(@value);
+    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)
+    end
+
+    # convert to binary
+    def to_binary(bplist)
+      return bplist.num_to_binary(self)
+    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)
+    end
+
+    # convert to binary
+    def to_binary(bplist)
+      return bplist.num_to_binary(self)
+    end
+  end
+
+  # This class holds Time values. While Apple uses seconds since 2001,
+  # the rest of the world uses seconds since 1970. So if you access value
+  # directly, you get the Time class. If you access via get_value you either
+  # geht the timestamp or the Apple timestamp
+  class CFDate < CFType
+    TIMESTAMP_APPLE = 0
+    TIMESTAMP_UNIX  = 1;
+    DATE_DIFF_APPLE_UNIX = 978307200
+
+    # create a XML date strimg from a time object
+    def CFDate.date_string(val)
+      # 2009-05-13T20:23:43Z
+      val.getutc.strftime("%Y-%m-%dT%H:%M:%SZ")
+    end
+
+    # parse a XML date string
+    def CFDate.parse_date(val)
+      # 2009-05-13T20:23:43Z
+      val =~ %r{^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})Z$}
+      year,month,day,hour,min,sec = $1, $2, $3, $4, $5, $6
+      return Time.utc(year,month,day,hour,min,sec).getlocal
+    end
+
+    # set value to defined state
+    def initialize(value = nil,format=CFDate::TIMESTAMP_UNIX)
+      if(value.is_a?(Time) || value.nil?) then
+        @value = value.nil? ? Time.now : value
+      else
+        set_value(value,format)
+      end
+    end
+
+    # set value with timestamp, either Apple or UNIX
+    def set_value(value,format=CFDate::TIMESTAMP_UNIX)
+      if(format == CFDate::TIMESTAMP_UNIX) then
+        @value = Time.at(value)
+      else
+        @value = Time.at(value + CFDate::DATE_DIFF_APPLE_UNIX)
+      end
+    end
+
+    # get timestamp, either UNIX or Apple timestamp
+    def get_value(format=CFDate::TIMESTAMP_UNIX)
+      if(format == CFDate::TIMESTAMP_UNIX) then
+        return @value.to_i
+      else
+        return @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))
+    end
+
+    # convert to binary
+    def to_binary(bplist)
+      return bplist.date_to_binary(@value)
+    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')
+    end
+
+    # convert to binary
+    def to_binary(bplist)
+      return bplist.bool_to_binary(@value);
+    end
+  end
+
+  # This class contains binary data values
+  class CFData < CFType
+    # Base64 encoded data
+    DATA_BASE64 = 0
+    # Raw data
+    DATA_RAW = 1
+
+    # set value to defined state, either base64 encoded or raw
+    def initialize(value=nil,format=DATA_BASE64)
+      if(format == DATA_RAW) then
+        @value = Base64.encode64(value)
+      else
+        @value = value
+      end
+    end
+
+    # get base64 decoded value
+    def decoded_value
+      return Base64.decode64(@value)
+    end
+
+    # convert to XML
+    def to_xml
+      return LibXML::XML::Node.new('data') << LibXML::XML::Node.new_text(@value)
+    end
+
+    # convert to binary
+    def to_binary(bplist)
+      return bplist.data_to_binary(decoded_value())
+    end
+  end
+
+  # This class contains an array of values
+  class CFArray < CFType
+    # create a new array CFType
+    def initialize(val=[])
+      @value = val
+    end
+
+    # convert to XML
+    def to_xml
+      n = LibXML::XML::Node.new('array')
+      @value.each do
+        |v|
+        n << v.to_xml
+      end
+
+      return n
+    end
+
+    # convert to binary
+    def to_binary(bplist)
+      return bplist.array_to_binary(self)
+    end
+  end
+
+  # this class contains a hash of values
+  class CFDictionary < CFType
+    # Create new CFDictonary type.
+    def initialize(value={})
+      @value = value
+    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
+      end
+
+      return n
+    end
+
+    # convert to binary
+    def to_binary(bplist)
+      return bplist.dict_to_binary(self)
+    end
+  end
+end
+
+# eof