Standardise on double quoted strings

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

diff --git a/app/models/way.rb b/app/models/way.rb
index 92d8f735a6e83cebb0561d50c7000955d7201c4f..9b1765d12d3c88ed3d4a41cf8084cce578cc9d2b 100644 (file)
--- a/app/models/way.rb
+++ b/app/models/way.rb
@@ -1,126 +1,112 @@
 class Way < ActiveRecord::Base
 class Way < ActiveRecord::Base

-  require 'xml/libxml'
-  
+  require "xml/libxml"
+

   include ConsistencyValidations
   include ConsistencyValidations

+  include NotRedactable
+  include ObjectMetadata
+
+  self.table_name = "current_ways"

 
 

-  set_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, :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 :id, :on => :update

-  validates_presence_of :changeset_id,:version,  :timestamp
+  validates_presence_of :changeset_id, :version,  :timestamp

   validates_uniqueness_of :id
   validates_uniqueness_of :id

-  validates_inclusion_of :visible, :in => [ true, false ]
+  validates_inclusion_of :visible, :in => [true, false]

   validates_numericality_of :changeset_id, :version, :integer_only => true
   validates_numericality_of :id, :on => :update, :integer_only => true
   validates_associated :changeset
 
   validates_numericality_of :changeset_id, :version, :integer_only => true
   validates_numericality_of :id, :on => :update, :integer_only => true
   validates_associated :changeset
 

-  def self.from_xml(xml, create=false)
-    begin
-      p = XML::Parser.string(xml)
-      doc = p.parse
+  scope :visible, -> { where(:visible => true) }
+  scope :invisible, -> { where(:visible => false) }

 
 

-      doc.find('//osm/way').each do |pt|
-        return Way.from_xml_node(pt, create)
-      end
-    rescue LibXML::XML::Error, ArgumentError => ex
-      raise OSM::APIBadXMLError.new("way", xml, ex.message)
+  # Read in xml as text and return it's Way object representation
+  def self.from_xml(xml, create = false)
+    p = XML::Parser.string(xml)
+    doc = p.parse
+
+    doc.find("//osm/way").each do |pt|
+      return Way.from_xml_node(pt, create)

     end
     end

+    fail 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
 

-  def self.from_xml_node(pt, create=false)
+  def self.from_xml_node(pt, create = false)

     way = Way.new
 
     way = Way.new
 

-    if !create and pt['id'] != '0'
-      way.id = pt['id'].to_i
-    end
-    
-    way.version = pt['version']
-    raise OSM::APIBadXMLError.new("node", pt, "Changeset is required") if pt['changeset'].nil?
-    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.getutc
-      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)
+    fail OSM::APIBadXMLError.new("way", pt, "Version is required when updating") unless create || !pt["version"].nil?
+    way.version = pt["version"]
+    fail OSM::APIBadXMLError.new("way", pt, "Changeset id is missing") if pt["changeset"].nil?
+    way.changeset_id = pt["changeset"]
+
+    unless create
+      fail 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
+      fail OSM::APIBadUserInput.new("ID of way cannot be zero when updating.") if way.id == 0

     end
 
     end
 

-    pt.find('tag').each do |tag|
-      way.add_tag_keyval(tag['k'], tag['v'])
+    # 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 = {}
+
+    # Add in any tags from the XML
+    pt.find("tag").each do |tag|
+      fail OSM::APIBadXMLError.new("way", pt, "tag is missing key") if tag["k"].nil?
+      fail OSM::APIBadXMLError.new("way", pt, "tag is missing value") if tag["v"].nil?
+      way.add_tag_keyval(tag["k"], tag["v"])

     end
 
     end
 

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

     end
 
     end
 

-    return way
+    way

   end
 
   # Find a way given it's ID, and in a single SQL call also grab its nodes
   #
   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)
   # 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}])
+    Way.find(id, :include => { :way_nodes => :node })
+    # If waytag had a multipart key that was real, you could do this:
+    # 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
     doc = OSM::API.new.get_xml_doc
   end
 
   # Find a way given it's ID, and in a single SQL call also grab its nodes and tags
   def to_xml
     doc = OSM::API.new.get_xml_doc

-    doc.root << to_xml_node()
-    return doc
+    doc.root << to_xml_node
+    doc

   end
 
   def to_xml_node(visible_nodes = nil, changeset_cache = {}, user_display_name_cache = {})
   end
 
   def to_xml_node(visible_nodes = nil, changeset_cache = {}, user_display_name_cache = {})

-    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
-
-    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 = XML::Node.new "way"
+    el["id"] = id.to_s

 
 

-    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[user_id] = nil
-    end
-
-    if not user_display_name_cache[user_id].nil?
-      el1['user'] = user_display_name_cache[user_id]
-      el1['uid'] = 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 = []

-    self.way_nodes.each do |nd|
+    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]
       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]


@@ -128,73 +114,48 @@ class Way < ActiveRecord::Base
         end
       else
         # otherwise, manually go to the db to check things
         end
       else
         # otherwise, manually go to the db to check things

-        if nd.node and nd.node.visible?
+        if nd.node && nd.node.visible?

           ordered_nodes[nd.sequence_id] = nd.node_id.to_s
         end
       end
     end
 
     ordered_nodes.each do |nd_id|
           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
+      next unless nd_id && nd_id != "0"

 
 

-    self.way_tags.each do |tag|
-      e = XML::Node.new 'tag'
-      e['k'] = tag.k
-      e['v'] = tag.v
-      el1 << e
+      node_el = XML::Node.new "nd"
+      node_el["ref"] = nd_id
+      el << node_el

     end
     end

-    return el1
-  end 
+
+    add_tags_to_xml_node(el, way_tags)
+
+    el
+  end

 
   def nds
 
   def nds

-    unless @nds
-      @nds = Array.new
-      self.way_nodes.each do |nd|
-        @nds += [nd.node_id]
-      end
-    end
-    @nds
+    @nds ||= way_nodes.collect(&: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[way_tags.collect { |t| [t.k, t.v] }]

   end
 
   end
 

-  def nds=(s)
-    @nds = s
-  end
+  attr_writer :nds

 
 

-  def tags=(t)
-    @tags = t
-  end
+  attr_writer :tags

 
   def add_nd_num(n)
 
   def add_nd_num(n)

-    @nds = Array.new unless @nds
+    @nds = [] unless @nds

     @nds << n.to_i
   end
 
   def add_tag_keyval(k, v)
     @nds << n.to_i
   end
 
   def add_tag_keyval(k, v)

-    @tags = Hash.new unless @tags
+    @tags = {} unless @tags

 
     # duplicate tags are now forbidden, so we can't allow values
     # in the hash to be overwritten.
 
     # duplicate tags are now forbidden, so we can't allow values
     # in the hash to be overwritten.

-    raise OSM::APIDuplicateTagsError.new("way", self.id, k) if @tags.include? k
-
-    # check tag size here, as we don't create a WayTag object until
-    # just before we save...
-    raise OSM::APIBadUserInput.new("Way #{self.id} has a tag with too long a key, '#{k}'.") if k.length > 255
-    raise OSM::APIBadUserInput.new("Way #{self.id} has a tag with too long a value, '#{k}'='#{v}'.") if v.length > 255
+    fail OSM::APIDuplicateTagsError.new("way", id, k) if @tags.include? k

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


@@ -203,63 +164,72 @@ class Way < ActiveRecord::Base
   # the integer coords (i.e: unscaled) bounding box of the way, assuming
   # straight line segments.
   def bbox
   # the integer coords (i.e: unscaled) bounding box of the way, assuming
   # straight line segments.
   def bbox

-    lons = nodes.collect { |n| n.longitude }
-    lats = nodes.collect { |n| n.latitude }
-    [ lons.min, lats.min, lons.max, lats.max ]
+    lons = nodes.collect(&:longitude)
+    lats = nodes.collect(&:latitude)
+    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)
-    unless new_way.preconditions_ok?
-      raise OSM::APIPreconditionFailedError.new("Cannot update way #{self.id}: data is invalid.")
-    end
+    Way.transaction do
+      self.lock!
+      check_consistency(self, new_way, user)
+      unless new_way.preconditions_ok?(nds)
+        fail OSM::APIPreconditionFailedError.new("Cannot update way #{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!
+      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
 
   def create_with_history(user)
     check_create_consistency(self, user)
     unless self.preconditions_ok?
   end
 
   def create_with_history(user)
     check_create_consistency(self, user)
     unless self.preconditions_ok?

-      raise OSM::APIPreconditionFailedError.new("Cannot create way: data is invalid.")
+      fail 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?
-    return false if self.nds.empty?
-    if self.nds.length > APP_CONFIG['max_number_of_way_nodes']
-      raise OSM::APITooManyWayNodesError.new(self.nds.length, APP_CONFIG['max_number_of_way_nodes'])
+  def preconditions_ok?(old_nodes = [])
+    return false if nds.empty?
+    if nds.length > MAX_NUMBER_OF_WAY_NODES
+      fail OSM::APITooManyWayNodesError.new(id, 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("Way #{self.id} requires the node with id #{n}, which 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 = (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(&:id)
+        fail OSM::APIPreconditionFailedError.new("Way #{id} requires the nodes with id in (#{missing.join(',')}), which either do not exist, or are not visible.")

       end
     end
       end
     end

-    return true
+
+    true

   end
 
   def delete_with_history!(new_way, user)
   end
 
   def delete_with_history!(new_way, user)

-    unless self.visible
-      raise OSM::APIAlreadyDeletedError.new("way", new_way.id)
-    end
-    
-    # need to start the transaction here, so that the database can 
+    fail OSM::APIAlreadyDeletedError.new("way", new_way.id) unless visible
+
+    # 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
     # 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)

-      rel = RelationMember.find(:first, :joins => :relation,
-                             :conditions => [ "visible = ? AND member_type='Way' and member_id=? ", true, self.id])
-      raise OSM::APIPreconditionFailedError.new("Way #{self.id} still used by relation #{rel.relation.id}.") if rel
-      
+      rels = Relation.joins(:relation_members).where(:visible => true, :current_relation_members => { :member_type => "Way", :member_id => id }).order(:id)
+      fail OSM::APIPreconditionFailedError.new("Way #{id} is still used by relations #{rels.collect(&:id).join(",")}.") unless rels.empty?
+

       self.changeset_id = new_way.changeset_id
       self.changeset = new_way.changeset
 
       self.changeset_id = new_way.changeset_id
       self.changeset = new_way.changeset
 


@@ -272,18 +242,18 @@ class Way < ActiveRecord::Base
 
   # Temporary method to match interface to nodes
   def tags_as_hash
 
   # Temporary method to match interface to nodes
   def tags_as_hash

-    return self.tags
+    tags

   end
 
   ##
   # if any referenced nodes are placeholder IDs (i.e: are negative) then
   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+. 
+  # this calling this method will fix them using the map from placeholders
+  # to IDs +id_map+.

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

-    self.nds.map! do |node_id|
+    nds.map! do |node_id|

       if node_id < 0
         new_id = id_map[:node][node_id]
       if node_id < 0
         new_id = id_map[:node][node_id]

-        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?
+        fail OSM::APIBadUserInput.new("Placeholder node not found for reference #{node_id} in way #{id.nil? ? placeholder_id : id}") if new_id.nil?

         new_id
       else
         node_id
         new_id
       else
         node_id


@@ -292,15 +262,15 @@ class Way < ActiveRecord::Base
   end
 
   private
   end
 
   private

-  
+

   def save_with_history!
     t = Time.now.getutc
 
   def save_with_history!
     t = Time.now.getutc
 

-    # 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 
+    # 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

     # bbox. we use a copy of the changeset so that it isn't reloaded
     # later in the save.
     # bbox. we use a copy of the changeset so that it isn't reloaded
     # later in the save.

-    cs = self.changeset
+    cs = changeset

     cs.update_bbox!(bbox) unless nodes.empty?
 
     Way.transaction do
     cs.update_bbox!(bbox) unless nodes.empty?
 
     Way.transaction do


@@ -309,21 +279,21 @@ class Way < ActiveRecord::Base
       self.save!
 
       tags = self.tags
       self.save!
 
       tags = self.tags

-      WayTag.delete_all(['id = ?', self.id])
-      tags.each do |k,v|
+      WayTag.delete_all(:way_id => id)
+      tags.each do |k, v|

         tag = WayTag.new
         tag = WayTag.new

+        tag.way_id = 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 => id)

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

-        nd.id = [self.id, sequence]
+        nd.id = [id, sequence]

         nd.node_id = n
         nd.save!
         sequence += 1
         nd.node_id = n
         nd.save!
         sequence += 1


@@ -335,9 +305,9 @@ class Way < ActiveRecord::Base
 
       # reload the way so that the nodes array points to the correct
       # new set of nodes.
 
       # reload the way so that the nodes array points to the correct
       # new set of nodes.

-      self.reload
+      reload

 
 

-      # update and commit the bounding box, now that way nodes 
+      # update and commit the bounding box, now that way nodes

       # have been updated and we're in a transaction.
       cs.update_bbox!(bbox) unless nodes.empty?
 
       # have been updated and we're in a transaction.
       cs.update_bbox!(bbox) unless nodes.empty?
 


@@ -347,5 +317,4 @@ class Way < ActiveRecord::Base
       cs.save!
     end
   end
       cs.save!
     end
   end

-

 end
 end