Fix most auto-correctable rubocop issues
[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     if is_open?
54       self.closed_at = Time.now.getutc
55     end
56   end
57
58   def self.from_xml(xml, create = false)
59     p = XML::Parser.string(xml, :options => XML::Parser::Options::NOERROR)
60     doc = p.parse
61
62     doc.find('//osm/changeset').each do |pt|
63       return Changeset.from_xml_node(pt, create)
64     end
65     fail OSM::APIBadXMLError.new("changeset", xml, "XML doesn't contain an osm/changeset element.")
66   rescue LibXML::XML::Error, ArgumentError => ex
67     raise OSM::APIBadXMLError.new("changeset", xml, ex.message)
68   end
69
70   def self.from_xml_node(pt, create = false)
71     cs = Changeset.new
72     if create
73       cs.created_at = Time.now.getutc
74       # initial close time is 1h ahead, but will be increased on each
75       # modification.
76       cs.closed_at = cs.created_at + IDLE_TIMEOUT
77       # initially we have no changes in a changeset
78       cs.num_changes = 0
79     end
80
81     pt.find('tag').each do |tag|
82       fail OSM::APIBadXMLError.new("changeset", pt, "tag is missing key") if tag['k'].nil?
83       fail OSM::APIBadXMLError.new("changeset", pt, "tag is missing value") if tag['v'].nil?
84       cs.add_tag_keyval(tag['k'], tag['v'])
85     end
86
87     cs
88   end
89
90   ##
91   # returns the bounding box of the changeset. it is possible that some
92   # or all of the values will be nil, indicating that they are undefined.
93   def bbox
94     @bbox ||= BoundingBox.new(min_lon, min_lat, max_lon, max_lat)
95   end
96
97   def has_valid_bbox?
98     bbox.complete?
99   end
100
101   ##
102   # expand the bounding box to include the given bounding box. also,
103   # expand a little bit more in the direction of the expansion, so that
104   # further expansions may be unnecessary. this is an optimisation
105   # suggested on the wiki page by kleptog.
106   def update_bbox!(bbox_update)
107     bbox.expand!(bbox_update, EXPAND)
108
109     # update active record. rails 2.1's dirty handling should take care of
110     # whether this object needs saving or not.
111     self.min_lon, self.min_lat, self.max_lon, self.max_lat = @bbox.to_a if bbox.complete?
112   end
113
114   ##
115   # the number of elements is also passed in so that we can ensure that
116   # a single changeset doesn't contain too many elements. this, of course,
117   # destroys the optimisation described in the bbox method above.
118   def add_changes!(elements)
119     self.num_changes += elements
120   end
121
122   def tags_as_hash
123     tags
124   end
125
126   def tags
127     unless @tags
128       @tags = {}
129       changeset_tags.each do |tag|
130         @tags[tag.k] = tag.v
131       end
132     end
133     @tags
134   end
135
136   attr_writer :tags
137
138   def add_tag_keyval(k, v)
139     @tags = {} unless @tags
140
141     # duplicate tags are now forbidden, so we can't allow values
142     # in the hash to be overwritten.
143     fail OSM::APIDuplicateTagsError.new("changeset", id, k) if @tags.include? k
144
145     @tags[k] = v
146   end
147
148   def save_with_tags!
149     # do the changeset update and the changeset tags update in the
150     # same transaction to ensure consistency.
151     Changeset.transaction do
152       self.save!
153
154       tags = self.tags
155       ChangesetTag.delete_all(:changeset_id => id)
156
157       tags.each do |k, v|
158         tag = ChangesetTag.new
159         tag.changeset_id = id
160         tag.k = k
161         tag.v = v
162         tag.save!
163       end
164     end
165   end
166
167   ##
168   # set the auto-close time to be one hour in the future unless
169   # that would make it more than 24h long, in which case clip to
170   # 24h, as this has been decided is a reasonable time limit.
171   def update_closed_at
172     if self.is_open?
173       if (closed_at - created_at) > (MAX_TIME_OPEN - IDLE_TIMEOUT)
174         self.closed_at = created_at + MAX_TIME_OPEN
175       else
176         self.closed_at = Time.now.getutc + IDLE_TIMEOUT
177       end
178     end
179   end
180
181   def to_xml(include_discussion = false)
182     doc = OSM::API.new.get_xml_doc
183     doc.root << to_xml_node(nil, include_discussion)
184     doc
185   end
186
187   def to_xml_node(user_display_name_cache = nil, include_discussion = false)
188     el1 = XML::Node.new 'changeset'
189     el1['id'] = id.to_s
190
191     user_display_name_cache = {} if user_display_name_cache.nil?
192
193     if user_display_name_cache && user_display_name_cache.key?(user_id)
194       # use the cache if available
195     elsif user.data_public?
196       user_display_name_cache[user_id] = user.display_name
197     else
198       user_display_name_cache[user_id] = nil
199     end
200
201     el1['user'] = user_display_name_cache[user_id] unless user_display_name_cache[user_id].nil?
202     el1['uid'] = user_id.to_s if user.data_public?
203
204     tags.each do |k, v|
205       el2 = XML::Node.new('tag')
206       el2['k'] = k.to_s
207       el2['v'] = v.to_s
208       el1 << el2
209     end
210
211     el1['created_at'] = created_at.xmlschema
212     el1['closed_at'] = closed_at.xmlschema unless is_open?
213     el1['open'] = is_open?.to_s
214
215     if bbox.complete?
216       bbox.to_unscaled.add_bounds_to(el1, '_')
217     end
218
219     el1['comments_count'] = comments.count.to_s
220
221     if include_discussion
222       el2 = XML::Node.new('discussion')
223       comments.includes(:author).each do |comment|
224         el3 = XML::Node.new('comment')
225         el3['date'] = comment.created_at.xmlschema
226         el3['uid'] = comment.author.id.to_s if comment.author.data_public?
227         el3['user'] = comment.author.display_name.to_s if comment.author.data_public?
228         el4 = XML::Node.new('text')
229         el4.content = comment.body.to_s
230         el3 << el4
231         el2 << el3
232       end
233       el1 << el2
234     end
235
236     # NOTE: changesets don't include the XML of the changes within them,
237     # they are just structures for tagging. to get the osmChange of a
238     # changeset, see the download method of the controller.
239
240     el1
241   end
242
243   ##
244   # update this instance from another instance given and the user who is
245   # doing the updating. note that this method is not for updating the
246   # bounding box, only the tags of the changeset.
247   def update_from(other, user)
248     # ensure that only the user who opened the changeset may modify it.
249     unless user.id == user_id
250       fail OSM::APIUserChangesetMismatchError.new
251     end
252
253     # can't change a closed changeset
254     unless is_open?
255       fail OSM::APIChangesetAlreadyClosedError.new(self)
256     end
257
258     # copy the other's tags
259     self.tags = other.tags
260
261     save_with_tags!
262   end
263 end