Class: CommunicationsController

Inherits:
CrmController show all
Includes:
Controllers::Attachable, Controllers::CommunicationsTab, Controllers::Destroyable, Controllers::Showable, Controllers::Workflowable
Defined in:
app/controllers/communications_controller.rb

Overview

Controller: communications.

Constant Summary

Constants included from Controllers::Attachable

Controllers::Attachable::PUBLICATIONS_PER_PAGE

Constants included from Controllers::ReferenceFindable

Controllers::ReferenceFindable::ID_EMBEDDED_PATTERNS

Constants included from Controllers::AnalyticsEvents

Controllers::AnalyticsEvents::MAX_QUEUED_EVENTS, Controllers::AnalyticsEvents::SESSION_KEY

Constants included from Controllers::ErrorRendering

Controllers::ErrorRendering::NON_CONTENT_PATH_PREFIXES

Instance Method Summary collapse

Methods included from Controllers::Workflowable

#render_workflow_error_stream, #render_workflow_success_stream, #workflow_action, #workflow_action_complete

Methods included from Controllers::Showable

#perform_show

Methods included from Controllers::Destroyable

#destroy, #perform_destroy

Methods included from Controllers::Attachable

#attach, #publication_modal, #remove_attachment, #search_library

Methods inherited from CrmController

#access_denied, #context_id, #context_object, #crm_home_path, #current_ability, #default_url_options, #download_temp, #get_tempfile_path_for_download, #init_status_job_collector, #initialize_crm_lazy_chunks, #persist_enqueued_status_jobs, #record_not_found, #redirect_to_job_or_fallback, #render_edit_action, #set_context, #set_download_path, #stash_file_for_temp_download, #sync_admin_presence_cookie, #touch_employee_last_seen

Methods inherited from ApplicationController

#account_impersonated?, #add_to_flash, #after_sign_in_path_for, #bypass_forgery_protection?, #chat_enabled?, #cloudflare_cleared?, #default_catalog, #default_url_options, #enable_turbo_frames, #find_publication, #fix_invalid_accept_header, #init_js_utils, #is_globals_call?, #layout_by_resource, #locale_store, #redirect_to, #require_employee_for_crm, #set_base_host, #set_real_ip, #set_report_errors_for, #should_render_layout?, #skip_layout_for_turbo_frame?, #stamp_impersonation_context, #tab_frame_breakout_request?, #warmlyyours_canada_ip?, #warmlyyours_ip?, #y

Methods included from Controllers::ReturnPathHandling

#check_for_return_path, #redirect_to_return_path_or_default

Methods included from Controllers::AnalyticsEvents

#consume_queued_analytics_events, #registration_lead_type, #track_event

Methods included from Controllers::DeviceDetection

#device_detector, #is_ie?

Methods included from Controllers::SubdomainDetection

#is_crm_request?, #is_www_request?, #json_request?

Methods included from Controllers::TurboSafeRedirect

#redirect_to

Methods included from Controllers::TrackingDetection

#bot_request?, #gdpr_country?, #gdpr_country_data, #prevent_bots, #set_tracking_cookie, #track_visitor?

Methods included from Controllers::AcceleratedFileSending

#send_file_accelerated, #send_upload_accelerated

Methods included from Controllers::ErrorRendering

#excp_string, #mail_to_for_error_reporting, #render_400, #render_404, #render_406, #render_410, #render_500, #render_invalid_authenticity_token, #render_ip_spoof_error, #render_unpermitted_parameters, #safe_referer_or_fallback

Methods included from Controllers::TurnstileVerification

#load_turnstile_script_tag, #turnstile_lazy_widget, #turnstile_script_tag, #turnstile_widget, #validate_turnstile!

Methods included from Controllers::CloudflareCaching

edge_cached, #edge_cached_action?, #reset_cloudflare_cache, #set_cloudflare_cache, #skip_edge_cache!, #skip_session

Methods included from Controllers::Webpackable

#preload_webpack_fonts, #webpack_css_include, #webpack_css_url, #webpack_js_include, #wpd_is_running?

Methods included from Controllers::Localizable

#cloudflare_country_locale, #determine_request_locale, #geocoder_locale, #guest_user_locale_check, #locale_optional_www_auth_path?, #param_locale, #set_locale, #set_request_locale, #skip_localization?, #warmlyyours_ip_locale

Methods included from Controllers::Authenticable

#access_denied, #authenticate_account, #authenticate_account!, #authenticate_account_from_login_token!, #check_is_a_manager, #check_is_a_sales_manager, #check_is_an_admin, #check_is_an_employee, #check_party, #clear_mismatched_guest_user, #create_guest_user, #credentials?, #current_or_guest_user, #current_or_guest_user_id_read_only, #current_user, #devise_mapping, #fully_logged_in?, #generate_bot_id, #guest_user, #identifiable?, #init_current_user, #initialize_guest, #load_context_user, #logging_in, #resource, #resource_name, #restrict_access_for_non_employees, #scrubbed_request_path, #user_object, #warn_on_session_guest_id_leak

Methods included from UrlsHelper

#catalog_breadcrumb_links, #catalog_link, #catalog_link_for_product_line, #catalog_link_for_sku, #cms_link, #delocalized_path, #path_to_sales_product_sku, #path_to_sales_product_sku_for_product_line, #path_to_sales_product_sku_for_product_line_slug, #product_line_from_catalog_link, #protocol_neutral_url, #sanitize_external_url, #valid_external_url?

Instance Method Details

#address_book ⇒ void

This method returns an undefined value.

GET /communications/address_book — contact points for a party (and
optionally a resource's participants), for the recipient picker.



317
318
319
320
321
322
323
324
 
# File 'app/controllers/communications_controller.rb', line 317

def address_book
  @communication = Communication.new(recipient_party_id: params[:party_id])
  resource = params[:resource_type].present? && params[:resource_id].present? ? params[:resource_type].constantize.find_by(id: params[:resource_id]) : nil
  @contact_points = contact_points_for_party_id(params[:party_id], resource:)
  respond_to do |format|
    format.turbo_stream
  end
end

#allowed_senders(communication) ⇒ Array<Array(String, Integer)>

Returns [name, id] pairs the sender picker may choose from.

Parameters:

  • communication (Communication) —

    the communication being composed/edited

Returns:

  • (Array<Array(String, Integer)>) —

    [name, id] pairs the sender picker may choose from



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'app/controllers/communications_controller.rb', line 372

def allowed_senders(communication)
  list = []
  list << [communication.sender_party.full_name, communication.sender_party.id] if communication.sender_party
  if communication.recipient_party && (sales_rep = begin
    communication.recipient_party.primary_sales_rep
  rescue StandardError
    nil
  end)
    list << [sales_rep.full_name, sales_rep.id]
  end
  list << [current_user.full_name, current_user.id]
  list.uniq
end

#body ⇒ void

This method returns an undefined value.

GET /communications/:id/body — renders the communication's email body
template directly (used inside the preview iframe).



126
127
128
129
130
131
 
# File 'app/controllers/communications_controller.rb', line 126

def body
  @communication = Communication.find(params[:id])
  authorize! :read, @communication
  prepare_email_render(@communication)
  render template: "/communication_mailer/#{@communication.template_for_email}", layout: false
end

#contact_points_for_party_id(party_id, resource: nil) ⇒ ActiveRecord::Relation<ContactPoint>

Returns transmittable contact points, party's own first.

Parameters:

  • party_id (Integer, String, nil) —

    the party to list contact points for

  • resource (Object, nil) (defaults to: nil) —

    the communication's linked resource, when it's a SupportCase (participant contact points are included too)

Returns:

  • (ActiveRecord::Relation<ContactPoint>) —

    transmittable contact points, party's own first



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'app/controllers/communications_controller.rb', line 353

def contact_points_for_party_id(party_id, resource: nil)
  if party_id.present? && (party = Party.find(party_id))
    party_ids = party.try(:customer).try(:all_my_active_party_ids) || [party.id]
    party_ids = Array(party_ids)

    # Include contact points from all SupportCase participants when resource is a SupportCase
    if resource.is_a?(SupportCase)
      participant_party_ids = resource.support_case_participants.with_party.pluck(:party_id)
      party_ids = (party_ids + participant_party_ids).compact.uniq
    end

    ContactPoint.transmittable.where(party_id: party_ids).order(Arel.sql("contact_points.party_id <> #{party_id}, contact_points.party_id, contact_points.category, contact_points.detail"))
  else
    ContactPoint.none
  end
end

#copy ⇒ void

This method returns an undefined value.

POST /communications/:id/copy — deep-duplicates a communication,
detached from its original resource.



137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'app/controllers/communications_controller.rb', line 137

def copy
  old_com = Communication.find(params[:id])
  @communication = old_com.deep_dup
  @communication.resource_type = nil
  @communication.resource_id = nil
  authorize! :create, @communication
  if @communication.save
    flash[:info] = 'Communication copied successfully.'
    redirect_to_return_path_or_default edit_communication_path(@communication)
  else
    flash[:error] = "Could not copy communication: #{@communication.errors_to_s}"
    redirect_to_return_path_or_default old_com
  end
end

#create ⇒ void

This method returns an undefined value.

POST /communications — creates a communication, tolerating a
concurrent-submission uniqueness race on recipients.



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
 
# File 'app/controllers/communications_controller.rb', line 82

def create
  @communication = Communication.new(communication_params)
  @communication.check_subscription_preferences = true
  authorize! :create, @communication
  @sender_party = @communication.sender_party || current_user
  begin
    saved = @communication.save
  rescue ActiveRecord::RecordNotUnique => e
    # Cross-request race against `idx_communication_recipients_unique`:
    # in-memory dedupe (`Communication#dedupe_new_communication_recipients`)
    # handles the same-process case, but two concurrent submissions still
    # see the same view of the DB. Surface a soft validation error and
    # re-render rather than 500ing (AppSignal #5276).
    ErrorReporting.warning('Communication recipient uniqueness violation', error: e.message)
    @communication.errors.add(:base, 'A recipient with that category and detail is already on this communication. Remove the duplicate and try again.')
    saved = false
  end
  if saved
    handle_communication_action
    return_path = edit_communication_path(@communication) if params[:commit] == 'Apply'
  end
  respond_to do |format|
    format.html do
      if @communication.new_record?
        render action: :new, status: :unprocessable_content
      else
        if @communication.resource
          return_path ||= begin
            polymorphic_path(@communication.resource)
          rescue StandardError
            nil
          end
        end
        return_path ||= communication_path(@communication)
        redirect_to_return_path_or_default return_path
      end
    end
  end
end

#edit ⇒ void

This method returns an undefined value.

GET /communications/:id/edit — edit form, unless the communication can
no longer be edited (already sent/queued).



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'app/controllers/communications_controller.rb', line 64

def edit
  @communication = Communication.find(params[:id])
  unless @communication.can_be_edited?
    flash[:warning] = "This communication cannot be edited because it has already been #{@communication.state}."
    redirect_to @communication and return
  end
  # Populates the address book lookup
  @recipient_party = begin
    @communication.communication_recipients.first.contact_point.party
  rescue StandardError
    nil
  end
end

#email_preview ⇒ void

This method returns an undefined value.

GET /communications/email_preview — renders a rendering-capable
record's email body (a template, or any object with a body-rendering
method named by method), for a live editor preview.



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
 
# File 'app/controllers/communications_controller.rb', line 414

def email_preview
  @context_obj = params[:context].classify.constantize.where(id: params[:id]).first
  render(text: "Unable to find #{params[:context]} with id: #{params[:id]}") && return if @context_obj.nil?

  if params[:context] == 'email_template'
    cb = CommunicationBuilder.new(
      sender_party_id: params[:sender_party_id],
      recipient_party_id: params[:recipient_party_id],
      resource_id: params[:resource_id],
      resource_type: params[:resource_type],
      email_template: @context_obj,
      merge_options: { ignore_errors: params[:ignore_errors].to_b }
    )
    # Support preview_v4 param to preview v4 content before it's marked ready
    @email_message = @body = if params[:preview_v4].to_b && @context_obj.respond_to?(:render_body_v4) && @context_obj.body_v4_email.present?
                               @context_obj.render_body_v4(cb.merge_options)
                             else
                               @context_obj.render_body(cb.merge_options) # body
                             end
  else
    @email_message = @body = @context_obj.send(params[:method]) # body
  end
  @subject = @context_obj.subject if @context_obj.respond_to?(:subject)

  # For Redactor 4 preview, the body_v4_email is a complete HTML document
  # with inline styles - render it directly without any wrapping.
  # The HTML should have background: #ffffff baked into .email-content
  # (fixed at save time by JavaScript capture or model callback).
  if params[:preview_v4].to_b && @email_message.present?
    render html: @email_message.html_safe, layout: false
    return
  end

  # Use effective_css for Redactor 4 support (falls back to css for v3)
  @inline_stylesheet = if @context_obj.respond_to?(:effective_css)
                         @context_obj.effective_css
                       elsif @context_obj.respond_to?(:css)
                         @context_obj.css
                       end
  # Load external stylesheet - default to 'default' if not specified
  stylesheet = @context_obj.stylesheet if @context_obj.respond_to?(:stylesheet)
  stylesheet = 'default' if stylesheet.blank?
  @external_stylesheet = "emails/#{stylesheet}"

  # Use effective_template for Redactor 4 support:
  # - R4-ready templates return 'v4' which renders body directly (complete HTML document)
  # - Legacy templates return their configured template (simple, email, etc.)
  template_name = if @context_obj.respond_to?(:effective_template)
                    @context_obj.effective_template
                  elsif @context_obj.respond_to?(:template)
                    @context_obj.template
                  end

  if template_name.present?
    render "communication_mailer/#{template_name}", layout: false
  else
    render layout: false
  end
end

#events ⇒ void

This method returns an undefined value.

GET /communications/:id/events — delivery/webhook event history for a
communication's recipients.



248
249
250
 
# File 'app/controllers/communications_controller.rb', line 248

def events
  @communication = Communication.includes(communication_recipients: :webhook_events).find(params[:id])
end

#index ⇒ void

This method returns an undefined value.

GET /communications — a context object's communications tab data, or the
global filterable communications list.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'app/controllers/communications_controller.rb', line 17

def index
  if context_object
    build_communications_tab_data(context_object)
  else
    @context_object = nil
    @q = Communication.ransack(params[:q])
    @q.sorts = 'created_at desc' if @q.sorts.blank?
    @pagy, @communications = pagy(
      :countless,
      @q.result.includes(:uploads, :communication_recipients, :sender_party)
    )
    preload_communications_campaign_delivery_resources(@communications)
  end
  @sender_filter_list = Employee.all.sorted
  respond_to do |format|
    format.html { render layout: should_render_layout? }
    format.turbo_stream
  end
end

#new ⇒ void

This method returns an undefined value.

GET /communications/new — blank communication form via CommunicationBuilder.



55
56
57
58
 
# File 'app/controllers/communications_controller.rb', line 55

def new
  @communication = CommunicationBuilder.new(params.merge(current_user: current_user, for_editor: true)).build
  @sender_party = @communication.sender_party || current_user
end

#reply ⇒ void

This method returns an undefined value.

GET /communications/:id/reply — redirects into a new-communication form
pre-filled to reply to the sender.



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
 
# File 'app/controllers/communications_controller.rb', line 173

def reply
  @communication = Communication.find(params[:id])
  # tracking_email = nil
  # tracking_email = @communication.tracking_email_address

  # Format sender email with name if available
  sender_formatted = if @communication.reply_to_full_name.present? && @communication.sender.present?
                       address = Mail::Address.new(@communication.sender)
                       address.display_name = @communication.reply_to_full_name
                       address.format
                     else
                       @communication.sender
                     end

  resource = resolve_reply_resource(@communication)
  comm_params = CommunicationBuilder.new(resource:,
                                         recipient_name: @communication.reply_to_full_name,
                                         skip_attachments: true,
                                         template: EmailTemplate.find_by(system_code: 'BLANK_REPLY')).to_params
  redirect_to new_communication_path(comm_params.merge(subject: "RE: #{@communication.subject}",
                                                       emails: sender_formatted,
                                                       cc: @communication.cc,
                                                       recipient_name: @communication.reply_to_full_name,
                                                       #  reply_to: tracking_email,
                                                       skip_attachments: true,
                                                       reply_to_parent_id: @communication.id))
end

#reply_all ⇒ void

This method returns an undefined value.

GET /communications/:id/reply_all — redirects into a new-communication
form pre-filled to reply to the sender and every other recipient.



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
 
# File 'app/controllers/communications_controller.rb', line 205

def reply_all
  @communication = Communication.find(params[:id])

  # Collect all recipients for reply all:
  # - Original sender becomes primary recipient (TO)
  # - Original "to" recipients (excluding current user's email) go to CC
  # - Original CC recipients also stay in CC
  current_user_emails = current_user.contact_points.emails.pluck(:detail).map(&:downcase)

  # Build CC list from original TO and CC recipients, excluding current user
  # The Communication#to and #cc methods return formatted "Name <email>" strings
  cc_recipients = @communication.communication_recipients.reject do |cr|
    cr.email_method == 'bcc' || current_user_emails.include?(cr.detail&.downcase)
  end

  # Format recipients with names preserved
  cc_emails = cc_recipients.map do |cr|
    if cr.name.present?
      address = Mail::Address.new(cr.detail)
      address.display_name = cr.name
      address.format
    else
      cr.detail
    end
  end

  resource = resolve_reply_resource(@communication)
  comm_params = CommunicationBuilder.new(resource:,
                                         recipient_name: @communication.reply_to_full_name,
                                         skip_attachments: true,
                                         template: EmailTemplate.find_by(system_code: 'BLANK_REPLY')).to_params
  redirect_to new_communication_path(comm_params.merge(subject: "RE: #{@communication.subject}",
                                                       emails: @communication.sender,
                                                       cc: cc_emails.join(','),
                                                       recipient_name: @communication.reply_to_full_name,
                                                       skip_attachments: true,
                                                       reply_to_parent_id: @communication.id))
end

#resend ⇒ void

This method returns an undefined value.

POST /communications/:id/resend — resends the communication in place
(not a copy).



390
391
392
393
394
 
# File 'app/controllers/communications_controller.rb', line 390

def resend
  @communication = Communication.find(params[:id])
  @communication.resend
  redirect_to @communication
end

#resend_email ⇒ void

This method returns an undefined value.

POST /communications/:id/resend_email — duplicates an outbound
communication so it can be re-sent as a fresh draft.



156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'app/controllers/communications_controller.rb', line 156

def resend_email
  # This should only be for outbound emails
  old_com = Communication.direction_outbound.find(params[:id])
  @communication = old_com.deep_dup
  authorize! :create, @communication
  if @communication.save
    redirect_to_return_path_or_default edit_communication_path(@communication)
  else
    flash[:error] = "Could not copy communication: #{@communication.errors_to_s}"
    redirect_to_return_path_or_default old_com
  end
end

#resources ⇒ Object

Pulls a list of resources for activities form



397
398
399
400
401
402
403
404
405
406
407
 
# File 'app/controllers/communications_controller.rb', line 397

def resources
  @communication = Communication.find(params[:communication_id]) if params[:communication_id].present?
  @party = @communication&.recipient_party
  @party ||= Party.find(params[:party_id]) if params[:party_id].present?
  if @party.respond_to?(:resources_for_select)
    results = @party.resources_for_select(page: params[:page],
                                          query: params[:q])
  end
  results ||= {}
  render json: results
end

#send_now ⇒ void

This method returns an undefined value.

POST /communications/:id/send_now — releases (sends) a communication
immediately.



303
304
305
306
307
308
309
310
311
 
# File 'app/controllers/communications_controller.rb', line 303

def send_now
  @communication = Communication.find(params[:id])
  @communication.check_subscription_preferences = true
  if @communication.release
    redirect_to @communication
  else
    render action: :edit, status: :unprocessable_content
  end
end

#show ⇒ void

This method returns an undefined value.

GET /communications/:id — a single communication, its rendered email
preview, and its thread.



41
42
43
44
45
46
47
48
49
50
 
# File 'app/controllers/communications_controller.rb', line 41

def show
  @communication = Communication.find(params[:id])
  @email_preview_html = build_email_preview_html(@communication)
  @thread_communications = load_thread_communications(@communication)
  respond_to do |format|
    format.html
    format.xml { head :ok }
    format.json { head :no_content }
  end
end

#template ⇒ void

This method returns an undefined value.

GET /communications/template — renders a communication built from the
requested template, as JSON (subject/body/css), for the editor's
template picker.



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'app/controllers/communications_controller.rb', line 331

def template
  # Instatiate a communication with for_editor: true to use body_v4 (editable content)
  options = params.merge(current_user: current_user, for_editor: true)
  if params[:communication_id] && (existing_communication = Communication.where(id: params[:communication_id]).first) && existing_communication.template_merge_options
    options[:merge_options] ||= {}
    options[:merge_options] = options[:merge_options].merge(existing_communication.template_merge_options)
  end
  @communication = CommunicationBuilder.new(options).build
  render json: {
    subject: @communication.subject,
    body: @communication.body,
    css: @communication&.email_template&.effective_css,
    redactor_4_ready: @communication&.email_template&.redactor_4_ready?
  }
rescue StandardError => e
  Rails.logger.error "Error loading template: #{e.message}\n#{e.backtrace.first(5).join("\n")}"
  render json: { error: e.message }, status: :unprocessable_content
end

#update ⇒ void

This method returns an undefined value.

PATCH/PUT /communications/:id — updates a communication, tolerating a
concurrent-submission uniqueness race on recipients.



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
 
# File 'app/controllers/communications_controller.rb', line 256

def update
  @communication = Communication.find(params[:id])
  @communication.check_subscription_preferences = true
  unless @communication.can_be_edited?
    flash[:warning] = "This communication cannot be edited because it has already been #{@communication.state}."
    redirect_to @communication and return
  end
  begin
    updated = @communication.update(communication_params)
  rescue ActiveRecord::RecordNotUnique => e
    # See `#create` — same cross-request race against
    # `idx_communication_recipients_unique` (AppSignal #5276).
    ErrorReporting.warning('Communication recipient uniqueness violation', error: e.message, communication_id: @communication.id)
    @communication.errors.add(:base, 'A recipient with that category and detail is already on this communication. Remove the duplicate and try again.')
    updated = false
  end
  if updated
    handle_communication_action
    return_path = edit_communication_path(@communication) if params[:commit] == 'Apply'
  end
  respond_to do |format|
    format.html do
      # Send button can succeed at validation but still fail to actually
      # release/queue (left in draft or suppressed). Treat that as a Hotwire
      # validation failure so the editor stays on screen.
      send_failed = params[:button] == 'send' && (@communication.draft? || @communication.suppressed?)
      if @communication.errors.present? || send_failed
        # Promote any flash[:error] set by handle_communication_flash into
        # flash.now so it shows on the re-rendered edit form (a redirect
        # won't happen).
        if flash[:error].present?
          flash.now[:error] = flash[:error]
          flash.delete(:error)
        end
        render action: :edit, status: :unprocessable_content
      else
        return_path ||= communication_path(@communication)
        redirect_to_return_path_or_default(return_path)
      end
    end
  end
end