]> git.openstreetmap.org Git - rails.git/blob - lib/potlatch.rb
Merge branch 'master' into openstreetbugs
[rails.git] / lib / potlatch.rb
1 require 'stringio'
2
3 # The Potlatch module provides helper functions for potlatch and its communication with the server
4 module Potlatch
5
6   # The AMF class is a set of helper functions for encoding and decoding AMF.
7   class AMF
8     
9     # Return two-byte integer
10     def self.getint(s) 
11       s.getc*256+s.getc
12     end
13
14     # Return four-byte long
15     def self.getlong(s) 
16       ((s.getc*256+s.getc)*256+s.getc)*256+s.getc
17     end
18
19     # Return string with two-byte length 
20     def self.getstring(s) 
21       len=s.getc*256+s.getc
22       s.read(len)
23     end
24
25     # Return eight-byte double-precision float 
26     def self.getdouble(s) 
27       a=s.read(8).unpack('G')                   # G big-endian, E little-endian
28       a[0]
29     end
30
31     # Return numeric array
32     def self.getarray(s) 
33       len=getlong(s)
34       arr=[]
35       for i in (0..len-1)
36         arr[i]=getvalue(s)
37       end
38       arr
39     end
40
41     # Return object/hash 
42     def self.getobject(s) 
43       arr={}
44       while (key=getstring(s))
45         if (key=='') then break end
46         arr[key]=getvalue(s)
47       end
48       s.getc            # skip the 9 'end of object' value
49       arr
50     end
51
52     # Parse and get value
53     def self.getvalue(s) 
54       case s.getc
55       when 0;   return getdouble(s)                     # number
56       when 1;   return s.getc                           # boolean
57       when 2;   return getstring(s)                     # string
58       when 3;   return getobject(s)                     # object/hash
59       when 5;   return nil                                      # null
60       when 6;   return nil                                      # undefined
61       when 8;   s.read(4)                                       # mixedArray
62         return getobject(s)                     #  |
63       when 10;return getarray(s)                        # array
64       else;     return nil                                      # error
65       end
66     end
67
68     # Envelope data into AMF writeable form
69     def self.putdata(index,n) 
70       d =encodestring(index+"/onResult")
71       d+=encodestring("null")
72       d+=[-1].pack("N")
73       d+=encodevalue(n)
74     end
75
76     # Pack variables as AMF
77     def self.encodevalue(n) 
78       case n.class.to_s
79       when 'Array'
80         a=10.chr+encodelong(n.length)
81         n.each do |b|
82           a+=encodevalue(b)
83         end
84         a
85       when 'Hash'
86         a=3.chr
87         n.each do |k,v|
88           a+=encodestring(k.to_s)+encodevalue(v)
89         end
90         a+0.chr+0.chr+9.chr
91       when 'String'
92         2.chr+encodestring(n)
93       when 'Bignum','Fixnum','Float'
94         0.chr+encodedouble(n)
95       when 'NilClass'
96         5.chr
97           when 'TrueClass'
98         0.chr+encodedouble(1)
99           when 'FalseClass'
100         0.chr+encodedouble(0)
101       else
102         Rails.logger.error("Unexpected Ruby type for AMF conversion: "+n.class.to_s)
103       end
104     end
105
106     # Encode string with two-byte length
107     def self.encodestring(n) 
108       a,b=n.size.divmod(256)
109       a.chr+b.chr+n
110     end
111
112     # Encode number as eight-byte double precision float 
113     def self.encodedouble(n) 
114       [n].pack('G')
115     end
116
117     # Encode number as four-byte long
118     def self.encodelong(n) 
119       [n].pack('N')
120     end
121
122   end
123
124   # The Dispatcher class handles decoding a series of RPC calls
125   # from the request, dispatching them, and encoding the response
126   class Dispatcher
127     def initialize(request, &block)
128       # Get stream for request data
129       @request = StringIO.new(request + 0.chr)
130
131       # Skip version indicator and client ID
132       @request.read(2)
133
134       # Skip headers
135       AMF.getint(@request).times do     # Read number of headers and loop
136         AMF.getstring(@request)         #  | skip name
137         req.getc                        #  | skip boolean
138         AMF.getvalue(@request)          #  | skip value
139       end
140
141       # Capture the dispatch routine
142       @dispatch = Proc.new
143     end
144
145     def each(&block)
146       # Read number of message bodies
147       bodies = AMF.getint(@request)
148
149       # Output response header
150       a,b = bodies.divmod(256)
151       yield 0.chr + 0.chr + 0.chr + 0.chr + a.chr + b.chr
152
153       # Process the bodies
154       bodies.times do                     # Read each body
155         name = AMF.getstring(@request)    #  | get message name
156         index = AMF.getstring(@request)   #  | get index in response sequence
157         bytes = AMF.getlong(@request)     #  | get total size in bytes
158         args = AMF.getvalue(@request)     #  | get response (probably an array)
159
160         result = @dispatch.call(name, *args)
161
162         yield AMF.putdata(index, result)
163       end
164     end
165   end
166
167   # The Potlatch class is a helper for Potlatch
168   class Potlatch
169
170     # ----- getpresets
171     #             in:   none
172     #             does: reads tag preset menus, colours, and autocomplete config files
173     #         out:  [0] presets, [1] presetmenus, [2] presetnames,
174     #                           [3] colours, [4] casing, [5] areas, [6] autotags
175     #                           (all hashes)
176     def self.get_presets
177       Rails.logger.info("  Message: getpresets")
178
179       # Read preset menus
180       presets={}
181       presetmenus={}; presetmenus['point']=[]; presetmenus['way']=[]; presetmenus['POI']=[]
182       presetnames={}; presetnames['point']={}; presetnames['way']={}; presetnames['POI']={}
183       presettype=''
184       presetcategory=''
185       # StringIO.open(txt) do |file|
186       File.open("#{Rails.root}/config/potlatch/presets.txt") do |file|
187         file.each_line {|line|
188           t=line.chomp
189           if (t=~/(\w+)\/(\w+)/) then
190             presettype=$1
191             presetcategory=$2
192             presetmenus[presettype].push(presetcategory)
193             presetnames[presettype][presetcategory]=["(no preset)"]
194           elsif (t=~/^([\w\s]+):\s?(.+)$/) then
195             pre=$1; kv=$2
196             presetnames[presettype][presetcategory].push(pre)
197             presets[pre]={}
198             kv.split(',').each {|a|
199               if (a=~/^(.+)=(.*)$/) then presets[pre][$1]=$2 end
200             }
201           end
202         }
203       end
204
205       # Read colours/styling
206       colours={}; casing={}; areas={}
207       File.open("#{Rails.root}/config/potlatch/colours.txt") do |file|
208         file.each_line {|line|
209           t=line.chomp
210           if (t=~/(\w+)\s+([^\s]+)\s+([^\s]+)\s+([^\s]+)/) then
211             tag=$1
212             if ($2!='-') then colours[tag]=$2.hex end
213             if ($3!='-') then casing[tag]=$3.hex end
214             if ($4!='-') then areas[tag]=$4.hex end
215           end
216         }
217       end
218
219       # Read relations colours/styling
220       relcolours={}; relalphas={}; relwidths={}
221       File.open("#{Rails.root}/config/potlatch/relation_colours.txt") do |file|
222         file.each_line {|line|
223           t=line.chomp
224           if (t=~/(\w+)\s+([^\s]+)\s+([^\s]+)\s+([^\s]+)/) then
225             tag=$1
226             if ($2!='-') then relcolours[tag]=$2.hex end
227             if ($3!='-') then relalphas[tag]=$3.to_i end
228             if ($4!='-') then relwidths[tag]=$4.to_i end
229           end
230         }
231       end
232
233       # Read POI presets
234       icon_list=[]; icon_tags={};
235       File.open("#{Rails.root}/config/potlatch/icon_presets.txt") do |file|
236         file.each_line {|line|
237           (icon,tags)=line.chomp.split("\t")
238           icon_list.push(icon)
239           icon_tags[icon]=Hash[*tags.scan(/([^;=]+)=([^;=]+)/).flatten]
240         }
241       end
242       icon_list.reverse!
243       
244       # Read auto-complete
245       autotags={}; autotags['point']={}; autotags['way']={}; autotags['POI']={};
246       File.open("#{Rails.root}/config/potlatch/autocomplete.txt") do |file|
247         file.each_line {|line|
248           t=line.chomp
249           if (t=~/^([\w:]+)\/(\w+)\s+(.+)$/) then
250             tag=$1; type=$2; values=$3
251             if values=='-' then autotags[type][tag]=[]
252             else autotags[type][tag]=values.split(',').sort.reverse end
253           end
254         }
255       end
256
257       [presets,presetmenus,presetnames,colours,casing,areas,autotags,relcolours,relalphas,relwidths,icon_list,{},icon_tags]
258     end
259   end
260
261 end
262