X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/4ab495f5db90c687574d4e4cee59cf73f79c31c6..5fa0aebe9fee869a4a988859dd454a28ee451b97:/app/models/way.rb diff --git a/app/models/way.rb b/app/models/way.rb index 4f988dc9d..e5b73ceaa 100644 --- a/app/models/way.rb +++ b/app/models/way.rb @@ -1,195 +1,168 @@ +# == Schema Information +# +# Table name: current_ways +# +# id :integer not null, primary key +# changeset_id :integer not null +# timestamp :datetime not null +# visible :boolean not null +# version :integer not null +# +# Indexes +# +# current_ways_timestamp_idx (timestamp) +# +# Foreign Keys +# +# current_ways_changeset_id_fkey (changeset_id => changesets.id) +# + class Way < ActiveRecord::Base - require 'xml/libxml' - + require "xml/libxml" + include ConsistencyValidations + include NotRedactable + include ObjectMetadata + + self.table_name = "current_ways" - set_table_name 'current_ways' - 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_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation, :extend => ObjectFinder - - 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 - - def self.from_xml(xml, create=false) - begin - p = XML::Parser.string(xml) - doc = p.parse - - 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) + has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation + + validates :id, :uniqueness => true, :presence => { :on => :update }, + :numericality => { :on => :update, :integer_only => true } + validates :version, :presence => true, + :numericality => { :integer_only => true } + validates :changeset_id, :presence => true, + :numericality => { :integer_only => 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, :options => XML::Parser::Options::NOERROR) + doc = p.parse + + doc.find("//osm/way").each do |pt| + return Way.from_xml_node(pt, create) end + raise 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 - def self.from_xml_node(pt, create=false) + def self.from_xml_node(pt, create = false) 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) + 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 + 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 + raise OSM::APIBadUserInput, "ID of way cannot be zero when updating." if way.id.zero? end - pt.find('tag').each do |tag| - way.add_tag_keyval(tag['k'], tag['v']) - end + # 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 = {} - pt.find('nd').each do |nd| - way.add_nd_num(nd['ref']) + # Add in any tags from the XML + 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? + way.add_tag_keyval(tag["k"], tag["v"]) end - return way - end + pt.find("nd").each do |nd| + way.add_nd_num(nd["ref"]) + 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}]) + way 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 = {}) - 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 = [] - 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] - ordered_nodes[nd.sequence_id] = nd.node_id.to_s - end + ordered_nodes[nd.sequence_id] = nd.node_id.to_s if visible_nodes[nd.node_id] else # otherwise, manually go to the db to check things - if nd.node and nd.node.visible? - ordered_nodes[nd.sequence_id] = nd.node_id.to_s - end + ordered_nodes[nd.sequence_id] = nd.node_id.to_s if nd.node && nd.node.visible? 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 - return el1 - end + + add_tags_to_xml_node(el, way_tags) + + el + end 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 - 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 - def nds=(s) - @nds = s - end + attr_writer :nds - def tags=(t) - @tags = t - end + attr_writer :tags def add_nd_num(n) - @nds = Array.new unless @nds + @nds ||= [] @nds << n.to_i end def add_tag_keyval(k, v) - @tags = Hash.new unless @tags + @tags ||= {} # 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 + raise OSM::APIDuplicateTagsError.new("way", id, k) if @tags.include? k @tags[k] = v end @@ -198,19 +171,17 @@ class Way < ActiveRecord::Base # 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) Way.transaction do - self.lock! + lock! check_consistency(self, new_way, user) - unless new_way.preconditions_ok?(self.nds) - raise OSM::APIPreconditionFailedError.new("Cannot update way #{self.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 self.tags = new_way.tags @@ -222,51 +193,46 @@ class Way < ActiveRecord::Base def create_with_history(user) check_create_consistency(self, user) - unless self.preconditions_ok? - raise 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! end def preconditions_ok?(old_nodes = []) - 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']) - end + return false if nds.empty? + raise OSM::APITooManyWayNodesError.new(id, nds.length, MAX_NUMBER_OF_WAY_NODES) if nds.length > 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 = (self.nds - old_nodes).sort.uniq + new_nds = (nds - old_nodes).sort.uniq unless new_nds.empty? - db_nds = Node.find(:all, :conditions => { :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 { |n| n.id } - raise OSM::APIPreconditionFailedError.new("Way #{self.id} requires the nodes with id in (#{missing.join(',')}), which either do not exist, or are not visible.") + missing = new_nds - db_nds.collect(&:id) + raise OSM::APIPreconditionFailedError, "Way #{id} requires the nodes with id in (#{missing.join(',')}), which either do not exist, or are not visible." end end - return true + true 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 + 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) - 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) + 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 @@ -277,20 +243,15 @@ class Way < ActiveRecord::Base end 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+. + # this calling this method will fix them using the map from placeholders + # to IDs +id_map+. 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] - 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? + 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 @@ -299,38 +260,41 @@ class Way < ActiveRecord::Base end private - + 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 + 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 # later in the save. - cs = self.changeset + cs = changeset 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(['id = ?', self.id]) - tags.each do |k,v| + WayTag.where(:way_id => id).delete_all + tags.each do |k, v| tag = WayTag.new + tag.way_id = id tag.k = k tag.v = v - tag.id = self.id tag.save! end nds = self.nds - WayNode.delete_all(['id = ?', self.id]) + WayNode.where(:way_id => id).delete_all 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 @@ -342,9 +306,9 @@ class Way < ActiveRecord::Base # 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? @@ -354,5 +318,4 @@ class Way < ActiveRecord::Base cs.save! end end - end