wovnrb 3.8.0 → 3.10.0

data/lib/wovnrb/store.rb

@@ -1,211 +1,221 @@
-require 'net/http'
-require 'uri'
-require 'cgi'
-require 'singleton'
-require 'wovnrb/services/wovn_logger'
-require 'wovnrb/services/glob'
-require 'wovnrb/settings'
-require 'active_support'
-require 'active_support/core_ext'
-
-module Wovnrb
-  class Store
-    include Singleton
-
-    def self.default_settings
-      Settings.new.merge(
-        'project_token' => '',
-        'log_path' => 'log/wovn_error.log',
-        'ignore_paths' => [],
-        'ignore_globs' => [],
-        'url_pattern' => 'path',
-        'url_pattern_reg' => "/(?<lang>[^/.?]+)",
-        'lang_param_name' => 'wovn',
-        'query' => [],
-        'ignore_class' => [],
-        'api_url' => 'https://wovn.global.ssl.fastly.net',
-        'api_timeout_seconds' => 1.0,
-        'api_timeout_search_engine_bots' => 5.0,
-        'default_lang' => 'ja',
-        'supported_langs' => %w[en ja],
-        'test_mode' => false,
-        'test_url' => '',
-        'cache_megabytes' => nil,
-        'ttl_seconds' => nil,
-        'use_proxy' => false, # use env['HTTP_X_FORWARDED_HOST'] instead of env['HTTP_HOST'] and env['SERVER_NAME'] when this setting is true.
-        'custom_lang_aliases' => {},
-        'translate_fragment' => true,
-        'widget_url' => 'https://j.wovn.io/1',
-        'wovn_dev_mode' => false,
-        'compress_api_requests' => true,
-        'translate_canonical_tag' => true
-      )
-    end
-
-    def initialize
-      reset
-    end
-
-    # Reset @settings and @config_loaded variables to default.
-    #
-    # @return [nil]
-    def reset
-      @settings = Store.default_settings
-      # When Store is initialized, the Rails.configuration object is not yet initialized
-      @config_loaded = false
-    end
-
-    # Returns true or false based on whether the token is valid or not
-    #
-    # @return [Boolean] Returns true if the token is valid, and false if it is not
-    def valid_token?(token)
-      !token.nil? && (token.length == 5 || token.length == 6)
-    end
-
-    # Returns true or false based on whether the settings are valid or not, logs any invalid settings to ../error.log
-    #
-    # @return [Boolean] Returns true if the settings are valid, and false if they are not
-    def valid_settings?
-      valid = true
-      errors = []
-      # if valid_token?(!settings.has_key?('project_token') || settings['project_token'].length < 5 || settings['project_token'].length > 6
-      if !valid_token?(settings['project_token'])
-        errors.push("Project token #{settings['project_token']} is not valid.")
-      end
-      if settings.has_key?('ignore_paths') && !settings['ignore_paths'].kind_of?(Array)
-        errors.push("Ignore Paths #{settings['ignore_paths']} should be Array.")
-      end
-      if !settings.has_key?('url_pattern') || settings['url_pattern'].length == 0
-        errors.push("Url pattern #{settings['url_pattern']} is not valid.")
-      end
-      if !settings.has_key?('query') || !settings['query'].kind_of?(Array)
-        errors.push("query config #{settings['query']} is not valid.")
-      end
-      if !settings.has_key?('ignore_class') || !settings['ignore_class'].kind_of?(Array)
-        errors.push("ignore_class config #{settings['ignore_class']} should be Array.")
-      end
-      if !settings.has_key?('api_url') || settings['api_url'].length == 0
-        errors.push("API URL is not configured.")
-      end
-      if !settings.has_key?('default_lang') || settings['default_lang'].nil?
-        errors.push("Default lang #{settings['default_lang']} is not valid.")
-      end
-      if !settings.has_key?('supported_langs') || !settings['supported_langs'].kind_of?(Array) || settings['supported_langs'].size < 1
-        errors.push("Supported langs configuration is not valid.")
-      end
-      if !settings.has_key?('custom_lang_aliases') || !settings['custom_lang_aliases'].kind_of?(Hash)
-        errors.push("Custom lang aliases is not valid.")
-      end
-      # log errors
-      if errors.length > 0
-        valid = false
-        errors.each do |e|
-          WovnLogger.instance.error(e)
-        end
-      end
-      valid
-    end
-
-    # Returns the settings object, pulling from Rails config the first time this is called
-    #
-    def settings
-      load_settings unless @config_loaded
-      @settings
-    end
-
-    # Load Rails config.wovnrb
-    #
-    def load_settings
-      if Object.const_defined?(:Rails) && Rails.configuration.respond_to?(:wovnrb)
-        @config_loaded = true
-        update_settings(Rails.configuration.wovnrb)
-      end
-    end
-
-    def update_settings(new_settings)
-      load_settings unless @config_loaded
-      if !new_settings.nil?
-        @settings.merge!(new_settings.stringify_keys)
-        format_settings
-      end
-    end
-
-    def format_settings
-      if @settings.has_key?('custom_lang_aliases')
-        stringify_keys! @settings['custom_lang_aliases']
-      end
-
-      @settings['default_lang'] = Lang.get_code(@settings['default_lang'])
-      if !@settings.has_key?('supported_langs')
-        @settings['supported_langs'] = [@settings['default_lang']]
-      end
-
-      if @settings.has_key?('user_token') && @settings['project_token'].empty?
-        @settings['project_token'] = @settings['user_token']
-      end
-      @settings.delete('user_token')
-
-      case @settings['url_pattern']
-      when 'path'
-        @settings['url_pattern_reg'] = "/(?<lang>[^/.?]+)"
-      when 'query'
-        @settings['url_pattern_reg'] = "((\\?.*&)|\\?)#{@settings['lang_param_name']}=(?<lang>[^&]+)(&|$)"
-      when 'subdomain'
-        @settings['url_pattern_reg'] = '^(?<lang>[^.]+)\.'
-      end
-
-      @settings['test_mode'] = !(@settings['test_mode'] != true || @settings['test_mode'] != 'on')
-
-      if @settings['wovn_dev_mode']
-        if @settings['api_url'] == self.class.default_settings['api_url']
-          @settings['api_url'] = 'http://dev-wovn.io:3001'
-        end
-
-        if @settings['api_timeout_seconds'] == self.class.default_settings['api_timeout_seconds']
-          @settings['api_timeout_seconds'] = 3.0
-        end
-      end
-    end
-
-    def custom_lang_aliases
-      @settings['custom_lang_aliases'] || {}
-    end
-
-    def default_lang
-      @settings['default_lang']
-    end
-
-    def default_lang_alias
-      custom_alias = custom_lang_aliases[default_lang]
-      custom_alias || default_lang
-    end
-
-    def supported_langs
-      @settings['supported_langs'] || []
-    end
-
-    def compress_api_requests?
-      @settings['compress_api_requests']
-    end
-
-    def widget_url
-      @settings['widget_url'] || 'https://j.wovn.io/1'
-    end
-
-    def dev_mode?
-      @settings['wovn_dev_mode']
-    end
-
-    def url_pattern
-      @settings['url_pattern']
-    end
-
-    private
-
-    def stringify_keys!(hash)
-      hash.keys.each do |k|
-        hash[k.to_s] = hash.delete(k)
-      end
-    end
-  end
-end
+require 'net/http'
+require 'uri'
+require 'cgi'
+require 'singleton'
+require 'wovnrb/custom_domain/custom_domain_langs'
+require 'wovnrb/services/wovn_logger'
+require 'wovnrb/services/glob'
+require 'wovnrb/settings'
+require 'active_support'
+require 'active_support/core_ext'
+
+module Wovnrb
+  class Store
+    include Singleton
+
+    def self.default_settings
+      Settings.new.merge(
+        'project_token' => '',
+        'log_path' => 'log/wovn_error.log',
+        'ignore_paths' => [],
+        'ignore_globs' => [],
+        'url_pattern' => 'path',
+        'url_pattern_reg' => "/(?<lang>[^/.?]+)",
+        'lang_param_name' => 'wovn',
+        'query' => [],
+        'ignore_class' => [],
+        'api_url' => 'https://wovn.global.ssl.fastly.net',
+        'api_timeout_seconds' => 1.0,
+        'api_timeout_search_engine_bots' => 5.0,
+        'default_lang' => 'ja',
+        'supported_langs' => %w[en ja],
+        'test_mode' => false,
+        'test_url' => '',
+        'cache_megabytes' => nil,
+        'ttl_seconds' => nil,
+        'use_proxy' => false, # use env['HTTP_X_FORWARDED_HOST'] instead of env['HTTP_HOST'] and env['SERVER_NAME'] when this setting is true.
+        'custom_lang_aliases' => {},
+        'translate_fragment' => true,
+        'widget_url' => 'https://j.wovn.io/1',
+        'wovn_dev_mode' => false,
+        'compress_api_requests' => true,
+        'translate_canonical_tag' => true,
+        'custom_domain_langs' => {},
+        'insert_hreflangs' => true
+      )
+    end
+
+    def initialize
+      reset
+    end
+
+    # Reset @settings and @config_loaded variables to default.
+    #
+    # @return [nil]
+    def reset
+      @settings = Store.default_settings
+      @custom_domain_langs = nil
+      # When Store is initialized, the Rails.configuration object is not yet initialized
+      @config_loaded = false
+    end
+
+    # Returns true or false based on whether the token is valid or not
+    #
+    # @return [Boolean] Returns true if the token is valid, and false if it is not
+    def valid_token?(token)
+      !token.nil? && (token.length == 5 || token.length == 6)
+    end
+
+    # Returns true or false based on whether the settings are valid or not, logs any invalid settings to ../error.log
+    #
+    # @return [Boolean] Returns true if the settings are valid, and false if they are not
+    def valid_settings?
+      valid = true
+      errors = []
+      # if valid_token?(!settings.has_key?('project_token') || settings['project_token'].length < 5 || settings['project_token'].length > 6
+      if !valid_token?(settings['project_token'])
+        errors.push("Project token #{settings['project_token']} is not valid.")
+      end
+      if settings.has_key?('ignore_paths') && !settings['ignore_paths'].kind_of?(Array)
+        errors.push("Ignore Paths #{settings['ignore_paths']} should be Array.")
+      end
+      if !settings.has_key?('url_pattern') || settings['url_pattern'].length == 0
+        errors.push("Url pattern #{settings['url_pattern']} is not valid.")
+      end
+      if !settings.has_key?('query') || !settings['query'].kind_of?(Array)
+        errors.push("query config #{settings['query']} is not valid.")
+      end
+      if !settings.has_key?('ignore_class') || !settings['ignore_class'].kind_of?(Array)
+        errors.push("ignore_class config #{settings['ignore_class']} should be Array.")
+      end
+      if !settings.has_key?('api_url') || settings['api_url'].length == 0
+        errors.push("API URL is not configured.")
+      end
+      if !settings.has_key?('default_lang') || settings['default_lang'].nil?
+        errors.push("Default lang #{settings['default_lang']} is not valid.")
+      end
+      if !settings.has_key?('supported_langs') || !settings['supported_langs'].kind_of?(Array) || settings['supported_langs'].size < 1
+        errors.push("Supported langs configuration is not valid.")
+      end
+      if !settings.has_key?('custom_lang_aliases') || !settings['custom_lang_aliases'].kind_of?(Hash)
+        errors.push("Custom lang aliases is not valid.")
+      end
+      # log errors
+      if errors.length > 0
+        valid = false
+        errors.each do |e|
+          WovnLogger.instance.error(e)
+        end
+      end
+      valid
+    end
+
+    # Returns the settings object, pulling from Rails config the first time this is called
+    #
+    def settings
+      load_settings unless @config_loaded
+      @settings
+    end
+
+    # Load Rails config.wovnrb
+    #
+    def load_settings
+      if Object.const_defined?(:Rails) && Rails.configuration.respond_to?(:wovnrb)
+        @config_loaded = true
+        update_settings(Rails.configuration.wovnrb)
+      end
+    end
+
+    def update_settings(new_settings)
+      load_settings unless @config_loaded
+      if !new_settings.nil?
+        @settings.merge!(new_settings.stringify_keys)
+        format_settings
+      end
+    end
+
+    def format_settings
+      if @settings.has_key?('custom_lang_aliases')
+        stringify_keys! @settings['custom_lang_aliases']
+      end
+
+      @settings['default_lang'] = Lang.get_code(@settings['default_lang'])
+      if !@settings.has_key?('supported_langs')
+        @settings['supported_langs'] = [@settings['default_lang']]
+      end
+
+      if @settings.has_key?('user_token') && @settings['project_token'].empty?
+        @settings['project_token'] = @settings['user_token']
+      end
+      @settings.delete('user_token')
+
+      case @settings['url_pattern']
+      when 'path'
+        @settings['url_pattern_reg'] = "/(?<lang>[^/.?]+)"
+      when 'query'
+        @settings['url_pattern_reg'] = "((\\?.*&)|\\?)#{@settings['lang_param_name']}=(?<lang>[^&]+)(&|$)"
+      when 'subdomain'
+        @settings['url_pattern_reg'] = '^(?<lang>[^.]+)\.'
+      when 'custom_domain'
+        # Do not use regex
+      end
+
+      @settings['test_mode'] = !(@settings['test_mode'] != true || @settings['test_mode'] != 'on')
+
+      if @settings['wovn_dev_mode']
+        if @settings['api_url'] == self.class.default_settings['api_url']
+          @settings['api_url'] = 'http://dev-wovn.io:3001'
+        end
+
+        if @settings['api_timeout_seconds'] == self.class.default_settings['api_timeout_seconds']
+          @settings['api_timeout_seconds'] = 3.0
+        end
+      end
+    end
+
+    def custom_lang_aliases
+      @settings['custom_lang_aliases'] || {}
+    end
+
+    def default_lang
+      @settings['default_lang']
+    end
+
+    def default_lang_alias
+      custom_alias = custom_lang_aliases[default_lang]
+      custom_alias || default_lang
+    end
+
+    def supported_langs
+      @settings['supported_langs'] || []
+    end
+
+    def compress_api_requests?
+      @settings['compress_api_requests']
+    end
+
+    def widget_url
+      @settings['widget_url'] || 'https://j.wovn.io/1'
+    end
+
+    def dev_mode?
+      @settings['wovn_dev_mode']
+    end
+
+    def url_pattern
+      @settings['url_pattern']
+    end
+
+    def custom_domain_langs
+      @custom_domain_langs ||= CustomDomainLangs.new(@settings['custom_domain_langs'])
+    end
+
+    private
+
+    def stringify_keys!(hash)
+      hash.keys.each do |k|
+        hash[k.to_s] = hash.delete(k)
+      end
+    end
+  end
+end

data/lib/wovnrb/url_language_switcher.rb

@@ -1,3 +1,4 @@
+require 'wovnrb/custom_domain/custom_domain_lang_url_handler'
 require 'wovnrb/services/url'
 
 module Wovnrb
@@ -28,10 +29,11 @@ module Wovnrb
 
     # Removes language code from a URI component (path, hostname, query etc), and returns it.
     #
-    # @param uri  [String] original URI component
-    # @param lang [String] language code
-    # @return     [String] removed URI
-    def remove_lang_from_uri_component(uri, lang)
+    # @param uri     [String] original URI component
+    # @param lang    [String] language code
+    # @param headers [Header] headers
+    # @return        [String] removed URI
+    def remove_lang_from_uri_component(uri, lang, headers = nil)
       lang_code = @store.settings['custom_lang_aliases'][lang] || lang
 
       return uri if lang_code.blank?
@@ -49,6 +51,25 @@ module Wovnrb
         # (/|$)         3: path or end-of-string
         lang_code_pattern = %r{^(.*://|//)?([^/]*/)?#{lang_code}(/|$)}
         uri.sub(lang_code_pattern, '\1\2')
+      when 'custom_domain'
+        custom_domain_langs = @store.custom_domain_langs
+        custom_domain_lang_to_remove = custom_domain_langs.custom_domain_lang_by_lang(lang_code)
+        default_custom_domain_lang = custom_domain_langs.custom_domain_lang_by_lang(@store.default_lang)
+        new_uri = uri
+        if Wovnrb::URL.absolute_url?(uri)
+          new_uri = CustomDomainLangUrlHandler.change_to_new_custom_domain_lang(uri, custom_domain_lang_to_remove, default_custom_domain_lang)
+        elsif Wovnrb::URL.absolute_path?(uri)
+          absolute_url = "#{headers.protocol}://#{headers.unmasked_host}#{uri}"
+          absolute_url_with_lang = CustomDomainLangUrlHandler.change_to_new_custom_domain_lang(absolute_url, custom_domain_lang_to_remove, default_custom_domain_lang)
+          segments = make_segments_from_absolute_url(absolute_url_with_lang)
+          new_uri = segments['others']
+        elsif uri == custom_domain_lang_to_remove.host
+          absolute_url = "#{headers.protocol}://#{uri}#{headers.unmasked_pathname}"
+          absolute_url_with_lang = CustomDomainLangUrlHandler.change_to_new_custom_domain_lang(absolute_url, custom_domain_lang_to_remove, default_custom_domain_lang)
+          segments = make_segments_from_absolute_url(absolute_url_with_lang)
+          new_uri = segments['host']
+        end
+        new_uri
       else
         raise RuntimeError("Invalid URL pattern: #{@store.settings['url_pattern']}")
       end
@@ -80,6 +101,8 @@ module Wovnrb
                  end
                when 'query'
                  add_query_lang_code(href, code_to_add)
+               when 'custom_domain'
+                 CustomDomainLangUrlHandler.add_custom_domain_lang_to_absolute_url(href, code_to_add, @store.custom_domain_langs)
                else # path
                  href_uri.path = add_lang_code_for_path(href_uri.path, code_to_add, headers)
                  href_uri.to_s
@@ -105,6 +128,9 @@ module Wovnrb
         "#{headers.protocol}://#{code_to_add.downcase}.#{headers.host}#{abs_path}"
       when 'query'
         add_query_lang_code(href, code_to_add)
+      when 'custom_domain'
+        absolute_url = "#{headers.protocol}://#{headers.host}#{abs_path}"
+        CustomDomainLangUrlHandler.add_custom_domain_lang_to_absolute_url(absolute_url, code_to_add, @store.custom_domain_langs)
       else # path
         add_lang_code_for_path(href, code_to_add, headers)
       end
@@ -148,5 +174,19 @@ module Wovnrb
     def build_lang_path(lang_code)
       lang_code.blank? ? '' : URL.prepend_path_slash(lang_code)
     end
+
+    def make_segments_from_absolute_url(absolute_uri)
+      # 1: schema (optional) like https://
+      # 2: host (optional) like wovn.io
+      # 3: path with query or hash
+      regex = %r{^(.*://|//)?([^/?]*)?((?:/|\?|#).*)?$}
+      matches = regex.match(absolute_uri)
+
+      {
+        'schema' => matches[1],
+        'host' => matches[2],
+        'others' => matches[3]
+      }.transform_values(&:to_s)
+    end
   end
 end

data/lib/wovnrb/version.rb

@@ -1,3 +1,3 @@
-module Wovnrb
-  VERSION = '3.8.0'.freeze
-end
+module Wovnrb
+  VERSION = '3.10.0'.freeze
+end

data/lib/wovnrb.rb

@@ -36,7 +36,7 @@ module Wovnrb
       return @app.call(env) if @store.settings['test_mode'] && @store.settings['test_url'] != headers.url
 
       # redirect if the path is set to the default language (for SEO purposes)
-      if headers.path_lang == default_lang
+      if explicit_default_lang?(headers)
         redirect_headers = headers.redirect(default_lang)
         return [307, redirect_headers, ['']]
       end
@@ -51,7 +51,7 @@ module Wovnrb
       status, res_headers, body = @app.call(headers.request_out)
 
       # disabled by next Rack middleware
-      return output(headers, status, res_headers, body) unless /html/.match?(res_headers['Content-Type'])
+      return output(headers, status, res_headers, body) unless res_headers['Content-Type']&.include?('html')
 
       request = Rack::Request.new(env)
 
@@ -129,5 +129,10 @@ module Wovnrb
 
       !!(html_attributes['amp'] || html_attributes["\u26A1"])
     end
+
+    def explicit_default_lang?(headers)
+      default_lang, url_pattern = @store.settings.values_at('default_lang', 'url_pattern')
+      default_lang == headers.url_language && url_pattern != 'custom_domain'
+    end
   end
 end