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