Merge branch 'master' into openstreetbugs
[rails.git] / app / models / node.rb
1 class Node < ActiveRecord::Base
2   require 'xml/libxml'
3
4   include GeoRecord
5   include ConsistencyValidations
6
7   set_table_name 'current_nodes'
8
9   belongs_to :changeset
10
11   has_many :old_nodes, :foreign_key => :id
12
13   has_many :way_nodes
14   has_many :ways, :through => :way_nodes
15
16   has_many :node_tags, :foreign_key => :id
17   
18   has_many :old_way_nodes
19   has_many :ways_via_history, :class_name=> "Way", :through => :old_way_nodes, :source => :way
20
21   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
22   has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation, :extend => ObjectFinder
23
24   validates_presence_of :id, :on => :update
25   validates_presence_of :timestamp,:version,  :changeset_id
26   validates_uniqueness_of :id
27   validates_inclusion_of :visible, :in => [ true, false ]
28   validates_numericality_of :latitude, :longitude, :changeset_id, :version, :integer_only => true
29   validates_numericality_of :id, :on => :update, :integer_only => true
30   validate :validate_position
31   validates_associated :changeset
32
33   # Sanity check the latitude and longitude and add an error if it's broken
34   def validate_position
35     errors.add_to_base("Node is not in the world") unless in_world?
36   end
37
38   #
39   # Search for nodes matching tags within bounding_box
40   #
41   # Also adheres to limitations such as within max_number_of_nodes
42   #
43   def self.search(bounding_box, tags = {})
44     min_lon, min_lat, max_lon, max_lat = *bounding_box
45     # @fixme a bit of a hack to search for only visible nodes
46     # couldn't think of another to add to tags condition
47     #conditions_hash = tags.merge({ 'visible' => 1 })
48   
49     # using named placeholders http://www.robbyonrails.com/articles/2005/10/21/using-named-placeholders-in-ruby
50     #keys = []
51     #values = {}
52
53     #conditions_hash.each do |key,value|
54     #  keys <<  "#{key} = :#{key}"
55     #  values[key.to_sym] = value
56     #end 
57     #conditions = keys.join(' AND ')
58  
59     find_by_area(min_lat, min_lon, max_lat, max_lon,
60                     :conditions => {:visible => true},
61                     :limit => MAX_NUMBER_OF_NODES+1)  
62   end
63
64   # Read in xml as text and return it's Node object representation
65   def self.from_xml(xml, create=false)
66     begin
67       p = XML::Parser.string(xml)
68       doc = p.parse
69
70       doc.find('//osm/node').each do |pt|
71         return Node.from_xml_node(pt, create)
72       end
73       raise OSM::APIBadXMLError.new("node", xml, "XML doesn't contain an osm/node element.")
74     rescue LibXML::XML::Error, ArgumentError => ex
75       raise OSM::APIBadXMLError.new("node", xml, ex.message)
76     end
77   end
78
79   def self.from_xml_node(pt, create=false)
80     node = Node.new
81     
82     raise OSM::APIBadXMLError.new("node", pt, "lat missing") if pt['lat'].nil?
83     raise OSM::APIBadXMLError.new("node", pt, "lon missing") if pt['lon'].nil?
84     node.lat = pt['lat'].to_f
85     node.lon = pt['lon'].to_f
86     raise OSM::APIBadXMLError.new("node", pt, "Changeset id is missing") if pt['changeset'].nil?
87     node.changeset_id = pt['changeset'].to_i
88
89     raise OSM::APIBadUserInput.new("The node is outside this world") unless node.in_world?
90
91     # version must be present unless creating
92     raise OSM::APIBadXMLError.new("node", pt, "Version is required when updating") unless create or not pt['version'].nil?
93     node.version = create ? 0 : pt['version'].to_i
94
95     unless create
96       raise OSM::APIBadXMLError.new("node", pt, "ID is required when updating.") if pt['id'].nil?
97       node.id = pt['id'].to_i
98       # .to_i will return 0 if there is no number that can be parsed. 
99       # We want to make sure that there is no id with zero anyway
100       raise OSM::APIBadUserInput.new("ID of node cannot be zero when updating.") if node.id == 0
101     end
102
103     # We don't care about the time, as it is explicitly set on create/update/delete
104     # We don't care about the visibility as it is implicit based on the action
105     # and set manually before the actual delete
106     node.visible = true
107
108     pt.find('tag').each do |tag|
109       raise OSM::APIBadXMLError.new("node", pt, "tag is missing key") if tag['k'].nil?
110       raise OSM::APIBadXMLError.new("node", pt, "tag is missing value") if tag['v'].nil?
111       node.add_tag_key_val(tag['k'],tag['v'])
112     end
113
114     return node
115   end
116
117   ##
118   # the bounding box around a node, which is used for determining the changeset's
119   # bounding box
120   def bbox
121     [ longitude, latitude, longitude, latitude ]
122   end
123
124   # Should probably be renamed delete_from to come in line with update
125   def delete_with_history!(new_node, user)
126     unless self.visible
127       raise OSM::APIAlreadyDeletedError.new("node", new_node.id)
128     end
129
130     # need to start the transaction here, so that the database can 
131     # provide repeatable reads for the used-by checks. this means it
132     # shouldn't be possible to get race conditions.
133     Node.transaction do
134       self.lock!
135       check_consistency(self, new_node, user)
136       way = WayNode.find(:first, :joins => :way, 
137                          :conditions => [ "current_ways.visible = ? AND current_way_nodes.node_id = ?", true, self.id ])
138       raise OSM::APIPreconditionFailedError.new("Node #{self.id} is still used by way #{way.way.id}.") unless way.nil?
139       
140       rel = RelationMember.find(:first, :joins => :relation, 
141                                 :conditions => [ "visible = ? AND member_type='Node' and member_id=? ", true, self.id])
142       raise OSM::APIPreconditionFailedError.new("Node #{self.id} is still used by relation #{rel.relation.id}.") unless rel.nil?
143
144       self.changeset_id = new_node.changeset_id
145       self.tags = {}
146       self.visible = false
147       
148       # update the changeset with the deleted position
149       changeset.update_bbox!(bbox)
150       
151       save_with_history!
152     end
153   end
154
155   def update_from(new_node, user)
156     Node.transaction do
157       self.lock!
158       check_consistency(self, new_node, user)
159       
160       # update changeset first
161       self.changeset_id = new_node.changeset_id
162       self.changeset = new_node.changeset
163       
164       # update changeset bbox with *old* position first
165       changeset.update_bbox!(bbox);
166       
167       # FIXME logic needs to be double checked
168       self.latitude = new_node.latitude 
169       self.longitude = new_node.longitude
170       self.tags = new_node.tags
171       self.visible = true
172       
173       # update changeset bbox with *new* position
174       changeset.update_bbox!(bbox);
175       
176       save_with_history!
177     end
178   end
179   
180   def create_with_history(user)
181     check_create_consistency(self, user)
182     self.version = 0
183     self.visible = true
184
185     # update the changeset to include the new location
186     changeset.update_bbox!(bbox)
187
188     save_with_history!
189   end
190
191   def to_xml
192     doc = OSM::API.new.get_xml_doc
193     doc.root << to_xml_node()
194     return doc
195   end
196
197   def to_xml_node(changeset_cache = {}, user_display_name_cache = {})
198     el1 = XML::Node.new 'node'
199     el1['id'] = self.id.to_s
200     el1['lat'] = self.lat.to_s
201     el1['lon'] = self.lon.to_s
202     el1['version'] = self.version.to_s
203     el1['changeset'] = self.changeset_id.to_s
204
205     if changeset_cache.key?(self.changeset_id)
206       # use the cache if available
207     else
208       changeset_cache[self.changeset_id] = self.changeset.user_id
209     end
210
211     user_id = changeset_cache[self.changeset_id]
212
213     if user_display_name_cache.key?(user_id)
214       # use the cache if available
215     elsif self.changeset.user.data_public?
216       user_display_name_cache[user_id] = self.changeset.user.display_name
217     else
218       user_display_name_cache[user_id] = nil
219     end
220
221     if not user_display_name_cache[user_id].nil?
222       el1['user'] = user_display_name_cache[user_id]
223       el1['uid'] = user_id.to_s
224     end
225
226     self.tags.each do |k,v|
227       el2 = XML::Node.new('tag')
228       el2['k'] = k.to_s
229       el2['v'] = v.to_s
230       el1 << el2
231     end
232
233     el1['visible'] = self.visible.to_s
234     el1['timestamp'] = self.timestamp.xmlschema
235     return el1
236   end
237
238   def tags_as_hash
239     return tags
240   end
241
242   def tags
243     unless @tags
244       @tags = {}
245       self.node_tags.each do |tag|
246         @tags[tag.k] = tag.v
247       end
248     end
249     @tags
250   end
251
252   def tags=(t)
253     @tags = t 
254   end 
255
256   def add_tag_key_val(k,v)
257     @tags = Hash.new unless @tags
258
259     # duplicate tags are now forbidden, so we can't allow values
260     # in the hash to be overwritten.
261     raise OSM::APIDuplicateTagsError.new("node", self.id, k) if @tags.include? k
262
263     @tags[k] = v
264   end
265
266   ##
267   # are the preconditions OK? this is mainly here to keep the duck
268   # typing interface the same between nodes, ways and relations.
269   def preconditions_ok?
270     in_world?
271   end
272
273   ##
274   # dummy method to make the interfaces of node, way and relation
275   # more consistent.
276   def fix_placeholders!(id_map, placeholder_id = nil)
277     # nodes don't refer to anything, so there is nothing to do here
278   end
279   
280   private
281
282   def save_with_history!
283     t = Time.now.getutc
284     Node.transaction do
285       self.version += 1
286       self.timestamp = t
287       self.save!
288
289       # Create a NodeTag
290       tags = self.tags
291       NodeTag.delete_all(['id = ?', self.id])
292       tags.each do |k,v|
293         tag = NodeTag.new
294         tag.k = k 
295         tag.v = v 
296         tag.id = self.id
297         tag.save!
298       end 
299
300       # Create an OldNode
301       old_node = OldNode.from_node(self)
302       old_node.timestamp = t
303       old_node.save_with_dependencies!
304
305       # tell the changeset we updated one element only
306       changeset.add_changes! 1
307
308       # save the changeset in case of bounding box updates
309       changeset.save!
310     end
311   end
312   
313 end