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