resync from rails_port 11795:12304
[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 => APP_CONFIG['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.new
68       p.string = xml
69       doc = p.parse
70
71       doc.find('//osm/node').each do |pt|
72         return Node.from_xml_node(pt, create)
73       end
74     rescue LibXML::XML::Error => 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 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       if pt['id'] != '0'
97         node.id = pt['id'].to_i
98       end
99     end
100
101     # visible if it says it is, or as the default if the attribute
102     # is missing.
103     # Don't need to set the visibility, when it is set explicitly in the create/update/delete
104     #node.visible = pt['visible'].nil? or pt['visible'] == 'true'
105
106     # We don't care about the time, as it is explicitly set on create/update/delete
107
108     tags = []
109
110     pt.find('tag').each do |tag|
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
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       check_consistency(self, new_node, user)
135       if WayNode.find(:first, :joins => "INNER JOIN current_ways ON current_ways.id = current_way_nodes.id", :conditions => [ "current_ways.visible = ? AND current_way_nodes.node_id = ?", true, self.id ])
136         raise OSM::APIPreconditionFailedError.new
137       elsif RelationMember.find(:first, :joins => "INNER JOIN current_relations ON current_relations.id=current_relation_members.id", :conditions => [ "visible = ? AND member_type='node' and member_id=? ", true, self.id])
138         raise OSM::APIPreconditionFailedError.new
139       else
140         self.changeset_id = new_node.changeset_id
141         self.visible = false
142         
143         # update the changeset with the deleted position
144         changeset.update_bbox!(bbox)
145         
146         save_with_history!
147       end
148     end
149   end
150
151   def update_from(new_node, user)
152     check_consistency(self, new_node, user)
153
154     # update changeset with *old* position first
155     changeset.update_bbox!(bbox);
156
157     # FIXME logic needs to be double checked
158     self.changeset_id = new_node.changeset_id
159     self.latitude = new_node.latitude 
160     self.longitude = new_node.longitude
161     self.tags = new_node.tags
162     self.visible = true
163
164     # update changeset with *new* position
165     changeset.update_bbox!(bbox);
166
167     save_with_history!
168   end
169   
170   def create_with_history(user)
171     check_create_consistency(self, user)
172     self.id = nil
173     self.version = 0
174     self.visible = true
175
176     # update the changeset to include the new location
177     changeset.update_bbox!(bbox)
178
179     save_with_history!
180   end
181
182   def to_xml
183     doc = OSM::API.new.get_xml_doc
184     doc.root << to_xml_node()
185     return doc
186   end
187
188   def to_xml_node(user_display_name_cache = nil)
189     el1 = XML::Node.new 'node'
190     el1['id'] = self.id.to_s
191     el1['lat'] = self.lat.to_s
192     el1['lon'] = self.lon.to_s
193     el1['version'] = self.version.to_s
194     el1['changeset'] = self.changeset_id.to_s
195     
196     user_display_name_cache = {} if user_display_name_cache.nil?
197
198     if user_display_name_cache and user_display_name_cache.key?(self.changeset.user_id)
199       # use the cache if available
200     elsif self.changeset.user.data_public?
201       user_display_name_cache[self.changeset.user_id] = self.changeset.user.display_name
202     else
203       user_display_name_cache[self.changeset.user_id] = nil
204     end
205
206     if not user_display_name_cache[self.changeset.user_id].nil?
207       el1['user'] = user_display_name_cache[self.changeset.user_id]
208       el1['uid'] = self.changeset.user_id.to_s
209     end
210
211     self.tags.each do |k,v|
212       el2 = XML::Node.new('tag')
213       el2['k'] = k.to_s
214       el2['v'] = v.to_s
215       el1 << el2
216     end
217
218     el1['visible'] = self.visible.to_s
219     el1['timestamp'] = self.timestamp.xmlschema
220     return el1
221   end
222
223   def tags_as_hash
224     return tags
225   end
226
227   def tags
228     unless @tags
229       @tags = {}
230       self.node_tags.each do |tag|
231         @tags[tag.k] = tag.v
232       end
233     end
234     @tags
235   end
236
237   def tags=(t)
238     @tags = t 
239   end 
240
241   def add_tag_key_val(k,v)
242     @tags = Hash.new unless @tags
243
244     # duplicate tags are now forbidden, so we can't allow values
245     # in the hash to be overwritten.
246     raise OSM::APIDuplicateTagsError.new("node", self.id, k) if @tags.include? k
247
248     @tags[k] = v
249   end
250
251   ##
252   # are the preconditions OK? this is mainly here to keep the duck
253   # typing interface the same between nodes, ways and relations.
254   def preconditions_ok?
255     in_world?
256   end
257
258   ##
259   # dummy method to make the interfaces of node, way and relation
260   # more consistent.
261   def fix_placeholders!(id_map)
262     # nodes don't refer to anything, so there is nothing to do here
263   end
264   
265   private
266
267   def save_with_history!
268     t = Time.now
269     Node.transaction do
270       self.version += 1
271       self.timestamp = t
272       self.save!
273
274       # Create a NodeTag
275       tags = self.tags
276       NodeTag.delete_all(['id = ?', self.id])
277       tags.each do |k,v|
278         tag = NodeTag.new
279         tag.k = k 
280         tag.v = v 
281         tag.id = self.id
282         tag.save!
283       end 
284
285       # Create an OldNode
286       old_node = OldNode.from_node(self)
287       old_node.timestamp = t
288       old_node.save_with_dependencies!
289
290       # tell the changeset we updated one element only
291       changeset.add_changes! 1
292
293       # save the changeset in case of bounding box updates
294       changeset.save!
295     end
296   end
297   
298 end