discourse/lib/auth/current_user_provider.rb

42 lines
919 B
Ruby
Raw Normal View History

module Auth; end
class Auth::CurrentUserProvider
# do all current user initialization here
def initialize(env)
raise NotImplementedError
end
# our current user, return nil if none is found
def current_user
raise NotImplementedError
end
# log on a user and set cookies and session etc.
2017-07-27 21:20:09 -04:00
def log_on_user(user, session, cookies)
raise NotImplementedError
end
# optional interface to be called to refresh cookies etc if needed
2017-07-27 21:20:09 -04:00
def refresh_session(user, session, cookies)
end
# api has special rights return true if api was detected
def is_api?
raise NotImplementedError
end
def is_user_api?
raise NotImplementedError
end
# we may need to know very early on in the middleware if an auth token
# exists, to optimise caching
def has_auth_cookie?
raise NotImplementedError
end
def log_off_user(session, cookies)
raise NotImplementedError
end
end