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