discourse/app/models/user_email.rb
Sam Saffron 6f9177e2ed
FEATURE: enforce_canonical_emails site setting
The new `enforce_canonical_emails` site setting ensures that emails in the
canonical form are unique.

This mean that if `s.a.m+1@gmail.com` is registered `sam@gmail.com` will
not be allowed.

The commit contains a blanket "tag strip" (stripping everything after +)
it also contains special handling of a "dot strip" for googlemail and gmail.

The setting only impacts new registrations after `enforce_canonical_emails`

The setting is default false so it will not impact any existing installs.
2020-04-14 14:16:30 +10:00

91 lines
2.5 KiB
Ruby

# frozen_string_literal: true
class UserEmail < ActiveRecord::Base
belongs_to :user
attr_accessor :skip_validate_email
before_validation :strip_downcase_email
validates :email, presence: true
validates :email, email: true, format: { with: EmailValidator.email_regex },
if: :validate_email?
validates :primary, uniqueness: { scope: [:user_id] }, if: [:user_id, :primary]
validate :user_id_not_changed, if: :primary
validate :unique_email
before_save :save_canonical
scope :secondary, -> { where(primary: false) }
def self.canonical(email)
name, domain = email.split('@', 2)
name = name.gsub(/\+.*/, '')
if ['gmail.com', 'googlemail.com'].include?(domain.downcase)
name = name.gsub('.', '')
end
"#{name}@#{domain}".downcase
end
private
def save_canonical
if SiteSetting.enforce_canonical_emails && self.will_save_change_to_email?
self.canonical_email = UserEmail.canonical(self.email)
end
end
def strip_downcase_email
if self.email
self.email = self.email.strip
self.email = self.email.downcase
end
end
def validate_email?
return false if self.skip_validate_email
email_changed?
end
def unique_email
if self.will_save_change_to_email?
exists = self.class.where("lower(email) = ?", email).exists?
exists ||= SiteSetting.enforce_canonical_emails &&
self.class.where("canonical_email = ?", UserEmail.canonical(email)).exists?
if exists
self.errors.add(:email, :taken)
end
end
end
def user_id_not_changed
if self.will_save_change_to_user_id? && self.persisted?
self.errors.add(:user_id, I18n.t(
'active_record.errors.model.user_email.attributes.user_id.reassigning_primary_email')
)
end
end
end
# == Schema Information
#
# Table name: user_emails
#
# id :integer not null, primary key
# user_id :integer not null
# email :string(513) not null
# primary :boolean default(FALSE), not null
# created_at :datetime not null
# updated_at :datetime not null
# canonical_email :string
#
# Indexes
#
# index_user_emails_on_canonical_email (canonical_email) WHERE (canonical_email IS NOT NULL)
# index_user_emails_on_email (lower((email)::text)) UNIQUE
# index_user_emails_on_user_id (user_id)
# index_user_emails_on_user_id_and_primary (user_id,primary) UNIQUE WHERE "primary"
#