app/models/node.rb

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