X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/97e0d5ad1f89b4717ddcc5d7280dc6c39341aa93..edfbbf7336a38162b2d996ebca21918a5d6039a0:/app/controllers/notes_controller.rb diff --git a/app/controllers/notes_controller.rb b/app/controllers/notes_controller.rb index b7d6631ae..ea32441f2 100644 --- a/app/controllers/notes_controller.rb +++ b/app/controllers/notes_controller.rb @@ -1,16 +1,15 @@ class NotesController < ApplicationController - - layout 'site', :only => [:mine] - - before_filter :check_api_readable - before_filter :authorize_web, :only => [:mine] - before_filter :setup_user_auth, :only => [:create, :comment] - before_filter :authorize, :only => [:close, :destroy] - before_filter :check_api_writable, :only => [:create, :comment, :close, :destroy] - before_filter :require_allow_write_notes, :only => [:create, :comment, :close, :destroy] - before_filter :set_locale, :only => [:mine] - after_filter :compress_output - around_filter :api_call_handle_error, :api_call_timeout + layout "site", :only => [:mine] + + before_action :check_api_readable + before_action :authorize_web, :only => [:mine] + before_action :setup_user_auth, :only => [:create, :comment] + before_action :authorize, :only => [:close, :reopen, :destroy] + before_action :require_moderator, :only => [:destroy] + before_action :check_api_writable, :only => [:create, :comment, :close, :reopen, :destroy] + before_action :require_allow_write_notes, :only => [:create, :comment, :close, :reopen, :destroy] + before_action :set_locale + around_action :api_call_handle_error, :api_call_timeout ## # Return a list of notes in a given area @@ -20,16 +19,16 @@ class NotesController < ApplicationController 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 - notes = closed_condition(Note.scoped) + notes = closed_condition(Note.all) # Check that the boundaries are valid bbox.check_boundaries @@ -52,21 +51,24 @@ class NotesController < ApplicationController ## # 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 - 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") if params[:text].blank? + 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 - 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] # 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? + fail OSM::APIBadUserInput.new("The note is outside this world") unless @note.in_world? # Save the note @note.save! @@ -85,9 +87,12 @@ class NotesController < ApplicationController ## # 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 - raise OSM::APIBadUserInput.new("No id was given") unless params[:id] - raise OSM::APIBadUserInput.new("No text was given") if params[:text].blank? + 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 @@ -95,9 +100,9 @@ class NotesController < ApplicationController # 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.new(@note) if @note.closed? + 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 @@ -115,7 +120,7 @@ class NotesController < ApplicationController # 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 @@ -123,9 +128,9 @@ class NotesController < ApplicationController # 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.new(@note) if @note.closed? + 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 @@ -139,13 +144,43 @@ class NotesController < ApplicationController format.xml { render :action => :show } format.json { render :action => :show } end - 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, comment, "reopened") + 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 - notes = closed_condition(Note.scoped) + notes = closed_condition(Note.all) # Process any bbox if params[:bbox] @@ -170,12 +205,12 @@ class NotesController < ApplicationController # 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]) - raise OSM::APINotFoundError unless @note - raise OSM::APIAlreadyDeletedError.new("note", @note.id) 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| @@ -190,37 +225,41 @@ class NotesController < ApplicationController # 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 + 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? + @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 - note.status = "hidden" - note.save + @note.status = "hidden" + @note.save - add_comment(note, nil, "hidden") + add_comment(@note, comment, "hidden", false) 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 - 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 - @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) @@ -237,44 +276,38 @@ class NotesController < ApplicationController ## # 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]) - @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 + @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 - @notes = @this_user.notes.order("updated_at DESC, id").uniq.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] + @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 -private - #------------------------------------------------------------ - # utility functions below. - #------------------------------------------------------------ - - ## - # Render an OK response - def render_ok - if params[:format] == "js" - 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 - end - end + private + + #------------------------------------------------------------ + # utility functions below. + #------------------------------------------------------------ ## # 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 @@ -289,7 +322,7 @@ private else closed_since = 7 end - + if closed_since < 0 notes = notes.where("status != 'hidden'") elsif closed_since > 0 @@ -298,25 +331,25 @@ private notes = notes.where("status = 'open'") end - return notes + notes end ## # Add a comment to a note - def add_comment(note, text, event) + def add_comment(note, text, event, notify = true) attributes = { :visible => true, :event => event, :body => text } - if @user + if @user attributes[:author_id] = @user.id - else + else attributes[:author_ip] = request.remote_ip end - comment = 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.note_comment_notification(comment, user).deliver + note.comments.map(&:author).uniq.each do |user| + if notify && user && user != @user + Notifier.note_comment_notification(comment, user).deliver_now end end end