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