app/models/way.rb

   1 # frozen_string_literal: true
   2
   3 # == Schema Information
   4 #
   5 # Table name: current_ways
   6 #
   7 #  id           :bigint           not null, primary key
   8 #  changeset_id :bigint           not null
   9 #  timestamp    :datetime         not null
  10 #  visible      :boolean          not null
  11 #  version      :bigint           not null
  12 #
  13 # Indexes
  14 #
  15 #  current_ways_timestamp_idx  (timestamp)
  16 #
  17 # Foreign Keys
  18 #
  19 #  current_ways_changeset_id_fkey  (changeset_id => changesets.id)
  20 #
  21
  22 class Way < ApplicationRecord
  23   include ConsistencyValidations
  24   include NotRedactable
  25
  26   self.table_name = "current_ways"
  27
  28   belongs_to :changeset
  29
  30   has_many :old_ways, -> { order(:version) }, :inverse_of => :current_way
  31
  32   has_many :way_nodes, -> { order(:sequence_id) }, :inverse_of => :way
  33   has_many :nodes, :through => :way_nodes
  34
  35   has_many :element_tags, :class_name => "WayTag"
  36
  37   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
  38   has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation
  39
  40   validates :id, :uniqueness => true, :presence => { :on => :update },
  41                  :numericality => { :on => :update, :only_integer => true }
  42   validates :version, :presence => true,
  43                       :numericality => { :only_integer => true }
  44   validates :timestamp, :presence => true
  45   validates :changeset, :associated => true
  46   validates :visible, :inclusion => [true, false]
  47
  48   scope :visible, -> { where(:visible => true) }
  49   scope :invisible, -> { where(:visible => false) }
  50
  51   # Read in xml as text and return it's Way object representation
  52   def self.from_xml(xml, create: false)
  53     p = XML::Parser.string(xml, :options => XML::Parser::Options::NOERROR)
  54     doc = p.parse
  55     pt = doc.find_first("//osm/way")
  56
  57     if pt
  58       Way.from_xml_node(pt, :create => create)
  59     else
  60       raise OSM::APIBadXMLError.new("node", xml, "XML doesn't contain an osm/way element.")
  61     end
  62   rescue LibXML::XML::Error, ArgumentError => e
  63     raise OSM::APIBadXMLError.new("way", xml, e.message)
  64   end
  65
  66   def self.from_xml_node(pt, create: false)
  67     way = Way.new
  68
  69     raise OSM::APIBadXMLError.new("way", pt, "Version is required when updating") unless create || !pt["version"].nil?
  70
  71     way.version = pt["version"]
  72     raise OSM::APIBadXMLError.new("way", pt, "Changeset id is missing") if pt["changeset"].nil?
  73
  74     way.changeset_id = pt["changeset"]
  75
  76     unless create
  77       raise OSM::APIBadXMLError.new("way", pt, "ID is required when updating") if pt["id"].nil?
  78
  79       way.id = pt["id"].to_i
  80       # .to_i will return 0 if there is no number that can be parsed.
  81       # We want to make sure that there is no id with zero anyway
  82       raise OSM::APIBadUserInput, "ID of way cannot be zero when updating." if way.id.zero?
  83     end
  84
  85     # We don't care about the timestamp nor the visibility as these are either
  86     # set explicitly or implicit in the action. The visibility is set to true,
  87     # and manually set to false before the actual delete.
  88     way.visible = true
  89
  90     # Start with no tags
  91     way.tags = {}
  92
  93     # Add in any tags from the XML
  94     pt.find("tag").each do |tag|
  95       raise OSM::APIBadXMLError.new("way", pt, "tag is missing key") if tag["k"].nil?
  96       raise OSM::APIBadXMLError.new("way", pt, "tag is missing value") if tag["v"].nil?
  97
  98       way.add_tag_keyval(tag["k"], tag["v"])
  99     end
 100
 101     pt.find("nd").each do |nd|
 102       way.add_nd_num(nd["ref"])
 103     end
 104
 105     way
 106   end
 107
 108   def nds
 109     @nds ||= way_nodes.collect(&:node_id)
 110   end
 111
 112   def tags
 113     @tags ||= element_tags.to_h { |t| [t.k, t.v] }
 114   end
 115
 116   attr_writer :nds, :tags
 117
 118   def add_nd_num(n)
 119     @nds ||= []
 120     @nds << n.to_i
 121   end
 122
 123   def add_tag_keyval(k, v)
 124     @tags ||= {}
 125
 126     # duplicate tags are now forbidden, so we can't allow values
 127     # in the hash to be overwritten.
 128     raise OSM::APIDuplicateTagsError.new("way", id, k) if @tags.include? k
 129
 130     @tags[k] = v
 131   end
 132
 133   ##
 134   # the integer coords (i.e: unscaled) bounding box of the way, assuming
 135   # straight line segments.
 136   def bbox
 137     lons = nodes.collect(&:longitude)
 138     lats = nodes.collect(&:latitude)
 139     BoundingBox.new(lons.min, lats.min, lons.max, lats.max)
 140   end
 141
 142   def update_from(new_way, user)
 143     Way.transaction do
 144       lock!
 145       check_update_element_consistency(self, new_way, user)
 146       raise OSM::APIPreconditionFailedError, "Cannot update way #{id}: data is invalid." unless new_way.preconditions_ok?(nds)
 147
 148       self.changeset_id = new_way.changeset_id
 149       self.changeset = new_way.changeset
 150       self.tags = new_way.tags
 151       self.nds = new_way.nds
 152       self.visible = true
 153       changeset.num_modified_ways += 1
 154       save_with_history!
 155     end
 156   end
 157
 158   def create_with_history(user)
 159     check_create_element_consistency(self, user)
 160     raise OSM::APIPreconditionFailedError, "Cannot create way: data is invalid." unless preconditions_ok?
 161
 162     self.version = 0
 163     self.visible = true
 164     changeset.num_created_ways += 1
 165     save_with_history!
 166   end
 167
 168   def preconditions_ok?(old_nodes = [])
 169     return false if nds.empty?
 170     raise OSM::APITooManyWayNodesError.new(id, nds.length, Settings.max_number_of_way_nodes) if nds.length > Settings.max_number_of_way_nodes
 171
 172     # check only the new nodes, for efficiency - old nodes having been checked last time and can't
 173     # be deleted when they're in-use.
 174     new_nds = (nds - old_nodes).sort.uniq
 175
 176     unless new_nds.empty?
 177       # NOTE: nodes are locked here to ensure they can't be deleted before
 178       # the current transaction commits.
 179       db_nds = Node.where(:id => new_nds, :visible => true).lock("for share")
 180
 181       if db_nds.length < new_nds.length
 182         missing = new_nds - db_nds.collect(&:id)
 183         raise OSM::APIPreconditionFailedError, "Way #{id} requires the nodes with id in (#{missing.join(',')}), which either do not exist, or are not visible."
 184       end
 185     end
 186
 187     true
 188   end
 189
 190   def delete_with_history!(new_way, user)
 191     raise OSM::APIAlreadyDeletedError.new("way", new_way.id) unless visible
 192
 193     # need to start the transaction here, so that the database can
 194     # provide repeatable reads for the used-by checks. this means it
 195     # shouldn't be possible to get race conditions.
 196     Way.transaction do
 197       lock!
 198       check_update_element_consistency(self, new_way, user)
 199       rels = Relation.joins(:relation_members).where(:visible => true, :current_relation_members => { :member_type => "Way", :member_id => id }).order(:id)
 200       raise OSM::APIPreconditionFailedError, "Way #{id} is still used by relations #{rels.collect(&:id).join(',')}." unless rels.empty?
 201
 202       self.changeset_id = new_way.changeset_id
 203       self.changeset = new_way.changeset
 204
 205       self.tags = []
 206       self.nds = []
 207       self.visible = false
 208       changeset.num_deleted_ways += 1
 209       save_with_history!
 210     end
 211   end
 212
 213   ##
 214   # if any referenced nodes are placeholder IDs (i.e: are negative) then
 215   # this calling this method will fix them using the map from placeholders
 216   # to IDs +id_map+.
 217   def fix_placeholders!(id_map, placeholder_id = nil)
 218     nds.map! do |node_id|
 219       if node_id.negative?
 220         new_id = id_map[:node][node_id]
 221         raise OSM::APIBadUserInput, "Placeholder node not found for reference #{node_id} in way #{id.nil? ? placeholder_id : id}" if new_id.nil?
 222
 223         new_id
 224       else
 225         node_id
 226       end
 227     end
 228   end
 229
 230   private
 231
 232   def save_with_history!
 233     t = Time.now.utc
 234
 235     self.version += 1
 236     self.timestamp = t
 237
 238     # update the bounding box, note that this has to be done both before
 239     # and after the save, so that nodes from both versions are included in the
 240     # bbox. we use a copy of the changeset so that it isn't reloaded
 241     # later in the save.
 242     cs = changeset
 243     cs.update_bbox!(bbox) unless nodes.empty?
 244
 245     Way.transaction do
 246       # clone the object before saving it so that the original is
 247       # still marked as dirty if we retry the transaction
 248       clone.save!
 249
 250       tags = self.tags
 251       WayTag.where(:way_id => id).delete_all
 252       tags.each do |k, v|
 253         tag = WayTag.new
 254         tag.way_id = id
 255         tag.k = k
 256         tag.v = v
 257         tag.save!
 258       end
 259
 260       nds = self.nds
 261       WayNode.where(:way_id => id).delete_all
 262       sequence = 1
 263       nds.each do |n|
 264         nd = WayNode.new
 265         nd.id = [id, sequence]
 266         nd.node_id = n
 267         nd.save!
 268         sequence += 1
 269       end
 270
 271       old_way = OldWay.from_way(self)
 272       old_way.timestamp = t
 273       old_way.save_with_dependencies!
 274
 275       # reload the way so that the nodes array points to the correct
 276       # new set of nodes.
 277       reload
 278
 279       # update and commit the bounding box, now that way nodes
 280       # have been updated and we're in a transaction.
 281       cs.update_bbox!(bbox) unless nodes.empty?
 282
 283       # tell the changeset we updated one element only
 284       cs.add_changes! 1
 285
 286       cs.save!
 287     end
 288   end
 289 end