Create api changeset download resource

[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 8a1b9f55bc779993d296f823afb286976becd98c..517cff47326d28853cacd96416c718c8b5d81b69 100644 (file)
--- a/app/controllers/api/changesets_controller.rb
+++ b/app/controllers/api/changesets_controller.rb
@@ -2,10 +2,10 @@
 
 module Api
   class ChangesetsController < ApiController
 
 module Api
   class ChangesetsController < ApiController

-    require "xml/libxml"
+    include QueryMethods

 
     before_action :check_api_writable, :only => [:create, :update, :upload, :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]
+    before_action :setup_user_auth, :only => [:show]

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


@@ -13,19 +13,59 @@ module Api
     before_action :require_public_data, :only => [:create, :update, :upload, :close, :subscribe, :unsubscribe]
     before_action :set_request_formats, :except => [:create, :close, :upload]
 
     before_action :require_public_data, :only => [:create, :update, :upload, :close, :subscribe, :unsubscribe]
     before_action :set_request_formats, :except => [:create, :close, :upload]
 

-    around_action :api_call_handle_error
-    around_action :api_call_timeout, :except => [:upload]
+    skip_around_action :api_call_timeout, :only => [:upload]

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

+    ##
+    # 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"
+
+      # 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 = query_conditions_time(changesets)
+      changesets = conditions_open(changesets, params["open"])
+      changesets = conditions_closed(changesets, params["closed"])
+      changesets = conditions_ids(changesets, params["changesets"])
+
+      # sort the changesets
+      changesets = if params[:order] == "oldest"
+                     changesets.order(:created_at => :asc)
+                   else
+                     changesets.order(:created_at => :desc)
+                   end
+
+      # limit the result
+      changesets = query_limit(changesets)
+
+      # 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
+

     ##
     # Return XML giving the basic info about the changeset. Does not
     # return anything about the nodes, ways and relations in the changeset.
     def show
       @changeset = Changeset.find(params[:id])
     ##
     # Return XML giving the basic info about the changeset. Does not
     # 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
 
       respond_to do |format|
         format.xml


@@ -35,8 +75,6 @@ module Api
 
     # Create a changeset from XML.
     def create
 
     # Create a changeset from XML.
     def create

-      assert_method :put
-

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


@@ -44,7 +82,7 @@ module Api
       cs.save_with_tags!
 
       # Subscribe user to changeset comments
       cs.save_with_tags!
 
       # Subscribe user to changeset comments

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

 
       render :plain => cs.id.to_s
     end
 
       render :plain => cs.id.to_s
     end


@@ -53,8 +91,6 @@ module Api
     # marks a changeset as closed. this may be called multiple times
     # on the same changeset, so is idempotent.
     def close
     # 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)
 


@@ -80,116 +116,20 @@ 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
 

-    ##
-    # download the changeset as an osmChange document.
-    #
-    # to make it easier to revert diffs it would be better if the osmChange
-    # format were reversible, i.e: contained both old and new versions of
-    # modified elements. but it doesn't at the moment...
-    #
-    # this method cannot order the database changes fully (i.e: timestamp and
-    # version number may be too coarse) so the resulting diff may not apply
-    # to a different database. however since changesets are not atomic this
-    # behaviour cannot be guaranteed anyway and is the result of a design
-    # choice.
-    def download
-      changeset = Changeset.find(params[:id])
-
-      # get all the elements in the changeset which haven't been redacted
-      # and stick them in a big array.
-      elements = [changeset.old_nodes.unredacted,
-                  changeset.old_ways.unredacted,
-                  changeset.old_relations.unredacted].flatten
-
-      # sort the elements by timestamp and version number, as this is the
-      # 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
-
-      # 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|
-        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
-
-      respond_to do |format|
-        format.xml
-      end
-    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 the changesets
-      changesets = if params[:order] == "oldest"
-                     changesets.order(:created_at => :asc)
-                   else
-                     changesets.order(:created_at => :desc)
-                   end
-
-      # limit the result
-      changesets = changesets.limit(result_limit)
-
-      # preload users, tags and comments, and render result
-      @changesets = changesets.preload(:user, :changeset_tags, :comments)
-      render "changesets"
-
-      respond_to do |format|
-        format.xml
-        format.json
-      end
-    end
-

     ##
     # updates a changeset's tags. none of the changeset's attributes are
     # user-modifiable, so they will be ignored.
     ##
     # updates a changeset's tags. none of the changeset's attributes are
     # user-modifiable, so they will be ignored.


@@ -199,15 +139,12 @@ 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
 
       respond_to do |format|
         format.xml


@@ -226,14 +163,14 @@ 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
 
       respond_to do |format|
         format.xml


@@ -252,14 +189,14 @@ 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
 
       respond_to do |format|
         format.xml


@@ -276,7 +213,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


@@ -304,7 +240,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


@@ -322,12 +258,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


@@ -343,7 +279,7 @@ module Api
         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).utc)
+        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.


@@ -390,19 +326,5 @@ 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