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 self.limit_index_columns_read
 195     # This method returns a list of column names.
 196     # If an index request reads that column from the database,
 197     # find_objects_for_index will only fetch objects until it reads
 198     # max_index_database_read bytes of data from those columns.
 199     []
 200   end
 201
 202   def find_objects_for_index
 203     @objects ||= model_class.readable_by(*@read_users)
 204     apply_where_limit_order_params
 205     limit_database_read if (action_name == "index")
 206   end
 207
 208   def apply_filters model_class=nil
 209     model_class ||= self.model_class
 210     ft = record_filters @filters, model_class
 211     if ft[:cond_out].any?
 212       @objects = @objects.where('(' + ft[:cond_out].join(') AND (') + ')',
 213                                 *ft[:param_out])
 214     end
 215   end
 216
 217   def apply_where_limit_order_params model_class=nil
 218     model_class ||= self.model_class
 219     apply_filters model_class
 220
 221     ar_table_name = @objects.table_name
 222     if @where.is_a? Hash and @where.any?
 223       conditions = ['1=1']
 224       @where.each do |attr,value|
 225         if attr.to_s == 'any'
 226           if value.is_a?(Array) and
 227               value.length == 2 and
 228               value[0] == 'contains' then
 229             ilikes = []
 230             model_class.searchable_columns('ilike').each do |column|
 231               # Including owner_uuid in an "any column" search will
 232               # probably just return a lot of false positives.
 233               next if column == 'owner_uuid'
 234               ilikes << "#{ar_table_name}.#{column} ilike ?"
 235               conditions << "%#{value[1]}%"
 236             end
 237             if ilikes.any?
 238               conditions[0] << ' and (' + ilikes.join(' or ') + ')'
 239             end
 240           end
 241         elsif attr.to_s.match(/^[a-z][_a-z0-9]+$/) and
 242             model_class.columns.collect(&:name).index(attr.to_s)
 243           if value.nil?
 244             conditions[0] << " and #{ar_table_name}.#{attr} is ?"
 245             conditions << nil
 246           elsif value.is_a? Array
 247             if value[0] == 'contains' and value.length == 2
 248               conditions[0] << " and #{ar_table_name}.#{attr} like ?"
 249               conditions << "%#{value[1]}%"
 250             else
 251               conditions[0] << " and #{ar_table_name}.#{attr} in (?)"
 252               conditions << value
 253             end
 254           elsif value.is_a? String or value.is_a? Fixnum or value == true or value == false
 255             conditions[0] << " and #{ar_table_name}.#{attr}=?"
 256             conditions << value
 257           elsif value.is_a? Hash
 258             # Not quite the same thing as "equal?" but better than nothing?
 259             value.each do |k,v|
 260               if v.is_a? String
 261                 conditions[0] << " and #{ar_table_name}.#{attr} ilike ?"
 262                 conditions << "%#{k}%#{v}%"
 263               end
 264             end
 265           end
 266         end
 267       end
 268       if conditions.length > 1
 269         conditions[0].sub!(/^1=1 and /, '')
 270         @objects = @objects.
 271           where(*conditions)
 272       end
 273     end
 274
 275     if @select
 276       unless action_name.in? %w(create update destroy)
 277         # Map attribute names in @select to real column names, resolve
 278         # those to fully-qualified SQL column names, and pass the
 279         # resulting string to the select method.
 280         columns_list = model_class.columns_for_attributes(@select).
 281           map { |s| "#{ar_table_name}.#{ActiveRecord::Base.connection.quote_column_name s}" }
 282         @objects = @objects.select(columns_list.join(", "))
 283       end
 284
 285       # This information helps clients understand what they're seeing
 286       # (Workbench always expects it), but they can't select it explicitly
 287       # because it's not an SQL column.  Always add it.
 288       # (This is harmless, given that clients can deduce what they're
 289       # looking at by the returned UUID anyway.)
 290       @select |= ["kind"]
 291     end
 292     @objects = @objects.order(@orders.join ", ") if @orders.any?
 293     @objects = @objects.limit(@limit)
 294     @objects = @objects.offset(@offset)
 295     @objects = @objects.uniq(@distinct) if not @distinct.nil?
 296   end
 297
 298   def limit_database_read
 299     limit_columns = self.class.limit_index_columns_read
 300     limit_columns &= model_class.columns_for_attributes(@select) if @select
 301     return if limit_columns.empty?
 302     model_class.transaction do
 303       limit_query = @objects.
 304         except(:select).
 305         select("(%s) as read_length" %
 306                limit_columns.map { |s| "octet_length(#{s})" }.join(" + "))
 307       new_limit = 0
 308       read_total = 0
 309       limit_query.each do |record|
 310         new_limit += 1
 311         read_total += record.read_length.to_i
 312         if read_total >= Rails.configuration.max_index_database_read
 313           new_limit -= 1 if new_limit > 1
 314           break
 315         elsif new_limit >= @limit
 316           break
 317         end
 318       end
 319       @limit = new_limit
 320       @objects = @objects.limit(@limit)
 321       # Force @objects to run its query inside this transaction.
 322       @objects.each { |_| break }
 323     end
 324   end
 325
 326   def resource_attrs
 327     return @attrs if @attrs
 328     @attrs = params[resource_name]
 329     if @attrs.is_a? String
 330       @attrs = Oj.load @attrs, symbol_keys: true
 331     end
 332     unless @attrs.is_a? Hash
 333       message = "No #{resource_name}"
 334       if resource_name.index('_')
 335         message << " (or #{resource_name.camelcase(:lower)})"
 336       end
 337       message << " hash provided with request"
 338       raise ArgumentError.new(message)
 339     end
 340     %w(created_at modified_by_client_uuid modified_by_user_uuid modified_at).each do |x|
 341       @attrs.delete x.to_sym
 342     end
 343     @attrs = @attrs.symbolize_keys if @attrs.is_a? HashWithIndifferentAccess
 344     @attrs
 345   end
 346
 347   # Authentication
 348   def load_read_auths
 349     @read_auths = []
 350     if current_api_client_authorization
 351       @read_auths << current_api_client_authorization
 352     end
 353     # Load reader tokens if this is a read request.
 354     # If there are too many reader tokens, assume the request is malicious
 355     # and ignore it.
 356     if request.get? and params[:reader_tokens] and
 357         params[:reader_tokens].size < 100
 358       @read_auths += ApiClientAuthorization
 359         .includes(:user)
 360         .where('api_token IN (?) AND
 361                 (expires_at IS NULL OR expires_at > CURRENT_TIMESTAMP)',
 362                params[:reader_tokens])
 363         .all
 364     end
 365     @read_auths.select! { |auth| auth.scopes_allow_request? request }
 366     @read_users = @read_auths.map { |auth| auth.user }.uniq
 367   end
 368
 369   def require_login
 370     if not current_user
 371       respond_to do |format|
 372         format.json { send_error("Not logged in", status: 401) }
 373         format.html { redirect_to '/auth/joshid' }
 374       end
 375       false
 376     end
 377   end
 378
 379   def admin_required
 380     unless current_user and current_user.is_admin
 381       send_error("Forbidden", status: 403)
 382     end
 383   end
 384
 385   def require_auth_scope
 386     if @read_auths.empty?
 387       if require_login != false
 388         send_error("Forbidden", status: 403)
 389       end
 390       false
 391     end
 392   end
 393
 394   def set_cors_headers
 395     response.headers['Access-Control-Allow-Origin'] = '*'
 396     response.headers['Access-Control-Allow-Methods'] = 'GET, HEAD, PUT, POST, DELETE'
 397     response.headers['Access-Control-Allow-Headers'] = 'Authorization'
 398     response.headers['Access-Control-Max-Age'] = '86486400'
 399   end
 400
 401   def respond_with_json_by_default
 402     html_index = request.accepts.index(Mime::HTML)
 403     if html_index.nil? or request.accepts[0...html_index].include?(Mime::JSON)
 404       request.format = :json
 405     end
 406   end
 407
 408   def model_class
 409     controller_name.classify.constantize
 410   end
 411
 412   def resource_name             # params[] key used by client
 413     controller_name.singularize
 414   end
 415
 416   def table_name
 417     controller_name
 418   end
 419
 420   def find_object_by_uuid
 421     if params[:id] and params[:id].match /\D/
 422       params[:uuid] = params.delete :id
 423     end
 424     @where = { uuid: params[:uuid] }
 425     @offset = 0
 426     @limit = 1
 427     @orders = []
 428     @filters = []
 429     @objects = nil
 430     find_objects_for_index
 431     @object = @objects.first
 432   end
 433
 434   def reload_object_before_update
 435     # This is necessary to prevent an ActiveRecord::ReadOnlyRecord
 436     # error when updating an object which was retrieved using a join.
 437     if @object.andand.readonly?
 438       @object = model_class.find_by_uuid(@objects.first.uuid)
 439     end
 440   end
 441
 442   def load_json_value(hash, key, must_be_class=nil)
 443     if hash[key].is_a? String
 444       hash[key] = Oj.load(hash[key], symbol_keys: false)
 445       if must_be_class and !hash[key].is_a? must_be_class
 446         raise TypeError.new("parameter #{key.to_s} must be a #{must_be_class.to_s}")
 447       end
 448     end
 449   end
 450
 451   def self.accept_attribute_as_json(attr, must_be_class=nil)
 452     before_filter lambda { accept_attribute_as_json attr, must_be_class }
 453   end
 454   accept_attribute_as_json :properties, Hash
 455   accept_attribute_as_json :info, Hash
 456   def accept_attribute_as_json(attr, must_be_class)
 457     if params[resource_name] and resource_attrs.is_a? Hash
 458       if resource_attrs[attr].is_a? Hash
 459         # Convert symbol keys to strings (in hashes provided by
 460         # resource_attrs)
 461         resource_attrs[attr] = resource_attrs[attr].
 462           with_indifferent_access.to_hash
 463       else
 464         load_json_value(resource_attrs, attr, must_be_class)
 465       end
 466     end
 467   end
 468
 469   def self.accept_param_as_json(key, must_be_class=nil)
 470     prepend_before_filter lambda { load_json_value(params, key, must_be_class) }
 471   end
 472   accept_param_as_json :reader_tokens, Array
 473
 474   def object_list
 475     list = {
 476       :kind  => "arvados##{(@response_resource_name || resource_name).camelize(:lower)}List",
 477       :etag => "",
 478       :self_link => "",
 479       :offset => @offset,
 480       :limit => @limit,
 481       :items => @objects.as_api_response(nil, {select: @select})
 482     }
 483     if @objects.respond_to? :except
 484       list[:items_available] = @objects.
 485         except(:limit).except(:offset).
 486         count(:id, distinct: true)
 487     end
 488     list
 489   end
 490
 491   def render_list
 492     send_json object_list
 493   end
 494
 495   def remote_ip
 496     # Caveat: this is highly dependent on the proxy setup. YMMV.
 497     if request.headers.has_key?('HTTP_X_REAL_IP') then
 498       # We're behind a reverse proxy
 499       @remote_ip = request.headers['HTTP_X_REAL_IP']
 500     else
 501       # Hopefully, we are not!
 502       @remote_ip = request.env['REMOTE_ADDR']
 503     end
 504   end
 505
 506   def load_required_parameters
 507     (self.class.send "_#{params[:action]}_requires_parameters" rescue {}).
 508       each do |key, info|
 509       if info[:required] and not params.include?(key)
 510         raise ArgumentError.new("#{key} parameter is required")
 511       elsif info[:type] == 'boolean'
 512         # Make sure params[key] is either true or false -- not a
 513         # string, not nil, etc.
 514         if not params.include?(key)
 515           params[key] = info[:default]
 516         elsif [false, 'false', '0', 0].include? params[key]
 517           params[key] = false
 518         elsif [true, 'true', '1', 1].include? params[key]
 519           params[key] = true
 520         else
 521           raise TypeError.new("#{key} parameter must be a boolean, true or false")
 522         end
 523       end
 524     end
 525     true
 526   end
 527
 528   def self._create_requires_parameters
 529     {
 530       ensure_unique_name: {
 531         type: "boolean",
 532         description: "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
 533         location: "query",
 534         required: false,
 535         default: false
 536       }
 537     }
 538   end
 539
 540   def self._index_requires_parameters
 541     {
 542       filters: { type: 'array', required: false },
 543       where: { type: 'object', required: false },
 544       order: { type: 'array', required: false },
 545       select: { type: 'array', required: false },
 546       distinct: { type: 'boolean', required: false },
 547       limit: { type: 'integer', required: false, default: DEFAULT_LIMIT },
 548       offset: { type: 'integer', required: false, default: 0 },
 549     }
 550   end
 551
 552   def client_accepts_plain_text_stream
 553     (request.headers['Accept'].split(' ') &
 554      ['text/plain', '*/*']).count > 0
 555   end
 556
 557   def render *opts
 558     if opts.first
 559       response = opts.first[:json]
 560       if response.is_a?(Hash) &&
 561           params[:_profile] &&
 562           Thread.current[:request_starttime]
 563         response[:_profile] = {
 564           request_time: Time.now - Thread.current[:request_starttime]
 565         }
 566       end
 567     end
 568     super *opts
 569   end
 570
 571   def select_theme
 572     return Rails.configuration.arvados_theme
 573   end
 574 end