RubyGems - camaleon_cms_rails6 - Versions diffs - 2.5.0 - Mend

camaleon_cms_rails6 2.5.0

Files changed (719) hide show

data/app/helpers/camaleon_cms/content_helper.rb ADDED

@@ -0,0 +1,29 @@
+module CamaleonCms::ContentHelper
+  # initialize content variables
+  def cama_content_init
+    @_before_content = []
+    @_after_content = []
+  end
+  # prepend content for admin or frontend (after <body>)
+  # sample: cama_content_prepend(<div>my prepend content</div>)
+  def cama_content_prepend(content)
+    @_before_content << content
+  end
+  # append content for admin or frontend (before </body>)
+  # sample: cama_content_prepend(<div>my after content</div>)
+  def cama_content_append(content)
+    @_after_content << content
+  end
+  # draw all before contents registered by cama_content_prepend
+  def cama_content_before_draw
+    @_before_content.join("") rescue ""
+  end
+  # draw all after contents registered by cama_content_append
+  def cama_content_after_draw
+    @_after_content.join("") rescue ""
+  end
+end

data/app/helpers/camaleon_cms/email_helper.rb ADDED

@@ -0,0 +1,56 @@
+module CamaleonCms::EmailHelper
+  include CamaleonCms::HooksHelper
+  # send and email
+  # email: email to
+  # subject: Subject of the email
+  # content: content of the email
+  # from: email figured as from
+  # attachs: array of files to be attached to the email
+  # layout_name: path of the template to render
+  # template_name: template name to render in template_path
+  def send_email(email, subject='Notification', content='', from=nil, attachs=[], template_name = nil, layout_name = nil, extra_data = {})
+    args = {attachs: attachs, extra_data: extra_data}
+    args[:template_name] = template_name if template_name.present?
+    args[:layout_name] = layout_name if layout_name.present?
+    args[:from] = from if from.present?
+    args[:content] = content if content.present?
+    cama_send_email(email, subject, args)
+  end
+  # short method of send_email
+  # args: content='', from=nil, attachs=[], url_base='', current_site, template_name, layout_name, extra_data, format, cc_to
+  def cama_send_email(email_to, subject, args = {})
+    args = {url_base: cama_root_url, current_site: current_site, subject: subject}.merge(args)
+    args[:attachments] = args[:attachs] if args[:attachs].present?
+    args[:current_site] = args[:current_site].id
+    # run hook "email" to customize values
+    hooks_run("email", args)
+    CamaleonCms::HtmlMailer.sender(email_to, args[:subject], args).deliver_later
+  end
+  def send_user_confirm_email(user_to_confirm)
+    user_to_confirm.send_confirm_email
+    confirm_email_url = cama_admin_confirm_email_url({h: user_to_confirm.confirm_email_token})
+    Rails.logger.debug "Camaleon CMS - Sending email verification to #{user_to_confirm}"
+    extra_data = {:url => confirm_email_url, :fullname => user_to_confirm.fullname}
+    send_email(user_to_confirm.email, t('camaleon_cms.admin.login.confirm.text'), '', nil, [], 'confirm_email', 'camaleon_cms/mailer', extra_data)
+  end
+  def send_password_reset_email(user_to_send)
+    user_to_send.send_password_reset
+    reset_url = cama_admin_forgot_url({h: user_to_send.password_reset_token})
+    extra_data = {
+        :url => reset_url,
+        :fullname => user_to_send.fullname,
+        :user => user_to_send
+    }
+    send_email(user_to_send.email, t('camaleon_cms.admin.login.message.subject_email'), '', nil, [], 'password_reset', 'camaleon_cms/mailer', extra_data)
+  end
+  # send email to the first administrator
+  # args: same arguments than cama_send_email
+  def cama_send_mail_to_admin(subject, args = {})
+    cama_send_email(current_site.get_option('system_email', current_site.users.admin_scope.first.email), subject, args)
+  end
+end

data/app/helpers/camaleon_cms/frontend/application_helper.rb ADDED

@@ -0,0 +1,36 @@
+module CamaleonCms::Frontend::ApplicationHelper
+  include CamaleonCms::Frontend::SiteHelper
+  include CamaleonCms::Frontend::NavMenuHelper
+  include CamaleonCms::Frontend::SeoHelper
+  include CamaleonCms::Frontend::ContentSelectHelper
+  # add where conditionals to filter private/hidden/expired/drafts/unpublished
+  # note: only for post records
+  def verify_front_visibility(active_record)
+    active_record = active_record.visible_frontend
+    r = {active_record: active_record}
+    hooks_run("filter_post", r)
+    r[:active_record]
+  end
+  # fix for url_to or url_path or any other who need add automatically current locale in the url
+  # sample: cama_url_to_fixed("root_url", data: "asdasd", y: 12)
+  # => http://localhost/fr?data=asdasd&y=12
+  # note: if current locale is the default language, then locale is not added in the url
+  def cama_url_to_fixed(url_to, *args)
+    options = args.extract_options!
+    _current_site = options.delete(:site) || current_site
+    if request.present?
+      if options.include?(:locale) && options[:locale] == false
+        options.delete(:locale)
+      else
+        options[:locale] = I18n.locale if !options[:locale].present? && _current_site && _current_site.get_languages.size > 1
+      end
+      options[:locale] = nil if options[:locale].present? && _current_site && _current_site.get_languages.first.to_s == options[:locale].to_s
+    end
+    options.delete(:format) if PluginRoutes.system_info["skip_format_url"].present?
+    cama_current_site_host_port(options) unless options.keys.include?(:host)
+    send(url_to.gsub('-', '_'), *(args << options))
+  end
+end

data/app/helpers/camaleon_cms/frontend/content_select_helper.rb ADDED

@@ -0,0 +1,161 @@
+=begin
+  Camaleon CMS is a content management system
+  Copyright (C) 2015 by Owen Peredo Diaz
+  Email: owenperedo@gmail.com
+  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.
+=end
+module CamaleonCms::Frontend::ContentSelectHelper
+  # select single post of post type
+  # the_post_type('post') do
+  #   the_post('first-blog-post')
+  # end
+  def the_post(slug)
+    post = @object.the_post(slug)
+    process_in_block(post) do
+      yield(post) if block_given?
+    end
+    post
+  end
+  # select posts of post type
+  # the_post_type('post') do
+  #   the_posts
+  # end
+  #
+  # the_post_type('post') do
+  #   the_posts(limit: 10)
+  # end
+  def the_posts(options={})
+    @object.posts.visible_frontend.limit(options[:limit]).decorate
+  end
+  # select post type by just pass slug to parameter
+  # Example:
+  # the_post_type('post')
+  # the_post_type('page')
+  #
+  # the_post_type('post') do
+  #   the_post('first-blog')
+  # end
+  def the_post_type(slug)
+    post_type = current_site.the_post_type(slug)
+    process_in_block(post_type) do
+      yield(post_type) if block_given?
+    end
+    post_type
+  end
+  # select comments of post
+  # the_post('blog')
+  #   the_comments
+  # end
+  def the_comments(options={})
+    @object.comments.limit(options[:limit]).decorate if @object.present?
+  end
+  # select title of post
+  # the_post('blog') do
+  #   the_title
+  # end
+  def the_title
+    @object.the_title if @object.present?
+  end
+  # select content of post
+  # the_post('blog') do
+  #   the_content
+  # end
+  def the_content
+    @object.the_content.html_safe if @object.present?
+  end
+  # select url of post
+  # the_post('blog') do
+  #   the_url
+  # end
+  def the_url
+    @object.the_url if @object.present?
+  end
+  # select thumbnail of post
+  # the_post('blog') do
+  #   the_thumbnail
+  # end
+  def the_thumbnail
+    @object.the_thumb_url if @object.present?
+  end
+  # select slug of post, post type ... (@object)
+  # the_post('blog') do
+  #   the_slug
+  # end
+  def the_slug
+    @object.the_slug if @object.present?
+  end
+  # select excerpt of post
+  # the_post('blog') do
+  #   the_excerpt
+  # end
+  def the_excerpt(chars=200)
+    @object.the_excerpt(chars) if @object.present?
+  end
+  # select custome field from object
+  # the_post('blog') do
+  #   the_field('extra-content')
+  # end
+  def the_field(slug)
+    @object.the_field(slug) if @object.present?
+  end
+  # loop through each post of post type
+  # each_post_of('post') do
+  #   the_title
+  # end
+  #
+  # each_post_of('post', limit: 10) do
+  #   the_title
+  # end
+  def each_post_of(post_type_slug, options={})
+    the_post_type(post_type_slug) do
+      the_posts(options).each do |post|
+        process_in_block(post) do
+          yield(post) if block_given?
+        end
+      end
+    end
+  end
+  # loop through each category of post type
+  # each_category_of('post') do
+  #   the_title
+  # end
+  #
+  # each_category_of('post', limit: 4) do
+  #   the_title
+  # end
+  def each_category_of(post_type_slug, options={})
+    the_post_type(post_type_slug) do
+      the_categories(options).each do |category|
+        process_in_block(category) do
+          yield(category) if block_given?
+        end
+      end
+    end
+  end
+  # allow object to be global varaible in block
+  # work_in_block_of(post) do
+  #   the_field('extra-content')
+  # end
+  def process_in_block(object)
+    temp_object = @object
+    @object     = object
+    yield
+    @object     = temp_object
+  end
+end

data/app/helpers/camaleon_cms/frontend/nav_menu_helper.rb ADDED

@@ -0,0 +1,237 @@
+module CamaleonCms::Frontend::NavMenuHelper
+  # draw nav menu as html list
+  # key: slug for nav menu
+  # to register this, go to admin -> appearance -> menus
+  # (DEPRECATED)
+  def get_nav_menu(key = 'main_menu', class_name = "navigation")
+    draw_menu({menu_slug: key, container_class: class_name})
+  end
+  # draw menu as an html
+  # default configurations is for bootstrap support
+  def draw_menu(args = {})
+    args_def = {
+                menu_slug:        'main_menu', #slug for the menu
+                container:        'ul', #type of container for the menu
+                container_id:     '', #container id for the menu
+                container_class:  'nav navbar-nav nav-menu', #container class for the menu
+                item_container:   'li', #type of container for the items
+                item_current:     'current-menu-item', #class for current menu item
+                item_class:       'menu-item', # class for all menu items
+                item_class_parent:"dropdown", # class for all menu items that contain sub items
+                sub_container:    'ul', #type of container for sub items
+                sub_class:        'dropdown-menu', # class for sub container
+                callback_item:    lambda{|args| },
+                    # callback executed for each item (args = { menu_item, link, level, settings, has_children, link_attrs = "", index}).
+                    #     menu_item: (Object) Menu object
+                    #     link: (Hash) link data: {link: '', name: ''}
+                    #     level: (Integer) current level
+                    #     has_children: (boolean) if this item contain sub menus
+                    #     settings: (Hash) menu settings
+                    #     index: (Integer) Index Position of this menu
+                    #     link_attrs: (String) Here you can add your custom attrs for current link, sample: id='my_id' data-title='#{args[:link][:name]}'
+                    #     item_container_attrs: (String) Here you can add your custom attrs for link container.
+                    # In settings you can change the values for this item, like after, before, ..:
+                    # sample: lambda{|args| args[:settings][:after] = "<span class='caret'></span>" if args[:has_children]; args[:link_attrs] = "id='#{menu_item.id}'";  }
+                    # sample: lambda{|args| args[:settings][:before] = "<i class='fa fa-home'></i>" if args[:level] == 0 && args[:index] == 0;  }
+                before:           '', # content before link text
+                after:            '', # content after link text
+                link_current:     'current-link', # class for current menu link
+                link_before:      '', # content before link
+                link_after:       '', # content after link
+                link_class:       'menu_link', # class for all menu links
+                link_class_parent:"dropdown-toggle", # class for all menu links that contain sub items
+                levels:            -1, # max of levels to recover, -1 => return all levels
+                container_prepend:      '', # content prepend for menu container
+                container_append:       ''  # content append for menu container
+                }
+    args = args_def.merge(args)
+    nav_menu = current_site.nav_menus.find_by_slug(args[:menu_slug])
+    nav_menu = current_site.nav_menus.first unless nav_menu.present?
+    html = "<#{args[:container]} class='#{args[:container_class]}' id='#{args[:container_id]}'>#{args[:container_prepend]}{__}#{args[:container_append]}</#{args[:container]}>"
+    if nav_menu.present?
+      html = html.sub("{__}", cama_menu_draw_items(args, nav_menu.children.reorder(:term_order)))
+    else
+      html = html.sub("{__}", "")
+    end
+    html
+  end
+  # draw menu items
+  def cama_menu_draw_items(args, nav_menu, level = 0)
+    html = ""
+    parent_current = false
+    index = 0
+    nav_menu.eager_load(:metas).each do |nav_menu_item|
+      _args = args.dup
+      data_nav_item = cama_parse_menu_item(nav_menu_item)
+      next if data_nav_item == false
+      _is_current = data_nav_item[:current] || site_current_path == data_nav_item[:link] || site_current_path == data_nav_item[:link].sub(".html", "")
+      has_children = nav_menu_item.have_children? && (args[:levels] == -1 || (args[:levels] != -1 && level <= args[:levels]))
+      r = {
+        menu_item: nav_menu_item.decorate,
+        link: data_nav_item,
+        level: level,
+        settings: _args,
+        has_children: has_children,
+        link_attrs: '',
+        item_container_attrs: '',
+        index: index
+      }
+      args[:callback_item].call(r)
+      _args = r[:settings]
+      if has_children
+        html_children, current_children = cama_menu_draw_items(args, nav_menu_item.children.reorder(:term_order), level + 1)
+      else
+        html_children, current_children = "", false
+      end
+      parent_current = true if _is_current || current_children
+      html += "<#{_args[:item_container]} #{r[:item_container_attrs]} class='#{_args[:item_class]} #{_args[:item_class_parent] if has_children} #{"#{_args[:item_current]}" if _is_current} #{"current-menu-ancestor" if current_children }'>#{_args[:link_before]}
+                <a #{r[:link_attrs]} #{" target='#{nav_menu_item.target}'" if nav_menu_item.target.present?} href='#{data_nav_item[:link]}' class='#{args[:link_current] if _is_current} #{_args[:link_class_parent] if has_children} #{_args[:link_class]}' #{"data-toggle='dropdown'" if has_children } >#{_args[:before]}#{data_nav_item[:name]}#{_args[:after]}</a> #{_args[:link_after]}
+                #{ html_children }
+              </#{_args[:item_container]}>"
+      index += 1
+    end
+    if level == 0
+      html
+    else
+      html = "<#{args[:sub_container]} class='#{args[:sub_class]} #{"parent-#{args[:item_current]}" if parent_current} level-#{level}'>#{html}</#{args[:sub_container]}>"
+      [html, parent_current]
+    end
+  end
+  # filter and parse all menu items visible for current user and adding the flag for current_parent or current_item
+  # max_levels: max levels to iterate
+  # return an multidimensional array with all items until level 'max_levels'
+  # internal_level: ingnore (managed by internal recursion)
+  def cama_menu_parse_items(items, max_levels=-1, internal_level=0)
+    res, is_current_parent, levels = [], false, [0]
+    items.reorder(:term_order).each_with_index do |nav_menu_item, index|
+      data_nav_item = cama_parse_menu_item(nav_menu_item)
+      next if data_nav_item == false
+      _is_current = data_nav_item[:current] || site_current_path == data_nav_item[:link] || site_current_path == data_nav_item[:link].sub(".html", "")
+      has_children = nav_menu_item.have_children?
+      has_children = false if max_levels > 0 && max_levels == internal_level
+      data_nav_item[:label] = data_nav_item[:name]
+      data_nav_item[:url] = data_nav_item[:link]
+      r = {
+          menu_item: nav_menu_item.decorate,
+          level: internal_level,
+          has_children: has_children,
+          index: index,
+          current_item: _is_current,
+          current_parent: false,
+          levels: 0
+      }.merge(data_nav_item.except(:current, :name, :link))
+      if has_children
+        r[:children], _is_current_parent, r[:levels] = cama_menu_parse_items(nav_menu_item.children, max_levels, internal_level + 1)
+        if _is_current_parent
+          is_current_parent = true
+          r[:current_parent] = true
+        end
+        r[:levels] = r[:levels] + 1
+      end
+      is_current_parent = true if r[:current_item]
+      levels << r[:levels]
+      res << r
+    end
+    if internal_level == 0
+      res
+    else
+      [res, is_current_parent, levels.max]
+    end
+  end
+  #******************* BREADCRUMBS *******************
+  # draw the breadcrumb as html list
+  def breadcrumb_draw
+    res = []
+    @_front_breadcrumb.each_with_index do |item, index|
+      if @_front_breadcrumb.size == (index+1) #last menu
+        res << "<li class='active'>#{item[0]}</li>"
+      else
+        res << "<li><a href='#{item[1]}'>#{item[0]}</a></li>"
+      end
+    end
+    res.join("")
+  end
+  # add breadcrumb item at the end
+  # label => label of the link
+  # url: url for the link
+  def breadcrumb_add(label, url = "", prepend = false)
+    @_front_breadcrumb ||= []
+    if prepend
+      @_front_breadcrumb = @_front_breadcrumb.unshift([label, url])
+    else
+      @_front_breadcrumb << [label, url]
+    end
+  end
+  def cama_parse_menu_item(nav_menu_item, is_from_backend = false)
+    type_menu, result = nav_menu_item.kind, false
+    begin
+      case type_menu
+        when 'post'
+          post = CamaleonCms::Post.find(nav_menu_item.url).decorate
+          if is_from_backend || post.can_visit?
+            result = {link: post.the_url(as_path: true), name: post.the_title, type_menu: type_menu, url_edit: post.the_edit_url}
+            result[:current] = @cama_visited_post.present? && @cama_visited_post.id == post.id unless is_from_backend
+          end
+        when 'category'
+          category = CamaleonCms::Category.find(nav_menu_item.url).decorate
+          result = {link: category.the_url(as_path: true), name: category.the_title, url_edit: category.the_edit_url}
+          result[:current] = @cama_visited_category.present? && @cama_visited_category.id == category.id unless is_from_backend
+        when 'post_tag'
+          post_tag = CamaleonCms::PostTag.find(nav_menu_item.url).decorate
+          result = {link: post_tag.the_url(as_path: true), name: post_tag.the_title, url_edit: post_tag.the_edit_url}
+          result[:current] = @cama_visited_tag.present? && @cama_visited_tag.id == post_tag.id unless is_from_backend
+        when 'post_type'
+          post_type = CamaleonCms::PostType.find(nav_menu_item.url).decorate
+          result = {link: post_type.the_url(as_path: true), name: post_type.the_title, url_edit: post_type.the_edit_url}
+          result[:current] = @cama_visited_post_type.present? && @cama_visited_post_type.id == post_type.id unless is_from_backend
+        when 'external'
+          result = {link: nav_menu_item.url.to_s.translate, name: nav_menu_item.name.to_s.translate, current: false}
+          # permit to customize or mark as current menu
+          # _args: (HASH) {menu_item: Model Menu Item, parsed_menu: Parsed Menu }
+          #   Sample parsed_menu: {link: "url of the link", name: "Text of the menu", current: Boolean (true => is current menu, false => not current menu item)}
+          unless is_from_backend
+            result[:link] = cama_root_path if result[:link] == "root_url"
+            result[:link] = site_current_path if site_current_path == "#{current_site.the_path}#{result[:link]}"
+            result[:current] = result[:link] == site_current_url || result[:link] == site_current_path
+            _args = {menu_item: nav_menu_item, parsed_menu: result}; hooks_run("on_external_menu", _args)
+            result = _args[:parsed_menu]
+          end
+        else
+          # permit to build custom menu items registered as Custom Menu by hook "nav_menu_custom"
+          # sample: def my_parse_custom_menu_item_listener(args);
+          #   if args[:menu_item].kind == 'MyModelClass'
+          #     my_model = MyModelClass.find(args[:menu_item].url)
+          #     res = {name: my_model.name, url_edit: my_model_edit_url(id: my_model.id), link: my_model_public_url(id: my_model.id)}
+          #     res[:current] = site_current_path == my_model_public_url(id: my_model.id) unless args[:is_from_backend]
+          #     args[:parsed_menu] = res
+          #   end
+          # end
+          hook_args={menu_item: nav_menu_item, parsed_menu: false, is_from_backend: is_from_backend}; hooks_run('parse_custom_menu_item', hook_args)
+          result = hook_args[:parsed_menu]
+      end
+    rescue => e
+      Rails.logger.error "Camaleon CMS - Menu Item Not Found => Skipped menu for: #{e.message} (#{nav_menu_item.inspect})".cama_log_style(:red)
+    end
+    # permit to customize data, like: current, title, ... of parsed menu item or skip menu item by assigning false into :parsed_menu
+    unless is_from_backend
+      _args = {menu_item: nav_menu_item, parsed_menu: result};  hooks_run("on_render_front_menu_item", _args)
+      _args[:parsed_menu]
+    else
+      result
+    end
+  end
+end