Files
docuseal/lib/submitters.rb
T

233 lines
8.2 KiB
Ruby
Raw Normal View History

2023-06-26 00:46:01 +03:00
# frozen_string_literal: true
module Submitters
2023-11-23 20:03:52 +02:00
TRUE_VALUES = ['1', 'true', true].freeze
2024-07-24 09:13:13 +03:00
PRELOAD_ALL_PAGES_AMOUNT = 200
2023-11-23 20:03:52 +02:00
2025-06-05 13:16:55 +03:00
FIELD_NAME_WEIGHTS = {
'email' => 'A',
'phone' => 'B',
'name' => 'C',
'values' => 'D'
}.freeze
2025-07-11 09:02:18 +03:00
UnableToSendCode = Class.new(StandardError)
InvalidOtp = Class.new(StandardError)
2023-06-26 00:46:01 +03:00
module_function
2025-06-05 13:16:55 +03:00
def search(current_user, submitters, keyword)
2025-06-21 22:52:10 +03:00
if Docuseal.fulltext_search?
2025-06-05 13:16:55 +03:00
fulltext_search(current_user, submitters, keyword)
else
plain_search(submitters, keyword)
end
end
def fulltext_search(current_user, submitters, keyword)
return submitters if keyword.blank?
submitters.where(
id: SearchEntry.where(record_type: 'Submitter')
.where(account_id: current_user.account_id)
.where(*SearchEntries.build_tsquery(keyword))
.select(:record_id)
)
end
def fulltext_search_field(current_user, submitters, keyword, field_name)
2025-06-07 09:50:04 +03:00
keyword = keyword.delete("\0")
2025-06-18 23:52:46 +03:00
return submitters.none if keyword.blank?
2025-06-05 13:16:55 +03:00
weight = FIELD_NAME_WEIGHTS[field_name]
2025-06-18 23:52:46 +03:00
return submitters.none if weight.blank?
2025-06-05 13:16:55 +03:00
query =
if keyword.match?(/\d/) && !keyword.match?(/\p{L}/)
number = keyword.gsub(/\D/, '')
2025-06-09 09:55:30 +03:00
sql =
if number.length <= 2
"ngram @@ ((quote_literal(?) || ':' || ?)::tsquery || (quote_literal(?) || ':' || ?)::tsquery)"
else
"tsvector @@ ((quote_literal(?) || ':*' || ?)::tsquery || (quote_literal(?) || ':*' || ?)::tsquery)"
end
[sql, number, weight, number.length > 1 ? number.delete_prefix('0') : number, weight]
2025-07-07 07:36:27 +03:00
elsif keyword.match?(/[^\p{L}\d&@.\-]/) || keyword.match?(/[.\-]{2,}/)
2025-06-05 13:16:55 +03:00
terms = TextUtils.transliterate(keyword.downcase).split(/\b/).map(&:squish).compact_blank.uniq
if terms.size > 1
SearchEntries.build_weights_tsquery(terms, weight)
else
2025-06-09 09:55:30 +03:00
SearchEntries.build_weights_wildcard_tsquery(keyword, weight)
2025-06-05 13:16:55 +03:00
end
else
2025-06-09 09:55:30 +03:00
SearchEntries.build_weights_wildcard_tsquery(keyword, weight)
2025-06-05 13:16:55 +03:00
end
2025-06-19 15:43:13 +03:00
submitter_ids = SearchEntry.where(record_type: 'Submitter')
.where(account_id: current_user.account_id)
.where(*query)
.limit(500)
.pluck(:record_id)
submitters.where(id: submitter_ids.first(100))
2025-06-05 13:16:55 +03:00
end
def plain_search(submitters, keyword)
2023-09-20 02:00:00 +03:00
return submitters if keyword.blank?
term = "%#{keyword.downcase}%"
arel_table = Submitter.arel_table
arel = arel_table[:email].lower.matches(term)
.or(arel_table[:phone].matches(term))
.or(arel_table[:name].lower.matches(term))
submitters.where(arel)
end
2023-06-26 00:46:01 +03:00
def select_attachments_for_download(submitter)
2024-08-23 23:46:22 +03:00
if AccountConfig.exists?(account_id: submitter.submission.account_id,
key: AccountConfig::COMBINE_PDF_RESULT_KEY,
value: true) && submitter.submission.combined_document_attachment
return [submitter.submission.combined_document_attachment]
end
2025-05-31 15:15:25 +03:00
original_documents = submitter.submission.schema_documents.preload(:blob)
2023-06-26 00:46:01 +03:00
is_more_than_two_images = original_documents.count(&:image?) > 1
submitter.documents.preload(:blob).reject do |attachment|
2024-02-25 16:25:04 +02:00
is_more_than_two_images &&
original_documents.find { |a| a.uuid == (attachment.metadata['original_uuid'] || attachment.uuid) }&.image?
2023-06-26 00:46:01 +03:00
end
end
2023-08-12 12:34:02 +03:00
def create_attachment!(submitter, params)
blob =
if (file = params[:file])
ActiveStorage::Blob.create_and_upload!(io: file.open,
filename: file.original_filename,
content_type: file.content_type)
else
ActiveStorage::Blob.find_signed(params[:blob_signed_id])
end
ActiveStorage::Attachment.create!(
blob:,
name: params[:name],
record: submitter
)
end
2023-09-03 14:05:31 +03:00
2023-11-23 20:03:52 +02:00
def normalize_preferences(account, user, params)
preferences = {}
2023-09-03 14:05:31 +03:00
2023-11-23 20:03:52 +02:00
message_params = params['message'].presence || params.slice('subject', 'body').presence
2023-09-03 14:05:31 +03:00
2023-11-23 20:03:52 +02:00
if message_params.present?
email_message = EmailMessages.find_or_create_for_account_user(account, user,
message_params['subject'],
message_params['body'])
2023-09-03 14:05:31 +03:00
end
2023-11-23 20:03:52 +02:00
preferences['email_message_uuid'] = email_message.uuid if email_message
preferences['send_email'] = params['send_email'].in?(TRUE_VALUES) if params.key?('send_email')
preferences['send_sms'] = params['send_sms'].in?(TRUE_VALUES) if params.key?('send_sms')
2025-06-28 10:37:10 +03:00
preferences['require_phone_2fa'] = params['require_phone_2fa'].in?(TRUE_VALUES) if params.key?('require_phone_2fa')
2024-01-10 02:06:31 +02:00
preferences['bcc_completed'] = params['bcc_completed'] if params.key?('bcc_completed')
2024-03-24 14:09:28 +02:00
preferences['reply_to'] = params['reply_to'] if params.key?('reply_to')
2024-04-13 15:33:05 +03:00
preferences['go_to_last'] = params['go_to_last'] if params.key?('go_to_last')
2024-01-14 12:11:13 +02:00
preferences['completed_redirect_url'] = params['completed_redirect_url'] if params.key?('completed_redirect_url')
2023-11-23 20:03:52 +02:00
preferences
2023-09-03 14:05:31 +03:00
end
2024-11-11 19:19:06 +02:00
def send_signature_requests(submitters, delay_seconds: nil)
submitters.each_with_index do |submitter, index|
2023-11-23 20:03:52 +02:00
next if submitter.email.blank?
2025-04-27 21:43:31 +03:00
next if submitter.declined_at?
2023-11-23 20:03:52 +02:00
next if submitter.preferences['send_email'] == false
2024-11-11 19:19:06 +02:00
if delay_seconds
SendSubmitterInvitationEmailJob.perform_in((delay_seconds + index).seconds, 'submitter_id' => submitter.id)
else
SendSubmitterInvitationEmailJob.perform_async('submitter_id' => submitter.id)
end
2023-11-23 20:03:52 +02:00
end
end
2024-09-26 15:47:18 +03:00
def current_submitter_order?(submitter)
2025-07-29 16:15:55 +03:00
submission = submitter.submission
2024-09-26 15:47:18 +03:00
2025-07-29 16:15:55 +03:00
submitter_items = submission.template_submitters || submission.template.submitters
2024-09-26 15:47:18 +03:00
2025-07-29 16:15:55 +03:00
before_items =
if submitter_items.any? { |s| s['order'] }
submitter_groups = submitter_items.group_by.with_index { |s, index| s['order'] || index }.sort_by(&:first)
current_group_index = submitter_groups.find_index { |_, group| group.any? { |s| s['uuid'] == submitter.uuid } }
submitter_groups.first(current_group_index).flat_map(&:last)
else
submitter_items.first(submitter_items.find_index { |e| e['uuid'] == submitter.uuid })
end
before_items.all? { |item| submission.submitters.find { |e| e.uuid == item['uuid'] }&.completed_at? }
2024-09-26 15:47:18 +03:00
end
2024-11-20 21:48:12 +02:00
def build_document_filename(submitter, blob, filename_format)
2024-11-21 23:18:27 +02:00
return blob.filename.to_s if filename_format.blank?
2024-11-20 21:48:12 +02:00
filename = ReplaceEmailVariables.call(filename_format, submitter:)
filename = filename.gsub('{document.name}', blob.filename.base)
2025-01-19 16:01:33 +02:00
filename = filename.gsub(' - {submission.status}') do
if submitter.submission.submitters.all?(&:completed_at?)
status =
if submitter.submission.template_fields.any? { |f| f['type'] == 'signature' }
I18n.t(:signed)
else
I18n.t(:completed)
end
" - #{status}"
end
end
2024-11-20 21:48:12 +02:00
filename = filename.gsub(
'{submission.completed_at}',
2025-01-16 16:30:06 +02:00
I18n.l(submitter.completed_at.in_time_zone(submitter.account.timezone), format: :short)
2024-11-20 21:48:12 +02:00
)
"#{filename}.#{blob.filename.extension}"
end
2025-07-11 09:02:18 +03:00
def send_shared_link_email_verification_code(submitter, request:)
RateLimit.call("send-otp-code-#{request.remote_ip}", limit: 2, ttl: 45.seconds, enabled: true)
TemplateMailer.otp_verification_email(submitter.submission.template, email: submitter.email).deliver_later!
rescue RateLimit::LimitApproached
Rollbar.warning("Limit verification code for template: #{submitter.submission.template.id}") if defined?(Rollbar)
raise UnableToSendCode, I18n.t('too_many_attempts')
end
def verify_link_otp!(otp, submitter)
return false if otp.blank?
RateLimit.call("verify-2fa-code-#{Digest::MD5.base64digest(submitter.email)}",
limit: 2, ttl: 45.seconds, enabled: true)
link_2fa_key = [submitter.email.downcase.squish, submitter.submission.template.slug].join(':')
raise InvalidOtp, I18n.t(:invalid_code) unless EmailVerificationCodes.verify(otp, link_2fa_key)
true
end
2023-06-26 00:46:01 +03:00
end