pageflow 12.0.4 → 12.1.0

data/app/mailers/pageflow/user_mailer.rb

@@ -3,7 +3,17 @@ module Pageflow
     include Resque::Mailer
 
     def invitation(options)
-      options.symbolize_keys!
+      # Different versions of resque_mailer either pass:
+      #
+      # - Hash with string keys (<= 2.4.0)
+      # - Hash with symbol keys (2.4.1)
+      # - Hash with both string and symbol keys (2.4.2)
+      # - HashWithIndifferentAccess (2.4.3)
+      #
+      # Symbolize keys to support 2.4.1, but do not use bang version
+      # (i.e. `smbolize_keys!`) since that is not supported by
+      # HashWithIndifferentAccess.
+      options = options.symbolize_keys
 
       @user = User.find(options[:user_id])
       @password_token = options[:password_token]

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

@@ -49,7 +49,7 @@ module Pageflow
     end
 
     def features_configuration
-      super || {}
+      self[:features_configuration] || {}
     end
   end
 end

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

@@ -71,6 +71,15 @@ module Pageflow
       url
     end
 
+    def cache_key
+      # Ensure the cache key changes when the state changes. There are
+      # cases during processing where the state is updated multiple
+      # times in a single second. Since `cache_key` relies on
+      # `updated_at`, which only is acurate to the second, we need to
+      # prevent caching outdated information.
+      "#{super}-#{state}"
+    end
+
     # @deprecated Write a migration instead
     def self.columns(t)
       t.belongs_to(:entry, index: true)

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

@@ -40,7 +40,8 @@ module Pageflow
     end
 
     def output_presences
-      (super || {}).merge(externally_generated_output_presences)
+      output_presences = self[:output_presences] || {}
+      output_presences.merge(externally_generated_output_presences)
     end
 
     def externally_generated_outputs

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

@@ -0,0 +1,19 @@
+module Pageflow
+  # @api private
+  module SerializationBlacklist
+    def serializable_hash(options = nil)
+      options ||= {}
+
+      options[:except] = Array(options[:except])
+      options[:except].concat(blacklist_for_serialization)
+
+      super(options)
+    end
+
+    private
+
+    def blacklist_for_serialization
+      []
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Pageflow
+  # Add a +configuration+ attribute.
+  # This is a hash serialized as JSON.
+  # It contains everything related to the object, which includes its text
+  # content such as title and body.
+  module SerializedConfiguration
+    extend ActiveSupport::Concern
+
+    included do
+      serialize :configuration, JSON
+    end
+
+    def configuration
+      self[:configuration] || {}
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Pageflow
+  module ThemeReferencer
+    extend ActiveSupport::Concern
+
+    included do
+      validates_inclusion_of(:theme_name, in: :available_theme_names)
+    end
+
+    def theme
+      available_themes.get(theme_name)
+    end
+
+    private
+
+    def available_theme_names
+      available_themes.names
+    end
+
+    def available_themes
+      raise NotImplementedError
+    end
+  end
+end

data/app/models/pageflow/account.rb

@@ -1,6 +1,7 @@
 module Pageflow
-  class Account < ActiveRecord::Base
+  class Account < ApplicationRecord
     include FeatureTarget
+    include SerializationBlacklist
 
     has_many :entries, dependent: :restrict_with_exception
     has_many :folders, dependent: :destroy
@@ -22,5 +23,9 @@ module Pageflow
         theming.account = self
       end
     end
+
+    def blacklist_for_serialization
+      [:features_configuration]
+    end
   end
 end

data/app/models/pageflow/account_member_query.rb

@@ -1,8 +1,9 @@
 module Pageflow
-  class AccountMemberQuery
-    class Scope
+  # Query accounts for members, e.g. based on role
+  class AccountMemberQuery < ApplicationQuery
+    class Scope < ApplicationQuery::Scope
       # Account whose members we scope
-      # @return {Pageflow::Account}
+      # @return [Pageflow::Account]
       attr_reader :account
 
       # Base scope which is further scoped according to account role
@@ -12,7 +13,7 @@ module Pageflow
       # Create scope that can limit base scope to account members at
       # or above a given role
       #
-      # @param {Pageflow::Account} account
+      # @param [Pageflow::Account] account
       #   Required. Membership account to check.
       # @param [ActiveRecord::Relation<User>] scope
       #   Optional. Membership entity to check.
@@ -24,7 +25,7 @@ module Pageflow
       # Scope to those members from scope on account who have at least
       # role
       #
-      # @param {String} role
+      # @param [String] role
       #   Required. Minimum role that we compare against.
       # @return [ActiveRecord::Relation<User>]
       def with_role_at_least(role)
@@ -34,7 +35,6 @@ module Pageflow
 
       private
 
-      # @api private
       def memberships_for_account_with_at_least_role(role)
         options = {roles: Roles.at_least(role), account_id: account.id}
 
@@ -48,15 +48,9 @@ module Pageflow
         SQL
       end
 
-      # @api private
       def membership_is_present
         'pageflow_account_memberships.entity_id IS NOT NULL'
       end
-
-      # @api private
-      def sanitize_sql(sql, interpolations)
-        ActiveRecord::Base.send(:sanitize_sql_array, [sql, interpolations])
-      end
     end
   end
 end

data/app/models/pageflow/account_role_query.rb

@@ -0,0 +1,68 @@
+module Pageflow
+  # Query users for their role on accounts based on role
+  class AccountRoleQuery < ApplicationQuery
+    # Query for accounts where a user has a given role.
+    class Scope < Scope
+      # Create query scope.
+      #
+      # @param [User] user
+      #   User to query roles for.
+      # @param [ActiveRecord::Relation] scope
+      #   Scope of all accounts to filter from.
+      def initialize(user, scope)
+        @user = user
+        @scope = scope
+      end
+
+      # Find all accounts where user has at least given role.
+      #
+      # @param [String] role
+      #   Name of role.
+      # @return [ActiveRecord::Relation]
+      def with_role_at_least(role)
+        scope.joins(with_membership_for_account(role))
+      end
+
+      private
+
+      attr_reader :user, :scope
+
+      def with_membership_for_account(role)
+        sanitize_sql(<<-SQL, user_id: user.id, roles: Roles.at_least(role))
+          INNER JOIN pageflow_memberships ON
+          pageflow_memberships.user_id = :user_id AND
+          pageflow_memberships.entity_id = pageflow_accounts.id AND
+          pageflow_memberships.entity_type = "Pageflow::Account" AND
+          pageflow_memberships.role IN (:roles)
+        SQL
+      end
+    end
+
+    # Create query that can be used for role comparisons
+    #
+    # @param [User] user
+    #   Required. Membership user to check.
+    # @param [Pageflow::Account] account
+    #   Required. Membership entity to check.
+    def initialize(user, account)
+      @user = user
+      @account = account
+    end
+
+    # Return true if there is a membership with at least role for
+    # user/account
+    #
+    # @param [String] role
+    #   Required. Minimum role that we compare against.
+    # @return [Boolean]
+    def has_at_least_role?(role)
+      @user
+        .memberships
+        .where(role: Roles.at_least(role))
+        .where('(entity_id = :account_id AND '\
+               "entity_type = 'Pageflow::Account')",
+               account_id: @account.id)
+        .any?
+    end
+  end
+end

data/app/models/pageflow/application_query.rb

@@ -0,0 +1,13 @@
+module Pageflow
+  # Abstraction layer for Pageflow's query interface
+  class ApplicationQuery
+    class Scope
+      protected
+
+      # @api private
+      def sanitize_sql(sql, interpolations)
+        ActiveRecord::Base.send(:sanitize_sql_array, [sql, interpolations])
+      end
+    end
+  end
+end

data/app/models/pageflow/application_record.rb

@@ -0,0 +1,5 @@
+module Pageflow
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/pageflow/audio_file.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class AudioFile < ActiveRecord::Base
+  class AudioFile < ApplicationRecord
     include HostedFile
     include EncodedFileStateMachine
 

data/app/models/pageflow/auto_snapshot_pruning.rb

@@ -0,0 +1,26 @@
+module Pageflow
+  # @api private
+  module AutoSnapshotPruning
+    extend self
+
+    def dirty_entry_ids(options)
+      Revision
+        .auto_snapshots
+        .where('created_at < ?', options.fetch(:created_before))
+        .select('COUNT(*) as revisions_count, entry_id')
+        .group('entry_id')
+        .having('revisions_count > ?', options.fetch(:keep_count))
+        .map(&:entry_id)
+    end
+
+    def prune(entry, options)
+      entry
+        .revisions
+        .auto_snapshots
+        .where('created_at < ?', options[:created_before])
+        .order('created_at DESC')
+        .offset(options[:keep_count])
+        .each(&:destroy)
+    end
+  end
+end

data/app/models/pageflow/chapter.rb

@@ -1,16 +1,12 @@
 module Pageflow
-  class Chapter < ActiveRecord::Base
+  class Chapter < ApplicationRecord
+    include SerializedConfiguration
+
     belongs_to :storyline, touch: true
-    has_many :pages, -> { order('position ASC') }
+    has_many :pages, -> { order('position ASC') }, dependent: :destroy
 
     delegate :entry, to: :storyline
 
-    serialize :configuration, JSON
-
-    def configuration
-      super || {}
-    end
-
     def copy_to(storyline)
       chapter = dup
       storyline.chapters << chapter

data/app/models/pageflow/draft_entry.rb

@@ -22,6 +22,7 @@ module Pageflow
              :image_files, :video_files, :audio_files,
              :locale,
              :author, :publisher, :keywords,
+             :theme,
              :to => :draft)
 
     def initialize(entry, draft = nil)
@@ -99,7 +100,7 @@ module Pageflow
     end
 
     def overview_button
-      OverviewButton.new(draft, theming)
+      OverviewButton.new(draft)
     end
 
     def resolve_widgets(options = {})

data/app/models/pageflow/edit_lock.rb

@@ -1,8 +1,9 @@
 module Pageflow
-  class EditLock < ActiveRecord::Base
-    TIME_TO_LIVE = 10.seconds
-
-    scope :active, ->(time = Time.now - TIME_TO_LIVE) { where('pageflow_edit_locks.updated_at >= ?', time) }
+  class EditLock < ApplicationRecord
+    scope :active, (lambda do
+      time = Time.now - EditLock.time_to_live
+      where('pageflow_edit_locks.updated_at >= ?', time)
+    end)
 
     class Error < RuntimeError
       def code
@@ -24,6 +25,11 @@ module Pageflow
     belongs_to :user
     belongs_to :entry, :inverse_of => :edit_lock
 
+    def self.time_to_live
+      timer_tolerance = 2.3
+      Pageflow.config.edit_lock_polling_interval * timer_tolerance
+    end
+
     def held_by?(user)
       self.user == user
     end
@@ -33,7 +39,7 @@ module Pageflow
     end
 
     def timed_out?
-      Time.now > self.updated_at + TIME_TO_LIVE
+      Time.now > updated_at + EditLock.time_to_live
     end
 
     def acquire(current_user, options = {})

data/app/models/pageflow/encoding_confirmation.rb

@@ -3,13 +3,14 @@ module Pageflow
     class QuotaExceededError < RuntimeError
     end
 
-    attr_reader :entry, :attributes, :encoding_quota, :user
+    attr_reader :entry, :attributes, :encoding_quota, :user, :account
 
     def initialize(entry, attributes, encoding_quota, user)
       @entry = entry
       @attributes = attributes
       @encoding_quota = encoding_quota
       @user = user
+      @account = entry.account
     end
 
     def exceeding?

data/app/models/pageflow/entry.rb

@@ -1,10 +1,11 @@
 module Pageflow
-  class Entry < ActiveRecord::Base
+  class Entry < ApplicationRecord
     class PasswordMissingError < StandardError
     end
 
     include FeatureTarget
     include EntryPublicationStates
+    include SerializationBlacklist
 
     extend FriendlyId
     friendly_id :slug_candidates, :use => [:finders, :slugged]
@@ -38,10 +39,15 @@ module Pageflow
 
     scope :editing, -> { joins(:edit_lock).merge(Pageflow::EditLock.active) }
 
+    scope(:include_account_name,
+          lambda do
+            joins(:account).select('pageflow_entries.*, pageflow_accounts.name AS account_name')
+          end)
+
     attr_accessor :skip_draft_creation
 
     after_create unless: :skip_draft_creation do
-      create_draft!(home_button_enabled: theming.home_button_enabled_by_default)
+      create_draft!
       draft.storylines.create!(configuration: {main: true})
       theming.copy_defaults_to(draft)
     end
@@ -87,6 +93,7 @@ module Pageflow
       restored_revision.copy do |revision|
         revision.restored_from = restored_revision
         revision.frozen_at = nil
+        revision.snapshot_type = nil
         revision.published_at = nil
         revision.published_until = nil
         revision.password_protected = nil
@@ -109,6 +116,10 @@ module Pageflow
       [:with_publication_state, :published]
     end
 
+    def blacklist_for_serialization
+      [:password_digest, :features_configuration]
+    end
+
     private
 
     def folder_belongs_to_same_account

data/app/models/pageflow/entry_publication.rb

@@ -16,6 +16,8 @@ module Pageflow
     def save!
       assumed_quota.verify_not_exceeded!
       entry.publish(attributes.merge(creator: user))
+
+      Pageflow.config.hooks.invoke(:entry_published, entry: entry)
     end
 
     private

data/app/models/pageflow/entry_role_query.rb

@@ -1,11 +1,12 @@
 module Pageflow
-  class EntryRoleQuery
-    class Scope
+  class EntryRoleQuery < ApplicationQuery
+    class Scope < Scope
       attr_reader :user, :scope
 
-      def initialize(user, scope)
+      def initialize(user, scope, table_alias_prefix: nil)
         @user = user
         @scope = scope
+        @table_alias_prefix = table_alias_prefix
       end
 
       def with_role_at_least(role)
@@ -15,10 +16,16 @@ module Pageflow
           .where(either_membership_is_present)
       end
 
+      def with_account_role_at_least(role)
+        scope
+          .joins(memberships_for_account_of_entries_with_at_least_role(role))
+          .where(entry_account_membership_is_present)
+      end
+
       private
 
       def memberships_for_entries_with_at_least_role(role)
-        join_memberships(table_alias: 'pageflow_entry_memberships',
+        join_memberships(table_alias: table_alias_for('entry'),
                          user_id: user.id,
                          roles: Roles.at_least(role),
                          entity_id_column: 'pageflow_entries.id',
@@ -26,7 +33,7 @@ module Pageflow
       end
 
       def memberships_for_account_of_entries_with_at_least_role(role)
-        join_memberships(table_alias: 'pageflow_entry_account_memberships',
+        join_memberships(table_alias: table_alias_for('entry_account'),
                          user_id: user.id,
                          roles: Roles.at_least(role),
                          entity_id_column: 'pageflow_entries.account_id',
@@ -47,12 +54,20 @@ module Pageflow
       end
 
       def either_membership_is_present
-        'pageflow_entry_memberships.entity_id IS NOT NULL OR ' \
-        'pageflow_entry_account_memberships.entity_id IS NOT NULL'
+        [entry_membership_is_present,
+         entry_account_membership_is_present].join(' OR ')
+      end
+
+      def entry_membership_is_present
+        "#{table_alias_for(:entry)}.entity_id IS NOT NULL"
+      end
+
+      def entry_account_membership_is_present
+        "#{table_alias_for(:entry_account)}.entity_id IS NOT NULL"
       end
 
-      def sanitize_sql(sql, interpolations)
-        ActiveRecord::Base.send(:sanitize_sql_array, [sql, interpolations])
+      def table_alias_for(type)
+        [@table_alias_prefix, 'pageflow', type, 'memberships'].compact.join('_')
       end
     end
 

data/app/models/pageflow/entry_title_or_account_name_query.rb

@@ -0,0 +1,33 @@
+module Pageflow
+  # @api private
+  class EntryTitleOrAccountNameQuery < ApplicationQuery
+    class Scope < Scope
+      def initialize(term, scope)
+        @term = term
+        @scope = scope
+      end
+
+      def resolve
+        scope
+          .joins(:account)
+          .references(:pageflow_accounts)
+          .where(word_conditions(term))
+      end
+
+      private
+
+      attr_reader :term, :scope
+
+      def word_conditions(term)
+        term.split(' ').map { |word|
+          word_condition(word)
+        }.join(' AND ')
+      end
+
+      def word_condition(word)
+        sanitize_sql('(pageflow_entries.title LIKE :word OR pageflow_accounts.name LIKE :word)',
+                     word: "%#{word}%")
+      end
+    end
+  end
+end

data/app/models/pageflow/file_usage.rb

@@ -1,14 +1,10 @@
 module Pageflow
-  class FileUsage < ActiveRecord::Base
+  class FileUsage < ApplicationRecord
+    include SerializedConfiguration
+
     belongs_to :revision
     belongs_to :file, polymorphic: true
 
-    serialize :configuration, JSON
-
-    def configuration
-      super || {}
-    end
-
     def copy_to(revision)
       revision.file_usages << dup
     end

data/app/models/pageflow/folder.rb

@@ -1,5 +1,5 @@
 module Pageflow
-  class Folder < ActiveRecord::Base
+  class Folder < ApplicationRecord
     belongs_to :account
     has_many :entries
 

data/app/models/pageflow/home_button.rb

@@ -13,7 +13,7 @@ module Pageflow
 
     def enabled?
       revision.home_button_enabled? &&
-        theming.theme.has_home_button? &&
+        revision.theme.has_home_button? &&
         url.present?
     end
 

data/app/models/pageflow/image_file.rb

@@ -1,27 +1,38 @@
 module Pageflow
-  class ImageFile < ActiveRecord::Base
+  class ImageFile < ApplicationRecord
     include ImageFileStateMachine
     include UploadedFile
 
     STYLES = lambda do |attachment|
       panorama_format = File.extname(attachment.original_filename) == '.png' ? :PNG : :JPG
 
-      Pageflow.config.thumbnail_styles
+      Pageflow
+        .config.thumbnail_styles
         .merge(print: ['300x300>', :JPG],
                medium: ['1024x1024>', :JPG],
                large: ['1920x1920>', :JPG],
                ultra: ['3840x3840>', :JPG],
                panorama_medium: ['1024x1024^', panorama_format],
-               panorama_large: ['1920x1080^', panorama_format])
+               panorama_large: ['1920x1080^', panorama_format],
+               panorama_mask: ['1920x1080^', panorama_format])
     end
 
+    SOURCE_FILE_OPTIONS = {
+      # Prevent anti aliasing. Otherwise, when processing color map
+      # images, borders between areas are blurred.
+      panorama_mask: '-filter point'
+    }.freeze
+
+    palette_path = File.expand_path('../../../../lib/pageflow/images/palette.png', __FILE__)
+
     CONVERT_OPTIONS = {
       print: '-quality 10 -interlace Plane',
       medium: '-quality 70 -interlace Plane',
       large: '-quality 70 -interlace Plane',
       ultra: '-quality 90 -interlace Plane',
       panorama_medium: '-quality 70 -interlace Plane',
-      panorama_large: '-quality 70 -interlace Plane'
+      panorama_large: '-quality 70 -interlace Plane',
+      panorama_mask: "-quality 70 -interlace Plane -dither None -colors 64 -remap #{palette_path}"
     }.freeze
 
     has_attached_file(:unprocessed_attachment,
@@ -31,6 +42,7 @@ module Pageflow
                       Pageflow.config.paperclip_s3_default_options
                         .merge(default_url: ':pageflow_placeholder',
                                styles: STYLES,
+                               source_file_options: SOURCE_FILE_OPTIONS,
                                convert_options: CONVERT_OPTIONS))
 
     do_not_validate_attachment_file_type(:unprocessed_attachment)
@@ -72,6 +84,12 @@ module Pageflow
       end
     end
 
+    def panorama_mask_url
+      if processed_attachment.present?
+        attachment.url(:panorama_mask)
+      end
+    end
+
     private
 
     def save_image_dimensions