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