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