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 the changesets
 174       changesets = if params[:order] == "oldest"
 175                      changesets.order(:closed_at => :asc)
 176                    else
 177                      changesets.order(:closed_at => :desc)
 178                    end
 179
 180       # limit the result
 181       changesets = changesets.limit(result_limit)
 182
 183       # preload users, tags and comments, and render result
 184       @changesets = changesets.preload(:user, :changeset_tags, :comments)
 185       render "changesets"
 186
 187       respond_to do |format|
 188         format.xml
 189         format.json
 190       end
 191     end
 192
 193     ##
 194     # updates a changeset's tags. none of the changeset's attributes are
 195     # user-modifiable, so they will be ignored.
 196     #
 197     # changesets are not (yet?) versioned, so we don't have to deal with
 198     # history tables here. changesets are locked to a single user, however.
 199     #
 200     # after succesful update, returns the XML of the changeset.
 201     def update
 202       # request *must* be a PUT.
 203       assert_method :put
 204
 205       @changeset = Changeset.find(params[:id])
 206       new_changeset = Changeset.from_xml(request.raw_post)
 207
 208       check_changeset_consistency(@changeset, current_user)
 209       @changeset.update_from(new_changeset, current_user)
 210       render "changeset"
 211
 212       respond_to do |format|
 213         format.xml
 214         format.json
 215       end
 216     end
 217
 218     ##
 219     # Adds a subscriber to the changeset
 220     def subscribe
 221       # Check the arguments are sane
 222       raise OSM::APIBadUserInput, "No id was given" unless params[:id]
 223
 224       # Extract the arguments
 225       id = params[:id].to_i
 226
 227       # Find the changeset and check it is valid
 228       changeset = Changeset.find(id)
 229       raise OSM::APIChangesetAlreadySubscribedError, changeset if changeset.subscribers.exists?(current_user.id)
 230
 231       # Add the subscriber
 232       changeset.subscribers << current_user
 233
 234       # Return a copy of the updated changeset
 235       @changeset = changeset
 236       render "changeset"
 237
 238       respond_to do |format|
 239         format.xml
 240         format.json
 241       end
 242     end
 243
 244     ##
 245     # Removes a subscriber from the changeset
 246     def unsubscribe
 247       # Check the arguments are sane
 248       raise OSM::APIBadUserInput, "No id was given" unless params[:id]
 249
 250       # Extract the arguments
 251       id = params[:id].to_i
 252
 253       # Find the changeset and check it is valid
 254       changeset = Changeset.find(id)
 255       raise OSM::APIChangesetNotSubscribedError, changeset unless changeset.subscribers.exists?(current_user.id)
 256
 257       # Remove the subscriber
 258       changeset.subscribers.delete(current_user)
 259
 260       # Return a copy of the updated changeset
 261       @changeset = changeset
 262       render "changeset"
 263
 264       respond_to do |format|
 265         format.xml
 266         format.json
 267       end
 268     end
 269
 270     private
 271
 272     #------------------------------------------------------------
 273     # utility functions below.
 274     #------------------------------------------------------------
 275
 276     ##
 277     # if a bounding box was specified do some sanity checks.
 278     # restrict changesets to those enclosed by a bounding box
 279     # we need to return both the changesets and the bounding box
 280     def conditions_bbox(changesets, bbox)
 281       if bbox
 282         bbox.check_boundaries
 283         bbox = bbox.to_scaled
 284
 285         changesets.where("min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?",
 286                          bbox.max_lon.to_i, bbox.min_lon.to_i,
 287                          bbox.max_lat.to_i, bbox.min_lat.to_i)
 288       else
 289         changesets
 290       end
 291     end
 292
 293     ##
 294     # restrict changesets to those by a particular user
 295     def conditions_user(changesets, user, name)
 296       if user.nil? && name.nil?
 297         changesets
 298       else
 299         # shouldn't provide both name and UID
 300         raise OSM::APIBadUserInput, "provide either the user ID or display name, but not both" if user && name
 301
 302         # use either the name or the UID to find the user which we're selecting on.
 303         u = if name.nil?
 304               # user input checking, we don't have any UIDs < 1
 305               raise OSM::APIBadUserInput, "invalid user ID" if user.to_i < 1
 306
 307               u = User.find(user.to_i)
 308             else
 309               u = User.find_by(:display_name => name)
 310             end
 311
 312         # make sure we found a user
 313         raise OSM::APINotFoundError if u.nil?
 314
 315         # should be able to get changesets of public users only, or
 316         # our own changesets regardless of public-ness.
 317         unless u.data_public?
 318           # get optional user auth stuff so that users can see their own
 319           # changesets if they're non-public
 320           setup_user_auth
 321
 322           raise OSM::APINotFoundError if current_user.nil? || current_user != u
 323         end
 324
 325         changesets.where(:user_id => u.id)
 326       end
 327     end
 328
 329     ##
 330     # restrict changes to those closed during a particular time period
 331     def conditions_time(changesets, time)
 332       if time.nil?
 333         changesets
 334       elsif time.count(",") == 1
 335         # if there is a range, i.e: comma separated, then the first is
 336         # low, second is high - same as with bounding boxes.
 337
 338         # check that we actually have 2 elements in the array
 339         times = time.split(",")
 340         raise OSM::APIBadUserInput, "bad time range" if times.size != 2
 341
 342         from, to = times.collect { |t| Time.parse(t).utc }
 343         changesets.where("closed_at >= ? and created_at <= ?", from, to)
 344       else
 345         # if there is no comma, assume its a lower limit on time
 346         changesets.where("closed_at >= ?", Time.parse(time).utc)
 347       end
 348       # stupid Time seems to throw both of these for bad parsing, so
 349       # we have to catch both and ensure the correct code path is taken.
 350     rescue ArgumentError, RuntimeError => e
 351       raise OSM::APIBadUserInput, e.message.to_s
 352     end
 353
 354     ##
 355     # return changesets which are open (haven't been closed yet)
 356     # we do this by seeing if the 'closed at' time is in the future. Also if we've
 357     # hit the maximum number of changes then it counts as no longer open.
 358     # if parameter 'open' is nill then open and closed changesets are returned
 359     def conditions_open(changesets, open)
 360       if open.nil?
 361         changesets
 362       else
 363         changesets.where("closed_at >= ? and num_changes <= ?",
 364                          Time.now.utc, Changeset::MAX_ELEMENTS)
 365       end
 366     end
 367
 368     ##
 369     # query changesets which are closed
 370     # ('closed at' time has passed or changes limit is hit)
 371     def conditions_closed(changesets, closed)
 372       if closed.nil?
 373         changesets
 374       else
 375         changesets.where("closed_at < ? or num_changes > ?",
 376                          Time.now.utc, Changeset::MAX_ELEMENTS)
 377       end
 378     end
 379
 380     ##
 381     # query changesets by a list of ids
 382     # (either specified as array or comma-separated string)
 383     def conditions_ids(changesets, ids)
 384       if ids.nil?
 385         changesets
 386       elsif ids.empty?
 387         raise OSM::APIBadUserInput, "No changesets were given to search for"
 388       else
 389         ids = ids.split(",").collect(&:to_i)
 390         changesets.where(:id => ids)
 391       end
 392     end
 393
 394     ##
 395     # Get the maximum number of results to return
 396     def result_limit
 397       if params[:limit]
 398         if params[:limit].to_i.positive? && params[:limit].to_i <= Settings.max_changeset_query_limit
 399           params[:limit].to_i
 400         else
 401           raise OSM::APIBadUserInput, "Changeset limit must be between 1 and #{Settings.max_changeset_query_limit}"
 402         end
 403       else
 404         Settings.default_changeset_query_limit
 405       end
 406     end
 407   end
 408 end