class Ucenter::Tools::PHP

string = PHP.serialize(mixed var[, bool assoc])

Returns a string representing the argument in a form PHP.unserialize and PHP's unserialize() should both be able to load.

Array, Hash, Fixnum, Float, True/FalseClass, NilClass, String and Struct are supported; as are objects which support the to_assoc method, which returns an array of the form [['attr_name', 'value']..]. Anything else will raise a TypeError.

If 'assoc' is specified, Array's who's first element is a two value array will be assumed to be an associative array, and will be serialized as a PHP associative array rather than a multidimensional array.

Public Class Methods

serialize(var, assoc = false) click to toggle source
# File lib/ucenter/tools/php.rb, line 55
def self.serialize(var, assoc = false) # {{{
  s = ''
  case var
    when Array
      s << "a:#{var.size}:{"
      if assoc and var.first.is_a?(Array) and var.first.size == 2
        var.each { |k,v|
          s << self.serialize(k, assoc) << self.serialize(v, assoc)
        }
      else
        var.each_with_index { |v,i|
          s << "i:#{i};#{self.serialize(v, assoc)}"
        }
      end

      s << '}'

    when Hash
      s << "a:#{var.size}:{"
      var.each do |k,v|
        s << "#{self.serialize(k, assoc)}#{self.serialize(v, assoc)}"
      end
      s << '}'

    when Struct
      # encode as Object with same name
      s << "O:#{var.class.to_s.length}:\"#{var.class.to_s.downcase}\":#{var.members.length}:{"
      var.members.each do |member|
        s << "#{self.serialize(member, assoc)}#{self.serialize(var[member], assoc)}"
      end
      s << '}'

    when String, Symbol
      s << "s:#{var.to_s.length}:\"#{var.to_s}\";"

    when Fixnum # PHP doesn't have bignums
      s << "i:#{var};"

    when Float
      s << "d:#{var};"

    when NilClass
      s << 'N;'

    when FalseClass, TrueClass
      s << "b:#{var ? 1 :0};"

    else
      if var.respond_to?(:to_assoc)
        v = var.to_assoc
        # encode as Object with same name
        s << "O:#{var.class.to_s.length}:\"#{var.class.to_s.downcase}\":#{v.length}:{"
        v.each do |k,v|
          s << "#{self.serialize(k.to_s, assoc)}#{self.serialize(v, assoc)}"
        end
        s << '}'
      else
        raise TypeError, "Unable to serialize type #{var.class}"
      end
  end

  s
end
serialize_session(var, assoc = false) click to toggle source

string = PHP.serialize_session(mixed var[, bool assoc])

Like PHP.serialize, but only accepts a Hash or associative Array as the root type. The results are returned in PHP session format.

# File lib/ucenter/tools/php.rb, line 123
def self.serialize_session(var, assoc = false) # {{{
  s = ''
  case var
    when Hash
      var.each do |key,value|
        if key.to_s =~ /\|/
          raise IndexError, "Top level names may not contain pipes"
        end
        s << "#{key}|#{self.serialize(value, assoc)}"
      end
    when Array
      var.each do |x|
        case x
          when Array
            if x.size == 2
              s << "#{x[0]}|#{self.serialize(x[1])}"
            else
              raise TypeError, "Array is not associative"
            end
        end
      end
    else
      raise TypeError, "Unable to serialize sessions with top level types other than Hash and associative Array"
  end
  s
end
unserialize(string, classmap = nil, assoc = false) click to toggle source

mixed = PHP.unserialize(string serialized, [hash classmap, [bool assoc]])

Returns an object containing the reconstituted data from serialized.

If a PHP array (associative; like an ordered hash) is encountered, it scans the keys; if they're all incrementing integers counting from 0, it's unserialized as an Array, otherwise it's unserialized as a Hash. Note: this will lose ordering. To avoid this, specify assoc=true, and it will be unserialized as an associative array: [[key,value],…]

If a serialized object is encountered, the hash 'classmap' is searched for the class name (as a symbol). Since PHP classnames are not case-preserving, this must be a .capitalize()d representation. The value is expected to be the class itself; i.e. something you could call .new on.

If it's not found in 'classmap', the current constant namespace is searched, and failing that, a new Struct(classname) is generated, with the arguments for .new specified in the same order PHP provided; since PHP uses hashes to represent attributes, this should be the same order they're specified in PHP, but this is untested.

each serialized attribute is sent to the new object using the respective {attribute}=() method; you'll get a NameError if the method doesn't exist.

Array, Hash, Fixnum, Float, True/FalseClass, NilClass and String should be returned identically (i.e. foo == PHP.unserialize(PHP.serialize(foo)) for these types); Struct should be too, provided it's in the namespace Module.const_get within unserialize() can see, or you gave it the same name in the Struct.new(), otherwise you should provide it in classmap.

Note: StringIO is required for unserialize(); it's loaded as needed

# File lib/ucenter/tools/php.rb, line 182
def self.unserialize(string, classmap = nil, assoc = false) # {{{
  if classmap == true or classmap == false
    assoc = classmap
    classmap = {}
  end
  classmap ||= {}

  require 'stringio'
  string = StringIO.new(string)
  def string.read_until(char)
    val = ''
    while (c = self.read(1)) != char
      val << c
    end
    val
  end

  if string.string =~ /^(\w+)\|/ # session_name|serialized_data
    ret = Hash.new
    loop do
      if string.string[string.pos, 32] =~ /^(\w+)\|/
        string.pos += $&.size
        ret[$1] = self.do_unserialize(string, classmap, assoc)
      else
        break
      end
    end
    ret
  else
    self.do_unserialize(string, classmap, assoc)
  end
end

Private Class Methods

do_unserialize(string, classmap, assoc) click to toggle source
# File lib/ucenter/tools/php.rb, line 216
def self.do_unserialize(string, classmap, assoc)
  val = nil
  # determine a type
  type = string.read(2)[0,1]
  case type
    when 'a' # associative array, a:length:{[index][value]...}
      count = string.read_until('{').to_i
      val = vals = Array.new
      count.times do |i|
        vals << [do_unserialize(string, classmap, assoc), do_unserialize(string, classmap, assoc)]
      end
      string.read(1) # skip the ending }

      # now, we have an associative array, let's clean it up a bit...
      # arrays have all numeric indexes, in order; otherwise we assume a hash
      array = true
      i = 0
      vals.each do |key,value|
        if key != i # wrong index -> assume hash
          array = false
          break
        end
        i += 1
      end

      if array
        vals.collect! do |key,value|
          value
        end
      else
        if assoc
          val = vals.map {|v| v }
        else
          val = Hash.new
          vals.each do |key,value|
            val[key] = value
          end
        end
      end

    when 'O' # object, O:length:"class":length:{[attribute][value]...}
      # class name (lowercase in PHP, grr)
      len = string.read_until(':').to_i + 3 # quotes, seperator
      klass = string.read(len)[1...-2].capitalize.intern # read it, kill useless quotes

      # read the attributes
      attrs = []
      len = string.read_until('{').to_i

      len.times do
        attr = (do_unserialize(string, classmap, assoc))
        attrs << [attr.intern, (attr << '=').intern, do_unserialize(string, classmap, assoc)]
      end
      string.read(1)

      val = nil
      # See if we need to map to a particular object
      if classmap.has_key?(klass)
        val = classmap[klass].new
      elsif Struct.const_defined?(klass) # Nope; see if there's a Struct
        classmap[klass] = val = Struct.const_get(klass)
        val = val.new
      else # Nope; see if there's a Constant
        begin
          classmap[klass] = val = Module.const_get(klass)

          val = val.new
        rescue NameError # Nope; make a new Struct
          classmap[klass] = Struct.new(klass.to_s, *attrs.collect { |v| v[0].to_s })
          val = val.new
        end
      end

      attrs.each do |attr,attrassign,v|
        val.__send__(attrassign, v)
      end

    when 's' # string, s:length:"data";
      len = string.read_until(':').to_i + 3 # quotes, separator
      val = string.read(len)[1...-2] # read it, kill useless quotes

    when 'i' # integer, i:123
      val = string.read_until(';').to_i

    when 'd' # double (float), d:1.23
      val = string.read_until(';').to_f

    when 'N' # NULL, N;
      val = nil

    when 'b' # bool, b:0 or 1
      val = (string.read(2)[0] == ?1 ? true : false)

    else
      raise TypeError, "Unable to unserialize type '#{type}'"
  end

  val
end