camaleon_cms_rails6 2.5.0

data/lib/generators/camaleon_cms/gem_plugin_template/app/views/plugins/my_plugin/admin/index.html.erb

@@ -0,0 +1,9 @@
+<%#= javascript_include_tag plugin_asset("my_file.js") %>
+<div class="panel panel-default">
+    <div class="panel-heading">
+        <h4>My Title</h4>
+    </div>
+    <div class="panel-body">
+        <p>Plugin ready to use in admin panel!.</p>
+    </div>
+</div>

data/lib/generators/camaleon_cms/gem_plugin_template/app/views/plugins/my_plugin/admin/settings.html.erb

@@ -0,0 +1,21 @@
+<div class="panel panel-default">
+    <div class="panel-heading">
+        <h4>My Plugin Settings</h4>
+    </div>
+    <div class="panel-body">
+        <%= form_tag(url_for(action: :save_settings), class: 'validate') do %>
+            <div class="form-group">
+                <label>My Option Setting</label>
+                <%= text_field_tag 'options[my_setting]', @plugin.get_option('my_setting'), class: 'form-control required' %>
+            </div>
+            <div class="form-group">
+                <label>My Meta Setting</label>
+                <%= text_field_tag 'metas[my_setting]', @plugin.get_meta('my_setting'), class: 'form-control required' %>
+            </div>
+            <%= render partial: "camaleon_cms/admin/settings/custom_fields/render", locals: {record: @plugin, field_groups: @plugin.get_field_groups} %>
+            <div class="form-group text-right">
+                <%= submit_tag 'Save Settings', class: 'btn btn-primary' %>
+            </div>
+        <% end %>
+    </div>
+</div>

data/lib/generators/camaleon_cms/gem_plugin_template/app/views/plugins/my_plugin/front/index.html.erb

@@ -0,0 +1,2 @@
+<%#= javascript_include_tag plugin_gem_asset("js/my_file.js") %>
+Plugin ready to use! in frontend.

data/lib/generators/camaleon_cms/gem_plugin_template/app/views/plugins/my_plugin/layouts/readme.txt

@@ -0,0 +1,2 @@
+You can create your layouts here.
+To load your custom layout you can use: layout: plugin_layout(<layout_name>) in your controller

data/lib/generators/camaleon_cms/gem_plugin_template/config/camaleon_plugin.json

@@ -0,0 +1,14 @@
+{
+  "title": "pluginTitle",
+  "descr": "",
+  "key": "pluginKey", // must be the name of the folder of your plugin, sample: app/views/plugins/<my_plugin> ==> 'my_plugin'
+  "helpers": [
+    "Plugins::PluginClass::MainHelper"
+  ],
+  "hooks": {
+    "on_active": ["pluginKey_on_active"],
+    "on_inactive": ["pluginKey_on_inactive"],
+    "plugin_options": ["pluginKey_on_plugin_options"]
+    //here you can add all your hooks (read documentation)
+  }
+}

data/lib/generators/camaleon_cms/gem_plugin_template/config/initializers/custom_models.rb

@@ -0,0 +1,5 @@
+#Rails.application.config.to_prepare do
+#   CamaleonCms::Site.class_eval do
+#     has_many :attack, class_name: "Plugins::Attack::Models::Attack"
+#   end
+# end

data/lib/generators/camaleon_cms/install_generator.rb

@@ -0,0 +1,43 @@
+require 'rails/generators/base'
+require 'securerandom'
+module CamaleonCms
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../install_template", __FILE__)
+      desc "This generator create all basic Camaleon CMS structure."
+
+      def create_initializer_file
+        copy_file "system.json", "config/system.json"
+        copy_file "plugin_routes.rb", "lib/plugin_routes.rb"
+        Dir.mkdir Rails.root.join("app", "apps").to_s unless Dir.exist?(Rails.root.join("app", "apps").to_s)
+        directory("apps", "app/apps")
+        directory( File.join($camaleon_engine_dir, 'app/apps/themes').to_s, 'app/apps/themes')
+
+        sprokects_4_or_newer = defined?(Sprockets::BabelProcessor)
+        if sprokects_4_or_newer
+          assets_config_dir = Rails.root.join('app', 'assets', 'config')
+          FileUtils.makedirs(assets_config_dir)
+          assets_config_file = assets_config_dir.join('manifest.js')
+          FileUtils.touch(assets_config_file) unless File.file?(assets_config_file)
+          append_to_file assets_config_file, <<~ASSETS
+  
+                                               // Camaleon CMS assets
+                                               //= link camaleon-cms.js
+                                               //= link_tree ../../apps/themes/camaleon_first/assets
+                                               //= link_tree ../../apps/themes/default/assets
+                                               //= link_tree ../../apps/themes/new/assets
+                                             ASSETS
+          append_to_file Rails.root.join('config', 'initializers', 'assets.rb'),
+            <<~PRECOMPILE_MANIFEST
+  
+              Rails.application.config.assets.precompile += %w( manifest.js )
+            PRECOMPILE_MANIFEST
+        end
+
+        append_to_file 'Gemfile' do
+          "\n\n#################### Camaleon CMS include all gems for plugins and themes #################### \nrequire './lib/plugin_routes' \ninstance_eval(PluginRoutes.draw_gems)"
+        end
+      end
+    end
+  end
+end

data/lib/generators/camaleon_cms/install_template/plugin_routes.rb

@@ -0,0 +1,22 @@
+require 'json'
+class PluginRoutes
+  # draw "all" gems registered for the plugins or themes and camaleon gems
+  def self.draw_gems
+    res = []
+    dirs = [] + Dir["#{apps_dir}/plugins/*"] + Dir["#{apps_dir}/themes/*"]
+
+    dirs.each do |path|
+      next if [".", ".."].include?(path)
+      g = File.join(path, "config", "Gemfile")
+      res << File.read(g) if File.exist?(g)
+    end
+    res.join("\n")
+  end
+
+  # return apps directory path
+  def self.apps_dir
+    dir =  "#{File.dirname(__FILE__)}".split("/")
+    dir.pop
+    dir.join("/")+ '/app/apps'
+  end
+end

data/lib/generators/camaleon_cms/install_template/system.json

@@ -0,0 +1,11 @@
+{
+  "share_sessions": true, // (boolean) share user sessions between subdomains of base_domain (only for users_share_sites = true)
+  "default_user_role": "client", // default user role for all new users
+  "users_share_sites": true, //(boolean) true: permit to share users between sites, false: All users are assigned for a unique site. (Only changed before installation)
+  "db_prefix": "cama_", // prefix name for database tables
+  "relative_url_root": "", // URL prefix, for example to get http://localhost:3000/blog/, this should be "blog"
+  "auto_include_migrations": false, // permit to avoid auto include of all migrations of camaleon cms and its related plugins
+  "hooks": {}
+}
+
+// Note: after any change in this file, you need to restart your server to apply changes.

data/lib/generators/camaleon_cms/theme_generator.rb

@@ -0,0 +1,66 @@
+require 'rails/generators/base'
+require 'securerandom'
+module CamaleonCms
+  module Generators
+    class ThemeGenerator < Rails::Generators::Base
+      source_root File.expand_path("../theme_template", __FILE__)
+      argument :theme_name, :type => :string, :default => "my_theme"
+      desc "This generator create basic theme structure"
+
+      def create_initializer_file
+        theme_folder = Rails.root.join('app', 'apps', 'themes', get_theme_name)
+        if behavior == :revoke
+          if Dir.exist?(theme_folder)
+            FileUtils.rm_rf(theme_folder)
+            puts "Theme destroyed successfully"
+          else
+            puts "This theme doesn't exist"
+          end
+
+        else
+
+          if Dir.exist?(theme_folder)
+            puts "This theme already exist"
+          else
+
+            theme_folder = Rails.root.join('app', 'apps', 'themes', get_theme_name)
+            return puts ("There is already a theme with the same name in: #{theme_folder}") if Dir.exist?(theme_folder)
+
+            # tmp copy
+            FileUtils.mkdir_p(theme_folder)
+            FileUtils.copy_entry(File.join($camaleon_engine_dir, "lib", "generators", "camaleon_cms", 'theme_template'), theme_folder)
+
+            # configuration
+            t = fix_text(File.read(File.join(theme_folder, "config", "config.json")))
+            File.open(File.join(theme_folder, "config", "config.json"), "w"){|f| f << t }
+
+            # helper
+            t = fix_text(File.read(File.join(theme_folder, "main_helper.rb")))
+            File.open(File.join(theme_folder, "main_helper.rb"), "w"){|f|  f << t }
+            puts "Theme successfully created in: #{theme_folder}"
+          end
+        end
+      end
+
+      def fix_text(text = "")
+        text.gsub("themeTitle", get_theme_title).gsub("ThemeClass", get_theme_class).gsub("themeKey", get_theme_name)
+      end
+
+      def self.next_migration_number(dir)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      private
+      def get_theme_name
+        theme_name.underscore.singularize
+      end
+
+      def get_theme_title
+        theme_name.titleize
+      end
+      def get_theme_class
+        get_theme_name.classify
+      end
+    end
+  end
+end

data/lib/generators/camaleon_cms/theme_template/assets/css/main.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require camaleon_cms/bootstrap.min
+ *= require font-awesome
+ */

data/lib/generators/camaleon_cms/theme_template/assets/js/main.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery.js
+//= require camaleon_cms/bootstrap.min.js

data/lib/generators/camaleon_cms/theme_template/config/config.json

@@ -0,0 +1,14 @@
+{
+  "name" : "themeTitle",
+  "description" : "",
+  "thumb" : "images/image.png",
+  "helpers": [
+    "Themes::ThemeClass::MainHelper"
+  ],
+  "hooks": {
+    "on_active": ["themeKey_on_install_theme"],
+    "on_inactive": ["themeKey_on_uninstall_theme"],
+    "on_theme_settings": ["themeKey_settings"]
+    //here all your hooks
+  }
+}

data/lib/generators/camaleon_cms/theme_template/main_helper.rb

@@ -0,0 +1,27 @@
+module Themes::ThemeClass::MainHelper
+  def self.included(klass)
+    # klass.helper_method [:my_helper_method] rescue "" # here your methods accessible from views
+  end
+
+  def themeKey_settings(theme)
+    # callback to save custom values of fields added in my_theme/views/admin/settings.html.erb
+  end
+
+  # callback called after theme installed
+  def themeKey_on_install_theme(theme)
+    # # Sample Custom Field
+    # unless theme.get_field_groups.where(slug: "fields").any?
+    #   group = theme.add_field_group({name: "Main Settings", slug: "fields", description: ""})
+    #   group.add_field({"name"=>"Background color", "slug"=>"bg_color"},{field_key: "colorpicker"})
+    #   group.add_field({"name"=>"Links color", "slug"=>"links_color"},{field_key: "colorpicker"})
+    #   group.add_field({"name"=>"Background image", "slug"=>"bg"},{field_key: "image"})
+    # end
+
+    # # Sample Meta Value
+    # theme.set_meta("installed_at", Time.current.to_s) # save a custom value
+  end
+
+  # callback executed after theme uninstalled
+  def themeKey_on_uninstall_theme(theme)
+  end
+end

data/lib/generators/camaleon_cms/theme_template/views/admin/settings.html.erb

@@ -0,0 +1,2 @@
+<!-- This page is viewed on admin->settings->site settings->tab theme -->
+<!-- You can add your custom html contents here, but don't forget to save the values with hook on_theme_settings -->

data/lib/generators/camaleon_cms/theme_template/views/index.html.erb

@@ -0,0 +1 @@
+<h1>Hello Camaleon CMS</h1>

data/lib/generators/camaleon_cms/theme_template/views/layouts/index.html.erb

@@ -0,0 +1,69 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <!-- META SECTION -->
+    <title><%= current_site.the_title %></title>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <!-- END META SECTION -->
+
+    <%= stylesheet_link_tag theme_asset_path("css/main") %>
+    <%= javascript_include_tag theme_asset_path("js/main.js") %>
+    <%= raw the_head %>
+</head>
+<body>
+
+    <!-- container -->
+    <div class="container">
+        <!-- header -->
+        <div class="navbar navbar-primary">
+            <div class="navbar-header">
+                <a id="logo" class="navbar-brand" href="<%= current_site.the_url %>"><%= image_tag current_site.the_logo, class: "img-responsive" %></a>
+                <button data-target="#navbar-main" data-toggle="collapse" type="button" class="navbar-toggle">
+                    <span class="icon-bar"></span>
+                    <span class="icon-bar"></span>
+                    <span class="icon-bar"></span>
+                </button>
+            </div>
+            <div id="navbar-main" class="navbar-collapse collapse">
+                <%= raw get_nav_menu('main_menu', 'nav navbar-nav ') %>
+
+                <ul class="nav navbar-nav navbar-right">
+                    <% if signin?  %>
+                        <li class="dropdown">
+                            <a class="dropdown-toggle" data-toggle="dropdown" href="#"><img src="<%= cama_current_user.decorate.the_avatar %>" style="max-width: 24px; border-radius: 50%" alt=""/> <%= cama_current_user.username %></a>
+                            <ul class="dropdown-menu">
+                                <li><a href="<%= cama_admin_dashboard_path %>">Dashboard</a></li>
+                                <li><a href="<%= cama_admin_profile_path %>">Profile</a></li>
+                                <li><a href="<%= cama_admin_logout_path %>">Logout</a></li>
+                            </ul>
+                        </li>
+                    <% else %>
+                        <li class="dropdown">
+                            <a id="login-user" class="dropdown-toggle" data-toggle="dropdown" href="#">Login / Register</a>
+                            <ul class="dropdown-menu">
+                                <li><a href="<%= cama_admin_login_path %>">Login</a></li>
+                                <li><a href="<%= cama_admin_register_path %>">Register</a></li>
+                            </ul>
+                        </li>
+                    <% end %>
+                </ul>
+                <%= raw current_site.draw_languages("language list-inline pull-right", true) %>
+            </div>
+        </div>
+        <!-- ./header -->
+
+        <div class="content">
+            <%= yield %>
+        </div>
+
+        <!-- footer -->
+        <footer>
+
+        </footer>
+        <!-- ./footer -->
+    </div>
+    <!-- ./container -->
+</body>
+</html>

data/lib/generators/camaleon_cms/theme_template/views/partials/readme.txt

@@ -0,0 +1 @@
+here all your partials

data/lib/plugin_routes.rb

@@ -0,0 +1,439 @@
+require 'json'
+class PluginRoutes
+  @@_vars = []
+  @@_after_reload = []
+  @@anonymous_hooks = {}
+  # load plugin routes if it is enabled
+  def self.load(env = "admin")
+    plugins = all_enabled_plugins
+    res = ""
+    if env == "front"
+      res << "namespace :plugins do \n"
+      plugins.each do |plugin|
+        res << "namespace '#{plugin["key"]}' do \n"
+        res << "#{File.open(File.join(plugin["path"], "config", "routes_#{env}.txt")).read}\n" rescue ""
+        res << "end\n"
+      end
+      res << "end\n"
+
+    elsif env == "admin" # admin
+      res << "scope 'admin', as: 'admin' do \n"
+      res << "namespace :plugins do \n"
+      plugins.each do |plugin|
+        res << "namespace '#{plugin["key"]}' do \n"
+        res << "#{File.open(File.join(plugin["path"], "config", "routes_#{env}.txt")).read}\n" rescue ""
+        res << "end\n"
+      end
+      res << "end\n"
+      res << "end\n"
+    else # main
+      plugins.each do |plugin|
+        res << "#{File.open(File.join(plugin["path"], "config", "routes_#{env}.txt")).read}\n" rescue ""
+      end
+    end
+    res + load_themes(env)
+  end
+
+  def self.load_themes(env = "admin")
+    plugins = all_enabled_themes
+    res = ""
+    if env == "front"
+      res << "namespace :themes do \n"
+      plugins.each do |plugin|
+        res << "namespace '#{plugin["key"]}' do \n"
+        res << "#{File.open(File.join(plugin["path"], "config", "routes_#{env}.txt")).read}\n" rescue ""
+        res << "end\n"
+      end
+      res << "end\n"
+
+    elsif env == "admin" # admin
+      res << "scope 'admin', as: 'admin' do \n"
+      res << "namespace :themes do \n"
+      plugins.each do |plugin|
+        res << "namespace '#{plugin["key"]}' do \n"
+        res << "#{File.open(File.join(plugin["path"], "config", "routes_#{env}.txt")).read}\n" rescue ""
+        res << "end\n"
+      end
+      res << "end\n"
+      res << "end\n"
+    else # main
+      plugins.each do |plugin|
+        res << "#{File.open(File.join(plugin["path"], "config", "routes_#{env}.txt")).read}\n" rescue ""
+      end
+    end
+    res
+  end
+
+  class << self
+    # return plugin information
+    def plugin_info(plugin_key)
+      self.all_plugins.each{|p| return p if p["key"] == plugin_key || p['path'].split('/').last == plugin_key }
+      nil
+    end
+
+    # return theme information
+    # if theme_name is nil, the use current site theme
+    def theme_info(theme_name)
+      self.all_themes.each{|p| return p if p["key"] == theme_name }
+      nil
+    end
+
+    # return system static settings (config.json values)
+    def static_system_info
+      r = cache_variable("statis_system_info");  return r unless r.nil?
+      settings = {}
+
+      gem_settings = File.join($camaleon_engine_dir, "config", "system.json")
+      app_settings = Rails.root.join("config", "system.json")
+
+      settings = settings.merge(JSON.parse(File.read(gem_settings))) if File.exist?(gem_settings)
+      settings = settings.merge(JSON.parse(File.read(app_settings))) if File.exist?(app_settings)
+
+      # custom settings
+      settings["key"] = "system"
+      settings["path"] = ''
+      settings["kind"] = "system"
+      settings["hooks"]["on_notification"] ||= []
+      cache_variable("statis_system_info", settings)
+    end
+    alias_method :system_info, :static_system_info
+
+    def isRails4?
+      Rails.version.to_s[0].to_i == 4
+    end
+
+    def isRails5?
+      Rails.version.to_s[0].to_i == 5
+    end
+
+    def isRails6?
+      Rails.version.to_s[0].to_i == 6
+    end
+
+    # convert action parameter into hash
+    def fixActionParameter(h)
+      (h.is_a?(ActionController::Parameters) ? (h.permit!.to_h rescue h.to_hash) : h)
+    end
+
+    # add a new anonymous hook
+    # sample: PluginRoutes.add_anonymous_hook('before_admin', lambda{|params| puts params })
+    # @param hook_key [String], key of hook
+    # @param hook_id [String], identifier for the anonymous hook
+    # @param callback [Lambda], anonymous function to be called when the hook was called
+    # @return nil
+    def add_anonymous_hook(hook_key, callback, hook_id = '')
+      @@anonymous_hooks[hook_key] ||= []
+      @@anonymous_hooks[hook_key] << {id: hook_id, callback: callback}
+    end
+
+    # return all registered anonymous hooks for hook_key
+    # @param hook_key [String] name of the hook
+    # @return [Array] array of hooks for hook_key
+    def get_anonymous_hooks(hook_key)
+      (@@anonymous_hooks[hook_key.to_s] || []).map{|item| item[:callback] }
+    end
+
+    # return all registered anonymous hooks for hook_key
+    # @param hook_key [String] name of the hook
+    # @param hook_id [String] identifier of the anonymous hooks
+    # @return [Array] array of hooks for hook_key
+    def remove_anonymous_hook(hook_key, hook_id)
+      (@@anonymous_hooks[hook_key.to_s] || []).delete_if{|item| item[:id] == hook_id }
+    end
+
+    # return the class name for user model
+    def get_user_class_name
+      static_system_info['user_model'].presence || 'CamaleonCms::User'
+    end
+  end
+
+  # reload routes
+  def self.reload
+    @@all_sites = nil
+    @@_vars.each { |v| class_variable_set("@@cache_#{v}", nil) }
+    Rails.application.reload_routes!
+    @@_after_reload.uniq.each{|r| eval(r) }
+  end
+
+  # permit to add extra actions for reload routes
+  def self.add_after_reload_routes(command)
+    @@_after_reload << command
+  end
+
+  # return all enabled plugins []
+  def self.enabled_plugins(site)
+    r = cache_variable("enable_plugins_site_#{site.id}")
+    return r unless r.nil?
+    res = []
+    enabled_ps = site.plugins.active.pluck(:slug)
+    all_plugins.each do |plugin|
+      res << plugin if enabled_ps.include?(plugin["key"])
+    end
+    res = res.sort_by{|e| e["position"] || 10 }
+    cache_variable("enable_plugins_site_#{site.id}", res)
+  end
+
+  # return all enabled apps for site (themes + system + plugins) []
+  # theme_slug: current theme slug
+  def self.enabled_apps(site, theme_slug = nil)
+    theme_slug = theme_slug || site.get_theme_slug
+    r = cache_variable("enabled_apps_#{site.id}_#{theme_slug}")
+    return r unless r.nil?
+    res = [system_info] + enabled_plugins(site) + [theme_info(theme_slug)]
+    cache_variable("enabled_apps_#{site.id}_#{theme_slug}", res)
+  end
+
+  # return all enabled apps as []: system, themes, plugins
+  def self.all_enabled_apps
+    [system_info] + all_enabled_themes + all_enabled_plugins
+  end
+
+  # return all enabled themes (a theme is enabled if at least one site is assigned)
+  def self.all_enabled_themes
+    r = cache_variable("all_enabled_themes"); return r unless r.nil?
+    res = []
+    get_sites.each do |site|
+      i = theme_info(site.get_theme_slug)
+      res << i if i.present?
+    end
+    cache_variable("all_enabled_themes", res)
+  end
+
+  # return all enabled plugins (a theme is enabled if at least one site has installed)
+  def self.all_enabled_plugins
+    r = cache_variable("all_enabled_plugins")
+    return r unless r.nil?
+    res, enabled_ps = [], []
+    get_sites.each { |site|  enabled_ps += site.plugins.active.pluck(:slug) }
+    all_plugins.each do |plugin|
+      if enabled_ps.include?(plugin["key"])
+        res << plugin
+      end
+    end
+    cache_variable("all_enabled_plugins", res)
+  end
+
+  # all helpers of enabled plugins for site
+  def self.site_plugin_helpers(site)
+    r = cache_variable("site_plugin_helpers"); return r unless r.nil?
+    res = []
+    enabled_apps(site).each do |settings|
+      res += settings["helpers"] if settings["helpers"].present?
+    end
+    cache_variable("site_plugin_helpers", res)
+  end
+
+  # all helpers of enabled plugins
+  def self.all_helpers
+    r = cache_variable("plugins_helper")
+    return r unless r.nil?
+    res = []
+    all_apps.each do |settings|
+      res += settings["helpers"] if settings["helpers"].present?
+    end
+    cache_variable("plugins_helper", res.uniq)
+  end
+
+  # destroy plugin
+  def self.destroy_plugin(plugin_key)
+    FileUtils.rm_r(Rails.root.join("app", "apps", "plugins", plugin_key)) rescue ""
+    PluginRoutes.reload
+  end
+
+  def self.cache_variable(var_name, value=nil)
+    @@_vars.push(var_name).uniq!
+    #if Rails.env != "development" # disable cache plugin routes for develoment mode
+      cache = class_variable_get("@@cache_#{var_name}") rescue nil
+      return cache if value.nil?
+    #end
+    class_variable_set("@@cache_#{var_name}", value)
+    value
+  end
+
+  # return all sites registered for Plugin routes
+  def self.get_sites
+    begin
+      @@all_sites ||= CamaleonCms::Site.order(id: :asc).all.to_a
+    rescue
+      []
+    end
+  end
+
+  # check if db migrate already done
+  def self.db_installed?
+    @@is_db_installed ||= ActiveRecord::Base.connection.table_exists?(CamaleonCms::Site.table_name)
+  end
+
+  # return all locales for all sites joined by |
+  def self.all_locales
+    r = cache_variable("site_all_locales"); return r unless r.nil?
+    res = []
+    get_sites.each do |s|
+      res += s.get_languages
+    end
+    cache_variable("site_all_locales", res.uniq.join("|"))
+  end
+
+  # return all translations for all languages, sample: ['Sample', 'Ejemplo', '....']
+  def self.all_translations(key, *args)
+    args = args.extract_options!
+    all_locales.split('|').map{|_l| I18n.t(key, args.merge({locale: _l})) }.uniq
+  end
+
+  # return all locales for translated routes
+  def self.all_locales_for_routes
+    r = cache_variable("all_locales_for_routes"); return r unless r.nil?
+    res = {}
+    all_locales.split("|").each do |l|
+      res[l] = "_#{l}"
+    end
+    res[false] = ''
+    cache_variable("all_locales_for_routes", res)
+  end
+
+  # return apps directory path
+  def self.apps_dir
+    Rails.root.join("app", "apps").to_s
+  end
+
+  # return all plugins located in cms and in this project
+  def self.all_plugins
+    camaleon_gem = get_gem('camaleon_cms')
+    return [] if !camaleon_gem
+    r = cache_variable("all_plugins"); return r unless (r.nil? || r == [])
+    res = get_gem_plugins
+    entries = [".", ".."]
+    res.each{|plugin| entries << plugin["key"] }
+    (Dir["#{apps_dir}/plugins/*"] + Dir["#{camaleon_gem.gem_dir}/app/apps/plugins/*"]).each do |path|
+      entry = path.split("/").last
+      config = File.join(path, "config", "config.json")
+      next if entries.include?(entry) || !File.directory?(path) || !File.exist?(config)
+      p = JSON.parse(File.read(config))
+      p = p.with_indifferent_access rescue p
+      p["key"] = entry
+      p["path"] = path
+      p["kind"] = "plugin"
+      res << p
+      entries << entry
+    end
+    cache_variable("all_plugins", res)
+  end
+
+  # return an array of all themes installed for all sites
+  def self.all_themes
+    camaleon_gem = get_gem('camaleon_cms')
+    return [] if !camaleon_gem
+    r = cache_variable("all_themes"); return r unless (r.nil? || r == [])
+    res = get_gem_themes
+    entries = [".", ".."]
+    res.each{|theme| entries << theme["key"] }
+    (Dir["#{apps_dir}/themes/*"] + Dir["#{camaleon_gem.gem_dir}/app/apps/themes/*"]).each do |path|
+      entry = path.split("/").last
+      config = File.join(path, "config", "config.json")
+      next if entries.include?(entry) || !File.directory?(path) || !File.exist?(config)
+      p = JSON.parse(File.read(config))
+      p = p.with_indifferent_access rescue p
+      p["key"] = entry
+      p["path"] = path
+      p["kind"] = "theme"
+      p["title"] = p["name"]
+      res << p
+      entries << entry
+    end
+    cache_variable("all_themes", res)
+  end
+
+  # return all apps loaded
+  def self.all_apps
+    all_plugins+all_themes
+  end
+
+  # return all plugins registered as gems
+  def self.get_gem_plugins
+    entries = []
+    Gem::Specification.each do |gem|
+      path = gem.gem_dir
+      config = File.join(path, "config", "camaleon_plugin.json")
+      if File.exist?(config)
+        p = JSON.parse(File.read(config))
+        p = p.with_indifferent_access rescue p
+        p["key"] = gem.name if p["key"].nil? # TODO REVIEW ERROR FOR conflict plugin keys
+        p["version"] = gem.version.to_s
+        p["path"] = path
+        p["kind"] = "plugin"
+        p["descr"] = gem.description unless p["descr"].present?
+        p["gem_mode"] = true
+        entries << p
+      end
+    end
+    entries
+  end
+
+  # return all themes registered as gems
+  def self.get_gem_themes
+    entries = []
+    Gem::Specification.each do |gem|
+      path = gem.gem_dir
+      config = File.join(path, "config", "camaleon_theme.json")
+      if File.exist?(config)
+        p = JSON.parse(File.read(config))
+        p = p.with_indifferent_access rescue p
+        p["key"] = gem.name if p["key"].nil? # TODO REVIEW ERROR FOR conflict plugin keys
+        p["path"] = path
+        p["kind"] = "theme"
+        p["gem_mode"] = true
+        entries << p
+      end
+    end
+    entries
+  end
+
+  # check if a gem is available or not
+  # Arguemnts:
+  # name: name of the gem
+  # return (Boolean) true/false
+  def self.get_gem(name)
+    Gem::Specification.find_by_name(name)
+  rescue Gem::LoadError
+    false
+  rescue
+    Gem.available?(name)
+  end
+
+  # return the default url options for Camaleon CMS
+  def self.default_url_options
+    options = { host: (CamaleonCms::Site.main_site.slug rescue "") }
+    options.merge!({ protocol: 'https' }) if Rails.application.config.force_ssl
+    options
+  end
+
+  def self.migration_class
+    isRails4? ? ActiveRecord::Migration : ActiveRecord::Migration[4.2]
+  end
+end
+CamaManager = PluginRoutes
+
+#********* fix missing helper method for breadcrumb on rails gem **********#
+if PluginRoutes.isRails5?
+  module BreadcrumbsOnRails
+    module ActionController extend ActiveSupport::Concern
+      def self.included(base = nil, &block)
+        if base.nil?
+          @_included_block = block
+        else
+          super
+        end
+      end
+
+      included do |base|
+        extend          ClassMethods
+        helper          HelperMethods if respond_to? :helper
+        helper_method   :add_breadcrumb, :breadcrumbs  if respond_to? :helper_method
+
+        unless base.respond_to?(:before_action)
+          base.alias_method :before_action, :before_filter
+        end
+      end
+    end
+  end
+end