Give a nice error message when parsing the nwr tags and they are missing the k and...
[rails.git] / app / models / node.rb
index 6eecc853d12a585577a95e36c3a1e87331bf5fd4..dd8d96d12aa2116b56be6e2a3b1d986c3a884f9f 100644 (file)
 class Node < ActiveRecord::Base
   require 'xml/libxml'
+
+  include GeoRecord
+  include ConsistencyValidations
+
   set_table_name 'current_nodes'
-  
 
-  validates_numericality_of :latitude
-  validates_numericality_of :longitude
-  # FIXME validate lat and lon within the world
+  belongs_to :changeset
 
   has_many :old_nodes, :foreign_key => :id
-  belongs_to :user
 
-  def self.from_xml(xml, create=false)
-    p = XML::Parser.new
-    p.string = xml
-    doc = p.parse
+  has_many :way_nodes
+  has_many :ways, :through => :way_nodes
 
-    node = Node.new
+  has_many :node_tags, :foreign_key => :id
+  
+  has_many :old_way_nodes
+  has_many :ways_via_history, :class_name=> "Way", :through => :old_way_nodes, :source => :way
 
-    doc.find('//osm/node').each do |pt|
+  has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
+  has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation, :extend => ObjectFinder
 
+  validates_presence_of :id, :on => :update
+  validates_presence_of :timestamp,:version,  :changeset_id
+  validates_uniqueness_of :id
+  validates_inclusion_of :visible, :in => [ true, false ]
+  validates_numericality_of :latitude, :longitude, :changeset_id, :version, :integer_only => true
+  validates_numericality_of :id, :on => :update, :integer_only => true
+  validate :validate_position
+  validates_associated :changeset
 
-      node.latitude = pt['lat'].to_f
-      node.longitude = pt['lon'].to_f
+  # 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
 
-      if node.latitude > 90 or node.latitude < -90 or node.longitude > 180 or node.longitude < -180
-        return nil
-      end
+  #
+  # 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 = {}
 
-      unless create
-        if pt['id'] != '0'
-          node.id = pt['id'].to_i
-        end
-      end
+    #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 => true},
+                    :limit => APP_CONFIG['max_number_of_nodes']+1)  
+  end
 
-      node.visible = pt['visible'] and pt['visible'] == 'true'
+  # Read in xml as text and return it's Node object representation
+  def self.from_xml(xml, create=false)
+    begin
+      p = XML::Parser.string(xml)
+      doc = p.parse
 
-      if create
-        node.timestamp = Time.now
-      else
-        if pt['timestamp']
-          node.timestamp = Time.parse(pt['timestamp'])
-        end
+      doc.find('//osm/node').each do |pt|
+        return Node.from_xml_node(pt, create)
       end
+    rescue LibXML::XML::Error, ArgumentError => ex
+      raise OSM::APIBadXMLError.new("node", xml, ex.message)
+    end
+  end
 
-      tags = []
+  def self.from_xml_node(pt, create=false)
+    node = Node.new
+    
+    raise OSM::APIBadXMLError.new("node", pt, "lat missing") if pt['lat'].nil?
+    raise OSM::APIBadXMLError.new("node", pt, "lon missing") if pt['lon'].nil?
+    node.lat = pt['lat'].to_f
+    node.lon = pt['lon'].to_f
+    raise OSM::APIBadXMLError.new("node", pt, "Changeset id is missing") if pt['changeset'].nil?
+    node.changeset_id = pt['changeset'].to_i
 
-      pt.find('tag').each do |tag|
-        tags << [tag['k'],tag['v']]
-      end
+    raise OSM::APIBadUserInput.new("The node is outside this world") unless node.in_world?
+
+    # version must be present unless creating
+    raise OSM::APIBadXMLError.new("node", pt, "Version is required when updating") unless create or not pt['version'].nil?
+    node.version = create ? 0 : pt['version'].to_i
 
-      tags = tags.collect { |k,v| "#{k}=#{v}" }.join(';')
-      tags = '' if tags.nil?
+    unless create
+      raise OSM::APIBadXMLError.new("node", pt, "ID is required when updating.") if pt['id'].nil?
+      node.id = pt['id'].to_i
+      # .to_i will return 0 if there is no number that can be parsed. 
+      # We want to make sure that there is no id with zero anyway
+      raise OSM::APIBadUserInput.new("ID of node cannot be zero when updating.") if node.id == 0
+    end
 
-      node.tags = tags
+    # We don't care about the time, as it is explicitly set on create/update/delete
+    # We don't care about the visibility as it is implicit based on the action
+    # and set manually before the actual delete
+    node.visible = true
 
+    pt.find('tag').each do |tag|
+      raise OSM::APIBadXMLError.new("node", pt, "tag is missing key") if tag['k'].nil?
+      raise OSM::APIBadXMLError.new("node", pt, "tag is missing value") if tag['v'].nil?
+      node.add_tag_key_val(tag['k'],tag['v'])
     end
+
     return node
   end
 
-  def save_with_history
-    begin
-      Node.transaction do
-        self.timestamp = Time.now
-        self.save
-        old_node = OldNode.from_node(self)
-        old_node.save
-      end
-      return true
-    rescue Exception => ex
-      return nil
+  ##
+  # the bounding box around a node, which is used for determining the changeset's
+  # bounding box
+  def bbox
+    [ longitude, latitude, longitude, latitude ]
+  end
+
+  # Should probably be renamed delete_from to come in line with update
+  def delete_with_history!(new_node, user)
+    unless self.visible
+      raise OSM::APIAlreadyDeletedError.new("node", new_node.id)
     end
+
+    # need to start the transaction here, so that the database can 
+    # provide repeatable reads for the used-by checks. this means it
+    # shouldn't be possible to get race conditions.
+    Node.transaction do
+      self.lock!
+      check_consistency(self, new_node, user)
+      way = WayNode.find(:first, :joins => :way, 
+                         :conditions => [ "current_ways.visible = ? AND current_way_nodes.node_id = ?", true, self.id ])
+      raise OSM::APIPreconditionFailedError.new("Node #{self.id} is still used by way #{way.way.id}.") unless way.nil?
+      
+      rel = RelationMember.find(:first, :joins => :relation, 
+                                :conditions => [ "visible = ? AND member_type='Node' and member_id=? ", true, self.id])
+      raise OSM::APIPreconditionFailedError.new("Node #{self.id} is still used by relation #{rel.relation.id}.") unless rel.nil?
+
+      self.changeset_id = new_node.changeset_id
+      self.visible = false
+      
+      # update the changeset with the deleted position
+      changeset.update_bbox!(bbox)
+      
+      save_with_history!
+    end
+  end
+
+  def update_from(new_node, user)
+    Node.transaction do
+      self.lock!
+      check_consistency(self, new_node, user)
+      
+      # update changeset first
+      self.changeset_id = new_node.changeset_id
+      self.changeset = new_node.changeset
+      
+      # update changeset bbox with *old* position first
+      changeset.update_bbox!(bbox);
+      
+      # FIXME logic needs to be double checked
+      self.latitude = new_node.latitude 
+      self.longitude = new_node.longitude
+      self.tags = new_node.tags
+      self.visible = true
+      
+      # update changeset bbox with *new* position
+      changeset.update_bbox!(bbox);
+      
+      save_with_history!
+    end
+  end
+  
+  def create_with_history(user)
+    check_create_consistency(self, user)
+    self.version = 0
+    self.visible = true
+
+    # update the changeset to include the new location
+    changeset.update_bbox!(bbox)
+
+    save_with_history!
   end
 
   def to_xml
@@ -78,41 +192,120 @@ class Node < ActiveRecord::Base
     return doc
   end
 
-  def to_xml_node(user_display_name_cache = nil)
+  def to_xml_node(changeset_cache = {}, user_display_name_cache = {})
     el1 = XML::Node.new 'node'
     el1['id'] = self.id.to_s
-    el1['lat'] = self.latitude.to_s
-    el1['lon'] = self.longitude.to_s
+    el1['lat'] = self.lat.to_s
+    el1['lon'] = self.lon.to_s
+    el1['version'] = self.version.to_s
+    el1['changeset'] = self.changeset_id.to_s
+
+    if changeset_cache.key?(self.changeset_id)
+      # use the cache if available
+    else
+      changeset_cache[self.changeset_id] = self.changeset.user_id
+    end
+
+    user_id = changeset_cache[self.changeset_id]
 
-    # el['user'] = self.user.display_name if self.user.data_public?
-    user_display_name_cache = {} if user_display_name_cache.nil?
-    if user_display_name_cache and user_display_name_cache[self.user_id]
+    if user_display_name_cache.key?(user_id)
       # use the cache if available
+    elsif self.changeset.user.data_public?
+      user_display_name_cache[user_id] = self.changeset.user.display_name
     else
-      user_display_name_cache[self.user_id] = self.user.display_name
+      user_display_name_cache[user_id] = nil
     end
 
-    el1['user'] = user_display_name_cache[self.user_id]
+    if not user_display_name_cache[user_id].nil?
+      el1['user'] = user_display_name_cache[user_id]
+      el1['uid'] = user_id.to_s
+    end
+
+    self.tags.each do |k,v|
+      el2 = XML::Node.new('tag')
+      el2['k'] = k.to_s
+      el2['v'] = v.to_s
+      el1 << el2
+    end
 
-    Node.split_tags(el1, self.tags)
     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
+  def tags_as_hash
+    return tags
+  end
+
+  def tags
+    unless @tags
+      @tags = {}
+      self.node_tags.each do |tag|
+        @tags[tag.k] = tag.v
       end
     end
+    @tags
   end
+
+  def tags=(t)
+    @tags = t 
+  end 
+
+  def add_tag_key_val(k,v)
+    @tags = Hash.new unless @tags
+
+    # duplicate tags are now forbidden, so we can't allow values
+    # in the hash to be overwritten.
+    raise OSM::APIDuplicateTagsError.new("node", self.id, k) if @tags.include? k
+
+    @tags[k] = v
+  end
+
+  ##
+  # are the preconditions OK? this is mainly here to keep the duck
+  # typing interface the same between nodes, ways and relations.
+  def preconditions_ok?
+    in_world?
+  end
+
+  ##
+  # dummy method to make the interfaces of node, way and relation
+  # more consistent.
+  def fix_placeholders!(id_map, placeholder_id = nil)
+    # nodes don't refer to anything, so there is nothing to do here
+  end
+  
+  private
+
+  def save_with_history!
+    t = Time.now.getutc
+    Node.transaction do
+      self.version += 1
+      self.timestamp = t
+      self.save!
+
+      # Create a NodeTag
+      tags = self.tags
+      NodeTag.delete_all(['id = ?', self.id])
+      tags.each do |k,v|
+        tag = NodeTag.new
+        tag.k = k 
+        tag.v = v 
+        tag.id = self.id
+        tag.save!
+      end 
+
+      # Create an OldNode
+      old_node = OldNode.from_node(self)
+      old_node.timestamp = t
+      old_node.save_with_dependencies!
+
+      # tell the changeset we updated one element only
+      changeset.add_changes! 1
+
+      # save the changeset in case of bounding box updates
+      changeset.save!
+    end
+  end
+  
 end