Module: Plugins::FrontCache::FrontCacheHelper

Included in:
AdminController
Defined in:
app/apps/plugins/front_cache/front_cache_helper.rb

Overview

Camaleon CMS is a content management system

Copyright (C) 2015 by Owen Peredo Diaz
Email: [email protected]
This program is free software: you can redistribute it and/or modify   it under the terms of the GNU Affero General Public License as  published by the Free Software Foundation, either version 3 of the  License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,  but WITHOUT ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the  GNU Affero General Public License (GPLv3) for more details.

Instance Method Summary collapse

Instance Method Details

#front_cache_before_loadObject

expire cache for a page after comment registered or updated


105
106
# File 'app/apps/plugins/front_cache/front_cache_helper.rb', line 105

def front_cache_before_load
end

#front_cache_cleanObject

clear all frontend cache files


121
122
123
# File 'app/apps/plugins/front_cache/front_cache_helper.rb', line 121

def front_cache_clean
  FileUtils.rm_rf(Rails.root.join("tmp", "cache", "pages", current_site.id.to_s)) # clear site pages cache
end

#front_cache_front_after_loadObject


46
47
48
49
50
51
52
53
54
# File 'app/apps/plugins/front_cache/front_cache_helper.rb', line 46

def front_cache_front_after_load
  cache_key = front_cache_get_key
  if @_plugin_do_cache && !flash.keys.present?
    front_cache_create(cache_key, response.body
                   .gsub(/csrf-token" content="(.*?)"/, 'csrf-token" content="{{form_authenticity_token}}"')
                   .gsub(/name="authenticity_token" value="(.*?)"/, 'name="authenticity_token" value="{{form_authenticity_token}}"'))
    Rails.logger.info "============================================== cache saved as: #{cache_key}"
  end
end

#front_cache_front_before_loadObject

save as cache all pages configured on settings of this plugin for public users


12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'app/apps/plugins/front_cache/front_cache_helper.rb', line 12

def front_cache_front_before_load
  if current_site.get_option("refresh_cache") # clear cache every restart server
    front_cache_clean
    current_site.set_option("refresh_cache", false)
  end

  return if signin? || Rails.env == "development" || Rails.env == "test" # avoid cache if current visitor is logged in or development environment
  # return if signin? # avoid cache if current visitor is logged in or development environment

  cache_key = front_cache_get_key
  if !flash.keys.present? && front_cache_exist?(cache_key) # recover cache file
    Rails.logger.info "============================================== readed cache: #{cache_key}"
    render text: front_cache_get(cache_key).gsub("{{form_authenticity_token}}", form_authenticity_token)
    return
  end

  @caches = current_site.get_meta("front_cache_elements")
  @_plugin_do_cache = false
  if @caches[:paths].include?(front_request_key) || (params[:action] == "index" && @caches[:home].present?) # cache paths and home page
    @_plugin_do_cache = true
  elsif params[:action] == "post" && !params[:draft_id].present?
    begin
      post = current_site.the_posts.find_by_slug(params[:slug]).decorate
      if post.can_visit?
        @post = post
        @post_type = post.the_post_type
        @_plugin_do_cache = true if can_cache_page?
      end
    rescue # skip post not found
    end
  end
end

#front_cache_on_active(plugin) ⇒ Object

on install plugin


57
58
59
60
61
62
63
64
# File 'app/apps/plugins/front_cache/front_cache_helper.rb', line 57

def front_cache_on_active(plugin)
  current_site.set_meta("front_cache_elements", {paths: [],
      posts: [],
      post_types: [current_site.post_types.where(slug: "page").first.id],
      skip_posts: [],
      home: true,
      cache_login: true}) unless current_site.get_meta("front_cache_elements", nil).present?
end

#front_cache_on_inactive(plugin) ⇒ Object

on uninstall plugin


67
68
69
# File 'app/apps/plugins/front_cache/front_cache_helper.rb', line 67

def front_cache_on_inactive(plugin)
  # current_site.delete_meta("front_cache_elements")
end

#front_cache_on_render(args) ⇒ Object

cache actions (for logged users)


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'app/apps/plugins/front_cache/front_cache_helper.rb', line 72

def front_cache_on_render(args)
  return nil
  return if args[:options].include?(:skip_cache_action) || !signin? # avoid recursive calling
  if params[:controller] == "frontend"
    do_cache = false
    @caches = current_site.get_meta("front_cache_elements")
    return unless @caches[:cache_login]
    if @caches[:paths].include?(front_request_key) || (params[:action] == "index" && @caches[:home].present?) # cache paths and home page
      do_cache = true
    elsif params[:action] == "post" && !params[:draft_id].present?
      do_cache = true if can_cache_page?
    end

    cache_key = front_cache_get_key("___")
    if do_cache # save or recovery cache
      if args[:context].controller.page_cache_exist?(cache_key) # recover cache file
        args[:options][:skip_cache_action] = true
        args[:options][:text] = File.read(args[:context].controller.page_cache_get(cache_key))
        args[:options].delete(:file)
        return
      end
      Thread.abort_on_exception=true
      Thread.new do
        options = args[:options].dup
        options[:layout] = false
        options[:skip_cache_action] = true
        args[:context].controller.cache_page(args[:context].controller.render_to_string(options), cache_key, false)
      end
    end
  end
end

#front_cache_plugin_options(arg) ⇒ Object


108
109
110
111
# File 'app/apps/plugins/front_cache/front_cache_helper.rb', line 108

def front_cache_plugin_options(arg)
  arg[:links] << link_to(t('plugin.front_cache.settings'), admin_plugins_front_cache_settings_path)
  arg[:links] << link_to(t('plugin.front_cache.clean_cache'), admin_plugins_front_cache_clean_path)
end

#front_cache_post_requestsObject

save as cache all post requests


114
115
116
117
118
# File 'app/apps/plugins/front_cache/front_cache_helper.rb', line 114

def front_cache_post_requests
  if (request.post? || request.patch?)
    front_cache_clean()
  end
end