app/models/changeset.rb

   1 # == Schema Information
   2 #
   3 # Table name: changesets
   4 #
   5 #  id                     :bigint           not null, primary key
   6 #  user_id                :bigint           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 #  num_created_nodes      :integer          default(0), not null
  15 #  num_modified_nodes     :integer          default(0), not null
  16 #  num_deleted_nodes      :integer          default(0), not null
  17 #  num_created_ways       :integer          default(0), not null
  18 #  num_modified_ways      :integer          default(0), not null
  19 #  num_deleted_ways       :integer          default(0), not null
  20 #  num_created_relations  :integer          default(0), not null
  21 #  num_modified_relations :integer          default(0), not null
  22 #  num_deleted_relations  :integer          default(0), not null
  23 #
  24 # Indexes
  25 #
  26 #  changesets_bbox_idx                        (min_lat,max_lat,min_lon,max_lon) USING gist
  27 #  changesets_closed_at_idx                   (closed_at)
  28 #  changesets_created_at_idx                  (created_at)
  29 #  changesets_user_id_created_at_idx          (user_id,created_at)
  30 #  changesets_user_id_id_idx                  (user_id,id)
  31 #  index_changesets_on_user_id_and_closed_at  (user_id,closed_at)
  32 #
  33 # Foreign Keys
  34 #
  35 #  changesets_user_id_fkey  (user_id => users.id)
  36 #
  37
  38 class Changeset < ApplicationRecord
  39   require "xml/libxml"
  40
  41   belongs_to :user, :counter_cache => true
  42
  43   has_many :changeset_tags
  44
  45   has_many :nodes
  46   has_many :ways
  47   has_many :relations
  48   has_many :old_nodes
  49   has_many :old_ways
  50   has_many :old_relations
  51
  52   has_many :comments, -> { where(:visible => true).order(:created_at) }, :class_name => "ChangesetComment"
  53   has_many :subscriptions, :class_name => "ChangesetSubscription"
  54   has_many :subscribers, :through => :subscriptions
  55
  56   validates :id, :uniqueness => true, :presence => { :on => :update },
  57                  :numericality => { :on => :update, :only_integer => true }
  58   [:num_changes,
  59    :num_created_nodes, :num_modified_nodes, :num_deleted_nodes,
  60    :num_created_ways, :num_modified_ways, :num_deleted_ways,
  61    :num_created_relations, :num_modified_relations, :num_deleted_relations].each do |counter_attribute|
  62     validates counter_attribute, :presence => true,
  63                                  :numericality => { :only_integer => true,
  64                                                     :greater_than_or_equal_to => 0 }
  65   end
  66   validates :created_at, :closed_at, :presence => true
  67   validates :min_lat, :max_lat, :min_lon, :max_lat, :allow_nil => true,
  68                                                     :numericality => { :only_integer => true }
  69
  70   before_save :update_closed_at
  71
  72   # maximum number of elements allowed in a changeset
  73   MAX_ELEMENTS = 10000
  74
  75   # maximum time a changeset is allowed to be open for.
  76   MAX_TIME_OPEN = 1.day
  77
  78   # idle timeout increment, one hour seems reasonable.
  79   IDLE_TIMEOUT = 1.hour
  80
  81   # Use a method like this, so that we can easily change how we
  82   # determine whether a changeset is open, without breaking code in at
  83   # least 6 controllers
  84   def open?
  85     # a changeset is open (that is, it will accept further changes) when
  86     # it has not yet run out of time and its capacity is small enough.
  87     # note that this may not be a hard limit - due to timing changes and
  88     # concurrency it is possible that some changesets may be slightly
  89     # longer than strictly allowed or have slightly more changes in them.
  90     (closed_at > Time.now.utc) && (num_changes <= MAX_ELEMENTS)
  91   end
  92
  93   def set_closed_time_now
  94     self.closed_at = Time.now.utc if open?
  95   end
  96
  97   def self.from_xml(xml, create: false)
  98     p = XML::Parser.string(xml, :options => XML::Parser::Options::NOERROR)
  99     doc = p.parse
 100     pt = doc.find_first("//osm/changeset")
 101
 102     if pt
 103       Changeset.from_xml_node(pt, :create => create)
 104     else
 105       raise OSM::APIBadXMLError.new("changeset", xml, "XML doesn't contain an osm/changeset element.")
 106     end
 107   rescue LibXML::XML::Error, ArgumentError => e
 108     raise OSM::APIBadXMLError.new("changeset", xml, e.message)
 109   end
 110
 111   def self.from_xml_node(pt, create: false)
 112     cs = Changeset.new
 113     if create
 114       cs.created_at = Time.now.utc
 115       # initial close time is 1h ahead, but will be increased on each
 116       # modification.
 117       cs.closed_at = cs.created_at + IDLE_TIMEOUT
 118       # initially we have no changes in a changeset
 119       cs.num_changes = 0
 120     end
 121
 122     pt.find("tag").each do |tag|
 123       raise OSM::APIBadXMLError.new("changeset", pt, "tag is missing key") if tag["k"].nil?
 124       raise OSM::APIBadXMLError.new("changeset", pt, "tag is missing value") if tag["v"].nil?
 125
 126       cs.add_tag_keyval(tag["k"], tag["v"])
 127     end
 128
 129     cs
 130   end
 131
 132   ##
 133   # returns the bounding box of the changeset. it is possible that some
 134   # or all of the values will be nil, indicating that they are undefined.
 135   def bbox
 136     @bbox ||= BoundingBox.new(min_lon, min_lat, max_lon, max_lat)
 137   end
 138
 139   def bbox_valid?
 140     bbox.complete?
 141   end
 142
 143   ##
 144   # expand the bounding box to include the given bounding box.
 145   def update_bbox!(bbox_update)
 146     bbox.expand!(bbox_update)
 147
 148     raise OSM::APISizeLimitExceeded if bbox.linear_size > size_limit
 149
 150     # update active record. rails 2.1's dirty handling should take care of
 151     # whether this object needs saving or not.
 152     self.min_lon, self.min_lat, self.max_lon, self.max_lat = @bbox.to_a.collect(&:round) if bbox.complete?
 153   end
 154
 155   ##
 156   # the number of elements is also passed in so that we can ensure that
 157   # a single changeset doesn't contain too many elements.
 158   def add_changes!(elements)
 159     self.num_changes += elements
 160   end
 161
 162   def tags
 163     unless @tags
 164       @tags = {}
 165       changeset_tags.each do |tag|
 166         @tags[tag.k] = tag.v
 167       end
 168     end
 169     @tags
 170   end
 171
 172   attr_writer :tags
 173
 174   def add_tag_keyval(k, v)
 175     @tags ||= {}
 176
 177     # duplicate tags are now forbidden, so we can't allow values
 178     # in the hash to be overwritten.
 179     raise OSM::APIDuplicateTagsError.new("changeset", id, k) if @tags.include? k
 180
 181     @tags[k] = v
 182   end
 183
 184   def save_with_tags!
 185     # do the changeset update and the changeset tags update in the
 186     # same transaction to ensure consistency.
 187     Changeset.transaction do
 188       save!
 189
 190       tags = self.tags
 191       ChangesetTag.where(:changeset => id).delete_all
 192
 193       tags.each do |k, v|
 194         tag = ChangesetTag.new
 195         tag.changeset_id = id
 196         tag.k = k
 197         tag.v = v
 198         tag.save!
 199       end
 200     end
 201   end
 202
 203   ##
 204   # set the auto-close time to be one hour in the future unless
 205   # that would make it more than 24h long, in which case clip to
 206   # 24h, as this has been decided is a reasonable time limit.
 207   def update_closed_at
 208     if open?
 209       self.closed_at = if (closed_at - created_at) > (MAX_TIME_OPEN - IDLE_TIMEOUT)
 210                          created_at + MAX_TIME_OPEN
 211                        else
 212                          Time.now.utc + IDLE_TIMEOUT
 213                        end
 214     end
 215   end
 216
 217   ##
 218   # update this instance from another instance given and the user who is
 219   # doing the updating. note that this method is not for updating the
 220   # bounding box, only the tags of the changeset.
 221   def update_from(other, user)
 222     # ensure that only the user who opened the changeset may modify it.
 223     raise OSM::APIUserChangesetMismatchError unless user.id == user_id
 224
 225     # can't change a closed changeset
 226     raise OSM::APIChangesetAlreadyClosedError, self unless open?
 227
 228     # copy the other's tags
 229     self.tags = other.tags
 230
 231     save_with_tags!
 232   end
 233
 234   def size_limit
 235     @size_limit ||= ActiveRecord::Base.connection.select_value(
 236       "SELECT api_size_limit($1)", "api_size_limit", [user_id]
 237     )
 238   end
 239
 240   def num_created_elements
 241     num_created_nodes + num_created_ways + num_created_relations
 242   end
 243
 244   def num_modified_elements
 245     num_modified_nodes + num_modified_ways + num_modified_relations
 246   end
 247
 248   def num_deleted_elements
 249     num_deleted_nodes + num_deleted_ways + num_deleted_relations
 250   end
 251
 252   def num_type_changes_in_sync?
 253     num_changes == num_created_elements + num_modified_elements + num_deleted_elements
 254   end
 255 end