X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/b875d14b7cd13432b0683ca548b341dcd8bddf80..ebd109c946d71b3ccc616ea3966e56ae019638d7:/app/controllers/changeset_controller.rb diff --git a/app/controllers/changeset_controller.rb b/app/controllers/changeset_controller.rb index 29b5ef83e..d0a357c85 100644 --- a/app/controllers/changeset_controller.rb +++ b/app/controllers/changeset_controller.rb @@ -1,62 +1,63 @@ # The ChangesetController is the RESTful interface to Changeset objects class ChangesetController < ApplicationController + layout 'site' require 'xml/libxml' - require 'diff_reader' - before_filter :authorize, :only => [:create, :update, :delete, :upload, :include] - before_filter :check_write_availability, :only => [:create, :update, :delete, :upload, :include] - before_filter :check_read_availability, :except => [:create, :update, :delete, :upload, :download, :query] + before_filter :authorize_web, :only => [:list, :list_user, :list_bbox] + before_filter :set_locale, :only => [:list, :list_user, :list_bbox] + before_filter :authorize, :only => [:create, :update, :delete, :upload, :include, :close] + before_filter :require_allow_write_api, :only => [:create, :update, :delete, :upload, :include, :close] + before_filter :require_public_data, :only => [:create, :update, :delete, :upload, :include, :close] + before_filter :check_api_writable, :only => [:create, :update, :delete, :upload, :include] + before_filter :check_api_readable, :except => [:create, :update, :delete, :upload, :download, :query] after_filter :compress_output + around_filter :api_call_handle_error + + filter_parameter_logging " cs.id.to_s, :content_type => "text/plain" - else - render :nothing => true, :status => :bad_request - end - else - render :nothing => true, :status => :method_not_allowed - end + cs = Changeset.from_xml(request.raw_post, true) + + # Assume that Changeset.from_xml has thrown an exception if there is an error parsing the xml + cs.user_id = @user.id + cs.save_with_tags! + render :text => cs.id.to_s, :content_type => "text/plain" end + ## + # Return XML giving the basic info about the changeset. Does not + # return anything about the nodes, ways and relations in the changeset. def read - begin - changeset = Changeset.find(params[:id]) - render :text => changeset.to_xml.to_s, :content_type => "text/xml" - rescue ActiveRecord::RecordNotFound - render :nothing => true, :status => :not_found - end + changeset = Changeset.find(params[:id]) + render :text => changeset.to_xml.to_s, :content_type => "text/xml" end + ## + # marks a changeset as closed. this may be called multiple times + # on the same changeset, so is idempotent. def close - begin - unless request.put? - render :nothing => true, :status => :method_not_allowed - return - end - - changeset = Changeset.find(params[:id]) + assert_method :put + + changeset = Changeset.find(params[:id]) + check_changeset_consistency(changeset, @user) - unless @user.id == changeset.user_id - raise OSM::APIUserChangesetMismatchError - end + # to close the changeset, we'll just set its closed_at time to + # now. this might not be enough if there are concurrency issues, + # but we'll have to wait and see. + changeset.set_closed_time_now - changeset.open = false - changeset.save! - render :nothing => true - rescue ActiveRecord::RecordNotFound - render :nothing => true, :status => :not_found - end + changeset.save! + render :nothing => true end ## @@ -64,53 +65,40 @@ class ChangesetController < ApplicationController # increase the size of the bounding box. this is a hint that clients can # set either before uploading a large number of changes, or changes that # the client (but not the server) knows will affect areas further away. - def include + def expand_bbox # only allow POST requests, because although this method is # idempotent, there is no "document" to PUT really... - if request.post? - cs = Changeset.find(params[:id]) - - # check user credentials - only the user who opened a changeset - # may alter it. - unless @user.id == cs.user_id - raise OSM::APIUserChangesetMismatchError - end + assert_method :post - # keep an array of lons and lats - lon = Array.new - lat = Array.new - - # the request is in pseudo-osm format... this is kind-of an - # abuse, maybe should change to some other format? - doc = XML::Parser.string(request.raw_post).parse - doc.find("//osm/node").each do |n| - lon << n['lon'].to_f * SCALE - lat << n['lat'].to_f * SCALE - end - - # add the existing bounding box to the lon-lat array - lon << cs.min_lon unless cs.min_lon.nil? - lat << cs.min_lat unless cs.min_lat.nil? - lon << cs.max_lon unless cs.max_lon.nil? - lat << cs.max_lat unless cs.max_lat.nil? - - # collapse the arrays to minimum and maximum - cs.min_lon, cs.min_lat, cs.max_lon, cs.max_lat = - lon.min, lat.min, lon.max, lat.max - - # save the larger bounding box and return the changeset, which - # will include the bigger bounding box. - cs.save! - render :text => cs.to_xml.to_s, :content_type => "text/xml" - - else - render :nothing => true, :status => :method_not_allowed + cs = Changeset.find(params[:id]) + check_changeset_consistency(cs, @user) + + # keep an array of lons and lats + lon = Array.new + lat = Array.new + + # the request is in pseudo-osm format... this is kind-of an + # abuse, maybe should change to some other format? + doc = XML::Parser.string(request.raw_post).parse + doc.find("//osm/node").each do |n| + lon << n['lon'].to_f * GeoRecord::SCALE + lat << n['lat'].to_f * GeoRecord::SCALE end - - rescue ActiveRecord::RecordNotFound - render :nothing => true, :status => :not_found - rescue OSM::APIError => ex - render ex.render_opts + + # add the existing bounding box to the lon-lat array + lon << cs.min_lon unless cs.min_lon.nil? + lat << cs.min_lat unless cs.min_lat.nil? + lon << cs.max_lon unless cs.max_lon.nil? + lat << cs.max_lat unless cs.max_lat.nil? + + # collapse the arrays to minimum and maximum + cs.min_lon, cs.min_lat, cs.max_lon, cs.max_lat = + lon.min, lat.min, lon.max, lat.max + + # save the larger bounding box and return the changeset, which + # will include the bigger bounding box. + cs.save! + render :text => cs.to_xml.to_s, :content_type => "text/xml" end ## @@ -124,35 +112,22 @@ class ChangesetController < ApplicationController # changeset. # # Returns: a diffResult document, as described in - # http://wiki.openstreetmap.org/index.php/OSM_Protocol_Version_0.6 + # http://wiki.openstreetmap.org/wiki/OSM_Protocol_Version_0.6 def upload # only allow POST requests, as the upload method is most definitely # not idempotent, as several uploads with placeholder IDs will have # different side-effects. # see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1.2 - unless request.post? - render :nothing => true, :status => :method_not_allowed - return - end + assert_method :post changeset = Changeset.find(params[:id]) - - # access control - only the user who created a changeset may - # upload to it. - unless @user.id == changeset.user_id - raise OSM::APIUserChangesetMismatchError - end + check_changeset_consistency(changeset, @user) diff_reader = DiffReader.new(request.raw_post, changeset) Changeset.transaction do result = diff_reader.commit render :text => result.to_s, :content_type => "text/xml" end - - rescue ActiveRecord::RecordNotFound - render :nothing => true, :status => :not_found - rescue OSM::APIError => ex - render ex.render_opts end ## @@ -220,11 +195,6 @@ class ChangesetController < ApplicationController end render :text => result.to_s, :content_type => "text/xml" - - rescue ActiveRecord::RecordNotFound - render :nothing => true, :status => :not_found - rescue OSM::APIError => ex - render ex.render_opts end ## @@ -233,9 +203,10 @@ class ChangesetController < ApplicationController # create the conditions that the user asked for. some or all of # these may be nil. conditions = conditions_bbox(params['bbox']) - cond_merge conditions, conditions_user(params['user']) - cond_merge conditions, conditions_time(params['time']) - cond_merge conditions, conditions_open(params['open']) + conditions = cond_merge conditions, conditions_user(params['user'], params['display_name']) + conditions = cond_merge conditions, conditions_time(params['time']) + conditions = cond_merge conditions, conditions_open(params['open']) + conditions = cond_merge conditions, conditions_closed(params['closed']) # create the results document results = OSM::API.new.get_xml_doc @@ -249,22 +220,113 @@ class ChangesetController < ApplicationController end render :text => results.to_s, :content_type => "text/xml" + end + + ## + # updates a changeset's tags. none of the changeset's attributes are + # user-modifiable, so they will be ignored. + # + # changesets are not (yet?) versioned, so we don't have to deal with + # history tables here. changesets are locked to a single user, however. + # + # after succesful update, returns the XML of the changeset. + def update + # request *must* be a PUT. + assert_method :put + + changeset = Changeset.find(params[:id]) + new_changeset = Changeset.from_xml(request.raw_post) - rescue ActiveRecord::RecordNotFound - render :nothing => true, :status => :not_found - rescue OSM::APIError => ex - render ex.render_opts - rescue String => s - render :text => s, :content_type => "text/plain", :status => :bad_request + unless new_changeset.nil? + check_changeset_consistency(changeset, @user) + changeset.update_from(new_changeset, @user) + render :text => changeset.to_xml, :mime_type => "text/xml" + else + + render :nothing => true, :status => :bad_request + end end + + + ## + # list edits (open changesets) in reverse chronological order + def list + conditions = conditions_nonempty + + if params[:display_name] + user = User.find_by_display_name(params[:display_name], :conditions => { :status => ["active", "confirmed"] }) + + if user + if user.data_public? or user == @user + conditions = cond_merge conditions, ['user_id = ?', user.id] + else + conditions = cond_merge conditions, ['false'] + end + elsif request.format == :html + @title = t 'user.no_such_user.title' + @not_found_user = params[:display_name] + render :template => 'user/no_such_user', :status => :not_found + end + end + + if params[:bbox] + bbox = params[:bbox] + elsif params[:minlon] and params[:minlat] and params[:maxlon] and params[:maxlat] + bbox = params[:minlon] + ',' + params[:minlat] + ',' + params[:maxlon] + ',' + params[:maxlat] + end + + if bbox + conditions = cond_merge conditions, conditions_bbox(bbox) + bbox = BoundingBox.from_s(bbox) + bbox_link = render_to_string :partial => "bbox", :object => bbox + end + + if user + user_link = render_to_string :partial => "user", :object => user + end + + if user and bbox + @title = t 'changeset.list.title_user_bbox', :user => user.display_name, :bbox => bbox.to_s + @heading = t 'changeset.list.heading_user_bbox', :user => user.display_name, :bbox => bbox.to_s + @description = t 'changeset.list.description_user_bbox', :user => user_link, :bbox => bbox_link + elsif user + @title = t 'changeset.list.title_user', :user => user.display_name + @heading = t 'changeset.list.heading_user', :user => user.display_name + @description = t 'changeset.list.description_user', :user => user_link + elsif bbox + @title = t 'changeset.list.title_bbox', :bbox => bbox.to_s + @heading = t 'changeset.list.heading_bbox', :bbox => bbox.to_s + @description = t 'changeset.list.description_bbox', :bbox => bbox_link + else + @title = t 'changeset.list.title' + @heading = t 'changeset.list.heading' + @description = t 'changeset.list.description' + end + + @page = (params[:page] || 1).to_i + @page_size = 20 + + @edits = Changeset.find(:all, + :include => [:user, :changeset_tags], + :conditions => conditions, + :order => "changesets.created_at DESC", + :offset => (@page - 1) * @page_size, + :limit => @page_size) + end + +private + #------------------------------------------------------------ + # utility functions below. + #------------------------------------------------------------ + ## # merge two conditions def cond_merge(a, b) if a and b a_str = a.shift b_str = b.shift - return [ a_str + " and " + b_str ] + a + b + return [ a_str + " AND " + b_str ] + a + b elsif a return a else b @@ -278,12 +340,12 @@ class ChangesetController < ApplicationController # area restriction. def conditions_bbox(bbox) unless bbox.nil? - raise "Bounding box should be min_lon,min_lat,max_lon,max_lat" unless bbox.count(',') == 3 + raise OSM::APIBadUserInput.new("Bounding box should be min_lon,min_lat,max_lon,max_lat") unless bbox.count(',') == 3 bbox = sanitise_boundaries(bbox.split(/,/)) - raise "Minimum longitude should be less than maximum." unless bbox[0] <= bbox[2] - raise "Minimum latitude should be less than maximum." unless bbox[1] <= bbox[3] + raise OSM::APIBadUserInput.new("Minimum longitude should be less than maximum.") unless bbox[0] <= bbox[2] + raise OSM::APIBadUserInput.new("Minimum latitude should be less than maximum.") unless bbox[1] <= bbox[3] return ['min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?', - bbox[2] * SCALE, bbox[0] * SCALE, bbox[3]* SCALE, bbox[1] * SCALE] + bbox[2] * GeoRecord::SCALE, bbox[0] * GeoRecord::SCALE, bbox[3]* GeoRecord::SCALE, bbox[1] * GeoRecord::SCALE] else return nil end @@ -291,10 +353,32 @@ class ChangesetController < ApplicationController ## # restrict changesets to those by a particular user - def conditions_user(user) - unless user.nil? - u = User.find(user.to_i) - raise OSM::APINotFoundError unless u.data_public? + def conditions_user(user, name) + unless user.nil? and name.nil? + # shouldn't provide both name and UID + raise OSM::APIBadUserInput.new("provide either the user ID or display name, but not both") if user and name + + # use either the name or the UID to find the user which we're selecting on. + u = if name.nil? + # user input checking, we don't have any UIDs < 1 + raise OSM::APIBadUserInput.new("invalid user ID") if user.to_i < 1 + u = User.find(user.to_i) + else + u = User.find_by_display_name(name) + end + + # make sure we found a user + raise OSM::APINotFoundError.new if u.nil? + + # should be able to get changesets of public users only, or + # our own changesets regardless of public-ness. + unless u.data_public? + # get optional user auth stuff so that users can see their own + # changesets if they're non-public + setup_user_auth + + raise OSM::APINotFoundError if @user.nil? or @user.id != u.id + end return ['user_id = ?', u.id] else return nil @@ -302,29 +386,56 @@ class ChangesetController < ApplicationController end ## - # restrict changes to those during a particular time period + # restrict changes to those closed during a particular time period def conditions_time(time) unless time.nil? # if there is a range, i.e: comma separated, then the first is # low, second is high - same as with bounding boxes. if time.count(',') == 1 - from, to = time.split(/,/).collect { |t| Date.parse(t) } - return ['created_at > ? and created_at < ?', from, to] + # check that we actually have 2 elements in the array + times = time.split(/,/) + raise OSM::APIBadUserInput.new("bad time range") if times.size != 2 + + from, to = times.collect { |t| DateTime.parse(t) } + return ['closed_at >= ? and created_at <= ?', from, to] else # if there is no comma, assume its a lower limit on time - return ['created_at > ?', Date.parse(time)] + return ['closed_at >= ?', DateTime.parse(time)] end else return nil end + # stupid DateTime seems to throw both of these for bad parsing, so + # we have to catch both and ensure the correct code path is taken. rescue ArgumentError => ex - raise ex.message.to_s + raise OSM::APIBadUserInput.new(ex.message.to_s) + rescue RuntimeError => ex + raise OSM::APIBadUserInput.new(ex.message.to_s) end ## - # restrict changes to those which are open + # return changesets which are open (haven't been closed yet) + # we do this by seeing if the 'closed at' time is in the future. Also if we've + # hit the maximum number of changes then it counts as no longer open. + # if parameter 'open' is nill then open and closed changsets are returned def conditions_open(open) - return open.nil? ? nil : ['open = ?', true] + return open.nil? ? nil : ['closed_at >= ? and num_changes <= ?', + Time.now.getutc, Changeset::MAX_ELEMENTS] + end + + ## + # query changesets which are closed + # ('closed at' time has passed or changes limit is hit) + def conditions_closed(closed) + return closed.nil? ? nil : ['closed_at < ? or num_changes > ?', + Time.now.getutc, Changeset::MAX_ELEMENTS] end + ## + # eliminate empty changesets (where the bbox has not been set) + # this should be applied to all changeset list displays + def conditions_nonempty() + return ['min_lat IS NOT NULL'] + end + end