Localise notes interface

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

diff --git a/app/models/node.rb b/app/models/node.rb
index 2efdb1bc93b58ce7f73c38bf67425c5123bb462d..2f528076eba632140ac85df651960617c78c5883 100644 (file)
--- a/app/models/node.rb
+++ b/app/models/node.rb
@@ -2,22 +2,19 @@ class Node < ActiveRecord::Base
   require 'xml/libxml'
 
   include GeoRecord
   require 'xml/libxml'
 
   include GeoRecord

+  include ConsistencyValidations
+  include NotRedactable

 
 

-  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
+  self.table_name = "current_nodes"

 
   belongs_to :changeset
 
 
   belongs_to :changeset
 

-  has_many :old_nodes, :foreign_key => :id
+  has_many :old_nodes, :order => :version

 
   has_many :way_nodes
   has_many :ways, :through => :way_nodes
 
 
   has_many :way_nodes
   has_many :ways, :through => :way_nodes
 

-  has_many :node_tags, :foreign_key => :id
+  has_many :node_tags

   
   has_many :old_way_nodes
   has_many :ways_via_history, :class_name=> "Way", :through => :old_way_nodes, :source => :way
   
   has_many :old_way_nodes
   has_many :ways_via_history, :class_name=> "Way", :through => :old_way_nodes, :source => :way


@@ -25,9 +22,21 @@ class Node < ActiveRecord::Base
   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
 
   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
+
+  scope :visible, where(:visible => true)
+  scope :invisible, where(:visible => false)
+

   # Sanity check the latitude and longitude and add an error if it's broken
   def validate_position
   # 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?
+    errors.add(:base, "Node is not in the world") unless in_world?

   end
 
   #
   end
 
   #


@@ -36,7 +45,6 @@ class Node < ActiveRecord::Base
   # Also adheres to limitations such as within max_number_of_nodes
   #
   def self.search(bounding_box, tags = {})
   # 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 })
     # @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 })


@@ -51,111 +59,136 @@ class Node < ActiveRecord::Base
     #end 
     #conditions = keys.join(' AND ')
  
     #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)  
+    find_by_area(bounding_box, :conditions => {:visible => true},
+                       :limit => MAX_NUMBER_OF_NODES+1)

   end
 
   # Read in xml as text and return it's Node object representation
   def self.from_xml(xml, create=false)
     begin
   end
 
   # 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
+      p = XML::Parser.string(xml)

       doc = p.parse
 
       doc.find('//osm/node').each do |pt|
         return Node.from_xml_node(pt, create)
       end
       doc = p.parse
 
       doc.find('//osm/node').each do |pt|
         return Node.from_xml_node(pt, create)
       end

-    rescue
-      return nil
+      raise OSM::APIBadXMLError.new("node", xml, "XML doesn't contain an osm/node element.")
+    rescue LibXML::XML::Error, ArgumentError => ex
+      raise OSM::APIBadXMLError.new("node", xml, ex.message)

     end
   end
 
   def self.from_xml_node(pt, create=false)
     node = Node.new
     
     end
   end
 
   def self.from_xml_node(pt, create=false)
     node = Node.new
     

-    node.version = pt['version']
+    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
     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
+
+    raise OSM::APIBadUserInput.new("The node is outside this world") unless node.in_world?

 
 

-    return nil 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

 
     unless create
 
     unless create

-      if pt['id'] != '0'
-        node.id = pt['id'].to_i
-      end
+      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
 
     end
 

-    node.visible = pt['visible'] and pt['visible'] == 'true'
-
-    if create
-      node.timestamp = Time.now
-    else
-      if pt['timestamp']
-        node.timestamp = Time.parse(pt['timestamp'])
-      end
-    end
+    # 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

 
 

-    tags = []
+    # Start with no tags
+    node.tags = Hash.new

 
 

+    # Add in any tags from the XML

     pt.find('tag').each do |tag|
     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
 
       node.add_tag_key_val(tag['k'],tag['v'])
     end
 
     return node
   end
 

-  def save_with_history!
-    t = Time.now
-    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 
+  ##
+  # the bounding box around a node, which is used for determining the changeset's
+  # bounding box
+  def bbox
+    BoundingBox.new(longitude, latitude, longitude, latitude)
+  end

 
 

-      # Create an OldNode
-      old_node = OldNode.from_node(self)
-      old_node.timestamp = t
-      old_node.save_with_dependencies!
+  # 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
     end

-  end

 
 

-  def delete_with_history(user)
-    if self.visible
-      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 ])
-       raise OSM::APIPreconditionFailedError.new
-      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])
-       raise OSM::APIPreconditionFailedError.new
-      else
-       self.user_id = user.id
-       self.visible = 0
-       save_with_history!
-      end
-    else
-      raise OSM::APIAlreadyDeletedError.new
+    # 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)
+      ways = Way.joins(:way_nodes).where(:visible => true, :current_way_nodes => { :node_id => id }).order(:id)
+      raise OSM::APIPreconditionFailedError.new("Node #{self.id} is still used by ways #{ways.collect { |w| w.id }.join(",")}.") unless ways.empty?
+      
+      rels = Relation.joins(:relation_members).where(:visible => true, :current_relation_members => { :member_type => "Node", :member_id => id }).order(:id)
+      raise OSM::APIPreconditionFailedError.new("Node #{self.id} is still used by relations #{rels.collect { |r| r.id }.join(",")}.") unless rels.empty?
+
+      self.changeset_id = new_node.changeset_id
+      self.tags = {}
+      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)
     end
   end
 
   def update_from(new_node, user)

-    if new_node.version != version
-      raise OSM::APIVersionMismatchError.new(new_node.version, version)
+    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

-
-    self.user_id = user.id
-    self.latitude = new_node.latitude 
-    self.longitude = new_node.longitude
-    self.tags = new_node.tags
+  end
+  
+  def create_with_history(user)
+    check_create_consistency(self, user)
+    self.version = 0

     self.visible = true
     self.visible = true

+
+    # update the changeset to include the new location
+    changeset.update_bbox!(bbox)
+

     save_with_history!
   end
 
     save_with_history!
   end
 


@@ -165,23 +198,37 @@ class Node < ActiveRecord::Base
     return doc
   end
 
     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 = XML::Node.new 'node'
     el1['id'] = self.id.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 self.visible?
+      el1['lat'] = self.lat.to_s
+      el1['lon'] = self.lon.to_s
+    end

 
 

-    user_display_name_cache = {} if user_display_name_cache.nil?
+    if changeset_cache.key?(self.changeset_id)
+      # use the cache if available
+    else
+      changeset_cache[self.changeset_id] = self.changeset.user_id
+    end

 
 

-    if user_display_name_cache and user_display_name_cache.key?(self.user_id)
+    user_id = changeset_cache[self.changeset_id]
+
+    if user_display_name_cache.key?(user_id)

       # use the cache if available
       # use the cache if available

-    elsif self.user.data_public?
-      user_display_name_cache[self.user_id] = self.user.display_name
+    elsif self.changeset.user.data_public?
+      user_display_name_cache[user_id] = self.changeset.user.display_name

     else
     else

-      user_display_name_cache[self.user_id] = nil
+      user_display_name_cache[user_id] = nil

     end
 
     end
 

-    el1['user'] = user_display_name_cache[self.user_id] unless user_display_name_cache[self.user_id].nil?
+    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')
 
     self.tags.each do |k,v|
       el2 = XML::Node.new('tag')


@@ -192,7 +239,6 @@ class Node < ActiveRecord::Base
 
     el1['visible'] = self.visible.to_s
     el1['timestamp'] = self.timestamp.xmlschema
 
     el1['visible'] = self.visible.to_s
     el1['timestamp'] = self.timestamp.xmlschema

-    el1['version'] = self.version.to_s

     return el1
   end
 
     return el1
   end
 


@@ -216,9 +262,59 @@ class Node < ActiveRecord::Base
 
   def add_tag_key_val(k,v)
     @tags = Hash.new unless @tags
 
   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
 
     @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(:node_id => self.id)
+      tags.each do |k,v|
+        tag = NodeTag.new
+        tag.node_id = self.id
+        tag.k = k 
+        tag.v = v 
+        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
 end