ref: master
app/models/user.rb
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 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 |
require 'digest/sha1' require 'securerandom' # User models the system users, and is generated by the acts_as_authenticated # Rails generator. class User < ApplicationRecord attr_accessible :login, :email, :password, :password_confirmation, :activated_at store_accessor :metadata include MetadataScopes N_('Password') N_('Password confirmation') N_('Terms accepted') # see http://stackoverflow.com/a/2513456/670229 def self.current Thread.current[:current_user] end def self.current=(user) Thread.current[:current_user] = user end SEARCHABLE_FIELDS = { :email => {:label => _('Email'), :weight => 5}, } # see http://stackoverflow.com/a/2513456/670229 def self.current Thread.current[:current_user] end def self.current=(user) Thread.current[:current_user] = user end def self.[](login) self.find_by login: login end # FIXME ugly workaround def self.human_attribute_name_with_customization(attrib, options={}) case attrib.to_sym when :login return [_('Username'), _('Email')].join(' / ') when :email return _('e-Mail') else _(self.human_attribute_name_without_customization(attrib)) end end class << self alias_method_chain :human_attribute_name, :customization end def self.build(user_data, person_data, environment) user = User.new(user_data) user.terms_of_use = environment.terms_of_use user.environment = environment user.person_data = person_data user end before_create do |user| if user.environment.nil? user.environment = Environment.default end user.send(:make_activation_code) unless user.environment.enabled?('skip_new_user_email_confirmation') end after_create do |user| unless user.person p = Person.new p.attributes = user.person_data p.identifier = user.login if p.identifier.blank? p.user = user p.environment = user.environment p.name ||= user.name || user.login p.visible = false unless user.activated? p.save! user.person = p end if user.environment.enabled?('skip_new_user_email_confirmation') if user.environment.enabled?('admin_must_approve_new_users') create_moderate_task else user.activate end end end after_create :deliver_activation_code after_create :delay_activation_check attr_writer :person_data def person_data @person_data = {} if @person_data.nil? @person_data end def email_domain self.person.preferred_domain && self.person.preferred_domain.name || self.environment.default_hostname(true) end # virtual attribute used to stash which community to join on signup or login attr_accessor :community_to_join def signup! User.transaction do self.save! self.person.save! end end # set autosave to false as we do manually when needed and Person syncs with us has_one :person, dependent: :destroy, autosave: false belongs_to :environment has_many :sessions, dependent: :destroy # holds the current session, see lib/authenticated_system.rb attr_accessor :session attr_protected :activated_at # Virtual attribute for the unencrypted password attr_accessor :password, :name validates_presence_of :login, :email validates_format_of :login, :with => Profile::IDENTIFIER_FORMAT, :if => (lambda {|user| !user.login.blank?}) validates_presence_of :password, :if => :password_required? validates_presence_of :password_confirmation, :if => :password_required? validates_length_of :password, :within => 4..40, :if => :password_required? validates_confirmation_of :password, :if => :password_required? validates_length_of :login, :within => 2..40, :if => (lambda {|user| !user.login.blank?}) validates_length_of :email, :within => 3..100, :if => (lambda {|user| !user.email.blank?}) validates_uniqueness_of :login, :email, :case_sensitive => false, :scope => :environment_id before_save :encrypt_password before_save :normalize_email, if: proc{ |u| u.email.present? } before_save :generate_private_token_if_not_exist validates_format_of :email, :with => Noosfero::Constants::EMAIL_FORMAT, :if => (lambda {|user| !user.email.blank?}) validates_inclusion_of :terms_accepted, :in => [ '1' ], :if => lambda { |u| ! u.terms_of_use.blank? }, :message => N_('{fn} must be checked in order to signup.').fix_i18n scope :has_login?, lambda { |login,email,environment_id| where('login = ? OR email = ? OR phone = ?', login, email, login). where(environment_id: environment_id) } # Authenticates a user by their login name or email and unencrypted password. Returns the user or nil. def self.authenticate(login, password, environment = nil) environment ||= Environment.default u = self.has_login?(login, login, environment.id) u = u.first if u.is_a?(ActiveRecord::Relation) if u && u.authenticated?(password) u.generate_private_token_if_not_exist return u end return nil end def register_login self.update_attribute :last_login_at, Time.now end def generate_private_token self.private_token = SecureRandom.hex self.private_token_generated_at = DateTime.now end def generate_private_token! self.generate_private_token save(:validate => false) end def generate_private_token_if_not_exist unless self.private_token self.generate_private_token end end # Activates the user in the database. def activate return false unless self.person self.activated_at = Time.now.utc self.activation_code = nil self.person.visible = true begin self.person.save! && self.save! rescue Exception => exception logger.error(exception.to_s) false else if environment.enabled?('send_welcome_email_to_new_users') && environment.has_signup_welcome_text? Delayed::Job.enqueue(UserMailer::Job.new(self, :signup_welcome_email)) end true end end # Deactivates the user in the database. def deactivate return false unless self.person self.activated_at = nil self.person.visible = false begin self.person.save! && self.save! rescue Exception => exception logger.error(exception.to_s) false else true end end def create_moderate_task @task = ModerateUserRegistration.new @task.user_id = self.id @task.name = self.name @task.email = self.email @task.target = self.environment @task.requestor = self.person @task.save end def activated? self.activation_code.nil? && !self.activated_at.nil? end class UnsupportedEncryptionType < Exception; end def self.system_encryption_method @system_encryption_method || :salted_sha1 end def self.system_encryption_method=(method) @system_encryption_method = method end # a Hash containing the available encryption methods. Keys are symbols, # values are Proc objects that contain the actual encryption code. def self.encryption_methods @encryption_methods ||= {} end # adds a new encryption method. def self.add_encryption_method(sym, &block) encryption_methods[sym] = block end # the encryption method used for this instance def encryption_method (password_type || User.system_encryption_method).to_sym end # Encrypts the password using the chosen method def encrypt(password) method = self.class.encryption_methods[encryption_method] if method method.call(password, salt) else raise UnsupportedEncryptionType, "Unsupported encryption type: #{encryption_method}" end end add_encryption_method :salted_sha1 do |password, salt| Digest::SHA1.hexdigest("--#{salt}--#{password}--") end add_encryption_method :md5 do |password, salt| Digest::MD5.hexdigest(password) end add_encryption_method :salted_md5 do |password, salt| Digest::MD5.hexdigest(password+salt) end add_encryption_method :clear do |password, salt| password end add_encryption_method :crypt do |password, salt| password.crypt(salt) end class UserNotActivated < StandardError attr_reader :user def initialize(message, user = nil) @user = user super(message) end end def authenticated?(password) unless self.activated? message = _('The user "%{login}" is not activated! Please check your email to activate your user') % {login: self.login} raise UserNotActivated.new(message, self) end result = (crypted_password == encrypt(password)) if (encryption_method != User.system_encryption_method) && result self.password_type = User.system_encryption_method.to_s self.password = password self.password_confirmation = password self.save! end result end def remember_token? remember_token_expires_at && Time.now.utc < remember_token_expires_at end # These create and unset the fields required for remembering users between browser closes def remember_me self.remember_token_expires_at = 1.months.from_now.utc # if the user's email/password changes this won't be valid anymore self.remember_token = encrypt "#{email}-#{self.crypted_password}-#{remember_token_expires_at}" save(:validate => false) end def forget_me self.remember_token_expires_at = nil self.remember_token = nil save(:validate => false) end # Exception thrown when #change_password! is called with a wrong current # password class IncorrectPassword < Exception; end # Changes the password of a user. # # * Raises IncorrectPassword if <tt>current</tt> is different from the user's # current password. # * Saves the record unless it is a new one. def change_password!(current, new, confirmation) begin unless self.authenticated?(current) self.errors.add(:current_password, _('does not match.')) raise IncorrectPassword end rescue UserNotActivated => e self.errors.add(:current_password, e.message) raise UserNotActivated end self.force_change_password!(new, confirmation) end # Changes the password of a user without asking for the old password. This # method is intended to be used by the "I forgot my password", and must be # used with care. def force_change_password!(new, confirmation) self.password = new self.password_confirmation = confirmation save! unless new_record? end def name name = (@name || login) person.nil? ? name : (person.name || name) end def name= name @name = name end def enable_email! self.update_attribute(:enable_email, true) end def disable_email! self.update_attribute(:enable_email, false) end def email_activation_pending? if self.environment.nil? return false else return EmailActivation.exists?(:requestor_id => self.person.id, :target_id => self.environment.id, :status => Task::Status::ACTIVE) end end def moderate_registration_pending? return ModerateUserRegistration.exists?(:requestor_id => self.person.id, :target_id => self.environment.id, :status => Task::Status::ACTIVE) end def data_hash(gravatar_default = nil) friends_list = {} enterprises = person.enterprises.map { |e| { 'name' => e.short_name, 'identifier' => e.identifier } } self.person.friends.online.map do |person| friends_list[person.identifier] = { 'avatar' => person.profile_custom_icon(gravatar_default), 'name' => person.short_name, 'jid' => person.full_jid, 'status' => person.user.chat_status, } end { 'login' => self.login, 'name' => self.person.name, 'email' => self.email, 'avatar' => self.person.profile_custom_icon(gravatar_default), 'is_admin' => self.person.is_admin?, 'since_month' => self.person.created_at.month, 'since_year' => self.person.created_at.year, 'email_domain' => self.enable_email ? self.email_domain : nil, 'friends_list' => friends_list, 'enterprises' => enterprises, 'amount_of_friends' => friends_list.count, 'chat_enabled' => person.environment.enabled?('xmpp_chat') } end def self.expires_chat_status_every 15 # in minutes end # Chat was not refreshed in the last 20 seconds. The window was closed. def chat_alive? (DateTime.now - chat_status_at.to_datetime) * 1.day <= 20 end def not_require_password! @is_password_required = false end def resend_activation_code return if self.activated? update_attribute(:activation_code, make_activation_code) self.deliver_activation_code end protected def normalize_email self.email = self.email.squish.downcase end # before filter def encrypt_password return if password.blank? self.salt ||= Digest::SHA1.hexdigest("--#{Time.now.to_s}--#{login}--") if new_record? self.password_type ||= User.system_encryption_method.to_s self.crypted_password = encrypt(password) end def password_required? (crypted_password.blank? || !password.blank?) && is_password_required? end def is_password_required? @is_password_required.nil? ? true : @is_password_required end def make_activation_code self.activation_code = Digest::SHA1.hexdigest(Time.now.to_s.split(//).sort_by{rand}.join) end def deliver_activation_code return if person.is_template? Delayed::Job.enqueue(UserMailer::Job.new(self, :activation_code)) unless self.activation_code.blank? end def delay_activation_check return if person.is_template? Delayed::Job.enqueue(UserActivationJob.new(self.id), {:priority => 0, :run_at => (NOOSFERO_CONF['hours_until_user_activation_check'] || 72).hours.from_now}) end end |