Merge remote-tracking branch 'upstream/master' into vagrant

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

diff --git a/app/models/way.rb b/app/models/way.rb
index dbc1197a9e039ec003b1e623e92bdf97e9c1faf2..1da048c96b00b39c3c2bd91028949bb531c9efa2 100644 (file)
--- a/app/models/way.rb
+++ b/app/models/way.rb
@@ -2,20 +2,22 @@ class Way < ActiveRecord::Base
   require 'xml/libxml'
   
   include ConsistencyValidations
   require 'xml/libxml'
   
   include ConsistencyValidations

+  include NotRedactable
+  include ObjectMetadata

 
 

-  set_table_name 'current_ways'
+  self.table_name = "current_ways"

   
   belongs_to :changeset
 
   
   belongs_to :changeset
 

-  has_many :old_ways, :foreign_key => 'id', :order => 'version'
+  has_many :old_ways, -> { order(:version) }

 
 

-  has_many :way_nodes, :foreign_key => 'id', :order => 'sequence_id'
-  has_many :nodes, :through => :way_nodes, :order => 'sequence_id'
+  has_many :way_nodes, -> { order(:sequence_id) }
+  has_many :nodes, -> { order("sequence_id") }, :through => :way_nodes

 
 

-  has_many :way_tags, :foreign_key => 'id'
+  has_many :way_tags

 
   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
 
   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_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation

 
   validates_presence_of :id, :on => :update
   validates_presence_of :changeset_id,:version,  :timestamp
 
   validates_presence_of :id, :on => :update
   validates_presence_of :changeset_id,:version,  :timestamp


@@ -25,6 +27,10 @@ class Way < ActiveRecord::Base
   validates_numericality_of :id, :on => :update, :integer_only => true
   validates_associated :changeset
 
   validates_numericality_of :id, :on => :update, :integer_only => true
   validates_associated :changeset
 

+  scope :visible, -> { where(:visible => true) }
+  scope :invisible, -> { where(:visible => false) }
+
+  # Read in xml as text and return it's Way object representation

   def self.from_xml(xml, create=false)
     begin
       p = XML::Parser.string(xml)
   def self.from_xml(xml, create=false)
     begin
       p = XML::Parser.string(xml)


@@ -33,7 +39,8 @@ class Way < ActiveRecord::Base
       doc.find('//osm/way').each do |pt|
         return Way.from_xml_node(pt, create)
       end
       doc.find('//osm/way').each do |pt|
         return Way.from_xml_node(pt, create)
       end

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

       raise OSM::APIBadXMLError.new("way", xml, ex.message)
     end
   end
       raise OSM::APIBadXMLError.new("way", xml, ex.message)
     end
   end


@@ -41,27 +48,31 @@ class Way < ActiveRecord::Base
   def self.from_xml_node(pt, create=false)
     way = Way.new
 
   def self.from_xml_node(pt, create=false)
     way = Way.new
 

-    if !create and pt['id'] != '0'
-      way.id = pt['id'].to_i
-    end
-    
+    raise OSM::APIBadXMLError.new("way", pt, "Version is required when updating") unless create or not pt['version'].nil?

     way.version = pt['version']
     way.version = pt['version']

-    raise OSM::APIBadXMLError.new("node", pt, "Changeset is required") if pt['changeset'].nil?
+    raise OSM::APIBadXMLError.new("way", pt, "Changeset id is missing") if pt['changeset'].nil?

     way.changeset_id = pt['changeset']
 
     way.changeset_id = pt['changeset']
 

-    # This next section isn't required for the create, update, or delete of ways
-    if create
-      way.timestamp = Time.now
-      way.visible = true
-    else
-      if pt['timestamp']
-        way.timestamp = Time.parse(pt['timestamp'])
-      end
-      # if visible isn't present then it defaults to true
-      way.visible = (pt['visible'] or true)
+    unless create
+      raise OSM::APIBadXMLError.new("way", pt, "ID is required when updating") if pt['id'].nil?
+      way.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 way cannot be zero when updating.") if way.id == 0

     end
 
     end
 

+    # We don't care about the timestamp nor the visibility as these are either
+    # set explicitly or implicit in the action. The visibility is set to true, 
+    # and manually set to false before the actual delete.
+    way.visible = true
+
+    # Start with no tags
+    way.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("way", pt, "tag is missing key") if tag['k'].nil?
+      raise OSM::APIBadXMLError.new("way", pt, "tag is missing value") if tag['v'].nil?

       way.add_tag_keyval(tag['k'], tag['v'])
     end
 
       way.add_tag_keyval(tag['k'], tag['v'])
     end
 


@@ -89,28 +100,11 @@ class Way < ActiveRecord::Base
     return doc
   end
 
     return doc
   end
 

-  def to_xml_node(visible_nodes = nil, user_display_name_cache = nil)
-    el1 = XML::Node.new 'way'
-    el1['id'] = self.id.to_s
-    el1['visible'] = self.visible.to_s
-    el1['timestamp'] = self.timestamp.xmlschema
-    el1['version'] = self.version.to_s
-    el1['changeset'] = self.changeset_id.to_s
-
-    user_display_name_cache = {} if user_display_name_cache.nil?
-
-    if user_display_name_cache and user_display_name_cache.key?(self.changeset.user_id)
-      # use the cache if available
-    elsif self.changeset.user.data_public?
-      user_display_name_cache[self.changeset.user_id] = self.changeset.user.display_name
-    else
-      user_display_name_cache[self.changeset.user_id] = nil
-    end
+  def to_xml_node(visible_nodes = nil, changeset_cache = {}, user_display_name_cache = {})
+    el = XML::Node.new 'way'
+    el['id'] = self.id.to_s

 
 

-    if not user_display_name_cache[self.changeset.user_id].nil?
-      el1['user'] = user_display_name_cache[self.changeset.user_id]
-      el1['uid'] = self.changeset.user_id.to_s
-    end
+    add_metadata_to_xml_node(el, self, changeset_cache, user_display_name_cache)

 
     # make sure nodes are output in sequence_id order
     ordered_nodes = []
 
     # make sure nodes are output in sequence_id order
     ordered_nodes = []


@@ -130,39 +124,23 @@ class Way < ActiveRecord::Base
 
     ordered_nodes.each do |nd_id|
       if nd_id and nd_id != '0'
 
     ordered_nodes.each do |nd_id|
       if nd_id and nd_id != '0'

-        e = XML::Node.new 'nd'
-        e['ref'] = nd_id
-        el1 << e
+        node_el = XML::Node.new 'nd'
+        node_el['ref'] = nd_id
+        el << node_el

       end
     end
 
       end
     end
 

-    self.way_tags.each do |tag|
-      e = XML::Node.new 'tag'
-      e['k'] = tag.k
-      e['v'] = tag.v
-      el1 << e
-    end
-    return el1
+    add_tags_to_xml_node(el, self.way_tags)
+
+    return el

   end 
 
   def nds
   end 
 
   def nds

-    unless @nds
-      @nds = Array.new
-      self.way_nodes.each do |nd|
-        @nds += [nd.node_id]
-      end
-    end
-    @nds
+    @nds ||= self.way_nodes.collect { |n| n.node_id }

   end
 
   def tags
   end
 
   def tags

-    unless @tags
-      @tags = {}
-      self.way_tags.each do |tag|
-        @tags[tag.k] = tag.v
-      end
-    end
-    @tags
+    @tags ||= Hash[self.way_tags.collect { |t| [t.k, t.v] }]

   end
 
   def nds=(s)
   end
 
   def nds=(s)


@@ -194,78 +172,80 @@ class Way < ActiveRecord::Base
   def bbox
     lons = nodes.collect { |n| n.longitude }
     lats = nodes.collect { |n| n.latitude }
   def bbox
     lons = nodes.collect { |n| n.longitude }
     lats = nodes.collect { |n| n.latitude }

-    [ lons.min, lats.min, lons.max, lats.max ]
+    BoundingBox.new(lons.min, lats.min, lons.max, lats.max)

   end
 
   def update_from(new_way, user)
   end
 
   def update_from(new_way, user)

-    check_consistency(self, new_way, user)
-    if !new_way.preconditions_ok?
-      raise OSM::APIPreconditionFailedError.new
+    Way.transaction do
+      self.lock!
+      check_consistency(self, new_way, user)
+      unless new_way.preconditions_ok?(self.nds)
+        raise OSM::APIPreconditionFailedError.new("Cannot update way #{self.id}: data is invalid.")
+      end
+      
+      self.changeset_id = new_way.changeset_id
+      self.changeset = new_way.changeset
+      self.tags = new_way.tags
+      self.nds = new_way.nds
+      self.visible = true
+      save_with_history!

     end
     end

-    self.changeset_id = new_way.changeset_id
-    self.tags = new_way.tags
-    self.nds = new_way.nds
-    self.visible = true
-    save_with_history!

   end
 
   def create_with_history(user)
     check_create_consistency(self, user)
   end
 
   def create_with_history(user)
     check_create_consistency(self, user)

-    if !self.preconditions_ok?
-      raise OSM::APIPreconditionFailedError.new
+    unless self.preconditions_ok?
+      raise OSM::APIPreconditionFailedError.new("Cannot create way: data is invalid.")

     end
     self.version = 0
     self.visible = true
     save_with_history!
   end
 
     end
     self.version = 0
     self.visible = true
     save_with_history!
   end
 

-  def preconditions_ok?
+  def preconditions_ok?(old_nodes = [])

     return false if self.nds.empty?
     return false if self.nds.empty?

-    if self.nds.length > APP_CONFIG['max_number_of_way_nodes']
-      raise OSM::APITooManyWayNodesError.new(self.nds.count, APP_CONFIG['max_number_of_way_nodes'])
+    if self.nds.length > MAX_NUMBER_OF_WAY_NODES
+      raise OSM::APITooManyWayNodesError.new(self.id, self.nds.length, MAX_NUMBER_OF_WAY_NODES)

     end
     end

-    self.nds.each do |n|
-      node = Node.find(:first, :conditions => ["id = ?", n])
-      unless node and node.visible
-        raise OSM::APIPreconditionFailedError.new("The node with id #{n} either does not exist, or is not visible")
+
+    # check only the new nodes, for efficiency - old nodes having been checked last time and can't
+    # be deleted when they're in-use.
+    new_nds = (self.nds - old_nodes).sort.uniq
+
+    unless new_nds.empty?
+      db_nds = Node.where(:id => new_nds, :visible => true)
+
+      if db_nds.length < new_nds.length
+        missing = new_nds - db_nds.collect { |n| n.id }
+        raise OSM::APIPreconditionFailedError.new("Way #{self.id} requires the nodes with id in (#{missing.join(',')}), which either do not exist, or are not visible.")

       end
     end
       end
     end

+

     return true
   end
 
   def delete_with_history!(new_way, user)
     unless self.visible
     return true
   end
 
   def delete_with_history!(new_way, user)
     unless self.visible

-      raise OSM::APIAlreadyDeletedError
+      raise OSM::APIAlreadyDeletedError.new("way", new_way.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.
     Way.transaction do
     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.
     Way.transaction do

+      self.lock!

       check_consistency(self, new_way, user)
       check_consistency(self, new_way, user)

-      if RelationMember.find(:first, :joins => "INNER JOIN current_relations ON current_relations.id=current_relation_members.id",
-                             :conditions => [ "visible = ? AND member_type='way' and member_id=? ", true, self.id])
-        raise OSM::APIPreconditionFailedError.new("You need to make sure that this way is not a member of a relation.")
-      else
-        self.changeset_id = new_way.changeset_id
-        self.tags = []
-        self.nds = []
-        self.visible = false
-        save_with_history!
-      end
-    end
-  end
+      rels = Relation.joins(:relation_members).where(:visible => true, :current_relation_members => { :member_type => "Way", :member_id => id }).order(:id)
+      raise OSM::APIPreconditionFailedError.new("Way #{self.id} is still used by relations #{rels.collect { |r| r.id }.join(",")}.") unless rels.empty?

 
 

-  # Find nodes that belong to this way only
-  def unshared_node_ids
-    node_ids = self.nodes.collect { |node| node.id }
+      self.changeset_id = new_way.changeset_id
+      self.changeset = new_way.changeset

 
 

-    unless node_ids.empty?
-      way_nodes = WayNode.find(:all, :conditions => "node_id in (#{node_ids.join(',')}) and id != #{self.id}")
-      node_ids = node_ids - way_nodes.collect { |way_node| way_node.node_id }
+      self.tags = []
+      self.nds = []
+      self.visible = false
+      save_with_history!

     end
     end

-
-    return node_ids

   end
 
   # Temporary method to match interface to nodes
   end
 
   # Temporary method to match interface to nodes


@@ -277,11 +257,11 @@ class Way < ActiveRecord::Base
   # if any referenced nodes are placeholder IDs (i.e: are negative) then
   # this calling this method will fix them using the map from placeholders 
   # to IDs +id_map+. 
   # if any referenced nodes are placeholder IDs (i.e: are negative) then
   # this calling this method will fix them using the map from placeholders 
   # to IDs +id_map+. 

-  def fix_placeholders!(id_map)
+  def fix_placeholders!(id_map, placeholder_id = nil)

     self.nds.map! do |node_id|
       if node_id < 0
         new_id = id_map[:node][node_id]
     self.nds.map! do |node_id|
       if node_id < 0
         new_id = id_map[:node][node_id]

-        raise "invalid placeholder for #{node_id.inspect}: #{new_id.inspect}" if new_id.nil?
+        raise OSM::APIBadUserInput.new("Placeholder node not found for reference #{node_id} in way #{self.id.nil? ? placeholder_id : self.id}") if new_id.nil?

         new_id
       else
         node_id
         new_id
       else
         node_id


@@ -292,13 +272,14 @@ class Way < ActiveRecord::Base
   private
   
   def save_with_history!
   private
   
   def save_with_history!

-    t = Time.now
+    t = Time.now.getutc

 
 

-    # update the bounding box, but don't save it as the controller knows the 
-    # lifetime of the change better. note that this has to be done both before 
+    # update the bounding box, note that this has to be done both before 

     # and after the save, so that nodes from both versions are included in the 
     # and after the save, so that nodes from both versions are included in the 

-    # bbox.
-    changeset.update_bbox!(bbox) unless nodes.empty?
+    # bbox. we use a copy of the changeset so that it isn't reloaded
+    # later in the save.
+    cs = self.changeset
+    cs.update_bbox!(bbox) unless nodes.empty?

 
     Way.transaction do
       self.version += 1
 
     Way.transaction do
       self.version += 1


@@ -306,17 +287,17 @@ class Way < ActiveRecord::Base
       self.save!
 
       tags = self.tags
       self.save!
 
       tags = self.tags

-      WayTag.delete_all(['id = ?', self.id])
+      WayTag.delete_all(:way_id => self.id)

       tags.each do |k,v|
         tag = WayTag.new
       tags.each do |k,v|
         tag = WayTag.new

+        tag.way_id = self.id

         tag.k = k
         tag.v = v
         tag.k = k
         tag.v = v

-        tag.id = self.id

         tag.save!
       end
 
       nds = self.nds
         tag.save!
       end
 
       nds = self.nds

-      WayNode.delete_all(['id = ?', self.id])
+      WayNode.delete_all(:way_id => self.id)

       sequence = 1
       nds.each do |n|
         nd = WayNode.new
       sequence = 1
       nds.each do |n|
         nd = WayNode.new


@@ -330,15 +311,18 @@ class Way < ActiveRecord::Base
       old_way.timestamp = t
       old_way.save_with_dependencies!
 
       old_way.timestamp = t
       old_way.save_with_dependencies!
 

+      # reload the way so that the nodes array points to the correct
+      # new set of nodes.
+      self.reload
+

       # update and commit the bounding box, now that way nodes 
       # have been updated and we're in a transaction.
       # update and commit the bounding box, now that way nodes 
       # have been updated and we're in a transaction.

-      changeset.update_bbox!(bbox) unless nodes.empty?
+      cs.update_bbox!(bbox) unless nodes.empty?

 
       # tell the changeset we updated one element only
 
       # tell the changeset we updated one element only

-      changeset.add_changes! 1
+      cs.add_changes! 1

 
 

-      changeset.save!
+      cs.save!

     end
   end
     end
   end

-

 end
 end