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     @new_resource_attrs ||= {}
 134     @new_resource_attrs.reject! { |k,v| k.to_s == 'uuid' }
 135     @object ||= model_class.new @new_resource_attrs
 136     @object.save!
 137
 138     respond_to do |f|
 139       f.json { render json: @object }
 140       f.html {
 141         redirect_to(params[:return_to] || @object)
 142       }
 143       f.js { render }
 144     end
 145   end
 146
 147   def destroy
 148     if @object.destroy
 149       respond_to do |f|
 150         f.json { render json: @object }
 151         f.html {
 152           redirect_to(params[:return_to] || :back)
 153         }
 154         f.js { render }
 155       end
 156     else
 157       self.render_error status: 422
 158     end
 159   end
 160
 161   def current_user
 162     if Thread.current[:arvados_api_token]
 163       Thread.current[:user] ||= User.current
 164     else
 165       logger.error "No API token in Thread"
 166       return nil
 167     end
 168   end
 169
 170   def model_class
 171     controller_name.classify.constantize
 172   end
 173
 174   def breadcrumb_page_name
 175     (@breadcrumb_page_name ||
 176      (@object.friendly_link_name if @object.respond_to? :friendly_link_name) ||
 177      action_name)
 178   end
 179
 180   def index_pane_list
 181     %w(Recent)
 182   end
 183
 184   def show_pane_list
 185     %w(Attributes Metadata JSON API)
 186   end
 187
 188   protected
 189
 190   def find_object_by_uuid
 191     if params[:id] and params[:id].match /\D/
 192       params[:uuid] = params.delete :id
 193     end
 194     if params[:uuid].is_a? String
 195       @object = model_class.find(params[:uuid])
 196     else
 197       @object = model_class.where(uuid: params[:uuid]).first
 198     end
 199   end
 200
 201   def thread_clear
 202     Thread.current[:arvados_api_token] = nil
 203     Thread.current[:user] = nil
 204     Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
 205     yield
 206     Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
 207   end
 208
 209   def thread_with_api_token(login_optional = false)
 210     begin
 211       try_redirect_to_login = true
 212       if params[:api_token]
 213         try_redirect_to_login = false
 214         Thread.current[:arvados_api_token] = params[:api_token]
 215         # Before copying the token into session[], do a simple API
 216         # call to verify its authenticity.
 217         if verify_api_token
 218           session[:arvados_api_token] = params[:api_token]
 219           if !request.format.json? and request.method == 'GET'
 220             # Repeat this request with api_token in the (new) session
 221             # cookie instead of the query string.  This prevents API
 222             # tokens from appearing in (and being inadvisedly copied
 223             # and pasted from) browser Location bars.
 224             redirect_to request.fullpath.sub(%r{([&\?]api_token=)[^&\?]*}, '')
 225           else
 226             yield
 227           end
 228         else
 229           @errors = ['Invalid API token']
 230           self.render_error status: 401
 231         end
 232       elsif session[:arvados_api_token]
 233         # In this case, the token must have already verified at some
 234         # point, but it might have been revoked since.  We'll try
 235         # using it, and catch the exception if it doesn't work.
 236         try_redirect_to_login = false
 237         Thread.current[:arvados_api_token] = session[:arvados_api_token]
 238         begin
 239           yield
 240         rescue ArvadosApiClient::NotLoggedInException
 241           try_redirect_to_login = true
 242         end
 243       else
 244         logger.debug "No token received, session is #{session.inspect}"
 245       end
 246       if try_redirect_to_login
 247         unless login_optional
 248           respond_to do |f|
 249             f.html {
 250               if request.method == 'GET'
 251                 redirect_to $arvados_api_client.arvados_login_url(return_to: request.url)
 252               else
 253                 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."
 254                 redirect_to :back
 255               end
 256             }
 257             f.json {
 258               @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.']
 259               self.render_error status: 422
 260             }
 261           end
 262         else
 263           # login is optional for this route so go on to the regular controller
 264           Thread.current[:arvados_api_token] = nil
 265           yield
 266         end
 267       end
 268     ensure
 269       # Remove token in case this Thread is used for anything else.
 270       Thread.current[:arvados_api_token] = nil
 271     end
 272   end
 273
 274   def thread_with_mandatory_api_token
 275     thread_with_api_token do
 276       yield
 277     end
 278   end
 279
 280   # This runs after thread_with_mandatory_api_token in the filter chain.
 281   def thread_with_optional_api_token
 282     if Thread.current[:arvados_api_token]
 283       # We are already inside thread_with_mandatory_api_token.
 284       yield
 285     else
 286       # We skipped thread_with_mandatory_api_token. Use the optional version.
 287       thread_with_api_token(true) do
 288         yield
 289       end
 290     end
 291   end
 292
 293   def verify_api_token
 294     begin
 295       Link.where(uuid: 'just-verifying-my-api-token')
 296       true
 297     rescue ArvadosApiClient::NotLoggedInException
 298       false
 299     end
 300   end
 301
 302   def ensure_current_user_is_admin
 303     unless current_user and current_user.is_admin
 304       @errors = ['Permission denied']
 305       self.render_error status: 401
 306     end
 307   end
 308
 309   def check_user_agreements
 310     if current_user && !current_user.is_active && current_user.is_invited
 311       signatures = UserAgreement.signatures
 312       @signed_ua_uuids = UserAgreement.signatures.map &:head_uuid
 313       @required_user_agreements = UserAgreement.all.map do |ua|
 314         if not @signed_ua_uuids.index ua.uuid
 315           Collection.find(ua.uuid)
 316         end
 317       end.compact
 318       if @required_user_agreements.empty?
 319         # No agreements to sign. Perhaps we just need to ask?
 320         current_user.activate
 321         if !current_user.is_active
 322           logger.warn "#{current_user.uuid.inspect}: " +
 323             "No user agreements to sign, but activate failed!"
 324         end
 325       end
 326       if !current_user.is_active
 327         render 'user_agreements/index'
 328       end
 329     end
 330     true
 331   end
 332
 333   def select_theme
 334     return Rails.configuration.arvados_theme
 335   end
 336
 337   @@notification_tests = []
 338
 339   @@notification_tests.push lambda { |controller, current_user|
 340     AuthorizedKey.limit(1).where(authorized_user_uuid: current_user.uuid).each do
 341       return nil
 342     end
 343     return lambda { |view|
 344       view.render partial: 'notifications/ssh_key_notification'
 345     }
 346   }
 347
 348   #@@notification_tests.push lambda { |controller, current_user|
 349   #  Job.limit(1).where(created_by: current_user.uuid).each do
 350   #    return nil
 351   #  end
 352   #  return lambda { |view|
 353   #    view.render partial: 'notifications/jobs_notification'
 354   #  }
 355   #}
 356
 357   @@notification_tests.push lambda { |controller, current_user|
 358     Collection.limit(1).where(created_by: current_user.uuid).each do
 359       return nil
 360     end
 361     return lambda { |view|
 362       view.render partial: 'notifications/collections_notification'
 363     }
 364   }
 365
 366   @@notification_tests.push lambda { |controller, current_user|
 367     PipelineInstance.limit(1).where(created_by: current_user.uuid).each do
 368       return nil
 369     end
 370     return lambda { |view|
 371       view.render partial: 'notifications/pipelines_notification'
 372     }
 373   }
 374
 375   def check_user_notifications
 376     @notification_count = 0
 377     @notifications = []
 378
 379     if current_user
 380       @showallalerts = false
 381       @@notification_tests.each do |t|
 382         a = t.call(self, current_user)
 383         if a
 384           @notification_count += 1
 385           @notifications.push a
 386         end
 387       end
 388     end
 389
 390     if @notification_count == 0
 391       @notification_count = ''
 392     end
 393   end
 394 end