Class: Caboose::ApplicationController

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

Direct Known Subclasses

AbOptionsController, AbVariantsController, AdminController, AssetsController, BillingAddressesController, BlockTypeCategoriesController, BlockTypeSourcesController, BlockTypeStoreController, BlockTypesController, BlocksController, CalendarsController, CartController, CategoriesController, CheckoutController, DomainsController, EventCustomFieldValuesController, EventCustomFieldsController, EventGroupsController, EventsController, FontsController, GiftCardsController, GoogleSpreadsheetsController, InboxController, InvoicePackagesController, InvoiceTransactionsController, InvoicesController, LineItemsController, LoginController, LoginLogsController, LogoutController, MediaCategoriesController, MediaController, ModalController, ModificationValueInputFieldsController, ModificationValuesController, ModificationsController, MyAccountController, MyAccountInvoicesController, MyAccountLineItemsController, PageCustomFieldValuesController, PageCustomFieldsController, PagePermissionsController, PageTemplatesController, PagesController, PermissionsController, PostCategoriesController, PostCustomFieldValuesController, PostCustomFieldsController, PostsController, ProductImagesController, ProductsController, RedirectsController, RegisterController, RetargetingController, ReviewsController, RolesController, SettingsController, ShippingAddressesController, ShippingPackagesController, SitesController, SmtpController, SnsController, SocialController, StackableGroupsController, StationController, StoreController, SubscriptionsController, ThemeFilesController, ThemesController, UsersController, VariantChildrenController, VariantLimitsController, VariantsController, VendorsController

Instance Method Summary collapse

Instance Method Details

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


103
104
105
106
107
108
109
# File 'app/controllers/caboose/application_controller.rb', line 103

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_addObject


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

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

#admin_bulk_addObject


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

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

#admin_bulk_deleteObject


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

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

#admin_bulk_updateObject


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

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

#admin_deleteObject


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

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

#admin_editObject


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

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

#admin_indexObject

Standard methods used by model binder


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

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

#admin_jsonObject


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

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

#admin_json_singleObject


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

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

#admin_updateObject


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

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

#before_actionObject

To be overridden by the child controllers


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

def before_action      
end

#before_before_actionObject


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
56
57
58
59
60
61
62
63
64
65
66
# 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      
  if @domain.nil? || @site.nil?
    Caboose.log("Error: No site configured for #{request.host_with_port}")
  end
  
  # Set the site in any mailers
  CabooseMailer.site = @site
    
  # Make sure someone is logged in
  if !logged_in? && @site                
    elo = User.logged_out_user(@site.id)        
    (elo) if 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  

   #   @nav = Caboose.plugin_hook('admin_nav', [], @logged_in_user, @page, @site) if request.fullpath.include?('/admin')
  
  # Initialize the card
  init_cart if @site && @site.use_store && !@domain.under_construction
  
  before_action
end

#hashify_query_stringObject

Redirects/Converts querystrings into hashes


293
294
295
296
297
298
299
# File 'app/controllers/caboose/application_controller.rb', line 293

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_cartObject

Initialize the cart in the session


69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'app/controllers/caboose/application_controller.rb', line 69

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

  if create_new_invoice # Create an invoice to associate with the session        
    @invoice = Caboose::Invoice.new        
    @invoice.site_id          = @site ? @site.id : nil
    @invoice.status           = Caboose::Invoice::STATUS_CART
    @invoice.financial_status = Caboose::Invoice::STATUS_PENDING
    @invoice.date_created     = DateTime.now
    @invoice.referring_site   = request.env['HTTP_REFERER']
    @invoice.landing_page     = request.fullpath
    @invoice.landing_page_ref = params[:ref] || nil
    @invoice.payment_terms    = @site.store_config.default_payment_terms
    @invoice.save
    
    InvoiceLog.create(
      :invoice_id     => @invoice.id,          
      :user_id        => logged_in_user.id,
      :date_logged    => DateTime.now.utc,
      :invoice_action => InvoiceLog::ACTION_INVOICE_CREATED                
    )
    
    # Save the cart ID in the session
    session[:cart_id] = @invoice.id
  end                  
end

#logged_in?Boolean

Returns whether or not a user is logged in

Returns:

  • (Boolean)

155
156
157
158
159
160
# File 'app/controllers/caboose/application_controller.rb', line 155

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(@site.id)
  return false
end

#logged_in_userObject

Returns the currently logged in user


188
189
190
191
192
193
194
# File 'app/controllers/caboose/application_controller.rb', line 188

def logged_in_user
  if (!logged_in?)
    return User.logged_out_user(@site.id) if @site
  end
  #return nil if !logged_in?
  return Caboose::User.where(:id => session["app_user"].id).first
end

#login_user(user, remember = false) ⇒ Object

Logs in a user


142
143
144
145
146
147
148
149
150
151
152
# File 'app/controllers/caboose/application_controller.rb', line 142

def (user, remember = false)
  session["app_user"] = Caboose::StdClass.new({      
    :id         => user.id         ,
    :site_id    => user.site_id    ,
    :first_name => user.first_name ,
    :last_name  => user.last_name  ,
    :username   => user.username   ,
    :email      => user.email                             
  })  
  cookies.permanent[:caboose_user_id] = user.id if remember
end

#logout_userObject

Logs a user out


135
136
137
138
139
# File 'app/controllers/caboose/application_controller.rb', line 135

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

#parse_url_paramsObject

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


112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'app/controllers/caboose/application_controller.rb', line 112

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


270
271
272
273
274
275
276
277
# File 'app/controllers/caboose/application_controller.rb', line 270

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)

314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
# File 'app/controllers/caboose/application_controller.rb', line 314

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 d.forward_to_uri && d.forward_to_uri.strip.length > 0
        url << d.forward_to_uri
      elsif 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, json = false) ⇒ 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.


202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'app/controllers/caboose/application_controller.rb', line 202

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

#user_is_allowed_to(action, resource, json = false) ⇒ 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.


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# File 'app/controllers/caboose/application_controller.rb', line 236

def user_is_allowed_to(action, resource, json = false)
  unless logged_in?
    if json
      render :json => { :error => 'Not logged in.' }
    else
      redirect_to "/login?return_url=" + URI.encode(request.fullpath)
    end
    return false
  end

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

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


176
177
178
179
180
181
182
183
184
185
# File 'app/controllers/caboose/application_controller.rb', line 176

def validate_cookie     
  if cookies[:caboose_user_id]
    user = User.where(:id => cookies[:caboose_user_id]).first
    if user        
      (user)
      return true
    end
  end
  return false
end

#validate_tokenObject

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


164
165
166
167
168
169
170
171
172
173
# File 'app/controllers/caboose/application_controller.rb', line 164

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


286
287
288
289
290
# File 'app/controllers/caboose/application_controller.rb', line 286

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

#verify_logged_inObject

Redirects to login if not logged in.


261
262
263
264
265
266
267
# File 'app/controllers/caboose/application_controller.rb', line 261

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