camaleon_cms_rails6 2.5.0

data/app/helpers/camaleon_cms/frontend/seo_helper.rb

@@ -0,0 +1,86 @@
+module CamaleonCms::Frontend::SeoHelper
+  # add seo attributes to your page
+  # you can pass custom data to overwrite default data generated by the system
+  # return hash of seo attributes used by the_head(...)
+  def cama_the_seo(data = {})
+    if is_home?
+      data2 = {}
+    elsif is_page?
+      data2 = {image: @cama_visited_post.the_thumb_url, title: "#{current_site.the_title} | #{@cama_visited_post.the_title}", description: @cama_visited_post.the_excerpt, keywords: @cama_visited_post.the_keywords, object: @cama_visited_post }
+    elsif is_ajax?
+      data2 = {}
+    elsif is_search?
+      data2 = {title: "#{current_site.the_title} | #{ct("search_title", default: "Search")}"}
+    elsif is_post_type?
+      data2 = {image: @cama_visited_post_type.the_thumb_url, title: "#{current_site.the_title} | #{@cama_visited_post_type.the_title}", description: @cama_visited_post_type.the_excerpt, keywords: @cama_visited_post_type.the_keywords, object: @cama_visited_post_type }
+    elsif is_post_tag?
+      data2 = {title: "#{current_site.the_title} | #{@cama_visited_tag.the_title}", description: @cama_visited_tag.the_excerpt, keywords: @cama_visited_tag.the_keywords, object: @cama_visited_tag }
+    elsif is_category?
+      data2 = {image: @cama_visited_category.the_thumb_url, title: "#{current_site.the_title} | #{@cama_visited_category.the_title}", description: @cama_visited_category.the_excerpt, keywords: @cama_visited_category.the_keywords, object: @cama_visited_category }
+    elsif is_profile?
+      data2 = {image: @user.the_avatar, title: "#{current_site.the_title} | #{@user.the_name}", description: @user.the_slogan, object: @user }
+    else
+      data2 = {}
+    end
+    cama_build_seo(data2.merge(@_cama_seo_setting_values || {}).merge(data))
+  end
+
+  # permit to define seo attributes by code without hooks (check here for more attributes: https://github.com/kpumuk/meta-tags)
+  # @Sample: cama_seo_settings({title: "my custom title", description: "my descr", keywords: "my keywords", image: 'my img url'})
+  # This values will be shown within the_head(...)
+  def cama_seo_settings(options)
+    @_cama_seo_setting_values ||= {}
+    @_cama_seo_setting_values = @_cama_seo_setting_values.merge(options)
+  end
+
+  private
+  # create seo attributes with options + default attributes
+  def cama_build_seo(options = {})
+    options[:image] = current_site.get_option("screenshot", current_site.the_logo) unless options[:image].present?
+    options[:title] = current_site.the_title unless options[:title].present?
+    options[:description] = current_site.the_option("seo_description") unless options[:description].present?
+    options[:url] = request.original_url
+    options[:keywords] = current_site.the_option("keywords") unless options[:keywords].present?
+
+    s = {
+      keywords: options[:keywords],
+      author: current_site.get_option('seo_author'),
+      icon: current_site.the_icon,
+      og: {
+        title: options[:title],
+        description: options[:description],
+        type: 'website',
+        url: options[:url],
+        image: options[:image]
+      },
+      twitter: {
+        card: 'summary',
+        title: options[:title],
+        description: options[:description],
+        url:   options[:url],
+        image: options[:image],
+        site: current_site.get_option('twitter_card'),
+        creator: current_site.get_option('twitter_card'),
+        domain: request.host
+      },
+      alternate: [
+        { type: 'application/rss+xml', href: cama_rss_url }
+      ]
+    }.merge(options.except(:object))
+
+    l = current_site.get_languages
+    if l.size > 1
+      l.each do |lang|
+        s[:alternate] << {
+          href: options[:object].present? ? options[:object].the_url(locale: lang) : current_site.the_url(locale: lang),
+          hreflang: lang
+        }
+      end
+    end
+
+    # call all hooks for seo
+    r = { seo_data: s, object: options[:object] }
+    hooks_run('seo', r)
+    r[:seo_data]
+  end
+end

data/app/helpers/camaleon_cms/frontend/site_helper.rb

@@ -0,0 +1,70 @@
+module CamaleonCms::Frontend::SiteHelper
+  # return full current visited url
+  def site_current_url
+    request.original_url
+  end
+
+  # return current url visited as path
+  # http://localhost:9001/category/cat-post-2  => /category/cat-post-2
+  def site_current_path
+    @_site_current_path ||= site_current_url.sub(cama_root_url(locale: nil), "/")
+  end
+
+  #**************** section is a? ****************#
+  # check if current section visited is home page
+  def is_home?
+    @cama_visited_home.present?
+  end
+
+  # check if current section visited is for post
+  def is_page?
+    @cama_visited_post.present?
+  end
+
+  # check if current section visited is for post
+  def is_profile?
+    @cama_visited_profile.present?
+  end
+
+  # check if current section visited is for ajax
+  def is_ajax?
+    @cama_visited_ajax.present?
+  end
+
+  # check if current section visited is for search
+  def is_search?
+    @cama_visited_search.present?
+  end
+
+  # check if current section visited is for post type
+  def is_post_type?
+    @cama_visited_post_type.present?
+  end
+
+  # check if current section visited is for post tag
+  def is_post_tag?
+    @cama_visited_tag.present?
+  end
+
+  # check if current section visited is for category
+  def is_category?
+    @cama_visited_category.present?
+  end
+  
+  # check if visited page is user profile (frontend)
+  def is_profile?
+    @cama_visited_profile == true
+  end
+
+  #**************** end section is a? ****************#
+
+  # show custom assets added by plugins
+  # show respond js and html5shiv
+  # seo_attrs: Custom attributes for seo in Hash format
+  # show_seo: (Boolean) control to append or not the seo attributes
+  def the_head(seo_attrs = {}, show_seo = true)
+    js = "<script>var ROOT_URL = '#{cama_root_url}'; var LANGUAGE = '#{I18n.locale}'; </script>".html_safe
+    js += cama_draw_pre_asset_contents
+    (csrf_meta_tag || "") + "\n" + display_meta_tags(cama_the_seo(seo_attrs)) + "\n" + js + "\n" + cama_draw_custom_assets
+  end
+end

data/app/helpers/camaleon_cms/hooks_helper.rb

@@ -0,0 +1,57 @@
+module CamaleonCms::HooksHelper
+  include CamaleonCms::PluginsHelper
+  
+  # execute hooks for plugin_key with action name hook_key
+  # non public method
+  # plugin: plugin configuration (config.json)
+  # hook_key: hook key
+  # params: params for hook
+  def hook_run(plugin, hook_key, params = nil)
+    _do_hook(plugin, hook_key, params)
+  end
+
+  # execute all hooks from enabled plugins with key hook_key
+  # non public method
+  # hook_key: hook key
+  # params: params for hook
+  def hooks_run(hook_key, params = nil)
+    PluginRoutes.enabled_apps(current_site).each do |plugin|
+      _do_hook(plugin, hook_key, params)
+    end
+
+    # call all anonymous hooks
+    PluginRoutes.get_anonymous_hooks(hook_key).each do |_hook|
+      _hook.call(params)
+    end
+  end
+  
+  # skip hook function with name: hook_function_name
+  def hook_skip(hook_function_name)
+    @_hooks_skip << hook_function_name
+  end
+
+  private
+
+  def _do_hook(plugin, hook_key, params =  nil)
+    return if !plugin.present? || !plugin["hooks"].present? || !plugin["hooks"][hook_key].present?
+
+    plugin["hooks"][hook_key].each do |hook|
+      next if @_hooks_skip.present? && @_hooks_skip.include?(hook)
+      begin
+        if params.nil?
+          send(hook)
+        else
+          send(hook, params)
+        end
+        Rails.logger.debug "Camaleon CMS - Hook \"#{hook_key}\" executed from dependency #{plugin['key'] rescue ''}".cama_log_style(:light_blue)
+      rescue
+        plugin_load_helpers(plugin)
+        if params.nil?
+          send(hook)
+        else
+          send(hook, params)
+        end
+      end
+    end
+  end
+end

data/app/helpers/camaleon_cms/html_helper.rb

@@ -0,0 +1,134 @@
+#encoding: utf-8
+module CamaleonCms::HtmlHelper
+  def cama_html_helpers_init
+    @_pre_assets_content = [] #Assets contents before the libraries import
+    @_assets_libraries = {}
+    @_assets_content = []
+  end
+
+  # register a new asset library to be included on demand calling by: cama_load_libraries(...)
+  # sample: cama_assets_library_register("my_library", {js: ["url_js", "url_js2"], css: ["url_css1", "url_css2"]})
+  #   cama_load_libraries("my_library")
+  def cama_assets_library_register(key, assets = {})
+    key = key.to_sym
+    cama_assets_libraries
+    @_cama_assets_libraries[key] = {css: [], js: [] } unless @_cama_assets_libraries[key].present?
+    @_cama_assets_libraries[key][:css] += assets[:css] if assets[:css].present?
+    @_cama_assets_libraries[key][:js] += assets[:js] if assets[:js].present?
+  end
+
+  # enable to load admin or registered libraries (colorpicker, datepicker, tinymce, form_ajax, cropper)
+  # sample: add_asset_library("datepicker", "colorpicker")
+  # This will add this assets library in the admin head or in a custom place by calling: cama_draw_custom_assets()
+  def cama_load_libraries(*keys)
+    keys.each do |key|
+      library = cama_assets_libraries[key.to_sym]
+      @_assets_libraries[key.to_sym] = library if library.present?
+    end
+  end
+
+  alias_method :add_asset_library, :cama_load_libraries
+
+  # add custom asset libraries (js, css or both) for the current request, also you can add extra css or js files for existent libraries
+  # sample: (add new library)
+  #   append_asset_libraries({"my_library_key"=> { js: [plugin_asset("js/my_js"), "plugins/myplugin/assets/js/my_js2"], css: [plugin_asset("css/my_css"), "plugins/myplugin/assets/css/my_css2"] }})
+  # sample: (update existent library)
+  #   append_asset_libraries({"colorpicker"=>{js: [plugin_asset("js/my_custom_js")] } })
+  # return nil
+  def append_asset_libraries(libraries)
+    libraries.each do |key, library|
+      if @_assets_libraries.include?(key)
+        @_assets_libraries[key.to_sym] = @_assets_libraries[key.to_sym].merge(library)
+      else
+        @_assets_libraries[key.to_sym] = library
+      end
+    end
+  end
+  alias_method :cama_load_custom_assets, :append_asset_libraries
+
+  # add asset content into custom assets
+  # content may be: <script>alert()</script>
+  # content may be: <style>a{color: red;}</style>
+  # this will be printed with <%raw cama_draw_custom_assets %>
+  def append_asset_content(content)
+    @_assets_content << content
+  end
+
+  # add pre asset content into custom assets
+  # content may be: <script>alert()</script>
+  # content may be: <style>a{color: red;}</style>
+  # this will be printed before assets_library with <%raw cama_draw_pre_asset_contents %>
+  def append_pre_asset_content(content)
+    @_pre_assets_content << content
+  end
+
+  # return all scripts to be executed before import the js libraries(cama_draw_custom_assets)
+  def cama_draw_pre_asset_contents
+    (@_pre_assets_content || []).join('').html_safe
+  end
+
+  # return all js libraries added [aa.js, bb,js, ..]
+  # def get_assets_js
+  def cama_draw_custom_assets
+    cama_html_helpers_init unless @_assets_libraries.present?
+    libs = []
+    @_assets_libraries.each do |key, assets|
+      libs += assets[:css] if assets[:css].present?
+    end
+    stylesheets = libs.uniq
+    css = stylesheet_link_tag *stylesheets, media: "all"
+
+    libs = []
+    @_assets_libraries.each do |key, assets|
+      libs += assets[:js] if assets[:js].present?
+    end
+    javascripts = libs.uniq
+    js = javascript_include_tag *javascripts
+
+    args = {stylesheets: stylesheets, javascripts: javascripts, js_html: js, css_html: css}; hooks_run('draw_custom_assets', args)
+    args[:css_html] + "\n" + args[:js_html] + "\n" + @_assets_content.join("").html_safe
+  end
+
+  # return category tree for category dropdown
+  # each level is prefixed with -
+  # level: internal recursive control
+  def cama_get_options_html_from_items(terms, level = 0)
+    options = []
+    terms.all.each do |term|
+      options << [("—"*level) + term.name, term.id] unless @term.id == term.id
+      children = term.children
+      options += cama_get_options_html_from_items(children, level + 1) if children.size > 0
+    end
+    options
+  end
+
+  # create a html tooltip to include anywhere
+  # text: text of the tooltip
+  # location: location of the tooltip (left | right | top |bottom)
+  def cama_html_tooltip(text='Tooltip', location='left')
+    "<a href='javascript:;' title='#{text}' data-toggle='tooltip' data-placement='#{location}'><i class='fa fa-info-circle'></i></a>"
+  end
+
+  private
+  def cama_assets_libraries
+    return @_cama_assets_libraries if @_cama_assets_libraries.present?
+    libs = {}
+    libs[:colorpicker] = {js: ['camaleon_cms/admin/bootstrap-colorpicker'], css: ["camaleon_cms/admin/colorpicker.css"]}
+    libs[:datepicker] = {js: []}
+    libs[:datetimepicker] = {js: [], css: []}
+    libs[:tinymce] = {js: ['camaleon_cms/admin/tinymce/tinymce.min', "camaleon_cms/admin/tinymce/plugins/filemanager/plugin.min"], css: ["camaleon_cms/admin/tinymce/skins/lightgray/content.min"]}
+    libs[:form_ajax] = {js: ['camaleon_cms/admin/form/jquery.form']}
+    libs[:cropper] = {} # loaded by default
+    libs[:post] = {js: ["camaleon_cms/admin/jquery.tagsinput.min", 'camaleon_cms/admin/post'], css: ["camaleon_cms/admin/jquery.tagsinput"]}
+    libs[:multiselect] = {js: ['camaleon_cms/admin/bootstrap-select.js']}
+    libs[:validate] = {js: ['camaleon_cms/admin/jquery.validate']}
+    libs[:nav_menu] = {css: ['camaleon_cms/admin/nestable/jquery.nestable'], js: ["camaleon_cms/admin/jquery.nestable", 'camaleon_cms/admin/nav_menu']}
+    libs[:admin_intro] = {js: ['camaleon_cms/admin/introjs/intro.min'], css: ["camaleon_cms/admin/introjs/introjs.min"]}
+    @_cama_assets_libraries = libs
+  end
+
+  # execute translation for value if this value is like: t(admin.my_text) ==> My Text
+  def cama_print_i18n_value(value)
+    value.start_with?('t(') ? eval(value.sub('t(', 'I18n.t(')) : value
+  end
+end

data/app/helpers/camaleon_cms/plugins_helper.rb

@@ -0,0 +1,173 @@
+module CamaleonCms::PluginsHelper
+  include CamaleonCms::SiteHelper
+  # load all plugins + theme installed for current site
+  # METHOD IGNORED (is a partial solution to avoid load helpers and cache it for all sites)
+  # this method try to load helpers for each request without caching
+  def plugins_initialize(klass = nil)
+    mod = Module.new
+    PluginRoutes.enabled_apps(current_site).each{|plugin|
+      next if !plugin.present? || !plugin["helpers"].present?
+      plugin["helpers"].each do |h|
+        mod.send :include, h.constantize
+      end
+    }
+    (klass || self).send :extend, mod
+  end
+
+  # upgrade installed plugin in current site for a new version
+  # plugin_key: key of the plugin
+  # trigger hook "on_upgrade"
+  # return model of the plugin
+  def plugin_upgrade(plugin_key)
+    plugin_model = current_site.plugins.where(slug: plugin_key).first!
+    hook_run(plugin_model.settings, "on_upgrade", plugin_model)
+    plugin_model.installed_version= plugin_model.settings["version"]
+    hooks_run("plugin_after_upgrade", {plugin: plugin_model})
+    hooks_run("plugin_#{plugin_key}_after_upgrade", {plugin: plugin_model})
+    plugin_model
+  end
+
+  # install a plugin for current site
+  # plugin_key: key of the plugin
+  # return model of the plugin
+  def plugin_install(plugin_key)
+    if PluginRoutes.plugin_info(plugin_key).nil?
+      Rails.logger.debug "Camaleon CMS - Plugin not found: #{plugin_key}"
+    else
+      plugin_model = current_site.plugins.where(slug: plugin_key).first_or_create!
+      plugin_model.installed_version= plugin_model.settings["version"]
+      return plugin_model if plugin_model.active?
+      plugin_model.active
+      PluginRoutes.reload
+      # plugins_initialize(self)
+      hook_run(plugin_model.settings, "on_active", plugin_model)
+      hooks_run("plugin_after_install", {plugin: plugin_model})
+      hooks_run("plugin_#{plugin_key}_after_install", {plugin: plugin_model})
+      plugin_model
+    end
+  end
+
+  # uninstall a plugin from current site
+  # plugin_key: key of the plugin
+  # return model of the plugin
+  def plugin_uninstall(plugin_key)
+    plugin_model = current_site.plugins.where(slug: plugin_key).first_or_create!
+    return plugin_model unless plugin_model.active?
+    plugin_model.inactive
+    PluginRoutes.reload
+    # plugins_initialize(self)
+    hook_run(plugin_model.settings, "on_inactive", plugin_model)
+    hooks_run("plugin_after_uninstall", {plugin: plugin_model})
+    hooks_run("plugin_#{plugin_key}_after_uninstall", {plugin: plugin_model})
+    plugin_model
+  end
+
+  # remove a plugin from current site
+  # plugin_key: key of the plugin
+  # return model of the plugin removed
+  # DEPRECATED: PLUGINS AND THEMES CANNOT BE DESTROYED
+  def plugin_destroy(plugin_key)
+    hooks_run("plugin_after_destroy", {plugin: plugin_key})
+    hooks_run("plugin_#{plugin_key}_after_destroy", {plugin: plugin_key})
+  end
+
+  # return plugin full layout path
+  # plugin_key: plugin name
+  def plugin_layout(layout_name, plugin_key = nil)
+    key = plugin_key || self_plugin_key(1)
+    if PluginRoutes.plugin_info(key)["gem_mode"]
+      "plugins/#{key}/layouts/#{layout_name}"
+    else
+      "plugins/#{key}/views/layouts/#{layout_name}"
+    end
+  end
+
+  # return plugin full view path
+  # plugin_key: plugin name
+  def plugin_view(view_name, plugin_key = nil)
+    if plugin_key.present? && plugin_key.include?("/") # fix for 1.x
+      k = view_name
+      view_name = plugin_key
+      plugin_key = k
+    end
+    key = plugin_key || self_plugin_key(1)
+    if PluginRoutes.plugin_info(key)["gem_mode"]
+      "plugins/#{key}/#{view_name}"
+    else
+      "plugins/#{key}/views/#{view_name}"
+    end
+  end
+
+  # return plugin full asset path
+  # plugin_key: plugin name
+  # asset: (String) asset name
+  # sample: <script src="<%= plugin_asset_path("admin.js") %>"></script> => /assets/plugins/my_plugin/admin-54505620f.js
+  # sample: <script src="<%= plugin_asset_path("admin.js", 'my_plugin') %>"></script> => /assets/plugins/my_plugin/admin-54505620f.js
+  def plugin_asset_path(asset, plugin_key = nil)
+    if plugin_key.present? && plugin_key.include?("/")
+      return plugin_asset_url(plugin_key, asset || self_plugin_key(1))
+    end
+    key = plugin_key || self_plugin_key(1)
+    if PluginRoutes.plugin_info(key)["gem_mode"]
+      "plugins/#{key}/#{asset}"
+    else
+      "plugins/#{key}/assets/#{asset}"
+    end
+  end
+  alias_method :plugin_asset, :plugin_asset_path
+  alias_method :plugin_gem_asset, :plugin_asset_path
+
+  # return the full url for asset of current plugin:
+  # asset: (String) asset name
+  # plugin_key: (optional) plugin name, default (current plugin caller to this function)
+  # sample:
+  #   plugin_asset_url("css/main.css") => return: http://myhost.com/assets/plugins/my_plugin/assets/css/main-54505620f.css
+  def plugin_asset_url(asset, plugin_key = nil)
+    key = plugin_key || self_plugin_key(1)
+    p = PluginRoutes.plugin_info(key)["gem_mode"] ? "plugins/#{key}/#{asset}" : "plugins/#{key}/assets/#{asset}"
+    begin
+      ActionController::Base.helpers.asset_url(p)
+    rescue NoMethodError => e
+      p
+    end
+  end
+
+  # auto load all helpers of this plugin
+  def plugin_load_helpers(plugin)
+    return if !plugin.present? || !plugin["helpers"].present?
+    plugin["helpers"].each do |h|
+      begin
+        next if self.class.include?(h.constantize)
+        self.class_eval do
+          include h.constantize
+        end
+      rescue => e
+        Rails.logger.debug "Camaleon CMS - App loading error for #{h}: #{e.message}. Please check the plugins and themes presence"
+      end
+    end
+  end
+
+  # return plugin key for current plugin file (helper|controller|view)
+  # index: internal control (ignored)
+  def self_plugin_key(index = 0)
+    f = caller[index]
+    if f.include?('/apps/plugins/')
+      key = f.split('/apps/plugins/').last.split("/").first
+    elsif f.include?('/plugins/')
+      key = f.split('/plugins/').last.split("/").first
+    else
+      key = f.split('/gems/').last.split("/").first
+    end
+    PluginRoutes.plugin_info(key)['key'] rescue raise("Not found plugin with key: #{key} or dirname: #{key}")
+  end
+
+  # method called only from files within plugins directory
+  # return the plugin model for current site calculated according to the file caller location
+  def current_plugin(plugin_key = nil)
+    _key = plugin_key || self_plugin_key(1)
+    cama_cache_fetch("current_plugin_#{_key}") do
+      current_site.get_plugin(_key)
+    end
+  end
+
+end