app/controllers/api/changesets_controller.rb

   1 # The ChangesetController is the RESTful interface to Changeset objects
   2
   3 module Api
   4   class ChangesetsController < ApiController
   5     require "xml/libxml"
   6
   7     before_action :check_api_writable, :only => [:create, :update, :upload, :subscribe, :unsubscribe]
   8     before_action :check_api_readable, :except => [:create, :update, :upload, :download, :query, :subscribe, :unsubscribe]
   9     before_action :authorize, :only => [:create, :update, :upload, :close, :subscribe, :unsubscribe]
  10
  11     authorize_resource
  12
  13     before_action :require_public_data, :only => [:create, :update, :upload, :close, :subscribe, :unsubscribe]
  14     before_action :set_request_formats, :except => [:create, :close, :upload]
  15
  16     around_action :api_call_handle_error
  17     around_action :api_call_timeout, :except => [:upload]
  18
  19     # Helper methods for checking consistency
  20     include ConsistencyValidations
  21
  22     ##
  23     # Return XML giving the basic info about the changeset. Does not
  24     # return anything about the nodes, ways and relations in the changeset.
  25     def show
  26       @changeset = Changeset.find(params[:id])
  27       @include_discussion = params[:include_discussion].presence
  28       render "changeset"
  29
  30       respond_to do |format|
  31         format.xml
  32         format.json
  33       end
  34     end
  35
  36     # Create a changeset from XML.
  37     def create
  38       assert_method :put
  39
  40       cs = Changeset.from_xml(request.raw_post, :create => true)
  41
  42       # Assume that Changeset.from_xml has thrown an exception if there is an error parsing the xml
  43       cs.user = current_user
  44       cs.save_with_tags!
  45
  46       # Subscribe user to changeset comments
  47       cs.subscribers << current_user
  48
  49       render :plain => cs.id.to_s
  50     end
  51
  52     ##
  53     # marks a changeset as closed. this may be called multiple times
  54     # on the same changeset, so is idempotent.
  55     def close
  56       assert_method :put
  57
  58       changeset = Changeset.find(params[:id])
  59       check_changeset_consistency(changeset, current_user)
  60
  61       # to close the changeset, we'll just set its closed_at time to
  62       # now. this might not be enough if there are concurrency issues,
  63       # but we'll have to wait and see.
  64       changeset.set_closed_time_now
  65
  66       changeset.save!
  67       head :ok
  68     end
  69
  70     ##
  71     # Upload a diff in a single transaction.
  72     #
  73     # This means that each change within the diff must succeed, i.e: that
  74     # each version number mentioned is still current. Otherwise the entire
  75     # transaction *must* be rolled back.
  76     #
  77     # Furthermore, each element in the diff can only reference the current
  78     # changeset.
  79     #
  80     # Returns: a diffResult document, as described in
  81     # http://wiki.openstreetmap.org/wiki/OSM_Protocol_Version_0.6
  82     def upload
  83       # only allow POST requests, as the upload method is most definitely
  84       # not idempotent, as several uploads with placeholder IDs will have
  85       # different side-effects.
  86       # see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1.2
  87       assert_method :post
  88
  89       changeset = Changeset.find(params[:id])
  90       check_changeset_consistency(changeset, current_user)
  91
  92       diff_reader = DiffReader.new(request.raw_post, changeset)
  93       Changeset.transaction do
  94         result = diff_reader.commit
  95         render :xml => result.to_s
  96       end
  97     end
  98
  99     ##
 100     # download the changeset as an osmChange document.
 101     #
 102     # to make it easier to revert diffs it would be better if the osmChange
 103     # format were reversible, i.e: contained both old and new versions of
 104     # modified elements. but it doesn't at the moment...
 105     #
 106     # this method cannot order the database changes fully (i.e: timestamp and
 107     # version number may be too coarse) so the resulting diff may not apply
 108     # to a different database. however since changesets are not atomic this
 109     # behaviour cannot be guaranteed anyway and is the result of a design
 110     # choice.
 111     def download
 112       changeset = Changeset.find(params[:id])
 113
 114       # get all the elements in the changeset which haven't been redacted
 115       # and stick them in a big array.
 116       elements = [changeset.old_nodes.unredacted,
 117                   changeset.old_ways.unredacted,
 118                   changeset.old_relations.unredacted].flatten
 119
 120       # sort the elements by timestamp and version number, as this is the
 121       # almost sensible ordering available. this would be much nicer if
 122       # global (SVN-style) versioning were used - then that would be
 123       # unambiguous.
 124       elements.sort! do |a, b|
 125         if a.timestamp == b.timestamp
 126           a.version <=> b.version
 127         else
 128           a.timestamp <=> b.timestamp
 129         end
 130       end
 131
 132       # generate an output element for each operation. note: we avoid looking
 133       # at the history because it is simpler - but it would be more correct to
 134       # check these assertions.
 135       @created = []
 136       @modified = []
 137       @deleted = []
 138
 139       elements.each do |elt|
 140         if elt.version == 1
 141           # first version, so it must be newly-created.
 142           @created << elt
 143         elsif elt.visible
 144           # must be a modify
 145           @modified << elt
 146         else
 147           # if the element isn't visible then it must have been deleted
 148           @deleted << elt
 149         end
 150       end
 151
 152       respond_to do |format|
 153         format.xml
 154       end
 155     end
 156
 157     ##
 158     # query changesets by bounding box, time, user or open/closed status.
 159     def query
 160       # find any bounding box
 161       bbox = BoundingBox.from_bbox_params(params) if params["bbox"]
 162
 163       # create the conditions that the user asked for. some or all of
 164       # these may be nil.
 165       changesets = Changeset.all
 166       changesets = conditions_bbox(changesets, bbox)
 167       changesets = conditions_user(changesets, params["user"], params["display_name"])
 168       changesets = conditions_time(changesets, params["time"])
 169       changesets = conditions_open(changesets, params["open"])
 170       changesets = conditions_closed(changesets, params["closed"])
 171       changesets = conditions_ids(changesets, params["changesets"])
 172
 173       # sort and limit the changesets
 174       changesets = changesets.order("created_at DESC").limit(100)
 175
 176       # preload users, tags and comments, and render result
 177       @changesets = changesets.preload(:user, :changeset_tags, :comments)
 178       render "changesets"
 179
 180       respond_to do |format|
 181         format.xml
 182         format.json
 183       end
 184     end
 185
 186     ##
 187     # updates a changeset's tags. none of the changeset's attributes are
 188     # user-modifiable, so they will be ignored.
 189     #
 190     # changesets are not (yet?) versioned, so we don't have to deal with
 191     # history tables here. changesets are locked to a single user, however.
 192     #
 193     # after succesful update, returns the XML of the changeset.
 194     def update
 195       # request *must* be a PUT.
 196       assert_method :put
 197
 198       @changeset = Changeset.find(params[:id])
 199       new_changeset = Changeset.from_xml(request.raw_post)
 200
 201       check_changeset_consistency(@changeset, current_user)
 202       @changeset.update_from(new_changeset, current_user)
 203       render "changeset"
 204
 205       respond_to do |format|
 206         format.xml
 207         format.json
 208       end
 209     end
 210
 211     ##
 212     # Adds a subscriber to the changeset
 213     def subscribe
 214       # Check the arguments are sane
 215       raise OSM::APIBadUserInput, "No id was given" unless params[:id]
 216
 217       # Extract the arguments
 218       id = params[:id].to_i
 219
 220       # Find the changeset and check it is valid
 221       changeset = Changeset.find(id)
 222       raise OSM::APIChangesetAlreadySubscribedError, changeset if changeset.subscribers.exists?(current_user.id)
 223
 224       # Add the subscriber
 225       changeset.subscribers << current_user
 226
 227       # Return a copy of the updated changeset
 228       @changeset = changeset
 229       render "changeset"
 230
 231       respond_to do |format|
 232         format.xml
 233         format.json
 234       end
 235     end
 236
 237     ##
 238     # Removes a subscriber from the changeset
 239     def unsubscribe
 240       # Check the arguments are sane
 241       raise OSM::APIBadUserInput, "No id was given" unless params[:id]
 242
 243       # Extract the arguments
 244       id = params[:id].to_i
 245
 246       # Find the changeset and check it is valid
 247       changeset = Changeset.find(id)
 248       raise OSM::APIChangesetNotSubscribedError, changeset unless changeset.subscribers.exists?(current_user.id)
 249
 250       # Remove the subscriber
 251       changeset.subscribers.delete(current_user)
 252
 253       # Return a copy of the updated changeset
 254       @changeset = changeset
 255       render "changeset"
 256
 257       respond_to do |format|
 258         format.xml
 259         format.json
 260       end
 261     end
 262
 263     private
 264
 265     #------------------------------------------------------------
 266     # utility functions below.
 267     #------------------------------------------------------------
 268
 269     ##
 270     # if a bounding box was specified do some sanity checks.
 271     # restrict changesets to those enclosed by a bounding box
 272     # we need to return both the changesets and the bounding box
 273     def conditions_bbox(changesets, bbox)
 274       if bbox
 275         bbox.check_boundaries
 276         bbox = bbox.to_scaled
 277
 278         changesets.where("min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?",
 279                          bbox.max_lon.to_i, bbox.min_lon.to_i,
 280                          bbox.max_lat.to_i, bbox.min_lat.to_i)
 281       else
 282         changesets
 283       end
 284     end
 285
 286     ##
 287     # restrict changesets to those by a particular user
 288     def conditions_user(changesets, user, name)
 289       if user.nil? && name.nil?
 290         changesets
 291       else
 292         # shouldn't provide both name and UID
 293         raise OSM::APIBadUserInput, "provide either the user ID or display name, but not both" if user && name
 294
 295         # use either the name or the UID to find the user which we're selecting on.
 296         u = if name.nil?
 297               # user input checking, we don't have any UIDs < 1
 298               raise OSM::APIBadUserInput, "invalid user ID" if user.to_i < 1
 299
 300               u = User.find(user.to_i)
 301             else
 302               u = User.find_by(:display_name => name)
 303             end
 304
 305         # make sure we found a user
 306         raise OSM::APINotFoundError if u.nil?
 307
 308         # should be able to get changesets of public users only, or
 309         # our own changesets regardless of public-ness.
 310         unless u.data_public?
 311           # get optional user auth stuff so that users can see their own
 312           # changesets if they're non-public
 313           setup_user_auth
 314
 315           raise OSM::APINotFoundError if current_user.nil? || current_user != u
 316         end
 317
 318         changesets.where(:user_id => u.id)
 319       end
 320     end
 321
 322     ##
 323     # restrict changes to those closed during a particular time period
 324     def conditions_time(changesets, time)
 325       if time.nil?
 326         changesets
 327       elsif time.count(",") == 1
 328         # if there is a range, i.e: comma separated, then the first is
 329         # low, second is high - same as with bounding boxes.
 330
 331         # check that we actually have 2 elements in the array
 332         times = time.split(",")
 333         raise OSM::APIBadUserInput, "bad time range" if times.size != 2
 334
 335         from, to = times.collect { |t| Time.parse(t).utc }
 336         changesets.where("closed_at >= ? and created_at <= ?", from, to)
 337       else
 338         # if there is no comma, assume its a lower limit on time
 339         changesets.where("closed_at >= ?", Time.parse(time).utc)
 340       end
 341       # stupid Time seems to throw both of these for bad parsing, so
 342       # we have to catch both and ensure the correct code path is taken.
 343     rescue ArgumentError, RuntimeError => e
 344       raise OSM::APIBadUserInput, e.message.to_s
 345     end
 346
 347     ##
 348     # return changesets which are open (haven't been closed yet)
 349     # we do this by seeing if the 'closed at' time is in the future. Also if we've
 350     # hit the maximum number of changes then it counts as no longer open.
 351     # if parameter 'open' is nill then open and closed changesets are returned
 352     def conditions_open(changesets, open)
 353       if open.nil?
 354         changesets
 355       else
 356         changesets.where("closed_at >= ? and num_changes <= ?",
 357                          Time.now.utc, Changeset::MAX_ELEMENTS)
 358       end
 359     end
 360
 361     ##
 362     # query changesets which are closed
 363     # ('closed at' time has passed or changes limit is hit)
 364     def conditions_closed(changesets, closed)
 365       if closed.nil?
 366         changesets
 367       else
 368         changesets.where("closed_at < ? or num_changes > ?",
 369                          Time.now.utc, Changeset::MAX_ELEMENTS)
 370       end
 371     end
 372
 373     ##
 374     # query changesets by a list of ids
 375     # (either specified as array or comma-separated string)
 376     def conditions_ids(changesets, ids)
 377       if ids.nil?
 378         changesets
 379       elsif ids.empty?
 380         raise OSM::APIBadUserInput, "No changesets were given to search for"
 381       else
 382         ids = ids.split(",").collect(&:to_i)
 383         changesets.where(:id => ids)
 384       end
 385     end
 386   end
 387 end