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 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
|
# frozen-string-literal: true
require 'securerandom'
module Rodauth
class ConfigurationError < StandardError; end
def self.lib(opts={}, &block)
require 'roda'
c = Class.new(Roda)
c.plugin(:rodauth, opts) do
enable :internal_request
instance_exec(&block)
end
c.freeze
c.rodauth
end
def self.load_dependencies(app, opts={}, &_)
json_opt = opts.fetch(:json, app.opts[:rodauth_json])
if json_opt
app.plugin :json
app.plugin :json_parser
end
unless json_opt == :only
unless opts[:render] == false
require 'tilt/string'
app.plugin :render
end
case opts.fetch(:csrf, app.opts[:rodauth_csrf])
when false
# nothing
when :rack_csrf
# :nocov:
app.plugin :csrf
# :nocov:
else
app.plugin :route_csrf
end
app.plugin :flash unless opts[:flash] == false
app.plugin :h
end
end
def self.configure(app, opts={}, &block)
json_opt = app.opts[:rodauth_json] = opts.fetch(:json, app.opts[:rodauth_json])
csrf = app.opts[:rodauth_csrf] = opts.fetch(:csrf, app.opts[:rodauth_csrf])
app.opts[:rodauth_route_csrf] = case csrf
when false, :rack_csrf
false
else
json_opt != :only
end
auth_class = (app.opts[:rodauths] ||= {})[opts[:name]] ||= opts[:auth_class] || Class.new(Auth)
if !auth_class.roda_class
auth_class.roda_class = app
elsif auth_class.roda_class != app
auth_class = app.opts[:rodauths][opts[:name]] = Class.new(auth_class)
auth_class.roda_class = app
end
auth_class.class_eval{@configuration_name = opts[:name] unless defined?(@configuration_name)}
auth_class.configure(&block) if block
auth_class.allocate.post_configure if auth_class.method_defined?(:post_configure)
end
FEATURES = {}
class FeatureConfiguration < Module
def def_configuration_methods(feature)
private_methods = feature.private_instance_methods.map(&:to_sym)
priv = proc{|m| private_methods.include?(m)}
feature.auth_methods.each{|m| def_auth_method(m, priv[m])}
feature.auth_value_methods.each{|m| def_auth_value_method(m, priv[m])}
feature.auth_private_methods.each{|m| def_auth_private_method(m)}
end
private
def def_auth_method(meth, priv)
define_method(meth) do |&block|
@auth.send(:define_method, meth, &block)
@auth.send(:private, meth) if priv
@auth.send(:alias_method, meth, meth)
end
end
def def_auth_private_method(meth)
umeth = :"_#{meth}"
define_method(meth) do |&block|
@auth.send(:define_method, umeth, &block)
@auth.send(:private, umeth)
@auth.send(:alias_method, umeth, umeth)
end
end
def def_auth_value_method(meth, priv)
define_method(meth) do |v=nil, &block|
block ||= proc{v}
@auth.send(:define_method, meth, &block)
@auth.send(:private, meth) if priv
@auth.send(:alias_method, meth, meth)
end
end
end
class Feature < Module
[:auth, :auth_value, :auth_private].each do |meth|
name = :"#{meth}_methods"
define_method(name) do |*v|
iv = :"@#{name}"
existing = instance_variable_get(iv) || []
if v.empty?
existing
else
instance_variable_set(iv, existing + v)
end
end
end
attr_accessor :feature_name
attr_accessor :dependencies
attr_accessor :routes
attr_accessor :configuration
attr_reader :internal_request_methods
def route(name=feature_name, default=name.to_s.tr('_', '-'), &block)
route_meth = :"#{name}_route"
auth_value_method route_meth, default
define_method(:"#{name}_path"){|opts={}| route_path(send(route_meth), opts) if send(route_meth)}
define_method(:"#{name}_url"){|opts={}| route_url(send(route_meth), opts) if send(route_meth)}
handle_meth = :"handle_#{name}"
internal_handle_meth = :"_#{handle_meth}"
before route_meth
define_method(internal_handle_meth, &block)
define_method(handle_meth) do
request.is send(route_meth) do
@current_route = name
check_csrf if check_csrf?
_around_rodauth do
before_rodauth
send(internal_handle_meth, request)
end
end
end
routes << handle_meth
end
def self.define(name, constant=nil, &block)
feature = new
feature.dependencies = []
feature.routes = []
feature.feature_name = name
configuration = feature.configuration = FeatureConfiguration.new
feature.module_eval(&block)
configuration.def_configuration_methods(feature)
# :nocov:
if constant
# :nocov:
Rodauth.const_set(constant, feature)
Rodauth::FeatureConfiguration.const_set(constant, configuration)
end
FEATURES[name] = feature
end
def internal_request_method(name=feature_name)
(@internal_request_methods ||= []) << name
end
def configuration_module_eval(&block)
configuration.module_eval(&block)
end
if RUBY_VERSION >= '2.5'
DEPRECATED_ARGS = [{:uplevel=>1}]
else
# :nocov:
DEPRECATED_ARGS = []
# :nocov:
end
def def_deprecated_alias(new, old)
configuration_module_eval do
define_method(old) do |*a, &block|
warn("Deprecated #{old} method used during configuration, switch to using #{new}", *DEPRECATED_ARGS)
send(new, *a, &block)
end
end
define_method(old) do
warn("Deprecated #{old} method called at runtime, switch to using #{new}", *DEPRECATED_ARGS)
send(new)
end
end
DEFAULT_REDIRECT_BLOCK = proc{default_redirect}
def redirect(name=feature_name, &block)
meth = :"#{name}_redirect"
block ||= DEFAULT_REDIRECT_BLOCK
define_method(meth, &block)
auth_value_methods meth
end
def view(page, title, name=feature_name)
meth = :"#{name}_view"
title_meth = :"#{name}_page_title"
translatable_method(title_meth, title)
define_method(meth) do
view(page, send(title_meth))
end
auth_methods meth
end
def response(name=feature_name)
meth = :"#{name}_response"
overridable_meth = :"_#{meth}"
notice_flash_meth = :"#{name}_notice_flash"
redirect_meth = :"#{name}_redirect"
define_method(overridable_meth) do
set_notice_flash send(notice_flash_meth)
redirect send(redirect_meth)
end
define_method(meth) do
require_response(overridable_meth)
end
private overridable_meth, meth
auth_private_methods meth
end
def loaded_templates(v)
define_method(:loaded_templates) do
super().concat(v)
end
private :loaded_templates
end
def depends(*deps)
dependencies.concat(deps)
end
%w'after before'.each do |hook|
define_method(hook) do |name=feature_name|
meth = "#{hook}_#{name}"
class_eval("def #{meth}; super if defined?(super); _#{meth}; hook_action(:#{hook}, :#{name}); nil end", __FILE__, __LINE__)
class_eval("def _#{meth}; nil end", __FILE__, __LINE__)
private meth, :"_#{meth}"
auth_private_methods(meth)
end
end
def email(type, subject, opts = {})
subject_method = :"#{type}_email_subject"
body_method = :"#{type}_email_body"
create_method = :"create_#{type}_email"
send_method = :"send_#{type}_email"
translatable_method subject_method, subject
auth_methods create_method, send_method
body_template = "#{type.to_s.tr('_', '-')}-email"
if opts[:translatable]
auth_value_methods body_method
define_method(body_method){translate(body_method, render(body_template))}
else
auth_methods body_method
define_method(body_method){render(body_template)}
end
define_method(create_method) do
create_email(send(subject_method), send(body_method))
end
define_method(send_method) do
send_email(send(create_method))
end
end
def additional_form_tags(name=feature_name)
auth_value_method(:"#{name}_additional_form_tags", nil)
end
def session_key(meth, value)
define_method(meth){convert_session_key(value)}
auth_value_methods(meth)
end
def flash_key(meth, value)
define_method(meth){normalize_session_or_flash_key(value)}
auth_value_methods(meth)
end
def auth_value_method(meth, value)
define_method(meth){value}
auth_value_methods(meth)
end
def translatable_method(meth, value)
define_method(meth){translate(meth, value)}
auth_value_methods(meth)
end
def auth_cached_method(meth, iv=:"@#{meth}")
umeth = :"_#{meth}"
define_method(meth) do
if instance_variable_defined?(iv)
instance_variable_get(iv)
else
instance_variable_set(iv, send(umeth))
end
end
alias_method(meth, meth)
auth_private_methods(meth)
end
[:notice_flash, :error_flash, :button].each do |meth|
define_method(meth) do |v, name=feature_name|
translatable_method(:"#{name}_#{meth}", v)
end
end
end
class Configuration
attr_reader :auth
def initialize(auth, &block)
@auth = auth
# :nocov:
# Only for backwards compatibility
# RODAUTH3: Remove
apply(&block) if block
# :nocov:
end
def apply(&block)
load_feature(:base)
instance_exec(&block)
end
def enable(*features)
features.each do |feature|
next if @auth.features.include?(feature)
load_feature(feature)
@auth.features << feature
end
end
private
def load_feature(feature_name)
require "rodauth/features/#{feature_name}" unless FEATURES[feature_name]
feature = FEATURES[feature_name]
enable(*feature.dependencies)
extend feature.configuration
@auth.routes.concat(feature.routes)
@auth.send(:include, feature)
end
end
class Auth
@features = []
@routes = []
@route_hash = {}
@configuration = Configuration.new(self)
class << self
attr_accessor :roda_class
attr_reader :features
attr_reader :routes
attr_accessor :route_hash
attr_reader :configuration_name
attr_reader :configuration
end
def self.inherited(subclass)
super
superclass = self
subclass.instance_exec do
@roda_class = superclass.roda_class
@features = superclass.features.clone
@routes = superclass.routes.clone
@route_hash = superclass.route_hash.clone
@configuration = superclass.configuration.clone
@configuration.instance_variable_set(:@auth, self)
end
end
def self.configure(&block)
@configuration.apply(&block)
end
def self.freeze
@features.freeze
@routes.freeze
@route_hash.freeze
super
end
end
module InstanceMethods
def default_rodauth_name
nil
end
def rodauth(name=default_rodauth_name)
if name
(@_rodauths ||= {})[name] ||= self.class.rodauth(name).new(self)
else
@_rodauth ||= self.class.rodauth.new(self)
end
end
end
module ClassMethods
def rodauth(name=nil)
opts[:rodauths][name]
end
def precompile_rodauth_templates
instance = allocate
rodauth = instance.rodauth
view_opts = rodauth.send(:loaded_templates).map do |page|
rodauth.send(:_view_opts, page)
end
view_opts << rodauth.send(:button_opts, '', {})
view_opts.each do |opts|
instance.send(:retrieve_template, opts).send(:compiled_method, opts[:locals].keys.sort_by(&:to_s))
end
nil
end
def freeze
opts[:rodauths].each_value(&:freeze)
opts[:rodauths].freeze
super
end
end
module RequestMethods
def rodauth(name=scope.default_rodauth_name)
scope.rodauth(name).route!
end
end
end
|