Adding pagination to the changesets, thus allowing you to browe large changesets...

[rails.git] / app / controllers / changeset_controller.rb

diff --git a/app/controllers/changeset_controller.rb b/app/controllers/changeset_controller.rb
index 1e6a44189ba1bac5cd0f8508dbdb71419cf86ba5..58bcd1020f15598d21b73ac4c55c7a312a9798ec 100644 (file)
--- a/app/controllers/changeset_controller.rb
+++ b/app/controllers/changeset_controller.rb
@@ -2,7 +2,6 @@
 
 class ChangesetController < ApplicationController
   require 'xml/libxml'
 
 class ChangesetController < ApplicationController
   require 'xml/libxml'

-  require 'diff_reader'

 
   before_filter :authorize, :only => [:create, :update, :delete, :upload, :include, :close]
   before_filter :check_write_availability, :only => [:create, :update, :delete, :upload, :include]
 
   before_filter :authorize, :only => [:create, :update, :delete, :upload, :include, :close]
   before_filter :check_write_availability, :only => [:create, :update, :delete, :upload, :include]


@@ -12,6 +11,9 @@ class ChangesetController < ApplicationController
   # Help methods for checking boundary sanity and area size
   include MapBoundary
 
   # 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?
   # Create a changeset from XML.
   def create
     if request.put?


@@ -47,13 +49,14 @@ class ChangesetController < ApplicationController
       return
     end
     
       return
     end
     

-    changeset = Changeset.find(params[:id])
-    
-    unless @user.id == changeset.user_id 
-      raise OSM::APIUserChangesetMismatchError 
-    end
-    
-    changeset.open = false
+    changeset = Changeset.find(params[:id])    
+    check_changeset_consistency(changeset, @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, 
+    # but we'll have to wait and see.
+    changeset.set_closed_time_now
+

     changeset.save!
     render :nothing => true
   rescue ActiveRecord::RecordNotFound
     changeset.save!
     render :nothing => true
   rescue ActiveRecord::RecordNotFound


@@ -67,17 +70,12 @@ class ChangesetController < ApplicationController
   # 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.
   # 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])
     # 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
 
       # keep an array of lons and lats
       lon = Array.new


@@ -139,12 +137,7 @@ class ChangesetController < ApplicationController
     end
 
     changeset = Changeset.find(params[:id])
     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
     
     diff_reader = DiffReader.new(request.raw_post, changeset)
     Changeset.transaction do


@@ -236,9 +229,9 @@ class ChangesetController < ApplicationController
     # create the conditions that the user asked for. some or all of
     # these may be nil.
     conditions = conditions_bbox(params['bbox'])
     # 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'])

 
     # create the results document
     results = OSM::API.new.get_xml_doc
 
     # create the results document
     results = OSM::API.new.get_xml_doc


@@ -257,8 +250,6 @@ class ChangesetController < ApplicationController
     render :nothing => true, :status => :not_found
   rescue OSM::APIError => ex
     render ex.render_opts
     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
   
   ##
   end
   
   ##


@@ -280,6 +271,7 @@ class ChangesetController < ApplicationController
     new_changeset = Changeset.from_xml(request.raw_post)
 
     unless new_changeset.nil?
     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
       changeset.update_from(new_changeset, @user)
       render :text => changeset.to_xml, :mime_type => "text/xml"
     else


@@ -293,6 +285,7 @@ class ChangesetController < ApplicationController
     render ex.render_opts
   end
 
     render ex.render_opts
   end
 

+private

   #------------------------------------------------------------
   # utility functions below.
   #------------------------------------------------------------  
   #------------------------------------------------------------
   # utility functions below.
   #------------------------------------------------------------  


@@ -317,10 +310,10 @@ class ChangesetController < ApplicationController
   # area restriction.
   def conditions_bbox(bbox)
     unless bbox.nil?
   # 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(/,/))
       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] * GeoRecord::SCALE, bbox[0] * GeoRecord::SCALE, bbox[3]* GeoRecord::SCALE, bbox[1] * GeoRecord::SCALE]
     else
       return ['min_lon < ? and max_lon > ? and min_lat < ? and max_lat > ?',
               bbox[2] * GeoRecord::SCALE, bbox[0] * GeoRecord::SCALE, bbox[3]* GeoRecord::SCALE, bbox[1] * GeoRecord::SCALE]
     else


@@ -332,8 +325,19 @@ class ChangesetController < ApplicationController
   # restrict changesets to those by a particular user
   def conditions_user(user)
     unless user.nil?
   # 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)
       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
       return ['user_id = ?', u.id]
     else
       return nil


@@ -347,23 +351,31 @@ class ChangesetController < ApplicationController
       # 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
       # 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
       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
       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
   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
   def conditions_open(open)
   end
 
   ##
   # restrict changes to those which are open
   def conditions_open(open)

-    return open.nil? ? nil : ['open = ?', true]
+    return open.nil? ? nil : ['closed_at >= ?', DateTime.now]

   end
 
 end
   end
 
 end