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