Add has_valid_bbox? method to Changeset model to tidy checking for bbox, and fix...
[rails.git] / app / models / changeset.rb
1 class Changeset < ActiveRecord::Base
2   require 'xml/libxml'
3
4   belongs_to :user
5
6   has_many :changeset_tags, :foreign_key => 'id'
7   
8   has_many :nodes
9   has_many :ways
10   has_many :relations
11   has_many :old_nodes
12   has_many :old_ways
13   has_many :old_relations
14   
15   validates_presence_of :id, :on => :update
16   validates_presence_of :user_id, :created_at, :closed_at, :num_changes
17   validates_uniqueness_of :id
18   validates_numericality_of :id, :on => :update, :integer_only => true
19   validates_numericality_of :min_lat, :max_lat, :min_lon, :max_lat, :allow_nil => true, :integer_only => true
20   validates_numericality_of :user_id,  :integer_only => true
21   validates_numericality_of :num_changes, :integer_only => true, :greater_than_or_equal_to => 0
22   validates_associated :user
23
24   # over-expansion factor to use when updating the bounding box
25   EXPAND = 0.1
26
27   # maximum number of elements allowed in a changeset
28   MAX_ELEMENTS = 50000
29
30   # maximum time a changeset is allowed to be open for.
31   MAX_TIME_OPEN = 1.day
32
33   # idle timeout increment, one hour seems reasonable.
34   IDLE_TIMEOUT = 1.hour
35
36   # Use a method like this, so that we can easily change how we
37   # determine whether a changeset is open, without breaking code in at 
38   # least 6 controllers
39   def is_open?
40     # a changeset is open (that is, it will accept further changes) when
41     # it has not yet run out of time and its capacity is small enough.
42     # note that this may not be a hard limit - due to timing changes and
43     # concurrency it is possible that some changesets may be slightly 
44     # longer than strictly allowed or have slightly more changes in them.
45     return ((closed_at > Time.now.getutc) and (num_changes <= MAX_ELEMENTS))
46   end
47
48   def set_closed_time_now
49     if is_open?
50       self.closed_at = Time.now.getutc
51     end
52   end
53   
54   def self.from_xml(xml, create=false)
55     begin
56       p = XML::Parser.string(xml)
57       doc = p.parse
58
59       cs = Changeset.new
60
61       doc.find('//osm/changeset').each do |pt|
62         if create
63           cs.created_at = Time.now.getutc
64           # initial close time is 1h ahead, but will be increased on each
65           # modification.
66           cs.closed_at = cs.created_at + IDLE_TIMEOUT
67           # initially we have no changes in a changeset
68           cs.num_changes = 0
69         end
70
71         pt.find('tag').each do |tag|
72           cs.add_tag_keyval(tag['k'], tag['v'])
73         end
74       end
75     rescue Exception => ex
76       cs = nil
77     end
78
79     return cs
80   end
81
82   ##
83   # returns the bounding box of the changeset. it is possible that some
84   # or all of the values will be nil, indicating that they are undefined.
85   def bbox
86     @bbox ||= [ min_lon, min_lat, max_lon, max_lat ]
87   end
88   
89   def has_valid_bbox?
90     not bbox.include? nil
91   end
92
93   ##
94   # expand the bounding box to include the given bounding box. also, 
95   # expand a little bit more in the direction of the expansion, so that
96   # further expansions may be unnecessary. this is an optimisation 
97   # suggested on the wiki page by kleptog.
98   def update_bbox!(array)
99     # ensure that bbox is cached and has no nils in it. if there are any
100     # nils, just use the bounding box update to write over them.
101     @bbox = bbox.zip(array).collect { |a, b| a.nil? ? b : a }
102
103     # FIXME - this looks nasty and violates DRY... is there any prettier 
104     # way to do this? 
105     @bbox[0] = array[0] + EXPAND * (@bbox[0] - @bbox[2]) if array[0] < @bbox[0]
106     @bbox[1] = array[1] + EXPAND * (@bbox[1] - @bbox[3]) if array[1] < @bbox[1]
107     @bbox[2] = array[2] + EXPAND * (@bbox[2] - @bbox[0]) if array[2] > @bbox[2]
108     @bbox[3] = array[3] + EXPAND * (@bbox[3] - @bbox[1]) if array[3] > @bbox[3]
109
110     # update active record. rails 2.1's dirty handling should take care of
111     # whether this object needs saving or not.
112     self.min_lon, self.min_lat, self.max_lon, self.max_lat = @bbox
113   end
114
115   ##
116   # the number of elements is also passed in so that we can ensure that
117   # a single changeset doesn't contain too many elements. this, of course,
118   # destroys the optimisation described in the bbox method above.
119   def add_changes!(elements)
120     self.num_changes += elements
121   end
122
123   def tags_as_hash
124     return tags
125   end
126
127   def tags
128     unless @tags
129       @tags = {}
130       self.changeset_tags.each do |tag|
131         @tags[tag.k] = tag.v
132       end
133     end
134     @tags
135   end
136
137   def tags=(t)
138     @tags = t
139   end
140
141   def add_tag_keyval(k, v)
142     @tags = Hash.new unless @tags
143     @tags[k] = v
144   end
145
146   def save_with_tags!
147     t = Time.now.getutc
148
149     # do the changeset update and the changeset tags update in the
150     # same transaction to ensure consistency.
151     Changeset.transaction do
152       # set the auto-close time to be one hour in the future unless
153       # that would make it more than 24h long, in which case clip to
154       # 24h, as this has been decided is a reasonable time limit.
155       if (closed_at - created_at) > (MAX_TIME_OPEN - IDLE_TIMEOUT)
156         self.closed_at = created_at + MAX_TIME_OPEN
157       else
158         self.closed_at = Time.now.getutc + IDLE_TIMEOUT
159       end
160       self.save!
161
162       tags = self.tags
163       ChangesetTag.delete_all(['id = ?', self.id])
164
165       tags.each do |k,v|
166         tag = ChangesetTag.new
167         tag.k = k
168         tag.v = v
169         tag.id = self.id
170         tag.save!
171       end
172     end
173   end
174   
175   def to_xml
176     doc = OSM::API.new.get_xml_doc
177     doc.root << to_xml_node()
178     return doc
179   end
180   
181   def to_xml_node(user_display_name_cache = nil)
182     el1 = XML::Node.new 'changeset'
183     el1['id'] = self.id.to_s
184
185     user_display_name_cache = {} if user_display_name_cache.nil?
186
187     if user_display_name_cache and user_display_name_cache.key?(self.user_id)
188       # use the cache if available
189     elsif self.user.data_public?
190       user_display_name_cache[self.user_id] = self.user.display_name
191     else
192       user_display_name_cache[self.user_id] = nil
193     end
194
195     el1['user'] = user_display_name_cache[self.user_id] unless user_display_name_cache[self.user_id].nil?
196     el1['uid'] = self.user_id.to_s if self.user.data_public?
197
198     self.tags.each do |k,v|
199       el2 = XML::Node.new('tag')
200       el2['k'] = k.to_s
201       el2['v'] = v.to_s
202       el1 << el2
203     end
204     
205     el1['created_at'] = self.created_at.xmlschema
206     el1['closed_at'] = self.closed_at.xmlschema unless is_open?
207     el1['open'] = is_open?.to_s
208
209     el1['min_lon'] = (bbox[0].to_f / GeoRecord::SCALE).to_s unless bbox[0].nil?
210     el1['min_lat'] = (bbox[1].to_f / GeoRecord::SCALE).to_s unless bbox[1].nil?
211     el1['max_lon'] = (bbox[2].to_f / GeoRecord::SCALE).to_s unless bbox[2].nil?
212     el1['max_lat'] = (bbox[3].to_f / GeoRecord::SCALE).to_s unless bbox[3].nil?
213     
214     # NOTE: changesets don't include the XML of the changes within them,
215     # they are just structures for tagging. to get the osmChange of a
216     # changeset, see the download method of the controller.
217
218     return el1
219   end
220
221   ##
222   # update this instance from another instance given and the user who is
223   # doing the updating. note that this method is not for updating the
224   # bounding box, only the tags of the changeset.
225   def update_from(other, user)
226     # ensure that only the user who opened the changeset may modify it.
227     unless user.id == self.user_id 
228       raise OSM::APIUserChangesetMismatchError 
229     end
230     
231     # can't change a closed changeset
232     unless is_open?
233       raise OSM::APIChangesetAlreadyClosedError.new(self)
234     end
235
236     # copy the other's tags
237     self.tags = other.tags
238
239     save_with_tags!
240   end
241 end