1 class ApplicationController < ActionController::Base
2 respond_to :html, :json, :js
4 around_filter :thread_clear
5 around_filter :thread_with_mandatory_api_token, :except => [:render_exception, :render_not_found]
6 around_filter :thread_with_optional_api_token
7 before_filter :find_object_by_uuid, :except => [:index, :render_exception, :render_not_found]
8 before_filter :check_user_agreements, :except => [:render_exception, :render_not_found]
9 before_filter :check_user_notifications, :except => [:render_exception, :render_not_found]
13 rescue_from Exception,
14 :with => :render_exception
15 rescue_from ActiveRecord::RecordNotFound,
16 :with => :render_not_found
17 rescue_from ActionController::RoutingError,
18 :with => :render_not_found
19 rescue_from ActionController::UnknownController,
20 :with => :render_not_found
21 rescue_from ::AbstractController::ActionNotFound,
22 :with => :render_not_found
25 def unprocessable(message=nil)
27 @errors << message if message
28 render_error status: 422
31 def render_error(opts)
33 # json must come before html here, so it gets used as the
34 # default format when js is requested by the client. This lets
35 # ajax:error callback parse the response correctly, even though
37 f.json { render opts.merge(json: {success: false, errors: @errors}) }
38 f.html { render opts.merge(controller: 'application', action: 'error') }
42 def render_exception(e)
43 logger.error e.inspect
44 logger.error e.backtrace.collect { |x| x + "\n" }.join('') if e.backtrace
45 if @object.andand.errors.andand.full_messages.andand.any?
46 @errors = @object.errors.full_messages
50 self.render_error status: 422
53 def render_not_found(e=ActionController::RoutingError.new("Path not found"))
54 logger.error e.inspect
55 @errors = ["Path not found"]
56 self.render_error status: 404
60 @objects ||= model_class.limit(200).all
62 f.json { render json: @objects }
70 return render_not_found("object not found")
73 f.json { render json: @object }
75 if request.method == 'GET'
78 redirect_to params[:return_to] || @object
87 return render_not_found("object not found")
92 @object = model_class.new
96 updates = params[@object.class.to_s.underscore.singularize.to_sym]
97 updates.keys.each do |attr|
98 if @object.send(attr).is_a? Hash and updates[attr].is_a? String
99 updates[attr] = Oj.load updates[attr]
102 if @object.update_attributes updates
105 self.render_error status: 422
110 @object ||= model_class.new params[model_class.to_s.singularize.to_sym]
114 redirect_to(params[:return_to] || @object)
124 redirect_to(params[:return_to] || :back)
129 self.render_error status: 422
134 if Thread.current[:arvados_api_token]
135 Thread.current[:user] ||= User.current
137 logger.error "No API token in Thread"
143 controller_name.classify.constantize
146 def breadcrumb_page_name
147 (@breadcrumb_page_name ||
148 (@object.friendly_link_name if @object.respond_to? :friendly_link_name))
156 %w(Attributes Metadata JSON API)
161 def find_object_by_uuid
162 if params[:id] and params[:id].match /\D/
163 params[:uuid] = params.delete :id
165 if params[:uuid].is_a? String
166 @object = model_class.find(params[:uuid])
168 @object = model_class.where(uuid: params[:uuid]).first
173 Thread.current[:arvados_api_token] = nil
174 Thread.current[:user] = nil
175 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
177 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
180 def thread_with_api_token(login_optional = false)
182 try_redirect_to_login = true
183 if params[:api_token]
184 try_redirect_to_login = false
185 Thread.current[:arvados_api_token] = params[:api_token]
186 # Before copying the token into session[], do a simple API
187 # call to verify its authenticity.
189 session[:arvados_api_token] = params[:api_token]
190 if !request.format.json? and request.method == 'GET'
191 # Repeat this request with api_token in the (new) session
192 # cookie instead of the query string. This prevents API
193 # tokens from appearing in (and being inadvisedly copied
194 # and pasted from) browser Location bars.
195 redirect_to request.fullpath.sub(%r{([&\?]api_token=)[^&\?]*}, '')
200 @errors = ['Invalid API token']
201 self.render_error status: 401
203 elsif session[:arvados_api_token]
204 # In this case, the token must have already verified at some
205 # point, but it might have been revoked since. We'll try
206 # using it, and catch the exception if it doesn't work.
207 try_redirect_to_login = false
208 Thread.current[:arvados_api_token] = session[:arvados_api_token]
211 rescue ArvadosApiClient::NotLoggedInException
212 try_redirect_to_login = true
215 logger.debug "No token received, session is #{session.inspect}"
217 if try_redirect_to_login
218 unless login_optional
221 if request.method == 'GET'
222 redirect_to $arvados_api_client.arvados_login_url(return_to: request.url)
224 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."
229 @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.']
230 self.render_error status: 422
234 # login is optional for this route so go on to the regular controller
235 Thread.current[:arvados_api_token] = nil
240 # Remove token in case this Thread is used for anything else.
241 Thread.current[:arvados_api_token] = nil
245 def thread_with_mandatory_api_token
246 thread_with_api_token do
251 # This runs after thread_with_mandatory_api_token in the filter chain.
252 def thread_with_optional_api_token
253 if Thread.current[:arvados_api_token]
254 # We are already inside thread_with_mandatory_api_token.
257 # We skipped thread_with_mandatory_api_token. Use the optional version.
258 thread_with_api_token(true) do
266 Link.where(uuid: 'just-verifying-my-api-token')
268 rescue ArvadosApiClient::NotLoggedInException
273 def ensure_current_user_is_admin
274 unless current_user and current_user.is_admin
275 @errors = ['Permission denied']
276 self.render_error status: 401
280 def check_user_agreements
281 if current_user && !current_user.is_active && current_user.is_invited
282 signatures = UserAgreement.signatures
283 @signed_ua_uuids = UserAgreement.signatures.map &:head_uuid
284 @required_user_agreements = UserAgreement.all.map do |ua|
285 if not @signed_ua_uuids.index ua.uuid
286 Collection.find(ua.uuid)
289 if @required_user_agreements.empty?
290 # No agreements to sign. Perhaps we just need to ask?
291 current_user.activate
292 if !current_user.is_active
293 logger.warn "#{current_user.uuid.inspect}: " +
294 "No user agreements to sign, but activate failed!"
297 if !current_user.is_active
298 render 'user_agreements/index'
305 return Rails.configuration.arvados_theme
308 @@notification_tests = []
310 @@notification_tests.push lambda { |controller, current_user|
311 AuthorizedKey.limit(1).where(authorized_user_uuid: current_user.uuid).each do
314 return lambda { |view|
315 view.render partial: 'notifications/ssh_key_notification'
319 @@notification_tests.push lambda { |controller, current_user|
320 Job.limit(1).where(created_by: current_user.uuid).each do
323 return lambda { |view|
324 view.render partial: 'notifications/jobs_notification'
328 @@notification_tests.push lambda { |controller, current_user|
329 Collection.limit(1).where(created_by: current_user.uuid).each do
332 return lambda { |view|
333 view.render partial: 'notifications/collections_notification'
337 @@notification_tests.push lambda { |controller, current_user|
338 PipelineInstance.limit(1).where(created_by: current_user.uuid).each do
341 return lambda { |view|
342 view.render partial: 'notifications/pipelines_notification'
346 def check_user_notifications
347 @notification_count = 0
351 @showallalerts = false
352 @@notification_tests.each do |t|
353 a = t.call(self, current_user)
355 @notification_count += 1
356 @notifications.push a
361 if @notification_count == 0
362 @notification_count = ''