pages_core 3.6.0 → 3.8.0

data/app/controllers/concerns/pages_core/authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module Authentication
     extend ActiveSupport::Concern
@@ -17,29 +19,35 @@ module PagesCore
     end
 
     def authenticate!(user)
-      user.mark_active!
-      @current_user = user
+      reset_session
+      authenticated(user)
     end
 
     def deauthenticate!
       @current_user = nil
-      session[:current_user_id] = nil
+      reset_session
     end
 
     protected
 
+    def authenticated(user)
+      user.mark_active!
+      @current_user = user
+    end
+
     def start_authenticated_session
       if session[:current_user_id]
         user = User.where(id: session[:current_user_id]).first
       end
 
-      return unless user && user.can_login?
+      return unless user&.can_login?
 
-      authenticate!(user)
+      authenticated(user)
     end
 
     def finalize_authenticated_session
       return unless current_user
+
       session[:current_user_id] = current_user.id
     end
   end

data/app/controllers/concerns/pages_core/error_renderer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module ErrorRenderer
     extend ActiveSupport::Concern
@@ -23,6 +25,7 @@ module PagesCore
 
     def error_layout(error, options = {})
       return options[:layout] if options.key?(:layout)
+
       if error == 404 && PagesCore.config.error_404_layout?
         PagesCore.config.error_404_layout
       else

data/app/controllers/concerns/pages_core/error_reporting.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module PagesCore
+  module ErrorReporting
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :configure_sentry_context
+    end
+
+    protected
+
+    def configure_sentry_context
+      if Object.const_defined?("Sentry")
+        Sentry.set_user(current_user_context)
+        Sentry.set_tags(locale: params[:locale] || I18n.default_locale.to_s)
+        Sentry.set_extras(params: params.to_unsafe_h)
+      elsif Object.const_defined?("Raven")
+        configure_legacy_sentry_context
+      end
+    end
+
+    def configure_legacy_sentry_context
+      Raven.user_context(current_user_context)
+      Raven.tags_context(locale: params[:locale] || I18n.default_locale.to_s)
+      Raven.extra_context(params: params.to_unsafe_h)
+    end
+
+    def current_user_context
+      return { user_id: :guest } unless logged_in?
+
+      { user_id: current_user.id,
+        user_email: current_user.email }
+    end
+  end
+end

data/app/controllers/concerns/pages_core/policies_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module PoliciesHelper
     extend ActiveSupport::Concern
@@ -33,7 +35,8 @@ module PagesCore
     end
 
     def verify_policy(record)
-      return true if policy(record).public_send(action_name + "?")
+      return true if policy(record).public_send("#{action_name}?")
+
       raise PagesCore::NotAuthorized
     end
   end

data/app/controllers/concerns/pages_core/preview_pages_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module PreviewPagesController
     extend ActiveSupport::Concern
@@ -8,6 +10,8 @@ module PagesCore
 
     def preview
       redirect_to(page_url(@locale, @page)) && return unless logged_in?
+
+      @preview = true
       @page.attributes = page_params.merge(
         status: 2,
         published_at: Time.zone.now,
@@ -17,6 +21,10 @@ module PagesCore
       render_page
     end
 
+    def preview?
+      @preview || false
+    end
+
     private
 
     def disable_xss_protection

data/app/controllers/concerns/pages_core/process_titler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module ProcessTitler
     extend ActiveSupport::Concern

data/app/controllers/concerns/pages_core/rss_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module RssController
     extend ActiveSupport::Concern

data/app/controllers/concerns/pages_core/static_cache_controller.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module PagesCore
+  module StaticCacheController
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def static_cache(*actions, permanent: false)
+        return unless perform_caching
+
+        if permanent
+          after_action :cache_static_page_permanently, only: actions
+        else
+          after_action :cache_static_page, only: actions
+        end
+      end
+
+      alias caches_page static_cache
+    end
+
+    def disable_static_cache!
+      @static_cache_disabled = true
+    end
+
+    private
+
+    def cache_static_page
+      return unless static_cache_allowed?
+
+      PagesCore::StaticCache.handler.cache_page(
+        self, request, response
+      )
+    end
+
+    def cache_static_page_permanently
+      return unless static_cache_allowed?
+
+      PagesCore::StaticCache.handler.cache_page_permanently(
+        self, request, response
+      )
+    end
+
+    def static_cache_allowed?
+      (request.get? || request.head?) && response.status == 200 &&
+        perform_caching && !@static_cache_disabled
+    end
+  end
+end

data/app/controllers/errors_controller.rb

@@ -1,13 +1,8 @@
+# frozen_string_literal: true
+
 class ErrorsController < ::ApplicationController
   layout "errors"
 
-  def report
-    report = decrypt_report(params[:error_report])
-    report[:user] = User.find_by(id: report[:user_id]) if report.key?(:user_id)
-
-    deliver_error_report(report, params[:email], params[:description])
-  end
-
   def show
     render_error params[:id].to_i
   end
@@ -30,54 +25,11 @@ class ErrorsController < ::ApplicationController
 
   def internal_error
     exception = request.env["action_dispatch.exception"]
-    if !exception
-      render_error 500
-    elsif exception.is_a?(PagesCore::NotAuthorized)
-      render_error 403
-    else
-      @report = encrypt_report(error_report(request, exception))
+    if exception
       wrapper = ActionDispatch::ExceptionWrapper.new(nil, exception)
       render_error wrapper.status_code
+    else
+      render_error 500
     end
   end
-
-  private
-
-  def deliver_error_report(report, from, description)
-    AdminMailer.error_report(report, from, description).deliver_now
-  end
-
-  def decrypt_report(str)
-    YAML.safe_load(report_encryptor.decrypt_and_verify(str))
-  end
-
-  def encrypt_report(report)
-    report_encryptor.encrypt_and_sign(report.to_yaml)
-  end
-
-  def error_report(request, exception)
-    { message:   exception.to_s,
-      url:       request.original_url,
-      env:       request.env.select { |_, v| v.is_a?(String) },
-      params:    params.to_unsafe_h,
-      session:   session.to_hash,
-      backtrace: exception_backtrace(exception),
-      timestamp: Time.now.utc,
-      user_id:   current_user.try(&:id) }
-  end
-
-  def exception_backtrace(exception)
-    Rails.backtrace_cleaner.send(:filter, exception.backtrace)
-  end
-
-  def report_encryptor
-    ActiveSupport::MessageEncryptor.new(
-      ActiveSupport::CachingKeyGenerator.new(
-        ActiveSupport::KeyGenerator.new(
-          Rails.application.secrets.secret_key_base,
-          iterations: 1000
-        )
-      ).generate_key("encrypted error report")
-    )
-  end
 end

data/app/controllers/pages_core/admin_controller.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 # All admin controllers inherit Admin::AdminController, which provides layout,
 # authorization and other common code for the Admin set of controllers.
 module PagesCore
   class AdminController < ::ApplicationController
+    include PagesCore::Admin::PersistentParams
+
     protect_from_forgery with: :exception
 
     before_action :set_i18n_locale
     before_action :require_authentication
-    before_action :restore_persistent_params
-    after_action :save_persistent_params
 
     layout "admin"
 
@@ -36,29 +38,14 @@ module PagesCore
     # If not, renders the login screen.
     def require_authentication
       return if logged_in?
+
       if User.count < 1
-        redirect_to(new_admin_user_url) && return
+        redirect_to(new_admin_user_url)
       else
-        redirect_to(login_admin_users_url) && return
+        redirect_to(login_admin_users_url)
       end
     end
 
-    # Loads persistent params from user model and merges with session.
-    def restore_persistent_params
-      return unless current_user && current_user.persistent_data?
-      session[:persistent_params] ||= {}
-      session[:persistent_params] = current_user.persistent_data.merge(
-        session[:persistent_params]
-      )
-    end
-
-    # Saves persistent params from session to User model if applicable.
-    def save_persistent_params
-      return unless current_user && session[:persistent_params]
-      current_user.persistent_data = session[:persistent_params]
-      current_user.save
-    end
-
     def secure_compare(compare, other)
       return false unless compare && other
       return false unless compare.bytesize == other.bytesize
@@ -69,52 +56,5 @@ module PagesCore
       other.each_byte { |byte| res |= byte ^ l.shift }
       res.zero?
     end
-
-    # --- HELPERS ---
-
-    # Add a stylesheet
-    def add_stylesheet(css_file)
-      @admin_stylesheets ||= []
-      @admin_stylesheets << "admin/#{css_file}"
-    end
-
-    def persistent_params(namespace)
-      session[:persistent_params] ||= {}
-      session[:persistent_params][namespace] ||= {}
-      session[:persistent_params][namespace]
-    end
-
-    def coerce_persistent_param(value)
-      case value
-      when "true"
-        true
-      when "false"
-        false
-      else
-        value
-      end
-    end
-
-    # Get a persistent param
-    def persistent_param(key, default = nil, options = {})
-      key = key.to_s
-      namespace = options[:namespace] || self.class.to_s
-
-      value = coerce_persistent_param(
-        if params.key?(key)
-          params[key]
-        elsif persistent_params(namespace).key?(key)
-          persistent_params(namespace)[key]
-        else
-          default
-        end
-      )
-
-      if !value.nil? || options[:preserve_nil]
-        persistent_params(namespace)[key.to_s] = value
-      end
-
-      value
-    end
   end
 end

data/app/controllers/pages_core/attachments_controller.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module PagesCore
   class AttachmentsController < ::ApplicationController
     before_action :verify_signed_params
     before_action :find_attachment, only: %i[show download]
 
-    caches_page :show
+    static_cache :show, permanent: true
 
     def show
       send_attachment
@@ -20,12 +22,14 @@ module PagesCore
     end
 
     def send_attachment(disposition: "inline")
-      if stale?(etag: @attachment, last_modified: @attachment.updated_at)
-        send_data(@attachment.data,
-                  filename: @attachment.filename,
-                  type: @attachment.content_type,
-                  disposition: disposition)
+      unless stale?(etag: @attachment, last_modified: @attachment.updated_at)
+        return
       end
+
+      send_data(@attachment.data,
+                filename: @attachment.filename,
+                type: @attachment.content_type,
+                disposition: disposition)
     end
 
     def verify_signed_params

data/app/controllers/pages_core/base_controller.rb

@@ -1,41 +1,35 @@
+# frozen_string_literal: true
+
 module PagesCore
   class BaseController < ActionController::Base
     include PagesCore::Authentication
-    include PagesCore::DomainBasedCache
     include PagesCore::ErrorRenderer
+    include PagesCore::ErrorReporting
     include PagesCore::ProcessTitler
     include PagesCore::PoliciesHelper
+    include PagesCore::StaticCacheController
 
-    before_action :set_locale, :configure_error_reporting
+    before_action :set_locale
     after_action :set_content_language_header
 
     protected
 
-    # Configures additional report data if Sentry is installed
-    def configure_error_reporting
-      return unless Object.const_defined?("Raven")
-      if logged_in?
-        Raven.user_context(user_id: current_user.id,
-                           user_email: current_user.email)
-      else
-        Raven.user_context({})
-      end
-      Raven.tags_context(locale: locale)
-      Raven.extra_context(params: params.to_unsafe_h)
+    def append_info_to_payload(payload)
+      super
+      payload[:remote_ip] = request.remote_ip
+      payload.merge!(current_user_context)
     end
 
     # Sets @locale from params[:locale], with I18n.default_locale as fallback
     def set_locale
-      legacy_locales = {
-        "nor" => "nb",
-        "eng" => "en"
-      }
+      legacy_locales = { "nor" => "nb", "eng" => "en" }
       @locale = params[:locale] || I18n.default_locale.to_s
       @locale = legacy_locales[@locale] if legacy_locales[@locale]
     end
 
     def set_content_language_header
       return unless locale
+
       headers["Content-Language"] = locale.to_s
     end
   end

data/app/controllers/pages_core/frontend/page_files_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module Frontend
     class PageFilesController < ::FrontendController
@@ -6,9 +8,11 @@ module PagesCore
       before_action :find_page_file, only: %i[show]
 
       def show
-        if stale?(etag: @page_file, last_modified: @page_file.updated_at)
-          redirect_to attachment_path(@page_file.attachment)
+        unless stale?(etag: @page_file, last_modified: @page_file.updated_at)
+          return
         end
+
+        redirect_to attachment_path(@page_file.attachment)
       end
 
       private

data/app/controllers/pages_core/frontend/pages_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module Frontend
     class PagesController < ::FrontendController
@@ -8,14 +10,12 @@ module PagesCore
       include PagesCore::PreviewPagesController
       include PagesCore::RssController
 
-      caches_page :index if PagesCore.config(:page_cache)
-
       before_action :load_root_pages
       before_action :find_page_by_path, only: [:show]
       before_action :find_page, only: %i[show preview]
       before_action :require_page, only: %i[show preview]
       before_action :canonicalize_url, only: [:show]
-      after_action :cache_page_request, only: [:show]
+      static_cache :index, :show
 
       def index
         respond_to do |format|
@@ -27,8 +27,11 @@ module PagesCore
       def show
         respond_to do |format|
           format.html { render_published_page(@page) }
-          format.rss { render_rss(@page.pages.limit(20), title: @page.name) }
-          format.json { render json: @page }
+          format.json { render json: PageResource.new(@page) }
+          format.rss do
+            render_rss(@page.pages.limit(20).includes(:image, :author),
+                       title: @page.name)
+          end
         end
       end
 
@@ -47,6 +50,7 @@ module PagesCore
         return if request.path == canonical_path(@page)
         # Don't canonicalize if any unknown params are present
         return if (params.keys - %w[controller action path locale id]).any?
+
         redirect_to(canonical_path(@page), status: :moved_permanently)
       end
 
@@ -78,23 +82,13 @@ module PagesCore
         template = page_template(@page)
         run_template_actions_for(template, @page)
         return if @already_rendered
-        render template: "pages/templates/#{template}"
-      end
 
-      # Cache pages by hand. This is dirty, but it works.
-      def cache_page_request
-        status_code = response.status.try(&:to_i)
-        unless status_code == 200 &&
-               PagesCore.config(:page_cache) &&
-               @page && @locale
-          return
-        end
-
-        self.class.cache_page response.body, request.path
+        render template: "pages/templates/#{template}"
       end
 
       def find_page_by_path
         return unless params[:path]
+
         @page = PagePath.get(locale, params[:path]).try(&:page)
       end
 
@@ -104,7 +98,7 @@ module PagesCore
       end
 
       def render_published_page(page)
-        if page && page.published?
+        if page&.published?
           @page = page
           render_page
         else
@@ -114,11 +108,13 @@ module PagesCore
 
       def redirect_page(page)
         return false unless page.redirects?
+
         redirect_to(page.redirect_path(locale: locale))
       end
 
       def require_page
         return if @page
+
         render_error 404
       end
     end

data/app/controllers/pages_core/frontend_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Abstract controller for all frontend controllers.
 module PagesCore
   class FrontendController < ::ApplicationController
@@ -32,6 +34,7 @@ module PagesCore
       I18n.locale = locale_param
     rescue I18n::InvalidLocale
       raise if Rails.application.config.consider_all_requests_local
+
       render_error 404
     end
   end

data/app/controllers/pages_core/images_controller.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module PagesCore
   class ImagesController < ::ApplicationController
     include DynamicImage::Controller
 
-    caches_page :show, :uncropped, :original
+    static_cache :show, :uncropped, :original, permanent: true
 
     private
 

data/app/controllers/pages_core/sitemaps_controller.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module PagesCore
   class SitemapsController < ::ApplicationController
     include PagesCore::PagePathHelper
-    caches_page :show
+    static_cache :show
 
     def show
       @entries = formatted_entries
@@ -42,13 +44,13 @@ module PagesCore
 
     def pages
       ([Page.root.try(:localize, I18n.default_locale)] +
-        locales.flat_map do |locale|
-          Page.published.localized(locale)
-        end).compact.uniq
+       locales.flat_map do |locale|
+         Page.published.localized(locale).includes(:parent)
+       end).compact.uniq
     end
 
     def page_record_url(record)
-      if record == Page.root && record.locale == I18n.default_locale
+      if record == root_page && record.locale == I18n.default_locale
         root_url
       else
         page_url(record.locale, record)
@@ -68,5 +70,9 @@ module PagesCore
     def records
       pages
     end
+
+    def root_page
+      @root_page ||= Page.root
+    end
   end
 end

data/app/controllers/sessions_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SessionsController < ::ApplicationController
   def create
     user = find_user(params[:username], params[:password])
@@ -7,7 +9,7 @@ class SessionsController < ::ApplicationController
       redirect_to admin_default_url
     else
       flash[:notice] = "The provided email address and password combination " \
-        "was not valid"
+                       "was not valid"
       redirect_to login_admin_users_url
     end
   end