app/models/node.rb

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