Add 'from' and 'to' changeset query parameters

[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 56070951a8264292416ac8a57dbc00d58fa117bd..84f1ccdb526b41be0d338f533f3c05b6e09f2212 100644 (file)
--- a/app/controllers/api/changesets_controller.rb
+++ b/app/controllers/api/changesets_controller.rb
@@ -157,6 +157,8 @@ module Api
     ##
     # query changesets by bounding box, time, user or open/closed status.
     def query
     ##
     # query changesets by bounding box, time, user or open/closed status.
     def query

+      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"]
 
       # find any bounding box
       bbox = BoundingBox.from_bbox_params(params) if params["bbox"]
 


@@ -166,12 +168,20 @@ module Api
       changesets = conditions_bbox(changesets, bbox)
       changesets = conditions_user(changesets, params["user"], params["display_name"])
       changesets = conditions_time(changesets, params["time"])
       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"])
 
       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)
+      # 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)
 
       # preload users, tags and comments, and render result
       @changesets = changesets.preload(:user, :changeset_tags, :comments)


@@ -320,7 +330,7 @@ module Api
     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


@@ -344,6 +354,33 @@ module Api
       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


@@ -383,5 +420,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