module PHP

Public Class Methods

serialize(var, assoc = false) click to toggle source

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

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

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.

# File lib/php_serialize.rb, line 31
def PHP.serialize(var, assoc = false) # {{{
        s = String.new
        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 << PHP.serialize(k, assoc) << PHP.serialize(v, assoc)
                                }
                        else
                                var.each_with_index { |v,i|
                                        s << "i:#{i};#{PHP.serialize(v, assoc)}"
                                }
                        end

                        s << '}'

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

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

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

                when Integer
                        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.bytesize}:\"#{var.class.to_s.downcase}\":#{v.length}:{"
                                v.each do |k,v|
                                        s << "#{PHP.serialize(k.to_s, assoc)}#{PHP.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

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

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

# File lib/php_serialize.rb, line 99
def PHP.serialize_session(var, assoc = false) # {{{
        s = String.new
        case var
        when Hash
                var.each do |key,value|
                        if key.to_s.include?('|')
                                raise IndexError, "Top level names may not contain pipes"
                        end
                        s << "#{key}|#{PHP.serialize(value, assoc)}"
                end
        when Array
                var.each do |x|
                        case x
                        when Array
                                if x.size == 2
                                        s << "#{x[0]}|#{PHP.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

Returns an object containing the reconstituted data from serialized.

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

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/php_serialize.rb, line 158
def PHP.unserialize(string, classmap = nil, assoc = false) # {{{
        if classmap == true or classmap == false
                assoc = classmap
                classmap = {}
        end
        classmap ||= {}

        ret = nil
        string = StringIOReader.new(string)
        while string.string[string.pos, 32] =~ /^(\w+)\|/ # session_name|serialized_data
                ret ||= {}
                string.pos += $&.size
                ret[$1] = PHP.do_unserialize(string, classmap, assoc)
        end

        ret || PHP.do_unserialize(string, classmap, assoc)
end

Private Class Methods

do_unserialize(string, classmap, assoc) click to toggle source

# File lib/php_serialize.rb, line 178
def PHP.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 = Array.new
                        count.times do |i|
                                val << [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
                        val.each do |key,_|
                                if key != i # wrong index -> assume hash
                                        array = false
                                        break
                                end
                                i += 1
                        end

                        if array
                                val.map! {|_,value| value }
                        elsif !assoc
                                val = Hash[val]
                        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] = val = 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'

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

        val
end