apps/workbench/app/controllers/application_controller.rb

   1 class ApplicationController < ActionController::Base
   2   respond_to :html, :json, :js
   3   protect_from_forgery
   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]
  10   theme :select_theme
  11
  12   begin
  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
  23   end
  24
  25   def unprocessable(message=nil)
  26     @errors ||= []
  27     @errors << message if message
  28     render_error status: 422
  29   end
  30
  31   def render_error(opts)
  32     respond_to do |f|
  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
  36       # the browser can't.
  37       f.json { render opts.merge(json: {success: false, errors: @errors}) }
  38       f.html { render opts.merge(controller: 'application', action: 'error') }
  39     end
  40   end
  41
  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
  47     else
  48       @errors = [e.to_s]
  49     end
  50     self.render_error status: 422
  51   end
  52
  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
  57   end
  58
  59   def index
  60     @objects ||= model_class.limit(200).all
  61     respond_to do |f|
  62       f.json { render json: @objects }
  63       f.html { render }
  64       f.js { render }
  65     end
  66   end
  67
  68   def show
  69     if !@object
  70       return render_not_found("object not found")
  71     end
  72     respond_to do |f|
  73       f.json { render json: @object }
  74       f.html {
  75         if request.method == 'GET'
  76           render
  77         else
  78           redirect_to params[:return_to] || @object
  79         end
  80       }
  81       f.js { render }
  82     end
  83   end
  84
  85   def render_content
  86     if !@object
  87       return render_not_found("object not found")
  88     end
  89   end
  90
  91   def new
  92     @object = model_class.new
  93   end
  94
  95   def update
  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]
 100       end
 101     end
 102     if @object.update_attributes updates
 103       show
 104     else
 105       self.render_error status: 422
 106     end
 107   end
 108
 109   def create
 110     @object ||= model_class.new params[model_class.to_s.underscore.singularize]
 111     @object.save!
 112     respond_to do |f|
 113       f.json { render json: @object }
 114       f.html {
 115         redirect_to(params[:return_to] || @object)
 116       }
 117       f.js { render }
 118     end
 119   end
 120
 121   def destroy
 122     if @object.destroy
 123       respond_to do |f|
 124         f.json { render json: @object }
 125         f.html {
 126           redirect_to(params[:return_to] || :back)
 127         }
 128         f.js { render }
 129       end
 130     else
 131       self.render_error status: 422
 132     end
 133   end
 134
 135   def current_user
 136     if Thread.current[:arvados_api_token]
 137       Thread.current[:user] ||= User.current
 138     else
 139       logger.error "No API token in Thread"
 140       return nil
 141     end
 142   end
 143
 144   def model_class
 145     controller_name.classify.constantize
 146   end
 147
 148   def breadcrumb_page_name
 149     (@breadcrumb_page_name ||
 150      (@object.friendly_link_name if @object.respond_to? :friendly_link_name) ||
 151      action_name)
 152   end
 153
 154   def index_pane_list
 155     %w(Recent)
 156   end
 157
 158   def show_pane_list
 159     %w(Attributes Metadata JSON API)
 160   end
 161
 162   protected
 163
 164   def find_object_by_uuid
 165     if params[:id] and params[:id].match /\D/
 166       params[:uuid] = params.delete :id
 167     end
 168     if params[:uuid].is_a? String
 169       @object = model_class.find(params[:uuid])
 170     else
 171       @object = model_class.where(uuid: params[:uuid]).first
 172     end
 173   end
 174
 175   def thread_clear
 176     Thread.current[:arvados_api_token] = nil
 177     Thread.current[:user] = nil
 178     Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
 179     yield
 180     Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
 181   end
 182
 183   def thread_with_api_token(login_optional = false)
 184     begin
 185       try_redirect_to_login = true
 186       if params[:api_token]
 187         try_redirect_to_login = false
 188         Thread.current[:arvados_api_token] = params[:api_token]
 189         # Before copying the token into session[], do a simple API
 190         # call to verify its authenticity.
 191         if verify_api_token
 192           session[:arvados_api_token] = params[:api_token]
 193           if !request.format.json? and request.method == 'GET'
 194             # Repeat this request with api_token in the (new) session
 195             # cookie instead of the query string.  This prevents API
 196             # tokens from appearing in (and being inadvisedly copied
 197             # and pasted from) browser Location bars.
 198             redirect_to request.fullpath.sub(%r{([&\?]api_token=)[^&\?]*}, '')
 199           else
 200             yield
 201           end
 202         else
 203           @errors = ['Invalid API token']
 204           self.render_error status: 401
 205         end
 206       elsif session[:arvados_api_token]
 207         # In this case, the token must have already verified at some
 208         # point, but it might have been revoked since.  We'll try
 209         # using it, and catch the exception if it doesn't work.
 210         try_redirect_to_login = false
 211         Thread.current[:arvados_api_token] = session[:arvados_api_token]
 212         begin
 213           yield
 214         rescue ArvadosApiClient::NotLoggedInException
 215           try_redirect_to_login = true
 216         end
 217       else
 218         logger.debug "No token received, session is #{session.inspect}"
 219       end
 220       if try_redirect_to_login
 221         unless login_optional
 222           respond_to do |f|
 223             f.html {
 224               if request.method == 'GET'
 225                 redirect_to $arvados_api_client.arvados_login_url(return_to: request.url)
 226               else
 227                 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."
 228                 redirect_to :back
 229               end
 230             }
 231             f.json {
 232               @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.']
 233               self.render_error status: 422
 234             }
 235           end
 236         else
 237           # login is optional for this route so go on to the regular controller
 238           Thread.current[:arvados_api_token] = nil
 239           yield
 240         end
 241       end
 242     ensure
 243       # Remove token in case this Thread is used for anything else.
 244       Thread.current[:arvados_api_token] = nil
 245     end
 246   end
 247
 248   def thread_with_mandatory_api_token
 249     thread_with_api_token do
 250       yield
 251     end
 252   end
 253
 254   # This runs after thread_with_mandatory_api_token in the filter chain.
 255   def thread_with_optional_api_token
 256     if Thread.current[:arvados_api_token]
 257       # We are already inside thread_with_mandatory_api_token.
 258       yield
 259     else
 260       # We skipped thread_with_mandatory_api_token. Use the optional version.
 261       thread_with_api_token(true) do
 262         yield
 263       end
 264     end
 265   end
 266
 267   def verify_api_token
 268     begin
 269       Link.where(uuid: 'just-verifying-my-api-token')
 270       true
 271     rescue ArvadosApiClient::NotLoggedInException
 272       false
 273     end
 274   end
 275
 276   def ensure_current_user_is_admin
 277     unless current_user and current_user.is_admin
 278       @errors = ['Permission denied']
 279       self.render_error status: 401
 280     end
 281   end
 282
 283   def check_user_agreements
 284     if current_user && !current_user.is_active && current_user.is_invited
 285       signatures = UserAgreement.signatures
 286       @signed_ua_uuids = UserAgreement.signatures.map &:head_uuid
 287       @required_user_agreements = UserAgreement.all.map do |ua|
 288         if not @signed_ua_uuids.index ua.uuid
 289           Collection.find(ua.uuid)
 290         end
 291       end.compact
 292       if @required_user_agreements.empty?
 293         # No agreements to sign. Perhaps we just need to ask?
 294         current_user.activate
 295         if !current_user.is_active
 296           logger.warn "#{current_user.uuid.inspect}: " +
 297             "No user agreements to sign, but activate failed!"
 298         end
 299       end
 300       if !current_user.is_active
 301         render 'user_agreements/index'
 302       end
 303     end
 304     true
 305   end
 306
 307   def select_theme
 308     return Rails.configuration.arvados_theme
 309   end
 310
 311   @@notification_tests = []
 312
 313   @@notification_tests.push lambda { |controller, current_user|
 314     AuthorizedKey.limit(1).where(authorized_user_uuid: current_user.uuid).each do
 315       return nil
 316     end
 317     return lambda { |view|
 318       view.render partial: 'notifications/ssh_key_notification'
 319     }
 320   }
 321
 322   @@notification_tests.push lambda { |controller, current_user|
 323     Job.limit(1).where(created_by: current_user.uuid).each do
 324       return nil
 325     end
 326     return lambda { |view|
 327       view.render partial: 'notifications/jobs_notification'
 328     }
 329   }
 330
 331   @@notification_tests.push lambda { |controller, current_user|
 332     Collection.limit(1).where(created_by: current_user.uuid).each do
 333       return nil
 334     end
 335     return lambda { |view|
 336       view.render partial: 'notifications/collections_notification'
 337     }
 338   }
 339
 340   @@notification_tests.push lambda { |controller, current_user|
 341     PipelineInstance.limit(1).where(created_by: current_user.uuid).each do
 342       return nil
 343     end
 344     return lambda { |view|
 345       view.render partial: 'notifications/pipelines_notification'
 346     }
 347   }
 348
 349   def check_user_notifications
 350     @notification_count = 0
 351     @notifications = []
 352
 353     if current_user
 354       @showallalerts = false
 355       @@notification_tests.each do |t|
 356         a = t.call(self, current_user)
 357         if a
 358           @notification_count += 1
 359           @notifications.push a
 360         end
 361       end
 362     end
 363
 364     if @notification_count == 0
 365       @notification_count = ''
 366     end
 367   end
 368 end