services/api/app/controllers/application_controller.rb

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