Fix typo.

[rails.git] / app / models / node.rb

diff --git a/app/models/node.rb b/app/models/node.rb
index 16e681f2ce80e464f8b9b4bdf8c243811f093543..37143ff00c5883a70daeed8717da9cbe25594776 100644 (file)
--- a/app/models/node.rb
+++ b/app/models/node.rb
@@ -1,111 +1,158 @@
-class Node < ActiveRecord::Base
+# The node model represents a current existing node, that is, the latest version. Use OldNode for historical nodes.
+
+class Node < GeoRecord

   require 'xml/libxml'
   require 'xml/libxml'

-  set_table_name 'current_nodes'

 
 

-  validates_numericality_of :latitude
-  validates_numericality_of :longitude
-  # FIXME validate lat and lon within the world
+  set_table_name 'current_nodes'
+  
+  validates_presence_of :user_id, :timestamp
+  validates_inclusion_of :visible, :in => [ true, false ]
+  validates_numericality_of :latitude, :longitude
+  validate :validate_position

 
   has_many :old_nodes, :foreign_key => :id
 
   has_many :old_nodes, :foreign_key => :id

+  has_many :way_nodes

   belongs_to :user
   belongs_to :user

+ 
+  # Sanity check the latitude and longitude and add an error if it's broken
+  def validate_position
+    errors.add_to_base("Node is not in the world") unless in_world?
+  end

 
 

+  # Is this node withing -90 > latitude > 90 and -180 > longitude > 180>
+  # * returns true/false
+  def in_world?
+    return false if self.lat < -90 or self.lat > 90
+    return false if self.lon < -180 or self.lon > 180
+    return true
+  end

 
 

-  def self.from_xml(xml, create=false)
-    p = XML::Parser.new
-    p.string = xml
-    doc = p.parse
-
-    node = Node.new
-
-    doc.find('//osm/node').each do |pt|
-
+  #
+  # Search for nodes matching tags within bounding_box
+  #
+  # Also adheres to limitations such as within max_number_of_nodes
+  #
+  def self.search(bounding_box, tags = {})
+    min_lon, min_lat, max_lon, max_lat = *bounding_box
+    # @fixme a bit of a hack to search for only visible nodes
+    # couldn't think of another to add to tags condition
+    #conditions_hash = tags.merge({ 'visible' => 1 })
+  
+    # using named placeholders http://www.robbyonrails.com/articles/2005/10/21/using-named-placeholders-in-ruby
+    #keys = []
+    #values = {}
+
+    #conditions_hash.each do |key,value|
+    #  keys <<  "#{key} = :#{key}"
+    #  values[key.to_sym] = value
+    #end 
+    #conditions = keys.join(' AND ')
+ 
+    find_by_area(min_lat, min_lon, max_lat, max_lon,
+                    :conditions => 'visible = 1',
+                    :limit => APP_CONFIG['max_number_of_nodes']+1)  
+  end

 
 

-      node.latitude = pt['lat'].to_f
-      node.longitude = pt['lon'].to_f
+  # Read in xml as text and return it's Node object representation
+  def self.from_xml(xml, create=false)
+    begin
+      p = XML::Parser.new
+      p.string = xml
+      doc = p.parse
+  
+      node = Node.new
+
+      doc.find('//osm/node').each do |pt|
+        node.lat = pt['lat'].to_f
+        node.lon = pt['lon'].to_f
+
+        return nil unless node.in_world?
+
+        unless create
+          if pt['id'] != '0'
+            node.id = pt['id'].to_i
+          end
+        end

 
 

-      if node.latitude > 90 or node.latitude < -90 or node.longitude > 180 or node.longitude < -180
-        return nil
-      end
+        node.visible = pt['visible'] and pt['visible'] == 'true'

 
 

-      unless create
-        if pt['id'] != '0'
-          node.id = pt['id'].to_i
+        if create
+          node.timestamp = Time.now
+        else
+          if pt['timestamp']
+            node.timestamp = Time.parse(pt['timestamp'])
+          end

         end
         end

-      end

 
 

-      node.visible = pt['visible'] and pt['visible'] == 'true'
+        tags = []

 
 

-      if create
-        node.timestamp = Time.now
-      else
-        if pt['timestamp']
-          node.timestamp = Time.parse(pt['timestamp'])
+        pt.find('tag').each do |tag|
+          tags << [tag['k'],tag['v']]

         end
         end

-      end

 
 

-      tags = []
-
-      pt.find('tag').each do |tag|
-        tags << [tag['k'],tag['v']]
+        node.tags = Tags.join(tags)

       end
       end

-
-      tags = tags.collect { |k,v| "#{k}=#{v}" }.join(';')
-      tags = '' if tags.nil?
-
-      node.tags = tags
-
+    rescue
+      node = nil

     end
     end

+

     return node
   end
 
     return node
   end
 

-  def save_with_history
-    begin
-      Node.transaction do
-        self.save
-        old_node = OldNode.from_node(self)
-        old_node.save
-      end
-      return true
-    rescue Exception => ex
-      return nil
+  # Save this node with the appropriate OldNode object to represent it's history.
+  def save_with_history!
+    Node.transaction do
+      self.timestamp = Time.now
+      self.save!
+      old_node = OldNode.from_node(self)
+      old_node.save!

     end
   end
 
     end
   end
 

+  # Turn this Node in to a complete OSM XML object with <osm> wrapper

   def to_xml
   def to_xml

-    doc = XML::Document.new
-    doc.encoding = 'UTF-8' 
-    root = XML::Node.new 'osm'
-    root['version'] = API_VERSION
-    root['generator'] = 'OpenStreetMap server'
-    doc.root = root
-    root << to_xml_node()
+    doc = OSM::API.new.get_xml_doc
+    doc.root << to_xml_node()

     return doc
   end
 
     return doc
   end
 

-  def to_xml_node
+  # Turn this Node in to an XML Node without the <osm> wrapper.
+  def to_xml_node(user_display_name_cache = nil)

     el1 = XML::Node.new 'node'
     el1['id'] = self.id.to_s
     el1 = XML::Node.new 'node'
     el1['id'] = self.id.to_s

-    el1['lat'] = self.latitude.to_s
-    el1['lon'] = self.longitude.to_s
-    Node.split_tags(el1, self.tags)
+    el1['lat'] = self.lat.to_s
+    el1['lon'] = self.lon.to_s
+
+    user_display_name_cache = {} if user_display_name_cache.nil?
+
+    if user_display_name_cache and user_display_name_cache.key?(self.user_id)
+      # use the cache if available
+    elsif self.user.data_public?
+      user_display_name_cache[self.user_id] = self.user.display_name
+    else
+      user_display_name_cache[self.user_id] = nil
+    end
+
+    el1['user'] = user_display_name_cache[self.user_id] unless user_display_name_cache[self.user_id].nil?
+
+    Tags.split(self.tags) do |k,v|
+      el2 = XML::Node.new('tag')
+      el2['k'] = k.to_s
+      el2['v'] = v.to_s
+      el1 << el2
+    end
+

     el1['visible'] = self.visible.to_s
     el1['timestamp'] = self.timestamp.xmlschema
     return el1
   end
 
     el1['visible'] = self.visible.to_s
     el1['timestamp'] = self.timestamp.xmlschema
     return el1
   end
 

-  def self.split_tags(el, tags)
-    tags.split(';').each do |tag|
-      parts = tag.split('=')
-      key = ''
-      val = ''
-      key = parts[0].strip unless parts[0].nil?
-      val = parts[1].strip unless parts[1].nil?
-      if key != '' && val != ''
-        el2 = XML::Node.new('tag')
-        el2['k'] = key.to_s
-        el2['v'] = val.to_s
-        el << el2
-      end
+  # Return the node's tags as a Hash of keys and their values
+  def tags_as_hash
+    hash = {}
+    Tags.split(self.tags) do |k,v|
+      hash[k] = v

     end
     end

+    hash

   end
 end
   end
 end