1 class ApplicationController < ActionController::Base
2 include ArvadosApiClientHelper
4 respond_to :html, :json, :js
7 ERROR_ACTIONS = [:render_error, :render_not_found]
9 around_filter :thread_clear
10 around_filter(:thread_with_mandatory_api_token,
11 except: [:index, :show] + ERROR_ACTIONS)
12 around_filter :thread_with_optional_api_token
13 before_filter :check_user_agreements, except: ERROR_ACTIONS
14 before_filter :check_user_notifications, except: ERROR_ACTIONS
15 around_filter :using_reader_tokens, only: [:index, :show]
16 before_filter :find_object_by_uuid, except: [:index] + ERROR_ACTIONS
20 rescue_from Exception,
21 :with => :render_exception
22 rescue_from ActiveRecord::RecordNotFound,
23 :with => :render_not_found
24 rescue_from ActionController::RoutingError,
25 :with => :render_not_found
26 rescue_from ActionController::UnknownController,
27 :with => :render_not_found
28 rescue_from ::AbstractController::ActionNotFound,
29 :with => :render_not_found
32 def unprocessable(message=nil)
35 @errors << message if message
36 render_error status: 422
39 def render_error(opts)
40 opts = {status: 500}.merge opts
42 # json must come before html here, so it gets used as the
43 # default format when js is requested by the client. This lets
44 # ajax:error callback parse the response correctly, even though
46 f.json { render opts.merge(json: {success: false, errors: @errors}) }
47 f.html { render opts.merge(controller: 'application', action: 'error') }
51 def render_exception(e)
52 logger.error e.inspect
53 logger.error e.backtrace.collect { |x| x + "\n" }.join('') if e.backtrace
54 if @object.andand.errors.andand.full_messages.andand.any?
55 @errors = @object.errors.full_messages
59 self.render_error status: 422
62 def render_not_found(e=ActionController::RoutingError.new("Path not found"))
63 logger.error e.inspect
64 @errors = ["Path not found"]
65 self.render_error status: 404
71 @limit = params[:limit].to_i
76 @offset = params[:offset].to_i
81 filters = params[:filters]
82 if filters.is_a? String
83 filters = Oj.load filters
88 @objects ||= model_class
89 @objects = @objects.filter(@filters).limit(@limit).offset(@offset).all
91 f.json { render json: @objects }
99 return render_not_found("object not found")
102 f.json { render json: @object.attributes.merge(href: url_for(@object)) }
104 if request.method == 'GET'
107 redirect_to params[:return_to] || @object
116 return render_not_found("object not found")
121 @object = model_class.new
125 @updates ||= params[@object.class.to_s.underscore.singularize.to_sym]
126 @updates.keys.each do |attr|
127 if @object.send(attr).is_a? Hash
128 if @updates[attr].is_a? String
129 @updates[attr] = Oj.load @updates[attr]
131 if params[:merge] || params["merge_#{attr}".to_sym]
132 # Merge provided Hash with current Hash, instead of
134 @updates[attr] = @object.send(attr).with_indifferent_access.
135 deep_merge(@updates[attr].with_indifferent_access)
139 if @object.update_attributes @updates
142 self.render_error status: 422
147 @new_resource_attrs ||= params[model_class.to_s.underscore.singularize]
148 @new_resource_attrs ||= {}
149 @new_resource_attrs.reject! { |k,v| k.to_s == 'uuid' }
150 @object ||= model_class.new @new_resource_attrs
158 f.json { render json: @object }
160 redirect_to(params[:return_to] || :back)
165 self.render_error status: 422
170 if Thread.current[:arvados_api_token]
171 Thread.current[:user] ||= User.current
173 logger.error "No API token in Thread"
179 controller_name.classify.constantize
182 def breadcrumb_page_name
183 (@breadcrumb_page_name ||
184 (@object.friendly_link_name if @object.respond_to? :friendly_link_name) ||
193 %w(Attributes Metadata JSON API)
198 def redirect_to_login
201 if request.method == 'GET'
202 redirect_to arvados_api_client.arvados_login_url(return_to: request.url)
204 flash[:error] = "Either you are not logged in, or your session has timed out. I can't automatically log you in and re-attempt this request."
209 @errors = ['You do not seem to be logged in. You did not supply an API token with this request, and your session (if any) has timed out.']
210 self.render_error status: 422
213 false # For convenience to return from callbacks
216 def using_reader_tokens(login_optional=false)
217 if params[:reader_tokens].is_a?(Array) and params[:reader_tokens].any?
218 Thread.current[:reader_tokens] = params[:reader_tokens]
222 rescue ArvadosApiClient::NotLoggedInException
226 return redirect_to_login
229 Thread.current[:reader_tokens] = nil
233 def using_specific_api_token(api_token)
235 [:arvados_api_token, :user].each do |key|
236 start_values[key] = Thread.current[key]
238 Thread.current[:arvados_api_token] = api_token
239 Thread.current[:user] = nil
243 start_values.each_key { |key| Thread.current[key] = start_values[key] }
247 def find_object_by_uuid
248 if params[:id] and params[:id].match /\D/
249 params[:uuid] = params.delete :id
253 elsif params[:uuid].is_a? String
254 if params[:uuid].empty?
257 @object = model_class.find(params[:uuid])
260 @object = model_class.where(uuid: params[:uuid]).first
265 Thread.current[:arvados_api_token] = nil
266 Thread.current[:user] = nil
267 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
269 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
272 def thread_with_api_token(login_optional = false)
274 try_redirect_to_login = true
275 if params[:api_token]
276 try_redirect_to_login = false
277 Thread.current[:arvados_api_token] = params[:api_token]
278 # Before copying the token into session[], do a simple API
279 # call to verify its authenticity.
281 session[:arvados_api_token] = params[:api_token]
282 if !request.format.json? and request.method == 'GET'
283 # Repeat this request with api_token in the (new) session
284 # cookie instead of the query string. This prevents API
285 # tokens from appearing in (and being inadvisedly copied
286 # and pasted from) browser Location bars.
287 redirect_to request.fullpath.sub(%r{([&\?]api_token=)[^&\?]*}, '')
292 @errors = ['Invalid API token']
293 self.render_error status: 401
295 elsif session[:arvados_api_token]
296 # In this case, the token must have already verified at some
297 # point, but it might have been revoked since. We'll try
298 # using it, and catch the exception if it doesn't work.
299 try_redirect_to_login = false
300 Thread.current[:arvados_api_token] = session[:arvados_api_token]
303 rescue ArvadosApiClient::NotLoggedInException
304 try_redirect_to_login = true
307 logger.debug "No token received, session is #{session.inspect}"
309 if try_redirect_to_login
310 unless login_optional
313 # login is optional for this route so go on to the regular controller
314 Thread.current[:arvados_api_token] = nil
319 # Remove token in case this Thread is used for anything else.
320 Thread.current[:arvados_api_token] = nil
324 def thread_with_mandatory_api_token
325 thread_with_api_token do
330 # This runs after thread_with_mandatory_api_token in the filter chain.
331 def thread_with_optional_api_token
332 if Thread.current[:arvados_api_token]
333 # We are already inside thread_with_mandatory_api_token.
336 # We skipped thread_with_mandatory_api_token. Use the optional version.
337 thread_with_api_token(true) do
345 Link.where(uuid: 'just-verifying-my-api-token')
347 rescue ArvadosApiClient::NotLoggedInException
352 def ensure_current_user_is_admin
353 unless current_user and current_user.is_admin
354 @errors = ['Permission denied']
355 self.render_error status: 401
359 def check_user_agreements
360 if current_user && !current_user.is_active && current_user.is_invited
361 signatures = UserAgreement.signatures
362 @signed_ua_uuids = UserAgreement.signatures.map &:head_uuid
363 @required_user_agreements = UserAgreement.all.map do |ua|
364 if not @signed_ua_uuids.index ua.uuid
365 Collection.find(ua.uuid)
368 if @required_user_agreements.empty?
369 # No agreements to sign. Perhaps we just need to ask?
370 current_user.activate
371 if !current_user.is_active
372 logger.warn "#{current_user.uuid.inspect}: " +
373 "No user agreements to sign, but activate failed!"
376 if !current_user.is_active
377 render 'user_agreements/index'
384 return Rails.configuration.arvados_theme
387 @@notification_tests = []
389 @@notification_tests.push lambda { |controller, current_user|
390 AuthorizedKey.limit(1).where(authorized_user_uuid: current_user.uuid).each do
393 return lambda { |view|
394 view.render partial: 'notifications/ssh_key_notification'
398 #@@notification_tests.push lambda { |controller, current_user|
399 # Job.limit(1).where(created_by: current_user.uuid).each do
402 # return lambda { |view|
403 # view.render partial: 'notifications/jobs_notification'
407 @@notification_tests.push lambda { |controller, current_user|
408 Collection.limit(1).where(created_by: current_user.uuid).each do
411 return lambda { |view|
412 view.render partial: 'notifications/collections_notification'
416 @@notification_tests.push lambda { |controller, current_user|
417 PipelineInstance.limit(1).where(created_by: current_user.uuid).each do
420 return lambda { |view|
421 view.render partial: 'notifications/pipelines_notification'
425 def check_user_notifications
426 @notification_count = 0
430 @showallalerts = false
431 @@notification_tests.each do |t|
432 a = t.call(self, current_user)
434 @notification_count += 1
435 @notifications.push a
440 if @notification_count == 0
441 @notification_count = ''