-class Way < ActiveRecord::Base
- require 'xml/libxml'
+# == Schema Information
+#
+# Table name: current_ways
+#
+# id :bigint(8) not null, primary key
+# changeset_id :bigint(8) not null
+# timestamp :datetime not null
+# visible :boolean not null
+# version :bigint(8) not null
+#
+# Indexes
+#
+# current_ways_timestamp_idx (timestamp)
+#
+# Foreign Keys
+#
+# current_ways_changeset_id_fkey (changeset_id => changesets.id)
+#
+
+class Way < ApplicationRecord
+ require "xml/libxml"
include ConsistencyValidations
include NotRedactable
- include ObjectMetadata
self.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
- validates_presence_of :id, :on => :update
- validates_presence_of :changeset_id, :version, :timestamp
- validates_uniqueness_of :id
- 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 :id, :uniqueness => true, :presence => { :on => :update },
+ :numericality => { :on => :update, :only_integer => true }
+ validates :version, :presence => true,
+ :numericality => { :only_integer => true }
+ validates :changeset_id, :presence => true,
+ :numericality => { :only_integer => true }
+ validates :timestamp, :presence => true
+ validates :changeset, :associated => true
+ validates :visible, :inclusion => [true, false]
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)
- p = XML::Parser.string(xml)
+ def self.from_xml(xml, create: false)
+ p = XML::Parser.string(xml, :options => XML::Parser::Options::NOERROR)
doc = p.parse
+ pt = doc.find_first("//osm/way")
- doc.find('//osm/way').each do |pt|
- return Way.from_xml_node(pt, create)
+ if pt
+ Way.from_xml_node(pt, :create => create)
+ else
+ raise OSM::APIBadXMLError.new("node", xml, "XML doesn't contain an osm/way element.")
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)
+ rescue LibXML::XML::Error, ArgumentError => e
+ raise OSM::APIBadXMLError.new("way", xml, e.message)
end
- def self.from_xml_node(pt, create = false)
+ def self.from_xml_node(pt, create: false)
way = Way.new
- 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']
+ raise OSM::APIBadXMLError.new("way", pt, "Version is required when updating") unless create || !pt["version"].nil?
+
+ way.version = pt["version"]
+ raise 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
+ 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
- fail OSM::APIBadUserInput.new("ID of way cannot be zero when updating.") if way.id == 0
+ raise OSM::APIBadUserInput, "ID of way cannot be zero when updating." if way.id.zero?
end
# We don't care about the timestamp nor the visibility as these are either
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
+ 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?
- pt.find('nd').each do |nd|
- way.add_nd_num(nd['ref'])
+ way.add_tag_keyval(tag["k"], tag["v"])
end
- 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.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
- doc.root << to_xml_node
- doc
- end
-
- def to_xml_node(visible_nodes = nil, changeset_cache = {}, user_display_name_cache = {})
- el = XML::Node.new 'way'
- el['id'] = id.to_s
-
- add_metadata_to_xml_node(el, self, changeset_cache, user_display_name_cache)
-
- # make sure nodes are output in sequence_id order
- ordered_nodes = []
- 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 && nd.node.visible?
- ordered_nodes[nd.sequence_id] = nd.node_id.to_s
- end
- end
+ pt.find("nd").each do |nd|
+ way.add_nd_num(nd["ref"])
end
- ordered_nodes.each do |nd_id|
- if nd_id && nd_id != '0'
- node_el = XML::Node.new 'nd'
- node_el['ref'] = nd_id
- el << node_el
- end
- end
-
- add_tags_to_xml_node(el, way_tags)
-
- el
+ way
end
def nds
end
def tags
- @tags ||= Hash[way_tags.collect { |t| [t.k, t.v] }]
+ @tags ||= way_tags.collect { |t| [t.k, t.v] }.to_h
end
- attr_writer :nds
-
- attr_writer :tags
+ attr_writer :nds, :tags
def add_nd_num(n)
- @nds = [] unless @nds
+ @nds ||= []
@nds << n.to_i
end
def add_tag_keyval(k, v)
- @tags = {} unless @tags
+ @tags ||= {}
# duplicate tags are now forbidden, so we can't allow values
# in the hash to be overwritten.
- fail OSM::APIDuplicateTagsError.new("way", id, k) if @tags.include? k
+ raise OSM::APIDuplicateTagsError.new("way", id, k) if @tags.include? k
@tags[k] = v
end
def update_from(new_way, user)
Way.transaction do
- self.lock!
+ 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
+ raise OSM::APIPreconditionFailedError, "Cannot update way #{id}: data is invalid." unless new_way.preconditions_ok?(nds)
self.changeset_id = new_way.changeset_id
self.changeset = new_way.changeset
def create_with_history(user)
check_create_consistency(self, user)
- unless self.preconditions_ok?
- fail OSM::APIPreconditionFailedError.new("Cannot create way: data is invalid.")
- end
+ raise OSM::APIPreconditionFailedError, "Cannot create way: data is invalid." unless preconditions_ok?
+
self.version = 0
self.visible = true
save_with_history!
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
+ raise OSM::APITooManyWayNodesError.new(id, nds.length, Settings.max_number_of_way_nodes) if nds.length > Settings.max_number_of_way_nodes
# 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)
+ # NOTE: nodes are locked here to ensure they can't be deleted before
+ # the current transaction commits.
+ db_nds = Node.where(:id => new_nds, :visible => true).lock("for share")
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.")
+ raise OSM::APIPreconditionFailedError, "Way #{id} requires the nodes with id in (#{missing.join(',')}), which either do not exist, or are not visible."
end
end
end
def delete_with_history!(new_way, user)
- unless visible
- fail OSM::APIAlreadyDeletedError.new("way", new_way.id)
- end
+ raise 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
- self.lock!
+ lock!
check_consistency(self, new_way, user)
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?
+ raise OSM::APIPreconditionFailedError, "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
end
end
- # Temporary method to match interface to nodes
- def tags_as_hash
- 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, placeholder_id = nil)
nds.map! do |node_id|
- if node_id < 0
+ if node_id.negative?
new_id = id_map[:node][node_id]
- fail OSM::APIBadUserInput.new("Placeholder node not found for reference #{node_id} in way #{id.nil? ? placeholder_id : id}") if new_id.nil?
+ raise OSM::APIBadUserInput, "Placeholder node not found for reference #{node_id} in way #{id.nil? ? placeholder_id : id}" if new_id.nil?
+
new_id
else
node_id
def save_with_history!
t = Time.now.getutc
+ self.version += 1
+ self.timestamp = t
+
# 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
cs.update_bbox!(bbox) unless nodes.empty?
Way.transaction do
- self.version += 1
- self.timestamp = t
- self.save!
+ # clone the object before saving it so that the original is
+ # still marked as dirty if we retry the transaction
+ clone.save!
tags = self.tags
- WayTag.delete_all(:way_id => id)
+ WayTag.where(:way_id => id).delete_all
tags.each do |k, v|
tag = WayTag.new
tag.way_id = id
end
nds = self.nds
- WayNode.delete_all(:way_id => id)
+ WayNode.where(:way_id => id).delete_all
sequence = 1
nds.each do |n|
nd = WayNode.new