app/models/way.rb

   1 class Way < ActiveRecord::Base
   2   require 'xml/libxml'
   3
   4   include ConsistencyValidations
   5
   6   set_table_name 'current_ways'
   7
   8   validates_presence_of :changeset_id, :timestamp
   9   validates_inclusion_of :visible, :in => [ true, false ]
  10
  11   belongs_to :changeset
  12
  13   has_many :old_ways, :foreign_key => 'id', :order => 'version'
  14
  15   has_many :way_nodes, :foreign_key => 'id', :order => 'sequence_id'
  16   has_many :nodes, :through => :way_nodes, :order => 'sequence_id'
  17
  18   has_many :way_tags, :foreign_key => 'id'
  19
  20   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
  21   has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation, :extend => ObjectFinder
  22
  23   def self.from_xml(xml, create=false)
  24     begin
  25       p = XML::Parser.new
  26       p.string = xml
  27       doc = p.parse
  28
  29       doc.find('//osm/way').each do |pt|
  30         return Way.from_xml_node(pt, create)
  31       end
  32     rescue
  33       return nil
  34     end
  35   end
  36
  37   def self.from_xml_node(pt, create=false)
  38     way = Way.new
  39
  40     if !create and pt['id'] != '0'
  41       way.id = pt['id'].to_i
  42     end
  43
  44     way.version = pt['version']
  45     way.changeset_id = pt['changeset']
  46
  47     if create
  48       way.timestamp = Time.now
  49       way.visible = true
  50     else
  51       if pt['timestamp']
  52         way.timestamp = Time.parse(pt['timestamp'])
  53       end
  54       # if visible isn't present then it defaults to true
  55       way.visible = (pt['visible'] or true)
  56     end
  57
  58     pt.find('tag').each do |tag|
  59       way.add_tag_keyval(tag['k'], tag['v'])
  60     end
  61
  62     pt.find('nd').each do |nd|
  63       way.add_nd_num(nd['ref'])
  64     end
  65
  66     return way
  67   end
  68
  69   # Find a way given it's ID, and in a single SQL call also grab its nodes
  70   #
  71
  72   # You can't pull in all the tags too unless we put a sequence_id on the way_tags table and have a multipart key
  73   def self.find_eager(id)
  74     way = Way.find(id, :include => {:way_nodes => :node})
  75     #If waytag had a multipart key that was real, you could do this:
  76     #way = Way.find(id, :include => [:way_tags, {:way_nodes => :node}])
  77   end
  78
  79   # Find a way given it's ID, and in a single SQL call also grab its nodes and tags
  80   def to_xml
  81     doc = OSM::API.new.get_xml_doc
  82     doc.root << to_xml_node()
  83     return doc
  84   end
  85
  86   def to_xml_node(visible_nodes = nil, user_display_name_cache = nil)
  87     el1 = XML::Node.new 'way'
  88     el1['id'] = self.id.to_s
  89     el1['visible'] = self.visible.to_s
  90     el1['timestamp'] = self.timestamp.xmlschema
  91     el1['version'] = self.version.to_s
  92     el1['changeset'] = self.changeset_id.to_s
  93
  94     user_display_name_cache = {} if user_display_name_cache.nil?
  95
  96     if user_display_name_cache and user_display_name_cache.key?(self.changeset.user_id)
  97       # use the cache if available
  98     elsif self.changeset.user.data_public?
  99       user_display_name_cache[self.changeset.user_id] = self.changeset.user.display_name
 100     else
 101       user_display_name_cache[self.changeset.user_id] = nil
 102     end
 103
 104     el1['user'] = user_display_name_cache[self.changeset.user_id] unless user_display_name_cache[self.changeset.user_id].nil?
 105
 106     # make sure nodes are output in sequence_id order
 107     ordered_nodes = []
 108     self.way_nodes.each do |nd|
 109       if visible_nodes
 110         # if there is a list of visible nodes then use that to weed out deleted nodes
 111         if visible_nodes[nd.node_id]
 112           ordered_nodes[nd.sequence_id] = nd.node_id.to_s
 113         end
 114       else
 115         # otherwise, manually go to the db to check things
 116         if nd.node.visible? and nd.node.visible?
 117           ordered_nodes[nd.sequence_id] = nd.node_id.to_s
 118         end
 119       end
 120     end
 121
 122     ordered_nodes.each do |nd_id|
 123       if nd_id and nd_id != '0'
 124         e = XML::Node.new 'nd'
 125         e['ref'] = nd_id
 126         el1 << e
 127       end
 128     end
 129
 130     self.way_tags.each do |tag|
 131       e = XML::Node.new 'tag'
 132       e['k'] = tag.k
 133       e['v'] = tag.v
 134       el1 << e
 135     end
 136     return el1
 137   end
 138
 139   def nds
 140     unless @nds
 141       @nds = Array.new
 142       self.way_nodes.each do |nd|
 143         @nds += [nd.node_id]
 144       end
 145     end
 146     @nds
 147   end
 148
 149   def tags
 150     unless @tags
 151       @tags = {}
 152       self.way_tags.each do |tag|
 153         @tags[tag.k] = tag.v
 154       end
 155     end
 156     @tags
 157   end
 158
 159   def nds=(s)
 160     @nds = s
 161   end
 162
 163   def tags=(t)
 164     @tags = t
 165   end
 166
 167   def add_nd_num(n)
 168     @nds = Array.new unless @nds
 169     @nds << n.to_i
 170   end
 171
 172   def add_tag_keyval(k, v)
 173     @tags = Hash.new unless @tags
 174
 175     # duplicate tags are now forbidden, so we can't allow values
 176     # in the hash to be overwritten.
 177     raise OSM::APIDuplicateTagsError.new if @tags.include? k
 178
 179     @tags[k] = v
 180   end
 181
 182   def save_with_history!
 183     t = Time.now
 184
 185     Way.transaction do
 186       self.version += 1
 187       self.timestamp = t
 188       self.save!
 189
 190       tags = self.tags
 191       WayTag.delete_all(['id = ?', self.id])
 192       tags.each do |k,v|
 193         tag = WayTag.new
 194         tag.k = k
 195         tag.v = v
 196         tag.id = self.id
 197         tag.save!
 198       end
 199
 200       nds = self.nds
 201       WayNode.delete_all(['id = ?', self.id])
 202       sequence = 1
 203       nds.each do |n|
 204         nd = WayNode.new
 205         nd.id = [self.id, sequence]
 206         nd.node_id = n
 207         nd.save!
 208         sequence += 1
 209       end
 210
 211       old_way = OldWay.from_way(self)
 212       old_way.timestamp = t
 213       old_way.save_with_dependencies!
 214     end
 215   end
 216
 217   def update_from(new_way, user)
 218     check_consistency(self, new_way, user)
 219     if !new_way.preconditions_ok?
 220       raise OSM::APIPreconditionFailedError.new
 221     end
 222     self.changeset_id = new_way.changeset_id
 223     self.tags = new_way.tags
 224     self.nds = new_way.nds
 225     self.visible = true
 226     save_with_history!
 227   end
 228
 229   def create_with_history(user)
 230     check_create_consistency(self, user)
 231     if !self.preconditions_ok?
 232       raise OSM::APIPreconditionFailedError.new
 233     end
 234     self.version = 0
 235     self.visible = true
 236     save_with_history!
 237   end
 238
 239   def preconditions_ok?
 240     return false if self.nds.empty?
 241     if self.nds.length > APP_CONFIG['max_number_of_way_nodes']
 242       raise OSM::APITooManyWayNodesError.new(self.nds.count, APP_CONFIG['max_number_of_way_nodes'])
 243     end
 244     self.nds.each do |n|
 245       node = Node.find(:first, :conditions => ["id = ?", n])
 246       unless node and node.visible
 247         return false
 248       end
 249     end
 250     return true
 251   end
 252
 253   def delete_with_history!(new_way, user)
 254     check_consistency(self, new_way, user)
 255     if self.visible
 256       if RelationMember.find(:first, :joins => "INNER JOIN current_relations ON current_relations.id=current_relation_members.id",
 257                              :conditions => [ "visible = 1 AND member_type='way' and member_id=? ", self.id])
 258         raise OSM::APIPreconditionFailedError
 259       else
 260         self.changeset_id = new_way.changeset_id
 261         self.tags = []
 262         self.nds = []
 263         self.visible = false
 264         self.save_with_history!
 265       end
 266     else
 267       raise OSM::APIAlreadyDeletedError
 268     end
 269   end
 270
 271   # delete a way and it's nodes that aren't part of other ways, with history
 272
 273   # FIXME: merge the potlatch code to delete the relations
 274   def delete_with_relations_and_nodes_and_history(user)
 275     # delete the nodes not used by other ways
 276     self.unshared_node_ids.each do |node_id|
 277       n = Node.find(node_id)
 278       n.user_id = user.id
 279       n.visible = false
 280       n.save_with_history!
 281     end
 282
 283     # FIXME needs more information passed in so that the changeset can be updated
 284     self.user_id = user.id
 285
 286     self.delete_with_history(user)
 287   end
 288
 289   # Find nodes that belong to this way only
 290   def unshared_node_ids
 291     node_ids = self.nodes.collect { |node| node.id }
 292
 293     unless node_ids.empty?
 294       way_nodes = WayNode.find(:all, :conditions => "node_id in (#{node_ids.join(',')}) and id != #{self.id}")
 295       node_ids = node_ids - way_nodes.collect { |way_node| way_node.node_id }
 296     end
 297
 298     return node_ids
 299   end
 300
 301   # Temporary method to match interface to nodes
 302   def tags_as_hash
 303     return self.tags
 304   end
 305
 306   ##
 307   # if any referenced nodes are placeholder IDs (i.e: are negative) then
 308   # this calling this method will fix them using the map from placeholders
 309   # to IDs +id_map+.
 310   def fix_placeholders!(id_map)
 311     self.nds.map! do |node_id|
 312       if node_id < 0
 313         new_id = id_map[:node][node_id]
 314         raise "invalid placeholder for #{node_id.inspect}: #{new_id.inspect}" if new_id.nil?
 315         new_id
 316       else
 317         node_id
 318       end
 319     end
 320   end
 321
 322 end