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