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