iachat/app/models/channel/whatsapp.rb
2026-02-26 10:49:00 -03:00

439 lines
16 KiB
Ruby

# == Schema Information
#
# Table name: channel_whatsapp
#
# id :bigint not null, primary key
# evolution_api_token :string
# evolution_api_token_iv :string
# message_templates :jsonb
# message_templates_last_updated :datetime
# phone_number :string not null
# provider :string default("default")
# provider_config :jsonb
# provider_connection :jsonb
# wuzapi_admin_token :string
# wuzapi_admin_token_iv :string
# wuzapi_user_token :string
# wuzapi_user_token_iv :string
# created_at :datetime not null
# updated_at :datetime not null
# account_id :integer not null
#
# Indexes
#
# index_channel_whatsapp_on_phone_number (phone_number) UNIQUE
# index_channel_whatsapp_provider_connection (provider_connection) WHERE ((provider)::text = ANY ((ARRAY['baileys'::character varying, 'zapi'::character varying])::text[])) USING gin
#
class Channel::Whatsapp < ApplicationRecord # rubocop:disable Metrics/ClassLength
include Channelable
include Reauthorizable
self.table_name = 'channel_whatsapp'
attr_accessor :inbox_name_for_provisioning
EDITABLE_ATTRS = [:phone_number, :provider, :wuzapi_user_token, :wuzapi_admin_token, :evolution_api_token, :inbox_name_for_provisioning,
{ provider_config: {} }].freeze
# default at the moment is 360dialog lets change later.
PROVIDERS = %w[default whatsapp_cloud wuzapi baileys zapi evolution].freeze
encrypts :wuzapi_user_token, :wuzapi_admin_token, :evolution_api_token
before_validation :ensure_webhook_verify_token
before_validation :move_tokens_to_encrypted_attributes
before_validation :provision_wuzapi_user, on: :create
before_validation :provision_evolution_instance, on: :create
validates :provider, inclusion: { in: PROVIDERS }
validates :phone_number, presence: true, uniqueness: true
validate :validate_provider_config
after_create :sync_templates
after_create_commit :setup_webhooks
after_update_commit :setup_webhooks, if: :webhook_configuration_changed?
before_destroy :teardown_webhooks
def name
'Whatsapp'
end
def provider_service
case provider
when 'whatsapp_cloud'
Whatsapp::Providers::WhatsappCloudService.new(whatsapp_channel: self)
when 'wuzapi'
Whatsapp::Providers::WuzapiService.new(whatsapp_channel: self)
when 'baileys'
Whatsapp::Providers::WhatsappBaileysService.new(whatsapp_channel: self)
when 'zapi'
Whatsapp::Providers::WhatsappZapiService.new(whatsapp_channel: self)
when 'evolution'
Whatsapp::Providers::EvolutionService.new(whatsapp_channel: self)
else
Whatsapp::Providers::Whatsapp360DialogService.new(whatsapp_channel: self)
end
end
def mark_message_templates_updated
# rubocop:disable Rails/SkipsModelValidations
update_column(:message_templates_last_updated, Time.zone.now)
# rubocop:enable Rails/SkipsModelValidations
end
delegate :send_message, to: :provider_service
delegate :send_reaction_message, to: :provider_service
delegate :send_template, to: :provider_service
delegate :sync_templates, to: :provider_service
delegate :media_url, to: :provider_service
delegate :api_headers, to: :provider_service
def setup_webhooks
perform_webhook_setup
rescue StandardError => e
Rails.logger.error "[WHATSAPP] Webhook setup failed: #{e.message}"
prompt_reauthorization!
end
def use_internal_host?
provider == 'baileys' && ENV.fetch('BAILEYS_PROVIDER_USE_INTERNAL_HOST_URL', false)
end
def update_provider_connection!(provider_connection)
assign_attributes(provider_connection: provider_connection)
# NOTE: Skip `validate_provider_config?` check
save!(validate: false)
end
def provider_connection_data
data = { connection: provider_connection['connection'] }
if Current.account_user&.administrator?
data[:qr_data_url] = provider_connection['qr_data_url']
data[:error] = provider_connection['error']
end
data
end
def toggle_typing_status(typing_status, conversation:)
return unless provider_service.respond_to?(:toggle_typing_status)
identifier = conversation.contact.identifier
phone_number = conversation.contact.phone_number
recipient_id = identifier || phone_number
# Debug Log
Rails.logger.info "[Typing] recipient_id=#{recipient_id.inspect} identifier=#{identifier.inspect} phone=#{phone_number.inspect}"
# Validation: Ensure recipient_id is E164 compliant (digits only, maybe +).
# If identifier is something like x@lid, we should fallback to phone_number.
# Using suggested regex: \A\+?\d{10,15}\z
unless recipient_id.to_s.gsub(/[\+\s\-\(\)]/, '').match?(/\A\d{10,15}\z/)
Rails.logger.warn "[Typing] Invalid recipient_id format (#{recipient_id}). Falling back to phone_number: #{phone_number}"
recipient_id = phone_number
end
provider_service.toggle_typing_status(typing_status, last_message: nil, recipient_id: recipient_id)
end
def update_presence(status)
return unless provider_service.respond_to?(:update_presence)
provider_service.update_presence(status)
end
def read_messages(messages, conversation:)
return unless provider_service.respond_to?(:read_messages)
# NOTE: This is the default behavior, so `mark_as_read` being `nil` is the same as `true`.
return if provider_config&.dig('mark_as_read') == false
recipient_id = if provider == 'zapi'
conversation.contact.phone_number
else
conversation.contact.identifier || conversation.contact.phone_number
end
provider_service.read_messages(messages, recipient_id: recipient_id)
end
def unread_conversation(conversation)
return unless provider_service.respond_to?(:unread_message)
# NOTE: For the Baileys provider, the last message is required even if it is an outgoing message.
last_message = conversation.messages.last
provider_service.unread_message(conversation.contact.phone_number, last_message) if last_message
end
def disconnect_channel_provider
provider_service.disconnect_channel_provider
rescue StandardError => e
# NOTE: Don't prevent destruction if disconnect fails
Rails.logger.error "Failed to disconnect channel provider: #{e.message}"
end
def received_messages(messages, conversation)
return unless provider_service.respond_to?(:received_messages)
recipient_id = conversation.contact.identifier || conversation.contact.phone_number
provider_service.received_messages(recipient_id, messages)
end
def on_whatsapp(phone_number)
return unless provider_service.respond_to?(:on_whatsapp)
provider_service.on_whatsapp(phone_number)
end
private
def webhook_configuration_changed?
return true if saved_change_to_provider? && provider.in?(%w[wuzapi evolution])
return false unless provider.in?(%w[wuzapi evolution])
if provider == 'evolution'
return saved_change_to_evolution_api_token? ||
(saved_change_to_provider_config? && provider_config['evolution_base_url'] != provider_config_before_last_save['evolution_base_url'])
end
saved_change_to_wuzapi_user_token? ||
(saved_change_to_provider_config? && provider_config['wuzapi_base_url'] != provider_config_before_last_save['wuzapi_base_url'])
end
def ensure_webhook_verify_token
provider_config['webhook_verify_token'] ||= SecureRandom.hex(16) if provider.in?(%w[whatsapp_cloud baileys])
end
def move_tokens_to_encrypted_attributes
move_evolution_token_to_encrypted_attribute
return unless provider == 'wuzapi'
move_wuzapi_user_token_to_encrypted_attribute
move_wuzapi_admin_token_to_encrypted_attribute
end
def validate_provider_config
errors.add(:provider_config, 'Invalid Credentials') unless provider_service.validate_provider_config?
end
def perform_webhook_setup
return setup_wuzapi_webhook if provider == 'wuzapi'
return setup_evolution_webhook if provider == 'evolution'
return provider_service.setup_channel_provider if provider_service.respond_to?(:setup_channel_provider)
setup_default_webhook
end
def teardown_webhooks
if provider == 'wuzapi'
teardown_wuzapi_session
elsif provider == 'evolution'
teardown_evolution_session
else
Whatsapp::WebhookTeardownService.new(self).perform
end
rescue StandardError => e
Rails.logger.error "[WHATSAPP] Failed to teardown webhooks: #{e.message}"
end
def teardown_wuzapi_session
return if provider_config['wuzapi_base_url'].blank?
client = Wuzapi::Client.new(provider_config['wuzapi_base_url'])
disconnect_wuzapi_user_session(client)
delete_wuzapi_user_with_admin_token(client)
end
def provision_wuzapi_user
return unless provider == 'wuzapi' && provider_config['auto_create_user']
return if wuzapi_user_token.present?
admin_token = wuzapi_admin_token
base_url = provider_config['wuzapi_base_url']
user_name = build_wuzapi_user_name
result = provision_wuzapi_user_with_fallback(base_url, admin_token, user_name)
provider_config['wuzapi_user_id'] = result[:wuzapi_user_id]
self.wuzapi_user_token = result[:wuzapi_user_token]
masked_token = result[:wuzapi_user_token].to_s[-4..]
Rails.logger.info "Wuzapi User Provisioned. ID: #{result[:wuzapi_user_id]}, Token (last 4): ****#{masked_token}"
end
def teardown_evolution_session
return if provider_config['evolution_base_url'].blank?
client = EvolutionApi::Client.new(provider_config['evolution_base_url'], evolution_api_token)
instance_name = "Chatwoot_#{phone_number}"
begin
client.logout_instance(instance_name)
rescue StandardError => e
Rails.logger.warn "Evolution Logout Failed: #{e.message}"
end
begin
client.delete_instance(instance_name)
rescue StandardError => e
Rails.logger.warn "Evolution Delete Instance Failed: #{e.message}"
end
end
def provision_evolution_instance
return unless provider == 'evolution'
return if evolution_api_token.blank?
begin
instance_name = "Chatwoot_#{phone_number}"
client = EvolutionApi::Client.new(provider_config['evolution_base_url'], evolution_api_token)
create_evolution_instance(client, instance_name)
apply_evolution_instance_settings(client, instance_name)
provider_config['evolution_instance_id'] = instance_name
rescue StandardError => e
Rails.logger.error "Evolution Provisioning failed: #{e.message}"
errors.add(:base, "Evolution Provisioning Failed: #{e.message}")
throw(:abort)
end
end
def move_evolution_token_to_encrypted_attribute
return unless provider == 'evolution'
return if provider_config['evolution_api_token'].blank?
self.evolution_api_token = provider_config['evolution_api_token']
provider_config.delete('evolution_api_token')
end
def move_wuzapi_user_token_to_encrypted_attribute
return if provider_config['wuzapi_user_token'].blank?
self.wuzapi_user_token = provider_config['wuzapi_user_token']
provider_config.delete('wuzapi_user_token')
end
def move_wuzapi_admin_token_to_encrypted_attribute
return if provider_config['wuzapi_admin_token'].blank?
self.wuzapi_admin_token = provider_config['wuzapi_admin_token']
provider_config.delete('wuzapi_admin_token')
end
def setup_wuzapi_webhook
return if inbox.blank?
return if wuzapi_user_token.blank?
client = Wuzapi::Client.new(provider_config['wuzapi_base_url'])
client.set_webhook(wuzapi_user_token, wuzapi_webhook_url)
rescue StandardError => e
Rails.logger.error "Wuzapi Webhook Setup Failed: #{e.message}"
end
def setup_evolution_webhook
return if inbox.blank?
return if evolution_api_token.blank?
client = EvolutionApi::Client.new(provider_config['evolution_base_url'], evolution_api_token)
client.set_webhook("Chatwoot_#{phone_number}", evolution_webhook_url)
rescue StandardError => e
Rails.logger.error "Evolution Webhook Setup Failed: #{e.message}"
end
def setup_default_webhook
business_account_id = provider_config['business_account_id']
api_key = provider_config['api_key']
Whatsapp::WebhookSetupService.new(self, business_account_id, api_key).perform
end
def wuzapi_webhook_url
app_url = ENV['FRONTEND_URL'].presence || 'http://localhost:3000'
webhook_phone = phone_number.to_s.gsub(/\D/, '')
"#{app_url}/webhooks/whatsapp/#{webhook_phone}"
end
def evolution_webhook_url
app_url = ENV['FRONTEND_URL'].presence || 'http://localhost:3000'
"#{app_url}/webhooks/evolution/#{phone_number}"
end
def disconnect_wuzapi_user_session(client)
return if wuzapi_user_token.blank?
safely_with_wuzapi_log('Logout') { client.session_logout(wuzapi_user_token) }
safely_with_wuzapi_log('Disconnect') { client.session_disconnect(wuzapi_user_token) }
end
def delete_wuzapi_user_with_admin_token(client)
return unless wuzapi_admin_token.present? && provider_config['wuzapi_user_id'].present?
safely_with_wuzapi_log('Delete User') do
client.delete_user(wuzapi_admin_token, provider_config['wuzapi_user_id'])
end
end
def safely_with_wuzapi_log(action)
yield
rescue StandardError => e
Rails.logger.warn "Wuzapi #{action} Failed: #{e.message}"
end
def build_wuzapi_user_name
raw_name = inbox&.name || inbox_name_for_provisioning
sanitized_inbox_name = raw_name.to_s.gsub(/[^a-zA-Z0-9]/, '_')
prefix = sanitized_inbox_name.presence || 'Chatwoot'
"#{prefix}_#{phone_number}"
end
def provision_wuzapi_user_with_fallback(base_url, admin_token, user_name)
provision_wuzapi_user_for_url(base_url, admin_token, user_name)
rescue StandardError => e
handle_wuzapi_provision_failure(base_url, admin_token, user_name, e)
end
def provision_wuzapi_user_for_url(url, admin_token, user_name)
service = Wuzapi::ProvisioningService.new(url, admin_token)
service.provision(user_name)
end
def handle_wuzapi_provision_failure(base_url, admin_token, user_name, error)
Rails.logger.warn "Wuzapi Provisioning failed with URL #{base_url}: #{error.message}"
raise error unless base_url.match?(%r{/api/?$})
fallback_url = base_url.gsub(%r{/api/?$}, '')
Rails.logger.info "Retrying Wuzapi Provisioning with fallback URL: #{fallback_url}"
result = provision_wuzapi_user_for_url(fallback_url, admin_token, user_name)
provider_config['wuzapi_base_url'] = fallback_url
Rails.logger.info "Wuzapi Provisioning fallback successful. Updated base_url to #{fallback_url}"
result
rescue StandardError => e
Rails.logger.error "Wuzapi Provisioning fallback also failed: #{e.message}"
errors.add(:base, "Wuzapi Provisioning Failed: #{e.message}")
throw(:abort)
end
def create_evolution_instance(client, instance_name)
client.create_instance(instance_name)
rescue StandardError => e
Rails.logger.warn "Evolution Create Instance failed (might already exist): #{e.message}"
end
def apply_evolution_instance_settings(client, instance_name)
evolution_settings = provider_config['settings']
return unless evolution_settings.is_a?(Hash)
client.set_settings(instance_name, { 'alwaysOnline' => to_boolean(evolution_settings['always_online']) })
client.set_instance_settings(instance_name, evolution_instance_settings_payload(evolution_settings))
rescue StandardError => e
Rails.logger.warn "Evolution Apply Settings failed: #{e.message}"
end
def evolution_instance_settings_payload(evolution_settings)
{
'rejectCall' => to_boolean(evolution_settings['reject_call']),
'readMessages' => to_boolean(evolution_settings['read_messages']),
'ignoreGroups' => to_boolean(evolution_settings['ignore_groups']),
'ignoreStatus' => to_boolean(evolution_settings['ignore_status'])
}
end
def to_boolean(value)
value == true || value == 'true'
end
end