services/api/app/controllers/application_controller.rb

   1 module ApiTemplateOverride
   2   def allowed_to_render?(fieldset, field, model, options)
   3     if options[:select]
   4       return options[:select].include? field.to_s
   5     end
   6     super
   7   end
   8 end
   9
  10 class ActsAsApi::ApiTemplate
  11   prepend ApiTemplateOverride
  12 end
  13
  14 require 'load_param'
  15 require 'record_filters'
  16
  17 class ApplicationController < ActionController::Base
  18   include CurrentApiClient
  19   include ThemesForRails::ActionController
  20   include LoadParam
  21   include RecordFilters
  22
  23   respond_to :json
  24   protect_from_forgery
  25
  26   ERROR_ACTIONS = [:render_error, :render_not_found]
  27
  28   before_filter :respond_with_json_by_default
  29   before_filter :remote_ip
  30   before_filter :load_read_auths
  31   before_filter :require_auth_scope, except: ERROR_ACTIONS
  32
  33   before_filter :catch_redirect_hint
  34   before_filter(:find_object_by_uuid,
  35                 except: [:index, :create] + ERROR_ACTIONS)
  36   before_filter :load_limit_offset_order_params, only: [:index, :contents]
  37   before_filter :load_where_param, only: [:index, :contents]
  38   before_filter :load_filters_param, only: [:index, :contents]
  39   before_filter :find_objects_for_index, :only => :index
  40   before_filter :reload_object_before_update, :only => :update
  41   before_filter(:render_404_if_no_object,
  42                 except: [:index, :create] + ERROR_ACTIONS)
  43
  44   theme :select_theme
  45
  46   attr_accessor :resource_attrs
  47
  48   begin
  49     rescue_from(Exception,
  50                 ArvadosModel::PermissionDeniedError,
  51                 :with => :render_error)
  52     rescue_from(ActiveRecord::RecordNotFound,
  53                 ActionController::RoutingError,
  54                 ActionController::UnknownController,
  55                 AbstractController::ActionNotFound,
  56                 :with => :render_not_found)
  57   end
  58
  59   def index
  60     @objects.uniq!(&:id) if @select.nil? or @select.include? "id"
  61     if params[:eager] and params[:eager] != '0' and params[:eager] != 0 and params[:eager] != ''
  62       @objects.each(&:eager_load_associations)
  63     end
  64     render_list
  65   end
  66
  67   def show
  68     render json: @object.as_api_response
  69   end
  70
  71   def create
  72     @object = model_class.new resource_attrs
  73     @object.save!
  74     show
  75   end
  76
  77   def update
  78     attrs_to_update = resource_attrs.reject { |k,v|
  79       [:kind, :etag, :href].index k
  80     }
  81     @object.update_attributes! attrs_to_update
  82     show
  83   end
  84
  85   def destroy
  86     @object.destroy
  87     show
  88   end
  89
  90   def catch_redirect_hint
  91     if !current_user
  92       if params.has_key?('redirect_to') then
  93         session[:redirect_to] = params[:redirect_to]
  94       end
  95     end
  96   end
  97
  98   def render_404_if_no_object
  99     render_not_found "Object not found" if !@object
 100   end
 101
 102   def render_error(e)
 103     logger.error e.inspect
 104     if e.respond_to? :backtrace and e.backtrace
 105       logger.error e.backtrace.collect { |x| x + "\n" }.join('')
 106     end
 107     if (@object.respond_to? :errors and
 108         @object.errors.andand.full_messages.andand.any?)
 109       errors = @object.errors.full_messages
 110       logger.error errors.inspect
 111     else
 112       errors = [e.inspect]
 113     end
 114     status = e.respond_to?(:http_status) ? e.http_status : 422
 115     send_error(*errors, status: status)
 116   end
 117
 118   def render_not_found(e=ActionController::RoutingError.new("Path not found"))
 119     logger.error e.inspect
 120     send_error("Path not found", status: 404)
 121   end
 122
 123   protected
 124
 125   def send_error(*args)
 126     if args.last.is_a? Hash
 127       err = args.pop
 128     else
 129       err = {}
 130     end
 131     err[:errors] ||= args
 132     err[:error_token] = [Time.now.utc.to_i, "%08x" % rand(16 ** 8)].join("+")
 133     status = err.delete(:status) || 422
 134     logger.error "Error #{err[:error_token]}: #{status}"
 135     render json: err, status: status
 136   end
 137
 138   def find_objects_for_index
 139     @objects ||= model_class.readable_by(*@read_users)
 140     apply_where_limit_order_params
 141   end
 142
 143   def apply_filters
 144     ft = record_filters @filters, @objects.table_name
 145     if ft[:cond_out].any?
 146       @objects = @objects.where(ft[:cond_out].join(' AND '), *ft[:param_out])
 147     end
 148   end
 149
 150   def apply_where_limit_order_params
 151     apply_filters
 152
 153     ar_table_name = @objects.table_name
 154     if @where.is_a? Hash and @where.any?
 155       conditions = ['1=1']
 156       @where.each do |attr,value|
 157         if attr.to_s == 'any'
 158           if value.is_a?(Array) and
 159               value.length == 2 and
 160               value[0] == 'contains' then
 161             ilikes = []
 162             model_class.searchable_columns('ilike').each do |column|
 163               # Including owner_uuid in an "any column" search will
 164               # probably just return a lot of false positives.
 165               next if column == 'owner_uuid'
 166               ilikes << "#{ar_table_name}.#{column} ilike ?"
 167               conditions << "%#{value[1]}%"
 168             end
 169             if ilikes.any?
 170               conditions[0] << ' and (' + ilikes.join(' or ') + ')'
 171             end
 172           end
 173         elsif attr.to_s.match(/^[a-z][_a-z0-9]+$/) and
 174             model_class.columns.collect(&:name).index(attr.to_s)
 175           if value.nil?
 176             conditions[0] << " and #{ar_table_name}.#{attr} is ?"
 177             conditions << nil
 178           elsif value.is_a? Array
 179             if value[0] == 'contains' and value.length == 2
 180               conditions[0] << " and #{ar_table_name}.#{attr} like ?"
 181               conditions << "%#{value[1]}%"
 182             else
 183               conditions[0] << " and #{ar_table_name}.#{attr} in (?)"
 184               conditions << value
 185             end
 186           elsif value.is_a? String or value.is_a? Fixnum or value == true or value == false
 187             conditions[0] << " and #{ar_table_name}.#{attr}=?"
 188             conditions << value
 189           elsif value.is_a? Hash
 190             # Not quite the same thing as "equal?" but better than nothing?
 191             value.each do |k,v|
 192               if v.is_a? String
 193                 conditions[0] << " and #{ar_table_name}.#{attr} ilike ?"
 194                 conditions << "%#{k}%#{v}%"
 195               end
 196             end
 197           end
 198         end
 199       end
 200       if conditions.length > 1
 201         conditions[0].sub!(/^1=1 and /, '')
 202         @objects = @objects.
 203           where(*conditions)
 204       end
 205     end
 206
 207     if @select
 208       # Map attribute names in @select to real column names, resolve
 209       # those to fully-qualified SQL column names, and pass the
 210       # resulting string to the select method.
 211       api_column_map = model_class.attributes_required_columns
 212       columns_list = @select.
 213         flat_map { |attr| api_column_map[attr] }.
 214         uniq.
 215         map { |s| "#{table_name}.#{ActiveRecord::Base.connection.quote_column_name s}" }
 216       columns_list += ["#{table_name}.id"] if not @distinct
 217       @objects = @objects.select(columns_list.join(", "))
 218     end
 219     @objects = @objects.order(@orders.join ", ") if @orders.any?
 220     @objects = @objects.limit(@limit)
 221     @objects = @objects.offset(@offset)
 222     @objects = @objects.uniq(@distinct) if not @distinct.nil?
 223   end
 224
 225   def resource_attrs
 226     return @attrs if @attrs
 227     @attrs = params[resource_name]
 228     if @attrs.is_a? String
 229       @attrs = Oj.load @attrs, symbol_keys: true
 230     end
 231     unless @attrs.is_a? Hash
 232       message = "No #{resource_name}"
 233       if resource_name.index('_')
 234         message << " (or #{resource_name.camelcase(:lower)})"
 235       end
 236       message << " hash provided with request"
 237       raise ArgumentError.new(message)
 238     end
 239     %w(created_at modified_by_client_uuid modified_by_user_uuid modified_at).each do |x|
 240       @attrs.delete x.to_sym
 241     end
 242     @attrs = @attrs.symbolize_keys if @attrs.is_a? HashWithIndifferentAccess
 243     @attrs
 244   end
 245
 246   # Authentication
 247   def load_read_auths
 248     @read_auths = []
 249     if current_api_client_authorization
 250       @read_auths << current_api_client_authorization
 251     end
 252     # Load reader tokens if this is a read request.
 253     # If there are too many reader tokens, assume the request is malicious
 254     # and ignore it.
 255     if request.get? and params[:reader_tokens] and
 256         params[:reader_tokens].size < 100
 257       @read_auths += ApiClientAuthorization
 258         .includes(:user)
 259         .where('api_token IN (?) AND
 260                 (expires_at IS NULL OR expires_at > CURRENT_TIMESTAMP)',
 261                params[:reader_tokens])
 262         .all
 263     end
 264     @read_auths.select! { |auth| auth.scopes_allow_request? request }
 265     @read_users = @read_auths.map { |auth| auth.user }.uniq
 266   end
 267
 268   def require_login
 269     if not current_user
 270       respond_to do |format|
 271         format.json { send_error("Not logged in", status: 401) }
 272         format.html { redirect_to '/auth/joshid' }
 273       end
 274       false
 275     end
 276   end
 277
 278   def admin_required
 279     unless current_user and current_user.is_admin
 280       send_error("Forbidden", status: 403)
 281     end
 282   end
 283
 284   def require_auth_scope
 285     if @read_auths.empty?
 286       if require_login != false
 287         send_error("Forbidden", status: 403)
 288       end
 289       false
 290     end
 291   end
 292
 293   def respond_with_json_by_default
 294     html_index = request.accepts.index(Mime::HTML)
 295     if html_index.nil? or request.accepts[0...html_index].include?(Mime::JSON)
 296       request.format = :json
 297     end
 298   end
 299
 300   def model_class
 301     controller_name.classify.constantize
 302   end
 303
 304   def resource_name             # params[] key used by client
 305     controller_name.singularize
 306   end
 307
 308   def table_name
 309     controller_name
 310   end
 311
 312   def find_object_by_uuid
 313     if params[:id] and params[:id].match /\D/
 314       params[:uuid] = params.delete :id
 315     end
 316     @where = { uuid: params[:uuid] }
 317     @offset = 0
 318     @limit = 1
 319     @orders = []
 320     @filters = []
 321     @objects = nil
 322     find_objects_for_index
 323     @object = @objects.first
 324   end
 325
 326   def reload_object_before_update
 327     # This is necessary to prevent an ActiveRecord::ReadOnlyRecord
 328     # error when updating an object which was retrieved using a join.
 329     if @object.andand.readonly?
 330       @object = model_class.find_by_uuid(@objects.first.uuid)
 331     end
 332   end
 333
 334   def load_json_value(hash, key, must_be_class=nil)
 335     if hash[key].is_a? String
 336       hash[key] = Oj.load(hash[key], symbol_keys: false)
 337       if must_be_class and !hash[key].is_a? must_be_class
 338         raise TypeError.new("parameter #{key.to_s} must be a #{must_be_class.to_s}")
 339       end
 340     end
 341   end
 342
 343   def self.accept_attribute_as_json(attr, must_be_class=nil)
 344     before_filter lambda { accept_attribute_as_json attr, must_be_class }
 345   end
 346   accept_attribute_as_json :properties, Hash
 347   accept_attribute_as_json :info, Hash
 348   def accept_attribute_as_json(attr, must_be_class)
 349     if params[resource_name] and resource_attrs.is_a? Hash
 350       if resource_attrs[attr].is_a? Hash
 351         # Convert symbol keys to strings (in hashes provided by
 352         # resource_attrs)
 353         resource_attrs[attr] = resource_attrs[attr].
 354           with_indifferent_access.to_hash
 355       else
 356         load_json_value(resource_attrs, attr, must_be_class)
 357       end
 358     end
 359   end
 360
 361   def self.accept_param_as_json(key, must_be_class=nil)
 362     prepend_before_filter lambda { load_json_value(params, key, must_be_class) }
 363   end
 364   accept_param_as_json :reader_tokens, Array
 365
 366   def render_list
 367     if @select
 368       # This information helps clients understand what they're seeing
 369       # (Workbench always expects it), but they can't select it explicitly
 370       # because it's not an SQL column.  Always add it.
 371       # I believe this is safe because clients can always deduce what they're
 372       # looking at by the returned UUID anyway.
 373       @select |= ["kind"]
 374     end
 375     @object_list = {
 376       :kind  => "arvados##{(@response_resource_name || resource_name).camelize(:lower)}List",
 377       :etag => "",
 378       :self_link => "",
 379       :offset => @offset,
 380       :limit => @limit,
 381       :items => @objects.as_api_response(nil, {select: @select})
 382     }
 383     if @objects.respond_to? :except
 384       @object_list[:items_available] = @objects.
 385         except(:limit).except(:offset).
 386         count(:id, distinct: true)
 387     end
 388     render json: @object_list
 389   end
 390
 391   def remote_ip
 392     # Caveat: this is highly dependent on the proxy setup. YMMV.
 393     if request.headers.has_key?('HTTP_X_REAL_IP') then
 394       # We're behind a reverse proxy
 395       @remote_ip = request.headers['HTTP_X_REAL_IP']
 396     else
 397       # Hopefully, we are not!
 398       @remote_ip = request.env['REMOTE_ADDR']
 399     end
 400   end
 401
 402   def self._index_requires_parameters
 403     {
 404       filters: { type: 'array', required: false },
 405       where: { type: 'object', required: false },
 406       order: { type: 'array', required: false },
 407       select: { type: 'array', required: false },
 408       distinct: { type: 'boolean', required: false },
 409       limit: { type: 'integer', required: false, default: DEFAULT_LIMIT },
 410       offset: { type: 'integer', required: false, default: 0 },
 411     }
 412   end
 413
 414   def client_accepts_plain_text_stream
 415     (request.headers['Accept'].split(' ') &
 416      ['text/plain', '*/*']).count > 0
 417   end
 418
 419   def render *opts
 420     if opts.first
 421       response = opts.first[:json]
 422       if response.is_a?(Hash) &&
 423           params[:_profile] &&
 424           Thread.current[:request_starttime]
 425         response[:_profile] = {
 426           request_time: Time.now - Thread.current[:request_starttime]
 427         }
 428       end
 429     end
 430     super *opts
 431   end
 432
 433   def select_theme
 434     return Rails.configuration.arvados_theme
 435   end
 436 end