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 :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_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     render 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     render json: err, status: status
 181   end
 182
 183   def find_objects_for_index
 184     @objects ||= model_class.readable_by(*@read_users)
 185     apply_where_limit_order_params
 186   end
 187
 188   def apply_filters model_class=nil
 189     model_class ||= self.model_class
 190     ft = record_filters @filters, model_class
 191     if ft[:cond_out].any?
 192       @objects = @objects.where('(' + ft[:cond_out].join(') AND (') + ')',
 193                                 *ft[:param_out])
 194     end
 195   end
 196
 197   def apply_where_limit_order_params *args
 198     apply_filters *args
 199
 200     ar_table_name = @objects.table_name
 201     if @where.is_a? Hash and @where.any?
 202       conditions = ['1=1']
 203       @where.each do |attr,value|
 204         if attr.to_s == 'any'
 205           if value.is_a?(Array) and
 206               value.length == 2 and
 207               value[0] == 'contains' then
 208             ilikes = []
 209             model_class.searchable_columns('ilike').each do |column|
 210               # Including owner_uuid in an "any column" search will
 211               # probably just return a lot of false positives.
 212               next if column == 'owner_uuid'
 213               ilikes << "#{ar_table_name}.#{column} ilike ?"
 214               conditions << "%#{value[1]}%"
 215             end
 216             if ilikes.any?
 217               conditions[0] << ' and (' + ilikes.join(' or ') + ')'
 218             end
 219           end
 220         elsif attr.to_s.match(/^[a-z][_a-z0-9]+$/) and
 221             model_class.columns.collect(&:name).index(attr.to_s)
 222           if value.nil?
 223             conditions[0] << " and #{ar_table_name}.#{attr} is ?"
 224             conditions << nil
 225           elsif value.is_a? Array
 226             if value[0] == 'contains' and value.length == 2
 227               conditions[0] << " and #{ar_table_name}.#{attr} like ?"
 228               conditions << "%#{value[1]}%"
 229             else
 230               conditions[0] << " and #{ar_table_name}.#{attr} in (?)"
 231               conditions << value
 232             end
 233           elsif value.is_a? String or value.is_a? Fixnum or value == true or value == false
 234             conditions[0] << " and #{ar_table_name}.#{attr}=?"
 235             conditions << value
 236           elsif value.is_a? Hash
 237             # Not quite the same thing as "equal?" but better than nothing?
 238             value.each do |k,v|
 239               if v.is_a? String
 240                 conditions[0] << " and #{ar_table_name}.#{attr} ilike ?"
 241                 conditions << "%#{k}%#{v}%"
 242               end
 243             end
 244           end
 245         end
 246       end
 247       if conditions.length > 1
 248         conditions[0].sub!(/^1=1 and /, '')
 249         @objects = @objects.
 250           where(*conditions)
 251       end
 252     end
 253
 254     if @select
 255       unless action_name.in? %w(create update destroy)
 256         # Map attribute names in @select to real column names, resolve
 257         # those to fully-qualified SQL column names, and pass the
 258         # resulting string to the select method.
 259         api_column_map = model_class.attributes_required_columns
 260         columns_list = @select.
 261           flat_map { |attr| api_column_map[attr] }.
 262           uniq.
 263           map { |s| "#{table_name}.#{ActiveRecord::Base.connection.quote_column_name s}" }
 264         @objects = @objects.select(columns_list.join(", "))
 265       end
 266
 267       # This information helps clients understand what they're seeing
 268       # (Workbench always expects it), but they can't select it explicitly
 269       # because it's not an SQL column.  Always add it.
 270       # (This is harmless, given that clients can deduce what they're
 271       # looking at by the returned UUID anyway.)
 272       @select |= ["kind"]
 273     end
 274     @objects = @objects.order(@orders.join ", ") if @orders.any?
 275     @objects = @objects.limit(@limit)
 276     @objects = @objects.offset(@offset)
 277     @objects = @objects.uniq(@distinct) if not @distinct.nil?
 278   end
 279
 280   def resource_attrs
 281     return @attrs if @attrs
 282     @attrs = params[resource_name]
 283     if @attrs.is_a? String
 284       @attrs = Oj.load @attrs, symbol_keys: true
 285     end
 286     unless @attrs.is_a? Hash
 287       message = "No #{resource_name}"
 288       if resource_name.index('_')
 289         message << " (or #{resource_name.camelcase(:lower)})"
 290       end
 291       message << " hash provided with request"
 292       raise ArgumentError.new(message)
 293     end
 294     %w(created_at modified_by_client_uuid modified_by_user_uuid modified_at).each do |x|
 295       @attrs.delete x.to_sym
 296     end
 297     @attrs = @attrs.symbolize_keys if @attrs.is_a? HashWithIndifferentAccess
 298     @attrs
 299   end
 300
 301   # Authentication
 302   def load_read_auths
 303     @read_auths = []
 304     if current_api_client_authorization
 305       @read_auths << current_api_client_authorization
 306     end
 307     # Load reader tokens if this is a read request.
 308     # If there are too many reader tokens, assume the request is malicious
 309     # and ignore it.
 310     if request.get? and params[:reader_tokens] and
 311         params[:reader_tokens].size < 100
 312       @read_auths += ApiClientAuthorization
 313         .includes(:user)
 314         .where('api_token IN (?) AND
 315                 (expires_at IS NULL OR expires_at > CURRENT_TIMESTAMP)',
 316                params[:reader_tokens])
 317         .all
 318     end
 319     @read_auths.select! { |auth| auth.scopes_allow_request? request }
 320     @read_users = @read_auths.map { |auth| auth.user }.uniq
 321   end
 322
 323   def require_login
 324     if not current_user
 325       respond_to do |format|
 326         format.json { send_error("Not logged in", status: 401) }
 327         format.html { redirect_to '/auth/joshid' }
 328       end
 329       false
 330     end
 331   end
 332
 333   def admin_required
 334     unless current_user and current_user.is_admin
 335       send_error("Forbidden", status: 403)
 336     end
 337   end
 338
 339   def require_auth_scope
 340     if @read_auths.empty?
 341       if require_login != false
 342         send_error("Forbidden", status: 403)
 343       end
 344       false
 345     end
 346   end
 347
 348   def respond_with_json_by_default
 349     html_index = request.accepts.index(Mime::HTML)
 350     if html_index.nil? or request.accepts[0...html_index].include?(Mime::JSON)
 351       request.format = :json
 352     end
 353   end
 354
 355   def model_class
 356     controller_name.classify.constantize
 357   end
 358
 359   def resource_name             # params[] key used by client
 360     controller_name.singularize
 361   end
 362
 363   def table_name
 364     controller_name
 365   end
 366
 367   def find_object_by_uuid
 368     if params[:id] and params[:id].match /\D/
 369       params[:uuid] = params.delete :id
 370     end
 371     @where = { uuid: params[:uuid] }
 372     @offset = 0
 373     @limit = 1
 374     @orders = []
 375     @filters = []
 376     @objects = nil
 377     find_objects_for_index
 378     @object = @objects.first
 379   end
 380
 381   def reload_object_before_update
 382     # This is necessary to prevent an ActiveRecord::ReadOnlyRecord
 383     # error when updating an object which was retrieved using a join.
 384     if @object.andand.readonly?
 385       @object = model_class.find_by_uuid(@objects.first.uuid)
 386     end
 387   end
 388
 389   def load_json_value(hash, key, must_be_class=nil)
 390     if hash[key].is_a? String
 391       hash[key] = Oj.load(hash[key], symbol_keys: false)
 392       if must_be_class and !hash[key].is_a? must_be_class
 393         raise TypeError.new("parameter #{key.to_s} must be a #{must_be_class.to_s}")
 394       end
 395     end
 396   end
 397
 398   def self.accept_attribute_as_json(attr, must_be_class=nil)
 399     before_filter lambda { accept_attribute_as_json attr, must_be_class }
 400   end
 401   accept_attribute_as_json :properties, Hash
 402   accept_attribute_as_json :info, Hash
 403   def accept_attribute_as_json(attr, must_be_class)
 404     if params[resource_name] and resource_attrs.is_a? Hash
 405       if resource_attrs[attr].is_a? Hash
 406         # Convert symbol keys to strings (in hashes provided by
 407         # resource_attrs)
 408         resource_attrs[attr] = resource_attrs[attr].
 409           with_indifferent_access.to_hash
 410       else
 411         load_json_value(resource_attrs, attr, must_be_class)
 412       end
 413     end
 414   end
 415
 416   def self.accept_param_as_json(key, must_be_class=nil)
 417     prepend_before_filter lambda { load_json_value(params, key, must_be_class) }
 418   end
 419   accept_param_as_json :reader_tokens, Array
 420
 421   def render_list
 422     @object_list = {
 423       :kind  => "arvados##{(@response_resource_name || resource_name).camelize(:lower)}List",
 424       :etag => "",
 425       :self_link => "",
 426       :offset => @offset,
 427       :limit => @limit,
 428       :items => @objects.as_api_response(nil, {select: @select})
 429     }
 430     if @objects.respond_to? :except
 431       @object_list[:items_available] = @objects.
 432         except(:limit).except(:offset).
 433         count(:id, distinct: true)
 434     end
 435     render json: @object_list
 436   end
 437
 438   def remote_ip
 439     # Caveat: this is highly dependent on the proxy setup. YMMV.
 440     if request.headers.has_key?('HTTP_X_REAL_IP') then
 441       # We're behind a reverse proxy
 442       @remote_ip = request.headers['HTTP_X_REAL_IP']
 443     else
 444       # Hopefully, we are not!
 445       @remote_ip = request.env['REMOTE_ADDR']
 446     end
 447   end
 448
 449   def self._index_requires_parameters
 450     {
 451       filters: { type: 'array', required: false },
 452       where: { type: 'object', required: false },
 453       order: { type: 'array', required: false },
 454       select: { type: 'array', required: false },
 455       distinct: { type: 'boolean', required: false },
 456       limit: { type: 'integer', required: false, default: DEFAULT_LIMIT },
 457       offset: { type: 'integer', required: false, default: 0 },
 458     }
 459   end
 460
 461   def client_accepts_plain_text_stream
 462     (request.headers['Accept'].split(' ') &
 463      ['text/plain', '*/*']).count > 0
 464   end
 465
 466   def render *opts
 467     if opts.first
 468       response = opts.first[:json]
 469       if response.is_a?(Hash) &&
 470           params[:_profile] &&
 471           Thread.current[:request_starttime]
 472         response[:_profile] = {
 473           request_time: Time.now - Thread.current[:request_starttime]
 474         }
 475       end
 476     end
 477     super *opts
 478   end
 479
 480   def select_theme
 481     return Rails.configuration.arvados_theme
 482   end
 483 end