X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/a56d1036d58d45777d6adeffd5a950519bc70318..aa1fb6dbb8c2e71b8ce8c231ae1272a2dfebd75a:/app/controllers/changeset_controller.rb diff --git a/app/controllers/changeset_controller.rb b/app/controllers/changeset_controller.rb index 89d244907..898afae4a 100644 --- a/app/controllers/changeset_controller.rb +++ b/app/controllers/changeset_controller.rb @@ -1,21 +1,22 @@ # The ChangesetController is the RESTful interface to Changeset objects class ChangesetController < ApplicationController - layout 'site' - require 'xml/libxml' - - skip_before_filter :verify_authenticity_token, :except => [:list] - before_filter :authorize_web, :only => [:list, :feed] - before_filter :set_locale, :only => [:list, :feed] - 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, :list, :feed] - before_filter(:only => [:list, :feed]) { |c| c.check_database_readable(true) } - after_filter :compress_output - around_filter :api_call_handle_error, :except => [:list, :feed] - around_filter :web_timeout, :only => [:list, :feed] + layout "site" + require "xml/libxml" + + skip_before_action :verify_authenticity_token, :except => [:list] + before_action :authorize_web, :only => [:list, :feed, :comments_feed] + before_action :set_locale, :only => [:list, :feed, :comments_feed] + before_action :authorize, :only => [:create, :update, :delete, :upload, :include, :close, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment] + before_action :require_moderator, :only => [:hide_comment, :unhide_comment] + before_action :require_allow_write_api, :only => [:create, :update, :delete, :upload, :include, :close, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment] + before_action :require_public_data, :only => [:create, :update, :delete, :upload, :include, :close, :comment, :subscribe, :unsubscribe] + before_action :check_api_writable, :only => [:create, :update, :delete, :upload, :include, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment] + before_action :check_api_readable, :except => [:create, :update, :delete, :upload, :download, :query, :list, :feed, :comment, :subscribe, :unsubscribe, :comments_feed] + before_action(:only => [:list, :feed, :comments_feed]) { |c| c.check_database_readable(true) } + around_action :api_call_handle_error, :except => [:list, :feed, :comments_feed] + around_action :api_call_timeout, :except => [:list, :feed, :comments_feed, :upload] + around_action :web_timeout, :only => [:list, :feed, :comments_feed] # Helper methods for checking consistency include ConsistencyValidations @@ -27,9 +28,13 @@ class ChangesetController < ApplicationController 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.user = current_user cs.save_with_tags! - render :text => cs.id.to_s, :content_type => "text/plain" + + # Subscribe user to changeset comments + cs.subscribers << current_user + + render :plain => cs.id.to_s end ## @@ -37,7 +42,8 @@ class ChangesetController < ApplicationController # return anything about the nodes, ways and relations in the changeset. def read changeset = Changeset.find(params[:id]) - render :text => changeset.to_xml.to_s, :content_type => "text/xml" + + render :xml => changeset.to_xml(params[:include_discussion].presence).to_s end ## @@ -47,7 +53,7 @@ class ChangesetController < ApplicationController assert_method :put changeset = Changeset.find(params[:id]) - check_changeset_consistency(changeset, @user) + check_changeset_consistency(changeset, current_user) # to close the changeset, we'll just set its closed_at time to # now. this might not be enough if there are concurrency issues, @@ -55,7 +61,7 @@ class ChangesetController < ApplicationController changeset.set_closed_time_now changeset.save! - render :text => "" + head :ok end ## @@ -69,18 +75,18 @@ class ChangesetController < ApplicationController assert_method :post cs = Changeset.find(params[:id]) - check_changeset_consistency(cs, @user) + check_changeset_consistency(cs, current_user) # keep an array of lons and lats - lon = Array.new - lat = Array.new + lon = [] + lat = [] # 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 = XML::Parser.string(request.raw_post, :options => XML::Parser::Options::NOERROR).parse doc.find("//osm/node").each do |n| - lon << n['lon'].to_f * GeoRecord::SCALE - lat << n['lat'].to_f * GeoRecord::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 @@ -90,13 +96,15 @@ class ChangesetController < ApplicationController 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 + cs.min_lon = lon.min + cs.min_lat = lat.min + cs.max_lon = lon.max + cs.max_lat = 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" + render :xml => cs.to_xml.to_s end ## @@ -119,12 +127,12 @@ class ChangesetController < ApplicationController assert_method :post changeset = Changeset.find(params[:id]) - check_changeset_consistency(changeset, @user) + check_changeset_consistency(changeset, current_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" + render :xml => result.to_s end end @@ -154,7 +162,7 @@ class ChangesetController < ApplicationController # global (SVN-style) versioning were used - then that would be # unambiguous. elements.sort! do |a, b| - if (a.timestamp == b.timestamp) + if a.timestamp == b.timestamp a.version <=> b.version else a.timestamp <=> b.timestamp @@ -174,42 +182,39 @@ class ChangesetController < ApplicationController # check these assertions. elements.each do |elt| result.root << - if (elt.version == 1) + if elt.version == 1 # first version, so it must be newly-created. created = XML::Node.new "create" created << elt.to_xml_node(changeset_cache, user_display_name_cache) + elsif elt.visible + # must be a modify + modified = XML::Node.new "modify" + modified << elt.to_xml_node(changeset_cache, user_display_name_cache) else - unless elt.visible - # if the element isn't visible then it must have been deleted - deleted = XML::Node.new "delete" - deleted << elt.to_xml_node(changeset_cache, user_display_name_cache) - else - # must be a modify - modified = XML::Node.new "modify" - modified << elt.to_xml_node(changeset_cache, user_display_name_cache) - end + # if the element isn't visible then it must have been deleted + deleted = XML::Node.new "delete" + deleted << elt.to_xml_node(changeset_cache, user_display_name_cache) end end - render :text => result.to_s, :content_type => "text/xml" + render :xml => result.to_s end ## # query changesets by bounding box, time, user or open/closed status. def query # find any bounding box - if params['bbox'] - bbox = BoundingBox.from_bbox_params(params) - end + bbox = BoundingBox.from_bbox_params(params) if params["bbox"] # create the conditions that the user asked for. some or all of # these may be nil. changesets = Changeset.all changesets = conditions_bbox(changesets, bbox) - changesets = conditions_user(changesets, params['user'], params['display_name']) - changesets = conditions_time(changesets, params['time']) - changesets = conditions_open(changesets, params['open']) - changesets = conditions_closed(changesets, params['closed']) + changesets = conditions_user(changesets, params["user"], params["display_name"]) + changesets = conditions_time(changesets, params["time"]) + changesets = conditions_open(changesets, params["open"]) + changesets = conditions_closed(changesets, params["closed"]) + changesets = conditions_ids(changesets, params["changesets"]) # create the results document results = OSM::API.new.get_xml_doc @@ -219,7 +224,7 @@ class ChangesetController < ApplicationController results.root << cs.to_xml_node end - render :text => results.to_s, :content_type => "text/xml" + render :xml => results.to_s end ## @@ -237,91 +242,61 @@ class ChangesetController < ApplicationController 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 :text => "", :status => :bad_request - end + check_changeset_consistency(changeset, current_user) + changeset.update_from(new_changeset, current_user) + render :xml => changeset.to_xml.to_s end ## - # list edits (open changesets) in reverse chronological order + # list non-empty changesets in reverse chronological order def list - if request.format == :atom and params[:page] - redirect_to params.merge({ :page => nil }), :status => :moved_permanently - else - changesets = conditions_nonempty(Changeset.all) - - if params[:display_name] - user = User.find_by_display_name(params[:display_name]) + @params = params.permit(:display_name, :bbox, :friends, :nearby, :max_id, :list) - if user and user.active? - if user.data_public? or user == @user - changesets = changesets.where(:user_id => user.id) - else - changesets = changesets.where("false") - end - else - render_unknown_user params[:display_name] - return - end - end - - if params[:friends] - if @user - changesets = changesets.where(:user_id => @user.friend_users.public) - elsif request.format == :html - require_user - return - end - end + if request.format == :atom && @params[:max_id] + redirect_to url_for(@params.merge(:max_id => nil)), :status => :moved_permanently + return + end - if params[:nearby] - if @user - changesets = changesets.where(:user_id => @user.nearby) - elsif request.format == :html - require_user - return - end + if @params[:display_name] + user = User.find_by(:display_name => @params[:display_name]) + if !user || !user.active? + render_unknown_user @params[:display_name] + return end + end - if params[:bbox] - bbox = BoundingBox.from_bbox_params(params) - elsif params[:minlon] and params[:minlat] and params[:maxlon] and params[:maxlat] - bbox = BoundingBox.from_lon_lat_params(params) - end + if (@params[:friends] || @params[:nearby]) && !current_user + require_user + return + end - if bbox - changesets = conditions_bbox(changesets, bbox) - end + if request.format == :html && !@params[:list] + require_oauth + render :action => :history, :layout => map_layout + else + changesets = conditions_nonempty(Changeset.all) - if user - user_link = render_to_string :partial => "user", :object => user + if @params[:display_name] + changesets = if user.data_public? || user == current_user + changesets.where(:user_id => user.id) + else + changesets.where("false") + end + elsif @params[:bbox] + changesets = conditions_bbox(changesets, BoundingBox.from_bbox_params(params)) + elsif @params[:friends] && current_user + changesets = changesets.where(:user_id => current_user.friend_users.identifiable) + elsif @params[:nearby] && current_user + changesets = changesets.where(:user_id => current_user.nearby) end - if params[:friends] and @user - @title = t 'changeset.list.title_friend' - @heading = t 'changeset.list.title_friend' - elsif params[:nearby] and @user - @title = t 'changeset.list.title_nearby' - @heading = t 'changeset.list.title_nearby' - elsif user - @title = t 'changeset.list.title_user', :user => user.display_name - @heading = t('changeset.list.title_user', :user => user_link).html_safe - else - @title = t 'changeset.list.title' - @heading = t 'changeset.list.title' + if @params[:max_id] + changesets = changesets.where("changesets.id <= ?", @params[:max_id]) end - @page = (params[:page] || 1).to_i - @page_size = 20 + @edits = changesets.order("changesets.id DESC").limit(20).preload(:user, :changeset_tags, :comments) - @edits = changesets.order("changesets.created_at DESC").offset((@page - 1) * @page_size).limit(@page_size).preload(:user, :changeset_tags) - - render :action => :list, :layout => map_layout + render :action => :list, :layout => false end end @@ -331,7 +306,147 @@ class ChangesetController < ApplicationController list end -private + ## + # Add a comment to a changeset + def comment + # Check the arguments are sane + raise OSM::APIBadUserInput, "No id was given" unless params[:id] + raise OSM::APIBadUserInput, "No text was given" if params[:text].blank? + + # Extract the arguments + id = params[:id].to_i + body = params[:text] + + # Find the changeset and check it is valid + changeset = Changeset.find(id) + raise OSM::APIChangesetNotYetClosedError, changeset if changeset.is_open? + + # Add a comment to the changeset + comment = changeset.comments.create(:changeset => changeset, + :body => body, + :author => current_user) + + # Notify current subscribers of the new comment + changeset.subscribers.visible.each do |user| + if current_user != user + Notifier.changeset_comment_notification(comment, user).deliver_now + end + end + + # Add the commenter to the subscribers if necessary + changeset.subscribers << current_user unless changeset.subscribers.exists?(current_user.id) + + # Return a copy of the updated changeset + render :xml => changeset.to_xml.to_s + end + + ## + # Adds a subscriber to the changeset + def subscribe + # Check the arguments are sane + raise OSM::APIBadUserInput, "No id was given" unless params[:id] + + # Extract the arguments + id = params[:id].to_i + + # Find the changeset and check it is valid + changeset = Changeset.find(id) + raise OSM::APIChangesetNotYetClosedError, changeset if changeset.is_open? + raise OSM::APIChangesetAlreadySubscribedError, changeset if changeset.subscribers.exists?(current_user.id) + + # Add the subscriber + changeset.subscribers << current_user + + # Return a copy of the updated changeset + render :xml => changeset.to_xml.to_s + end + + ## + # Removes a subscriber from the changeset + def unsubscribe + # Check the arguments are sane + raise OSM::APIBadUserInput, "No id was given" unless params[:id] + + # Extract the arguments + id = params[:id].to_i + + # Find the changeset and check it is valid + changeset = Changeset.find(id) + raise OSM::APIChangesetNotYetClosedError, changeset if changeset.is_open? + raise OSM::APIChangesetNotSubscribedError, changeset unless changeset.subscribers.exists?(current_user.id) + + # Remove the subscriber + changeset.subscribers.delete(current_user) + + # Return a copy of the updated changeset + render :xml => changeset.to_xml.to_s + end + + ## + # Sets visible flag on comment to false + def hide_comment + # Check the arguments are sane + raise OSM::APIBadUserInput, "No id was given" unless params[:id] + + # Extract the arguments + id = params[:id].to_i + + # Find the changeset + comment = ChangesetComment.find(id) + + # Hide the comment + comment.update(:visible => false) + + # Return a copy of the updated changeset + render :xml => comment.changeset.to_xml.to_s + end + + ## + # Sets visible flag on comment to true + def unhide_comment + # Check the arguments are sane + raise OSM::APIBadUserInput, "No id was given" unless params[:id] + + # Extract the arguments + id = params[:id].to_i + + # Find the changeset + comment = ChangesetComment.find(id) + + # Unhide the comment + comment.update(:visible => true) + + # Return a copy of the updated changeset + render :xml => comment.changeset.to_xml.to_s + end + + ## + # Get a feed of recent changeset comments + def comments_feed + if params[:id] + # Extract the arguments + id = params[:id].to_i + + # Find the changeset + changeset = Changeset.find(id) + + # Return comments for this changeset only + @comments = changeset.comments.includes(:author, :changeset).limit(comments_limit) + else + # Return comments + @comments = ChangesetComment.includes(:author, :changeset).where(:visible => true).order("created_at DESC").limit(comments_limit).preload(:changeset) + end + + # Render the result + respond_to do |format| + format.rss + end + rescue OSM::APIBadUserInput + head :bad_request + end + + private + #------------------------------------------------------------ # utility functions below. #------------------------------------------------------------ @@ -341,35 +456,38 @@ private # restrict changesets to those enclosed by a bounding box # we need to return both the changesets and the bounding box def conditions_bbox(changesets, bbox) - if bbox + if bbox bbox.check_boundaries bbox = bbox.to_scaled - return changesets.where("min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?", - bbox.max_lon.to_i, bbox.min_lon.to_i, - bbox.max_lat.to_i, bbox.min_lat.to_i) + + changesets.where("min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?", + bbox.max_lon.to_i, bbox.min_lon.to_i, + bbox.max_lat.to_i, bbox.min_lat.to_i) else - return changesets + changesets end end ## # restrict changesets to those by a particular user def conditions_user(changesets, user, name) - unless user.nil? and name.nil? + if user.nil? && name.nil? + changesets + else # 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 + raise OSM::APIBadUserInput, "provide either the user ID or display name, but not both" if user && 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 + raise OSM::APIBadUserInput, "invalid user ID" if user.to_i < 1 u = User.find(user.to_i) else - u = User.find_by_display_name(name) + u = User.find_by(:display_name => name) end # make sure we found a user - raise OSM::APINotFoundError.new if u.nil? + raise OSM::APINotFoundError if u.nil? # should be able to get changesets of public users only, or # our own changesets regardless of public-ness. @@ -378,40 +496,38 @@ private # changesets if they're non-public setup_user_auth - raise OSM::APINotFoundError if @user.nil? or @user.id != u.id + raise OSM::APINotFoundError if current_user.nil? || current_user != u end - return changesets.where(:user_id => u.id) - else - return changesets + + changesets.where(:user_id => u.id) end end ## # restrict changes to those closed during a particular time period def conditions_time(changesets, time) - unless time.nil? + if time.nil? + return changesets + elsif time.count(",") == 1 # 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 - # 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 changesets.where("closed_at >= ? and created_at <= ?", from, to) - else - # if there is no comma, assume its a lower limit on time - return changesets.where("closed_at >= ?", DateTime.parse(time)) - end + # check that we actually have 2 elements in the array + times = time.split(/,/) + raise OSM::APIBadUserInput, "bad time range" if times.size != 2 + + from, to = times.collect { |t| Time.parse(t) } + return changesets.where("closed_at >= ? and created_at <= ?", from, to) else - return changesets + # if there is no comma, assume its a lower limit on time + return changesets.where("closed_at >= ?", Time.parse(time)) end - # stupid DateTime seems to throw both of these for bad parsing, so + # stupid Time 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 OSM::APIBadUserInput.new(ex.message.to_s) + raise OSM::APIBadUserInput, ex.message.to_s rescue RuntimeError => ex - raise OSM::APIBadUserInput.new(ex.message.to_s) + raise OSM::APIBadUserInput, ex.message.to_s end ## @@ -421,10 +537,10 @@ private # if parameter 'open' is nill then open and closed changesets are returned def conditions_open(changesets, open) if open.nil? - return changesets + changesets else - return changesets.where("closed_at >= ? and num_changes <= ?", - Time.now.getutc, Changeset::MAX_ELEMENTS) + changesets.where("closed_at >= ? and num_changes <= ?", + Time.now.getutc, Changeset::MAX_ELEMENTS) end end @@ -433,10 +549,24 @@ private # ('closed at' time has passed or changes limit is hit) def conditions_closed(changesets, closed) if closed.nil? - return changesets + changesets + else + changesets.where("closed_at < ? or num_changes > ?", + Time.now.getutc, Changeset::MAX_ELEMENTS) + end + end + + ## + # query changesets by a list of ids + # (either specified as array or comma-separated string) + def conditions_ids(changesets, ids) + if ids.nil? + changesets + elsif ids.empty? + raise OSM::APIBadUserInput, "No changesets were given to search for" else - return changesets.where("closed_at < ? or num_changes > ?", - Time.now.getutc, Changeset::MAX_ELEMENTS) + ids = ids.split(",").collect(&:to_i) + changesets.where(:id => ids) end end @@ -444,7 +574,20 @@ private # eliminate empty changesets (where the bbox has not been set) # this should be applied to all changeset list displays def conditions_nonempty(changesets) - return changesets.where("num_changes > 0") + changesets.where("num_changes > 0") end + ## + # Get the maximum number of comments to return + def comments_limit + if params[:limit] + if params[:limit].to_i > 0 && params[:limit].to_i <= 10000 + params[:limit].to_i + else + raise OSM::APIBadUserInput, "Comments limit must be between 1 and 10000" + end + else + 100 + end + end end