Class: Caboose::Page

Inherits:
ActiveRecord::Base
  • Object
show all
Defined in:
app/models/caboose/page.rb

Constant Summary collapse

CONTENT_FORMAT_HTML = 
1
CONTENT_FORMAT_TEXT = 
2
CONTENT_FORMAT_RUBY = 
3

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.crumb_trail(page) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'app/models/caboose/page.rb', line 202

def self.crumb_trail(page)
  page_id = page.is_a?(Integer) ? page : page.id
  
  arr = []
  self.crumb_trail_helper(page_id, arr)
  arr.reverse!
  
  trail = arr.collect do |row|
    Caboose::StdClass.new({
      'href' => !row.uri.nil? && row.uri.length > 0 ? row.uri : '/',
      'text' => !row.menu_title.nil? && row.menu_title.length > 0 ? row.menu_title : row.title
    })
  end
  return trail
end

.crumb_trail_helper(page_id, arr) ⇒ Object 



218
219
220
221
222
223
224
 
# File 'app/models/caboose/page.rb', line 218

def self.crumb_trail_helper(page_id, arr)
  return if page_id.nil? || page_id <= 0
  p = self.find_with_fields(page_id, [:parent_id, :title, :menu_title, :uri])   
  return if p.nil?
  arr << p
  self.crumb_trail_helper(p.parent_id, arr)
end

.find_with_fields(page_id, fields) ⇒ Object 



51
52
53
 
# File 'app/models/caboose/page.rb', line 51

def self.find_with_fields(page_id, fields)
  return self.where(:id => page_id).select(fields).first
end

.has_children(page_id) ⇒ Object 



306
307
308
309
 
# File 'app/models/caboose/page.rb', line 306

def self.has_children(page_id)
  count = self.where(:parent_id => page_id).count
  return count > 0
end

.index_page ⇒ Object 



55
56
57
 
# File 'app/models/caboose/page.rb', line 55

def self.index_page
  return self.where(:parent_id => -1).first
end

.is_allowed(user, page_id, action) ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'app/models/caboose/page.rb', line 146

def self.is_allowed(user, page_id, action)
  user = User.logged_out_user if user.nil?

  # Allow a user id to be sent instead of a user object
  user = User.find(user) if user.is_a?(Integer)
  user.role_ids = [Role.logged_out_role_id] if user.role_ids.nil?

  t = PagePermission.table    
  reqs = nil
  user.role_ids.each do |role_id|
    if (reqs.nil?)
      reqs = t[:role_id].eq(role_id)
    else
      reqs.or(t[:role_id].eq(role_id))
    end
  end 
  var params = { :page_id => page_id, :action => action }
  params << reqs if !reqs.nil?
  count = PagePermission.where(params).count
  
  return true if count > 0
  return false
end

.is_child(parent_id, child_id) ⇒ Object 



311
312
313
314
315
316
 
# File 'app/models/caboose/page.rb', line 311

def self.is_child(parent_id, child_id)
  pid = self.where(:id => child_id).limit(1).pluck(:parent_id)[0]
  return false if pid.nil? || pid <= 0
  return true if pid == parent_id
  return self.is_child(parent_id, pid)
end

.page_ids_with_permission(user, action) ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'app/models/caboose/page.rb', line 188

def self.page_ids_with_permission(user, action)
  if (user.is_a?(Integer))
    user = Caboose::User.find(user)
  end
  ids = []
  user.roles.each do |role|     
    ids + Caboose::PagePermission.where({
        :role_id => role.id,
        :action => action
      }).pluck(:page_id)
  end
  return ids.uniq
end

.page_with_uri(uri, get_closest_parent = true) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'app/models/caboose/page.rb', line 59

def self.page_with_uri(uri, get_closest_parent = true)

  uri = uri.to_s.gsub(/^(.*?)\?.*?$/, '\1')
  uri.chop! if uri.end_with?('/')
  uri[0] = '' if uri.starts_with?('/')
    
  return self.index_page if uri.length == 0

  page = false
  parts = uri.split('/')
    
  # See where to start looking
  page_ids = self.where(:alias => parts[0]).limit(1).pluck(:id)
  page_id = !page_ids.nil? && page_ids.count > 0 ? page_ids[0] : false
  
  # Search for the page
  if (page_id)
    page_id = self.page_with_uri_helper(parts, 1, page_id)
  else
    parent_id = self.index_page
    page_id = self.page_with_uri_helper(parts, 0, parent_id)
  end
  
  return false if page_id.nil?
      
  page = self.find(page_id)
  
  if (!get_closest_parent) # // Look for an exact match
    return false if page.uri != uri
  end
  return page   
end

.page_with_uri_helper(parts, level, parent_id) ⇒ Object 



92
93
94
95
96
97
98
 
# File 'app/models/caboose/page.rb', line 92

def self.page_with_uri_helper(parts, level, parent_id)
  return parent_id if level >= parts.count
  slug = parts[level]   
  page_ids = self.where(:parent_id => parent_id, :slug => slug).limit(1).pluck(:id)
  return parent_id if page_ids.nil? || page_ids.count == 0    
  return self.page_with_uri_helper(parts, level+1, page_ids[0])       
end

.permissible_actions(user, page_id) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'app/models/caboose/page.rb', line 174

def self.permissible_actions(user, page_id)
  if (user.is_a?(Integer))
    user = Caboose::User.find(user)
  end
  actions = []
  user.roles.each do |role|
    actions + Caboose::PagePermission.where({
        :role_id => role.id, 
        :page_id => page_id
      }).pluck(:action)
  end
  return actions.uniq
end

.roles_with_permission(page_id, action) ⇒ Object 



170
171
172
 
# File 'app/models/caboose/page.rb', line 170

def self.roles_with_permission(page_id, action)
  return Role.roles_with_page_permission(page_id, action)
end

.slug(str) ⇒ Object 



302
303
304
 
# File 'app/models/caboose/page.rb', line 302

def self.slug(str)
  return str.downcase.gsub(' ', '-').gsub(/[^\w-]/, '')
end

.subnav(page, use_redirect_urls = true, user = false) ⇒ Object 



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'app/models/caboose/page.rb', line 226

def self.subnav(page, use_redirect_urls = true, user = false)
  
  # Be nice and allow page ids to be sent
  if (page.is_a?(Integer)) 
    page = self.find_with_fields(page, [:title, :menu_title, :custom_sort_children])
  end
  
  block = Caboose::MenuBlock.new
  block.title = !page.menu_title.nil? && page.menu_title.length > 0 ? page.menu_title : page.title
  block.title_id = page.id
                 
  pages = self.select([:id, :title, :menu_title, :alias, :slug, :uri, :redirect_url, :sort_order]).where(:parent_id => page.id, :hide => false).reorder(:sort_order).all
  if (page.custom_sort_children)
    pages.sort! {|x,y| x.sort_order <=> y.sort_order }
  else
    pages.sort! {|x,y| x.order_title <=> y.order_title }
  end
    
  if (pages.nil? || pages.count == 0) # No children, go up a level  
    parent = self.find_with_fields(page.parent_id, [:title, :menu_title, :custom_sort_children])
    return block if parent.nil? # If we happen to be at the top page
    
    block.title = !parent.menu_title.nil? && parent.menu_title.length > 0 ? parent.menu_title : parent.title
    block.title_id = parent.id
    
    pages = self.select([
        :id, :title, :menu_title, :alias, :slug, :uri, :redirect_url, :sort_order
      ]).where(:parent_id => page.parent_id, :hide => false)
    if (parent.custom_sort_children)
      pages.sort! {|x,y| x.sort_order <=> y.sort_order }
    else
      pages.sort! {|x,y| x.order_title <=> y.order_title }    
    end
  end
  
  block.links = []
  pages.each do |p|
    link = Caboose::StdClass.new({
      'href' => !p.redirect_url.nil? && p.redirect_url.length > 0 ? p.redirect_url : p.uri,
      'text' => !p.menu_title.nil? && p.menu_title.length > 0 ? p.menu_title : p.title,
      'is_current' => p.id == page.id
    })
    if (!use_redirect_urls && self.is_allowed(user, p.id, 'edit'))
      link.href = row.uri
    end 
    block.links << link
  end    
  return block
end

.update_authorized_for_action(page_id, action, roles) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'app/models/caboose/page.rb', line 131

def self.update_authorized_for_action(page_id, action, roles)
  Caboose::PagePermission.where(:page_id => page_id, :action => action).destroy_all
  if (!roles.nil?)
    roles.each do |role|
      role_id = role.is_a?(Integer) ? role : role.id
      Caboose::PagePermission.create({
        :page_id => page_id,
        :role_id => role_id,
        :action => action
      })
    end
  end
  return true
end

.update_child_perms(page_id) ⇒ Object 



111
112
113
114
115
116
117
118
119
 
# File 'app/models/caboose/page.rb', line 111

def self.update_child_perms(page_id)
  page = self.find(page_id)
    
  viewers_ids   = Role.roles_with_page_permission(page_id, 'view').collect {|r| r.id }
  editors_ids   = Role.roles_with_page_permission(page_id, 'edit').collect {|r| r.id }
  approvers_ids = Role.roles_with_page_permission(page_id, 'approve').collect {|r| r.id }   
  
  self.update_child_perms_helper(page, viewer_ids, editor_ids, approver_ids)
end

.update_child_perms_helper(page, viewer_ids, editor_ids, approver_ids) ⇒ Object 



121
122
123
124
125
126
127
128
129
 
# File 'app/models/caboose/page.rb', line 121

def self.update_child_perms_helper(page, viewer_ids, editor_ids, approver_ids)
  self.update_authorized_for_action(page.id, 'view'     , viewer_ids)
  self.update_authorized_for_action(page.id, 'edit'     , editor_ids)
  self.update_authorized_for_action(page.id, 'approve'  , approver_ids)

  page.children.each do |kid|
    self.update_child_perms_helper(kid, viewer_ids, editor_ids, approver_ids)
  end
end

.update_uri(page) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
 
# File 'app/models/caboose/page.rb', line 100

def self.update_uri(page)
  #return if page.redirect_url && page.redirect_url.length > 0
  
  page.slug = self.slug(page.title) if page.slug.nil? || page.slug.strip.length == 0
  page.uri = page.alias && page.alias.strip.length > 0 ? page.alias : (page.parent ? "#{page.parent.uri}/#{page.slug}" : "#{page.slug}")
  page.uri[0] = '' if page.uri.starts_with?('/')
  page.save
  
  page.children.each { |p2| self.update_uri(p2) }     
end

.url(page_id) ⇒ Object 



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'app/models/caboose/page.rb', line 276

def self.url(page_id)
  arr = []
  self.url_helper(page_id, arr)
  arr.reverse!
  
  path = []      
  arr.each do |row|
    if (row.alias.length > 0)
      path = [row.alias]
    elsif (row.slug.length > 0)
      path << row.slug
    end
  end
  return path.join('/')
end

.url_helper(page_id, arr) ⇒ Object 



292
293
294
295
296
297
298
299
300
 
# File 'app/models/caboose/page.rb', line 292

def self.url_helper(page_id, arr)
  return if page_id <= 0
  
  p = self.find_with_fields(page_id, [:id, :parent_id, :title, :menu_title, :alias, :slug])
  return if p.nil?

  arr << p
  self.url_helper(p.parent_id, arr)
end

Instance Method Details

#blocks ⇒ Object 



42
43
44
 
# File 'app/models/caboose/page.rb', line 42

def blocks
  self.page_blocks
end

#content ⇒ Object 



46
47
48
49
 
# File 'app/models/caboose/page.rb', line 46

def content
  return "" if self.blocks.nil? || self.blocks.count == 0
  self.blocks.collect { |b| b.render }.join("\n")     
end

#linked_resources_map ⇒ Object 



318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'app/models/caboose/page.rb', line 318

def linked_resources_map
  resources = { js: [], css: [] }
  return resources if self.linked_resources.nil?
  self.linked_resources.each_line do |r|
    r.chomp!
    case r
    when /\.js$/
      resources[:js] << r
    when /\.css$/
      resources[:css] << r
    end
  end
  return resources
end

#order_title ⇒ Object 



35
36
37
38
39
40
 
# File 'app/models/caboose/page.rb', line 35

def order_title
  return "" + menu_title + title unless menu_title.nil? || title.nil?
  return menu_title unless menu_title.nil?
  return title unless title.nil?
  return ""
end