Module: CamaleonCms::SessionHelper
- Included in:
- CamaleonController
- Defined in:
- app/helpers/camaleon_cms/session_helper.rb
Instance Method Summary collapse
-
#cama_authenticate(redirect_uri = nil) ⇒ Object
check if a visitor was logged in if the user was not logged in, then redirect to login url.
-
#cama_current_role ⇒ Object
return the role for current user if not logged in, then return ‘public’.
-
#cama_current_user ⇒ Object
return current user logged in.
-
#cama_get_session_id ⇒ Object
return the session id.
-
#cama_logout_user ⇒ Object
logout current user.
-
#cama_on_heroku? ⇒ Boolean
check if current host is heroku.
-
#cama_register_user(user_data, meta) ⇒ Object
User registration.
-
#cama_sign_in? ⇒ Boolean
(also: #signin?)
check if current user is already signed.
-
#login_user(user, remember_me = false, redirect_url = nil) ⇒ Object
log in the user in to system user: User model remember_me: true/false (remember session permanently) redirect_url (default nil): after initialized the session, this will be redirected to “redirect_url” if defined it doesn’t redirect if redirect_url === false return to previous page if defined the cookie or login url received extra param: return_to=mysite.com.
-
#login_user_with_password(username, password) ⇒ Object
login a user using username and password return boolean: true => authenticated, false => authentication failed.
-
#session_back_to_parent(redirect_url = nil) ⇒ Object
switch current session into parent session called by session_switch_user after returned into parent session, this will be redirected to redirect_url or admin dashboard.
-
#session_switch_user(user, redirect_url = nil) ⇒ Object
switch current session user into other (user) after switched, this will be redirected to redirect_url or admin dashboard.
Instance Method Details
#cama_authenticate(redirect_uri = nil) ⇒ Object
check if a visitor was logged in if the user was not logged in, then redirect to login url
132 133 134 135 136 137 138 139 |
# File 'app/helpers/camaleon_cms/session_helper.rb', line 132 def cama_authenticate(redirect_uri = nil) params[:return_to] = redirect_uri unless cama_sign_in? flash[:error] = t('camaleon_cms.admin.login.please_login') [:return_to] = params[:return_to].present? ? params[:return_to] : ((request.get? && params[:controller] != "admin/sessions") ? request.original_url : nil) redirect_to cama_admin_login_path end end |
#cama_current_role ⇒ Object
return the role for current user if not logged in, then return ‘public’
112 113 114 |
# File 'app/helpers/camaleon_cms/session_helper.rb', line 112 def cama_current_role current_site.visitor_role end |
#cama_current_user ⇒ Object
return current user logged in
117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'app/helpers/camaleon_cms/session_helper.rb', line 117 def cama_current_user return @cama_current_user if defined?(@cama_current_user) # api current user... @cama_current_user = cama_calc_api_current_user return @cama_current_user if @cama_current_user return nil unless [:auth_token].present? c = [:auth_token].split("&") return nil unless c.size == 3 @cama_current_user = current_site.users_include_admins.find_by_auth_token(c[0]).try(:decorate) end |
#cama_get_session_id ⇒ Object
return the session id
142 143 144 145 146 147 |
# File 'app/helpers/camaleon_cms/session_helper.rb', line 142 def cama_get_session_id session[:autor] = "Owen Peredo Diaz" unless request.[:id].present? id = request.[:id] id = id.public_id if id && id.class.name == 'Rack::Session::SessionId' id end |
#cama_logout_user ⇒ Object
logout current user
94 95 96 97 98 99 100 101 |
# File 'app/helpers/camaleon_cms/session_helper.rb', line 94 def cama_logout_user .delete(:auth_token, domain: :all) .delete(:auth_token, domain: nil) c_data = {value: nil, expires: 24.hours.ago} c_data[:domain] = :all if PluginRoutes.system_info["users_share_sites"].present? && CamaleonCms::Site.count > 1 [:auth_token] = c_data redirect_to params[:return_to].present? ? params[:return_to] : cama_admin_login_path, :notice => t('camaleon_cms.admin.logout.message.closed') end |
#cama_on_heroku? ⇒ Boolean
check if current host is heroku
70 71 72 |
# File 'app/helpers/camaleon_cms/session_helper.rb', line 70 def cama_on_heroku? ENV.keys.any? { |var_name| var_name.match(/(heroku|dyno)/i) } end |
#cama_register_user(user_data, meta) ⇒ Object
User registration.
user_data must contain:
-
first_name
-
email
-
username
-
password
-
password_confirmation
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'app/helpers/camaleon_cms/session_helper.rb', line 51 def cama_register_user(user_data, ) @user = current_site.users.new(user_data) r = {user: @user, params: params}; hook_run('user_before_register', r) if current_site.security_user_register_captcha_enabled? && !cama_captcha_verified? {:result => false, :type => :captcha_error, :message => t('camaleon_cms.admin.users.message.error_captcha')} else if @user.save @user.() = current_site.need_validate_email? ? t('camaleon_cms.admin.users.message.created_pending_validate_email') : t('camaleon_cms.admin.users.message.created') r = {user: @user, message: , redirect_url: cama_admin_login_path}; hooks_run('user_after_register', r) {:result => true, :message => r[:message], :redirect_url => r[:redirect_url]} else {:result => false, :type => :no_saved} end end end |
#cama_sign_in? ⇒ Boolean Also known as: signin?
check if current user is already signed
104 105 106 |
# File 'app/helpers/camaleon_cms/session_helper.rb', line 104 def cama_sign_in? !cama_current_user.nil? end |
#login_user(user, remember_me = false, redirect_url = nil) ⇒ Object
log in the user in to system user: User model remember_me: true/false (remember session permanently) redirect_url (default nil): after initialized the session, this will be redirected to
"redirect_url" if defined
it doesn't redirect if redirect_url === false
return to previous page if defined the cookie['return_to'] or login url received extra param: return_to=http://mysite.com
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# File 'app/helpers/camaleon_cms/session_helper.rb', line 9 def login_user(user, remember_me = false, redirect_url = nil) c = {value: [user.auth_token, request.user_agent, request.ip], expires: 24.hours.from_now} c[:domain] = :all if PluginRoutes.system_info["users_share_sites"].present? && CamaleonCms::Site.count > 1 c[:expires] = 1.month.from_now if remember_me # fix to overwrite a cookie .delete(:auth_token, domain: :all) .delete(:auth_token) user.update({last_login_at: Time.zone.now}) [:auth_token] = c # user redirection flash[:notice] = t('camaleon_cms.admin.login.message.success', locale: current_site.get_admin_language) return if redirect_url === false if redirect_url.present? redirect_to redirect_url elsif (return_to = .delete(:return_to)).present? redirect_to return_to else redirect_to cama_admin_dashboard_path end end |
#login_user_with_password(username, password) ⇒ Object
login a user using username and password return boolean: true => authenticated, false => authentication failed
35 36 37 38 39 |
# File 'app/helpers/camaleon_cms/session_helper.rb', line 35 def login_user_with_password(username, password) @user = current_site.users.find_by_username(username) r = {user: @user, params: params, password: password, captcha_validate: true}; hooks_run('user_before_login', r) @user && @user.authenticate(password) end |
#session_back_to_parent(redirect_url = nil) ⇒ Object
switch current session into parent session called by session_switch_user after returned into parent session, this will be redirected to redirect_url or admin dashboard
85 86 87 88 89 90 91 |
# File 'app/helpers/camaleon_cms/session_helper.rb', line 85 def session_back_to_parent(redirect_url = nil) if cama_sign_in? && session[:parent_auth_token].present? [:auth_token] = session[:parent_auth_token] session.delete(:parent_auth_token) redirect_to (redirect_url || cama_admin_dashboard_path), notice: "Welcome back!" end end |
#session_switch_user(user, redirect_url = nil) ⇒ Object
switch current session user into other (user) after switched, this will be redirected to redirect_url or admin dashboard
76 77 78 79 80 81 |
# File 'app/helpers/camaleon_cms/session_helper.rb', line 76 def session_switch_user(user, redirect_url = nil) if cama_sign_in? session[:parent_auth_token] = [:auth_token] login_user(user, false, redirect_url) end end |