Additional api tests for the changes. Also making sure that you cannot request a...

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

diff --git a/app/models/way.rb b/app/models/way.rb
index a8724456374be2f339933c6201bcb2bdd8277fe2..9d4d8ba87c0ac13c1ef635a612dfa191577e21e7 100644 (file)
--- a/app/models/way.rb
+++ b/app/models/way.rb
@@ -1,128 +1,322 @@
 class Way < ActiveRecord::Base
   require 'xml/libxml'
   
 class Way < ActiveRecord::Base
   require 'xml/libxml'
   

-  belongs_to :user
+  include ConsistencyValidations
+
+  set_table_name 'current_ways'
+
+  validates_presence_of :changeset_id, :timestamp
+  validates_inclusion_of :visible, :in => [ true, false ]
+  
+  belongs_to :changeset
+
+  has_many :old_ways, :foreign_key => 'id', :order => 'version'
+
+  has_many :way_nodes, :foreign_key => 'id', :order => 'sequence_id'
+  has_many :nodes, :through => :way_nodes, :order => 'sequence_id'

 
 

-  has_many :way_segments, :foreign_key => 'id'

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

-  set_table_name 'current_ways'
+  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

 
   def self.from_xml(xml, create=false)
 
   def self.from_xml(xml, create=false)

-    p = XML::Parser.new
-    p.string = xml
-    doc = p.parse
-
-    way = Way.new
+    begin
+      p = XML::Parser.new
+      p.string = xml
+      doc = p.parse

 
 

-    doc.find('//osm/way').each do |pt|
-      if !create and pt['id'] != '0'
-        way.id = pt['id'].to_i
+      doc.find('//osm/way').each do |pt|
+       return Way.from_xml_node(pt, create)

       end
       end

+    rescue
+      return nil
+    end
+  end

 
 

-      if create
-        way.timestamp = Time.now
-        way.visible = true
-      else
-        if pt['timestamp']
-          way.timestamp = Time.parse(pt['timestamp'])
-        end
-      end
+  def self.from_xml_node(pt, create=false)
+    way = Way.new

 
 

-      pt.find('tag').each do |tag|
-        way.add_tag_keyval(tag['k'], tag['v'])
-      end
+    if !create and pt['id'] != '0'
+      way.id = pt['id'].to_i
+    end
+    
+    way.version = pt['version']
+    way.changeset_id = pt['changeset']

 
 

-      pt.find('seg').each do |seg|
-        way.add_seg_num(seg['id'])
+    if create
+      way.timestamp = Time.now
+      way.visible = true
+    else
+      if pt['timestamp']
+        way.timestamp = Time.parse(pt['timestamp'])

       end
       end

+      # if visible isn't present then it defaults to true
+      way.visible = (pt['visible'] or true)
+    end
+
+    pt.find('tag').each do |tag|
+      way.add_tag_keyval(tag['k'], tag['v'])
+    end

 
 

+    pt.find('nd').each do |nd|
+      way.add_nd_num(nd['ref'])

     end
 
     return way
   end
 
     end
 
     return way
   end
 

+  # Find a way given it's ID, and in a single SQL call also grab its nodes
+  #
+  
+  # You can't pull in all the tags too unless we put a sequence_id on the way_tags table and have a multipart key
+  def self.find_eager(id)
+    way = Way.find(id, :include => {:way_nodes => :node})
+    #If waytag had a multipart key that was real, you could do this:
+    #way = Way.find(id, :include => [:way_tags, {:way_nodes => :node}])
+  end
+
+  # Find a way given it's ID, and in a single SQL call also grab its nodes and tags

   def to_xml
   def to_xml

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

 
 

-    doc.root = root
-    
+  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 = XML::Node.new 'way'
     el1['id'] = self.id.to_s
     el1['visible'] = self.visible.to_s
     el1['timestamp'] = self.timestamp.xmlschema

-    
-    self.way_segments.each do |seg| # FIXME need to make sure they come back in the right order
-      e = XML::Node.new 'seg'
-      e['id'] = seg.segment_id.to_s
-      el1 << e
+    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
     end

- 
+
+    el1['user'] = user_display_name_cache[self.changeset.user_id] unless user_display_name_cache[self.changeset.user_id].nil?
+
+    # make sure nodes are output in sequence_id order
+    ordered_nodes = []
+    self.way_nodes.each do |nd|
+      if visible_nodes
+        # if there is a list of visible nodes then use that to weed out deleted nodes
+        if visible_nodes[nd.node_id]
+          ordered_nodes[nd.sequence_id] = nd.node_id.to_s
+        end
+      else
+        # otherwise, manually go to the db to check things
+        if nd.node.visible? and nd.node.visible?
+          ordered_nodes[nd.sequence_id] = nd.node_id.to_s
+        end
+      end
+    end
+
+    ordered_nodes.each do |nd_id|
+      if nd_id and nd_id != '0'
+        e = XML::Node.new 'nd'
+        e['ref'] = nd_id
+        el1 << e
+      end
+    end
+

     self.way_tags.each do |tag|
       e = XML::Node.new 'tag'
       e['k'] = tag.k
       e['v'] = tag.v
       el1 << e
     end
     self.way_tags.each do |tag|
       e = XML::Node.new 'tag'
       e['k'] = tag.k
       e['v'] = tag.v
       el1 << e
     end

-  
-    root << el1
-    return doc
-  end
+    return el1
+  end 

 
 

-  def segs
-    @segs = Array.new unless @segs
-    @segs
+  def nds
+    unless @nds
+      @nds = Array.new
+      self.way_nodes.each do |nd|
+        @nds += [nd.node_id]
+      end
+    end
+    @nds

   end
 
   def tags
   end
 
   def tags

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

     @tags
   end
 
     @tags
   end
 

-  def add_seg_num(n)
-    @segs = Array.new unless @segs
-    @segs << n.to_i
+  def nds=(s)
+    @nds = s
+  end
+
+  def tags=(t)
+    @tags = t
+  end
+
+  def add_nd_num(n)
+    @nds = Array.new unless @nds
+    @nds << n.to_i

   end
 
   def add_tag_keyval(k, v)
     @tags = Hash.new unless @tags
   end
 
   def add_tag_keyval(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 if @tags.include? k
+

     @tags[k] = v
   end
 
     @tags[k] = v
   end
 

-  def save_with_history
+  def save_with_history!

     t = Time.now
     t = Time.now

-    self.timestamp = t
-    self.save
-    
-    WayTag.delete_all(['id = ?', self.id])

 
 

-    self.tags.each do |k,v|
-      tag = WayTag.new
-      tag.k = k
-      tag.v = v
-      tag.id = self.id
-      tag.save
+    Way.transaction do
+      self.version += 1
+      self.timestamp = t
+      self.save!
+
+      tags = self.tags
+      WayTag.delete_all(['id = ?', self.id])
+      tags.each do |k,v|
+        tag = WayTag.new
+        tag.k = k
+        tag.v = v
+        tag.id = self.id
+        tag.save!
+      end
+
+      nds = self.nds
+      WayNode.delete_all(['id = ?', self.id])
+      sequence = 1
+      nds.each do |n|
+        nd = WayNode.new
+        nd.id = [self.id, sequence]
+        nd.node_id = n
+        nd.save!
+        sequence += 1
+      end
+
+      old_way = OldWay.from_way(self)
+      old_way.timestamp = t
+      old_way.save_with_dependencies!
+    end
+  end
+
+  def update_from(new_way, user)
+    check_consistency(self, new_way, user)
+    if !new_way.preconditions_ok?
+      raise OSM::APIPreconditionFailedError.new

     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)
+    if !self.preconditions_ok?
+      raise OSM::APIPreconditionFailedError.new
+    end
+    self.version = 0
+    self.visible = true
+    save_with_history!
+  end

 
 

-    WaySegment.delete_all(['id = ?', self.id])
+  def preconditions_ok?
+    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'])
+    end
+    self.nds.each do |n|
+      node = Node.find(:first, :conditions => ["id = ?", n])
+      unless node and node.visible
+        return false
+      end
+    end
+    return true
+  end
+
+  def delete_with_history!(new_way, user)
+    check_consistency(self, new_way, user)
+    if self.visible
+      if RelationMember.find(:first, :joins => "INNER JOIN current_relations ON current_relations.id=current_relation_members.id",
+                             :conditions => [ "visible = 1 AND member_type='way' and member_id=? ", self.id])
+        raise OSM::APIPreconditionFailedError
+      else
+        self.changeset_id = new_way.changeset_id
+        self.tags = []
+        self.nds = []
+        self.visible = false
+        self.save_with_history!
+      end
+    else
+      raise OSM::APIAlreadyDeletedError
+    end
+  end
+
+  # delete a way and it's nodes that aren't part of other ways, with history
+
+  # FIXME: merge the potlatch code to delete the relations
+  def delete_with_relations_and_nodes_and_history(user)
+    # delete the nodes not used by other ways
+    self.unshared_node_ids.each do |node_id|
+      n = Node.find(node_id)
+      n.user_id = user.id
+      n.visible = false
+      n.save_with_history!
+    end

     
     

-    i = 0
-    self.segs.each do |n|
-      seg = WaySegment.new
-      seg.id = self.id
-      seg.segment_id = n
-      seg.sequence_id = i
-      seg.save
-      i += 1
-    end
-
-    old_way = OldWay.from_way(self)
-    old_way.timestamp = t
-    old_way.save_with_dependencies
+    # FIXME needs more information passed in so that the changeset can be updated
+    self.user_id = user.id
+
+    self.delete_with_history(user)
+  end
+
+  # Find nodes that belong to this way only
+  def unshared_node_ids
+    node_ids = self.nodes.collect { |node| node.id }
+
+    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 }
+    end
+
+    return node_ids
+  end
+
+  # Temporary method to match interface to nodes
+  def tags_as_hash
+    return self.tags
+  end
+
+  ##
+  # 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)
+    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?
+        new_id
+      else
+        node_id
+      end
+    end

   end
 
 end
   end
 
 end