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