Some node documentation
[rails.git] / app / models / node.rb
1 # The node model represents a current existing node, that is, the latest version. Use OldNode for historical nodes.
2
3 class Node < GeoRecord
4   require 'xml/libxml'
5
6   set_table_name 'current_nodes'
7   
8   validates_presence_of :user_id, :timestamp
9   validates_inclusion_of :visible, :in => [ true, false ]
10   validates_numericality_of :latitude, :longitude
11   validate :validate_position
12
13   has_many :old_nodes, :foreign_key => :id
14   has_many :way_nodes
15   belongs_to :user
16  
17   # Sanity check the latitude and longitude and add an error if it's broken
18   def validate_position
19     errors.add_to_base("Node is not in the world") unless in_world?
20   end
21
22   # Is this node withing -90 > latitude > 90 and -180 > longitude > 180>
23   # * returns true/false
24   def in_world?
25     return false if self.lat < -90 or self.lat > 90
26     return false if self.lon < -180 or self.lon > 180
27     return true
28   end
29
30   # Read in xml as text and return it's Node object representation
31   def self.from_xml(xml, create=false)
32     begin
33       p = XML::Parser.new
34       p.string = xml
35       doc = p.parse
36   
37       node = Node.new
38
39       doc.find('//osm/node').each do |pt|
40         node.lat = pt['lat'].to_f
41         node.lon = pt['lon'].to_f
42
43         return nil unless node.in_world?
44
45         unless create
46           if pt['id'] != '0'
47             node.id = pt['id'].to_i
48           end
49         end
50
51         node.visible = pt['visible'] and pt['visible'] == 'true'
52
53         if create
54           node.timestamp = Time.now
55         else
56           if pt['timestamp']
57             node.timestamp = Time.parse(pt['timestamp'])
58           end
59         end
60
61         tags = []
62
63         pt.find('tag').each do |tag|
64           tags << [tag['k'],tag['v']]
65         end
66
67         node.tags = Tags.join(tags)
68       end
69     rescue
70       node = nil
71     end
72
73     return node
74   end
75
76   # Save this node with the appropriate OldNode object to represent it's history.
77   def save_with_history!
78     Node.transaction do
79       self.timestamp = Time.now
80       self.save!
81       old_node = OldNode.from_node(self)
82       old_node.save!
83     end
84   end
85
86   # Turn this Node in to a complete OSM XML object with <osm> wrapper
87   def to_xml
88     doc = OSM::API.new.get_xml_doc
89     doc.root << to_xml_node()
90     return doc
91   end
92
93   # Turn this Node in to an XML Node without the <osm> wrapper.
94   def to_xml_node(user_display_name_cache = nil)
95     el1 = XML::Node.new 'node'
96     el1['id'] = self.id.to_s
97     el1['lat'] = self.lat.to_s
98     el1['lon'] = self.lon.to_s
99
100     user_display_name_cache = {} if user_display_name_cache.nil?
101
102     if user_display_name_cache and user_display_name_cache.key?(self.user_id)
103       # use the cache if available
104     elsif self.user.data_public?
105       user_display_name_cache[self.user_id] = self.user.display_name
106     else
107       user_display_name_cache[self.user_id] = nil
108     end
109
110     el1['user'] = user_display_name_cache[self.user_id] unless user_display_name_cache[self.user_id].nil?
111
112     Tags.split(self.tags) do |k,v|
113       el2 = XML::Node.new('tag')
114       el2['k'] = k.to_s
115       el2['v'] = v.to_s
116       el1 << el2
117     end
118
119     el1['visible'] = self.visible.to_s
120     el1['timestamp'] = self.timestamp.xmlschema
121     return el1
122   end
123
124   # Return the node's tags as a Hash of keys and their values
125   def tags_as_hash
126     hash = {}
127     Tags.split(self.tags) do |k,v|
128       hash[k] = v
129     end
130     hash
131   end
132 end