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(1000).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.singularize.to_sym]
 111     @object.save!
 112     respond_to do |f|
 113       f.html {
 114         redirect_to(params[:return_to] || @object)
 115       }
 116       f.js { render }
 117     end
 118   end
 119
 120   def destroy
 121     if @object.destroy
 122       respond_to do |f|
 123         f.html {
 124           redirect_to(params[:return_to] || :back)
 125         }
 126         f.js { render }
 127       end
 128     else
 129       self.render_error status: 422
 130     end
 131   end
 132
 133   def current_user
 134     if Thread.current[:arvados_api_token]
 135       Thread.current[:user] ||= User.current
 136     else
 137       logger.error "No API token in Thread"
 138       return nil
 139     end
 140   end
 141
 142   def model_class
 143     controller_name.classify.constantize
 144   end
 145
 146   def breadcrumb_page_name
 147     (@breadcrumb_page_name ||
 148      (@object.friendly_link_name if @object.respond_to? :friendly_link_name))
 149   end
 150
 151   def index_pane_list
 152     %w(Recent)
 153   end
 154
 155   def show_pane_list
 156     %w(Attributes Metadata JSON API)
 157   end
 158
 159   protected
 160
 161   def find_object_by_uuid
 162     if params[:id] and params[:id].match /\D/
 163       params[:uuid] = params.delete :id
 164     end
 165     if params[:uuid].is_a? String
 166       @object = model_class.find(params[:uuid])
 167     else
 168       @object = model_class.where(uuid: params[:uuid]).first
 169     end
 170   end
 171
 172   def thread_clear
 173     Thread.current[:arvados_api_token] = nil
 174     Thread.current[:user] = nil
 175     Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
 176     yield
 177     Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
 178   end
 179
 180   def thread_with_api_token(login_optional = false)
 181     begin
 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.
 188         if verify_api_token
 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=)[^&\?]*}, '')
 196           else
 197             yield
 198           end
 199         else
 200           @errors = ['Invalid API token']
 201           self.render_error status: 401
 202         end
 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]
 209         begin
 210           yield
 211         rescue ArvadosApiClient::NotLoggedInException
 212           try_redirect_to_login = true
 213         end
 214       else
 215         logger.debug "No token received, session is #{session.inspect}"
 216       end
 217       if try_redirect_to_login
 218         unless login_optional
 219           respond_to do |f|
 220             f.html {
 221               if request.method == 'GET'
 222                 redirect_to $arvados_api_client.arvados_login_url(return_to: request.url)
 223               else
 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."
 225                 redirect_to :back
 226               end
 227             }
 228             f.json {
 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
 231             }
 232           end
 233         else
 234           # login is optional for this route so go on to the regular controller
 235           Thread.current[:arvados_api_token] = nil
 236           yield
 237         end
 238       end
 239     ensure
 240       # Remove token in case this Thread is used for anything else.
 241       Thread.current[:arvados_api_token] = nil
 242     end
 243   end
 244
 245   def thread_with_mandatory_api_token
 246     thread_with_api_token do
 247       yield
 248     end
 249   end
 250
 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.
 255       yield
 256     else
 257       # We skipped thread_with_mandatory_api_token. Use the optional version.
 258       thread_with_api_token(true) do
 259         yield
 260       end
 261     end
 262   end
 263
 264   def verify_api_token
 265     begin
 266       Link.where(uuid: 'just-verifying-my-api-token')
 267       true
 268     rescue ArvadosApiClient::NotLoggedInException
 269       false
 270     end
 271   end
 272
 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
 277     end
 278   end
 279
 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)
 287         end
 288       end.compact
 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!"
 295         end
 296       end
 297       if !current_user.is_active
 298         render 'user_agreements/index'
 299       end
 300     end
 301     true
 302   end
 303
 304   def select_theme
 305     return Rails.configuration.arvados_theme
 306   end
 307
 308   @@notification_tests = []
 309
 310   @@notification_tests.push lambda { |controller, current_user|
 311     AuthorizedKey.limit(1).where(authorized_user_uuid: current_user.uuid).each do
 312       return nil
 313     end
 314     return lambda { |view|
 315       view.render partial: 'notifications/ssh_key_notification'
 316     }
 317   }
 318
 319   @@notification_tests.push lambda { |controller, current_user|
 320     Job.limit(1).where(created_by: current_user.uuid).each do
 321       return nil
 322     end
 323     return lambda { |view|
 324       view.render partial: 'notifications/jobs_notification'
 325     }
 326   }
 327
 328   @@notification_tests.push lambda { |controller, current_user|
 329     Collection.limit(1).where(created_by: current_user.uuid).each do
 330       return nil
 331     end
 332     return lambda { |view|
 333       view.render partial: 'notifications/collections_notification'
 334     }
 335   }
 336
 337   @@notification_tests.push lambda { |controller, current_user|
 338     PipelineInstance.limit(1).where(created_by: current_user.uuid).each do
 339       return nil
 340     end
 341     return lambda { |view|
 342       view.render partial: 'notifications/pipelines_notification'
 343     }
 344   }
 345
 346   def check_user_notifications
 347     @notification_count = 0
 348     @notifications = []
 349
 350     if current_user
 351       @showallalerts = false
 352       @@notification_tests.each do |t|
 353         a = t.call(self, current_user)
 354         if a
 355           @notification_count += 1
 356           @notifications.push a
 357         end
 358       end
 359     end
 360
 361     if @notification_count == 0
 362       @notification_count = ''
 363     end
 364   end
 365 end