services/api/app/controllers/application_controller.rb

   1 module ApiTemplateOverride
   2   def allowed_to_render?(fieldset, field, model, options)
   3     if options[:select]
   4       return options[:select].include? field.to_s
   5     end
   6     super
   7   end
   8 end
   9
  10 class ActsAsApi::ApiTemplate
  11   prepend ApiTemplateOverride
  12 end
  13
  14 require 'load_param'
  15 require 'record_filters'
  16
  17 class ApplicationController < ActionController::Base
  18   include CurrentApiClient
  19   include ThemesForRails::ActionController
  20   include LoadParam
  21   include RecordFilters
  22
  23   respond_to :json
  24   protect_from_forgery
  25
  26   ERROR_ACTIONS = [:render_error, :render_not_found]
  27
  28   before_filter :respond_with_json_by_default
  29   before_filter :remote_ip
  30   before_filter :load_read_auths
  31   before_filter :require_auth_scope, except: ERROR_ACTIONS
  32
  33   before_filter :catch_redirect_hint
  34   before_filter(:find_object_by_uuid,
  35                 except: [:index, :create] + ERROR_ACTIONS)
  36   before_filter :load_limit_offset_order_params, only: [:index, :contents]
  37   before_filter :load_where_param, only: [:index, :contents]
  38   before_filter :load_filters_param, only: [:index, :contents]
  39   before_filter :find_objects_for_index, :only => :index
  40   before_filter :reload_object_before_update, :only => :update
  41   before_filter(:render_404_if_no_object,
  42                 except: [:index, :create] + ERROR_ACTIONS)
  43
  44   theme :select_theme
  45
  46   attr_accessor :resource_attrs
  47
  48   begin
  49     rescue_from(Exception,
  50                 ArvadosModel::PermissionDeniedError,
  51                 :with => :render_error)
  52     rescue_from(ActiveRecord::RecordNotFound,
  53                 ActionController::RoutingError,
  54                 ActionController::UnknownController,
  55                 AbstractController::ActionNotFound,
  56                 :with => :render_not_found)
  57   end
  58
  59   def index
  60     @objects.uniq!(&:id) if @select.nil? or @select.include? "id"
  61     if params[:eager] and params[:eager] != '0' and params[:eager] != 0 and params[:eager] != ''
  62       @objects.each(&:eager_load_associations)
  63     end
  64     render_list
  65   end
  66
  67   def show
  68     render json: @object.as_api_response
  69   end
  70
  71   def create
  72     @object = model_class.new resource_attrs
  73     @object.save!
  74     show
  75   end
  76
  77   def update
  78     attrs_to_update = resource_attrs.reject { |k,v|
  79       [:kind, :etag, :href].index k
  80     }
  81     @object.update_attributes! attrs_to_update
  82     show
  83   end
  84
  85   def destroy
  86     @object.destroy
  87     show
  88   end
  89
  90   def catch_redirect_hint
  91     if !current_user
  92       if params.has_key?('redirect_to') then
  93         session[:redirect_to] = params[:redirect_to]
  94       end
  95     end
  96   end
  97
  98   def render_404_if_no_object
  99     render_not_found "Object not found" if !@object
 100   end
 101
 102   def render_error(e)
 103     logger.error e.inspect
 104     if e.respond_to? :backtrace and e.backtrace
 105       logger.error e.backtrace.collect { |x| x + "\n" }.join('')
 106     end
 107     if @object and @object.errors and @object.errors.full_messages and not @object.errors.full_messages.empty?
 108       errors = @object.errors.full_messages
 109     else
 110       errors = [e.inspect]
 111     end
 112     status = e.respond_to?(:http_status) ? e.http_status : 422
 113     send_error(*errors, status: status)
 114   end
 115
 116   def render_not_found(e=ActionController::RoutingError.new("Path not found"))
 117     logger.error e.inspect
 118     send_error("Path not found", status: 404)
 119   end
 120
 121   protected
 122
 123   def send_error(*args)
 124     if args.last.is_a? Hash
 125       err = args.pop
 126     else
 127       err = {}
 128     end
 129     err[:errors] ||= args
 130     err[:error_token] = [Time.now.utc.to_i, "%08x" % rand(16 ** 8)].join("+")
 131     status = err.delete(:status) || 422
 132     logger.error "Error #{err[:error_token]}: #{status}"
 133     render json: err, status: status
 134   end
 135
 136   def find_objects_for_index
 137     @objects ||= model_class.readable_by(*@read_users)
 138     apply_where_limit_order_params
 139   end
 140
 141   def apply_filters
 142     ft = record_filters @filters, @objects.table_name
 143     if ft[:cond_out].any?
 144       @objects = @objects.where(ft[:cond_out].join(' AND '), *ft[:param_out])
 145     end
 146   end
 147
 148   def apply_where_limit_order_params
 149     apply_filters
 150
 151     ar_table_name = @objects.table_name
 152     if @where.is_a? Hash and @where.any?
 153       conditions = ['1=1']
 154       @where.each do |attr,value|
 155         if attr.to_s == 'any'
 156           if value.is_a?(Array) and
 157               value.length == 2 and
 158               value[0] == 'contains' then
 159             ilikes = []
 160             model_class.searchable_columns('ilike').each do |column|
 161               # Including owner_uuid in an "any column" search will
 162               # probably just return a lot of false positives.
 163               next if column == 'owner_uuid'
 164               ilikes << "#{ar_table_name}.#{column} ilike ?"
 165               conditions << "%#{value[1]}%"
 166             end
 167             if ilikes.any?
 168               conditions[0] << ' and (' + ilikes.join(' or ') + ')'
 169             end
 170           end
 171         elsif attr.to_s.match(/^[a-z][_a-z0-9]+$/) and
 172             model_class.columns.collect(&:name).index(attr.to_s)
 173           if value.nil?
 174             conditions[0] << " and #{ar_table_name}.#{attr} is ?"
 175             conditions << nil
 176           elsif value.is_a? Array
 177             if value[0] == 'contains' and value.length == 2
 178               conditions[0] << " and #{ar_table_name}.#{attr} like ?"
 179               conditions << "%#{value[1]}%"
 180             else
 181               conditions[0] << " and #{ar_table_name}.#{attr} in (?)"
 182               conditions << value
 183             end
 184           elsif value.is_a? String or value.is_a? Fixnum or value == true or value == false
 185             conditions[0] << " and #{ar_table_name}.#{attr}=?"
 186             conditions << value
 187           elsif value.is_a? Hash
 188             # Not quite the same thing as "equal?" but better than nothing?
 189             value.each do |k,v|
 190               if v.is_a? String
 191                 conditions[0] << " and #{ar_table_name}.#{attr} ilike ?"
 192                 conditions << "%#{k}%#{v}%"
 193               end
 194             end
 195           end
 196         end
 197       end
 198       if conditions.length > 1
 199         conditions[0].sub!(/^1=1 and /, '')
 200         @objects = @objects.
 201           where(*conditions)
 202       end
 203     end
 204
 205     @objects = @objects.select(@select.map { |s| "#{table_name}.#{ActiveRecord::Base.connection.quote_column_name s.to_s}" }.join ", ") if @select
 206     @objects = @objects.order(@orders.join ", ") if @orders.any?
 207     @objects = @objects.limit(@limit)
 208     @objects = @objects.offset(@offset)
 209     @objects = @objects.uniq(@distinct) if not @distinct.nil?
 210   end
 211
 212   def resource_attrs
 213     return @attrs if @attrs
 214     @attrs = params[resource_name]
 215     if @attrs.is_a? String
 216       @attrs = Oj.load @attrs, symbol_keys: true
 217     end
 218     unless @attrs.is_a? Hash
 219       message = "No #{resource_name}"
 220       if resource_name.index('_')
 221         message << " (or #{resource_name.camelcase(:lower)})"
 222       end
 223       message << " hash provided with request"
 224       raise ArgumentError.new(message)
 225     end
 226     %w(created_at modified_by_client_uuid modified_by_user_uuid modified_at).each do |x|
 227       @attrs.delete x.to_sym
 228     end
 229     @attrs = @attrs.symbolize_keys if @attrs.is_a? HashWithIndifferentAccess
 230     @attrs
 231   end
 232
 233   # Authentication
 234   def load_read_auths
 235     @read_auths = []
 236     if current_api_client_authorization
 237       @read_auths << current_api_client_authorization
 238     end
 239     # Load reader tokens if this is a read request.
 240     # If there are too many reader tokens, assume the request is malicious
 241     # and ignore it.
 242     if request.get? and params[:reader_tokens] and
 243         params[:reader_tokens].size < 100
 244       @read_auths += ApiClientAuthorization
 245         .includes(:user)
 246         .where('api_token IN (?) AND
 247                 (expires_at IS NULL OR expires_at > CURRENT_TIMESTAMP)',
 248                params[:reader_tokens])
 249         .all
 250     end
 251     @read_auths.select! { |auth| auth.scopes_allow_request? request }
 252     @read_users = @read_auths.map { |auth| auth.user }.uniq
 253   end
 254
 255   def require_login
 256     if not current_user
 257       respond_to do |format|
 258         format.json { send_error("Not logged in", status: 401) }
 259         format.html { redirect_to '/auth/joshid' }
 260       end
 261       false
 262     end
 263   end
 264
 265   def admin_required
 266     unless current_user and current_user.is_admin
 267       send_error("Forbidden", status: 403)
 268     end
 269   end
 270
 271   def require_auth_scope
 272     if @read_auths.empty?
 273       if require_login != false
 274         send_error("Forbidden", status: 403)
 275       end
 276       false
 277     end
 278   end
 279
 280   def respond_with_json_by_default
 281     html_index = request.accepts.index(Mime::HTML)
 282     if html_index.nil? or request.accepts[0...html_index].include?(Mime::JSON)
 283       request.format = :json
 284     end
 285   end
 286
 287   def model_class
 288     controller_name.classify.constantize
 289   end
 290
 291   def resource_name             # params[] key used by client
 292     controller_name.singularize
 293   end
 294
 295   def table_name
 296     controller_name
 297   end
 298
 299   def find_object_by_uuid
 300     if params[:id] and params[:id].match /\D/
 301       params[:uuid] = params.delete :id
 302     end
 303     @where = { uuid: params[:uuid] }
 304     @offset = 0
 305     @limit = 1
 306     @orders = []
 307     @filters = []
 308     @objects = nil
 309     find_objects_for_index
 310     @object = @objects.first
 311   end
 312
 313   def reload_object_before_update
 314     # This is necessary to prevent an ActiveRecord::ReadOnlyRecord
 315     # error when updating an object which was retrieved using a join.
 316     if @object.andand.readonly?
 317       @object = model_class.find_by_uuid(@objects.first.uuid)
 318     end
 319   end
 320
 321   def load_json_value(hash, key, must_be_class=nil)
 322     if hash[key].is_a? String
 323       hash[key] = Oj.load(hash[key], symbol_keys: false)
 324       if must_be_class and !hash[key].is_a? must_be_class
 325         raise TypeError.new("parameter #{key.to_s} must be a #{must_be_class.to_s}")
 326       end
 327     end
 328   end
 329
 330   def self.accept_attribute_as_json(attr, must_be_class=nil)
 331     before_filter lambda { accept_attribute_as_json attr, must_be_class }
 332   end
 333   accept_attribute_as_json :properties, Hash
 334   accept_attribute_as_json :info, Hash
 335   def accept_attribute_as_json(attr, must_be_class)
 336     if params[resource_name] and resource_attrs.is_a? Hash
 337       if resource_attrs[attr].is_a? Hash
 338         # Convert symbol keys to strings (in hashes provided by
 339         # resource_attrs)
 340         resource_attrs[attr] = resource_attrs[attr].
 341           with_indifferent_access.to_hash
 342       else
 343         load_json_value(resource_attrs, attr, must_be_class)
 344       end
 345     end
 346   end
 347
 348   def self.accept_param_as_json(key, must_be_class=nil)
 349     prepend_before_filter lambda { load_json_value(params, key, must_be_class) }
 350   end
 351   accept_param_as_json :reader_tokens, Array
 352
 353   def render_list
 354     if @select
 355       # This information helps clients understand what they're seeing
 356       # (Workbench always expects it), but they can't select it explicitly
 357       # because it's not an SQL column.  Always add it.
 358       # I believe this is safe because clients can always deduce what they're
 359       # looking at by the returned UUID anyway.
 360       @select |= ["kind"]
 361     end
 362     @object_list = {
 363       :kind  => "arvados##{(@response_resource_name || resource_name).camelize(:lower)}List",
 364       :etag => "",
 365       :self_link => "",
 366       :offset => @offset,
 367       :limit => @limit,
 368       :items => @objects.as_api_response(nil, {select: @select})
 369     }
 370     if @objects.respond_to? :except
 371       @object_list[:items_available] = @objects.
 372         except(:limit).except(:offset).
 373         count(:id, distinct: true)
 374     end
 375     render json: @object_list
 376   end
 377
 378   def remote_ip
 379     # Caveat: this is highly dependent on the proxy setup. YMMV.
 380     if request.headers.has_key?('HTTP_X_REAL_IP') then
 381       # We're behind a reverse proxy
 382       @remote_ip = request.headers['HTTP_X_REAL_IP']
 383     else
 384       # Hopefully, we are not!
 385       @remote_ip = request.env['REMOTE_ADDR']
 386     end
 387   end
 388
 389   def self._index_requires_parameters
 390     {
 391       filters: { type: 'array', required: false },
 392       where: { type: 'object', required: false },
 393       order: { type: 'array', required: false },
 394       select: { type: 'array', required: false },
 395       distinct: { type: 'boolean', required: false },
 396       limit: { type: 'integer', required: false, default: DEFAULT_LIMIT },
 397       offset: { type: 'integer', required: false, default: 0 },
 398     }
 399   end
 400
 401   def client_accepts_plain_text_stream
 402     (request.headers['Accept'].split(' ') &
 403      ['text/plain', '*/*']).count > 0
 404   end
 405
 406   def render *opts
 407     if opts.first
 408       response = opts.first[:json]
 409       if response.is_a?(Hash) &&
 410           params[:_profile] &&
 411           Thread.current[:request_starttime]
 412         response[:_profile] = {
 413           request_time: Time.now - Thread.current[:request_starttime]
 414         }
 415       end
 416     end
 417     super *opts
 418   end
 419
 420   def select_theme
 421     return Rails.configuration.arvados_theme
 422   end
 423 end