Merge remote-tracking branch 'upstream/pull/5405'

[rails.git] / app / controllers / api / changesets_controller.rb

diff --git a/app/controllers/api/changesets_controller.rb b/app/controllers/api/changesets_controller.rb
index 31601522877dce62e24ee81bbd91a385eededa8a..9111bb609d27d91753d3b6b46a6ee7ae59954eae 100644 (file)
--- a/app/controllers/api/changesets_controller.rb
+++ b/app/controllers/api/changesets_controller.rb
@@ -2,36 +2,56 @@
 
 module Api
   class ChangesetsController < ApiController
 
 module Api
   class ChangesetsController < ApiController

-    layout "site"
-    require "xml/libxml"
-
+    before_action :check_api_writable, :only => [:create, :update, :upload, :subscribe, :unsubscribe]
+    before_action :setup_user_auth, :only => [:show]

     before_action :authorize, :only => [:create, :update, :upload, :close, :subscribe, :unsubscribe]
 
     authorize_resource
 
     before_action :require_public_data, :only => [:create, :update, :upload, :close, :subscribe, :unsubscribe]
     before_action :authorize, :only => [:create, :update, :upload, :close, :subscribe, :unsubscribe]
 
     authorize_resource
 
     before_action :require_public_data, :only => [:create, :update, :upload, :close, :subscribe, :unsubscribe]

-    before_action :check_api_writable, :only => [:create, :update, :upload, :subscribe, :unsubscribe]
-    before_action :check_api_readable, :except => [:create, :update, :upload, :download, :query, :subscribe, :unsubscribe]
-    around_action :api_call_handle_error
-    around_action :api_call_timeout, :except => [:upload]
+    before_action :set_request_formats, :except => [:create, :close, :upload]
+
+    skip_around_action :api_call_timeout, :only => [:upload]

 
     # Helper methods for checking consistency
     include ConsistencyValidations
 
 
     # Helper methods for checking consistency
     include ConsistencyValidations
 

-    # Create a changeset from XML.
-    def create
-      assert_method :put
+    ##
+    # query changesets by bounding box, time, user or open/closed status.
+    def index
+      raise OSM::APIBadUserInput, "cannot use order=oldest with time" if params[:time] && params[:order] == "oldest"

 
 

-      cs = Changeset.from_xml(request.raw_post, true)
+      # find any bounding box
+      bbox = BoundingBox.from_bbox_params(params) if params["bbox"]

 
 

-      # Assume that Changeset.from_xml has thrown an exception if there is an error parsing the xml
-      cs.user = current_user
-      cs.save_with_tags!
+      # 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_from_to(changesets, params["from"], params["to"])
+      changesets = conditions_open(changesets, params["open"])
+      changesets = conditions_closed(changesets, params["closed"])
+      changesets = conditions_ids(changesets, params["changesets"])

 
 

-      # Subscribe user to changeset comments
-      cs.subscribers << current_user
+      # sort the changesets
+      changesets = if params[:order] == "oldest"
+                     changesets.order(:created_at => :asc)
+                   else
+                     changesets.order(:created_at => :desc)
+                   end

 
 

-      render :plain => cs.id.to_s
+      # limit the result
+      changesets = changesets.limit(result_limit)
+
+      # preload users, tags and comments, and render result
+      @changesets = changesets.preload(:user, :changeset_tags, :comments)
+
+      respond_to do |format|
+        format.xml
+        format.json
+      end

     end
 
     ##
     end
 
     ##


@@ -39,16 +59,36 @@ module Api
     # return anything about the nodes, ways and relations in the changeset.
     def show
       @changeset = Changeset.find(params[:id])
     # return anything about the nodes, ways and relations in the changeset.
     def show
       @changeset = Changeset.find(params[:id])

-      @include_discussion = params[:include_discussion].presence
-      render "changeset"
+      if params[:include_discussion].presence
+        @comments = @changeset.comments
+        @comments = @comments.unscope(:where => :visible) if params[:show_hidden_comments].presence && can?(:restore, ChangesetComment)
+        @comments = @comments.includes(:author)
+      end
+
+      respond_to do |format|
+        format.xml
+        format.json
+      end
+    end
+
+    # Create a changeset from XML.
+    def create
+      cs = Changeset.from_xml(request.raw_post, :create => true)
+
+      # Assume that Changeset.from_xml has thrown an exception if there is an error parsing the xml
+      cs.user = current_user
+      cs.save_with_tags!
+
+      # Subscribe user to changeset comments
+      cs.subscribe(current_user)
+
+      render :plain => cs.id.to_s

     end
 
     ##
     # marks a changeset as closed. this may be called multiple times
     # on the same changeset, so is idempotent.
     def close
     end
 
     ##
     # marks a changeset as closed. this may be called multiple times
     # on the same changeset, so is idempotent.
     def close

-      assert_method :put
-

       changeset = Changeset.find(params[:id])
       check_changeset_consistency(changeset, current_user)
 
       changeset = Changeset.find(params[:id])
       check_changeset_consistency(changeset, current_user)
 


@@ -74,18 +114,16 @@ module Api
     # Returns: a diffResult document, as described in
     # http://wiki.openstreetmap.org/wiki/OSM_Protocol_Version_0.6
     def upload
     # Returns: a diffResult document, as described in
     # 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
-      assert_method :post
-

       changeset = Changeset.find(params[:id])
       check_changeset_consistency(changeset, current_user)
 
       diff_reader = DiffReader.new(request.raw_post, changeset)
       Changeset.transaction do
         result = diff_reader.commit
       changeset = Changeset.find(params[:id])
       check_changeset_consistency(changeset, current_user)
 
       diff_reader = DiffReader.new(request.raw_post, changeset)
       Changeset.transaction do
         result = diff_reader.commit

+        # the number of changes in this changeset has already been
+        # updated and is visible in this transaction so we don't need
+        # to allow for any more when checking the limit
+        check_rate_limit(0)

         render :xml => result.to_s
       end
     end
         render :xml => result.to_s
       end
     end


@@ -115,67 +153,31 @@ module Api
       # almost sensible ordering available. this would be much nicer if
       # global (SVN-style) versioning were used - then that would be
       # unambiguous.
       # almost sensible ordering available. this would be much nicer if
       # global (SVN-style) versioning were used - then that would be
       # unambiguous.

-      elements.sort! do |a, b|
-        if a.timestamp == b.timestamp
-          a.version <=> b.version
-        else
-          a.timestamp <=> b.timestamp
-        end
-      end
-
-      # create changeset and user caches
-      changeset_cache = {}
-      user_display_name_cache = {}
-
-      # create an osmChange document for the output
-      result = OSM::API.new.get_xml_doc
-      result.root.name = "osmChange"
+      elements.sort_by! { |e| [e.timestamp, e.version] }

 
       # generate an output element for each operation. note: we avoid looking
       # at the history because it is simpler - but it would be more correct to
       # check these assertions.
 
       # generate an output element for each operation. note: we avoid looking
       # at the history because it is simpler - but it would be more correct to
       # check these assertions.

+      @created = []
+      @modified = []
+      @deleted = []
+

       elements.each do |elt|
       elements.each do |elt|

-        result.root <<
-          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
-            # 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
+        if elt.version == 1
+          # first version, so it must be newly-created.
+          @created << elt
+        elsif elt.visible
+          # must be a modify
+          @modified << elt
+        else
+          # if the element isn't visible then it must have been deleted
+          @deleted << elt
+        end

       end
 
       end
 

-      render :xml => result.to_s
-    end
-
-    ##
-    # query changesets by bounding box, time, user or open/closed status.
-    def query
-      # find any bounding box
-      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_ids(changesets, params["changesets"])
-
-      # sort and limit the changesets
-      changesets = changesets.order("created_at DESC").limit(100)
-
-      # preload users, tags and comments, and render result
-      @changesets = changesets.preload(:user, :changeset_tags, :comments)
-      render "changesets"
+      respond_to do |format|
+        format.xml
+      end

     end
 
     ##
     end
 
     ##


@@ -187,15 +189,17 @@ module Api
     #
     # after succesful update, returns the XML of the changeset.
     def update
     #
     # 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)
 
       check_changeset_consistency(@changeset, current_user)
       @changeset.update_from(new_changeset, current_user)
       @changeset = Changeset.find(params[:id])
       new_changeset = Changeset.from_xml(request.raw_post)
 
       check_changeset_consistency(@changeset, current_user)
       @changeset.update_from(new_changeset, current_user)

-      render "changeset"
+      render "show"
+
+      respond_to do |format|
+        format.xml
+        format.json
+      end

     end
 
     ##
     end
 
     ##


@@ -209,14 +213,19 @@ module Api
 
       # Find the changeset and check it is valid
       changeset = Changeset.find(id)
 
       # Find the changeset and check it is valid
       changeset = Changeset.find(id)

-      raise OSM::APIChangesetAlreadySubscribedError, changeset if changeset.subscribers.exists?(current_user.id)
+      raise OSM::APIChangesetAlreadySubscribedError, changeset if changeset.subscribed?(current_user)

 
       # Add the subscriber
 
       # Add the subscriber

-      changeset.subscribers << current_user
+      changeset.subscribe(current_user)

 
       # Return a copy of the updated changeset
       @changeset = changeset
 
       # Return a copy of the updated changeset
       @changeset = changeset

-      render "changeset"
+      render "show"
+
+      respond_to do |format|
+        format.xml
+        format.json
+      end

     end
 
     ##
     end
 
     ##


@@ -230,14 +239,19 @@ module Api
 
       # Find the changeset and check it is valid
       changeset = Changeset.find(id)
 
       # Find the changeset and check it is valid
       changeset = Changeset.find(id)

-      raise OSM::APIChangesetNotSubscribedError, changeset unless changeset.subscribers.exists?(current_user.id)
+      raise OSM::APIChangesetNotSubscribedError, changeset unless changeset.subscribed?(current_user)

 
       # Remove the subscriber
 
       # Remove the subscriber

-      changeset.subscribers.delete(current_user)
+      changeset.unsubscribe(current_user)

 
       # Return a copy of the updated changeset
       @changeset = changeset
 
       # Return a copy of the updated changeset
       @changeset = changeset

-      render "changeset"
+      render "show"
+
+      respond_to do |format|
+        format.xml
+        format.json
+      end

     end
 
     private
     end
 
     private


@@ -249,7 +263,6 @@ module Api
     ##
     # if a bounding box was specified do some sanity checks.
     # restrict changesets to those enclosed by a bounding box
     ##
     # if a bounding box was specified do some sanity checks.
     # 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
         bbox.check_boundaries
     def conditions_bbox(changesets, bbox)
       if bbox
         bbox.check_boundaries


@@ -277,7 +290,7 @@ module Api
               # user input checking, we don't have any UIDs < 1
               raise OSM::APIBadUserInput, "invalid user ID" if user.to_i < 1
 
               # user input checking, we don't have any UIDs < 1
               raise OSM::APIBadUserInput, "invalid user ID" if user.to_i < 1
 

-              u = User.find(user.to_i)
+              u = User.find_by(:id => user.to_i)

             else
               u = User.find_by(:display_name => name)
             end
             else
               u = User.find_by(:display_name => name)
             end


@@ -295,12 +308,12 @@ module Api
           raise OSM::APINotFoundError if current_user.nil? || current_user != u
         end
 
           raise OSM::APINotFoundError if current_user.nil? || current_user != u
         end
 

-        changesets.where(:user_id => u.id)
+        changesets.where(:user => u)

       end
     end
 
     ##
       end
     end
 
     ##

-    # restrict changes to those closed during a particular time period
+    # restrict changesets to those during a particular time period

     def conditions_time(changesets, time)
       if time.nil?
         changesets
     def conditions_time(changesets, time)
       if time.nil?
         changesets


@@ -309,23 +322,48 @@ module Api
         # low, second is high - same as with bounding boxes.
 
         # check that we actually have 2 elements in the array
         # low, second is high - same as with bounding boxes.
 
         # check that we actually have 2 elements in the array

-        times = time.split(/,/)
+        times = time.split(",")

         raise OSM::APIBadUserInput, "bad time range" if times.size != 2
 
         raise OSM::APIBadUserInput, "bad time range" if times.size != 2
 

-        from, to = times.collect { |t| Time.parse(t) }
+        from, to = times.collect { |t| Time.parse(t).utc }

         changesets.where("closed_at >= ? and created_at <= ?", from, to)
       else
         # if there is no comma, assume its a lower limit on time
         changesets.where("closed_at >= ? and created_at <= ?", from, to)
       else
         # if there is no comma, assume its a lower limit on time

-        changesets.where("closed_at >= ?", Time.parse(time))
+        changesets.where(:closed_at => Time.parse(time).utc..)

       end
       # 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.
       end
       # 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 => e
-      raise OSM::APIBadUserInput, e.message.to_s
-    rescue RuntimeError => e
+    rescue ArgumentError, RuntimeError => e

       raise OSM::APIBadUserInput, e.message.to_s
     end
 
       raise OSM::APIBadUserInput, e.message.to_s
     end
 

+    ##
+    # restrict changesets to those opened during a particular time period
+    # works similar to from..to of notes controller, including the requirement of 'from' when specifying 'to'
+    def conditions_from_to(changesets, from, to)
+      if from
+        begin
+          from = Time.parse(from).utc
+        rescue ArgumentError
+          raise OSM::APIBadUserInput, "Date #{from} is in a wrong format"
+        end
+
+        begin
+          to = if to
+                 Time.parse(to).utc
+               else
+                 Time.now.utc
+               end
+        rescue ArgumentError
+          raise OSM::APIBadUserInput, "Date #{to} is in a wrong format"
+        end
+
+        changesets.where(:created_at => from..to)
+      else
+        changesets
+      end
+    end
+

     ##
     # 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
     ##
     # 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


@@ -336,7 +374,7 @@ module Api
         changesets
       else
         changesets.where("closed_at >= ? and num_changes <= ?",
         changesets
       else
         changesets.where("closed_at >= ? and num_changes <= ?",

-                         Time.now.getutc, Changeset::MAX_ELEMENTS)
+                         Time.now.utc, Changeset::MAX_ELEMENTS)

       end
     end
 
       end
     end
 


@@ -348,7 +386,7 @@ module Api
         changesets
       else
         changesets.where("closed_at < ? or num_changes > ?",
         changesets
       else
         changesets.where("closed_at < ? or num_changes > ?",

-                         Time.now.getutc, Changeset::MAX_ELEMENTS)
+                         Time.now.utc, Changeset::MAX_ELEMENTS)

       end
     end
 
       end
     end
 


@@ -365,5 +403,19 @@ module Api
         changesets.where(:id => ids)
       end
     end
         changesets.where(:id => ids)
       end
     end

+
+    ##
+    # Get the maximum number of results to return
+    def result_limit
+      if params[:limit]
+        if params[:limit].to_i.positive? && params[:limit].to_i <= Settings.max_changeset_query_limit
+          params[:limit].to_i
+        else
+          raise OSM::APIBadUserInput, "Changeset limit must be between 1 and #{Settings.max_changeset_query_limit}"
+        end
+      else
+        Settings.default_changeset_query_limit
+      end
+    end

   end
 end
   end
 end