Class: Wovnrb::Headers

Inherits:
Object
  • Object
show all
Defined in:
lib/wovnrb/headers.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(env, settings) ⇒ Headers

Generates new instance of Wovnrb::Headers. Its parameters are set by parsing env variable.



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
67
68
 
# File 'lib/wovnrb/headers.rb', line 16

def initialize(env, settings)
  @env = env
  @settings = settings
  @protocol = @env['rack.url_scheme']
  if settings['use_proxy'] && @env.has_key?('HTTP_X_FORWARDED_HOST')
    @unmasked_host = @env['HTTP_X_FORWARDED_HOST']
  else
    @unmasked_host = @env['HTTP_HOST']
  end
  unless @env.has_key?('REQUEST_URI')
    # Add '/' to PATH_INFO as a possible fix for pow server
    @env['REQUEST_URI'] = (@env['PATH_INFO'] =~ /^[^\/]/ ? '/' : '') + @env['PATH_INFO'] + (@env['QUERY_STRING'].size == 0 ? '' : "?#{@env['QUERY_STRING']}")
  end
  # REQUEST_URI is expected to not contain the server name
  # heroku contains http://...
  if @env['REQUEST_URI'] =~ /:\/\//
    @env['REQUEST_URI'] = @env['REQUEST_URI'].sub(/^.*:\/\/[^\/]+/, '')
  end
  @unmasked_pathname = @env['REQUEST_URI'].split('?')[0]
  @unmasked_pathname += '/' unless @unmasked_pathname =~ /\/$/ || @unmasked_pathname =~ /\/[^\/.]+\.[^\/.]+$/
  @unmasked_url = "#{@protocol}://#{@unmasked_host}#{@unmasked_pathname}"
  if settings['use_proxy'] && @env.has_key?('HTTP_X_FORWARDED_HOST')
    @host = @env['HTTP_X_FORWARDED_HOST']
  else
    @host = @env['HTTP_HOST']
  end
  @env['wovnrb.target_lang'] = self.lang_code
  @host = settings['url_pattern'] == 'subdomain' ? remove_lang(@host, self.lang_code) : @host
  @pathname, @query = @env['REQUEST_URI'].split('?')
  @pathname = settings['url_pattern'] == 'path' ? remove_lang(@pathname, self.lang_code) : @pathname
  @query = @query || ''
  @url = "#{@host}#{@pathname}#{(@query.length > 0 ? '?' : '') + remove_lang(@query, self.lang_code)}"
  if settings['query'].length > 0
    query_vals = []
    settings['query'].each do |qv|
      rx = Regexp.new("(^|&)(?<query_val>#{qv}[^&]+)(&|$)")
      m = @query.match(rx)
      if m && m[:query_val]
        query_vals.push(m[:query_val])
      end
    end
    if query_vals.length > 0
      @query = "?#{query_vals.sort.join('&')}"
    else
      @query = ''
    end
  else
    @query = ''
  end
  @query = remove_lang(@query, self.lang_code)
  @pathname = @pathname.gsub(/\/$/, '')
  @redis_url = "#{@host}#{@pathname}#{@query}"
end

Instance Attribute Details

#host ⇒ Object (readonly)

Returns the value of attribute host.



8
9
10
 
# File 'lib/wovnrb/headers.rb', line 8

def host
  @host
end

#pathname ⇒ Object (readonly)

Returns the value of attribute pathname.



10
11
12
 
# File 'lib/wovnrb/headers.rb', line 10

def pathname
  @pathname
end

#protocol ⇒ Object (readonly)

Returns the value of attribute protocol.



6
7
8
 
# File 'lib/wovnrb/headers.rb', line 6

def protocol
  @protocol
end

#redis_url ⇒ Object (readonly)

Returns the value of attribute redis_url.



11
12
13
 
# File 'lib/wovnrb/headers.rb', line 11

def redis_url
  @redis_url
end

#unmasked_host ⇒ Object (readonly)

Returns the value of attribute unmasked_host.



7
8
9
 
# File 'lib/wovnrb/headers.rb', line 7

def unmasked_host
  @unmasked_host
end

#unmasked_pathname ⇒ Object (readonly)

Returns the value of attribute unmasked_pathname.



9
10
11
 
# File 'lib/wovnrb/headers.rb', line 9

def unmasked_pathname
  @unmasked_pathname
end

#unmasked_url ⇒ Object (readonly)

Returns the value of attribute unmasked_url.



4
5
6
 
# File 'lib/wovnrb/headers.rb', line 4

def unmasked_url
  @unmasked_url
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



5
6
7
 
# File 'lib/wovnrb/headers.rb', line 5

def url
  @url
end

Instance Method Details

#browser_lang ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/wovnrb/headers.rb', line 99

def browser_lang
  if @browser_lang.nil?
    match = (@env['HTTP_COOKIE'] || '').match(/wovn_selected_lang\s*=\s*(?<lang>[^;\s]+)/)
    if match && match[:lang] && Lang.get_lang(match[:lang])
      @browser_lang = match[:lang]
    else
# IS THIS RIGHT?
      @browser_lang = ''
      accept_langs = (@env['HTTP_ACCEPT_LANGUAGE'] || '').split(/[,;]/)
      accept_langs.each do |l|
        if Lang.get_lang(l)
          @browser_lang = l
          break
        end
      end
    end
  end
  return @browser_lang
end

#lang_code ⇒ String

Get the language code of the current request

Returns:

  • (String) —

    The lang code of the current page



73
74
75
 
# File 'lib/wovnrb/headers.rb', line 73

def lang_code
  (self.path_lang && self.path_lang.length > 0) ? self.path_lang : @settings['default_lang']
end

#out(headers) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/wovnrb/headers.rb', line 210

def out(headers)
  r = Regexp.new("//" + @host)
  lang_code = Store.instance.settings['custom_lang_aliases'][self.lang_code] || self.lang_code
  if lang_code != @settings['default_lang'] && headers.has_key?("Location") && headers["Location"] =~ r
    case @settings['url_pattern']
    when 'query'
      if headers['Location'] =~ /\?/
        headers['Location'] += "&"
      else
        headers['Location'] += "?"
      end
      headers['Location'] += "wovn=#{lang_code}"
    when 'subdomain'
      headers['Location'] = headers["Location"].sub(/\/\/([^.]+)/, '//' + lang_code + '.\1')
   #when 'path'
    else
      headers['Location'] = headers['Location'].sub(/(\/\/[^\/]+)/, '\1/' + lang_code)
    end
  end
  headers
end

#path_lang ⇒ String

picks up language code from requested URL by using url_pattern_reg setting. when language code is invalid, this method returns empty string. if you want examples, please see test/lib/headers_test.rb.

Returns:

  • (String) —

    language code in requrested URL.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/wovnrb/headers.rb', line 82

def path_lang
  if @path_lang.nil?
    rp = Regexp.new(@settings['url_pattern_reg'])
    if @settings['use_proxy'] && @env.has_key?('HTTP_X_FORWARDED_HOST')
      match = "#{@env['HTTP_X_FORWARDED_HOST']}#{@env['REQUEST_URI']}".match(rp)
    else
      match = "#{@env['SERVER_NAME']}#{@env['REQUEST_URI']}".match(rp)
    end
    if match && match[:lang] && Lang.get_lang(match[:lang])
      @path_lang = Lang.get_code(match[:lang])
    else
      @path_lang = ''
    end
  end
  return @path_lang
end

#redirect(lang = self.browser_lang) ⇒ Object 



119
120
121
122
123
124
 
# File 'lib/wovnrb/headers.rb', line 119

def redirect(lang=self.browser_lang)
  redirect_headers = {}
  redirect_headers['location'] = self.redirect_location(lang)
  redirect_headers['content-length'] = '0'
  return redirect_headers
end

#redirect_location(lang) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/wovnrb/headers.rb', line 126

def redirect_location(lang)
  if lang == @settings['default_lang']
# IS THIS RIGHT??
    return "#{self.protocol}://#{self.url}"
    #return remove_lang("#{@env['HTTP_HOST']}#{@env['REQUEST_URI']}", lang)
  else
    # TODO test
    lang_code = Store.instance.settings['custom_lang_aliases'][lang] || lang
    location = self.url
    case @settings['url_pattern']
    when 'query'
      if location !~ /\?/
        location = "#{location}?wovn=#{lang_code}"
      else @env['REQUEST_URI'] !~ /(\?|&)wovn=/
        location = "#{location}&wovn=#{lang_code}"
      end
    when 'subdomain'
      location = "#{lang_code.downcase}.#{location}"
   #when 'path'
    else
      location = location.sub(/(\/|$)/, "/#{lang_code}/");
    end
    return "#{self.protocol}://#{location}"
  end
end

#remove_lang(uri, lang = self.path_lang) ⇒ String

Remove language code from the URI.

Parameters:

  • uri (String) —

    original URI

  • lang_code (String) —

    language code

Returns:

  • (String) —

    removed URI



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/wovnrb/headers.rb', line 190

def remove_lang(uri, lang=self.path_lang)
  lang_code = Store.instance.settings['custom_lang_aliases'][lang] || lang

  # Do nothing if lang is empty.
  if lang_code.nil? || lang_code.empty?
    return uri
  end

  case @settings['url_pattern']
  when 'query'
    return uri.sub(/(^|\?|&)wovn=#{lang_code}(&|$)/, '\1').gsub(/(\?|&)$/, '')
  when 'subdomain'
    rp = Regexp.new('(^|(//))' + lang_code + '\.', 'i')
    return uri.sub(rp, '\1')
 #when 'path'
  else
    return uri.sub(/\/#{lang_code}(\/|$)/, '/')
  end
end

#request_out(def_lang = ) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/wovnrb/headers.rb', line 152

def request_out(def_lang=@settings['default_lang'])
  case @settings['url_pattern']
  when 'query'
    @env['REQUEST_URI'] = remove_lang(@env['REQUEST_URI']) if @env.has_key?('REQUEST_URI')
    @env['QUERY_STRING'] = remove_lang(@env['QUERY_STRING']) if @env.has_key?('QUERY_STRING')
    @env['ORIGINAL_FULLPATH'] = remove_lang(@env['ORIGINAL_FULLPATH']) if @env.has_key?('ORIGINAL_FULLPATH')
  when 'subdomain'
    if @settings['use_proxy'] && @env.has_key?('HTTP_X_FORWARDED_HOST')
      @env['HTTP_X_FORWARDED_HOST'] = remove_lang(@env['HTTP_X_FORWARDED_HOST'])
    else
      @env["HTTP_HOST"] = remove_lang(@env["HTTP_HOST"])
      @env["SERVER_NAME"] = remove_lang(@env["SERVER_NAME"])
    end
    if @env.has_key?('HTTP_REFERER')
      @env["HTTP_REFERER"] = remove_lang(@env["HTTP_REFERER"])
    end
 #when 'path'
  else
    @env['REQUEST_URI'] = remove_lang(@env['REQUEST_URI'])
    if @env.has_key?('REQUEST_PATH')
      @env['REQUEST_PATH'] = remove_lang(@env['REQUEST_PATH'])
    end
    @env['PATH_INFO'] = remove_lang(@env['PATH_INFO'])
    if @env.has_key?('ORIGINAL_FULLPATH')
      @env['ORIGINAL_FULLPATH'] = remove_lang(@env['ORIGINAL_FULLPATH'])
    end
    if @env.has_key?('HTTP_REFERER')
      @env["HTTP_REFERER"] = remove_lang(@env["HTTP_REFERER"])
    end
  end
  @env
end