pageflow 17.0.5 → 17.1.0

data/app/controllers/pageflow/application_controller.rb

@@ -2,11 +2,15 @@ require 'cancan'
 require 'state_machines'
 
 module Pageflow
+  # @api private
   class ApplicationController < ActionController::Base
     layout 'pageflow/application'
 
     before_action do
-      I18n.locale = current_user.try(:locale) || locale_from_accept_language_header || I18n.default_locale
+      I18n.locale =
+        current_user.try(:locale) ||
+        locale_from_accept_language_header ||
+        I18n.default_locale
     end
 
     # Prevent CSRF attacks by raising an exception.
@@ -22,15 +26,9 @@ module Pageflow
 
     rescue_from ActiveRecord::RecordNotFound do |exception|
       debug_log_with_backtrace(exception)
+
       respond_to do |format|
-        format.html do
-          begin
-            render file: Rails.public_path.join('pageflow', 'error_pages', '404.html'), status: :not_found
-          rescue ActionView::MissingTemplate => exception
-            debug_log_with_backtrace(exception)
-            head :not_found
-          end
-        end
+        format.html { render_static_404_error_page }
         format.any { head :not_found }
       end
     end
@@ -38,7 +36,7 @@ module Pageflow
     rescue_from CanCan::AccessDenied do |exception|
       debug_log_with_backtrace(exception)
       respond_to do |format|
-        format.html { redirect_to main_app.admin_root_path, :alert => t('pageflow.unauthorized') }
+        format.html { redirect_to main_app.admin_root_path, alert: t('pageflow.unauthorized') }
         format.any(:json, :css) { head :forbidden }
       end
     end
@@ -46,7 +44,9 @@ module Pageflow
     rescue_from StateMachines::InvalidTransition do |exception|
       debug_log_with_backtrace(exception)
       respond_to do |format|
-        format.html { redirect_to main_app.admin_root_path, :alert => t('pageflow.invalid_transition') }
+        format.html do
+          redirect_to main_app.admin_root_path, alert: t('pageflow.invalid_transition')
+        end
         format.json { head :bad_request }
       end
     end
@@ -57,18 +57,18 @@ module Pageflow
       @current_ability ||= Ability.new(current_user)
     end
 
-    def after_sign_in_path_for(resource_or_scope)
-      root_url(:protocol => 'http')
-    end
-
-    def after_sign_out_path_for(resource_or_scope)
-      root_url(:protocol => 'http')
-    end
-
     def locale_from_accept_language_header
       http_accept_language.compatible_language_from(I18n.available_locales)
     end
 
+    def render_static_404_error_page
+      render file: Rails.public_path.join('pageflow', 'error_pages', '404.html'),
+             status: :not_found
+    rescue ActionView::MissingTemplate => e
+      debug_log_with_backtrace(e)
+      head :not_found
+    end
+
     def debug_log_with_backtrace(exception)
       Rails.logger.debug exception
       backtrace = ''

data/app/controllers/pageflow/chapters_controller.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class ChaptersController < Pageflow::ApplicationController
     respond_to :json
 
@@ -67,8 +68,8 @@ module Pageflow
       configuration = params.require(:chapter)[:configuration].try(:permit!) || {}
 
       params.require(:chapter)
-        .permit(:position, :title)
-        .merge(configuration: configuration)
+            .permit(:position, :title)
+            .merge(configuration:)
     end
   end
 end

data/app/controllers/pageflow/edit_locks_controller.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class EditLocksController < Pageflow::ApplicationController
     before_action :authenticate_user!
 
@@ -11,7 +12,7 @@ module Pageflow
 
       entry.snapshot(creator: current_user) unless entry.feature_state('no_edit_lock_snapshot')
 
-      respond_with(entry.reload.edit_lock, :location => entry_edit_lock_url(entry))
+      respond_with(entry.reload.edit_lock, location: entry_edit_lock_url(entry))
     end
 
     def update
@@ -30,7 +31,7 @@ module Pageflow
     protected
 
     def edit_lock_params
-      params.permit(:edit_lock => [:force, :id]).fetch(:edit_lock, {})
+      params.permit(edit_lock: [:force, :id]).fetch(:edit_lock, {})
     end
   end
 end

data/app/controllers/pageflow/editor/encoding_confirmations_controller.rb

@@ -1,5 +1,6 @@
 module Pageflow
   module Editor
+    # @api private
     class EncodingConfirmationsController < Pageflow::ApplicationController
       respond_to :json
 

data/app/controllers/pageflow/editor/entries_controller.rb

@@ -1,5 +1,6 @@
 module Pageflow
   module Editor
+    # @api private
     class EntriesController < Pageflow::ApplicationController
       layout 'pageflow/editor'
 
@@ -50,7 +51,7 @@ module Pageflow
                   :share_url, :share_image_id, :share_image_x, :share_image_y,
                   :locale, :author, :publisher, :keywords, :theme_name,
                   share_providers: {})
-          .merge(configuration: configuration)
+          .merge(configuration:)
       end
     end
   end

data/app/controllers/pageflow/editor/entry_publications_controller.rb

@@ -1,5 +1,6 @@
 module Pageflow
   module Editor
+    # @api private
     class EntryPublicationsController < Pageflow::ApplicationController
       respond_to :json
 

data/app/controllers/pageflow/editor/file_import_controller.rb

@@ -26,7 +26,7 @@ module Pageflow
 
           FileImportJob.perform_later(file_import.id, file_importer_credentials)
 
-          {file: file, source_url: file_params[:url]}
+          {file:, source_url: file_params[:url]}
         end
       end
 
@@ -54,12 +54,12 @@ module Pageflow
 
       def files_params
         params
-          .permit(files: [:file_name,
+          .permit(files: [:display_name,
                           :rights,
                           :content_type,
                           :file_size,
                           :url,
-                          configuration: [:alt, :source_url]])
+                          {configuration: [:alt, :source_url]}])
           .require(:files)
       end
 

data/app/controllers/pageflow/editor/files_controller.rb

@@ -1,5 +1,6 @@
 module Pageflow
   module Editor
+    # @api private
     class FilesController < Pageflow::ApplicationController
       respond_to :json
 
@@ -91,10 +92,10 @@ module Pageflow
       private
 
       def create_params
-        file_params.permit(:file_name, :content_type, :file_size)
-          .merge(file_configuration_params)
-          .merge(file_parent_file_params)
-          .merge(file_custom_params)
+        file_params.permit(:display_name, :content_type, :file_size)
+                   .merge(file_configuration_params)
+                   .merge(file_parent_file_params)
+                   .merge(file_custom_params)
       end
 
       def file_reuse_params
@@ -102,7 +103,7 @@ module Pageflow
       end
 
       def update_params
-        file_configuration_params
+        file_configuration_params.merge(file_params.permit(:display_name))
       end
 
       def file_configuration_params
@@ -110,7 +111,7 @@ module Pageflow
 
         file_params
           .permit(:rights)
-          .merge(configuration: configuration)
+          .merge(configuration:)
       end
 
       def file_parent_file_params

data/app/controllers/pageflow/editor/widgets_controller.rb

@@ -1,5 +1,6 @@
 module Pageflow
   module Editor
+    # @api private
     class WidgetsController < Pageflow::ApplicationController
       respond_to :json
 

data/app/controllers/pageflow/entries_controller.rb

@@ -6,21 +6,35 @@ module Pageflow
     include EntryPasswordProtection
 
     def index
-      site = Site.for_request(request).with_home_url.first!
+      site = Site.for_request(request).first!
 
-      redirect_to(site.home_url, allow_other_host: true)
+      entry = PublishedEntry.find_by_permalink(
+        directory: '',
+        slug: '',
+        scope: site.entries
+      )
+
+      if entry
+        handle_public_entry_request(entry)
+      elsif site.home_url.present?
+        redirect_to(site.home_url, allow_other_host: true)
+      else
+        raise ActiveRecord::RecordNotFound
+      end
     end
 
     def show
       respond_to do |format|
         format.html do
-          entry = find_by_permalink || find_by_slug
+          entry = find_by_permalink
 
-          return if redirect_according_to_entry_redirect(entry)
-          return if redirect_according_to_public_https_mode
-          return unless check_entry_password_protection(entry)
+          return if !entry && redirect_according_to_permalink_redirect
 
-          delegate_to_entry_type_frontend_app!(entry)
+          entry ||= find_by_slug!
+
+          handle_public_entry_request(entry)
+        rescue ActiveRecord::RecordNotFound
+          render_custom_or_static_404_error_page
         end
       end
     end
@@ -49,7 +63,7 @@ module Pageflow
       entry = PublishedEntry.find(params[:id], entry_request_scope)
       index = params[:page_index].split('-').first.to_i
 
-      redirect_to(short_entry_path(entry.to_model, :anchor => entry.pages[index].try(:perma_id)))
+      redirect_to(short_entry_path(entry.to_model, anchor: entry.pages[index].try(:perma_id)))
     end
 
     protected
@@ -62,7 +76,7 @@ module Pageflow
       )
     end
 
-    def find_by_slug
+    def find_by_slug!
       PublishedEntry.find(params[:id], entry_request_scope)
     end
 
@@ -70,22 +84,52 @@ module Pageflow
       Pageflow.config.public_entry_request_scope.call(Entry, request)
     end
 
+    def handle_public_entry_request(entry)
+      return if redirect_according_to_entry_redirect(entry)
+      return if redirect_according_to_public_https_mode
+      return unless check_entry_password_protection(entry)
+
+      delegate_to_entry_type_frontend_app!(entry)
+    end
+
+    def redirect_according_to_permalink_redirect
+      entry = PublishedEntry.find_by_permalink_redirect(
+        directory: params[:directory],
+        slug: params[:id],
+        site: Site.for_request(request)
+      )
+
+      return false unless entry
+
+      redirect_to(EntriesHelper::PrettyUrl.build(pageflow, entry),
+                  status: :moved_permanently,
+                  allow_other_host: true)
+      true
+    end
+
     def redirect_according_to_entry_redirect(entry)
-      return unless (redirect_location = entry_redirect(entry))
+      return false unless (redirect_location = entry_redirect(entry))
 
       redirect_to(redirect_location, status: :moved_permanently, allow_other_host: true)
+      true
     end
 
     def entry_redirect(entry)
       Pageflow.config.public_entry_redirect.call(entry, request)
     end
 
-    def delegate_to_entry_type_frontend_app!(entry)
-      EntriesControllerEnvHelper.add_entry_info_to_env(request.env, entry: entry, mode: :published)
+    def delegate_to_entry_type_frontend_app!(entry, override_status: nil)
+      EntriesControllerEnvHelper.add_entry_info_to_env(request.env, entry:, mode: :published)
+
+      delegate_to_rack_app!(entry.entry_type.frontend_app) do |result|
+        status, headers, body = result
+        config = Pageflow.config_for(entry)
 
-      delegate_to_rack_app!(entry.entry_type.frontend_app) do |_status, headers, _body|
         allow_iframe_for_embed(headers)
-        apply_cache_control(entry, headers)
+        apply_additional_headers(entry, config, headers)
+        apply_cache_control(entry, config, headers)
+
+        [override_status || status, headers, body]
       end
     end
 
@@ -93,13 +137,29 @@ module Pageflow
       headers.except!('X-Frame-Options') if params[:embed]
     end
 
-    def apply_cache_control(entry, headers)
-      config = Pageflow.config_for(entry)
-
+    def apply_cache_control(entry, config, headers)
       return if config.public_entry_cache_control_header.blank?
       return if entry.password_protected?
 
       headers['Cache-Control'] = config.public_entry_cache_control_header
     end
+
+    def apply_additional_headers(entry, config, headers)
+      headers.merge!(
+        config.additional_public_entry_headers.for(entry, request)
+      )
+    end
+
+    def render_custom_or_static_404_error_page
+      site = Site.for_request(request).first
+
+      if site&.custom_404_entry&.published_without_password_protection?
+        entry = PublishedEntry.new(site.custom_404_entry)
+        delegate_to_entry_type_frontend_app!(entry, override_status: 404)
+      else
+        # Fallback to ApplicationController's handler method
+        render_static_404_error_page
+      end
+    end
   end
 end

data/app/controllers/pageflow/feeds_controller.rb

@@ -6,7 +6,7 @@ module Pageflow
       return head 404 unless site.feeds_enabled?
 
       @feed = EntriesFeed.for(
-        site: site,
+        site:,
         locale: params[:locale]
       )
 

data/app/controllers/pageflow/files_controller.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class FilesController < Pageflow::ApplicationController
     include PublicHttpsMode
     include EntryPasswordProtection

data/app/controllers/pageflow/pages_controller.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class PagesController < Pageflow::ApplicationController
     respond_to :json
 
@@ -43,7 +44,7 @@ module Pageflow
 
       authorize!(:destroy, page)
       verify_edit_lock!(page.chapter.entry)
-      page.chapter.entry.snapshot(:creator => current_user)
+      page.chapter.entry.snapshot(creator: current_user)
 
       page.destroy
 
@@ -54,7 +55,8 @@ module Pageflow
 
     def page_params
       configuration = params.require(:page)[:configuration].try(:permit!) || {}
-      params.require(:page).permit(:template, :position, :title).merge(:configuration => configuration)
+      params.require(:page).permit(:template, :position,
+                                   :title).merge(configuration:)
     end
   end
 end

data/app/controllers/pageflow/revisions_controller.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class RevisionsController < Pageflow::ApplicationController
     include ControllerDelegation
     include QuotaVerification
@@ -38,7 +39,7 @@ module Pageflow
     end
 
     def delegate_to_entry_type_frontend_app!(entry)
-      EntriesControllerEnvHelper.add_entry_info_to_env(request.env, entry: entry, mode: :preview)
+      EntriesControllerEnvHelper.add_entry_info_to_env(request.env, entry:, mode: :preview)
       delegate_to_rack_app!(entry.entry_type.frontend_app)
     end
   end

data/app/controllers/pageflow/sitemaps_controller.rb

@@ -5,7 +5,7 @@ module Pageflow
       site = Site.for_request(request).first!
       return head 404 unless site.sitemap_enabled?
 
-      @entries = Sitemaps.entries_for(site: site)
+      @entries = Sitemaps.entries_for(site:)
 
       respond_to do |format|
         format.xml

data/app/controllers/pageflow/storylines_controller.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class StorylinesController < Pageflow::ApplicationController
     respond_to :json
 

data/app/helpers/pageflow/admin/cutoff_modes_helper.rb

@@ -0,0 +1,12 @@
+module Pageflow
+  module Admin
+    # @api private
+    module CutoffModesHelper
+      def cutoff_modes_collection(config)
+        config.cutoff_modes.names.map do |name|
+          [t(name, scope: 'pageflow.cutoff_modes'), name]
+        end
+      end
+    end
+  end
+end

data/app/helpers/pageflow/admin/entries_helper.rb

@@ -1,6 +1,6 @@
 module Pageflow
   module Admin
-    module EntriesHelper
+    module EntriesHelper # rubocop:todo Style/Documentation
       def admin_entry_title(entry)
         if entry.title.blank?
           I18n.t('pageflow.admin.entries.default_title', id: entry.id)

data/app/helpers/pageflow/admin/entry_translations_helper.rb

@@ -0,0 +1,18 @@
+module Pageflow
+  module Admin
+    # @api private
+    module EntryTranslationsHelper
+      include Pageflow::PublicI18n::LocalesHelper
+
+      def entry_translation_display_locale(entry)
+        display_locale = public_locale_name_for((entry.published_revision || entry.draft).locale)
+
+        if entry.default_translation?
+          t('pageflow.admin.entry_translations.default_translation', display_locale:)
+        else
+          display_locale
+        end
+      end
+    end
+  end
+end

data/app/helpers/pageflow/admin/features_helper.rb

@@ -1,6 +1,6 @@
 module Pageflow
   module Admin
-    module FeaturesHelper
+    module FeaturesHelper # rubocop:todo Style/Documentation
       def feature_state_select_tag(feature_target, feature_name)
         own_state = feature_target.own_feature_state(feature_name)
         inherited_state = feature_target.inherited_feature_state(feature_name)

data/app/helpers/pageflow/admin/form_helper.rb

@@ -1,13 +1,13 @@
 module Pageflow
   module Admin
-    module FormHelper
+    module FormHelper # rubocop:todo Style/Documentation
       # Using semantic_form_for directly causes Formtastic deprecation
       # warnings regarding `input_class_finder` and
       # `action_class_finder`. `active_admin_form_for` causes issues
       # in `erb` templates (see
       # https://github.com/activeadmin/activeadmin/issues/3916).
-      def admin_form_for(resource, options = {}, &block)
-        semantic_form_for(resource, options.merge(builder: ActiveAdmin::FormBuilder), &block)
+      def admin_form_for(resource, options = {}, &)
+        semantic_form_for(resource, options.merge(builder: ActiveAdmin::FormBuilder), &)
       end
     end
   end

data/app/helpers/pageflow/admin/locales_helper.rb

@@ -1,9 +1,17 @@
 module Pageflow
   module Admin
-    module LocalesHelper
+    module LocalesHelper # rubocop:todo Style/Documentation
+      include Pageflow::PublicI18n::LocalesHelper
+
       def available_locales_collection
         Pageflow.config.available_locales.map do |locale|
-          [I18n.t('language', locale: locale), locale.to_s]
+          [I18n.t('language', locale:), locale.to_s]
+        end
+      end
+
+      def available_public_locales_collection
+        Pageflow.config.available_public_locales.map do |locale|
+          [public_locale_name_for(locale), locale.to_s]
         end
       end
     end

data/app/helpers/pageflow/admin/memberships_helper.rb

@@ -1,22 +1,22 @@
 module Pageflow
   module Admin
-    module MembershipsHelper
-      def membership_user_select(f, parent)
-        if f.object.persisted?
-          membership_disabled_select(f, :user, f.object.user, :formal_name)
+    module MembershipsHelper # rubocop:todo Style/Documentation
+      def membership_user_select(form, parent)
+        if form.object.persisted?
+          membership_disabled_select(form, :user, form.object.user, :formal_name)
         elsif parent.is_a?(User)
-          membership_disabled_select(f, :user, parent, :formal_name)
+          membership_disabled_select(form, :user, parent, :formal_name)
         else
           parent_type = parent.class.model_name.singular_route_key
-          membership_select(f, :user, parent, :"potential_users_for_#{parent_type}")
+          membership_select(form, :user, parent, :"potential_users_for_#{parent_type}")
         end
       end
 
-      def membership_entity_select(f, parent, entity_type)
+      def membership_entity_select(form, parent, entity_type)
         if entity_type == 'Pageflow::Entry'
-          membership_entry_select(f, parent)
+          membership_entry_select(form, parent)
         else
-          membership_account_select(f, parent)
+          membership_account_select(form, parent)
         end
       end
 
@@ -35,41 +35,41 @@ module Pageflow
 
       private
 
-      def membership_entry_select(f, parent)
-        if f.object.persisted?
-          membership_disabled_select(f, :entity, f.object.entity, :title)
+      def membership_entry_select(form, parent)
+        if form.object.persisted?
+          membership_disabled_select(form, :entity, form.object.entity, :title)
         elsif parent.is_a?(Entry)
-          membership_disabled_select(f, :entity, parent, :title)
+          membership_disabled_select(form, :entity, parent, :title)
         else
-          membership_select(f, :entry, parent, :potential_entries_for_user)
+          membership_select(form, :entry, parent, :potential_entries_for_user)
         end
       end
 
-      def membership_account_select(f, parent)
-        if f.object.persisted?
-          membership_disabled_select(f, :entity, f.object.entity, :name)
+      def membership_account_select(form, parent)
+        if form.object.persisted?
+          membership_disabled_select(form, :entity, form.object.entity, :name)
         elsif parent.is_a?(Account)
-          membership_disabled_select(f, :entity, parent, :name)
+          membership_disabled_select(form, :entity, parent, :name)
         else
-          membership_select(f, :entity, parent, :potential_accounts_for_user)
+          membership_select(form, :entity, parent, :potential_accounts_for_user)
         end
       end
 
-      def membership_select(f, name, parent, collection_name)
-        f.input(name,
-                as: :searchable_select,
-                ajax: {resource: Membership,
-                       collection_name: collection_name,
-                       params: {parent_id: parent.id}},
-                include_blank: false)
+      def membership_select(form, name, parent, collection_name)
+        form.input(name,
+                   as: :searchable_select,
+                   ajax: {resource: Membership,
+                          collection_name:,
+                          params: {parent_id: parent.id}},
+                   include_blank: false)
       end
 
-      def membership_disabled_select(f, name, record, text_method)
-        f.input(name,
-                as: :searchable_select,
-                collection: [[record.send(text_method), record.id]],
-                include_blank: false,
-                input_html: {disabled: true})
+      def membership_disabled_select(form, name, record, text_method)
+        form.input(name,
+                   as: :searchable_select,
+                   collection: [[record.send(text_method), record.id]],
+                   include_blank: false,
+                   input_html: {disabled: true})
       end
     end
   end

data/app/helpers/pageflow/admin/revisions_helper.rb

@@ -1,6 +1,6 @@
 module Pageflow
   module Admin
-    module RevisionsHelper
+    module RevisionsHelper # rubocop:todo Style/Documentation
       def revision_css_class(revision)
         css_classes = []
         css_classes << 'published' if revision.published?

data/app/helpers/pageflow/admin/sites_helper.rb

@@ -0,0 +1,22 @@
+module Pageflow
+  module Admin
+    # @api private
+    module SitesHelper
+      def site_home_url_hint(site)
+        if site&.persisted?
+          if (root_entry = site.root_entry)
+            t('pageflow.admin.sites.home_url_with_root_entry_hint_html',
+              entry_title: root_entry.title,
+              entry_url: admin_entry_path(root_entry))
+          else
+            t('pageflow.admin.sites.home_url_hint_html',
+              choose_url: admin_site_root_entry_choose_path(site_id: site),
+              new_url: new_admin_entry_path(site_id: site, at: 'root'))
+          end
+        else
+          t('pageflow.admin.sites.home_url_new_site_hint')
+        end
+      end
+    end
+  end
+end