Class: PluginRoutes

Inherits:
Object
  • Object
show all
Defined in:
lib/plugin_routes.rb,
lib/generators/camaleon_cms/install_template/plugin_routes.rb

Constant Summary collapse

@@_vars = 
[]
@@_after_reload = 
[]

Class Method Summary collapse

Class Method Details

.add_after_reload_routes(command) ⇒ Object

permit to add extra actions for reload routes



122
123
124
 
# File 'lib/plugin_routes.rb', line 122

def self.add_after_reload_routes(command)
  @@_after_reload << command
end

.all_apps ⇒ Object

return all apps loaded



316
317
318
 
# File 'lib/plugin_routes.rb', line 316

def self.all_apps
  all_plugins+all_themes
end

.all_enabled_apps ⇒ Object

return all enabled apps as []: system, themes, plugins



150
151
152
 
# File 'lib/plugin_routes.rb', line 150

def self.all_enabled_apps
  [system_info] + all_enabled_themes + all_enabled_plugins
end

.all_enabled_plugins ⇒ Object

return all enabled plugins (a theme is enabled if at least one site has installed)



166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/plugin_routes.rb', line 166

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_enabled_themes ⇒ Object

return all enabled themes (a theme is enabled if at least one site is assigned)



155
156
157
158
159
160
161
162
163
 
# File 'lib/plugin_routes.rb', line 155

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

.all_helpers ⇒ Object

all helpers of enabled plugins



190
191
192
193
194
195
196
197
198
 
# File 'lib/plugin_routes.rb', line 190

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

.all_locales ⇒ Object

return all locales for all sites joined by |



237
238
239
240
241
242
243
244
 
# File 'lib/plugin_routes.rb', line 237

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

.all_locales_for_routes ⇒ Object

return all locales for translated routes



253
254
255
256
257
258
259
260
261
 
# File 'lib/plugin_routes.rb', line 253

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

.all_plugins ⇒ Object

return all plugins located in cms and in this project



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/plugin_routes.rb', line 269

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

.all_themes ⇒ Object

return an array of all themes installed for all sites



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/plugin_routes.rb', line 292

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

.all_translations(key, *args) ⇒ Object

return all translations for all languages, sample: [‘Sample’, ‘Ejemplo’, ‘.…’]



247
248
249
250
 
# File 'lib/plugin_routes.rb', line 247

def self.all_translations(key, *args)
  args = args.extract_options!
  all_locales.split('|').map{|_l| I18n.t(key, args.merge({locale: _l})) }.uniq
end

.apps_dir ⇒ Object

return apps directory path



264
265
266
 
# File 'lib/plugin_routes.rb', line 264

def self.apps_dir
  Rails.root.join("app", "apps").to_s
end

.cache_variable(var_name, value = nil) ⇒ Object 



212
213
214
215
216
217
218
219
220
 
# File 'lib/plugin_routes.rb', line 212

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

.db_installed? ⇒ Boolean

check if db migrate already done

Returns:

  • (Boolean) 


232
233
234
 
# File 'lib/plugin_routes.rb', line 232

def self.db_installed?
  @@is_db_installed ||= ActiveRecord::Base.connection.table_exists?(CamaleonCms::Site.table_name)
end

.default_url_options ⇒ Object

return the default url options for Camaleon CMS



373
374
375
 
# File 'lib/plugin_routes.rb', line 373

def self.default_url_options
  {host: (CamaleonCms::Site.main_site.slug rescue "")}
end

.destroy_plugin(plugin_key) ⇒ Object

destroy plugin



201
202
203
204
 
# File 'lib/plugin_routes.rb', line 201

def self.destroy_plugin(plugin_key)
  FileUtils.rm_r(Rails.root.join("app", "apps", "plugins", plugin_key)) rescue ""
  PluginRoutes.reload
end

.destroy_theme(theme_key) ⇒ Object

destroy theme



207
208
209
210
 
# File 'lib/plugin_routes.rb', line 207

def self.destroy_theme(theme_key)
  FileUtils.rm_r(Rails.root.join("app", "apps", "themes", theme_key)) rescue ""
  PluginRoutes.reload
end

.draw_gems ⇒ Object

draw “all” gems registered for the plugins or themes and camaleon gems



4
5
6
7
8
9
10
11
12
13
14
 
# File 'lib/generators/camaleon_cms/install_template/plugin_routes.rb', line 4

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

.enabled_apps(site, theme_slug = nil) ⇒ Object

return all enabled apps for site (themes + system + plugins) [] theme_slug: current theme slug



141
142
143
144
145
146
147
 
# File 'lib/plugin_routes.rb', line 141

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

.enabled_plugins(site) ⇒ Object

return all enabled plugins []



127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/plugin_routes.rb', line 127

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

.fixActionParameter(h) ⇒ Object

convert action parameter into hash



108
109
110
 
# File 'lib/plugin_routes.rb', line 108

def fixActionParameter(h)
  (h.is_a?(ActionController::Parameters) ? (h.permit!.to_h rescue h.to_hash) : h)
end

.get_gem(name) ⇒ Object

check if a gem is available or not Arguemnts: name: name of the gem return (Boolean) true/false



364
365
366
367
368
369
370
 
# File 'lib/plugin_routes.rb', line 364

def self.get_gem(name)
  Gem::Specification.find_by_name(name)
rescue Gem::LoadError
  false
rescue
  Gem.available?(name)
end

.get_gem_plugins ⇒ Object

return all plugins registered as gems



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/plugin_routes.rb', line 321

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

.get_gem_themes ⇒ Object

return all themes registered as gems



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/plugin_routes.rb', line 342

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

.get_sites ⇒ Object

return all sites registered for Plugin routes



223
224
225
226
227
228
229
 
# File 'lib/plugin_routes.rb', line 223

def self.get_sites
  begin
    @@all_sites ||= CamaleonCms::Site.order(id: :asc).all.to_a
  rescue
    []
  end
end

.isRails4? ⇒ Boolean

Returns:

  • (Boolean) 


100
101
102
 
# File 'lib/plugin_routes.rb', line 100

def isRails4?
  Rails.version.to_s[0].to_i == 4
end

.isRails5? ⇒ Boolean

Returns:

  • (Boolean) 


104
105
106
 
# File 'lib/plugin_routes.rb', line 104

def isRails5?
  Rails.version.to_s[0].to_i == 5
end

.load(env = "admin") ⇒ Object

load plugin routes if it is enabled



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/plugin_routes.rb', line 6

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

.load_themes(env = "admin") ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/plugin_routes.rb', line 36

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

.migration_class ⇒ Object 



377
378
379
 
# File 'lib/plugin_routes.rb', line 377

def self.migration_class
  isRails4? ? ActiveRecord::Migration : ActiveRecord::Migration[4.2]
end

.plugin_info(plugin_key) ⇒ Object

return plugin information



68
69
70
71
 
# File 'lib/plugin_routes.rb', line 68

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

.reload ⇒ Object

reload routes



114
115
116
117
118
119
 
# File 'lib/plugin_routes.rb', line 114

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

.site_plugin_helpers(site) ⇒ Object

all helpers of enabled plugins for site



180
181
182
183
184
185
186
187
 
# File 'lib/plugin_routes.rb', line 180

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

.static_system_info ⇒ Object Also known as: system_info

return system static settings (config.json values)



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/plugin_routes.rb', line 81

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"] = (settings["hooks"]["on_notification"] || []) + ["admin_system_notifications"]
  cache_variable("statis_system_info", settings)
end

.theme_info(theme_name) ⇒ Object

return theme information if theme_name is nil, the use current site theme



75
76
77
78
 
# File 'lib/plugin_routes.rb', line 75

def theme_info(theme_name)
  self.all_themes.each{|p| return p if p["key"] == theme_name }
  nil
end