app/models/node.rb

   1 class Node < ActiveRecord::Base
   2   require 'xml/libxml'
   3
   4   include GeoRecord
   5   include ConsistencyValidations
   6   include NotRedactable
   7   include ObjectMetadata
   8
   9   self.table_name = "current_nodes"
  10
  11   belongs_to :changeset
  12
  13   has_many :old_nodes, -> { order(:version) }
  14
  15   has_many :way_nodes
  16   has_many :ways, :through => :way_nodes
  17
  18   has_many :node_tags
  19
  20   has_many :old_way_nodes
  21   has_many :ways_via_history, :class_name => "Way", :through => :old_way_nodes, :source => :way
  22
  23   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
  24   has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation
  25
  26   validates_presence_of :id, :on => :update
  27   validates_presence_of :timestamp, :version,  :changeset_id
  28   validates_uniqueness_of :id
  29   validates_inclusion_of :visible, :in => [true, false]
  30   validates_numericality_of :latitude, :longitude, :changeset_id, :version, :integer_only => true
  31   validates_numericality_of :id, :on => :update, :integer_only => true
  32   validate :validate_position
  33   validates_associated :changeset
  34
  35   scope :visible, -> { where(:visible => true) }
  36   scope :invisible, -> { where(:visible => false) }
  37
  38   # Sanity check the latitude and longitude and add an error if it's broken
  39   def validate_position
  40     errors.add(:base, "Node is not in the world") unless in_world?
  41   end
  42
  43   # Read in xml as text and return it's Node object representation
  44   def self.from_xml(xml, create = false)
  45     p = XML::Parser.string(xml)
  46     doc = p.parse
  47
  48     doc.find('//osm/node').each do |pt|
  49       return Node.from_xml_node(pt, create)
  50     end
  51     fail OSM::APIBadXMLError.new("node", xml, "XML doesn't contain an osm/node element.")
  52   rescue LibXML::XML::Error, ArgumentError => ex
  53     raise OSM::APIBadXMLError.new("node", xml, ex.message)
  54   end
  55
  56   def self.from_xml_node(pt, create = false)
  57     node = Node.new
  58
  59     fail OSM::APIBadXMLError.new("node", pt, "lat missing") if pt['lat'].nil?
  60     fail OSM::APIBadXMLError.new("node", pt, "lon missing") if pt['lon'].nil?
  61     node.lat = OSM.parse_float(pt['lat'], OSM::APIBadXMLError, "node", pt, "lat not a number")
  62     node.lon = OSM.parse_float(pt['lon'], OSM::APIBadXMLError, "node", pt, "lon not a number")
  63     fail OSM::APIBadXMLError.new("node", pt, "Changeset id is missing") if pt['changeset'].nil?
  64     node.changeset_id = pt['changeset'].to_i
  65
  66     fail OSM::APIBadUserInput.new("The node is outside this world") unless node.in_world?
  67
  68     # version must be present unless creating
  69     fail OSM::APIBadXMLError.new("node", pt, "Version is required when updating") unless create || !pt['version'].nil?
  70     node.version = create ? 0 : pt['version'].to_i
  71
  72     unless create
  73       fail OSM::APIBadXMLError.new("node", pt, "ID is required when updating.") if pt['id'].nil?
  74       node.id = pt['id'].to_i
  75       # .to_i will return 0 if there is no number that can be parsed.
  76       # We want to make sure that there is no id with zero anyway
  77       fail OSM::APIBadUserInput.new("ID of node cannot be zero when updating.") if node.id == 0
  78     end
  79
  80     # We don't care about the time, as it is explicitly set on create/update/delete
  81     # We don't care about the visibility as it is implicit based on the action
  82     # and set manually before the actual delete
  83     node.visible = true
  84
  85     # Start with no tags
  86     node.tags = {}
  87
  88     # Add in any tags from the XML
  89     pt.find('tag').each do |tag|
  90       fail OSM::APIBadXMLError.new("node", pt, "tag is missing key") if tag['k'].nil?
  91       fail OSM::APIBadXMLError.new("node", pt, "tag is missing value") if tag['v'].nil?
  92       node.add_tag_key_val(tag['k'], tag['v'])
  93     end
  94
  95     node
  96   end
  97
  98   ##
  99   # the bounding box around a node, which is used for determining the changeset's
 100   # bounding box
 101   def bbox
 102     BoundingBox.new(longitude, latitude, longitude, latitude)
 103   end
 104
 105   # Should probably be renamed delete_from to come in line with update
 106   def delete_with_history!(new_node, user)
 107     fail OSM::APIAlreadyDeletedError.new("node", new_node.id) unless visible
 108
 109     # need to start the transaction here, so that the database can
 110     # provide repeatable reads for the used-by checks. this means it
 111     # shouldn't be possible to get race conditions.
 112     Node.transaction do
 113       self.lock!
 114       check_consistency(self, new_node, user)
 115       ways = Way.joins(:way_nodes).where(:visible => true, :current_way_nodes => { :node_id => id }).order(:id)
 116       fail OSM::APIPreconditionFailedError.new("Node #{id} is still used by ways #{ways.collect(&:id).join(",")}.") unless ways.empty?
 117
 118       rels = Relation.joins(:relation_members).where(:visible => true, :current_relation_members => { :member_type => "Node", :member_id => id }).order(:id)
 119       fail OSM::APIPreconditionFailedError.new("Node #{id} is still used by relations #{rels.collect(&:id).join(",")}.") unless rels.empty?
 120
 121       self.changeset_id = new_node.changeset_id
 122       self.tags = {}
 123       self.visible = false
 124
 125       # update the changeset with the deleted position
 126       changeset.update_bbox!(bbox)
 127
 128       save_with_history!
 129     end
 130   end
 131
 132   def update_from(new_node, user)
 133     Node.transaction do
 134       self.lock!
 135       check_consistency(self, new_node, user)
 136
 137       # update changeset first
 138       self.changeset_id = new_node.changeset_id
 139       self.changeset = new_node.changeset
 140
 141       # update changeset bbox with *old* position first
 142       changeset.update_bbox!(bbox)
 143
 144       # FIXME logic needs to be double checked
 145       self.latitude = new_node.latitude
 146       self.longitude = new_node.longitude
 147       self.tags = new_node.tags
 148       self.visible = true
 149
 150       # update changeset bbox with *new* position
 151       changeset.update_bbox!(bbox)
 152
 153       save_with_history!
 154     end
 155   end
 156
 157   def create_with_history(user)
 158     check_create_consistency(self, user)
 159     self.version = 0
 160     self.visible = true
 161
 162     # update the changeset to include the new location
 163     changeset.update_bbox!(bbox)
 164
 165     save_with_history!
 166   end
 167
 168   def to_xml
 169     doc = OSM::API.new.get_xml_doc
 170     doc.root << to_xml_node
 171     doc
 172   end
 173
 174   def to_xml_node(changeset_cache = {}, user_display_name_cache = {})
 175     el = XML::Node.new 'node'
 176     el['id'] = id.to_s
 177
 178     add_metadata_to_xml_node(el, self, changeset_cache, user_display_name_cache)
 179
 180     if self.visible?
 181       el['lat'] = lat.to_s
 182       el['lon'] = lon.to_s
 183     end
 184
 185     add_tags_to_xml_node(el, node_tags)
 186
 187     el
 188   end
 189
 190   def tags_as_hash
 191     tags
 192   end
 193
 194   def tags
 195     @tags ||= Hash[node_tags.collect { |t| [t.k, t.v] }]
 196   end
 197
 198   attr_writer :tags
 199
 200   def add_tag_key_val(k, v)
 201     @tags = {} unless @tags
 202
 203     # duplicate tags are now forbidden, so we can't allow values
 204     # in the hash to be overwritten.
 205     fail OSM::APIDuplicateTagsError.new("node", id, k) if @tags.include? k
 206
 207     @tags[k] = v
 208   end
 209
 210   ##
 211   # are the preconditions OK? this is mainly here to keep the duck
 212   # typing interface the same between nodes, ways and relations.
 213   def preconditions_ok?
 214     in_world?
 215   end
 216
 217   ##
 218   # dummy method to make the interfaces of node, way and relation
 219   # more consistent.
 220   def fix_placeholders!(_id_map, _placeholder_id = nil)
 221     # nodes don't refer to anything, so there is nothing to do here
 222   end
 223
 224   private
 225
 226   def save_with_history!
 227     t = Time.now.getutc
 228     Node.transaction do
 229       self.version += 1
 230       self.timestamp = t
 231       self.save!
 232
 233       # Create a NodeTag
 234       tags = self.tags
 235       NodeTag.delete_all(:node_id => id)
 236       tags.each do |k, v|
 237         tag = NodeTag.new
 238         tag.node_id = id
 239         tag.k = k
 240         tag.v = v
 241         tag.save!
 242       end
 243
 244       # Create an OldNode
 245       old_node = OldNode.from_node(self)
 246       old_node.timestamp = t
 247       old_node.save_with_dependencies!
 248
 249       # tell the changeset we updated one element only
 250       changeset.add_changes! 1
 251
 252       # save the changeset in case of bounding box updates
 253       changeset.save!
 254     end
 255   end
 256 end