services/api/app/controllers/application_controller.rb

   1 class ApplicationController < ActionController::Base
   2   include CurrentApiClient
   3
   4   respond_to :json
   5   protect_from_forgery
   6   around_filter :thread_with_auth_info, :except => [:render_error, :render_not_found]
   7
   8   before_filter :remote_ip
   9   before_filter :require_auth_scope_all, :except => :render_not_found
  10   before_filter :catch_redirect_hint
  11
  12   before_filter :load_where_param, :only => :index
  13   before_filter :load_filters_param, :only => :index
  14   before_filter :find_objects_for_index, :only => :index
  15   before_filter :find_object_by_uuid, :except => [:index, :create,
  16                                                   :render_error,
  17                                                   :render_not_found]
  18   before_filter :reload_object_before_update, :only => :update
  19   before_filter :render_404_if_no_object, except: [:index, :create,
  20                                                    :render_error,
  21                                                    :render_not_found]
  22
  23   attr_accessor :resource_attrs
  24
  25   def index
  26     @objects.uniq!(&:id)
  27     if params[:eager] and params[:eager] != '0' and params[:eager] != 0 and params[:eager] != ''
  28       @objects.each(&:eager_load_associations)
  29     end
  30     render_list
  31   end
  32
  33   def show
  34     render json: @object.as_api_response
  35   end
  36
  37   def create
  38     @object = model_class.new resource_attrs
  39     @object.save!
  40     show
  41   end
  42
  43   def update
  44     attrs_to_update = resource_attrs.reject { |k,v|
  45       [:kind, :etag, :href].index k
  46     }
  47     @object.update_attributes! attrs_to_update
  48     show
  49   end
  50
  51   def destroy
  52     @object.destroy
  53     show
  54   end
  55
  56   def catch_redirect_hint
  57     if !current_user
  58       if params.has_key?('redirect_to') then
  59         session[:redirect_to] = params[:redirect_to]
  60       end
  61     end
  62   end
  63
  64   begin
  65     rescue_from Exception,
  66     :with => :render_error
  67     rescue_from ActiveRecord::RecordNotFound,
  68     :with => :render_not_found
  69     rescue_from ActionController::RoutingError,
  70     :with => :render_not_found
  71     rescue_from ActionController::UnknownController,
  72     :with => :render_not_found
  73     rescue_from AbstractController::ActionNotFound,
  74     :with => :render_not_found
  75     rescue_from ArvadosModel::PermissionDeniedError,
  76     :with => :render_error
  77   end
  78
  79   def render_404_if_no_object
  80     render_not_found "Object not found" if !@object
  81   end
  82
  83   def render_error(e)
  84     logger.error e.inspect
  85     if e.respond_to? :backtrace and e.backtrace
  86       logger.error e.backtrace.collect { |x| x + "\n" }.join('')
  87     end
  88     if @object and @object.errors and @object.errors.full_messages and not @object.errors.full_messages.empty?
  89       errors = @object.errors.full_messages
  90     else
  91       errors = [e.inspect]
  92     end
  93     status = e.respond_to?(:http_status) ? e.http_status : 422
  94     render json: { errors: errors }, status: status
  95   end
  96
  97   def render_not_found(e=ActionController::RoutingError.new("Path not found"))
  98     logger.error e.inspect
  99     render json: { errors: ["Path not found"] }, status: 404
 100   end
 101
 102   protected
 103
 104   def load_where_param
 105     if params[:where].nil? or params[:where] == ""
 106       @where = {}
 107     elsif params[:where].is_a? Hash
 108       @where = params[:where]
 109     elsif params[:where].is_a? String
 110       begin
 111         @where = Oj.load(params[:where])
 112         raise unless @where.is_a? Hash
 113       rescue
 114         raise ArgumentError.new("Could not parse \"where\" param as an object")
 115       end
 116     end
 117     @where = @where.with_indifferent_access
 118   end
 119
 120   def load_filters_param
 121     if params[:filters].is_a? Array
 122       @filters = params[:filters]
 123     elsif params[:filters].is_a? String
 124       begin
 125         @filters = Oj.load params[:filters]
 126         raise unless @filters.is_a? Array
 127       rescue
 128         raise ArgumentError.new("Could not parse \"filters\" param as an array")
 129       end
 130     end
 131   end
 132
 133   def find_objects_for_index
 134     @objects ||= model_class.readable_by(current_user)
 135     apply_where_limit_order_params
 136   end
 137
 138   def apply_where_limit_order_params
 139     if @filters.is_a? Array and @filters.any?
 140       cond_out = []
 141       param_out = []
 142       @filters.each do |attr, operator, operand|
 143         if !model_class.searchable_columns.index attr.to_s
 144           raise ArgumentError.new("Invalid attribute '#{attr}' in condition")
 145         end
 146         case operator.downcase
 147         when '=', '<', '<=', '>', '>=', 'like'
 148           if operand.is_a? String
 149             cond_out << "#{table_name}.#{attr} #{operator} ?"
 150             if (# any operator that operates on value rather than
 151                 # representation:
 152                 operator.match(/[<=>]/) and
 153                 model_class.attribute_column(attr).type == :datetime)
 154               operand = Time.parse operand
 155             end
 156             param_out << operand
 157           end
 158         when 'in'
 159           if operand.is_a? Array
 160             cond_out << "#{table_name}.#{attr} IN (?)"
 161             param_out << operand
 162           end
 163         end
 164       end
 165       if cond_out.any?
 166         @objects = @objects.where(cond_out.join(' AND '), *param_out)
 167       end
 168     end
 169     if @where.is_a? Hash and @where.any?
 170       conditions = ['1=1']
 171       @where.each do |attr,value|
 172         if attr == :any
 173           if value.is_a?(Array) and
 174               value.length == 2 and
 175               value[0] == 'contains' and
 176               model_class.columns.collect(&:name).index('name') then
 177             ilikes = []
 178             model_class.searchable_columns.each do |column|
 179               ilikes << "#{table_name}.#{column} ilike ?"
 180               conditions << "%#{value[1]}%"
 181             end
 182             if ilikes.any?
 183               conditions[0] << ' and (' + ilikes.join(' or ') + ')'
 184             end
 185           end
 186         elsif attr.to_s.match(/^[a-z][_a-z0-9]+$/) and
 187             model_class.columns.collect(&:name).index(attr.to_s)
 188           if value.nil?
 189             conditions[0] << " and #{table_name}.#{attr} is ?"
 190             conditions << nil
 191           elsif value.is_a? Array
 192             if value[0] == 'contains' and value.length == 2
 193               conditions[0] << " and #{table_name}.#{attr} like ?"
 194               conditions << "%#{value[1]}%"
 195             else
 196               conditions[0] << " and #{table_name}.#{attr} in (?)"
 197               conditions << value
 198             end
 199           elsif value.is_a? String or value.is_a? Fixnum or value == true or value == false
 200             conditions[0] << " and #{table_name}.#{attr}=?"
 201             conditions << value
 202           elsif value.is_a? Hash
 203             # Not quite the same thing as "equal?" but better than nothing?
 204             value.each do |k,v|
 205               if v.is_a? String
 206                 conditions[0] << " and #{table_name}.#{attr} ilike ?"
 207                 conditions << "%#{k}%#{v}%"
 208               end
 209             end
 210           end
 211         end
 212       end
 213       if conditions.length > 1
 214         conditions[0].sub!(/^1=1 and /, '')
 215         @objects = @objects.
 216           where(*conditions)
 217       end
 218     end
 219
 220     if params[:limit]
 221       begin
 222         @limit = params[:limit].to_i
 223       rescue
 224         raise ArgumentError.new("Invalid value for limit parameter")
 225       end
 226     else
 227       @limit = 100
 228     end
 229     @objects = @objects.limit(@limit)
 230
 231     orders = []
 232
 233     if params[:offset]
 234       begin
 235         @objects = @objects.offset(params[:offset].to_i)
 236         @offset = params[:offset].to_i
 237       rescue
 238         raise ArgumentError.new("Invalid value for limit parameter")
 239       end
 240     else
 241       @offset = 0
 242     end
 243
 244     orders = []
 245     if params[:order]
 246       params[:order].split(',').each do |order|
 247         attr, direction = order.strip.split " "
 248         direction ||= 'asc'
 249         if attr.match /^[a-z][_a-z0-9]+$/ and
 250             model_class.columns.collect(&:name).index(attr) and
 251             ['asc','desc'].index direction.downcase
 252           orders << "#{table_name}.#{attr} #{direction.downcase}"
 253         end
 254       end
 255     end
 256     if orders.empty?
 257       orders << "#{table_name}.modified_at desc"
 258     end
 259     @objects = @objects.order(orders.join ", ")
 260   end
 261
 262   def resource_attrs
 263     return @attrs if @attrs
 264     @attrs = params[resource_name]
 265     if @attrs.is_a? String
 266       @attrs = Oj.load @attrs, symbol_keys: true
 267     end
 268     unless @attrs.is_a? Hash
 269       message = "No #{resource_name}"
 270       if resource_name.index('_')
 271         message << " (or #{resource_name.camelcase(:lower)})"
 272       end
 273       message << " hash provided with request"
 274       raise ArgumentError.new(message)
 275     end
 276     %w(created_at modified_by_client_uuid modified_by_user_uuid modified_at).each do |x|
 277       @attrs.delete x.to_sym
 278     end
 279     @attrs = @attrs.symbolize_keys if @attrs.is_a? HashWithIndifferentAccess
 280     @attrs
 281   end
 282
 283   # Authentication
 284   def require_login
 285     if current_user
 286       true
 287     else
 288       respond_to do |format|
 289         format.json {
 290           render :json => { errors: ['Not logged in'] }.to_json, status: 401
 291         }
 292         format.html  {
 293           redirect_to '/auth/joshid'
 294         }
 295       end
 296       false
 297     end
 298   end
 299
 300   def admin_required
 301     unless current_user and current_user.is_admin
 302       render :json => { errors: ['Forbidden'] }.to_json, status: 403
 303     end
 304   end
 305
 306   def require_auth_scope_all
 307     require_login and require_auth_scope(['all'])
 308   end
 309
 310   def require_auth_scope(ok_scopes)
 311     unless current_api_client_auth_has_scope(ok_scopes)
 312       render :json => { errors: ['Forbidden'] }.to_json, status: 403
 313     end
 314   end
 315
 316   def thread_with_auth_info
 317     Thread.current[:request_starttime] = Time.now
 318     Thread.current[:api_url_base] = root_url.sub(/\/$/,'') + '/arvados/v1'
 319     begin
 320       user = nil
 321       api_client = nil
 322       api_client_auth = nil
 323       supplied_token =
 324         params[:api_token] ||
 325         params[:oauth_token] ||
 326         request.headers["Authorization"].andand.match(/OAuth2 ([a-z0-9]+)/).andand[1]
 327       if supplied_token
 328         api_client_auth = ApiClientAuthorization.
 329           includes(:api_client, :user).
 330           where('api_token=? and (expires_at is null or expires_at > CURRENT_TIMESTAMP)', supplied_token).
 331           first
 332         if api_client_auth.andand.user
 333           session[:user_id] = api_client_auth.user.id
 334           session[:api_client_uuid] = api_client_auth.api_client.andand.uuid
 335           session[:api_client_authorization_id] = api_client_auth.id
 336           user = api_client_auth.user
 337           api_client = api_client_auth.api_client
 338         end
 339       elsif session[:user_id]
 340         user = User.find(session[:user_id]) rescue nil
 341         api_client = ApiClient.
 342           where('uuid=?',session[:api_client_uuid]).
 343           first rescue nil
 344         if session[:api_client_authorization_id] then
 345           api_client_auth = ApiClientAuthorization.
 346             find session[:api_client_authorization_id]
 347         end
 348       end
 349       Thread.current[:api_client_ip_address] = remote_ip
 350       Thread.current[:api_client_authorization] = api_client_auth
 351       Thread.current[:api_client_uuid] = api_client.andand.uuid
 352       Thread.current[:api_client] = api_client
 353       Thread.current[:user] = user
 354       if api_client_auth
 355         api_client_auth.last_used_at = Time.now
 356         api_client_auth.last_used_by_ip_address = remote_ip
 357         api_client_auth.save validate: false
 358       end
 359       yield
 360     ensure
 361       Thread.current[:api_client_ip_address] = nil
 362       Thread.current[:api_client_authorization] = nil
 363       Thread.current[:api_client_uuid] = nil
 364       Thread.current[:api_client] = nil
 365       Thread.current[:user] = nil
 366     end
 367   end
 368   # /Authentication
 369
 370   def model_class
 371     controller_name.classify.constantize
 372   end
 373
 374   def resource_name             # params[] key used by client
 375     controller_name.singularize
 376   end
 377
 378   def table_name
 379     controller_name
 380   end
 381
 382   def find_object_by_uuid
 383     if params[:id] and params[:id].match /\D/
 384       params[:uuid] = params.delete :id
 385     end
 386     @where = { uuid: params[:uuid] }
 387     find_objects_for_index
 388     @object = @objects.first
 389   end
 390
 391   def reload_object_before_update
 392     # This is necessary to prevent an ActiveRecord::ReadOnlyRecord
 393     # error when updating an object which was retrieved using a join.
 394     if @object.andand.readonly?
 395       @object = model_class.find_by_uuid(@objects.first.uuid)
 396     end
 397   end
 398
 399   def self.accept_attribute_as_json(attr, force_class=nil)
 400     before_filter lambda { accept_attribute_as_json attr, force_class }
 401   end
 402   accept_attribute_as_json :properties, Hash
 403   accept_attribute_as_json :info, Hash
 404   def accept_attribute_as_json(attr, force_class)
 405     if params[resource_name] and resource_attrs.is_a? Hash
 406       if resource_attrs[attr].is_a? String
 407         resource_attrs[attr] = Oj.load(resource_attrs[attr],
 408                                        symbol_keys: false)
 409         if force_class and !resource_attrs[attr].is_a? force_class
 410           raise TypeError.new("#{resource_name}[#{attr.to_s}] must be a #{force_class.to_s}")
 411         end
 412       elsif resource_attrs[attr].is_a? Hash
 413         # Convert symbol keys to strings (in hashes provided by
 414         # resource_attrs)
 415         resource_attrs[attr] = resource_attrs[attr].
 416           with_indifferent_access.to_hash
 417       end
 418     end
 419   end
 420
 421   def render_list
 422     @object_list = {
 423       :kind  => "arvados##{(@response_resource_name || resource_name).camelize(:lower)}List",
 424       :etag => "",
 425       :self_link => "",
 426       :offset => @offset,
 427       :limit => @limit,
 428       :items => @objects.as_api_response(nil)
 429     }
 430     if @objects.respond_to? :except
 431       @object_list[:items_available] = @objects.except(:limit).except(:offset).count
 432     end
 433     render json: @object_list
 434   end
 435
 436   def remote_ip
 437     # Caveat: this is highly dependent on the proxy setup. YMMV.
 438     if request.headers.has_key?('HTTP_X_REAL_IP') then
 439       # We're behind a reverse proxy
 440       @remote_ip = request.headers['HTTP_X_REAL_IP']
 441     else
 442       # Hopefully, we are not!
 443       @remote_ip = request.env['REMOTE_ADDR']
 444     end
 445   end
 446
 447   def self._index_requires_parameters
 448     {
 449       filters: { type: 'array', required: false },
 450       where: { type: 'object', required: false },
 451       order: { type: 'string', required: false }
 452     }
 453   end
 454
 455   def client_accepts_plain_text_stream
 456     (request.headers['Accept'].split(' ') &
 457      ['text/plain', '*/*']).count > 0
 458   end
 459
 460   def render *opts
 461     if opts.first
 462       response = opts.first[:json]
 463       if response.is_a?(Hash) &&
 464           params[:_profile] &&
 465           Thread.current[:request_starttime]
 466         response[:_profile] = {
 467           request_time: Time.now - Thread.current[:request_starttime]
 468         }
 469       end
 470     end
 471     super *opts
 472   end
 473 end