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