services/api/app/controllers/application_controller.rb

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