app/models/changeset.rb

   1 # == Schema Information
   2 #
   3 # Table name: changesets
   4 #
   5 #  id          :bigint(8)        not null, primary key
   6 #  user_id     :bigint(8)        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) USING gist
  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 < ApplicationRecord
  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, :only_integer => true }
  47   validates :user_id, :presence => true,
  48                       :numericality => { :only_integer => true }
  49   validates :num_changes, :presence => true,
  50                           :numericality => { :only_integer => 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 => { :only_integer => true }
  55
  56   before_save :update_closed_at
  57
  58   # maximum number of elements allowed in a changeset
  59   MAX_ELEMENTS = 10000
  60
  61   # maximum time a changeset is allowed to be open for.
  62   MAX_TIME_OPEN = 1.day
  63
  64   # idle timeout increment, one hour seems reasonable.
  65   IDLE_TIMEOUT = 1.hour
  66
  67   # Use a method like this, so that we can easily change how we
  68   # determine whether a changeset is open, without breaking code in at
  69   # least 6 controllers
  70   def is_open?
  71     # a changeset is open (that is, it will accept further changes) when
  72     # it has not yet run out of time and its capacity is small enough.
  73     # note that this may not be a hard limit - due to timing changes and
  74     # concurrency it is possible that some changesets may be slightly
  75     # longer than strictly allowed or have slightly more changes in them.
  76     ((closed_at > Time.now.getutc) && (num_changes <= MAX_ELEMENTS))
  77   end
  78
  79   def set_closed_time_now
  80     self.closed_at = Time.now.getutc if is_open?
  81   end
  82
  83   def self.from_xml(xml, create: false)
  84     p = XML::Parser.string(xml, :options => XML::Parser::Options::NOERROR)
  85     doc = p.parse
  86     pt = doc.find_first("//osm/changeset")
  87
  88     if pt
  89       Changeset.from_xml_node(pt, :create => create)
  90     else
  91       raise OSM::APIBadXMLError.new("changeset", xml, "XML doesn't contain an osm/changeset element.")
  92     end
  93   rescue LibXML::XML::Error, ArgumentError => e
  94     raise OSM::APIBadXMLError.new("changeset", xml, e.message)
  95   end
  96
  97   def self.from_xml_node(pt, create: false)
  98     cs = Changeset.new
  99     if create
 100       cs.created_at = Time.now.getutc
 101       # initial close time is 1h ahead, but will be increased on each
 102       # modification.
 103       cs.closed_at = cs.created_at + IDLE_TIMEOUT
 104       # initially we have no changes in a changeset
 105       cs.num_changes = 0
 106     end
 107
 108     pt.find("tag").each do |tag|
 109       raise OSM::APIBadXMLError.new("changeset", pt, "tag is missing key") if tag["k"].nil?
 110       raise OSM::APIBadXMLError.new("changeset", pt, "tag is missing value") if tag["v"].nil?
 111
 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.
 131   def update_bbox!(bbox_update)
 132     bbox.expand!(bbox_update)
 133
 134     # update active record. rails 2.1's dirty handling should take care of
 135     # whether this object needs saving or not.
 136     self.min_lon, self.min_lat, self.max_lon, self.max_lat = @bbox.to_a.collect(&:round) if bbox.complete?
 137   end
 138
 139   ##
 140   # the number of elements is also passed in so that we can ensure that
 141   # a single changeset doesn't contain too many elements.
 142   def add_changes!(elements)
 143     self.num_changes += elements
 144   end
 145
 146   def tags
 147     unless @tags
 148       @tags = {}
 149       changeset_tags.each do |tag|
 150         @tags[tag.k] = tag.v
 151       end
 152     end
 153     @tags
 154   end
 155
 156   attr_writer :tags
 157
 158   def add_tag_keyval(k, v)
 159     @tags ||= {}
 160
 161     # duplicate tags are now forbidden, so we can't allow values
 162     # in the hash to be overwritten.
 163     raise OSM::APIDuplicateTagsError.new("changeset", id, k) if @tags.include? k
 164
 165     @tags[k] = v
 166   end
 167
 168   def save_with_tags!
 169     # do the changeset update and the changeset tags update in the
 170     # same transaction to ensure consistency.
 171     Changeset.transaction do
 172       save!
 173
 174       tags = self.tags
 175       ChangesetTag.where(:changeset_id => id).delete_all
 176
 177       tags.each do |k, v|
 178         tag = ChangesetTag.new
 179         tag.changeset_id = id
 180         tag.k = k
 181         tag.v = v
 182         tag.save!
 183       end
 184     end
 185   end
 186
 187   ##
 188   # set the auto-close time to be one hour in the future unless
 189   # that would make it more than 24h long, in which case clip to
 190   # 24h, as this has been decided is a reasonable time limit.
 191   def update_closed_at
 192     if is_open?
 193       self.closed_at = if (closed_at - created_at) > (MAX_TIME_OPEN - IDLE_TIMEOUT)
 194                          created_at + MAX_TIME_OPEN
 195                        else
 196                          Time.now.getutc + IDLE_TIMEOUT
 197                        end
 198     end
 199   end
 200
 201   ##
 202   # update this instance from another instance given and the user who is
 203   # doing the updating. note that this method is not for updating the
 204   # bounding box, only the tags of the changeset.
 205   def update_from(other, user)
 206     # ensure that only the user who opened the changeset may modify it.
 207     raise OSM::APIUserChangesetMismatchError unless user.id == user_id
 208
 209     # can't change a closed changeset
 210     raise OSM::APIChangesetAlreadyClosedError, self unless is_open?
 211
 212     # copy the other's tags
 213     self.tags = other.tags
 214
 215     save_with_tags!
 216   end
 217 end