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