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.string(xml)
  68       doc = p.parse
  69
  70       doc.find('//osm/node').each do |pt|
  71         return Node.from_xml_node(pt, create)
  72       end
  73     rescue LibXML::XML::Error, ArgumentError => ex
  74       raise OSM::APIBadXMLError.new("node", xml, ex.message)
  75     end
  76   end
  77
  78   def self.from_xml_node(pt, create=false)
  79     node = Node.new
  80
  81     raise OSM::APIBadXMLError.new("node", pt, "lat missing") if pt['lat'].nil?
  82     raise OSM::APIBadXMLError.new("node", pt, "lon missing") if pt['lon'].nil?
  83     node.lat = pt['lat'].to_f
  84     node.lon = pt['lon'].to_f
  85     raise OSM::APIBadXMLError.new("node", pt, "Changeset id is missing") if pt['changeset'].nil?
  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     raise OSM::APIBadXMLError.new("node", pt, "Version is required when updating") unless create or not pt['version'].nil?
  92     node.version = create ? 0 : pt['version'].to_i
  93
  94     unless create
  95       raise OSM::APIBadXMLError.new("node", pt, "ID is required when updating.") if pt['id'].nil?
  96       node.id = pt['id'].to_i
  97       # .to_i will return 0 if there is no number that can be parsed.
  98       # We want to make sure that there is no id with zero anyway
  99       raise OSM::APIBadUserInput.new("ID of node cannot be zero when updating.") if node.id == 0
 100     end
 101
 102     # We don't care about the time, as it is explicitly set on create/update/delete
 103     # We don't care about the visibility as it is implicit based on the action
 104     # and set manually before the actual delete
 105     node.visible = true
 106
 107     pt.find('tag').each do |tag|
 108       raise OSM::APIBadXMLError.new("node", pt, "tag is missing key") if tag['k'].nil?
 109       raise OSM::APIBadXMLError.new("node", pt, "tag is missing value") if tag['v'].nil?
 110       node.add_tag_key_val(tag['k'],tag['v'])
 111     end
 112
 113     return node
 114   end
 115
 116   ##
 117   # the bounding box around a node, which is used for determining the changeset's
 118   # bounding box
 119   def bbox
 120     [ longitude, latitude, longitude, latitude ]
 121   end
 122
 123   # Should probably be renamed delete_from to come in line with update
 124   def delete_with_history!(new_node, user)
 125     unless self.visible
 126       raise OSM::APIAlreadyDeletedError.new("node", new_node.id)
 127     end
 128
 129     # need to start the transaction here, so that the database can
 130     # provide repeatable reads for the used-by checks. this means it
 131     # shouldn't be possible to get race conditions.
 132     Node.transaction do
 133       self.lock!
 134       check_consistency(self, new_node, user)
 135       way = WayNode.find(:first, :joins => :way,
 136                          :conditions => [ "current_ways.visible = ? AND current_way_nodes.node_id = ?", true, self.id ])
 137       raise OSM::APIPreconditionFailedError.new("Node #{self.id} is still used by way #{way.way.id}.") unless way.nil?
 138
 139       rel = RelationMember.find(:first, :joins => :relation,
 140                                 :conditions => [ "visible = ? AND member_type='Node' and member_id=? ", true, self.id])
 141       raise OSM::APIPreconditionFailedError.new("Node #{self.id} is still used by relation #{rel.relation.id}.") unless rel.nil?
 142
 143       self.changeset_id = new_node.changeset_id
 144       self.visible = false
 145
 146       # update the changeset with the deleted position
 147       changeset.update_bbox!(bbox)
 148
 149       save_with_history!
 150     end
 151   end
 152
 153   def update_from(new_node, user)
 154     Node.transaction do
 155       self.lock!
 156       check_consistency(self, new_node, user)
 157
 158       # update changeset first
 159       self.changeset_id = new_node.changeset_id
 160       self.changeset = new_node.changeset
 161
 162       # update changeset bbox with *old* position first
 163       changeset.update_bbox!(bbox);
 164
 165       # FIXME logic needs to be double checked
 166       self.latitude = new_node.latitude
 167       self.longitude = new_node.longitude
 168       self.tags = new_node.tags
 169       self.visible = true
 170
 171       # update changeset bbox with *new* position
 172       changeset.update_bbox!(bbox);
 173
 174       save_with_history!
 175     end
 176   end
 177
 178   def create_with_history(user)
 179     check_create_consistency(self, user)
 180     self.version = 0
 181     self.visible = true
 182
 183     # update the changeset to include the new location
 184     changeset.update_bbox!(bbox)
 185
 186     save_with_history!
 187   end
 188
 189   def to_xml
 190     doc = OSM::API.new.get_xml_doc
 191     doc.root << to_xml_node()
 192     return doc
 193   end
 194
 195   def to_xml_node(changeset_cache = {}, user_display_name_cache = {})
 196     el1 = XML::Node.new 'node'
 197     el1['id'] = self.id.to_s
 198     el1['lat'] = self.lat.to_s
 199     el1['lon'] = self.lon.to_s
 200     el1['version'] = self.version.to_s
 201     el1['changeset'] = self.changeset_id.to_s
 202
 203     if changeset_cache.key?(self.changeset_id)
 204       # use the cache if available
 205     else
 206       changeset_cache[self.changeset_id] = self.changeset.user_id
 207     end
 208
 209     user_id = changeset_cache[self.changeset_id]
 210
 211     if user_display_name_cache.key?(user_id)
 212       # use the cache if available
 213     elsif self.changeset.user.data_public?
 214       user_display_name_cache[user_id] = self.changeset.user.display_name
 215     else
 216       user_display_name_cache[user_id] = nil
 217     end
 218
 219     if not user_display_name_cache[user_id].nil?
 220       el1['user'] = user_display_name_cache[user_id]
 221       el1['uid'] = user_id.to_s
 222     end
 223
 224     self.tags.each do |k,v|
 225       el2 = XML::Node.new('tag')
 226       el2['k'] = k.to_s
 227       el2['v'] = v.to_s
 228       el1 << el2
 229     end
 230
 231     el1['visible'] = self.visible.to_s
 232     el1['timestamp'] = self.timestamp.xmlschema
 233     return el1
 234   end
 235
 236   def tags_as_hash
 237     return tags
 238   end
 239
 240   def tags
 241     unless @tags
 242       @tags = {}
 243       self.node_tags.each do |tag|
 244         @tags[tag.k] = tag.v
 245       end
 246     end
 247     @tags
 248   end
 249
 250   def tags=(t)
 251     @tags = t
 252   end
 253
 254   def add_tag_key_val(k,v)
 255     @tags = Hash.new unless @tags
 256
 257     # duplicate tags are now forbidden, so we can't allow values
 258     # in the hash to be overwritten.
 259     raise OSM::APIDuplicateTagsError.new("node", self.id, k) if @tags.include? k
 260
 261     @tags[k] = v
 262   end
 263
 264   ##
 265   # are the preconditions OK? this is mainly here to keep the duck
 266   # typing interface the same between nodes, ways and relations.
 267   def preconditions_ok?
 268     in_world?
 269   end
 270
 271   ##
 272   # dummy method to make the interfaces of node, way and relation
 273   # more consistent.
 274   def fix_placeholders!(id_map, placeholder_id = nil)
 275     # nodes don't refer to anything, so there is nothing to do here
 276   end
 277
 278   private
 279
 280   def save_with_history!
 281     t = Time.now.getutc
 282     Node.transaction do
 283       self.version += 1
 284       self.timestamp = t
 285       self.save!
 286
 287       # Create a NodeTag
 288       tags = self.tags
 289       NodeTag.delete_all(['id = ?', self.id])
 290       tags.each do |k,v|
 291         tag = NodeTag.new
 292         tag.k = k
 293         tag.v = v
 294         tag.id = self.id
 295         tag.save!
 296       end
 297
 298       # Create an OldNode
 299       old_node = OldNode.from_node(self)
 300       old_node.timestamp = t
 301       old_node.save_with_dependencies!
 302
 303       # tell the changeset we updated one element only
 304       changeset.add_changes! 1
 305
 306       # save the changeset in case of bounding box updates
 307       changeset.save!
 308     end
 309   end
 310
 311 end