Fix more rubocop style issues

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

diff --git a/app/controllers/notes_controller.rb b/app/controllers/notes_controller.rb
index fe3615d7a0965e4290a21b5eb47fc00c9203ac63..5bdf28862636ae28708684c06e2b8e4c676c1958 100644 (file)
--- a/app/controllers/notes_controller.rb
+++ b/app/controllers/notes_controller.rb
@@ -1,11 +1,14 @@
 class NotesController < ApplicationController
 class NotesController < ApplicationController

-
-  layout 'site', :only => [:mine]
+  layout "site", :only => [:mine]

 
   before_filter :check_api_readable
 
   before_filter :check_api_readable

-  before_filter :authorize_web, :only => [:create, :close, :update, :delete, :mine]
-  before_filter :check_api_writable, :only => [:create, :close, :update, :delete]
-  before_filter :set_locale, :only => [:mine]
+  before_filter :authorize_web, :only => [:mine]
+  before_filter :setup_user_auth, :only => [:create, :comment]
+  before_filter :authorize, :only => [:close, :reopen, :destroy]
+  before_filter :require_moderator, :only => [:destroy]
+  before_filter :check_api_writable, :only => [:create, :comment, :close, :reopen, :destroy]
+  before_filter :require_allow_write_notes, :only => [:create, :comment, :close, :reopen, :destroy]
+  before_filter :set_locale

   after_filter :compress_output
   around_filter :api_call_handle_error, :api_call_timeout
 
   after_filter :compress_output
   around_filter :api_call_handle_error, :api_call_timeout
 


@@ -17,16 +20,16 @@ class NotesController < ApplicationController
     if params[:bbox]
       bbox = BoundingBox.from_bbox_params(params)
     else
     if params[:bbox]
       bbox = BoundingBox.from_bbox_params(params)
     else

-      raise OSM::APIBadUserInput.new("No l was given") unless params[:l]
-      raise OSM::APIBadUserInput.new("No r was given") unless params[:r]
-      raise OSM::APIBadUserInput.new("No b was given") unless params[:b]
-      raise OSM::APIBadUserInput.new("No t was given") unless params[:t]
+      fail OSM::APIBadUserInput.new("No l was given") unless params[:l]
+      fail OSM::APIBadUserInput.new("No r was given") unless params[:r]
+      fail OSM::APIBadUserInput.new("No b was given") unless params[:b]
+      fail OSM::APIBadUserInput.new("No t was given") unless params[:t]

 
       bbox = BoundingBox.from_lrbt_params(params)
     end
 
     # Get any conditions that need to be applied
 
       bbox = BoundingBox.from_lrbt_params(params)
     end
 
     # Get any conditions that need to be applied

-    notes = closed_condition(Note.scoped)
+    notes = closed_condition(Note.all)

 
     # Check that the boundaries are valid
     bbox.check_boundaries
 
     # Check that the boundaries are valid
     bbox.check_boundaries


@@ -49,105 +52,136 @@ class NotesController < ApplicationController
   ##
   # Create a new note
   def create
   ##
   # Create a new note
   def create

+    # Check the ACLs
+    fail OSM::APIAccessDenied if Acl.no_note_comment(request.remote_ip)
+

     # Check the arguments are sane
     # Check the arguments are sane

-    raise OSM::APIBadUserInput.new("No lat was given") unless params[:lat]
-    raise OSM::APIBadUserInput.new("No lon was given") unless params[:lon]
-    raise OSM::APIBadUserInput.new("No text was given") unless params[:text]
+    fail OSM::APIBadUserInput.new("No lat was given") unless params[:lat]
+    fail OSM::APIBadUserInput.new("No lon was given") unless params[:lon]
+    fail OSM::APIBadUserInput.new("No text was given") if params[:text].blank?

 
     # Extract the arguments
 
     # Extract the arguments

-    lon = params[:lon].to_f
-    lat = params[:lat].to_f
+    lon = OSM.parse_float(params[:lon], OSM::APIBadUserInput, "lon was not a number")
+    lat = OSM.parse_float(params[:lat], OSM::APIBadUserInput, "lat was not a number")

     comment = params[:text]
     comment = params[:text]

-    name = params[:name]

 
     # Include in a transaction to ensure that there is always a note_comment for every note
     Note.transaction do
       # Create the note
       @note = Note.create(:lat => lat, :lon => lon)
 
     # Include in a transaction to ensure that there is always a note_comment for every note
     Note.transaction do
       # Create the note
       @note = Note.create(:lat => lat, :lon => lon)

-      raise OSM::APIBadUserInput.new("The note is outside this world") unless @note.in_world?
-
-      #TODO: move this into a helper function
-      begin
-        url = "http://nominatim.openstreetmap.org/reverse?lat=" + lat.to_s + "&lon=" + lon.to_s + "&zoom=16" 
-        response = REXML::Document.new(Net::HTTP.get(URI.parse(url))) 
-               
-        if result = response.get_text("reversegeocode/result") 
-          @note.nearby_place = result.to_s 
-        else 
-          @note.nearby_place = "unknown"
-        end
-      rescue Exception => err
-        @note.nearby_place = "unknown"
-      end
+      fail OSM::APIBadUserInput.new("The note is outside this world") unless @note.in_world?

 
       # Save the note
       @note.save!
 
       # Add a comment to the note
 
       # Save the note
       @note.save!
 
       # Add a comment to the note

-      add_comment(@note, comment, name, "opened")
+      add_comment(@note, comment, "opened")

     end
 
     end
 

-    # Send an OK response
-    render_ok
+    # Return a copy of the new 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
   end
 
   ##
   # Add a comment to an existing note
   def comment

+    # Check the ACLs
+    fail OSM::APIAccessDenied if Acl.no_note_comment(request.remote_ip)
+

     # Check the arguments are sane
     # Check the arguments are sane

-    raise OSM::APIBadUserInput.new("No id was given") unless params[:id]
-    raise OSM::APIBadUserInput.new("No text was given") unless params[:text]
+    fail OSM::APIBadUserInput.new("No id was given") unless params[:id]
+    fail OSM::APIBadUserInput.new("No text was given") if params[:text].blank?

 
     # Extract the arguments
     id = params[:id].to_i
     comment = params[:text]
 
     # Extract the arguments
     id = params[:id].to_i
     comment = params[:text]

-    name = params[:name] or "NoName"

 
     # Find the note and check it is valid
 
     # Find the note and check it is valid

-    note = Note.find(id)
-    raise OSM::APINotFoundError unless note
-    raise OSM::APIAlreadyDeletedError unless note.visible?
+    @note = Note.find(id)
+    fail OSM::APINotFoundError unless @note
+    fail OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?
+    fail OSM::APINoteAlreadyClosedError.new(@note) if @note.closed?

 
     # Add a comment to the note
     Note.transaction do
 
     # Add a comment to the note
     Note.transaction do

-      add_comment(note, comment, name, "commented")
+      add_comment(@note, comment, "commented")

     end
 
     end
 

-    # Send an OK response
-    render_ok
+    # Return a copy of the updated note
+    respond_to do |format|
+      format.xml { render :action => :show }
+      format.json { render :action => :show }
+    end

   end
 
   ##
   # Close a note
   def close
     # Check the arguments are sane
   end
 
   ##
   # Close a note
   def close
     # Check the arguments are sane

-    raise OSM::APIBadUserInput.new("No id was given") unless params[:id]
+    fail OSM::APIBadUserInput.new("No id was given") unless params[:id]

 
     # Extract the arguments
     id = params[:id].to_i
 
     # Extract the arguments
     id = params[:id].to_i

-    name = params[:name]
+    comment = params[:text]

 
     # Find the note and check it is valid
 
     # Find the note and check it is valid

-    note = Note.find_by_id(id)
-    raise OSM::APINotFoundError unless note
-    raise OSM::APIAlreadyDeletedError unless note.visible?
+    @note = Note.find_by_id(id)
+    fail OSM::APINotFoundError unless @note
+    fail OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?
+    fail OSM::APINoteAlreadyClosedError.new(@note) if @note.closed?

 
     # Close the note and add a comment
     Note.transaction do
 
     # Close the note and add a comment
     Note.transaction do

-      note.close
+      @note.close
+
+      add_comment(@note, comment, "closed")
+    end
+
+    # Return a copy of the updated note
+    respond_to do |format|
+      format.xml { render :action => :show }
+      format.json { render :action => :show }
+    end
+  end
+
+  ##
+  # Reopen a note
+  def reopen
+    # Check the arguments are sane
+    fail OSM::APIBadUserInput.new("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_by_id(id)
+    fail OSM::APINotFoundError unless @note
+    fail OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible? || @user.moderator?
+    fail OSM::APINoteAlreadyOpenError.new(@note) unless @note.closed? || !@note.visible?
+
+    # Reopen the note and add a comment
+    Note.transaction do
+      @note.reopen

 
 

-      add_comment(note, nil, name, "closed")
+      add_comment(@note, comment, "reopened")

     end
 
     end
 

-    # Send an OK response
-    render_ok
-  end 
+    # Return a copy of the updated note
+    respond_to do |format|
+      format.xml { render :action => :show }
+      format.json { render :action => :show }
+    end
+  end

 
   ##
   # Get a feed of recent notes and comments
   def feed
     # Get any conditions that need to be applied
 
   ##
   # Get a feed of recent notes and comments
   def feed
     # Get any conditions that need to be applied

-    notes = closed_condition(Note.scoped)
+    notes = closed_condition(Note.all)

 
     # Process any bbox
     if params[:bbox]
 
     # Process any bbox
     if params[:bbox]


@@ -172,13 +206,13 @@ class NotesController < ApplicationController
   # Read a note
   def show
     # Check the arguments are sane
   # Read a note
   def show
     # Check the arguments are sane

-    raise OSM::APIBadUserInput.new("No id was given") unless params[:id]
+    fail OSM::APIBadUserInput.new("No id was given") unless params[:id]

 
     # Find the note and check it is valid
     @note = Note.find(params[:id])
 
     # Find the note and check it is valid
     @note = Note.find(params[:id])

-    raise OSM::APINotFoundError unless @note
-    raise OSM::APIAlreadyDeletedError unless @note.visible?
-    
+    fail OSM::APINotFoundError unless @note
+    fail OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?
+

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


@@ -192,38 +226,41 @@ class NotesController < ApplicationController
   # Delete (hide) a note
   def destroy
     # Check the arguments are sane
   # Delete (hide) a note
   def destroy
     # Check the arguments are sane

-    raise OSM::APIBadUserInput.new("No id was given") unless params[:id]
+    fail OSM::APIBadUserInput.new("No id was given") unless params[:id]

 
     # Extract the arguments
     id = params[:id].to_i
 
     # Extract the arguments
     id = params[:id].to_i

-    name = params[:name]
+    comment = params[:text]

 
     # Find the note and check it is valid
 
     # Find the note and check it is valid

-    note = Note.find(id)
-    raise OSM::APINotFoundError unless note
-    raise OSM::APIAlreadyDeletedError unless note.visible?
+    @note = Note.find(id)
+    fail OSM::APINotFoundError unless @note
+    fail OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?

 
     # Mark the note as hidden
     Note.transaction do
 
     # Mark the note as hidden
     Note.transaction do

-      note.status = "hidden"
-      note.save
+      @note.status = "hidden"
+      @note.save

 
 

-      add_comment(note, nil, name, "hidden")
+      add_comment(@note, comment, "hidden", false)

     end
 
     end
 

-    # Render the result
-    render :text => "ok\n", :content_type => "text/html" 
+    # 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
     # Check the arguments are sane
   end
 
   ##
   # Return a list of notes matching a given string
   def search
     # Check the arguments are sane

-    raise OSM::APIBadUserInput.new("No query string was given") unless params[:q]
+    fail OSM::APIBadUserInput.new("No query string was given") unless params[:q]

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

-    @notes = closed_condition(Note.scoped)
-    @notes = @notes.joins(:comments).where("note_comments.body ~ ?", params[:q])
+    @notes = closed_condition(Note.all)
+    @notes = @notes.joins(:comments).where("to_tsvector('english', note_comments.body) @@ plainto_tsquery('english', ?)", params[:q])

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


@@ -240,33 +277,34 @@ class NotesController < ApplicationController
   ##
   # Display a list of notes by a specified user
   def mine
   ##
   # Display a list of notes by a specified user
   def mine

-    if params[:display_name] 
+    if params[:display_name]

       if @this_user = User.active.find_by_display_name(params[:display_name])
       if @this_user = User.active.find_by_display_name(params[:display_name])

-        @title =  t 'note.mine.title', :user => @this_user.display_name 
-        @heading =  t 'note.mine.heading', :user => @this_user.display_name 
-        @description = t 'note.mine.description', :user => render_to_string(:partial => "user", :object => @this_user)
-        @page = (params[:page] || 1).to_i 
+        @title =  t "note.mine.title", :user => @this_user.display_name
+        @heading =  t "note.mine.heading", :user => @this_user.display_name
+        @description = t "note.mine.subheading", :user => render_to_string(:partial => "user", :object => @this_user)
+        @page = (params[:page] || 1).to_i

         @page_size = 10
         @page_size = 10

-        @notes = @this_user.notes.order("updated_at DESC").offset((@page - 1) * @page_size).limit(@page_size).preload(:comments => :author)
+        @notes = @this_user.notes.order("updated_at DESC, id").uniq.offset((@page - 1) * @page_size).limit(@page_size).preload(:comments => :author).to_a

       else
       else

-        @title = t 'user.no_such_user.title' 
-        @not_found_user = params[:display_name] 
+        @title = t "user.no_such_user.title"
+        @not_found_user = params[:display_name]

 
 

-        render :template => 'user/no_such_user', :status => :not_found 
-      end 
+        render :template => "user/no_such_user", :status => :not_found
+      end

     end
   end
 
     end
   end
 

-private 
-  #------------------------------------------------------------ 
-  # utility functions below. 
-  #------------------------------------------------------------   
- 
+  private
+
+  #------------------------------------------------------------
+  # utility functions below.
+  #------------------------------------------------------------
+

   ##
   # Render an OK response
   def render_ok
     if params[:format] == "js"
   ##
   # Render an OK response
   def render_ok
     if params[:format] == "js"

-      render :text => "osbResponse();", :content_type => "text/javascript" 
+      render :text => "osbResponse();", :content_type => "text/javascript"

     else
       render :text => "ok " + @note.id.to_s + "\n", :content_type => "text/plain" if @note
       render :text => "ok\n", :content_type => "text/plain" unless @note
     else
       render :text => "ok " + @note.id.to_s + "\n", :content_type => "text/plain" if @note
       render :text => "ok\n", :content_type => "text/plain" unless @note


@@ -276,8 +314,12 @@ private
   ##
   # Get the maximum number of results to return
   def result_limit
   ##
   # Get the maximum number of results to return
   def result_limit

-    if params[:limit] and params[:limit].to_i > 0 and params[:limit].to_i < 10000
-      params[:limit].to_i
+    if params[:limit]
+      if params[:limit].to_i > 0 && params[:limit].to_i <= 10000
+        params[:limit].to_i
+      else
+        fail OSM::APIBadUserInput.new("Note limit must be between 1 and 10000")
+      end

     else
       100
     end
     else
       100
     end


@@ -292,7 +334,7 @@ private
     else
       closed_since = 7
     end
     else
       closed_since = 7
     end

-       
+

     if closed_since < 0
       notes = notes.where("status != 'hidden'")
     elsif closed_since > 0
     if closed_since < 0
       notes = notes.where("status != 'hidden'")
     elsif closed_since > 0


@@ -301,29 +343,25 @@ private
       notes = notes.where("status = 'open'")
     end
 
       notes = notes.where("status = 'open'")
     end
 

-    return notes
+    notes

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

-  def add_comment(note, text, name, event)
-    name = "NoName" if name.nil?
-
+  def add_comment(note, text, event, notify = true)

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

-    if @user  
+    if @user

       attributes[:author_id] = @user.id
       attributes[:author_id] = @user.id

-      attributes[:author_name] = @user.display_name
-    else  
+    else

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

-      attributes[:author_name] = name + " (a)"

     end
 
     end
 

-    note.comments.create(attributes, :without_protection => true)
+    comment = note.comments.create(attributes)

 
 

-    note.comments.map { |c| c.author }.uniq.each do |user|
-      if user and user != @user
-        Notifier.deliver_note_comment_notification(comment, user)
+    note.comments.map(&:author).uniq.each do |user|
+      if notify && user && user != @user
+        Notifier.note_comment_notification(comment, user).deliver_now

       end
     end
   end
       end
     end
   end