# 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]
+ session :off, :except => [:list, :list_user, :list_bbox]
+ before_filter :authorize_web, :only => [:list, :list_user, :list_bbox]
+ before_filter :authorize, :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
# Help methods for checking boundary sanity and area size
include MapBoundary
+ # Helper methods for checking consistency
+ include ConsistencyValidations
+
# Create a changeset from XML.
def create
if request.put?
end
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])
end
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])
+ unless request.put?
+ render :nothing => true, :status => :method_not_allowed
+ return
+ end
+
+ 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
+ rescue ActiveRecord::RecordNotFound
+ render :nothing => true, :status => :not_found
+ rescue OSM::APIError => ex
+ render ex.render_opts
end
##
# 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
+ check_changeset_consistency(cs, @user)
# keep an array of lons and lats
lon = Array.new
# 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
+ lon << n['lon'].to_f * GeoRecord::SCALE
+ lat << n['lat'].to_f * GeoRecord::SCALE
end
# add the existing bounding box to the lon-lat array
render :nothing => true, :status => :method_not_allowed
end
+ rescue LibXML::XML::Error, ArgumentError => ex
+ raise OSM::APIBadXMLError.new("osm", xml, ex.message)
rescue ActiveRecord::RecordNotFound
render :nothing => true, :status => :not_found
rescue OSM::APIError => ex
end
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
# 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'])
+ 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
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
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.
+ unless request.put?
+ render :nothing => true, :status => :method_not_allowed
+ return
+ end
+
+ changeset = Changeset.find(params[:id])
+ new_changeset = Changeset.from_xml(request.raw_post)
+
+ 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
+
+ rescue ActiveRecord::RecordNotFound
+ render :nothing => true, :status => :not_found
+ rescue OSM::APIError => ex
+ render ex.render_opts
+ end
+
+
+
+ ##
+ # list edits (open changesets) in reverse chronological order
+ def list
+ conditions = conditions_nonempty
+
+
+ # @changesets = Changeset.find(:all, :order => "closed_at DESC", :conditions => ['closed_at < ?', DateTime.now], :limit=> 20)
+
+
+ #@edit_pages, @edits = paginate(:changesets,
+ # :include => [:user, :changeset_tags],
+ # :conditions => conditions,
+ # :order => "changesets.created_at DESC",
+ # :per_page => 20)
+ #
+
+ @edits = Changeset.find(:all,
+ :order => "changesets.created_at DESC",
+ :conditions => conditions,
+ :limit => 20)
+
+ end
+
+ ##
+ # list edits (changesets) belonging to a user
+ def list_user
+ user = User.find_by_display_name(params[:display_name], :conditions => {:visible => true})
+
+ if user
+ @display_name = user.display_name
+ if not user.data_public? and @user != user
+ @edits = nil
+ render
+ else
+ conditions = cond_merge conditions, ['user_id = ?', user.id]
+ conditions = cond_merge conditions, conditions_nonempty
+ @edit_pages, @edits = paginate(:changesets,
+ :include => [:user, :changeset_tags],
+ :conditions => conditions,
+ :order => "changesets.created_at DESC",
+ :per_page => 20)
+ end
+ else
+ @not_found_user = params[:display_name]
+ render :template => 'user/no_such_user', :status => :not_found
+ end
+ end
+
+ ##
+ # list changesets in a bbox
+ def list_bbox
+ # support 'bbox' param or alternatively 'minlon', 'minlat' etc
+ if params['bbox']
+ bbox = params['bbox']
+ elsif params['minlon'] and params['minlat'] and params['maxlon'] and params['maxlat']
+ bbox = h(params['minlon']) + ',' + h(params['minlat']) + ',' + h(params['maxlon']) + ',' + h(params['maxlat'])
+ else
+ #TODO: fix bugs in location determination for history tab (and other tabs) then uncomment this redirect
+ #redirect_to :action => 'list'
+ end
+
+ conditions = conditions_bbox(bbox);
+ conditions = cond_merge conditions, conditions_nonempty
+
+ @edit_pages, @edits = paginate(:changesets,
+ :include => [:user, :changeset_tags],
+ :conditions => conditions,
+ :order => "changesets.created_at DESC",
+ :per_page => 20)
+
+ @bbox = sanitise_boundaries(bbox.split(/,/)) unless bbox==nil
+ end
+
+private
+ #------------------------------------------------------------
+ # utility functions below.
+ #------------------------------------------------------------
##
# merge two conditions
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
# 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
# restrict changesets to those by a particular user
def conditions_user(user)
unless user.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)
- raise OSM::APINotFoundError unless u.data_public?
+ # 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
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 < ? and 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
projects / rails.git / blobdiff