services/api/app/controllers/application_controller.rb

   1 class ApplicationController < ActionController::Base
   2   include CurrentApiClient
   3
   4   protect_from_forgery
   5   before_filter :uncamelcase_params_hash_keys
   6   around_filter :thread_with_auth_info, :except => [:render_error, :render_not_found]
   7
   8   before_filter :remote_ip
   9   before_filter :login_required, :except => :render_not_found
  10   before_filter :catch_redirect_hint
  11
  12   before_filter :load_where_param, :only => :index
  13   before_filter :find_objects_for_index, :only => :index
  14   before_filter :find_object_by_uuid, :except => [:index, :create]
  15
  16   attr_accessor :resource_attrs
  17
  18   def index
  19     @objects.uniq!(&:id)
  20     if params[:eager] and params[:eager] != '0' and params[:eager] != 0 and params[:eager] != ''
  21       @objects.each(&:eager_load_associations)
  22     end
  23     render_list
  24   end
  25
  26   def show
  27     if @object
  28       render json: @object.as_api_response(:superuser)
  29     else
  30       render_not_found("object not found")
  31     end
  32   end
  33
  34   def create
  35     @object = model_class.new resource_attrs
  36     @object.save
  37     show
  38   end
  39
  40   def update
  41     attrs_to_update = resource_attrs.reject { |k,v| [:kind,:etag].index k }
  42     if @object.update_attributes attrs_to_update
  43       show
  44     else
  45       render json: { errors: @object.errors.full_messages }, status: 422
  46     end
  47   end
  48
  49   def destroy
  50     @object.destroy
  51     show
  52   end
  53
  54   def catch_redirect_hint
  55     if !current_user
  56       if params.has_key?('redirect_to') then
  57         session[:redirect_to] = params[:redirect_to]
  58       end
  59     end
  60   end
  61
  62   begin
  63     rescue_from Exception,
  64     :with => :render_error
  65     rescue_from ActiveRecord::RecordNotFound,
  66     :with => :render_not_found
  67     rescue_from ActionController::RoutingError,
  68     :with => :render_not_found
  69     rescue_from ActionController::UnknownController,
  70     :with => :render_not_found
  71     rescue_from ActionController::UnknownAction,
  72     :with => :render_not_found
  73     rescue_from ArvadosModel::PermissionDeniedError,
  74     :with => :render_error
  75   end
  76
  77   def render_error(e)
  78     logger.error e.inspect
  79     logger.error e.backtrace.collect { |x| x + "\n" }.join('') if e.backtrace
  80     if @object and @object.errors and @object.errors.full_messages and not @object.errors.full_messages.empty?
  81       errors = @object.errors.full_messages
  82     else
  83       errors = [e.inspect]
  84     end
  85     render json: { errors: errors }, status: 422
  86   end
  87
  88   def render_not_found(e=ActionController::RoutingError.new("Path not found"))
  89     logger.error e.inspect
  90     render json: { errors: ["Path not found"] }, status: 404
  91   end
  92
  93   protected
  94
  95   def load_where_param
  96     @where = params[:where] || {}
  97     @where = Oj.load(@where) if @where.is_a?(String)
  98   end
  99
 100   def find_objects_for_index
 101     uuid_list = [current_user.uuid, *current_user.groups_i_can(:read)]
 102     sanitized_uuid_list = uuid_list.
 103       collect { |uuid| model_class.sanitize(uuid) }.join(', ')
 104     or_references_me = ''
 105     if model_class == Link and current_user
 106       or_references_me = "OR #{model_class.sanitize current_user.uuid} IN (#{table_name}.head_uuid, #{table_name}.tail_uuid)"
 107     end
 108     @objects ||= model_class.
 109       joins("LEFT JOIN links permissions ON permissions.head_uuid in (#{table_name}.owner, #{table_name}.uuid) AND permissions.tail_uuid in (#{sanitized_uuid_list}) AND permissions.link_class='permission'").
 110       where("?=? OR #{table_name}.owner in (?) OR #{table_name}.uuid=? OR permissions.head_uuid IS NOT NULL #{or_references_me}",
 111             true, current_user.is_admin,
 112             uuid_list,
 113             current_user.uuid)
 114     if !@where.empty?
 115       conditions = ['1=1']
 116       @where.each do |attr,value|
 117         if attr == 'any' or attr == :any
 118           if value.is_a?(Array) and
 119               value[0] == 'contains' and
 120               model_class.columns.collect(&:name).index('name') then
 121             conditions[0] << " and #{table_name}.name ilike ?"
 122             conditions << "%#{value[1]}%"
 123           end
 124         elsif attr.to_s.match(/^[a-z][_a-z0-9]+$/) and
 125             model_class.columns.collect(&:name).index(attr.to_s)
 126           if value.nil?
 127             conditions[0] << " and #{table_name}.#{attr} is ?"
 128             conditions << nil
 129           elsif value.is_a? Array
 130             conditions[0] << " and #{table_name}.#{attr} in (?)"
 131             conditions << value
 132           elsif value.is_a? String or value.is_a? Fixnum or value == true or value == false
 133             conditions[0] << " and #{table_name}.#{attr}=?"
 134             conditions << value
 135           elsif value.is_a? Hash
 136             # Not quite the same thing as "equal?" but better than nothing?
 137             value.each do |k,v|
 138               if v.is_a? String
 139                 conditions[0] << " and #{table_name}.#{attr} ilike ?"
 140                 conditions << "%#{k}%#{v}%"
 141               end
 142             end
 143           end
 144         end
 145       end
 146       if conditions.length > 1
 147         conditions[0].sub!(/^1=1 and /, '')
 148         @objects = @objects.
 149           where(*conditions)
 150       end
 151     end
 152     if params[:limit]
 153       begin
 154         @objects = @objects.limit(params[:limit].to_i)
 155       rescue
 156         raise ArgumentError.new("Invalid value for limit parameter")
 157       end
 158     else
 159       @objects = @objects.limit(100)
 160     end
 161     orders = []
 162     if params[:order]
 163       params[:order].split(',').each do |order|
 164         attr, direction = order.strip.split " "
 165         direction ||= 'asc'
 166         if attr.match /^[a-z][_a-z0-9]+$/ and
 167             model_class.columns.collect(&:name).index(attr) and
 168             ['asc','desc'].index direction.downcase
 169           orders << "#{table_name}.#{attr} #{direction.downcase}"
 170         end
 171       end
 172     end
 173     if orders.empty?
 174       orders << "#{table_name}.modified_at desc"
 175     end
 176     @objects = @objects.order(orders.join ", ")
 177   end
 178
 179   def resource_attrs
 180     return @attrs if @attrs
 181     @attrs = params[resource_name]
 182     if @attrs.is_a? String
 183       @attrs = uncamelcase_hash_keys(Oj.load @attrs)
 184     end
 185     unless @attrs.is_a? Hash
 186       message = "No #{resource_name}"
 187       if resource_name.index('_')
 188         message << " (or #{resource_name.camelcase(:lower)})"
 189       end
 190       message << " hash provided with request"
 191       raise ArgumentError.new(message)
 192     end
 193     %w(created_at modified_by_client modified_by_user modified_at).each do |x|
 194       @attrs.delete x
 195     end
 196     @attrs
 197   end
 198
 199   # Authentication
 200   def login_required
 201     if !current_user
 202       respond_to do |format|
 203         format.html  {
 204           redirect_to '/auth/joshid'
 205         }
 206         format.json {
 207           render :json => { errors: ['Not logged in'] }.to_json
 208         }
 209       end
 210     end
 211   end
 212
 213   def admin_required
 214     unless current_user and current_user.is_admin
 215       render :json => { errors: ['Forbidden'] }.to_json, status: 403
 216     end
 217   end
 218
 219   def thread_with_auth_info
 220     begin
 221       user = nil
 222       api_client = nil
 223       api_client_auth = nil
 224       supplied_token =
 225         params[:api_token] ||
 226         params[:oauth_token] ||
 227         request.headers["Authorization"].andand.match(/OAuth2 ([a-z0-9]+)/).andand[1]
 228       if supplied_token
 229         api_client_auth = ApiClientAuthorization.
 230           includes(:api_client, :user).
 231           where('api_token=?', supplied_token).
 232           first
 233         if api_client_auth
 234           session[:user_id] = api_client_auth.user.id
 235           session[:api_client_uuid] = api_client_auth.api_client.uuid
 236           session[:api_client_authorization_id] = api_client_auth.id
 237           user = api_client_auth.user
 238           api_client = api_client_auth.api_client
 239         end
 240       elsif session[:user_id]
 241         user = User.find(session[:user_id]) rescue nil
 242         api_client = ApiClient.
 243           where('uuid=?',session[:api_client_uuid]).
 244           first rescue nil
 245         if session[:api_client_authorization_id] then
 246           api_client_auth = ApiClientAuthorization.
 247             find session[:api_client_authorization_id]
 248         end
 249       end
 250       Thread.current[:api_client_trusted] = session[:api_client_trusted]
 251       Thread.current[:api_client_ip_address] = remote_ip
 252       Thread.current[:api_client_authorization] = api_client_auth
 253       Thread.current[:api_client_uuid] = api_client && api_client.uuid
 254       Thread.current[:api_client] = api_client
 255       Thread.current[:user] = user
 256       yield
 257     ensure
 258       Thread.current[:api_client_trusted] = nil
 259       Thread.current[:api_client_ip_address] = nil
 260       Thread.current[:api_client_authorization] = nil
 261       Thread.current[:api_client_uuid] = nil
 262       Thread.current[:api_client] = nil
 263       Thread.current[:user] = nil
 264     end
 265   end
 266   # /Authentication
 267
 268   def model_class
 269     controller_name.classify.constantize
 270   end
 271
 272   def resource_name             # params[] key used by client
 273     controller_name.singularize
 274   end
 275
 276   def table_name
 277     controller_name
 278   end
 279
 280   def find_object_by_uuid
 281     if params[:id] and params[:id].match /\D/
 282       params[:uuid] = params.delete :id
 283     end
 284     @object = model_class.where('uuid=?', params[:uuid]).first
 285   end
 286
 287   def self.accept_attribute_as_json(attr, force_class=nil)
 288     before_filter lambda { accept_attribute_as_json attr, force_class }
 289   end
 290   def accept_attribute_as_json(attr, force_class)
 291     if params[resource_name].is_a? Hash
 292       if params[resource_name][attr].is_a? String
 293         params[resource_name][attr] = Oj.load params[resource_name][attr]
 294         if force_class and !params[resource_name][attr].is_a? force_class
 295           raise TypeError.new("#{resource_name}[#{attr.to_s}] must be a #{force_class.to_s}")
 296         end
 297       end
 298     end
 299   end
 300
 301   def uncamelcase_params_hash_keys
 302     self.params = uncamelcase_hash_keys(params)
 303   end
 304   def uncamelcase_hash_keys(h, max_depth=-1)
 305     if h.is_a? Hash and max_depth != 0
 306       nh = Hash.new
 307       h.each do |k,v|
 308         if k.class == String
 309           nk = k.underscore
 310         elsif k.class == Symbol
 311           nk = k.to_s.underscore.to_sym
 312         else
 313           nk = k
 314         end
 315         nh[nk] = uncamelcase_hash_keys(v, max_depth-1)
 316       end
 317       h.replace(nh)
 318     end
 319     h
 320   end
 321
 322   def render_list
 323     @object_list = {
 324       :kind  => "arvados##{resource_name}List",
 325       :etag => "",
 326       :self_link => "",
 327       :next_page_token => "",
 328       :next_link => "",
 329       :items => @objects.as_api_response(:superuser)
 330     }
 331     render json: @object_list
 332   end
 333
 334   def remote_ip
 335     # Caveat: this is highly dependent on the proxy setup. YMMV.
 336     if request.headers.has_key?('HTTP_X_REAL_IP') then
 337       # We're behind a reverse proxy
 338       @remote_ip = request.headers['HTTP_X_REAL_IP']
 339     else
 340       # Hopefully, we are not!
 341       @remote_ip = request.env['REMOTE_ADDR']
 342     end
 343   end
 344
 345   def self._index_requires_parameters
 346     {
 347       where: { type: 'object', required: false },
 348       order: { type: 'string', required: false }
 349     }
 350   end
 351 end