X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/c57d2b29fc1f4647b460b6b74d072c409932e3f2..7e5cbe87ed37f9cba8224fa4049047d7f981f66a:/app/models/changeset.rb?ds=sidebyside diff --git a/app/models/changeset.rb b/app/models/changeset.rb index 549600df6..f23a4e356 100644 --- a/app/models/changeset.rb +++ b/app/models/changeset.rb @@ -1,4 +1,31 @@ -class Changeset < ActiveRecord::Base +# == Schema Information +# +# Table name: changesets +# +# id :bigint(8) not null, primary key +# user_id :bigint(8) not null +# created_at :datetime not null +# min_lat :integer +# max_lat :integer +# min_lon :integer +# max_lon :integer +# closed_at :datetime not null +# num_changes :integer default(0), not null +# +# Indexes +# +# changesets_bbox_idx (min_lat,max_lat,min_lon,max_lon) USING gist +# changesets_closed_at_idx (closed_at) +# changesets_created_at_idx (created_at) +# changesets_user_id_created_at_idx (user_id,created_at) +# changesets_user_id_id_idx (user_id,id) +# +# Foreign Keys +# +# changesets_user_id_fkey (user_id => users.id) +# + +class Changeset < ApplicationRecord require "xml/libxml" belongs_to :user, :counter_cache => true @@ -16,21 +43,16 @@ class Changeset < ActiveRecord::Base has_and_belongs_to_many :subscribers, :class_name => "User", :join_table => "changesets_subscribers", :association_foreign_key => "subscriber_id" validates :id, :uniqueness => true, :presence => { :on => :update }, - :numericality => { :on => :update, :integer_only => true } - validates :user_id, :presence => true, - :numericality => { :integer_only => true } + :numericality => { :on => :update, :only_integer => true } validates :num_changes, :presence => true, - :numericality => { :integer_only => true, + :numericality => { :only_integer => true, :greater_than_or_equal_to => 0 } validates :created_at, :closed_at, :presence => true validates :min_lat, :max_lat, :min_lon, :max_lat, :allow_nil => true, - :numericality => { :integer_only => true } + :numericality => { :only_integer => true } before_save :update_closed_at - # over-expansion factor to use when updating the bounding box - EXPAND = 0.1 - # maximum number of elements allowed in a changeset MAX_ELEMENTS = 10000 @@ -43,35 +65,37 @@ class Changeset < ActiveRecord::Base # Use a method like this, so that we can easily change how we # determine whether a changeset is open, without breaking code in at # least 6 controllers - def is_open? + def open? # a changeset is open (that is, it will accept further changes) when # it has not yet run out of time and its capacity is small enough. # note that this may not be a hard limit - due to timing changes and # concurrency it is possible that some changesets may be slightly # longer than strictly allowed or have slightly more changes in them. - ((closed_at > Time.now.getutc) && (num_changes <= MAX_ELEMENTS)) + ((closed_at > Time.now.utc) && (num_changes <= MAX_ELEMENTS)) end def set_closed_time_now - self.closed_at = Time.now.getutc if is_open? + self.closed_at = Time.now.utc if open? end - def self.from_xml(xml, create = false) + def self.from_xml(xml, create: false) p = XML::Parser.string(xml, :options => XML::Parser::Options::NOERROR) doc = p.parse + pt = doc.find_first("//osm/changeset") - doc.find("//osm/changeset").each do |pt| - return Changeset.from_xml_node(pt, create) + if pt + Changeset.from_xml_node(pt, :create => create) + else + raise OSM::APIBadXMLError.new("changeset", xml, "XML doesn't contain an osm/changeset element.") end - raise OSM::APIBadXMLError.new("changeset", xml, "XML doesn't contain an osm/changeset element.") - rescue LibXML::XML::Error, ArgumentError => ex - raise OSM::APIBadXMLError.new("changeset", xml, ex.message) + rescue LibXML::XML::Error, ArgumentError => e + raise OSM::APIBadXMLError.new("changeset", xml, e.message) end - def self.from_xml_node(pt, create = false) + def self.from_xml_node(pt, create: false) cs = Changeset.new if create - cs.created_at = Time.now.getutc + cs.created_at = Time.now.utc # initial close time is 1h ahead, but will be increased on each # modification. cs.closed_at = cs.created_at + IDLE_TIMEOUT @@ -82,6 +106,7 @@ class Changeset < ActiveRecord::Base pt.find("tag").each do |tag| raise OSM::APIBadXMLError.new("changeset", pt, "tag is missing key") if tag["k"].nil? raise OSM::APIBadXMLError.new("changeset", pt, "tag is missing value") if tag["v"].nil? + cs.add_tag_keyval(tag["k"], tag["v"]) end @@ -95,27 +120,23 @@ class Changeset < ActiveRecord::Base @bbox ||= BoundingBox.new(min_lon, min_lat, max_lon, max_lat) end - def has_valid_bbox? + def bbox_valid? bbox.complete? end ## - # expand the bounding box to include the given bounding box. also, - # expand a little bit more in the direction of the expansion, so that - # further expansions may be unnecessary. this is an optimisation - # suggested on the wiki page by kleptog. + # expand the bounding box to include the given bounding box. def update_bbox!(bbox_update) - bbox.expand!(bbox_update, EXPAND) + bbox.expand!(bbox_update) # update active record. rails 2.1's dirty handling should take care of # whether this object needs saving or not. - self.min_lon, self.min_lat, self.max_lon, self.max_lat = @bbox.to_a if bbox.complete? + self.min_lon, self.min_lat, self.max_lon, self.max_lat = @bbox.to_a.collect(&:round) if bbox.complete? end ## # the number of elements is also passed in so that we can ensure that - # a single changeset doesn't contain too many elements. this, of course, - # destroys the optimisation described in the bbox method above. + # a single changeset doesn't contain too many elements. def add_changes!(elements) self.num_changes += elements end @@ -133,7 +154,7 @@ class Changeset < ActiveRecord::Base attr_writer :tags def add_tag_keyval(k, v) - @tags = {} unless @tags + @tags ||= {} # duplicate tags are now forbidden, so we can't allow values # in the hash to be overwritten. @@ -149,7 +170,7 @@ class Changeset < ActiveRecord::Base save! tags = self.tags - ChangesetTag.delete_all(:changeset_id => id) + ChangesetTag.where(:changeset_id => id).delete_all tags.each do |k, v| tag = ChangesetTag.new @@ -166,85 +187,25 @@ class Changeset < ActiveRecord::Base # that would make it more than 24h long, in which case clip to # 24h, as this has been decided is a reasonable time limit. def update_closed_at - if is_open? + if open? self.closed_at = if (closed_at - created_at) > (MAX_TIME_OPEN - IDLE_TIMEOUT) created_at + MAX_TIME_OPEN else - Time.now.getutc + IDLE_TIMEOUT + Time.now.utc + IDLE_TIMEOUT end end end - def to_xml(include_discussion = false) - doc = OSM::API.new.get_xml_doc - doc.root << to_xml_node(nil, include_discussion) - doc - end - - def to_xml_node(user_display_name_cache = nil, include_discussion = false) - el1 = XML::Node.new "changeset" - el1["id"] = id.to_s - - user_display_name_cache = {} if user_display_name_cache.nil? - - if user_display_name_cache && user_display_name_cache.key?(user_id) - # use the cache if available - elsif user.data_public? - user_display_name_cache[user_id] = user.display_name - else - user_display_name_cache[user_id] = nil - end - - el1["user"] = user_display_name_cache[user_id] unless user_display_name_cache[user_id].nil? - el1["uid"] = user_id.to_s if user.data_public? - - tags.each do |k, v| - el2 = XML::Node.new("tag") - el2["k"] = k.to_s - el2["v"] = v.to_s - el1 << el2 - end - - el1["created_at"] = created_at.xmlschema - el1["closed_at"] = closed_at.xmlschema unless is_open? - el1["open"] = is_open?.to_s - - bbox.to_unscaled.add_bounds_to(el1, "_") if bbox.complete? - - el1["comments_count"] = comments.count.to_s - - if include_discussion - el2 = XML::Node.new("discussion") - comments.includes(:author).each do |comment| - el3 = XML::Node.new("comment") - el3["date"] = comment.created_at.xmlschema - el3["uid"] = comment.author.id.to_s if comment.author.data_public? - el3["user"] = comment.author.display_name.to_s if comment.author.data_public? - el4 = XML::Node.new("text") - el4.content = comment.body.to_s - el3 << el4 - el2 << el3 - end - el1 << el2 - end - - # NOTE: changesets don't include the XML of the changes within them, - # they are just structures for tagging. to get the osmChange of a - # changeset, see the download method of the controller. - - el1 - end - ## # update this instance from another instance given and the user who is # doing the updating. note that this method is not for updating the # bounding box, only the tags of the changeset. def update_from(other, user) # ensure that only the user who opened the changeset may modify it. - raise OSM::APIUserChangesetMismatchError.new unless user.id == user_id + raise OSM::APIUserChangesetMismatchError unless user.id == user_id # can't change a closed changeset - raise OSM::APIChangesetAlreadyClosedError.new(self) unless is_open? + raise OSM::APIChangesetAlreadyClosedError, self unless open? # copy the other's tags self.tags = other.tags