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