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