Class: Caboose::ApplicationController

Inherits:
ActionController::Base
  • Object
show all
Defined in:
app/controllers/caboose/application_controller.rb

Instance Method Summary collapse

Instance Method Details

#add_ga_event(cat, action, label = nil, value = nil) ⇒ Object 



83
84
85
86
87
88
89
 
# File 'app/controllers/caboose/application_controller.rb', line 83

def add_ga_event(cat, action, label = nil, value = nil)
  # Category String Required  Typically the object that was interacted with (e.g. button)
  # Action   String Required  The type of interaction (e.g. click)
  # Label    String Option    Useful for categorizing events (e.g. nav buttons)
  # Value    Number Option    Values must be non-negative. Useful to pass counts (e.g. 4 times)
  @ga_events << [cat, action, label, value]
end

#admin_add ⇒ Object 



263
 
# File 'app/controllers/caboose/application_controller.rb', line 263

def admin_add()         raise 'This method should be overridden.' end

#admin_bulk_add ⇒ Object 



264
 
# File 'app/controllers/caboose/application_controller.rb', line 264

def admin_bulk_add()    raise 'This method should be overridden.' end

#admin_bulk_delete ⇒ Object 



266
 
# File 'app/controllers/caboose/application_controller.rb', line 266

def admin_bulk_delete() raise 'This method should be overridden.' end

#admin_bulk_update ⇒ Object 



262
 
# File 'app/controllers/caboose/application_controller.rb', line 262

def admin_bulk_update() raise 'This method should be overridden.' end

#admin_delete ⇒ Object 



265
 
# File 'app/controllers/caboose/application_controller.rb', line 265

def admin_delete()      raise 'This method should be overridden.' end

#admin_edit ⇒ Object 



260
 
# File 'app/controllers/caboose/application_controller.rb', line 260

def admin_edit()        raise 'This method should be overridden.' end

#admin_index ⇒ Object

Standard methods used by model binder



257
 
# File 'app/controllers/caboose/application_controller.rb', line 257

def admin_index()       raise 'This method should be overridden.' end

#admin_json ⇒ Object 



258
 
# File 'app/controllers/caboose/application_controller.rb', line 258

def admin_json()        raise 'This method should be overridden.' end

#admin_json_single ⇒ Object 



259
 
# File 'app/controllers/caboose/application_controller.rb', line 259

def admin_json_single() raise 'This method should be overridden.' end

#admin_update ⇒ Object 



261
 
# File 'app/controllers/caboose/application_controller.rb', line 261

def admin_update()      raise 'This method should be overridden.' end

#before_action ⇒ Object

To be overridden by the child controllers



111
112
 
# File 'app/controllers/caboose/application_controller.rb', line 111

def before_action      
end

#before_before_action ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'app/controllers/caboose/application_controller.rb', line 11

def before_before_action            
  # Modify the built-in params array with URL params if necessary
  parse_url_params if Caboose.use_url_params
  
  @use_page_cache = !request.fullpath.starts_with?('/admin')
        
  # Get the site we're working with      
  domain = Domain.where(:domain => request.host_with_port).first
  @site = domain ? domain.site : nil
    
  # Make sure someone is logged in
  if !logged_in?      
    elo = User.find(User::LOGGED_OUT_USER_ID)        
    (elo)
  end
  
  session['use_redirect_urls'] = true if session['use_redirect_urls'].nil?
  
  # Initialize AB Testing
  AbTesting.init(request.session_options[:id]) if Caboose.use_ab_testing            
  
  # Try to find the page
  @request = request
  @page = Page.new
  @crumbtrail = Crumbtrail.new      
  @subnav       = {}
  @actions      = {}
  @tasks        = {}
  @page_tasks   = {}
  @is_real_page = false
  @ga_events    = []
  
  #if @find_page
    @page = Page.page_with_uri(request.host_with_port, request.fullpath)
    @crumb_trail  = Caboose::Page.crumb_trail(@page)		    
  #end
  
  # Sets an instance variable of the logged in user
  @logged_in_user = logged_in_user  
  
  # Initialize the card
  init_cart if @site && @site.use_store && !domain.under_construction
  
  before_action
end

#hashify_query_string ⇒ Object

Redirects/Converts querystrings into hashes



248
249
250
251
252
253
254
 
# File 'app/controllers/caboose/application_controller.rb', line 248

def hashify_query_string
  if request.query_string && request.query_string.length > 0
    redirect_to request.url.gsub('?', '#')
    return true
  end
  return false
end

#init_cart ⇒ Object

Initialize the cart in the session



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'app/controllers/caboose/application_controller.rb', line 58

def init_cart            
  # Check if the cart ID is defined and that it exists in the database
  create_new_order = false
  if session[:cart_id]
    @order = Caboose::Order.where(:id => session[:cart_id]).first
    create_new_order = true if @order.nil? || @order.status != 'cart'                    
  else                        
    create_new_order = true                         
  end

  if create_new_order # Create an order to associate with the session        
    @order = Caboose::Order.new        
    @order.site_id          = @site ? @site.id : nil
    @order.status           = Caboose::Order::STATUS_CART
    @order.financial_status = Caboose::Order::STATUS_PENDING
    @order.date_created     = DateTime.now
    @order.referring_site   = request.env['HTTP_REFERER']
    @order.landing_page     = request.fullpath
    @order.landing_page_ref = params[:ref] || nil
    @order.save
    # Save the cart ID in the session
    session[:cart_id] = @order.id
  end                  
end

#logged_in? ⇒ Boolean

Returns whether or not a user is logged in

Returns:

  • (Boolean) 


128
129
130
131
132
133
 
# File 'app/controllers/caboose/application_controller.rb', line 128

def logged_in?
  validate_token
  validate_cookie
  return true if !session["app_user"].nil? && session["app_user"] != false && session["app_user"].id != -1 && session["app_user"].id != User::LOGGED_OUT_USER_ID     
  return false
end

#logged_in_user ⇒ Object

Returns the currently logged in user



159
160
161
162
163
164
165
 
# File 'app/controllers/caboose/application_controller.rb', line 159

def logged_in_user
  if (!logged_in?)
    return User.logged_out_user
  end
  #return nil if !logged_in?
  return session["app_user"]
end

#login_user(user, remember = false) ⇒ Object

Logs in a user



122
123
124
125
 
# File 'app/controllers/caboose/application_controller.rb', line 122

def (user, remember = false)
  session["app_user"] = user
  cookies.permanent[:caboose_user_id] = user.id if remember
end

#logout_user ⇒ Object

Logs a user out



115
116
117
118
119
 
# File 'app/controllers/caboose/application_controller.rb', line 115

def logout_user
  cookies.delete(:caboose_user_id)
  session["app_user"] = nil
  reset_session
end

#parse_url_params ⇒ Object

Parses any parameters in the URL and adds them to the params



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'app/controllers/caboose/application_controller.rb', line 92

def parse_url_params      
  return if !Caboose.use_url_params      
  url = "#{request.fullpath}"
  url[0] = "" if url.starts_with?('/')      
  url = url.split('?')[0] if url.include?('?')      
  arr = url.split('/')      
  i = arr.count - 1
  while i >= 1 do
    k = arr[i-1]
    v = arr[i]    
    if v && v.length > 0
      v = v.gsub('%20', ' ')
      params[k] = v
    end
    i = i-2
  end      
end

#reject_param(url, param) ⇒ Object

Removes a given parameter from a URL querystring



225
226
227
228
229
230
231
232
 
# File 'app/controllers/caboose/application_controller.rb', line 225

def reject_param(url, param)
  arr = url.split('?')
  return url if (arr.count == 1)
  qs = arr[1].split('&').reject { |pair| pair.split(/[=;]/).first == param }
  url2 = arr[0]
  url2 += "?" + qs.join('&') if qs.count > 0 
  return url2
end

#under_construction_or_forwarding_domain? ⇒ Boolean

Make sure we’re not under construction or on a forwarded domain

Returns:

  • (Boolean) 


269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'app/controllers/caboose/application_controller.rb', line 269

def under_construction_or_forwarding_domain?
        
  d = Caboose::Domain.where(:domain => request.host_with_port).first
  if d.nil?
    Caboose.log("Could not find domain for #{request.host_with_port}\nAdd this domain to the caboose site.")
  elsif d.under_construction == true
    if d.site.under_construction_html && d.site.under_construction_html.strip.length > 0 
      render :text => d.site.under_construction_html
    else 
      render :file => 'caboose/application/under_construction', :layout => false
    end
    return true
  # See if we're on a forwarding domain
  elsif d.primary == false && d.forward_to_primary == true
    pd = d.site.primary_domain
    if pd && pd.domain != request.host
      url = "#{request.protocol}#{pd.domain}"
      if request.fullpath && request.fullpath.strip.length > 0 && request.fullpath.strip != '/'
        url << request.fullpath
      end
      redirect_to url
      return true
    end
  # Check for a 301 redirect
  else
    new_url = PermanentRedirect.match(@site.id, request.fullpath)        
    if new_url
      redirect_to new_url, :status => 301
      return true
    end        
  end
  return false
end

#user_is_allowed(resource, action) ⇒ Object

DEPRECATED: Use user_is_allowed_to(action, resource)

Checks to see if a user has permission to perform the given action on the given resource. Redirects to login if not logged in. Redirects to error page with message if not allowed.



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'app/controllers/caboose/application_controller.rb', line 173

def user_is_allowed(resource, action)
  if (!logged_in?)
    redirect_to "/login?return_url=" + URI.encode(request.fullpath)
    return false
  end
  
  @user = logged_in_user
  if (!@user.is_allowed(resource, action))
    @error = "You don't have permission to " + action + " " + resource
    @return_url = request.fullpath
    render :template => "caboose/extras/error"
    return false
  end
  
  return true    
end

#user_is_allowed_to(action, resource) ⇒ Object

Checks to see if a user has permission to perform action on resource

Redirects to login if not logged in Redirects to error page with message if not allowed

useful for creating super-readable code, for example:

> return unless user_is_allowed_to 'edit', 'pages'

Even your mom could read that code.



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'app/controllers/caboose/application_controller.rb', line 199

def user_is_allowed_to(action, resource)
  unless logged_in?
    redirect_to "/login?return_url=" + URI.encode(request.fullpath)
    return false
  end

  @user = logged_in_user
  unless @user.is_allowed(resource, action)
    @error = "You don't have permission to #{action} #{resource}"
    @return_url = request.fullpath
    render :template => "caboose/extras/error"
    return false
  end
  return true
end

#validate_cookie ⇒ Object

Checks to see if a remember me cookie value is present.



149
150
151
152
153
154
155
156
 
# File 'app/controllers/caboose/application_controller.rb', line 149

def validate_cookie
  if cookies[:caboose_user_id] && User.exists?(cookies[:caboose_user_id])
    user = User.find(cookies[:caboose_user_id])
    (user)
    return true
  end
  return false
end

#validate_token ⇒ Object

Checks to see if a token is given. If so, it tries to validate the token and log the user in.



137
138
139
140
141
142
143
144
145
146
 
# File 'app/controllers/caboose/application_controller.rb', line 137

def validate_token
  token = params[:token]
  return false if token.nil?
  
  user = User.validate_token(token)
  return false if user.nil?
 
  (user)
  return true
end

#var(name) ⇒ Object

def auth_or_error(message)

if (!logged_in?)
  redirect_to "/login?return_url=#{request.request_uri}" and return false
end
redirect_to "/error?message=#{message}"

end



241
242
243
244
245
 
# File 'app/controllers/caboose/application_controller.rb', line 241

def var(name)
  s = Setting.where(:name => name).first
  return "" if s.nil?    
  return s.value
end

#verify_logged_in ⇒ Object

Redirects to login if not logged in.



216
217
218
219
220
221
222
 
# File 'app/controllers/caboose/application_controller.rb', line 216

def verify_logged_in
  if !logged_in?
    redirect_to "/modal/login?return_url=" + URI.encode(request.fullpath)
    return false
  end      
  return true    
end