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