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

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

diff --git a/app/controllers/api/notes_controller.rb b/app/controllers/api/notes_controller.rb
index cd71b437457e302f2e33c13d6faf90f9761c5e6f..3352c1f69b591c121fcf582d2ec01f6307185bac 100644 (file)
--- a/app/controllers/api/notes_controller.rb
+++ b/app/controllers/api/notes_controller.rb
@@ -1,14 +1,14 @@
 module Api
   class NotesController < ApiController
 module Api
   class NotesController < ApiController

-    before_action :check_api_readable
-    before_action :setup_user_auth, :only => [:create, :comment, :show]
+    before_action :check_api_writable, :only => [:create, :comment, :close, :reopen, :destroy]
+    before_action :setup_user_auth, :only => [:create, :show]

     before_action :authorize, :only => [:close, :reopen, :destroy, :comment]
 
     authorize_resource
 
     before_action :authorize, :only => [:close, :reopen, :destroy, :comment]
 
     authorize_resource
 

-    before_action :check_api_writable, :only => [:create, :comment, :close, :reopen, :destroy]

     before_action :set_locale
     around_action :api_call_handle_error, :api_call_timeout
     before_action :set_locale
     around_action :api_call_handle_error, :api_call_timeout

+    before_action :set_request_formats, :except => [:feed]

 
     ##
     # Return a list of notes in a given area
 
     ##
     # Return a list of notes in a given area


@@ -17,13 +17,10 @@ module Api
       # support the old, deprecated, method with four arguments
       if params[:bbox]
         bbox = BoundingBox.from_bbox_params(params)
       # support the old, deprecated, method with four arguments
       if params[:bbox]
         bbox = BoundingBox.from_bbox_params(params)

-      else
-        raise OSM::APIBadUserInput, "No l was given" unless params[:l]
-        raise OSM::APIBadUserInput, "No r was given" unless params[:r]
-        raise OSM::APIBadUserInput, "No b was given" unless params[:b]
-        raise OSM::APIBadUserInput, "No t was given" unless params[:t]
-
+      elsif params[:l] && params[:r] && params[:b] && params[:t]

         bbox = BoundingBox.from_lrbt_params(params)
         bbox = BoundingBox.from_lrbt_params(params)

+      else
+        raise OSM::APIBadUserInput, "The parameter bbox is required"

       end
 
       # Get any conditions that need to be applied
       end
 
       # Get any conditions that need to be applied


@@ -34,6 +31,10 @@ module Api
 
       # Check the the bounding box is not too big
       bbox.check_size(Settings.max_note_request_area)
 
       # Check the the bounding box is not too big
       bbox.check_size(Settings.max_note_request_area)

+      @min_lon = bbox.min_lon
+      @min_lat = bbox.min_lat
+      @max_lon = bbox.max_lon
+      @max_lat = bbox.max_lat

 
       # Find the notes we want to return
       @notes = notes.bbox(bbox).order("updated_at DESC").limit(result_limit).preload(:comments)
 
       # Find the notes we want to return
       @notes = notes.bbox(bbox).order("updated_at DESC").limit(result_limit).preload(:comments)


@@ -47,6 +48,26 @@ module Api
       end
     end
 
       end
     end
 

+    ##
+    # Read a note
+    def show
+      # Check the arguments are sane
+      raise OSM::APIBadUserInput, "No id was given" unless params[:id]
+
+      # Find the note and check it is valid
+      @note = Note.find(params[:id])
+      raise OSM::APINotFoundError unless @note
+      raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible? || current_user&.moderator?
+
+      # Render the result
+      respond_to do |format|
+        format.xml
+        format.rss
+        format.json
+        format.gpx
+      end
+    end
+

     ##
     # Create a new note
     def create
     ##
     # Create a new note
     def create


@@ -83,12 +104,39 @@ module Api
       end
     end
 
       end
     end
 

+    ##
+    # Delete (hide) a note
+    def destroy
+      # Check the arguments are sane
+      raise OSM::APIBadUserInput, "No id was given" unless params[:id]
+
+      # Extract the arguments
+      id = params[:id].to_i
+      comment = params[:text]
+
+      # Find the note and check it is valid
+      Note.transaction do
+        @note = Note.lock.find(id)
+        raise OSM::APINotFoundError unless @note
+        raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?
+
+        # Mark the note as hidden
+        @note.status = "hidden"
+        @note.save
+
+        add_comment(@note, comment, "hidden", :notify => false)
+      end
+
+      # Return a copy of the updated note
+      respond_to do |format|
+        format.xml { render :action => :show }
+        format.json { render :action => :show }
+      end
+    end
+

     ##
     # Add a comment to an existing note
     def comment
     ##
     # Add a comment to an existing note
     def comment

-      # Check the ACLs
-      raise OSM::APIAccessDenied if current_user.nil? && Acl.no_note_comment(request.remote_ip)
-

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


@@ -98,13 +146,13 @@ module Api
       comment = params[:text]
 
       # Find the note and check it is valid
       comment = params[:text]
 
       # Find the note and check it is valid

-      @note = Note.find(id)
-      raise OSM::APINotFoundError unless @note
-      raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?
-      raise OSM::APINoteAlreadyClosedError, @note if @note.closed?
-
-      # Add a comment to the note

       Note.transaction do
       Note.transaction do

+        @note = Note.lock.find(id)
+        raise OSM::APINotFoundError unless @note
+        raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?
+        raise OSM::APINoteAlreadyClosedError, @note if @note.closed?
+
+        # Add a comment to the note

         add_comment(@note, comment, "commented")
       end
 
         add_comment(@note, comment, "commented")
       end
 


@@ -126,13 +174,13 @@ module Api
       comment = params[:text]
 
       # Find the note and check it is valid
       comment = params[:text]
 
       # Find the note and check it is valid

-      @note = Note.find_by(:id => id)
-      raise OSM::APINotFoundError unless @note
-      raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?
-      raise OSM::APINoteAlreadyClosedError, @note if @note.closed?
-
-      # Close the note and add a comment

       Note.transaction do
       Note.transaction do

+        @note = Note.lock.find_by(:id => id)
+        raise OSM::APINotFoundError unless @note
+        raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?
+        raise OSM::APINoteAlreadyClosedError, @note if @note.closed?
+
+        # Close the note and add a comment

         @note.close
 
         add_comment(@note, comment, "closed")
         @note.close
 
         add_comment(@note, comment, "closed")


@@ -156,13 +204,13 @@ module Api
       comment = params[:text]
 
       # Find the note and check it is valid
       comment = params[:text]
 
       # Find the note and check it is valid

-      @note = Note.find_by(:id => id)
-      raise OSM::APINotFoundError unless @note
-      raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible? || current_user.moderator?
-      raise OSM::APINoteAlreadyOpenError, @note unless @note.closed? || !@note.visible?
-
-      # Reopen the note and add a comment

       Note.transaction do
       Note.transaction do

+        @note = Note.lock.find_by(:id => id)
+        raise OSM::APINotFoundError unless @note
+        raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible? || current_user.moderator?
+        raise OSM::APINoteAlreadyOpenError, @note unless @note.closed? || !@note.visible?
+
+        # Reopen the note and add a comment

         @note.reopen
 
         add_comment(@note, comment, "reopened")
         @note.reopen
 
         add_comment(@note, comment, "reopened")


@@ -180,19 +228,12 @@ module Api
     def feed
       # Get any conditions that need to be applied
       notes = closed_condition(Note.all)
     def feed
       # Get any conditions that need to be applied
       notes = closed_condition(Note.all)

-
-      # Process any bbox
-      if params[:bbox]
-        bbox = BoundingBox.from_bbox_params(params)
-
-        bbox.check_boundaries
-        bbox.check_size(Settings.max_note_request_area)
-
-        notes = notes.bbox(bbox)
-      end
+      notes = bbox_condition(notes)

 
       # Find the comments we want to return
 
       # Find the comments we want to return

-      @comments = NoteComment.where(:note_id => notes).order("created_at DESC").limit(result_limit).preload(:note)
+      @comments = NoteComment.where(:note => notes)
+                             .order(:created_at => :desc).limit(result_limit)
+                             .preload(:author, :note => { :comments => :author })

 
       # Render the result
       respond_to do |format|
 
       # Render the result
       respond_to do |format|


@@ -200,61 +241,12 @@ module Api
       end
     end
 
       end
     end
 

-    ##
-    # Read a note
-    def show
-      # Check the arguments are sane
-      raise OSM::APIBadUserInput, "No id was given" unless params[:id]
-
-      # Find the note and check it is valid
-      @note = Note.find(params[:id])
-      raise OSM::APINotFoundError unless @note
-      raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible? || current_user&.moderator?
-
-      # Render the result
-      respond_to do |format|
-        format.xml
-        format.rss
-        format.json
-        format.gpx
-      end
-    end
-
-    ##
-    # Delete (hide) a note
-    def destroy
-      # Check the arguments are sane
-      raise OSM::APIBadUserInput, "No id was given" unless params[:id]
-
-      # Extract the arguments
-      id = params[:id].to_i
-      comment = params[:text]
-
-      # Find the note and check it is valid
-      @note = Note.find(id)
-      raise OSM::APINotFoundError unless @note
-      raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?
-
-      # Mark the note as hidden
-      Note.transaction do
-        @note.status = "hidden"
-        @note.save
-
-        add_comment(@note, comment, "hidden", false)
-      end
-
-      # Return a copy of the updated note
-      respond_to do |format|
-        format.xml { render :action => :show }
-        format.json { render :action => :show }
-      end
-    end
-

     ##
     # Return a list of notes matching a given string
     def search
       # Get the initial set of notes
       @notes = closed_condition(Note.all)
     ##
     # Return a list of notes matching a given string
     def search
       # Get the initial set of notes
       @notes = closed_condition(Note.all)

+      @notes = bbox_condition(@notes)

 
       # Add any user filter
       if params[:display_name] || params[:user]
 
       # Add any user filter
       if params[:display_name] || params[:user]


@@ -277,16 +269,16 @@ module Api
       # Add any date filter
       if params[:from]
         begin
       # Add any date filter
       if params[:from]
         begin

-          from = Time.parse(params[:from])
+          from = Time.parse(params[:from]).utc

         rescue ArgumentError
           raise OSM::APIBadUserInput, "Date #{params[:from]} is in a wrong format"
         end
 
         begin
           to = if params[:to]
         rescue ArgumentError
           raise OSM::APIBadUserInput, "Date #{params[:from]} is in a wrong format"
         end
 
         begin
           to = if params[:to]

-                 Time.parse(params[:to])
+                 Time.parse(params[:to]).utc

                else
                else

-                 Time.now
+                 Time.now.utc

                end
         rescue ArgumentError
           raise OSM::APIBadUserInput, "Date #{params[:to]} is in a wrong format"
                end
         rescue ArgumentError
           raise OSM::APIBadUserInput, "Date #{params[:to]} is in a wrong format"


@@ -336,13 +328,13 @@ module Api
     # Get the maximum number of results to return
     def result_limit
       if params[:limit]
     # Get the maximum number of results to return
     def result_limit
       if params[:limit]

-        if params[:limit].to_i.positive? && params[:limit].to_i <= 10000
+        if params[:limit].to_i.positive? && params[:limit].to_i <= Settings.max_note_query_limit

           params[:limit].to_i
         else
           params[:limit].to_i
         else

-          raise OSM::APIBadUserInput, "Note limit must be between 1 and 10000"
+          raise OSM::APIBadUserInput, "Note limit must be between 1 and #{Settings.max_note_query_limit}"

         end
       else
         end
       else

-        100
+        Settings.default_note_query_limit

       end
     end
 
       end
     end
 


@@ -351,9 +343,9 @@ module Api
     # on their status and the user's request parameters
     def closed_condition(notes)
       closed_since = if params[:closed]
     # on their status and the user's request parameters
     def closed_condition(notes)
       closed_since = if params[:closed]

-                       params[:closed].to_i
+                       params[:closed].to_i.days

                      else
                      else

-                       7
+                       Note::DEFAULT_FRESHLY_CLOSED_LIMIT

                      end
 
       if closed_since.negative?
                      end
 
       if closed_since.negative?


@@ -361,19 +353,46 @@ module Api
       elsif closed_since.positive?
         notes.where(:status => "open")
              .or(notes.where(:status => "closed")
       elsif closed_since.positive?
         notes.where(:status => "open")
              .or(notes.where(:status => "closed")

-                      .where(notes.arel_table[:closed_at].gt(Time.now - closed_since.days)))
+                      .where(notes.arel_table[:closed_at].gt(Time.now.utc - closed_since)))

       else
         notes.where(:status => "open")
       end
     end
 
       else
         notes.where(:status => "open")
       end
     end
 

+    ##
+    # Generate a condition to choose which notes we want based
+    # on the user's bounding box request parameters
+    def bbox_condition(notes)
+      if params[:bbox]
+        bbox = BoundingBox.from_bbox_params(params)
+
+        bbox.check_boundaries
+        bbox.check_size(Settings.max_note_request_area)
+
+        @min_lon = bbox.min_lon
+        @min_lat = bbox.min_lat
+        @max_lon = bbox.max_lon
+        @max_lat = bbox.max_lat
+
+        notes.bbox(bbox)
+      else
+        notes
+      end
+    end
+

     ##
     # Add a comment to a note
     ##
     # Add a comment to a note

-    def add_comment(note, text, event, notify = true)
+    def add_comment(note, text, event, notify: true)

       attributes = { :visible => true, :event => event, :body => text }
 
       attributes = { :visible => true, :event => event, :body => text }
 

-      if current_user
-        attributes[:author_id] = current_user.id
+      if doorkeeper_token
+        author = current_user if scope_enabled?(:write_notes)
+      else
+        author = current_user
+      end
+
+      if author
+        attributes[:author_id] = author.id

       else
         attributes[:author_ip] = request.remote_ip
       end
       else
         attributes[:author_ip] = request.remote_ip
       end


@@ -381,7 +400,7 @@ module Api
       comment = note.comments.create!(attributes)
 
       note.comments.map(&:author).uniq.each do |user|
       comment = note.comments.create!(attributes)
 
       note.comments.map(&:author).uniq.each do |user|

-        Notifier.note_comment_notification(comment, user).deliver_later if notify && user && user != current_user && user.visible?
+        UserMailer.note_comment_notification(comment, user).deliver_later if notify && user && user != current_user && user.visible?

       end
     end
   end
       end
     end
   end