pageflow 16.1.0 → 17.0.0

data/app/models/concerns/pageflow/output_source.rb

@@ -8,7 +8,7 @@ module Pageflow
     extend ActiveSupport::Concern
 
     included do
-      serialize :output_presences, JSON
+      serialize :output_presences, coder: JSON
     end
 
     def present_outputs

data/app/models/concerns/pageflow/serialized_configuration.rb

@@ -7,7 +7,7 @@ module Pageflow
     extend ActiveSupport::Concern
 
     included do
-      serialize :configuration, JSON
+      serialize :configuration, coder: JSON
     end
 
     def configuration

data/app/models/concerns/pageflow/uploadable_file.rb

@@ -38,6 +38,11 @@ module Pageflow
       end
     end
 
+    # see https://github.com/rails/rails/issues/50048
+    def file_name
+      attachment_on_s3_file_name
+    end
+
     def attachment
       attachment_on_s3
     end

data/app/models/pageflow/account.rb

@@ -28,11 +28,11 @@ module Pageflow
       [:features_configuration]
     end
 
-    def self.ransackable_attributes(_auth_object)
+    def self.ransackable_attributes(_auth_object = nil)
       %w[id name]
     end
 
-    def self.ransackable_associations(_auth_object)
+    def self.ransackable_associations(_auth_object = nil)
       []
     end
   end

data/app/models/pageflow/entry.rb

@@ -29,8 +29,8 @@ module Pageflow
 
     has_many :imports, class_name: 'Pageflow::FileImport', dependent: :destroy
 
-    has_one :draft, -> { editable }, :class_name => 'Revision'
-    has_one :published_revision, -> { published }, :class_name => 'Revision'
+    has_one :draft, -> { editable }, class_name: 'Revision', inverse_of: :entry
+    has_one :published_revision, -> { published }, class_name: 'Revision', inverse_of: :entry
 
     has_one :edit_lock, :dependent => :destroy
 
@@ -88,6 +88,7 @@ module Pageflow
           revision.published_at = Time.now
           revision.published_until = options[:published_until]
           revision.password_protected = options[:password_protected]
+          revision.noindex = !!options[:noindex]
         end
       end
     end
@@ -111,6 +112,7 @@ module Pageflow
         revision.published_at = nil
         revision.published_until = nil
         revision.password_protected = nil
+        revision.noindex = nil
       end
     end
 
@@ -130,15 +132,15 @@ module Pageflow
       title.to_s.parameterize
     end
 
-    def self.ransackable_attributes(_auth_object)
+    def self.ransackable_attributes(_auth_object = nil)
       %w[title type_name created_at edited_at first_published_at]
     end
 
-    def self.ransackable_associations(_auth_object)
+    def self.ransackable_associations(_auth_object = nil)
       %w[account published_revision]
     end
 
-    def self.ransackable_scopes(_)
+    def self.ransackable_scopes(_auth_object = nil)
       [:with_publication_state, :published]
     end
 

data/app/models/pageflow/entry_at_revision.rb

@@ -22,6 +22,7 @@ module Pageflow
              :password_digest,
              :to_model, :to_key, :to_param, :persisted?, :to_json,
              :first_published_at, :published_until, :published?,
+             :last_published_with_noindex?,
              :type_name,
              to: :entry)
 
@@ -35,6 +36,7 @@ module Pageflow
              :locale,
              :author, :publisher, :keywords,
              :published_at,
+             :noindex?,
              :configuration,
              to: :revision)
 

data/app/models/pageflow/entry_template.rb

@@ -2,9 +2,12 @@ module Pageflow
   class EntryTemplate < ApplicationRecord
     include ThemeReferencer
     include SerializedConfiguration
-    serialize :default_share_providers, JSON
+
+    serialize :default_share_providers, coder: JSON
+
     belongs_to :site
     delegate :enabled_feature_names, to: :site
+
     has_many :widgets, as: :subject, dependent: :destroy
 
     validates :site, presence: true

data/app/models/pageflow/image_file.rb

@@ -2,6 +2,9 @@ module Pageflow
   class ImageFile < ApplicationRecord
     include UploadableFile
     include ImageAndTextTrackProcessingStateMachine
+    include OutputSource
+
+    before_post_process :set_output_presences
 
     # used in paperclip initializer to interpolate the storage path
     # needs to be "processed_attachments" for images for legacy reasons
@@ -35,19 +38,19 @@ module Pageflow
       panorama_format = File.extname(attachment.original_filename) == '.png' ? :PNG : :JPG
 
       Pageflow
-        .config.thumbnail_styles
+        .config.thumbnail_styles.transform_values { |options| options.merge(style_defaults) }
         .merge(
           print: {geometry: '300x300>',
-                  format: :JPG,
+                  **style_defaults,
                   convert_options: '-quality 10 -interlace Plane'},
           medium: {geometry: '1024x1024>',
-                   format: :JPG,
+                   **style_defaults,
                    convert_options: '-quality 70 -interlace Plane'},
           large: {geometry: '1920x1920>',
-                  format: :JPG,
+                  **style_defaults,
                   convert_options: '-quality 70 -interlace Plane'},
           ultra: {geometry: '3840x3840>',
-                  format: :JPG,
+                  **style_defaults,
                   convert_options: '-quality 90 -interlace Plane'},
           panorama_medium: {geometry: ImageFile.scale_down_to_cover(1024, 1024),
                             format: panorama_format,
@@ -82,5 +85,17 @@ module Pageflow
       self.height = geo.height
     rescue Paperclip::Errors::NotIdentifiedByImageMagickError
     end
+
+    def style_defaults
+      if output_present?(:webp)
+        {format: :webp, processors: [:pageflow_webp]}
+      else
+        {format: :JPG}
+      end
+    end
+
+    def set_output_presences
+      self.output_presences = {webp: true} if entry&.feature_state('webp_images')
+    end
   end
 end

data/app/models/pageflow/image_file_url_templates.rb

@@ -2,12 +2,18 @@ module Pageflow
   class ImageFileUrlTemplates
     def call
       styles.each_with_object({}) do |style, result|
-        result[style] = UrlTemplate.from_attachment(example_file.attachment, style)
+        result[style] = replace_extension_with_placeholder(
+          UrlTemplate.from_attachment(example_file.attachment, style)
+        )
       end
     end
 
     private
 
+    def replace_extension_with_placeholder(url)
+      url.gsub(/.JPG$/, '.:processed_extension')
+    end
+
     def styles
       example_file.attachment_styles(example_file.attachment).keys + [:original]
     end

data/app/models/pageflow/revision.rb

@@ -15,7 +15,7 @@ module Pageflow
 
     include ThemeReferencer
 
-    serialize :share_providers, JSON
+    serialize :share_providers, coder: JSON
 
     belongs_to :entry, touch: :edited_at
     belongs_to :creator, class_name: 'User', optional: true
@@ -65,6 +65,8 @@ module Pageflow
     scope(:with_password_protection, -> { where('password_protected IS TRUE') })
     scope(:without_password_protection, -> { where('password_protected IS NOT TRUE') })
 
+    scope(:without_noindex, -> { where('noindex IS NOT TRUE') })
+
     scope :editable, -> { where('frozen_at IS NULL') }
     scope :frozen, -> { where('frozen_at IS NOT NULL') }
 
@@ -204,6 +206,10 @@ module Pageflow
         .merge(read_attribute(:configuration) || {})
     end
 
+    def self.ransackable_attributes(_auth_object = nil)
+      %w[published_at]
+    end
+
     private
 
     def files(model)
@@ -232,9 +238,5 @@ module Pageflow
     def available_themes
       @available_themes ||= Pageflow.config_for(entry).themes
     end
-
-    def self.ransackable_attributes(_auth_object)
-      %w[published_at]
-    end
   end
 end

data/app/models/pageflow/site.rb

@@ -56,11 +56,11 @@ module Pageflow
       first_paged_entry_template.theme_name
     end
 
-    def self.ransackable_attributes(_auth_object)
+    def self.ransackable_attributes(_auth_object = nil)
       %w[name]
     end
 
-    def self.ransackable_associations(_auth_object)
+    def self.ransackable_associations(_auth_object = nil)
       %w[account]
     end
   end

data/app/models/pageflow/sitemaps.rb

@@ -6,6 +6,7 @@ module Pageflow
         site
           .entries
           .published_without_password_protection
+          .published_without_noindex
           .order('first_published_at DESC')
       )
     end

data/app/models/pageflow/theme_customization.rb

@@ -6,8 +6,8 @@ module Pageflow
   class ThemeCustomization < ApplicationRecord
     belongs_to :site
 
-    serialize :overrides, JSON
-    serialize :selected_file_ids, JSON
+    serialize :overrides, coder: JSON
+    serialize :selected_file_ids, coder: JSON
 
     has_many :uploaded_files, class_name: 'ThemeCustomizationFile'
 

data/app/models/pageflow/used_file.rb

@@ -23,6 +23,14 @@ module Pageflow
       @usage.perma_id
     end
 
+    def cache_key
+      [@file.cache_key, @usage.cache_key].join('-')
+    end
+
+    def cache_key_with_version
+      [@file.cache_key_with_version, @usage.cache_key_with_version].join('-')
+    end
+
     # Not delegated by default. Required to allow using instances in
     # Active Record conditions.
 

data/app/views/components/pageflow/admin/extensible_attributes_table.rb

@@ -79,13 +79,7 @@ module Pageflow
         # This is also the reason we can not use SimpleDelegator here
         # and also delegate_missing in Rails 5 would not work.
         def method_missing(method, *args, **kwargs, &block)
-          # Required for Ruby 2.6. Remove together with
-          # Pageflow::RailsVersion.experimental? conditionals.
-          if kwargs.present?
-            @context.public_send(method, *args, **kwargs, &block)
-          else
-            @context.public_send(method, *args, &block)
-          end
+          @context.public_send(method, *args, **kwargs, &block)
         end
         # rubocop:enable Style/MethodMissing
       end

data/app/views/components/pageflow/admin/revisions_tab.rb

@@ -39,6 +39,14 @@ module Pageflow
                 end
               end
 
+              if revision.noindex?
+                span(class: 'publication_state_indicator published_with_noindex') do
+                  span(class: 'tooltip_bubble') do
+                    t('pageflow.admin.entries.noindex')
+                  end
+                end
+              end
+
               if revision.password_protected?
                 span(class: 'publication_state_indicator published_with_password_protection') do
                   span(class: 'tooltip_bubble') do

data/app/views/pageflow/editor/config/_seeds.json.jbuilder

@@ -4,6 +4,7 @@ json.call(Pageflow.config,
           :default_published_until_duration_in_months,
           :available_locales,
           :available_public_locales,
+          :available_file_licenses,
           :available_text_track_kinds,
           :available_share_providers)
 json.file_types Pageflow.config_for(entry).file_types do |file_type|

data/app/views/pageflow/editor/entries/_entry.json.jbuilder

@@ -6,6 +6,7 @@ json.default_file_rights entry.account.default_file_rights
 json.published(entry.published?)
 json.publishable(can?(:publish, entry.to_model))
 json.password_protected(entry.password_digest.present?)
+json.last_published_with_noindex(entry.last_published_with_noindex?)
 
 json.metadata do
   json.(entry,

data/app/views/pageflow/editor/entry_publications/check.json.jbuilder

@@ -6,6 +6,7 @@ json.entry do
   json.(@entry_publication.entry, :published_until)
   json.published(@entry_publication.entry.published?)
   json.password_protected(@entry_publication.entry.password_digest.present?)
+  json.last_published_with_noindex(@entry_publication.entry.last_published_with_noindex?)
 end
 json.exhausted_html(render_html_partial('pageflow/editor/quotas/published_entries_exhausted',
                                         entry: @entry_publication.entry,

data/app/views/pageflow/image_files/_image_file.json.jbuilder

@@ -1,2 +1,3 @@
 json.call(image_file, :width, :height)
+json.processed_extension image_file.output_present?(:webp) ? 'webp' : 'JPG'
 json.created_at image_file.created_at.try(:utc).try(:iso8601, 0)

data/app/views/pageflow/meta_tags/_entry.html.erb

@@ -2,3 +2,4 @@
   <% if keywords.present? %><meta name="keywords" content="<%= keywords %>"><% end %>
   <% if author.present? %><meta name="author" content="<%= author %>"><% end %>
   <% if publisher.present? %><meta name="publisher" content="<%= publisher %>"><% end %>
+  <% if noindex %><meta name="robots" content="noindex"><% end %>

data/config/initializers/features.rb

@@ -1,5 +1,7 @@
 Pageflow.configure do |config|
+  config.features.register('webp_images')
   config.features.register('highdef_video_encoding')
   config.features.register('force_fullhd_video_quality')
+  config.features.register('large_player_pool')
   config.features.register('selectable_themes')
 end

data/config/initializers/paperclip.rb

@@ -1,5 +1,6 @@
 require 'pageflow/paperclip_processors/vtt'
 require 'pageflow/paperclip_processors/audio_waveform'
+require 'pageflow/paperclip_processors/webp'
 require 'pageflow/paperclip_processors/noop'
 
 Paperclip.interpolates(:pageflow_s3_root) do |_attachment, _style|
@@ -33,6 +34,9 @@ Paperclip.interpolates(:pageflow_hls_qualities) do |attachment, _style|
 end
 
 Paperclip.configure do |config|
+  config.register_processor(:pageflow_webp,
+                            Pageflow::PaperclipProcessors::Webp)
+
   config.register_processor(:pageflow_vtt,
                             Pageflow::PaperclipProcessors::Vtt)
 

data/config/locales/de.yml

@@ -443,6 +443,7 @@ de:
       pageflow/entry:
         publication_states:
           not_published: Nicht veröffentlicht
+          published_with_noindex: Veröffentlicht aber aus Suchmaschinen ausgeschlossen
           published_with_password_protection: Mit Passwortschutz veröffentlicht
           published_without_password_protection: Ohne Passwortschutz veröffentlicht
         share_providers:
@@ -826,6 +827,7 @@ de:
         members: Mitglieder
         no_members: Es sind keine Redakteure zugeordnet.
         no_revisions: Bisher keine Revisionen
+        noindex: Aus Suchmaschinen ausgeschlossen
         not_allowed_to_see_entry_types: Sie sind nicht berechtigt, die verfügbaren Beitrags-Typen für dieses Konto abzurufen
         not_published: Nicht veröffentlicht
         password_protected: Mit Passwortschutz
@@ -1125,6 +1127,10 @@ de:
           file_name:
             column_header: Dateiname
             label: Dateiname
+          license:
+            blank: "(Nicht angegeben)"
+            inline_help: Fügt der Rechteangabe im Beitrag einen Link zur Lizenz hinzu.
+            label: Lizenz
           original_url:
             label: Original
           rights:
@@ -1134,6 +1140,21 @@ de:
             column_header: Rechte
             inline_help: Wird im Copyright-Bereich des Beitrags angezeigt.
             label: Rechte
+          rights_display:
+            inline_help: |-
+              Lege fest, ob die Rechteangabe der Datei in der
+              zusammenfassenden Liste in der Info-Box angezeigt werden
+              soll oder unmittelbar an der Stelle im Beitrag, wo die
+              Datei verwendet wird.
+            label: Rechte anzeigen
+            values:
+              credits: In der Info-Box
+              inline: Am verwendenden Element
+          source_url:
+            inline_help: |-
+              Rechteangabe mit einem Link zur ursprünglichen Quelle
+              oder zum Author der Datei versehen.
+            label: Quell-URL
           text_tracks:
             label: Untertitel
         settings_dialog_tabs:
@@ -1351,6 +1372,12 @@ de:
           already_published_without_password_help: Dieser Beitrag ist im Moment ohne Passwortschutz veröffentlicht. Nach Festlegen eines Passworts ist kein öffentlicher Zugriff mehr möglich.
           date: Datum
           files_pending_notice: Bitte warten Sie bis alle Dateien des Beitrags verarbeitet wurden und überprüfen Sie das Ergebnis. Der Beitrag kann dann veröffentlicht werden.
+          noindex: Suchmaschinen ausschließen
+          noindex_help: |
+            Ein Meta-Tag setzen, das Crawler von Suchmaschinen wie
+            Google oder Bing anweist, den veröffentlichten Beitrag
+            nicht in den Index aufzunehmen. Der Beitrag erscheint
+            daher nicht in Suchergebnissen.
           not_published_notice: Dieser Beitrag ist zur Zeit nicht veröffentlicht.
           password: Passwort
           password_help: Teilen Sie Ihren veröffentlichten Beitrag nur mit bestimmten Personen. Besucher benötigen dann das von Ihnen festgelegte Passwort, um den Beitrag ansehen zu können.
@@ -1513,6 +1540,25 @@ de:
               label: Übersicht-Button anzeigen
             overview_button_enabled_disabled:
               inline_help: Diese Funktion steht in diesem Theme nicht zur Verfügung.
+    file_licenses:
+      cc_by_4:
+        name: CC-BY 4.0
+        url: https://creativecommons.org/licenses/by/4.0/
+      cc_by_nc_4:
+        name: CC-BY-NC 4.0
+        url: https://creativecommons.org/licenses/by-nc/4.0/
+      cc_by_nc_nd_4:
+        name: CC-BY-NC-ND 4.0
+        url: https://creativecommons.org/licenses/by-nc-nd/4.0/
+      cc_by_nc_sa_4:
+        name: CC-BY-NC-SA 4.0
+        url: https://creativecommons.org/licenses/by-sa-nc/4.0/
+      cc_by_nd_4:
+        name: CC-BY-ND 4.0
+        url: https://creativecommons.org/licenses/by-nd/4.0/
+      cc_by_sa_4:
+        name: CC-BY-SA 4.0
+        url: https://creativecommons.org/licenses/by-sa/4.0/
     help_entries:
       files:
         menu_item: Dateien verwalten
@@ -1748,6 +1794,8 @@ de:
       tr: Türkisch
       unknown: "(Unbekannt)"
       zh: Chinesisch
+    large_player_pool:
+      feature_name: Vergrößerter Player-Pool
     media_loading_spinner:
       widget_type_name: Media
     page_transitions:
@@ -1920,6 +1968,8 @@ de:
       page_type_name: Video
     waveform_player_controls:
       feature_name: Waveform-Steuerlement-Variante für Audio-Seite
+    webp_images:
+      feature_name: webp Bilder
     widgets:
       none: "(Kein)"
       roles:

data/config/locales/en.yml

@@ -443,6 +443,7 @@ en:
       pageflow/entry:
         publication_states:
           not_published: Not published
+          published_with_noindex: Published but excluded from search engines
           published_with_password_protection: Published with password protection
           published_without_password_protection: Published without password protection
         share_providers:
@@ -826,6 +827,7 @@ en:
         members: Members
         no_members: No members assigned
         no_revisions: No versions yet
+        noindex: Excluded from search engines
         not_allowed_to_see_entry_types: You are not allowed to access the available story types for this account.
         not_published: Not yet published
         password_protected: Password protected
@@ -1123,6 +1125,10 @@ en:
           file_name:
             column_header: File name
             label: File name
+          license:
+            blank: "(Not specified)"
+            inline_help: Adds a link to the license in the credit note.
+            label: License
           original_url:
             label: Original
           rights:
@@ -1132,6 +1138,20 @@ en:
             column_header: Rights
             inline_help: Displayed in copyright area of story.
             label: Rights
+          rights_display:
+            inline_help: |-
+              Decide if the file's credit note should be displayed in
+              the summary list in the info box, or right at the place
+              in the entry where the file is used.
+            label: Display rights
+            values:
+              credits: In the info box
+              inline: At the element where it is used
+          source_url:
+            inline_help: |-
+              Turns the credit note into a link to the original source
+              or to the author of the file.
+            label: Source URL
           text_tracks:
             label: Subtitles
         settings_dialog_tabs:
@@ -1349,6 +1369,12 @@ en:
           already_published_without_password_help: This story is published without a password at the moment. Setting a password will prevent public access from now on.
           date: Date
           files_pending_notice: Please wait until all files have been processed and check the results. You may then publish your story.
+          noindex: Exclude from search engines
+          noindex_help: |
+            Set a meta tag that instructs crawlers of search engines
+            like Google or Bing to not include the published entry in
+            the index. The entry will, thus, not show up in search
+            results.
           not_published_notice: This story is currently not published.
           password: Password
           password_help: Restrict access to the published version of this story. Visitors will have to enter a password.
@@ -1511,6 +1537,25 @@ en:
               label: Show 'Overview' button
             overview_button_enabled_disabled:
               inline_help: This option is not available for your theme.
+    file_licenses:
+      cc_by_4:
+        name: CC-BY 4.0
+        url: https://creativecommons.org/licenses/by/4.0/
+      cc_by_nc_4:
+        name: CC-BY-NC 4.0
+        url: https://creativecommons.org/licenses/by-nc/4.0/
+      cc_by_nc_nd_4:
+        name: CC-BY-NC-ND 4.0
+        url: https://creativecommons.org/licenses/by-nc-nd/4.0/
+      cc_by_nc_sa_4:
+        name: CC-BY-NC-SA 4.0
+        url: https://creativecommons.org/licenses/by-sa-nc/4.0/
+      cc_by_nd_4:
+        name: CC-BY-ND 4.0
+        url: https://creativecommons.org/licenses/by-nd/4.0/
+      cc_by_sa_4:
+        name: CC-BY-SA 4.0
+        url: https://creativecommons.org/licenses/by-sa/4.0/
     help_entries:
       files:
         menu_item: Manage Files
@@ -1741,6 +1786,8 @@ en:
       tr: Turkish
       unknown: "(Unknown)"
       zh: Chinese
+    large_player_pool:
+      feature_name: Large Player-Pool
     media_loading_spinner:
       widget_type_name: Media
     page_transitions:
@@ -1916,6 +1963,8 @@ en:
       page_type_name: Video
     waveform_player_controls:
       feature_name: Waveform player controls variant for audio page
+    webp_images:
+      feature_name: webp images
     widgets:
       none: "(none)"
       roles:

data/db/migrate/20231024062501_add_output_presences_to_image_files.rb

@@ -0,0 +1,5 @@
+class AddOutputPresencesToImageFiles < ActiveRecord::Migration[5.2]
+  def change
+    add_column :pageflow_image_files, :output_presences, :text
+  end
+end

data/db/migrate/20231128124523_add_noindex_to_revisions.rb

@@ -0,0 +1,5 @@
+class AddNoindexToRevisions < ActiveRecord::Migration[5.2]
+  def change
+    add_column :pageflow_revisions, :noindex, :boolean
+  end
+end