e78d0df0b048b2143cf8038ed7027c0f711bcf31
[rails.git] / app / models / way.rb
1 class Way < ActiveRecord::Base
2   require 'xml/libxml'
3   
4   include ConsistencyValidations
5   include NotRedactable
6   include ObjectMetadata
7
8   self.table_name = "current_ways"
9   
10   belongs_to :changeset
11
12   has_many :old_ways, -> { order(:version) }
13
14   has_many :way_nodes, -> { order(:sequence_id) }
15   has_many :nodes, :through => :way_nodes
16
17   has_many :way_tags
18
19   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
20   has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation
21
22   validates_presence_of :id, :on => :update
23   validates_presence_of :changeset_id,:version,  :timestamp
24   validates_uniqueness_of :id
25   validates_inclusion_of :visible, :in => [ true, false ]
26   validates_numericality_of :changeset_id, :version, :integer_only => true
27   validates_numericality_of :id, :on => :update, :integer_only => true
28   validates_associated :changeset
29
30   scope :visible, -> { where(:visible => true) }
31   scope :invisible, -> { where(:visible => false) }
32
33   # Read in xml as text and return it's Way object representation
34   def self.from_xml(xml, create=false)
35     begin
36       p = XML::Parser.string(xml)
37       doc = p.parse
38
39       doc.find('//osm/way').each do |pt|
40         return Way.from_xml_node(pt, create)
41       end
42       raise OSM::APIBadXMLError.new("node", xml, "XML doesn't contain an osm/way element.")
43     rescue LibXML::XML::Error, ArgumentError => ex
44       raise OSM::APIBadXMLError.new("way", xml, ex.message)
45     end
46   end
47
48   def self.from_xml_node(pt, create=false)
49     way = Way.new
50
51     raise OSM::APIBadXMLError.new("way", pt, "Version is required when updating") unless create or not pt['version'].nil?
52     way.version = pt['version']
53     raise OSM::APIBadXMLError.new("way", pt, "Changeset id is missing") if pt['changeset'].nil?
54     way.changeset_id = pt['changeset']
55
56     unless create
57       raise OSM::APIBadXMLError.new("way", pt, "ID is required when updating") if pt['id'].nil?
58       way.id = pt['id'].to_i
59       # .to_i will return 0 if there is no number that can be parsed. 
60       # We want to make sure that there is no id with zero anyway
61       raise OSM::APIBadUserInput.new("ID of way cannot be zero when updating.") if way.id == 0
62     end
63
64     # We don't care about the timestamp nor the visibility as these are either
65     # set explicitly or implicit in the action. The visibility is set to true, 
66     # and manually set to false before the actual delete.
67     way.visible = true
68
69     # Start with no tags
70     way.tags = Hash.new
71
72     # Add in any tags from the XML
73     pt.find('tag').each do |tag|
74       raise OSM::APIBadXMLError.new("way", pt, "tag is missing key") if tag['k'].nil?
75       raise OSM::APIBadXMLError.new("way", pt, "tag is missing value") if tag['v'].nil?
76       way.add_tag_keyval(tag['k'], tag['v'])
77     end
78
79     pt.find('nd').each do |nd|
80       way.add_nd_num(nd['ref'])
81     end
82
83     return way
84   end
85
86   # Find a way given it's ID, and in a single SQL call also grab its nodes
87   #
88   
89   # 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
90   def self.find_eager(id)
91     way = Way.find(id, :include => {:way_nodes => :node})
92     #If waytag had a multipart key that was real, you could do this:
93     #way = Way.find(id, :include => [:way_tags, {:way_nodes => :node}])
94   end
95
96   # Find a way given it's ID, and in a single SQL call also grab its nodes and tags
97   def to_xml
98     doc = OSM::API.new.get_xml_doc
99     doc.root << to_xml_node()
100     return doc
101   end
102
103   def to_xml_node(visible_nodes = nil, changeset_cache = {}, user_display_name_cache = {})
104     el = XML::Node.new 'way'
105     el['id'] = self.id.to_s
106
107     add_metadata_to_xml_node(el, self, changeset_cache, user_display_name_cache)
108
109     # make sure nodes are output in sequence_id order
110     ordered_nodes = []
111     self.way_nodes.each do |nd|
112       if visible_nodes
113         # if there is a list of visible nodes then use that to weed out deleted nodes
114         if visible_nodes[nd.node_id]
115           ordered_nodes[nd.sequence_id] = nd.node_id.to_s
116         end
117       else
118         # otherwise, manually go to the db to check things
119         if nd.node and nd.node.visible?
120           ordered_nodes[nd.sequence_id] = nd.node_id.to_s
121         end
122       end
123     end
124
125     ordered_nodes.each do |nd_id|
126       if nd_id and nd_id != '0'
127         node_el = XML::Node.new 'nd'
128         node_el['ref'] = nd_id
129         el << node_el
130       end
131     end
132
133     add_tags_to_xml_node(el, self.way_tags)
134
135     return el
136   end 
137
138   def nds
139     @nds ||= self.way_nodes.collect { |n| n.node_id }
140   end
141
142   def tags
143     @tags ||= Hash[self.way_tags.collect { |t| [t.k, t.v] }]
144   end
145
146   def nds=(s)
147     @nds = s
148   end
149
150   def tags=(t)
151     @tags = t
152   end
153
154   def add_nd_num(n)
155     @nds = Array.new unless @nds
156     @nds << n.to_i
157   end
158
159   def add_tag_keyval(k, v)
160     @tags = Hash.new unless @tags
161
162     # duplicate tags are now forbidden, so we can't allow values
163     # in the hash to be overwritten.
164     raise OSM::APIDuplicateTagsError.new("way", self.id, k) if @tags.include? k
165
166     @tags[k] = v
167   end
168
169   ##
170   # the integer coords (i.e: unscaled) bounding box of the way, assuming
171   # straight line segments.
172   def bbox
173     lons = nodes.collect { |n| n.longitude }
174     lats = nodes.collect { |n| n.latitude }
175     BoundingBox.new(lons.min, lats.min, lons.max, lats.max)
176   end
177
178   def update_from(new_way, user)
179     Way.transaction do
180       self.lock!
181       check_consistency(self, new_way, user)
182       unless new_way.preconditions_ok?(self.nds)
183         raise OSM::APIPreconditionFailedError.new("Cannot update way #{self.id}: data is invalid.")
184       end
185       
186       self.changeset_id = new_way.changeset_id
187       self.changeset = new_way.changeset
188       self.tags = new_way.tags
189       self.nds = new_way.nds
190       self.visible = true
191       save_with_history!
192     end
193   end
194
195   def create_with_history(user)
196     check_create_consistency(self, user)
197     unless self.preconditions_ok?
198       raise OSM::APIPreconditionFailedError.new("Cannot create way: data is invalid.")
199     end
200     self.version = 0
201     self.visible = true
202     save_with_history!
203   end
204
205   def preconditions_ok?(old_nodes = [])
206     return false if self.nds.empty?
207     if self.nds.length > MAX_NUMBER_OF_WAY_NODES
208       raise OSM::APITooManyWayNodesError.new(self.id, self.nds.length, MAX_NUMBER_OF_WAY_NODES)
209     end
210
211     # check only the new nodes, for efficiency - old nodes having been checked last time and can't
212     # be deleted when they're in-use.
213     new_nds = (self.nds - old_nodes).sort.uniq
214
215     unless new_nds.empty?
216       db_nds = Node.where(:id => new_nds, :visible => true)
217
218       if db_nds.length < new_nds.length
219         missing = new_nds - db_nds.collect { |n| n.id }
220         raise OSM::APIPreconditionFailedError.new("Way #{self.id} requires the nodes with id in (#{missing.join(',')}), which either do not exist, or are not visible.")
221       end
222     end
223
224     return true
225   end
226
227   def delete_with_history!(new_way, user)
228     unless self.visible
229       raise OSM::APIAlreadyDeletedError.new("way", new_way.id)
230     end
231     
232     # need to start the transaction here, so that the database can 
233     # provide repeatable reads for the used-by checks. this means it
234     # shouldn't be possible to get race conditions.
235     Way.transaction do
236       self.lock!
237       check_consistency(self, new_way, user)
238       rels = Relation.joins(:relation_members).where(:visible => true, :current_relation_members => { :member_type => "Way", :member_id => id }).order(:id)
239       raise OSM::APIPreconditionFailedError.new("Way #{self.id} is still used by relations #{rels.collect { |r| r.id }.join(",")}.") unless rels.empty?
240
241       self.changeset_id = new_way.changeset_id
242       self.changeset = new_way.changeset
243
244       self.tags = []
245       self.nds = []
246       self.visible = false
247       save_with_history!
248     end
249   end
250
251   # Temporary method to match interface to nodes
252   def tags_as_hash
253     return self.tags
254   end
255
256   ##
257   # if any referenced nodes are placeholder IDs (i.e: are negative) then
258   # this calling this method will fix them using the map from placeholders 
259   # to IDs +id_map+. 
260   def fix_placeholders!(id_map, placeholder_id = nil)
261     self.nds.map! do |node_id|
262       if node_id < 0
263         new_id = id_map[:node][node_id]
264         raise OSM::APIBadUserInput.new("Placeholder node not found for reference #{node_id} in way #{self.id.nil? ? placeholder_id : self.id}") if new_id.nil?
265         new_id
266       else
267         node_id
268       end
269     end
270   end
271
272   private
273   
274   def save_with_history!
275     t = Time.now.getutc
276
277     # update the bounding box, note that this has to be done both before 
278     # and after the save, so that nodes from both versions are included in the 
279     # bbox. we use a copy of the changeset so that it isn't reloaded
280     # later in the save.
281     cs = self.changeset
282     cs.update_bbox!(bbox) unless nodes.empty?
283
284     Way.transaction do
285       self.version += 1
286       self.timestamp = t
287       self.save!
288
289       tags = self.tags
290       WayTag.delete_all(:way_id => self.id)
291       tags.each do |k,v|
292         tag = WayTag.new
293         tag.way_id = self.id
294         tag.k = k
295         tag.v = v
296         tag.save!
297       end
298
299       nds = self.nds
300       WayNode.delete_all(:way_id => self.id)
301       sequence = 1
302       nds.each do |n|
303         nd = WayNode.new
304         nd.id = [self.id, sequence]
305         nd.node_id = n
306         nd.save!
307         sequence += 1
308       end
309
310       old_way = OldWay.from_way(self)
311       old_way.timestamp = t
312       old_way.save_with_dependencies!
313
314       # reload the way so that the nodes array points to the correct
315       # new set of nodes.
316       self.reload
317
318       # update and commit the bounding box, now that way nodes 
319       # have been updated and we're in a transaction.
320       cs.update_bbox!(bbox) unless nodes.empty?
321
322       # tell the changeset we updated one element only
323       cs.add_changes! 1
324
325       cs.save!
326     end
327   end
328 end