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.underscore.singularize]
113 f.json { render json: @object }
115 redirect_to(params[:return_to] || @object)
124 f.json { render json: @object }
126 redirect_to(params[:return_to] || :back)
131 self.render_error status: 422
136 if Thread.current[:arvados_api_token]
137 Thread.current[:user] ||= User.current
139 logger.error "No API token in Thread"
145 controller_name.classify.constantize
148 def breadcrumb_page_name
149 (@breadcrumb_page_name ||
150 (@object.friendly_link_name if @object.respond_to? :friendly_link_name))
158 %w(Attributes Metadata JSON API)
163 def find_object_by_uuid
164 if params[:id] and params[:id].match /\D/
165 params[:uuid] = params.delete :id
167 if params[:uuid].is_a? String
168 @object = model_class.find(params[:uuid])
170 @object = model_class.where(uuid: params[:uuid]).first
175 Thread.current[:arvados_api_token] = nil
176 Thread.current[:user] = nil
177 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
179 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
182 def thread_with_api_token(login_optional = false)
184 try_redirect_to_login = true
185 if params[:api_token]
186 try_redirect_to_login = false
187 Thread.current[:arvados_api_token] = params[:api_token]
188 # Before copying the token into session[], do a simple API
189 # call to verify its authenticity.
191 session[:arvados_api_token] = params[:api_token]
192 if !request.format.json? and request.method == 'GET'
193 # Repeat this request with api_token in the (new) session
194 # cookie instead of the query string. This prevents API
195 # tokens from appearing in (and being inadvisedly copied
196 # and pasted from) browser Location bars.
197 redirect_to request.fullpath.sub(%r{([&\?]api_token=)[^&\?]*}, '')
202 @errors = ['Invalid API token']
203 self.render_error status: 401
205 elsif session[:arvados_api_token]
206 # In this case, the token must have already verified at some
207 # point, but it might have been revoked since. We'll try
208 # using it, and catch the exception if it doesn't work.
209 try_redirect_to_login = false
210 Thread.current[:arvados_api_token] = session[:arvados_api_token]
213 rescue ArvadosApiClient::NotLoggedInException
214 try_redirect_to_login = true
217 logger.debug "No token received, session is #{session.inspect}"
219 if try_redirect_to_login
220 unless login_optional
223 if request.method == 'GET'
224 redirect_to $arvados_api_client.arvados_login_url(return_to: request.url)
226 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."
231 @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.']
232 self.render_error status: 422
236 # login is optional for this route so go on to the regular controller
237 Thread.current[:arvados_api_token] = nil
242 # Remove token in case this Thread is used for anything else.
243 Thread.current[:arvados_api_token] = nil
247 def thread_with_mandatory_api_token
248 thread_with_api_token do
253 # This runs after thread_with_mandatory_api_token in the filter chain.
254 def thread_with_optional_api_token
255 if Thread.current[:arvados_api_token]
256 # We are already inside thread_with_mandatory_api_token.
259 # We skipped thread_with_mandatory_api_token. Use the optional version.
260 thread_with_api_token(true) do
268 Link.where(uuid: 'just-verifying-my-api-token')
270 rescue ArvadosApiClient::NotLoggedInException
275 def ensure_current_user_is_admin
276 unless current_user and current_user.is_admin
277 @errors = ['Permission denied']
278 self.render_error status: 401
282 def check_user_agreements
283 if current_user && !current_user.is_active && current_user.is_invited
284 signatures = UserAgreement.signatures
285 @signed_ua_uuids = UserAgreement.signatures.map &:head_uuid
286 @required_user_agreements = UserAgreement.all.map do |ua|
287 if not @signed_ua_uuids.index ua.uuid
288 Collection.find(ua.uuid)
291 if @required_user_agreements.empty?
292 # No agreements to sign. Perhaps we just need to ask?
293 current_user.activate
294 if !current_user.is_active
295 logger.warn "#{current_user.uuid.inspect}: " +
296 "No user agreements to sign, but activate failed!"
299 if !current_user.is_active
300 render 'user_agreements/index'
307 return Rails.configuration.arvados_theme
310 @@notification_tests = []
312 @@notification_tests.push lambda { |controller, current_user|
313 AuthorizedKey.limit(1).where(authorized_user_uuid: current_user.uuid).each do
316 return lambda { |view|
317 view.render partial: 'notifications/ssh_key_notification'
321 @@notification_tests.push lambda { |controller, current_user|
322 Job.limit(1).where(created_by: current_user.uuid).each do
325 return lambda { |view|
326 view.render partial: 'notifications/jobs_notification'
330 @@notification_tests.push lambda { |controller, current_user|
331 Collection.limit(1).where(created_by: current_user.uuid).each do
334 return lambda { |view|
335 view.render partial: 'notifications/collections_notification'
339 @@notification_tests.push lambda { |controller, current_user|
340 PipelineInstance.limit(1).where(created_by: current_user.uuid).each do
343 return lambda { |view|
344 view.render partial: 'notifications/pipelines_notification'
348 def check_user_notifications
349 @notification_count = 0
353 @showallalerts = false
354 @@notification_tests.each do |t|
355 a = t.call(self, current_user)
357 @notification_count += 1
358 @notifications.push a
363 if @notification_count == 0
364 @notification_count = ''