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