Adding some amf create poi tests. Minor bugfix tweaks to the amf controller
[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     node.changeset_id = pt['changeset'].to_i
87
88     raise OSM::APIBadUserInput.new("The node is outside this world") unless node.in_world?
89
90     # version must be present unless creating
91     raise OSM::APIBadXMLError.new("node", pt, "Version is required when updating") unless create or not pt['version'].nil?
92     node.version = create ? 0 : pt['version'].to_i
93
94     unless create
95       if pt['id'] != '0'
96         node.id = pt['id'].to_i
97       end
98     end
99
100     # visible if it says it is, or as the default if the attribute
101     # is missing.
102     node.visible = pt['visible'].nil? or pt['visible'] == 'true'
103
104     if create
105       node.timestamp = Time.now
106     else
107       if pt['timestamp']
108         node.timestamp = Time.parse(pt['timestamp'])
109       end
110     end
111
112     tags = []
113
114     pt.find('tag').each do |tag|
115       node.add_tag_key_val(tag['k'],tag['v'])
116     end
117
118     return node
119   end
120
121   ##
122   # the bounding box around a node, which is used for determining the changeset's
123   # bounding box
124   def bbox
125     [ longitude, latitude, longitude, latitude ]
126   end
127
128   # Should probably be renamed delete_from to come in line with update
129   def delete_with_history!(new_node, user)
130     unless self.visible
131       raise OSM::APIAlreadyDeletedError.new
132     end
133
134     # need to start the transaction here, so that the database can 
135     # provide repeatable reads for the used-by checks. this means it
136     # shouldn't be possible to get race conditions.
137     Node.transaction do
138       check_consistency(self, new_node, user)
139       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 ])
140         raise OSM::APIPreconditionFailedError.new
141       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])
142         raise OSM::APIPreconditionFailedError.new
143       else
144         self.changeset_id = new_node.changeset_id
145         self.visible = false
146         
147         # update the changeset with the deleted position
148         changeset.update_bbox!(bbox)
149         
150         save_with_history!
151       end
152     end
153   end
154
155   def update_from(new_node, user)
156     check_consistency(self, new_node, user)
157
158     # update changeset with *old* position first
159     changeset.update_bbox!(bbox);
160
161     # FIXME logic needs to be double checked
162     self.changeset_id = new_node.changeset_id
163     self.latitude = new_node.latitude 
164     self.longitude = new_node.longitude
165     self.tags = new_node.tags
166     self.visible = true
167
168     # update changeset with *new* position
169     changeset.update_bbox!(bbox);
170
171     save_with_history!
172   end
173   
174   def create_with_history(user)
175     check_create_consistency(self, user)
176     self.id = nil
177     self.version = 0
178     self.visible = true
179
180     # update the changeset to include the new location
181     changeset.update_bbox!(bbox)
182
183     save_with_history!
184   end
185
186   def to_xml
187     doc = OSM::API.new.get_xml_doc
188     doc.root << to_xml_node()
189     return doc
190   end
191
192   def to_xml_node(user_display_name_cache = nil)
193     el1 = XML::Node.new 'node'
194     el1['id'] = self.id.to_s
195     el1['lat'] = self.lat.to_s
196     el1['lon'] = self.lon.to_s
197     el1['version'] = self.version.to_s
198     el1['changeset'] = self.changeset_id.to_s
199     
200     user_display_name_cache = {} if user_display_name_cache.nil?
201
202     if user_display_name_cache and user_display_name_cache.key?(self.changeset.user_id)
203       # use the cache if available
204     elsif self.changeset.user.data_public?
205       user_display_name_cache[self.changeset.user_id] = self.changeset.user.display_name
206     else
207       user_display_name_cache[self.changeset.user_id] = nil
208     end
209
210     if not user_display_name_cache[self.changeset.user_id].nil?
211       el1['user'] = user_display_name_cache[self.changeset.user_id]
212       el1['uid'] = self.changeset.user_id.to_s
213     end
214
215     self.tags.each do |k,v|
216       el2 = XML::Node.new('tag')
217       el2['k'] = k.to_s
218       el2['v'] = v.to_s
219       el1 << el2
220     end
221
222     el1['visible'] = self.visible.to_s
223     el1['timestamp'] = self.timestamp.xmlschema
224     return el1
225   end
226
227   def tags_as_hash
228     return tags
229   end
230
231   def tags
232     unless @tags
233       @tags = {}
234       self.node_tags.each do |tag|
235         @tags[tag.k] = tag.v
236       end
237     end
238     @tags
239   end
240
241   def tags=(t)
242     @tags = t 
243   end 
244
245   def add_tag_key_val(k,v)
246     @tags = Hash.new unless @tags
247
248     # duplicate tags are now forbidden, so we can't allow values
249     # in the hash to be overwritten.
250     raise OSM::APIDuplicateTagsError.new("node", self.id, k) if @tags.include? k
251
252     @tags[k] = v
253   end
254
255   ##
256   # are the preconditions OK? this is mainly here to keep the duck
257   # typing interface the same between nodes, ways and relations.
258   def preconditions_ok?
259     in_world?
260   end
261
262   ##
263   # dummy method to make the interfaces of node, way and relation
264   # more consistent.
265   def fix_placeholders!(id_map)
266     # nodes don't refer to anything, so there is nothing to do here
267   end
268   
269   private
270
271   def save_with_history!
272     t = Time.now
273     Node.transaction do
274       self.version += 1
275       self.timestamp = t
276       self.save!
277
278       # Create a NodeTag
279       tags = self.tags
280       NodeTag.delete_all(['id = ?', self.id])
281       tags.each do |k,v|
282         tag = NodeTag.new
283         tag.k = k 
284         tag.v = v 
285         tag.id = self.id
286         tag.save!
287       end 
288
289       # Create an OldNode
290       old_node = OldNode.from_node(self)
291       old_node.timestamp = t
292       old_node.save_with_dependencies!
293
294       # tell the changeset we updated one element only
295       changeset.add_changes! 1
296
297       # save the changeset in case of bounding box updates
298       changeset.save!
299     end
300   end
301   
302 end