camaleon_cms 0.0.1

data/app/helpers/plugins_helper.rb

@@ -0,0 +1,129 @@
+=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 PluginsHelper
+  # 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
+
+  # install a plugin for current site
+  # plugin_key: key of the plugin
+  # return model of the plugin
+  def plugin_install(plugin_key)
+    plugin_model = current_site.plugins.where(slug: plugin_key).first_or_create!
+    return plugin_model if plugin_model.active?
+    plugin_model.active
+    PluginRoutes.reload
+    # plugins_initialize(self)
+    hook_run(plugin_model.settings, "on_active", plugin_model)
+    plugin_model
+  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)
+    plugin_model
+  end
+
+  # remove a plugin from current site
+  # plugin_key: key of the plugin
+  # return model of the plugin removed
+  def plugin_destroy(plugin_key)
+    plugin_model = current_site.plugins.where(slug: plugin_key).first_or_create
+    if !plugin_can_be_deleted?(params[:id]) || true
+      plugin_model.error = false
+      plugin_model
+    else
+      hook_run(plugin_model.settings, "on_destroy", plugin_model)
+      plugin_model.destroy
+      PluginRoutes.destroy_plugin(params[:id])
+      plugin_model.error = true
+    end
+    plugin_model
+  end
+
+  # return plugin full layout path
+  # plugin_key: plugin name
+  def plugin_layout(plugin_key, layout_name)
+    "#{plugin_key}/views/layouts/#{layout_name}"
+  end
+
+  # return plugin full view path
+  # plugin_key: plugin name
+  def plugin_view(plugin_key, view_name)
+    "#{plugin_key}/views/#{view_name}"
+  end
+
+  # return plugin full asset path
+  # plugin_key: plugin name
+  # if asset is present return full path to this asset
+  # sample: <script src="<%= plugin_asset_path("my_plugin", "js/admin.js") %>"></script>
+  def plugin_asset_path(plugin_key, asset = nil)
+    # "#{root_url(locale: nil)}assets/plugins/#{plugin_key}/assets/#{asset}"
+    "plugins/#{plugin_key}/assets/#{asset}"
+  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.info "---------------------------app loading error for #{h}: #{e.message}. Please check the plugins and themes presence"
+        # flash.now[:error] = "app loading error for #{h}: #{e.message}. Please check the plugins and themes presence"
+      end
+
+      #self.class.helper h.constantize rescue ActionController::Base.helper(h.constantize)
+    end
+  end
+
+  ############# admin helpers ##############
+  # check if this plugin can be deleted
+  def plugin_can_be_deleted?(key)
+    c = 0
+    Site.all.each do |site|
+      c += site.plugins.where(slug: key).count
+    end
+    c == 0
+  end
+
+  # return plugin key for current plugin file (helper|controller|view)
+  def self_plugin_key
+    k = "app/apps/plugins/"
+    f = caller.first
+    f.split(k).last.split("/").first if f.include?(k)
+  end
+
+  # method called only from files within plugins directory
+  # return the plugin model for current site
+  def current_plugin
+    current_site.get_plugin(self_plugin_key)
+  end
+
+end

data/app/helpers/session_helper.rb

@@ -0,0 +1,108 @@
+=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 SessionHelper
+
+  # log in the user in to system
+  # user: User model
+  # remember_me: true/false (remember session permanently)
+  def login_user(user, remember_me = false, redirect_url = nil)
+    c = {value: [user.auth_token, request.user_agent, request.ip], expires: 24.hours.from_now }
+    # c[:domain] = :all if PluginRoutes.system_info["users_share_sites"].present? && Site.main_site.get_meta("share_sessions", true) && !cookies[:login].present?
+    c[:domain] = :all if PluginRoutes.system_info["users_share_sites"].present? && Site.count > 1
+    c[:expires] = 1.month.from_now if remember_me
+
+    Site.main_site.set_meta("share_sessions", false) if cookies.delete(:login).present?
+    user.update({last_login_at: Time.zone.now})
+
+    cookies[:auth_token] = c
+    cookies[:login] = true
+
+    # user redirection
+    flash[:notice] = t('admin.login.message.success', locale: current_site.get_admin_language)
+    if redirect_url.present?
+      redirect_to redirect_url
+    elsif (return_to = cookies.delete(:return_to)).present?
+      redirect_to return_to
+    else
+      redirect_to admin_dashboard_path
+    end
+  end
+
+  # check if current host is heroku
+  def on_heroku?
+    ENV.keys.any? {|var_name| var_name.match(/(heroku|dyno)/i) }
+  end
+
+  # switch current session user into other (user)
+  # after switched, this will be redirected to redirect_url or admin dashboard
+  def session_switch_user(user, redirect_url = nil)
+    if signin?
+      cookies[:parent_auth_token] = cookies[:auth_token]
+      login_user(user, false, redirect_url)
+    end
+  end
+
+  # switch current session into parent session called by session_switch_user
+  # after returned into parent session, this will be redirected to redirect_url or admin dashboard
+  def session_back_to_parent(redirect_url = nil)
+    if signin? && cookies[:parent_auth_token].present?
+      cookies[:auth_token] = cookies[:parent_auth_token]
+      redirect_to (redirect_url||admin_dashboard_path), notice: "Welcome back!"
+    end
+  end
+
+  # logout current user
+  def logout_user
+    cookies.delete(:auth_token, domain: :all)
+    cookies.delete(:auth_token, domain: nil)
+    cookies[:auth_token] = {value: nil, expires: 24.hours.ago, domain: (PluginRoutes.system_info["users_share_sites"] && Site.count > 1 ? :all : nil)}
+    cookies.delete :login
+    redirect_to params[:return_to].present? ? params[:return_to] : admin_login_path, :notice => t('admin.logout.message.closed')
+  end
+
+  # check if current user is already signed
+  def signin?
+    !current_user.nil?
+  end
+
+  # return the role for current user
+  # if not logged in, then return 'public'
+  def current_role
+    (signin?)? current_user.role : 'public'
+  end
+
+  # return current user logged in
+  def current_user
+    return @current_user if defined?(@current_user)
+    return nil unless cookies[:auth_token].present?
+    c = cookies[:auth_token].split("&")
+    return nil unless c.size == 3
+
+    if c[1] == request.user_agent && request.ip == c[2]
+      @current_user = (current_site.users_include_admins.find_by_auth_token(c[0]).decorate rescue nil)
+    end
+  end
+
+  # check if a visitor was logged in
+  # if the user was not logged in, then redirect to login url
+  def authenticate(redirect_uri = nil)
+    params[:return_to] = redirect_uri
+    unless signin?
+      flash[:error] = "Required Login"
+      cookies[:return_to] = params[:return_to].present? ? params[:return_to] : ((request.get? && params[:controller] != "admin/sessions") ? request.original_url : nil)
+      redirect_to admin_login_path
+    end
+  end
+
+  # return the session id
+  def get_session_id
+    session[:autor] = "Owen Peredo Diaz" unless request.session_options[:id].present?
+    request.session_options[:id]
+  end
+end

data/app/helpers/short_code_helper.rb

@@ -0,0 +1,82 @@
+=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 ShortCodeHelper
+
+  # Internal method
+  def shortcodes_init
+    @_shortcodes = ["widget"]
+    @_shortcodes_template = {}
+    @_shortcodes_descr = {}
+  end
+
+  # add shortcode
+  # key: chortcode key
+  # template: template to render, if nil will render "shortcode_templates/<key>"
+  # descr: description for shortcode
+  def shortcode_add(key, template = nil, descr = '')
+    @_shortcodes << key
+    @_shortcodes_template = @_shortcodes_template.merge({"#{key}"=> template}) if template.present?
+    @_shortcodes_descr[key] = descr if descr.present?
+  end
+
+  # add or update shortcode template
+  # key: chortcode key to add or update
+  # template: template to render, if nil will render "shortcode_templates/<key>"
+  def shortcode_change_template(key, template = nil)
+    @_shortcodes_template[key] = template
+  end
+
+  # delete shortcode
+  # key: chortcode key to delete
+  def shortcode_delete(key)
+    @_shortcodes.delete(key)
+  end
+
+  # run all shortcodes in the content
+  # content: (string) text to find a short codes
+  # args: custom arguments to pass for short codes render, sample: {owner: my_model, a: true}
+    # if args != Hash, this will re send as args = {owner: args}
+  def do_shortcode(content, args = {})
+    args = {owner: args} unless args.is_a?(Hash)
+    content.scan(/(\[(#{@_shortcodes.join("|")})\s?(.*?)\])/) do |item|
+      shortcode, code, attrs = item
+      res = render :file => (@_shortcodes_template[code].present? ? @_shortcodes_template[code] : "shortcode_templates/#{code}"), :locals => {attributes: _shortcode_parse_attr(attrs), args: args}
+      content = content.sub(shortcode, res)
+    end
+    content
+  end
+
+  # render direct a shortcode
+  # template: custom template to be rendered for this short code
+  # sample: render_shortcode("[slider_basic as]")
+  # sample2: render_shortcode("[slider_basic as]", theme_view("custom_slider"))
+  def render_shortcode(shortcode, template = nil)
+    shortcode, code, attrs = shortcode.scan(/(\[(#{@_shortcodes.join("|")})\s?(.*?)\])/).first
+    template ||= (@_shortcodes_template[code].present? ? @_shortcodes_template[code] : "shortcode_templates/#{code}")
+    render :file => template, :locals => {attributes: _shortcode_parse_attr(attrs)}
+  end
+
+  private
+  def _shortcode_parse_attr(text)
+    res = {}
+    return res unless text.present?
+    text.scan(/(\w+)\s*=\s*"([^"]*)"(?:\s|$)|(\w+)\s*=\s*\'([^\']*)\'(?:\s|$)|(\w+)\s*=\s*([^\s\'"]+)(?:\s|$)|"([^"]*)"(?:\s|$)|(\S+)(?:\s|$)/).each do |item|
+      item.each_with_index do |c, index|
+        if c.present?
+          res[c] = item[index+1]
+          break
+        end
+      end
+    end
+    res
+  end
+
+
+
+end

data/app/helpers/site_helper.rb

@@ -0,0 +1,124 @@
+=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 SiteHelper
+
+  # return current site or assign a site as a current site
+  def current_site(site = nil)
+    @current_site = site.decorate if site.present?
+    return $current_site if defined?($current_site)
+    return @current_site if defined?(@current_site)
+    all_sites = Site.all
+    if all_sites.size == 1
+      site = all_sites.first.decorate
+    else
+      host = request.original_url.to_s.parse_domain
+      if host == PluginRoutes.system_info["base_domain"]
+        site = Site.first.decorate rescue nil
+      else
+        s = [host]
+        s << request.subdomain if request.subdomain.present?
+        site = Site.where(slug: s).first.decorate rescue nil
+      end
+    end
+    puts "============================ Please define the $current_site = Site.first.decorate " unless site.present?
+    @current_site = site
+  end
+
+  # initialize ability for current user
+  def current_ability
+    @current_ability ||= Ability.new(current_user, current_site)
+  end
+
+  # check if current site exist, if not, this will be redirected to main domain
+  def site_check_existence()
+    if !current_site.present?
+      if (site = Site.first).present?
+        base_domain = PluginRoutes.system_info["base_domain"]
+        redirect_to root_url(host: base_domain.split(":").first, port: (base_domain.split(":")[1] rescue nil))
+      else
+        redirect_to admin_installers_path
+      end
+    end
+  end
+
+  # return current theme model for current site
+  def current_theme
+    @_current_theme ||= current_site.get_theme.decorate
+  end
+
+  # get list templates files
+  def get_list_template_files
+    base_path = Rails.root.join("app", "apps", 'themes', current_theme.slug, 'views')
+    base_path = Pathname.new(base_path)
+    contained_files = []
+    Dir[File.join(base_path, '*.html.erb')].each do |full_path|
+      path = Pathname.new(full_path).relative_path_from(base_path).to_s
+      contained_files << path if path.include?('template_')
+    end
+    contained_files
+  end
+
+  # get locale language
+  def current_locale
+    I18n.locale.to_s
+  end
+
+  #***************** administration HELPERS ***********************
+  # do common actions after site installation
+  # theme_key: theme slug of the theme for site
+  def site_after_install(site, theme_key = nil)
+    theme_key ||= site.get_theme_slug
+    _s = current_site
+    current_site(site)
+    PluginRoutes.system_info[:default_plugins].each{|p| plugin_install(p) } # auto install plugins
+    site_install_theme(theme_key)
+    current_site(_s)
+  end
+
+  # install theme for current site
+  def site_install_theme(key)
+    #uninstall previous theme
+    site_uninstall_theme()
+
+    # new theme
+    current_site.set_option('_theme', key)
+    theme = PluginRoutes.theme_info(key)
+    theme_model = current_site.themes.where(slug: key).first_or_create!{|t| t.name = theme[:name]; }
+    hook_run(theme, "on_active", theme_model)
+    PluginRoutes.reload
+  end
+
+  # uninstall current theme form current site
+  def site_uninstall_theme()
+    key = current_site.get_theme_slug
+    theme = PluginRoutes.theme_info(key)
+    theme_model = current_site.get_theme(key)
+    hook_run(theme, "on_inactive", theme_model) if theme_model.present?
+    theme_model.destroy
+  end
+
+
+  # load all custom models customized by plugins or templates in custom_models.rb
+  def site_load_custom_models(site)
+    PluginRoutes.enabled_apps(site).each{ |app|
+      s = File.join(app["path"], "config", "custom_models.rb")
+      require_relative s if File.exist?(s)
+    }
+  end
+
+  #################### ONLY FOR CONSOLE ####################
+  # switch console sessions and redefine current for the console session
+  # site: Site model used as current site
+  # return nil
+  def site_console_switch(site = nil)
+    $current_site = site
+    site_load_custom_models($current_site)
+  end
+
+end

data/app/helpers/theme_helper.rb

@@ -0,0 +1,51 @@
+=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 ThemeHelper
+
+  def theme_init()
+    @_front_breadcrumb = []
+  end
+
+  # assign the layout for this request
+  # asset: asset file name, if asset is present return full path to this asset
+  # layout_name: layout name
+  def theme_layout(layout_name, theme_name = nil)
+    path = "#{theme_name || current_theme.slug}/views/layouts/#{layout_name}"
+    self.class.send(:layout, path)
+    path
+  end
+
+  # return theme full asset path
+  # theme_name: theme name, if nil, then will use current theme
+  # asset: asset file name, if asset is present return full path to this asset
+  # sample: <script src="<%= theme_asset_path("js/admin.js") %>"></script>
+  def theme_asset_path(asset = nil, theme_name = nil)
+    # "#{root_url(locale: nil)}assets/themes/#{theme_name || current_theme.slug }/assets/#{asset}"
+    "themes/#{theme_name || current_theme.slug }/assets/#{asset}"
+  end
+
+  # return theme full view path
+  # theme_key: theme folder name
+  # view_name: name of the view or template
+  def theme_view(theme_key, view_name)
+    begin
+      p = "themes/" if request.env['PATH_INFO'].start_with?("/admin")
+    rescue
+      p = ""
+    end
+    "#{p if p.present?}#{theme_key}/views/#{view_name}"
+  end
+
+  # return theme key for current theme file (helper|controller|view)
+  def self_theme_key
+    k = "app/apps/themes/"
+    f = caller.first
+    f.split(k).last.split("/").first if f.include?(k)
+  end
+end