Added tests for changeset upload code. Refactored diff reading code and put it into...
[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   validates_presence_of :changeset_id, :timestamp
10   validates_inclusion_of :visible, :in => [ true, false ]
11   validates_numericality_of :latitude, :longitude
12   validate :validate_position
13
14   belongs_to :changeset
15
16   has_many :old_nodes, :foreign_key => :id
17
18   has_many :way_nodes
19   has_many :ways, :through => :way_nodes
20
21   has_many :node_tags, :foreign_key => :id
22   
23   has_many :old_way_nodes
24   has_many :ways_via_history, :class_name=> "Way", :through => :old_way_nodes, :source => :way
25
26   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
27   has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation, :extend => ObjectFinder
28
29   # Sanity check the latitude and longitude and add an error if it's broken
30   def validate_position
31     errors.add_to_base("Node is not in the world") unless in_world?
32   end
33
34   #
35   # Search for nodes matching tags within bounding_box
36   #
37   # Also adheres to limitations such as within max_number_of_nodes
38   #
39   def self.search(bounding_box, tags = {})
40     min_lon, min_lat, max_lon, max_lat = *bounding_box
41     # @fixme a bit of a hack to search for only visible nodes
42     # couldn't think of another to add to tags condition
43     #conditions_hash = tags.merge({ 'visible' => 1 })
44   
45     # using named placeholders http://www.robbyonrails.com/articles/2005/10/21/using-named-placeholders-in-ruby
46     #keys = []
47     #values = {}
48
49     #conditions_hash.each do |key,value|
50     #  keys <<  "#{key} = :#{key}"
51     #  values[key.to_sym] = value
52     #end 
53     #conditions = keys.join(' AND ')
54  
55     find_by_area(min_lat, min_lon, max_lat, max_lon,
56                     :conditions => 'visible = 1',
57                     :limit => APP_CONFIG['max_number_of_nodes']+1)  
58   end
59
60   # Read in xml as text and return it's Node object representation
61   def self.from_xml(xml, create=false)
62     begin
63       p = XML::Parser.new
64       p.string = xml
65       doc = p.parse
66
67       doc.find('//osm/node').each do |pt|
68         return Node.from_xml_node(pt, create)
69       end
70     rescue
71       return nil
72     end
73   end
74
75   def self.from_xml_node(pt, create=false)
76     node = Node.new
77     
78     node.lat = pt['lat'].to_f
79     node.lon = pt['lon'].to_f
80     node.changeset_id = pt['changeset'].to_i
81
82     return nil unless node.in_world?
83
84     # version must be present unless creating
85     return nil unless create or not pt['version'].nil?
86     node.version = pt['version'].to_i
87
88     unless create
89       if pt['id'] != '0'
90         node.id = pt['id'].to_i
91       end
92     end
93
94     # visible if it says it is, or as the default if the attribute
95     # is missing.
96     node.visible = pt['visible'].nil? or pt['visible'] == 'true'
97
98     if create
99       node.timestamp = Time.now
100     else
101       if pt['timestamp']
102         node.timestamp = Time.parse(pt['timestamp'])
103       end
104     end
105
106     tags = []
107
108     pt.find('tag').each do |tag|
109       node.add_tag_key_val(tag['k'],tag['v'])
110     end
111
112     return node
113   end
114
115   def save_with_history!
116     t = Time.now
117     Node.transaction do
118       self.version += 1
119       self.timestamp = t
120       self.save!
121
122       # Create a NodeTag
123       tags = self.tags
124       NodeTag.delete_all(['id = ?', self.id])
125       tags.each do |k,v|
126         tag = NodeTag.new
127         tag.k = k 
128         tag.v = v 
129         tag.id = self.id
130         tag.save!
131       end 
132
133       # Create an OldNode
134       old_node = OldNode.from_node(self)
135       old_node.timestamp = t
136       old_node.save_with_dependencies!
137     end
138   end
139
140   # Should probably be renamed delete_from to come in line with update
141   def delete_with_history!(new_node, user)
142     if self.visible
143       check_consistency(self, new_node, user)
144       if WayNode.find(:first, :joins => "INNER JOIN current_ways ON current_ways.id = current_way_nodes.id", :conditions => [ "current_ways.visible = 1 AND current_way_nodes.node_id = ?", self.id ])
145         raise OSM::APIPreconditionFailedError.new
146       elsif RelationMember.find(:first, :joins => "INNER JOIN current_relations ON current_relations.id=current_relation_members.id", :conditions => [ "visible = 1 AND member_type='node' and member_id=? ", self.id])
147         raise OSM::APIPreconditionFailedError.new
148       else
149         self.changeset_id = new_node.changeset_id
150         self.visible = 0
151         save_with_history!
152       end
153     else
154       raise OSM::APIAlreadyDeletedError.new
155     end
156   end
157
158   def update_from(new_node, user)
159     check_consistency(self, new_node, user)
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     save_with_history!
168   end
169   
170   def create_with_history(user)
171     check_create_consistency(self, user)
172     self.version = 0
173     self.visible = true
174     save_with_history!
175   end
176
177   def to_xml
178     doc = OSM::API.new.get_xml_doc
179     doc.root << to_xml_node()
180     return doc
181   end
182
183   def to_xml_node(user_display_name_cache = nil)
184     el1 = XML::Node.new 'node'
185     el1['id'] = self.id.to_s
186     el1['lat'] = self.lat.to_s
187     el1['lon'] = self.lon.to_s
188     el1['version'] = self.version.to_s
189     el1['changeset'] = self.changeset_id.to_s
190     
191     user_display_name_cache = {} if user_display_name_cache.nil?
192
193     if user_display_name_cache and user_display_name_cache.key?(self.changeset.user_id)
194       # use the cache if available
195     elsif self.changeset.user.data_public?
196       user_display_name_cache[self.changeset.user_id] = self.changeset.user.display_name
197     else
198       user_display_name_cache[self.changeset.user_id] = nil
199     end
200
201     el1['user'] = user_display_name_cache[self.changeset.user_id] unless user_display_name_cache[self.changeset.user_id].nil?
202
203     self.tags.each do |k,v|
204       el2 = XML::Node.new('tag')
205       el2['k'] = k.to_s
206       el2['v'] = v.to_s
207       el1 << el2
208     end
209
210     el1['visible'] = self.visible.to_s
211     el1['timestamp'] = self.timestamp.xmlschema
212     return el1
213   end
214
215   def tags_as_hash
216     return tags
217   end
218
219   def tags
220     unless @tags
221       @tags = {}
222       self.node_tags.each do |tag|
223         @tags[tag.k] = tag.v
224       end
225     end
226     @tags
227   end
228
229   def tags=(t)
230     @tags = t 
231   end 
232
233   def add_tag_key_val(k,v)
234     @tags = Hash.new unless @tags
235
236     # duplicate tags are now forbidden, so we can't allow values
237     # in the hash to be overwritten.
238     raise OSM::APIDuplicateTagsError.new if @tags.include? k
239
240     @tags[k] = v
241   end
242
243   ##
244   # dummy method to make the interfaces of node, way and relation
245   # more consistent.
246   def fix_placeholders!(id_map)
247     # nodes don't refer to anything, so there is nothing to do here
248   end
249
250 end