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(nil, select: @select)
  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 and @object.errors and @object.errors.full_messages and not @object.errors.full_messages.empty?
 108       errors = @object.errors.full_messages
 109       logger.error errors.inspect
 110     else
 111       errors = [e.inspect]
 112     end
 113     status = e.respond_to?(:http_status) ? e.http_status : 422
 114     send_error(*errors, status: status)
 115   end
 116
 117   def render_not_found(e=ActionController::RoutingError.new("Path not found"))
 118     logger.error e.inspect
 119     send_error("Path not found", status: 404)
 120   end
 121
 122   protected
 123
 124   def send_error(*args)
 125     if args.last.is_a? Hash
 126       err = args.pop
 127     else
 128       err = {}
 129     end
 130     err[:errors] ||= args
 131     err[:error_token] = [Time.now.utc.to_i, "%08x" % rand(16 ** 8)].join("+")
 132     status = err.delete(:status) || 422
 133     logger.error "Error #{err[:error_token]}: #{status}"
 134     render json: err, status: status
 135   end
 136
 137   def find_objects_for_index
 138     @objects ||= model_class.readable_by(*@read_users)
 139     apply_where_limit_order_params
 140   end
 141
 142   def apply_filters
 143     ft = record_filters @filters, @objects.table_name
 144     if ft[:cond_out].any?
 145       @objects = @objects.where(ft[:cond_out].join(' AND '), *ft[:param_out])
 146     end
 147   end
 148
 149   def apply_where_limit_order_params
 150     apply_filters
 151
 152     ar_table_name = @objects.table_name
 153     if @where.is_a? Hash and @where.any?
 154       conditions = ['1=1']
 155       @where.each do |attr,value|
 156         if attr.to_s == 'any'
 157           if value.is_a?(Array) and
 158               value.length == 2 and
 159               value[0] == 'contains' then
 160             ilikes = []
 161             model_class.searchable_columns('ilike').each do |column|
 162               # Including owner_uuid in an "any column" search will
 163               # probably just return a lot of false positives.
 164               next if column == 'owner_uuid'
 165               ilikes << "#{ar_table_name}.#{column} ilike ?"
 166               conditions << "%#{value[1]}%"
 167             end
 168             if ilikes.any?
 169               conditions[0] << ' and (' + ilikes.join(' or ') + ')'
 170             end
 171           end
 172         elsif attr.to_s.match(/^[a-z][_a-z0-9]+$/) and
 173             model_class.columns.collect(&:name).index(attr.to_s)
 174           if value.nil?
 175             conditions[0] << " and #{ar_table_name}.#{attr} is ?"
 176             conditions << nil
 177           elsif value.is_a? Array
 178             if value[0] == 'contains' and value.length == 2
 179               conditions[0] << " and #{ar_table_name}.#{attr} like ?"
 180               conditions << "%#{value[1]}%"
 181             else
 182               conditions[0] << " and #{ar_table_name}.#{attr} in (?)"
 183               conditions << value
 184             end
 185           elsif value.is_a? String or value.is_a? Fixnum or value == true or value == false
 186             conditions[0] << " and #{ar_table_name}.#{attr}=?"
 187             conditions << value
 188           elsif value.is_a? Hash
 189             # Not quite the same thing as "equal?" but better than nothing?
 190             value.each do |k,v|
 191               if v.is_a? String
 192                 conditions[0] << " and #{ar_table_name}.#{attr} ilike ?"
 193                 conditions << "%#{k}%#{v}%"
 194               end
 195             end
 196           end
 197         end
 198       end
 199       if conditions.length > 1
 200         conditions[0].sub!(/^1=1 and /, '')
 201         @objects = @objects.
 202           where(*conditions)
 203       end
 204     end
 205
 206     if @select
 207       unless action_name.in? %w(create update destroy)
 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         @objects = @objects.select(columns_list.join(", "))
 217       end
 218
 219       # This information helps clients understand what they're seeing
 220       # (Workbench always expects it), but they can't select it explicitly
 221       # because it's not an SQL column.  Always add it.
 222       # (This is harmless, given that clients can deduce what they're
 223       # looking at by the returned UUID anyway.)
 224       @select |= ["kind"]
 225     end
 226     @objects = @objects.order(@orders.join ", ") if @orders.any?
 227     @objects = @objects.limit(@limit)
 228     @objects = @objects.offset(@offset)
 229     @objects = @objects.uniq(@distinct) if not @distinct.nil?
 230   end
 231
 232   def resource_attrs
 233     return @attrs if @attrs
 234     @attrs = params[resource_name]
 235     if @attrs.is_a? String
 236       @attrs = Oj.load @attrs, symbol_keys: true
 237     end
 238     unless @attrs.is_a? Hash
 239       message = "No #{resource_name}"
 240       if resource_name.index('_')
 241         message << " (or #{resource_name.camelcase(:lower)})"
 242       end
 243       message << " hash provided with request"
 244       raise ArgumentError.new(message)
 245     end
 246     %w(created_at modified_by_client_uuid modified_by_user_uuid modified_at).each do |x|
 247       @attrs.delete x.to_sym
 248     end
 249     @attrs = @attrs.symbolize_keys if @attrs.is_a? HashWithIndifferentAccess
 250     @attrs
 251   end
 252
 253   # Authentication
 254   def load_read_auths
 255     @read_auths = []
 256     if current_api_client_authorization
 257       @read_auths << current_api_client_authorization
 258     end
 259     # Load reader tokens if this is a read request.
 260     # If there are too many reader tokens, assume the request is malicious
 261     # and ignore it.
 262     if request.get? and params[:reader_tokens] and
 263         params[:reader_tokens].size < 100
 264       @read_auths += ApiClientAuthorization
 265         .includes(:user)
 266         .where('api_token IN (?) AND
 267                 (expires_at IS NULL OR expires_at > CURRENT_TIMESTAMP)',
 268                params[:reader_tokens])
 269         .all
 270     end
 271     @read_auths.select! { |auth| auth.scopes_allow_request? request }
 272     @read_users = @read_auths.map { |auth| auth.user }.uniq
 273   end
 274
 275   def require_login
 276     if not current_user
 277       respond_to do |format|
 278         format.json { send_error("Not logged in", status: 401) }
 279         format.html { redirect_to '/auth/joshid' }
 280       end
 281       false
 282     end
 283   end
 284
 285   def admin_required
 286     unless current_user and current_user.is_admin
 287       send_error("Forbidden", status: 403)
 288     end
 289   end
 290
 291   def require_auth_scope
 292     if @read_auths.empty?
 293       if require_login != false
 294         send_error("Forbidden", status: 403)
 295       end
 296       false
 297     end
 298   end
 299
 300   def respond_with_json_by_default
 301     html_index = request.accepts.index(Mime::HTML)
 302     if html_index.nil? or request.accepts[0...html_index].include?(Mime::JSON)
 303       request.format = :json
 304     end
 305   end
 306
 307   def model_class
 308     controller_name.classify.constantize
 309   end
 310
 311   def resource_name             # params[] key used by client
 312     controller_name.singularize
 313   end
 314
 315   def table_name
 316     controller_name
 317   end
 318
 319   def find_object_by_uuid
 320     if params[:id] and params[:id].match /\D/
 321       params[:uuid] = params.delete :id
 322     end
 323     @where = { uuid: params[:uuid] }
 324     @offset = 0
 325     @limit = 1
 326     @orders = []
 327     @filters = []
 328     @objects = nil
 329     find_objects_for_index
 330     @object = @objects.first
 331   end
 332
 333   def reload_object_before_update
 334     # This is necessary to prevent an ActiveRecord::ReadOnlyRecord
 335     # error when updating an object which was retrieved using a join.
 336     if @object.andand.readonly?
 337       @object = model_class.find_by_uuid(@objects.first.uuid)
 338     end
 339   end
 340
 341   def load_json_value(hash, key, must_be_class=nil)
 342     if hash[key].is_a? String
 343       hash[key] = Oj.load(hash[key], symbol_keys: false)
 344       if must_be_class and !hash[key].is_a? must_be_class
 345         raise TypeError.new("parameter #{key.to_s} must be a #{must_be_class.to_s}")
 346       end
 347     end
 348   end
 349
 350   def self.accept_attribute_as_json(attr, must_be_class=nil)
 351     before_filter lambda { accept_attribute_as_json attr, must_be_class }
 352   end
 353   accept_attribute_as_json :properties, Hash
 354   accept_attribute_as_json :info, Hash
 355   def accept_attribute_as_json(attr, must_be_class)
 356     if params[resource_name] and resource_attrs.is_a? Hash
 357       if resource_attrs[attr].is_a? Hash
 358         # Convert symbol keys to strings (in hashes provided by
 359         # resource_attrs)
 360         resource_attrs[attr] = resource_attrs[attr].
 361           with_indifferent_access.to_hash
 362       else
 363         load_json_value(resource_attrs, attr, must_be_class)
 364       end
 365     end
 366   end
 367
 368   def self.accept_param_as_json(key, must_be_class=nil)
 369     prepend_before_filter lambda { load_json_value(params, key, must_be_class) }
 370   end
 371   accept_param_as_json :reader_tokens, Array
 372
 373   def render_list
 374     @object_list = {
 375       :kind  => "arvados##{(@response_resource_name || resource_name).camelize(:lower)}List",
 376       :etag => "",
 377       :self_link => "",
 378       :offset => @offset,
 379       :limit => @limit,
 380       :items => @objects.as_api_response(nil, {select: @select})
 381     }
 382     if @objects.respond_to? :except
 383       @object_list[:items_available] = @objects.
 384         except(:limit).except(:offset).
 385         count(:id, distinct: true)
 386     end
 387     render json: @object_list
 388   end
 389
 390   def remote_ip
 391     # Caveat: this is highly dependent on the proxy setup. YMMV.
 392     if request.headers.has_key?('HTTP_X_REAL_IP') then
 393       # We're behind a reverse proxy
 394       @remote_ip = request.headers['HTTP_X_REAL_IP']
 395     else
 396       # Hopefully, we are not!
 397       @remote_ip = request.env['REMOTE_ADDR']
 398     end
 399   end
 400
 401   def self._index_requires_parameters
 402     {
 403       filters: { type: 'array', required: false },
 404       where: { type: 'object', required: false },
 405       order: { type: 'array', required: false },
 406       select: { type: 'array', required: false },
 407       distinct: { type: 'boolean', required: false },
 408       limit: { type: 'integer', required: false, default: DEFAULT_LIMIT },
 409       offset: { type: 'integer', required: false, default: 0 },
 410     }
 411   end
 412
 413   def client_accepts_plain_text_stream
 414     (request.headers['Accept'].split(' ') &
 415      ['text/plain', '*/*']).count > 0
 416   end
 417
 418   def render *opts
 419     if opts.first
 420       response = opts.first[:json]
 421       if response.is_a?(Hash) &&
 422           params[:_profile] &&
 423           Thread.current[:request_starttime]
 424         response[:_profile] = {
 425           request_time: Time.now - Thread.current[:request_starttime]
 426         }
 427       end
 428     end
 429     super *opts
 430   end
 431
 432   def select_theme
 433     return Rails.configuration.arvados_theme
 434   end
 435 end