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