/usr/lib/ruby/1.8/ramaze/helper/user.rb is in libramaze-ruby1.8 2010.06.18-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 | module Ramaze
module Helper
# This helper provides a convenience wrapper for handling authentication
# and persistence of users.
#
# On every request, when you use the {User#user} method for the first time,
# we confirm the authentication and store the returned object in the
# request.env, usually this will involve a request to your database.
#
# @example Basic usage with User::authenticate
#
# # We assume that User::[] will make a query and returns the requested
# # User instance. This instance will be wrapped and cached.
#
# class User
# def self.authenticate(creds)
# User[:name => creds['name'], :pass => creds['pass']]
# end
# end
#
# class Profiles < Ramaze::Controller
# helper :user
#
# def edit
# redirect_referrer unless logged_in?
# "Your profile is shown, your are logged in."
# end
# end
#
# class Accounts < Ramaze::Controller
# helper :user
#
# def login
# return unless request.post?
# user_login(request.subset(:name, :pass))
# redirect Profiles.r(:edit)
# end
#
# def logout
# user_logout
# redirect_referer
# end
# end
#
# On every request it checks authentication again and retrieves the model,
# we are not using a normal cache for this as it may lead to behaviour that
# is very hard to predict and debug.
#
# You can however, add your own caching quite easily.
#
# @example caching the authentication lookup with memcached
#
# # Add the name of the cache you are going to use for the authentication
# # and set all caches to use memcached
#
# Ramaze::Cache.options do |cache|
# cache.names = [:session, :user]
# cache.default = Ramaze::Cache::MemCache
# end
#
# class User
#
# # Try to fetch the user from the cache, if that fails make a query.
# # We are using a ttl (time to live) of one hour, that's just to show
# # you how to do it and not necessary.
# def self.authenticate(credentials)
# cache = Ramaze::Cache.user
#
# if user = cache[credentials]
# return user
# elsif user = User[:name => creds['name'], :pass => creds['pass']]
# cache.store(credentials, user, :ttl => 3600)
# end
# end
# end
#
# @example Using a lambda instead of User::authenticate
#
# # assumes all your controllers inhert from this one
#
# class Controller < Ramaze::Controller
# trait :user_callback => lambda{|creds|
# User[:name => creds['name'], :pass => creds['pass']]
# }
# end
#
# @example Using a different model instead of User
#
# # assumes all your controllers inhert from this one
#
# class Controller < Ramaze::Controller
# trait :user_model => Account
# end
#
# @author manveru
# @todo convert the examples into real examples with specs
module User
# Using this as key in request.env
RAMAZE_HELPER_USER = 'ramaze.helper.user'.freeze
# Use this method in your application, but do not use it in conditionals
# as it will never be nil or false.
#
# @return [Ramaze::Helper::User::Wrapper] wrapped return value from model or callback
#
# @api external
# @author manveru
def user
env = request.env
found = env[RAMAZE_HELPER_USER]
return found if found
model, callback = ancestral_trait.values_at(:user_model, :user_callback)
model ||= ::User
env[RAMAZE_HELPER_USER] = Wrapper.new(model, callback)
end
# shortcut for user._login but default argument are request.params
#
# @param [Hash] creds the credentials that will be passed to callback or model
#
# @return [nil Hash] the given creds are returned on successful login
#
# @api external
# @see Ramaze::Helper::User::Wrapper#_login
# @author manveru
def user_login(creds = request.params)
user._login(creds)
end
# shortcut for user._logout
#
# @return [nil]
#
# @api external
# @see Ramaze::Helper::User::Wrapper#_logout
# @author manveru
def user_logout
user._logout
end
# @return [true false] whether the user is logged in already.
#
# @api external
# @see Ramaze::Helper::User::Wrapper#_logged_in?
# @author manveru
def logged_in?
user._logged_in?
end
# Wrapper for the ever-present "user" in your application.
# It wraps around an arbitrary instance and worries about authentication
# and storing information about the user in the session.
#
# In order to not interfere with the wrapped instance/model we start our
# methods with an underscore.
#
# Patches and suggestions are highly appreciated.
class Wrapper < BlankSlate
attr_accessor :_model, :_callback, :_user
def initialize(model, callback)
@_model, @_callback = model, callback
@_user = nil
_login
end
# @param [Hash] creds this hash will be stored in the session on successful login
# @return [Ramaze::Helper::User::Wrapper] wrapped return value from
# model or callback
# @see Ramaze::Helper::User#user_login
# @author manveru
def _login(creds = _persistence)
if @_user = _would_login?(creds)
self._persistence = creds
end
end
# The callback should return an instance of the user, otherwise it
# should answer with nil.
#
# This will not actually login, just check whether the credentials
# would result in a user.
def _would_login?(creds)
if c = @_callback
c.call(creds)
elsif _model.respond_to?(:authenticate)
_model.authenticate(creds)
else
Log.warn("Helper::User has no callback and there is no %p::authenticate" % _model)
nil
end
end
# @api internal
# @see Ramaze::Helper::User#user_logout
# @author manveru
def _logout
_persistence.clear
Current.request.env['ramaze.helper.user'] = nil
end
# @return [true false] whether the current user is logged in.
# @api internal
# @see Ramaze::Helper::User#logged_in?
# @author manveru
def _logged_in?
!!_user
end
def _persistence=(creds)
Current.session[:USER] = creds
end
def _persistence
Current.session[:USER] || {}
end
# Refer everything not known
# THINK: This might be quite confusing... should we raise instead?
def method_missing(meth, *args, &block)
return unless _user
_user.send(meth, *args, &block)
end
end
end
end
end
|