Class: VideoMediaController

Inherits:
ApplicationController show all
Defined in:
app/controllers/video_media_controller.rb

Overview

Video media controller for displaying video content

Constant Summary

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

Constants included from Www::SeoHelper

Www::SeoHelper::AWARDS, Www::SeoHelper::CA_ADDRESS, Www::SeoHelper::CA_BUSINESS_HOURS, Www::SeoHelper::CA_CONTACT_POINT, Www::SeoHelper::CA_CURRENCIES, Www::SeoHelper::CA_DESCRIPTION, Www::SeoHelper::CA_FOUNDING_DATE, Www::SeoHelper::CA_GLOBAL_LOCATION_NUMBER, Www::SeoHelper::CA_LEGAL_NAME, Www::SeoHelper::CA_LOCAL_BUSINESS, Www::SeoHelper::CA_ONLINE_STORE, Www::SeoHelper::CA_RETURN_POLICY, Www::SeoHelper::CA_SALES_DEPARTMENT, Www::SeoHelper::CA_SERVICE_AREA, Www::SeoHelper::CA_URL, Www::SeoHelper::CA_VAT_ID, Www::SeoHelper::CA_WAREHOUSE_DEPARTMENT, Www::SeoHelper::CA_WAREHOUSE_HOURS, Www::SeoHelper::COMPANY_EMAIL, Www::SeoHelper::COMPANY_LOGO, Www::SeoHelper::COMPANY_NAME, Www::SeoHelper::COMPANY_SLOGAN, Www::SeoHelper::EXPERTISE, Www::SeoHelper::FAX_NUMBER, Www::SeoHelper::GS1_COMPANY_PREFIX, Www::SeoHelper::ISO6523_CODE, Www::SeoHelper::PAYMENT_METHODS, Www::SeoHelper::PHONE_NUMBER, Www::SeoHelper::PRIMARY_NAICS, Www::SeoHelper::REFUND_TYPE, Www::SeoHelper::RETURN_FEES, Www::SeoHelper::RETURN_METHOD, Www::SeoHelper::RETURN_POLICY_CATEGORY, Www::SeoHelper::SECONDARY_NAICS, Www::SeoHelper::SOCIAL_PROFILES, Www::SeoHelper::US_ADDRESS, Www::SeoHelper::US_BUSINESS_HOURS, Www::SeoHelper::US_CONTACT_POINT, Www::SeoHelper::US_CURRENCIES, Www::SeoHelper::US_DESCRIPTION, Www::SeoHelper::US_FOUNDING_DATE, Www::SeoHelper::US_GLOBAL_LOCATION_NUMBER, Www::SeoHelper::US_IMAGE, Www::SeoHelper::US_LEGAL_NAME, Www::SeoHelper::US_LOCAL_BUSINESS, Www::SeoHelper::US_ONLINE_STORE, Www::SeoHelper::US_RETURN_POLICY, Www::SeoHelper::US_SALES_DEPARTMENT, Www::SeoHelper::US_SERVICE_AREA, Www::SeoHelper::US_TAX_ID, Www::SeoHelper::US_URL, Www::SeoHelper::US_WAREHOUSE_DEPARTMENT, Www::SeoHelper::US_WAREHOUSE_HOURS

Constants included from IconHelper

IconHelper::CUSTOM_ICON_MAP, IconHelper::CUSTOM_SVG_DIR, IconHelper::DEFAULT_FAMILY

Instance Method Summary collapse

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?, #stamp_impersonation_context, #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, #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 ApplicationHelper

#better_number_to_currency, #check_force_logout, #check_or_cross, #check_or_times, #embedded_tab_frame_id, #error_messages, #general_disclaimer_on_product_installation_and_local_codes, #gridjs_from_html_table, #gridjs_table, #is_wy_ip, #line_break, #parent_layout, #pass_or_fail, #render_error_messages_list, #render_video_card, #resolved_auth_form_turbo_frame, #return_path_or, #safe_css_color, #set_return_path_if_present, #set_section_if_present, #tab_frame_id, #to_underscore, #track_page?, #turbo_section_wrapper, #turbo_tabs_request?, #url_on_same_domain_as_request, #widget_index_daily_focus_index_path, #working_hours?, #yes_or_no, #yes_or_no_highlighted, #yes_or_no_with_check_or_cross, #youtube_video

Methods included from UppyUploaderHelper

#file_uploader, #image_uploader, #large_file_uploader_s3, #lead_sketch_uploader, #rma_image_uploader, #rma_image_uploader_s3, #uppy_uploader, #video_uploader

Methods included from Www::ImagesHelper

#image_asset_tag, #image_asset_url

Methods included from Www::SeoHelper

#add_page_schema, #add_webpage_schema, #canada?, #company_social_links, #ensure_context_json, #json_ld_script_tag, #local_business_schema, #online_store_id, #online_store_schema, #page_main_entity, #page_main_entity_json, #render_auto_collection_page_schema, #render_collection_page_schema, #render_local_business_schema, #render_online_store_schema, #render_page_schemas, #render_page_video_schemas, #render_webpage_schema, #render_webpage_schema_with_collections, #usa?

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?

Methods included from IconHelper

#account_nav_icon, #fa_icon, #star_rating_html

Instance Method Details

#captions ⇒ Object

Serve WebVTT captions for video players
GET /videos/:id/captions?type=polished&locale=en



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

def captions
  @video = Video.linkable_videos.friendly.find(params.expect(:id))

  vtt_type = params[:type] || 'polished'
  locale = params[:locale]

  # Determine which VTT data to use
  vtt_data = case vtt_type
             when 'original'
               @video.vtt_original_text_for_display
             when 'polished'
               @video.vtt_polished_text_for_display
             when 'translated'
               return head(:not_found) unless locale.present? && @video.has_translated_vtt?(locale)

               @video.vtt_translated_text_for_display(locale)
             else
               return head(:bad_request)
             end

  return head(:not_found) if vtt_data.blank?

  # Generate VTT content
  vtt_content = VttService.generate_vtt_content(vtt_data)

  # Cache VTT files aggressively - they rarely change
  expires_in 1.week, public: true
  set_cloudflare_cache(time_in_secs: 1.week.to_i, tags: %w[video vtt])

  send_data vtt_content,
            type: 'text/vtt; charset=utf-8',
            disposition: 'inline'
rescue ActiveRecord::RecordNotFound
  head :not_found
end

#chapters ⇒ Object

Serve a WebVTT chapters track so Shaka Player can render key-moment markers
on the seek bar (and a chapter-selection control). Each chapter spans from
its start to the next chapter's start (video duration for the last).
GET /videos/:id/chapters.vtt



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'app/controllers/video_media_controller.rb', line 195

def chapters
  video = Video.linkable_videos.includes(:video_chapters).friendly.find(params.expect(:id))
  chapters = video.video_chapters.to_a
  return head(:not_found) if chapters.empty?

  total_ms = video.duration_in_seconds.to_i * 1000
  cues = chapters.each_with_index.map do |chapter, i|
    start_ms = chapter.start_ms.to_i
    end_ms = chapters[i + 1]&.start_ms&.to_i || total_ms
    end_ms = start_ms + 1000 if end_ms <= start_ms # guard zero/negative-length cues
    { 'start_time' => start_ms, 'end_time' => end_ms, 'text' => chapter.title }
  end

  expires_in 1.week, public: true
  set_cloudflare_cache(time_in_secs: 1.week.to_i, tags: %w[video])
  send_data VttService.generate_vtt_content(cues),
            type: 'text/vtt; charset=utf-8',
            disposition: 'inline'
rescue ActiveRecord::RecordNotFound
  head :not_found
end

#index ⇒ Object

GET /videos — global video index
GET /:root(/*pl_path)/videos — pillar-scoped video index
Always cacheable; displays all videos in scope without filtering.



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

def index
  if params[:root].present?
    @pillar_product_line = resolve_pillar_product_line
    return if performed?
  end

  scope = base_video_scope
  scope = scope.by_product_line_path(@pillar_product_line.ltree_path_slugs) if @pillar_product_line
  # Pre-select the pillar in the filter form's product-line dropdown so it
  # reflects the page the user is on (and so submitting the form preserves
  # the pillar context). Uses `ltree_path_slugs` — not `slug_ltree` —
  # because the `by_product_line_path` ransack scope queries against the
  # `ltree_path_slugs` column. For roof-and-gutter-deicing the two columns
  # diverge (slug_ltree=`roof_and_gutter_deicing`, ltree_path_slugs=`roof_gutter_deicing`)
  # and the wrong choice silently filters to zero videos.
  initial_ransack = @pillar_product_line ? { by_product_line_path: @pillar_product_line.ltree_path_slugs.to_s } : {}
  @q = scope.ransack(initial_ransack)
  # NOTE: with_product_line_urls removed - not used in views and adds expensive correlated subquery
  videos_scope = uniquely_ordered_scope(@q.result.distinct)
  @pagy, @videos = pagy(:keyset, videos_scope, limit: 24)

  # Featured-video slot: every video tagged "featured-for-<pillar-slug>"
  # is promoted to the top of the grid with a Featured badge overlay,
  # most-recently-created first. Editors can promote as many as they
  # like by applying the tag in the standard tag UI on the Video edit
  # page. Pillar pages only (no global featured), page 1 only (so
  # pagination / turbo-frame next-page requests don't repeat them).
  @featured_videos = if @pillar_product_line && params[:page].blank?
                       base_video_scope
                         .tagged_with(featured_tag_for(@pillar_product_line))
                         .order(created_at: :desc, id: :desc)
                     else
                       Video.none
                     end

  # For infinite scroll: if requesting next page via turbo frame, render just the frame
  if turbo_frame_request? && params[:page].present?
    render partial: 'next_page', layout: false
  else
    set_cloudflare_cache(time_in_secs: 24.hours.to_i, tags: %w[video])
    fresh_when(etag: [@videos, params[:page], I18n.locale, @pillar_product_line&.id],
               last_modified: @videos.maximum(:updated_at), public: true)
  end
end

#search ⇒ Object

GET /videos/search — global filtered search
GET /:root(/*pl_path)/videos/search — pillar-scoped filtered search
Search action handles all filtering - never cached.

by_product_line_path is carried in the URL PATH, never the query string.
When the pillar is in the path we resolve it here; when it arrives as a
stray ?q[by_product_line_path]= (legacy links, bookmarks, bots) we 301 it
onto the canonical path-based URL, preserving any other active filters.



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

def search
  if params[:root].present?
    @pillar_product_line = resolve_pillar_product_line(suffix: 'videos/search')
    return if performed?
  end

  ransack_params = extract_ransack_params
  query_pl = ransack_params.delete('by_product_line_path')

  if @pillar_product_line
    pillar_base = "/#{I18n.locale}/#{@pillar_product_line.canonical_path}/videos"
    # The product line is the path — a stray ?q[by_product_line_path]= (legacy
    # links, bots) or a bare pillar search (no other filters → the pillar
    # landing page in disguise) is non-canonical, so 301 to the clean URL.
    if query_pl.present? || !other_filters_active?(ransack_params)
      return redirect_to(pillar_url_with_filters(pillar_base, ransack_params),
                         status: :moved_permanently)
    end

    ransack_params['by_product_line_path'] = @pillar_product_line.ltree_path_slugs.to_s
  elsif query_pl.present?
    # Move a query-string product line into the path (carrying other filters
    # along). Falls back to keeping it as a filter only when the path has no
    # pillar landing page (no canonical /<pillar>/videos URL).
    if (canonical = pillar_search_redirect(query_pl, ransack_params))
      return redirect_to(canonical, status: :moved_permanently)
    end

    ransack_params['by_product_line_path'] = query_pl
  end

  @q = base_video_scope.ransack(ransack_params)
  scoped = @q.result.distinct

  # NOTE: with_product_line_urls removed - not used in views and adds expensive correlated subquery
  videos_scope = uniquely_ordered_scope(scoped, ransack_params['s'])
  @pagy, @videos = pagy(:keyset, videos_scope, limit: 24)

  # For infinite scroll: if requesting next page via turbo frame, render just the frame
  if turbo_frame_request? && params[:page].present?
    render partial: 'next_page', layout: false
    return
  end

  # Allow browser caching with ETag revalidation, but prevent Cloudflare edge caching
  response.delete_header('Cloudflare-CDN-Cache-Control')

  # Use stale? to avoid DoubleRenderError - only render if content has changed
  return unless stale?(
    etag: [@videos, ransack_params, params[:page], I18n.locale],
    last_modified: @videos.maximum(:updated_at),
    public: false
  )

  respond_to do |format|
    format.html { render :index }
    format.turbo_stream
  end
end

#show ⇒ Object

GET /videos/:id — flat video URL (fallback when no pillar)
GET /:root(/*pl_path)/videos/:id — canonical pillar video URL



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

def show
  slug = params.expect(:id)&.downcase
  # TODO: Add a successor_id to the video model and if the video is found but not public redirect to the successor
  @video = begin
    # Preload chapters so the VideoObject schema can emit `hasPart` Clips
    # (key moments) without a lazy query — see VideoBasePresenter#chapter_clips.
    Video.linkable_videos.includes(:video_chapters).friendly.find(slug)
  rescue ActiveRecord::RecordNotFound
    # We don't need to blow up an error report. We can just redirect to the index.
  end
  if @video.nil?
    redirect_to(video_medias_path, status: :moved_permanently)
  elsif request.path != canonical_video_path(@video)
    # Flat /videos/:id (when a pillar URL exists), stale slugs, and
    # non-canonical pillar prefixes all 301 to the canonical pillar URL.
    redirect_to(canonical_video_path(@video), status: :moved_permanently)
  else # We have a video, cache
    set_noindex_for_unlisted(@video)
    set_cloudflare_cache(time_in_secs: 24.hours.to_i, tags: %w[video])
    fresh_when(etag: [@video, I18n.locale], last_modified: @video.updated_at, public: true)
  end
rescue ActiveRecord::RecordNotFound
  ErrorReporting.warning("Video #{slug} not found") if Rails.env.production?
  reset_cloudflare_cache
  redirect_to(video_medias_path, status: :moved_permanently)
end

#webinars ⇒ Object

GET /videos/webinars — paginated "Past Webinars" grid

Lazy-loaded (and infinite-scrolled) into the /webinar CMS page via a Turbo
Frame, so that page's initial render does zero webinar-video work — the grid
sits below the fold and only loads when scrolled near. Each page is 24 cards
built from the for_card_grid projection (no transcript columns), keeping
every response small and edge-cacheable.



148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'app/controllers/video_media_controller.rb', line 148

def webinars
  # Order by effective publish date — air_date when set, else created_at — so
  # an undated webinar sorts by when we added it rather than being grouped at
  # the end. (No NULLS LAST: created_at is NOT NULL, so the coalesce is never
  # NULL.) id breaks ties for stable pagination.
  scope = Video.by_category('webinar')
               .for_card_grid
               .order(Arel.sql('coalesce(air_date, created_at) DESC, id DESC'))
  @pagy, @videos = pagy(scope, limit: 24)

  set_cloudflare_cache(time_in_secs: 24.hours.to_i, tags: %w[video])
  render partial: 'webinar_videos', layout: false
end