translating the listing of diary entries. Adding some initial tests for checking...

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

diff --git a/app/controllers/application.rb b/app/controllers/application.rb
index a4f65cd54b9d30bb095285b370b402ecabdeb818..3d16ffa6954d22db95c3f2bad0d00c70cdceef33 100644 (file)
--- a/app/controllers/application.rb
+++ b/app/controllers/application.rb
@@ -2,60 +2,155 @@
 # Likewise, all the methods added will be available for all controllers.
 class ApplicationController < ActionController::Base
 
 # Likewise, all the methods added will be available for all controllers.
 class ApplicationController < ActionController::Base
 

+  if OSM_STATUS == :database_readonly or OSM_STATUS == :database_offline
+    session :off
+  end
+

   def authorize_web
   def authorize_web

-    @user = User.find_by_token(session[:token])
+    if session[:user]
+      @user = User.find(session[:user], :conditions => {:visible => true})
+    elsif session[:token]
+      @user = User.authenticate(:token => session[:token])
+      session[:user] = @user.id
+    end
+  rescue Exception => ex
+    logger.info("Exception authorizing user: #{ex.to_s}")
+    @user = nil
+  end
+
+  def require_user
+    redirect_to :controller => 'user', :action => 'login', :referer => request.request_uri unless @user

   end
 
   end
 

-  def authorize(realm='Web Password', errormessage="Could't authenticate you") \r
-    username, passwd = get_auth_data # parse from headers\r
+  ##
+  # sets up the @user object for use by other methods. this is mostly called
+  # from the authorize method, but can be called elsewhere if authorisation
+  # is optional.
+  def setup_user_auth
+    username, passwd = get_auth_data # parse from headers

     # authenticate per-scheme
     # authenticate per-scheme

-    if username.nil?\r
-      @user = nil # no authentication provided - perhaps first connect (client should retry after 401)\r
-    elsif username == 'token' \r
-      @user = User.authenticate_token(passwd) # preferred - random token for user from db, passed in basic auth\r
-    else\r
-      @user = User.authenticate(username, passwd) # basic auth\r
-    end\r
-    \r
-    # handle authenticate pass/fail\r
-    if @user
-      # user exists and password is correct ... horray! 
-      if @user.methods.include? 'lastlogin'         # note last login 
-        @session['lastlogin'] = user.lastlogin 
-        @user.last.login = Time.now 
-        @user.save() 
-        @session["User.id"] = @user.id 
-      end             
-    else 
+    if username.nil?
+      @user = nil # no authentication provided - perhaps first connect (client should retry after 401)
+    elsif username == 'token' 
+      @user = User.authenticate(:token => passwd) # preferred - random token for user from db, passed in basic auth
+    else
+      @user = User.authenticate(:username => username, :password => passwd) # basic auth
+    end
+  end
+
+  def authorize(realm='Web Password', errormessage="Couldn't authenticate you") 
+    # make the @user object from any auth sources we have
+    setup_user_auth
+
+    # handle authenticate pass/fail
+    unless @user

       # no auth, the user does not exist or the password was wrong
       response.headers["Status"] = "Unauthorized" 
       response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\"" 
       # no auth, the user does not exist or the password was wrong
       response.headers["Status"] = "Unauthorized" 
       response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\"" 

-      render_text(errormessage, 401) # :unauthorized
+      render :text => errormessage, :status => :unauthorized
+      return false

     end 
   end 
 
     end 
   end 
 

-  def get_xml_doc
-    doc = XML::Document.new
-    doc.encoding = 'UTF-8' 
-    root = XML::Node.new 'osm'
-    root['version'] = API_VERSION
-    root['generator'] = 'OpenStreetMap server'
-    doc.root = root
-    return doc
+  def check_database_readable(need_api = false)
+    if OSM_STATUS == :database_offline or (need_api and OSM_STATUS == :api_offline)
+      redirect_to :controller => 'site', :action => 'offline'
+    end
+  end
+
+  def check_database_writable(need_api = false)
+    if OSM_STATUS == :database_offline or OSM_STATUS == :database_readonly or
+       (need_api and (OSM_STATUS == :api_offline or OSM_STATUS == :api_readonly))
+      redirect_to :controller => 'site', :action => 'offline'
+    end
+  end
+
+  def check_api_readable
+    if OSM_STATUS == :database_offline or OSM_STATUS == :api_offline
+      response.headers['Error'] = "Database offline for maintenance"
+      render :nothing => true, :status => :service_unavailable
+      return false
+    end
+  end
+
+  def check_api_writable
+    if OSM_STATUS == :database_offline or OSM_STATUS == :database_readonly or
+       OSM_STATUS == :api_offline or OSM_STATUS == :api_readonly
+      response.headers['Error'] = "Database offline for maintenance"
+      render :nothing => true, :status => :service_unavailable
+      return false
+    end

   end
 
   end
 

-  # extract authorisation credentials from headers, returns user = nil if none\r
-  private 
+  def require_public_data
+    unless @user.data_public?
+      response.headers['Error'] = "You must make your edits public to upload new data"
+      render :nothing => true, :status => :forbidden
+      return false
+    end
+  end
+
+  # Report and error to the user
+  # (If anyone ever fixes Rails so it can set a http status "reason phrase",
+  #  rather than only a status code and having the web engine make up a 
+  #  phrase from that, we can also put the error message into the status
+  #  message. For now, rails won't let us)
+  def report_error(message, status = :bad_request)
+    # Todo: some sort of escaping of problem characters in the message
+    response.headers['Error'] = message
+    render :text => message, :status => status
+  end
+  
+  def set_locale
+    I18n.locale = request.compatible_language_from(I18n.available_locales)
+  end
+
+  def api_call_handle_error
+    begin
+      yield
+    rescue ActiveRecord::RecordNotFound => ex
+      render :nothing => true, :status => :not_found
+    rescue LibXML::XML::Error, ArgumentError => ex
+      report_error ex.message, :bad_request
+    rescue ActiveRecord::RecordInvalid => ex
+      message = "#{ex.record.class} #{ex.record.id}: "
+      ex.record.errors.each { |attr,msg| message << "#{attr}: #{msg} (#{ex.record[attr].inspect})" }
+      report_error message, :bad_request
+    rescue OSM::APIError => ex
+      report_error ex.message, ex.status
+    rescue Exception => ex
+      report_error "#{ex.class}: #{ex.message}", :internal_server_error
+    end
+  end
+
+  ##
+  # asserts that the request method is the +method+ given as a parameter
+  # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
+  def assert_method(method)
+    ok = request.send((method.to_s.downcase + "?").to_sym)
+    raise OSM::APIBadMethodError.new(method) unless ok
+  end
+
+  def api_call_timeout
+    Timeout::timeout(APP_CONFIG['api_timeout'], OSM::APITimeoutError) do
+      yield
+    end
+  end
+
+private 
+  # extract authorisation credentials from headers, returns user = nil if none

   def get_auth_data 
     if request.env.has_key? 'X-HTTP_AUTHORIZATION'          # where mod_rewrite might have put it 
       authdata = request.env['X-HTTP_AUTHORIZATION'].to_s.split 
   def get_auth_data 
     if request.env.has_key? 'X-HTTP_AUTHORIZATION'          # where mod_rewrite might have put it 
       authdata = request.env['X-HTTP_AUTHORIZATION'].to_s.split 

+    elsif request.env.has_key? 'REDIRECT_X_HTTP_AUTHORIZATION'          # mod_fcgi 
+      authdata = request.env['REDIRECT_X_HTTP_AUTHORIZATION'].to_s.split 

     elsif request.env.has_key? 'HTTP_AUTHORIZATION'         # regular location
       authdata = request.env['HTTP_AUTHORIZATION'].to_s.split
     end 
     # only basic authentication supported
     if authdata and authdata[0] == 'Basic' 
     elsif request.env.has_key? 'HTTP_AUTHORIZATION'         # regular location
       authdata = request.env['HTTP_AUTHORIZATION'].to_s.split
     end 
     # only basic authentication supported
     if authdata and authdata[0] == 'Basic' 

-      user, pass = Base64.decode64(authdata[1]).split(':')[0..1] 
-    end \r
+      user, pass = Base64.decode64(authdata[1]).split(':',2)
+    end 

     return [user, pass] 
   end 
 
     return [user, pass] 
   end