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