use boolean flags when using boolean columns
[rails.git] / app / models / way.rb
1 class Way < ActiveRecord::Base
2   require 'xml/libxml'
3   
4   include ConsistencyValidations
5
6   set_table_name 'current_ways'
7
8   validates_presence_of :changeset_id, :timestamp
9   validates_inclusion_of :visible, :in => [ true, false ]
10   
11   belongs_to :changeset
12
13   has_many :old_ways, :foreign_key => 'id', :order => 'version'
14
15   has_many :way_nodes, :foreign_key => 'id', :order => 'sequence_id'
16   has_many :nodes, :through => :way_nodes, :order => 'sequence_id'
17
18   has_many :way_tags, :foreign_key => 'id'
19
20   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
21   has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation, :extend => ObjectFinder
22
23   def self.from_xml(xml, create=false)
24     begin
25       p = XML::Parser.new
26       p.string = xml
27       doc = p.parse
28
29       doc.find('//osm/way').each do |pt|
30         return Way.from_xml_node(pt, create)
31       end
32     rescue
33       return nil
34     end
35   end
36
37   def self.from_xml_node(pt, create=false)
38     way = Way.new
39
40     if !create and pt['id'] != '0'
41       way.id = pt['id'].to_i
42     end
43     
44     way.version = pt['version']
45     way.changeset_id = pt['changeset']
46
47     if create
48       way.timestamp = Time.now
49       way.visible = true
50     else
51       if pt['timestamp']
52         way.timestamp = Time.parse(pt['timestamp'])
53       end
54       # if visible isn't present then it defaults to true
55       way.visible = (pt['visible'] or true)
56     end
57
58     pt.find('tag').each do |tag|
59       way.add_tag_keyval(tag['k'], tag['v'])
60     end
61
62     pt.find('nd').each do |nd|
63       way.add_nd_num(nd['ref'])
64     end
65
66     return way
67   end
68
69   # Find a way given it's ID, and in a single SQL call also grab its nodes
70   #
71   
72   # You can't pull in all the tags too unless we put a sequence_id on the way_tags table and have a multipart key
73   def self.find_eager(id)
74     way = Way.find(id, :include => {:way_nodes => :node})
75     #If waytag had a multipart key that was real, you could do this:
76     #way = Way.find(id, :include => [:way_tags, {:way_nodes => :node}])
77   end
78
79   # Find a way given it's ID, and in a single SQL call also grab its nodes and tags
80   def to_xml
81     doc = OSM::API.new.get_xml_doc
82     doc.root << to_xml_node()
83     return doc
84   end
85
86   def to_xml_node(visible_nodes = nil, user_display_name_cache = nil)
87     el1 = XML::Node.new 'way'
88     el1['id'] = self.id.to_s
89     el1['visible'] = self.visible.to_s
90     el1['timestamp'] = self.timestamp.xmlschema
91     el1['version'] = self.version.to_s
92     el1['changeset'] = self.changeset_id.to_s
93
94     user_display_name_cache = {} if user_display_name_cache.nil?
95
96     if user_display_name_cache and user_display_name_cache.key?(self.changeset.user_id)
97       # use the cache if available
98     elsif self.changeset.user.data_public?
99       user_display_name_cache[self.changeset.user_id] = self.changeset.user.display_name
100     else
101       user_display_name_cache[self.changeset.user_id] = nil
102     end
103
104     el1['user'] = user_display_name_cache[self.changeset.user_id] unless user_display_name_cache[self.changeset.user_id].nil?
105
106     # make sure nodes are output in sequence_id order
107     ordered_nodes = []
108     self.way_nodes.each do |nd|
109       if visible_nodes
110         # if there is a list of visible nodes then use that to weed out deleted nodes
111         if visible_nodes[nd.node_id]
112           ordered_nodes[nd.sequence_id] = nd.node_id.to_s
113         end
114       else
115         # otherwise, manually go to the db to check things
116         if nd.node.visible? and nd.node.visible?
117           ordered_nodes[nd.sequence_id] = nd.node_id.to_s
118         end
119       end
120     end
121
122     ordered_nodes.each do |nd_id|
123       if nd_id and nd_id != '0'
124         e = XML::Node.new 'nd'
125         e['ref'] = nd_id
126         el1 << e
127       end
128     end
129
130     self.way_tags.each do |tag|
131       e = XML::Node.new 'tag'
132       e['k'] = tag.k
133       e['v'] = tag.v
134       el1 << e
135     end
136     return el1
137   end 
138
139   def nds
140     unless @nds
141       @nds = Array.new
142       self.way_nodes.each do |nd|
143         @nds += [nd.node_id]
144       end
145     end
146     @nds
147   end
148
149   def tags
150     unless @tags
151       @tags = {}
152       self.way_tags.each do |tag|
153         @tags[tag.k] = tag.v
154       end
155     end
156     @tags
157   end
158
159   def nds=(s)
160     @nds = s
161   end
162
163   def tags=(t)
164     @tags = t
165   end
166
167   def add_nd_num(n)
168     @nds = Array.new unless @nds
169     @nds << n.to_i
170   end
171
172   def add_tag_keyval(k, v)
173     @tags = Hash.new unless @tags
174
175     # duplicate tags are now forbidden, so we can't allow values
176     # in the hash to be overwritten.
177     raise OSM::APIDuplicateTagsError.new if @tags.include? k
178
179     @tags[k] = v
180   end
181
182   ##
183   # the integer coords (i.e: unscaled) bounding box of the way, assuming
184   # straight line segments.
185   def bbox
186     lons = nodes.collect { |n| n.longitude }
187     lats = nodes.collect { |n| n.latitude }
188     [ lons.min, lats.min, lons.max, lats.max ]
189   end
190
191   def save_with_history!
192     t = Time.now
193
194     # update the bounding box, but don't save it as the controller knows the 
195     # lifetime of the change better. note that this has to be done both before 
196     # and after the save, so that nodes from both versions are included in the 
197     # bbox.
198     changeset.update_bbox!(bbox) unless nodes.empty?
199
200     Way.transaction do
201       self.version += 1
202       self.timestamp = t
203       self.save!
204
205       tags = self.tags
206       WayTag.delete_all(['id = ?', self.id])
207       tags.each do |k,v|
208         tag = WayTag.new
209         tag.k = k
210         tag.v = v
211         tag.id = self.id
212         tag.save!
213       end
214
215       nds = self.nds
216       WayNode.delete_all(['id = ?', self.id])
217       sequence = 1
218       nds.each do |n|
219         nd = WayNode.new
220         nd.id = [self.id, sequence]
221         nd.node_id = n
222         nd.save!
223         sequence += 1
224       end
225
226       old_way = OldWay.from_way(self)
227       old_way.timestamp = t
228       old_way.save_with_dependencies!
229
230       # update and commit the bounding box, now that way nodes 
231       # have been updated and we're in a transaction.
232       changeset.update_bbox!(bbox) unless nodes.empty?
233       changeset.save!
234     end
235   end
236
237   def update_from(new_way, user)
238     check_consistency(self, new_way, user)
239     if !new_way.preconditions_ok?
240       raise OSM::APIPreconditionFailedError.new
241     end
242     self.changeset_id = new_way.changeset_id
243     self.tags = new_way.tags
244     self.nds = new_way.nds
245     self.visible = true
246     save_with_history!
247   end
248
249   def create_with_history(user)
250     check_create_consistency(self, user)
251     if !self.preconditions_ok?
252       raise OSM::APIPreconditionFailedError.new
253     end
254     self.version = 0
255     self.visible = true
256     save_with_history!
257   end
258
259   def preconditions_ok?
260     return false if self.nds.empty?
261     if self.nds.length > APP_CONFIG['max_number_of_way_nodes']
262       raise OSM::APITooManyWayNodesError.new(self.nds.count, APP_CONFIG['max_number_of_way_nodes'])
263     end
264     self.nds.each do |n|
265       node = Node.find(:first, :conditions => ["id = ?", n])
266       unless node and node.visible
267         return false
268       end
269     end
270     return true
271   end
272
273   def delete_with_history!(new_way, user)
274     check_consistency(self, new_way, user)
275     if self.visible
276       if RelationMember.find(:first, :joins => "INNER JOIN current_relations ON current_relations.id=current_relation_members.id",
277                              :conditions => [ "visible = ? AND member_type='way' and member_id=? ", true, self.id])
278         raise OSM::APIPreconditionFailedError
279       else
280         self.changeset_id = new_way.changeset_id
281         self.tags = []
282         self.nds = []
283         self.visible = false
284         self.save_with_history!
285       end
286     else
287       raise OSM::APIAlreadyDeletedError
288     end
289   end
290
291   # delete a way and it's nodes that aren't part of other ways, with history
292
293   # FIXME: merge the potlatch code to delete the relations
294   def delete_with_relations_and_nodes_and_history(user)
295     # delete the nodes not used by other ways
296     self.unshared_node_ids.each do |node_id|
297       n = Node.find(node_id)
298       n.user_id = user.id
299       n.visible = false
300       n.save_with_history!
301     end
302     
303     # FIXME needs more information passed in so that the changeset can be updated
304     self.user_id = user.id
305
306     self.delete_with_history(user)
307   end
308
309   # Find nodes that belong to this way only
310   def unshared_node_ids
311     node_ids = self.nodes.collect { |node| node.id }
312
313     unless node_ids.empty?
314       way_nodes = WayNode.find(:all, :conditions => "node_id in (#{node_ids.join(',')}) and id != #{self.id}")
315       node_ids = node_ids - way_nodes.collect { |way_node| way_node.node_id }
316     end
317
318     return node_ids
319   end
320
321   # Temporary method to match interface to nodes
322   def tags_as_hash
323     return self.tags
324   end
325
326   ##
327   # if any referenced nodes are placeholder IDs (i.e: are negative) then
328   # this calling this method will fix them using the map from placeholders 
329   # to IDs +id_map+. 
330   def fix_placeholders!(id_map)
331     self.nds.map! do |node_id|
332       if node_id < 0
333         new_id = id_map[:node][node_id]
334         raise "invalid placeholder for #{node_id.inspect}: #{new_id.inspect}" if new_id.nil?
335         new_id
336       else
337         node_id
338       end
339     end
340   end
341
342 end