Module: NginxTail::HttpReferer

Defined in:
lib/ntail/http_referer.rb

Constant Summary collapse

UNKNOWN_REFERER =

to easily identify external referers, for filtering and formatting purposes

 e.g. Regexp.compile(‘^http(s)?://(www.)?MY_WEBSITE_NAME.com’)

"-".freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

 the ‘default’ nginx value for $http_referer variable



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
 
# File 'lib/ntail/http_referer.rb', line 14

def self.included(base) # :nodoc:
  base.class_eval do

    @@internal_referers = []

    # mainly (solely?) for testing purposes...
    def self.reset_internal_referers()
      while !@@internal_referers.empty? ; @@internal_referers.pop ; end
    end
    
    # mainly (solely?) for testing purposes...
    def self.internal_referers()
      @@internal_referers.dup
    end
    
    def self.add_internal_referer(internal_referer)
      raise "Cannot add unkown HTTP referer" if self.unknown_referer? internal_referer
      (@@internal_referers << internal_referer).uniq!
    end

    def self.unknown_referer?(http_referer)
      http_referer == UNKNOWN_REFERER
    end
    
    def self.internal_referer?(http_referer)
      !self.unknown_referer?(http_referer) && !@@internal_referers.detect { |referer| referer.match(http_referer) }.nil?
    end
    
    def self.external_referer?(http_referer)
      !self.unknown_referer?(http_referer) && !self.internal_referer?(http_referer)
    end

    def self.to_referer_s(http_referer)
      if self.unknown_referer? http_referer
        http_referer
      else begin
          # try to parse it as a URI, but with default value if un-parsable
          URI.parse(http_referer).host || http_referer
        rescue URI::InvalidURIError
          http_referer
        end
      end
    end

    # this ensures the below module methods actually make sense...
    raise "Class #{base.name} should implement instance method 'http_referer'" unless base.instance_methods.map(&:to_s).include? 'http_referer'

  end
end

Instance Method Details

#external_referer? ⇒ Boolean

Returns:

  • (Boolean) 


72
73
74
 
# File 'lib/ntail/http_referer.rb', line 72

def external_referer?
  self.class.external_referer?(self.http_referer)
end

#internal_referer? ⇒ Boolean

Returns:

  • (Boolean) 


68
69
70
 
# File 'lib/ntail/http_referer.rb', line 68

def internal_referer?
  self.class.internal_referer?(self.http_referer)
end

#to_referer_s ⇒ Object 



76
77
78
 
# File 'lib/ntail/http_referer.rb', line 76

def to_referer_s
  self.class.to_referer_s(self.http_referer)
end

#unknown_referer? ⇒ Boolean

Returns:

  • (Boolean) 


64
65
66
 
# File 'lib/ntail/http_referer.rb', line 64

def unknown_referer?
  self.class.unknown_referer?(self.http_referer)
end