More refactoring of common code in object models

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

diff --git a/app/controllers/notes_controller.rb b/app/controllers/notes_controller.rb
index bf9d0187fd00c9896b08a7f8246fef41301d0ce1..333597a722724835662c9fd4156946291a4791ed 100644 (file)
--- a/app/controllers/notes_controller.rb
+++ b/app/controllers/notes_controller.rb
@@ -3,9 +3,13 @@ class NotesController < ApplicationController
   layout 'site', :only => [:mine]
 
   before_filter :check_api_readable
   layout 'site', :only => [:mine]
 
   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
 


@@ -26,7 +30,7 @@ class NotesController < ApplicationController
     end
 
     # Get any conditions that need to be applied
     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


@@ -52,13 +56,12 @@ class NotesController < ApplicationController
     # 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]
     # 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]
+    raise 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
 
     # Include in a transaction to ensure that there is always a note_comment for every note
     Note.transaction do


@@ -66,25 +69,11 @@ class NotesController < ApplicationController
       @note = Note.create(:lat => lat, :lon => lon)
       raise OSM::APIBadUserInput.new("The note is outside this world") unless @note.in_world?
 
       @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
-

       # 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
 
     # Return a copy of the new note
     end
 
     # Return a copy of the new note


@@ -99,21 +88,21 @@ class NotesController < ApplicationController
   def comment
     # Check the arguments are sane
     raise OSM::APIBadUserInput.new("No id was given") unless params[:id]
   def comment
     # 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]
+    raise 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
     @note = Note.find(id)
     raise OSM::APINotFoundError unless @note
 
     # Find the note and check it is valid
     @note = Note.find(id)
     raise OSM::APINotFoundError unless @note

-    raise OSM::APIAlreadyDeletedError unless @note.visible?
+    raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?
+    raise 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
 
     # Return a copy of the updated note
     end
 
     # Return a copy of the updated note


@@ -132,18 +121,48 @@ class NotesController < ApplicationController
     # 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]

 
     # Find the note and check it is valid
     @note = Note.find_by_id(id)
     raise OSM::APINotFoundError unless @note
 
     # 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?
+    raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?
+    raise OSM::APINoteAlreadyClosedError.new(@note) if @note.closed?

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

-      add_comment(@note, comment, name, "closed")
+      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
+    raise 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)
+    raise OSM::APINotFoundError unless @note
+    raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible? or @user.moderator?
+    raise OSM::APINoteAlreadyOpenError.new(@note) unless @note.closed? or not @note.visible?
+
+    # Reopen the note and add a comment
+    Note.transaction do
+      @note.reopen
+
+      add_comment(@note, comment, "reopened")

     end
 
     # Return a copy of the updated note
     end
 
     # Return a copy of the updated note


@@ -157,7 +176,7 @@ class NotesController < ApplicationController
   # 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]


@@ -187,8 +206,8 @@ class NotesController < ApplicationController
     # Find the note and check it is valid
     @note = Note.find(params[:id])
     raise OSM::APINotFoundError unless @note
     # Find the note and check it is valid
     @note = Note.find(params[:id])
     raise OSM::APINotFoundError unless @note

-    raise OSM::APIAlreadyDeletedError unless @note.visible?
-    
+    raise 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


@@ -206,23 +225,26 @@ class NotesController < ApplicationController
 
     # 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)
+    raise OSM::APINotFoundError unless @note
+    raise 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
 
   ##
   end
 
   ##


@@ -232,7 +254,7 @@ class NotesController < ApplicationController
     raise OSM::APIBadUserInput.new("No query string was given") unless params[:q]
 
     # Get any conditions that need to be applied
     raise OSM::APIBadUserInput.new("No query string was given") unless params[:q]
 
     # Get any conditions that need to be applied

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

     @notes = @notes.joins(:comments).where("note_comments.body ~ ?", params[:q])
 
     # Find the notes we want to return
     @notes = @notes.joins(:comments).where("note_comments.body ~ ?", params[:q])
 
     # Find the notes we want to return


@@ -254,10 +276,10 @@ class NotesController < ApplicationController
       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 
       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)
+        @description = t 'note.mine.subheading', :user => render_to_string(:partial => "user", :object => @this_user)

         @page = (params[:page] || 1).to_i 
         @page_size = 10
         @page = (params[:page] || 1).to_i 
         @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
         @title = t 'user.no_such_user.title' 
         @not_found_user = params[:display_name] 
       else
         @title = t 'user.no_such_user.title' 
         @not_found_user = params[:display_name] 


@@ -316,23 +338,19 @@ private
 
   ##
   # Add a comment to a note
 
   ##
   # 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 }
 
     if @user  
       attributes[:author_id] = @user.id
     attributes = { :visible => true, :event => event, :body => text }
 
     if @user  
       attributes[:author_id] = @user.id

-      attributes[:author_name] = @user.display_name

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

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

     end
 
     end
 

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

 
     note.comments.map { |c| c.author }.uniq.each do |user|
 
     note.comments.map { |c| c.author }.uniq.each do |user|

-      if user and user != @user
+      if notify and user and user != @user

         Notifier.note_comment_notification(comment, user).deliver
       end
     end
         Notifier.note_comment_notification(comment, user).deliver
       end
     end