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