apps/workbench/app/controllers/application_controller.rb

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