Module: RefererTracking::ControllerAddons

Defined in:
lib/referer_tracking/controller_addons.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



138
139
140
141
142
143
144
145
146
 
# File 'lib/referer_tracking/controller_addons.rb', line 138

def self.included(base)
  base.class_eval do
    before_action :before_action_referer_tracking_save_to_session
    helper_method :'referer_tracking_first_request?'
    helper_method :'referer_tracking_add_info'
    helper_method :'referer_tracking_set_info'
    helper_method :'referer_tracking_get_info'
  end
end

Instance Method Details

#before_action_referer_tracking_save_to_session ⇒ Object

before_filter :before_filter_referer_tracking_save_to_session



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/referer_tracking/controller_addons.rb', line 5

def before_action_referer_tracking_save_to_session
  unless request_is_from_a_known_bot?
    if session[:referer_tracking].nil?
      @referer_tracking_first_request = true
      session[:referer_tracking] = hash = Hash.new

      request_ref = "unknown"
      request_ref = request.headers["HTTP_REFERER"] if !request.headers["HTTP_REFERER"].blank?

      request_ref = request_ref.to_s.gsub(/pass(word)?=[^&]+/, 'pass=xxxx')
      first_url = request.url.to_s.gsub(/pass(word)?=[^&]+/, 'pass=xxxx')

      hash[:session_referer_url] = request_ref
      hash[:session_first_url] = first_url

      if RefererTracking.set_referer_cookies && cookies[RefererTracking.set_referer_cookies_name].nil?
        cookie_info = "v01|||#{Time.now.utc.to_i}|||#{first_url.first(RefererTracking.set_referer_cookies_first_url_max_length)}|||#{request_ref.first(RefererTracking.set_referer_cookies_ref_url_max_length)}"
        cookies[RefererTracking.set_referer_cookies_name] = { :value => cookie_info, :expires => 5.years.from_now, :domain => :all }
      end

      logger.info( "REFERER_TRACKING_FIRST: ver04 (ref|first) ||| #{hash[:session_referer_url]} ||| #{hash[:session_first_url]}" )
    end

  end
end

#referer_tracking_add_info(key, value) ⇒ Object

Add only if referer_tracking already in session and key has not been added/changed before So this is only performed on the first time of the session



92
93
94
95
96
 
# File 'lib/referer_tracking/controller_addons.rb', line 92

def referer_tracking_add_info(key, value)
  if !session[:referer_tracking].nil? && session[:referer_tracking][key.to_sym].nil?
    referer_tracking_set_info(key, value)
  end
end

#referer_tracking_after_create(record) ⇒ Object 



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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/referer_tracking/controller_addons.rb', line 31

def referer_tracking_after_create(record)
  @referer_tracking_saved_records ||= []
  if session && session["referer_tracking"]
    ses = session["referer_tracking"]

    ref_mod = @referer_tracking_saved_records.find { |ref_mod| ref_mod.trackable == record || (record.id && ref_mod.trackable_id == record.id && ref_mod.trackable_type == record.class.to_s) }
    if ref_mod.nil?
      #ref_mod = RefererTracking::Tracking.new(:trackable_id => record.id, :trackable_type => record.class.to_s)
      ref_mod = record.build_tracking
      @referer_tracking_saved_records.push(ref_mod)
    end

    ses.each_pair do |key, value|
      ref_mod[key] = value if ref_mod.has_attribute?(key)
      ref_mod.infos_session[key] = value unless [:session_referer_url, :session_first_url].include?(key)
    end

    if defined?(@referer_tracking_request_add_infos)
      if (req = @referer_tracking_request_add_infos) && req.is_a?(Hash)
        req.each_pair do |key, value|
          ref_mod[key] = value if ref_mod.has_attribute?(key)
          ref_mod.infos_request[key] = value
        end
      end
    end

    ref_mod[:ip] = request.ip
    ref_mod[:user_agent] = request.env['HTTP_USER_AGENT'].to_s.first(200)
    ref_mod[:current_request_url] = request.url
    ref_mod[:current_request_referer_url] = request.env["HTTP_REFERER"] # or request.headers["HTTP_REFERER"]
    ref_mod[:session_id] = request.session["session_id"]

    unless cookies[RefererTracking.set_referer_cookies_name].blank?
      _cookie_ver, cookie_time_org, cookie_first_url, cookie_referer_url = cookies[RefererTracking.set_referer_cookies_name].to_s.split("|||")
      ref_mod[:cookie_first_url] = cookie_first_url
      ref_mod[:cookie_referer_url] = cookie_referer_url
      ref_mod[:cookie_time] = Time.at(cookie_time_org.to_i)
    end

    if RefererTracking.save_cookies
      begin
        ref_mod[:cookies_yaml] = cookies.instance_variable_get('@cookies').to_yaml
      rescue
        str = "referer_tracking after create problem encoding cookie yml, probably non utf8 chars #{e}"
        logger.error(str)
        ref_mod[:cookies_yaml] = "error: #{str}"
      end
    end

    ref_mod.save unless ref_mod.trackable.new_record?
  end

rescue Exception => e
  Rails.logger.info "RefererTracking::ControllerAddons.after_create problem with creating record: #{e}"
end

#referer_tracking_first_request? ⇒ Boolean

Returns:

  • (Boolean) 


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

def referer_tracking_first_request?
  @referer_tracking_first_request
end

#referer_tracking_get_info(key) ⇒ Object 



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

def referer_tracking_get_info(key)
  session[:referer_tracking].nil? ? nil : session[:referer_tracking][key.to_sym]
end

#referer_tracking_request_set_info(key, value) ⇒ Object 



116
117
118
 
# File 'lib/referer_tracking/controller_addons.rb', line 116

def referer_tracking_request_set_info(key, value)
  referer_tracking_request_add_infos[key.to_sym] = value
end

#referer_tracking_set_info(key, value) ⇒ Object 



98
99
100
101
102
 
# File 'lib/referer_tracking/controller_addons.rb', line 98

def referer_tracking_set_info(key, value)
  if !session[:referer_tracking].nil?
    session[:referer_tracking][key.to_sym] = value
  end
end

#request_is_from_a_known_bot? ⇒ Boolean

Returns:

  • (Boolean) 


127
128
129
130
 
# File 'lib/referer_tracking/controller_addons.rb', line 127

def request_is_from_a_known_bot?
  bot_user_agents = /\b(GoogleBot|Mediapartners-Google|msnbot|TwengaBot|DigExt; DTS Agent|YandexImages)\b/i
  request.user_agent =~ bot_user_agents
end

#request_is_from_a_possible_bot? ⇒ Boolean

Returns:

  • (Boolean) 


132
133
134
 
# File 'lib/referer_tracking/controller_addons.rb', line 132

def request_is_from_a_possible_bot?
  request.user_agent =~ /bot/i
end