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