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