Merge potlatch_010 branch to head.
[rails.git] / app / models / way.rb
1 class Way < ActiveRecord::Base
2   require 'xml/libxml'
3
4   set_table_name 'current_ways'
5
6   belongs_to :user
7
8   has_many :old_ways, :foreign_key => 'id', :order => 'version'
9
10   has_many :way_nodes, :foreign_key => 'id', :order => 'sequence_id'
11   has_many :nodes, :through => :way_nodes, :order => 'sequence_id'
12
13   has_many :way_tags, :foreign_key => 'id'
14
15   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
16   has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation, :extend => ObjectFinder
17
18   def self.from_xml(xml, create=false)
19     begin
20       p = XML::Parser.new
21       p.string = xml
22       doc = p.parse
23
24       way = Way.new
25
26       doc.find('//osm/way').each do |pt|
27         if !create and pt['id'] != '0'
28           way.id = pt['id'].to_i
29         end
30
31         if create
32           way.timestamp = Time.now
33           way.visible = true
34         else
35           if pt['timestamp']
36             way.timestamp = Time.parse(pt['timestamp'])
37           end
38         end
39
40         pt.find('tag').each do |tag|
41           way.add_tag_keyval(tag['k'], tag['v'])
42         end
43
44         pt.find('nd').each do |nd|
45           way.add_nd_num(nd['ref'])
46         end
47       end
48     rescue
49       way = nil
50     end
51
52     return way
53   end
54
55   # Find a way given it's ID, and in a single SQL call also grab its nodes
56   #
57   
58   # 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
59   def self.find_eager(id)
60     way = Way.find(id, :include => {:way_nodes => :node})
61     #If waytag had a multipart key that was real, you could do this:
62     #way = Way.find(id, :include => [:way_tags, {:way_nodes => :node}])
63   end
64
65   # Find a way given it's ID, and in a single SQL call also grab its nodes and tags
66   def to_xml
67     doc = OSM::API.new.get_xml_doc
68     doc.root << to_xml_node()
69     return doc
70   end
71
72   def to_xml_node(visible_nodes = nil, user_display_name_cache = nil)
73     el1 = XML::Node.new 'way'
74     el1['id'] = self.id.to_s
75     el1['visible'] = self.visible.to_s
76     el1['timestamp'] = self.timestamp.xmlschema
77
78     user_display_name_cache = {} if user_display_name_cache.nil?
79
80     if user_display_name_cache and user_display_name_cache.key?(self.user_id)
81       # use the cache if available
82     elsif self.user.data_public?
83       user_display_name_cache[self.user_id] = self.user.display_name
84     else
85       user_display_name_cache[self.user_id] = nil
86     end
87
88     el1['user'] = user_display_name_cache[self.user_id] unless user_display_name_cache[self.user_id].nil?
89
90     # make sure nodes are output in sequence_id order
91     ordered_nodes = []
92     self.way_nodes.each do |nd|
93       if visible_nodes
94         # if there is a list of visible nodes then use that to weed out deleted nodes
95         if visible_nodes[nd.node_id]
96           ordered_nodes[nd.sequence_id] = nd.node_id.to_s
97         end
98       else
99         # otherwise, manually go to the db to check things
100         if nd.node.visible? and nd.node.visible?
101           ordered_nodes[nd.sequence_id] = nd.node_id.to_s
102         end
103       end
104     end
105
106     ordered_nodes.each do |nd_id|
107       if nd_id and nd_id != '0'
108         e = XML::Node.new 'nd'
109         e['ref'] = nd_id
110         el1 << e
111       end
112     end
113
114     self.way_tags.each do |tag|
115       e = XML::Node.new 'tag'
116       e['k'] = tag.k
117       e['v'] = tag.v
118       el1 << e
119     end
120     return el1
121   end 
122
123   def nds
124     unless @nds
125       @nds = Array.new
126       self.way_nodes.each do |nd|
127         @nds += [nd.node_id]
128       end
129     end
130     @nds
131   end
132
133   def tags
134     unless @tags
135       @tags = {}
136       self.way_tags.each do |tag|
137         @tags[tag.k] = tag.v
138       end
139     end
140     @tags
141   end
142
143   def nds=(s)
144     @nds = s
145   end
146
147   def tags=(t)
148     @tags = t
149   end
150
151   def add_nd_num(n)
152     @nds = Array.new unless @nds
153     @nds << n.to_i
154   end
155
156   def add_tag_keyval(k, v)
157     @tags = Hash.new unless @tags
158     @tags[k] = v
159   end
160
161   def save_with_history!
162     t = Time.now
163
164     Way.transaction do
165       self.timestamp = t
166       self.save!
167     end
168
169     WayTag.transaction do
170       tags = self.tags
171
172       WayTag.delete_all(['id = ?', self.id])
173
174       tags.each do |k,v|
175         tag = WayTag.new
176         tag.k = k
177         tag.v = v
178         tag.id = self.id
179         tag.save!
180       end
181     end
182
183     WayNode.transaction do
184       nds = self.nds
185
186       WayNode.delete_all(['id = ?', self.id])
187
188       sequence = 1
189       nds.each do |n|
190         nd = WayNode.new
191         nd.id = [self.id, sequence]
192         nd.node_id = n
193         nd.save!
194         sequence += 1
195       end
196     end
197
198     old_way = OldWay.from_way(self)
199     old_way.timestamp = t
200     old_way.save_with_dependencies!
201   end
202
203   def preconditions_ok?
204     return false if self.nds.empty?
205     self.nds.each do |n|
206       node = Node.find(:first, :conditions => ["id = ?", n])
207       unless node and node.visible
208         return false
209       end
210     end
211     return true
212   end
213
214   # Delete the way and it's relations, but don't really delete it - set its visibility to false and update the history etc to maintain wiki-like functionality.
215   def delete_with_relations_and_history(user)
216     if self.visible
217           # FIXME
218           # this should actually delete the relations,
219           # not just throw a PreconditionFailed if it's a member of a relation!!
220       if RelationMember.find(:first, :joins => "INNER JOIN current_relations ON current_relations.id=current_relation_members.id",
221                              :conditions => [ "visible = 1 AND member_type='way' and member_id=?", self.id])
222         raise OSM::APIPreconditionFailedError
223       # end FIXME
224       else
225         self.user_id = user.id
226         self.tags = []
227         self.nds = []
228         self.visible = false
229         self.save_with_history!
230       end
231     else
232       raise OSM::APIAlreadyDeletedError
233     end
234   end
235
236   # delete a way and it's nodes that aren't part of other ways, with history
237   def delete_with_relations_and_nodes_and_history(user)
238     node_ids_to_delete = node_ids - node_ids_not_to_delete
239
240     # delete the nodes not used by other ways
241     self.unshared_node_ids.each do |node_id|
242       n = Node.find(node_id)
243       n.user_id = user.id
244       n.visible = false
245       n.save_with_history!
246     end
247     
248     self.user_id = user.id
249
250     self.delete_with_relations_and_history(user)
251   end
252
253   # Find nodes that belong to this way only
254   def unshared_node_ids
255     node_ids = self.nodes.collect { |node| node.id }
256
257     unless node_ids.empty?
258       way_nodes = WayNode.find(:all, :conditions => "node_id in (#{node_ids.join(',')}) and id != #{self.id}")
259       node_ids = node_ids - way_nodes.collect { |way_node| way_node.node_id }
260     end
261
262     return node_ids
263   end
264
265   # Temporary method to match interface to nodes
266   def tags_as_hash
267     return self.tags
268   end
269 end