Class: Ucenter::Tools::PHP

Inherits:
Object
  • Object
show all
Defined in:
lib/ucenter/tools/php.rb

Overview

as a PHP associative array rather than a multidimensional array.

Class Method Summary collapse

Class Method Details

.serialize(var, assoc = false) ⇒ Object

{{{



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# 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) ⇒ Object

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.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# 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) ⇒ Object

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(<structname>), otherwise you should provide it in classmap.

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# 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