app/models/way.rb

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