app/controllers/api/changesets_controller.rb

   1 # frozen_string_literal: true
   2
   3 # The ChangesetController is the RESTful interface to Changeset objects
   4
   5 module Api
   6   class ChangesetsController < ApiController
   7     include QueryMethods
   8
   9     before_action :check_api_writable, :only => [:create, :update]
  10     before_action :setup_user_auth, :only => [:show]
  11     before_action :authorize, :only => [:create, :update]
  12
  13     authorize_resource
  14
  15     before_action :require_public_data, :only => [:create, :update]
  16     before_action :set_request_formats, :except => [:create]
  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?(:create, :changeset_comment_visibility)
  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.subscribers << current_user
  86
  87       render :plain => cs.id.to_s
  88     end
  89
  90     ##
  91     # updates a changeset's tags. none of the changeset's attributes are
  92     # user-modifiable, so they will be ignored.
  93     #
  94     # changesets are not (yet?) versioned, so we don't have to deal with
  95     # history tables here. changesets are locked to a single user, however.
  96     #
  97     # after succesful update, returns the XML of the changeset.
  98     def update
  99       @changeset = Changeset.find(params[:id])
 100       new_changeset = Changeset.from_xml(request.raw_post)
 101
 102       check_changeset_consistency(@changeset, current_user)
 103       @changeset.update_from(new_changeset, current_user)
 104       render "show"
 105
 106       respond_to do |format|
 107         format.xml
 108         format.json
 109       end
 110     end
 111
 112     private
 113
 114     #------------------------------------------------------------
 115     # utility functions below.
 116     #------------------------------------------------------------
 117
 118     ##
 119     # if a bounding box was specified do some sanity checks.
 120     # restrict changesets to those enclosed by a bounding box
 121     def conditions_bbox(changesets, bbox)
 122       if bbox
 123         bbox.check_boundaries
 124         bbox = bbox.to_scaled
 125
 126         changesets.where("min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?",
 127                          bbox.max_lon.to_i, bbox.min_lon.to_i,
 128                          bbox.max_lat.to_i, bbox.min_lat.to_i)
 129       else
 130         changesets
 131       end
 132     end
 133
 134     ##
 135     # restrict changesets to those by a particular user
 136     def conditions_user(changesets, user, name)
 137       if user.nil? && name.nil?
 138         changesets
 139       else
 140         # shouldn't provide both name and UID
 141         raise OSM::APIBadUserInput, "provide either the user ID or display name, but not both" if user && name
 142
 143         # use either the name or the UID to find the user which we're selecting on.
 144         u = if name.nil?
 145               # user input checking, we don't have any UIDs < 1
 146               raise OSM::APIBadUserInput, "invalid user ID" if user.to_i < 1
 147
 148               u = User.find_by(:id => user.to_i)
 149             else
 150               u = User.find_by(:display_name => name)
 151             end
 152
 153         # make sure we found a user
 154         raise OSM::APINotFoundError if u.nil?
 155
 156         # should be able to get changesets of public users only, or
 157         # our own changesets regardless of public-ness.
 158         unless u.data_public?
 159           # get optional user auth stuff so that users can see their own
 160           # changesets if they're non-public
 161           setup_user_auth
 162
 163           raise OSM::APINotFoundError if current_user.nil? || current_user != u
 164         end
 165
 166         changesets.where(:user => u)
 167       end
 168     end
 169
 170     ##
 171     # restrict changesets to those during a particular time period
 172     def conditions_time(changesets, time)
 173       if time.nil?
 174         changesets
 175       elsif time.count(",") == 1
 176         # if there is a range, i.e: comma separated, then the first is
 177         # low, second is high - same as with bounding boxes.
 178
 179         # check that we actually have 2 elements in the array
 180         times = time.split(",")
 181         raise OSM::APIBadUserInput, "bad time range" if times.size != 2
 182
 183         from, to = times.collect { |t| Time.parse(t).utc }
 184         changesets.where("closed_at >= ? and created_at <= ?", from, to)
 185       else
 186         # if there is no comma, assume its a lower limit on time
 187         changesets.where(:closed_at => Time.parse(time).utc..)
 188       end
 189       # stupid Time seems to throw both of these for bad parsing, so
 190       # we have to catch both and ensure the correct code path is taken.
 191     rescue ArgumentError, RuntimeError => e
 192       raise OSM::APIBadUserInput, e.message.to_s
 193     end
 194
 195     ##
 196     # return changesets which are open (haven't been closed yet)
 197     # we do this by seeing if the 'closed at' time is in the future. Also if we've
 198     # hit the maximum number of changes then it counts as no longer open.
 199     # if parameter 'open' is nill then open and closed changesets are returned
 200     def conditions_open(changesets, open)
 201       if open.nil?
 202         changesets
 203       else
 204         changesets.where("closed_at >= ? and num_changes <= ?",
 205                          Time.now.utc, Changeset::MAX_ELEMENTS)
 206       end
 207     end
 208
 209     ##
 210     # query changesets which are closed
 211     # ('closed at' time has passed or changes limit is hit)
 212     def conditions_closed(changesets, closed)
 213       if closed.nil?
 214         changesets
 215       else
 216         changesets.where("closed_at < ? or num_changes > ?",
 217                          Time.now.utc, Changeset::MAX_ELEMENTS)
 218       end
 219     end
 220
 221     ##
 222     # query changesets by a list of ids
 223     # (either specified as array or comma-separated string)
 224     def conditions_ids(changesets, ids)
 225       if ids.nil?
 226         changesets
 227       elsif ids.empty?
 228         raise OSM::APIBadUserInput, "No changesets were given to search for"
 229       else
 230         ids = ids.split(",").collect(&:to_i)
 231         changesets.where(:id => ids)
 232       end
 233     end
 234   end
 235 end