mongo 2.11.4 → 2.18.1

data/lib/mongo/uri.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -192,12 +195,13 @@ module Mongo
     # @since 2.0.0
     AUTH_MECH_MAP = {
       'GSSAPI'       => :gssapi,
+      'MONGODB-AWS'  => :aws,
       # MONGODB-CR is deprecated and will be removed in driver version 3.0
       'MONGODB-CR'   => :mongodb_cr,
       'MONGODB-X509' => :mongodb_x509,
       'PLAIN'        => :plain,
       'SCRAM-SHA-1'  => :scram,
-      'SCRAM-SHA-256' => :scram256
+      'SCRAM-SHA-256' => :scram256,
     }.freeze
 
     # Options that are allowed to appear more than once in the uri.
@@ -215,10 +219,22 @@ module Mongo
     # @example Get the uri object.
     #   URI.get(string)
     #
+    # @param [ String ] string The URI to parse.
+    # @param [ Hash ] opts The options.
+    #
+    # @option options [ Logger ] :logger A custom logger to use.
+    #
     # @return [URI, URI::SRVProtocol] The uri object.
     #
     # @since 2.5.0
     def self.get(string, opts = {})
+      unless string
+        raise Error::InvalidURI.new(string, 'URI must be a string, not nil.')
+      end
+      if string.empty?
+        raise Error::InvalidURI.new(string, 'Cannot parse an empty URI.')
+      end
+
       scheme, _, remaining = string.partition(SCHEME_DELIM)
       case scheme
         when MONGODB_SCHEME
@@ -257,13 +273,22 @@ module Mongo
     # @example Create the new URI.
     #   URI.new('mongodb://localhost:27017')
     #
-    # @param [ String ] string The uri string.
+    # @param [ String ] string The URI to parse.
     # @param [ Hash ] options The options.
     #
+    # @option options [ Logger ] :logger A custom logger to use.
+    #
     # @raise [ Error::InvalidURI ] If the uri does not match the spec.
     #
     # @since 2.0.0
     def initialize(string, options = {})
+      unless string
+        raise Error::InvalidURI.new(string, 'URI must be a string, not nil.')
+      end
+      if string.empty?
+        raise Error::InvalidURI.new(string, 'Cannot parse an empty URI.')
+      end
+
       @string = string
       @options = options
       parsed_scheme, _, remaining = string.partition(SCHEME_DELIM)
@@ -274,34 +299,7 @@ module Mongo
         raise_invalid_error!('No hosts in the URI')
       end
       parse!(remaining)
-
-      # The URI options spec requires that we raise an error if there are conflicting values of
-      # 'tls' and 'ssl'. In order to fulfill this, we parse the values of each instance into an
-      # array; assuming all values in the array are the same, we replace the array with that value.
-      unless @uri_options[:ssl].nil? || @uri_options[:ssl].empty?
-        unless @uri_options[:ssl].uniq.length == 1
-          raise_invalid_error_no_fmt!("all instances of 'tls' and 'ssl' must have the same value")
-        end
-
-        @uri_options[:ssl] = @uri_options[:ssl].first
-      end
-
-      # Check for conflicting TLS insecure options.
-      unless @uri_options[:ssl_verify].nil?
-        unless @uri_options[:ssl_verify_certificate].nil?
-          raise_invalid_error_no_fmt!("'tlsInsecure' and 'tlsAllowInvalidCertificates' cannot both be specified")
-        end
-
-        unless @uri_options[:ssl_verify_hostname].nil?
-          raise_invalid_error_no_fmt!("tlsInsecure' and 'tlsAllowInvalidHostnames' cannot both be specified")
-        end
-      end
-
-      # Since we know that the only URI option that sets :ssl_cert is "tlsCertificateKeyFile", any
-      # value set for :ssl_cert must also be set for :ssl_key.
-      if @uri_options[:ssl_cert]
-        @uri_options[:ssl_key] = @uri_options[:ssl_cert]
-      end
+      validate_uri_options!
     end
 
     # Get the credentials provided in the URI.
@@ -393,6 +391,12 @@ module Mongo
       [ creds_hosts, db_opts ].map { |s| s.reverse }
     end
 
+    def options_mapper
+      @options_mapper ||= OptionsMapper.new(
+        logger: @options[:logger],
+      )
+    end
+
     def parse_uri_options!(string)
       uri_options = {}
       unless string
@@ -406,12 +410,9 @@ module Mongo
         if value.nil?
           raise_invalid_error!("Option #{key} has no value")
         end
-        if value.index('=')
-          raise_invalid_error!("Value for option #{key} contains the key/value delimiter (=): #{value}")
-        end
         key = decode(key)
         value = decode(value)
-        add_uri_option(key, value, uri_options)
+        options_mapper.add_uri_option(key, value, uri_options)
       end
       uri_options
     end
@@ -458,394 +459,108 @@ module Mongo
     end
 
     def encode(value)
-      ::URI.encode(value)
+      CGI.escape(value).gsub('+', '%20')
     end
 
-    # Hash for storing map of URI option parameters to conversion strategies
-    URI_OPTION_MAP = {}
-
-    # Simple internal dsl to register a MongoDB URI option in the URI_OPTION_MAP.
-    #
-    # @param uri_key [String] The MongoDB URI option to register.
-    # @param name [Symbol] The name of the option in the driver.
-    # @param extra [Hash] Extra options.
-    #   * :group [Symbol] Nested hash where option will go.
-    #   * :type [Symbol] Name of function to transform value.
-    def self.uri_option(uri_key, name, extra = {})
-      URI_OPTION_MAP[uri_key] = { :name => name }.merge(extra)
-    end
-
-    # Replica Set Options
-    uri_option 'replicaset', :replica_set
-
-    # Timeout Options
-    uri_option 'connecttimeoutms', :connect_timeout, :type => :ms
-    uri_option 'sockettimeoutms', :socket_timeout, :type => :ms
-    uri_option 'serverselectiontimeoutms', :server_selection_timeout, :type => :ms
-    uri_option 'localthresholdms', :local_threshold, :type => :ms
-    uri_option 'heartbeatfrequencyms', :heartbeat_frequency, :type => :ms
-    uri_option 'maxidletimems', :max_idle_time, :type => :ms
-
-    # Write Options
-    uri_option 'w', :w, :group => :write_concern, type: :w
-    uri_option 'journal', :j, :group => :write_concern, :type => :bool
-    uri_option 'fsync', :fsync, :group => :write_concern, type: :bool
-    uri_option 'wtimeoutms', :wtimeout, :group => :write_concern, :type => :integer
-
-    # Read Options
-    uri_option 'readpreference', :mode, :group => :read, :type => :read_mode
-    uri_option 'readpreferencetags', :tag_sets, :group => :read, :type => :read_tags
-    uri_option 'maxstalenessseconds', :max_staleness, :group => :read, :type => :max_staleness
-
-    # Pool options
-    uri_option 'minpoolsize', :min_pool_size, :type => :integer
-    uri_option 'maxpoolsize', :max_pool_size, :type => :integer
-    uri_option 'waitqueuetimeoutms', :wait_queue_timeout, :type => :ms
-
-    # Security Options
-    uri_option 'ssl', :ssl, :type => :repeated_bool
-    uri_option 'tls', :ssl, :type => :repeated_bool
-    uri_option 'tlsallowinvalidcertificates', :ssl_verify_certificate,
-               :type => :inverse_bool
-    uri_option 'tlsallowinvalidhostnames', :ssl_verify_hostname,
-               :type => :inverse_bool
-    uri_option 'tlscafile', :ssl_ca_cert
-    uri_option 'tlscertificatekeyfile', :ssl_cert
-    uri_option 'tlscertificatekeyfilepassword', :ssl_key_pass_phrase
-    uri_option 'tlsinsecure', :ssl_verify, :type => :inverse_bool
-
-    # Topology options
-    uri_option 'connect', :connect, type: :symbol
-
-    # Auth Options
-    uri_option 'authsource', :auth_source
-    uri_option 'authmechanism', :auth_mech, :type => :auth_mech
-    uri_option 'authmechanismproperties', :auth_mech_properties, :type => :auth_mech_props
-
-    # Client Options
-    uri_option 'appname', :app_name
-    uri_option 'compressors', :compressors, :type => :array
-    uri_option 'readconcernlevel', :level, group: :read_concern, type: :symbol
-    uri_option 'retryreads', :retry_reads, :type => :bool
-    uri_option 'retrywrites', :retry_writes, :type => :bool
-    uri_option 'zlibcompressionlevel', :zlib_compression_level, :type => :zlib_compression_level
-
-    # Applies URI value transformation by either using the default cast
-    # or a transformation appropriate for the given type.
-    #
-    # @param key [String] URI option name.
-    # @param value [String] The value to be transformed.
-    # @param type [Symbol] The transform method.
-    def apply_transform(key, value, type)
-      if type
-        if respond_to?("convert_#{type}", true)
-          send("convert_#{type}", key, value)
-        else
-          send(type, value)
+    def validate_uri_options!
+      # The URI options spec requires that we raise an error if there are conflicting values of
+      # 'tls' and 'ssl'. In order to fulfill this, we parse the values of each instance into an
+      # array; assuming all values in the array are the same, we replace the array with that value.
+      unless uri_options[:ssl].nil? || uri_options[:ssl].empty?
+        unless uri_options[:ssl].uniq.length == 1
+          raise_invalid_error_no_fmt!("all instances of 'tls' and 'ssl' must have the same value")
         end
-      else
-        value
-      end
-    end
 
-    # Selects the output destination for an option.
-    #
-    # @param [Hash] uri_options The base target.
-    # @param [Symbol] group Group subtarget.
-    #
-    # @return [Hash] The target for the option.
-    def select_target(uri_options, group = nil)
-      if group
-        uri_options[group] ||= {}
-      else
-        uri_options
+        uri_options[:ssl] = uri_options[:ssl].first
       end
-    end
 
-    # Merges a new option into the target.
-    #
-    # If the option exists at the target destination the merge will
-    # be an addition.
-    #
-    # Specifically required to append an additional tag set
-    # to the array of tag sets without overwriting the original.
-    #
-    # @param target [Hash] The destination.
-    # @param value [Object] The value to be merged.
-    # @param name [Symbol] The name of the option.
-    def merge_uri_option(target, value, name)
-      if target.key?(name)
-        if REPEATABLE_OPTIONS.include?(name)
-          target[name] += value
-        else
-          log_warn("Repeated option key: #{name}.")
+      # Check for conflicting TLS insecure options.
+      unless uri_options[:ssl_verify].nil?
+        unless uri_options[:ssl_verify_certificate].nil?
+          raise_invalid_error_no_fmt!("'tlsInsecure' and 'tlsAllowInvalidCertificates' cannot both be specified")
         end
-      else
-        target.merge!(name => value)
-      end
-    end
-
-    # Adds an option to the uri options hash via the supplied strategy.
-    #
-    #   Acquires a target for the option based on group.
-    #   Transforms the value.
-    #   Merges the option into the target.
-    #
-    # @param key [String] URI option name.
-    # @param value [String] The value of the option.
-    # @param uri_options [Hash] The base option target.
-    def add_uri_option(key, value, uri_options)
-      strategy = URI_OPTION_MAP[key.downcase]
-      if strategy.nil?
-        log_warn("Unsupported URI option '#{key}' on URI '#{@string}'. It will be ignored.")
-        return
-      end
-
-      target = select_target(uri_options, strategy[:group])
-      value = apply_transform(key, value, strategy[:type])
-      merge_uri_option(target, value, strategy[:name])
-    end
-
-    # Authentication mechanism transformation.
-    #
-    # @param value [String] The authentication mechanism.
-    #
-    # @return [Symbol] The transformed authentication mechanism.
-    def auth_mech(value)
-      (AUTH_MECH_MAP[value.upcase] || value).tap do |mech|
-        log_warn("#{value} is not a valid auth mechanism") unless mech
-      end
-    end
-
-    # Read preference mode transformation.
-    #
-    # @param value [String] The read mode string value.
-    #
-    # @return [Symbol] The read mode symbol.
-    def read_mode(value)
-      READ_MODE_MAP[value.downcase] || value
-    end
-
-    # Read preference tags transformation.
-    #
-    # @param value [String] The string representing tag set.
-    #
-    # @return [Array<Hash>] Array with tag set.
-    def read_tags(value)
-      [read_set(value)]
-    end
 
-    # Read preference tag set extractor.
-    #
-    # @param value [String] The tag set string.
-    #
-    # @return [Hash] The tag set hash.
-    def read_set(value)
-      hash_extractor('readPreferenceTags', value)
-    end
+        unless uri_options[:ssl_verify_hostname].nil?
+          raise_invalid_error_no_fmt!("tlsInsecure' and 'tlsAllowInvalidHostnames' cannot both be specified")
+        end
 
-    # Auth mechanism properties extractor.
-    #
-    # @param value [ String ] The auth mechanism properties string.
-    #
-    # @return [ Hash ] The auth mechanism properties hash.
-    def auth_mech_props(value)
-      properties = hash_extractor('authMechanismProperties', value)
-      if properties[:canonicalize_host_name]
-        properties.merge!(canonicalize_host_name:
-          properties[:canonicalize_host_name].downcase == 'true')
+        unless uri_options[:ssl_verify_ocsp_endpoint].nil?
+          raise_invalid_error_no_fmt!("tlsInsecure' and 'tlsDisableOCSPEndpointCheck' cannot both be specified")
+        end
       end
-      properties
-    end
 
-    # Parses the zlib compression level.
-    #
-    # @param value [ String ] The zlib compression level string.
-    #
-    # @return [ Integer | nil ] The compression level value if it is between -1 and 9 (inclusive),
-    #   otherwise nil (and a warning will be logged).
-    def zlib_compression_level(value)
-      if /\A-?\d+\z/ =~ value
-        i = value.to_i
-
-        if i >= -1 && i <= 9
-          return i
+      unless uri_options[:ssl_verify_certificate].nil?
+        unless uri_options[:ssl_verify_ocsp_endpoint].nil?
+          raise_invalid_error_no_fmt!("tlsAllowInvalidCertificates' and 'tlsDisableOCSPEndpointCheck' cannot both be specified")
         end
       end
 
-      log_warn("#{value} is not a valid zlibCompressionLevel")
-      nil
-    end
-
-    # Converts the value into a boolean and returns it wrapped in an array.
-    #
-    # @param name [ String ] Name of the URI option being processed.
-    # @param value [ String ] URI option value.
-    #
-    # @return [ Array<true | false> ] The boolean value parsed and wraped
-    #   in an array.
-    def convert_repeated_bool(name, value)
-      [convert_bool(name, value)]
-    end
-
-    # Converts +value+ into an integer.
-    #
-    # If the value is not a valid integer, warns and returns nil.
-    #
-    # @param name [ String ] Name of the URI option being processed.
-    # @param value [ String ] URI option value.
-    #
-    # @return [ nil | Integer ] Converted value.
-    def convert_integer(name, value)
-      unless /\A\d+\z/ =~ value
-        log_warn("#{value} is not a valid integer for #{name}")
-        return nil
+      # Since we know that the only URI option that sets :ssl_cert is
+      # "tlsCertificateKeyFile", any value set for :ssl_cert must also be set
+      # for :ssl_key.
+      if uri_options[:ssl_cert]
+        uri_options[:ssl_key] = uri_options[:ssl_cert]
       end
 
-      value.to_i
-    end
-
-    # Converts +value+ into a symbol.
-    #
-    # @param name [ String ] Name of the URI option being processed.
-    # @param value [ String ] URI option value.
-    #
-    # @return [ Symbol ] Converted value.
-    def convert_symbol(name, value)
-      value.to_sym
-    end
-
-    # Converts +value+ as a write concern.
-    #
-    # If +value+ is the word "majority", returns the symbol :majority.
-    # If +value+ is a number, returns the number as an integer.
-    # Otherwise returns the string +value+ unchanged.
-    #
-    # @param name [ String ] Name of the URI option being processed.
-    # @param value [ String ] URI option value.
-    #
-    # @return [ Integer | Symbol | String ] Converted value.
-    def convert_w(name, value)
-      case value
-      when 'majority'
-        :majority
-      when /\A[0-9]+\z/
-        value.to_i
-      else
-        value
-      end
-    end
-
-    # Converts +value+ to a boolean.
-    #
-    # Returns true for 'true', false for 'false', otherwise nil.
-    #
-    # @param name [ String ] Name of the URI option being processed.
-    # @param value [ String ] URI option value.
-    #
-    # @return [ true | false | nil ] Converted value.
-    def convert_bool(name, value)
-      case value
-      when "true", 'TRUE'
-        true
-      when "false", 'FALSE'
-        false
-      else
-        log_warn("invalid boolean option for #{name}: #{value}")
-        nil
+      if uri_options[:write_concern] && !uri_options[:write_concern].empty?
+        begin
+          WriteConcern.get(uri_options[:write_concern])
+        rescue Error::InvalidWriteConcern => e
+          raise_invalid_error_no_fmt!("#{e.class}: #{e}")
+        end
       end
-    end
-
-    # Parses a boolean value and returns its inverse.
-    #
-    # @param value [ String ] The URI option value.
-    #
-    # @return [ true | false | nil ] The inverse of the  boolean value parsed out, otherwise nil
-    #   (and a warning will be logged).
-    def convert_inverse_bool(name, value)
-      b = convert_bool(name, value)
 
-      if b.nil?
-        nil
-      else
-        !b
+      if uri_options[:direct_connection]
+        if uri_options[:connect] && uri_options[:connect].to_s != 'direct'
+          raise_invalid_error_no_fmt!("directConnection=true cannot be used with connect=#{uri_options[:connect]}")
+        end
+        if servers.length > 1
+          raise_invalid_error_no_fmt!("directConnection=true cannot be used with multiple seeds")
+        end
+      elsif uri_options[:direct_connection] == false && uri_options[:connect].to_s == 'direct'
+        raise_invalid_error_no_fmt!("directConnection=false cannot be used with connect=direct")
       end
-    end
 
-    # Parses the max staleness value, which must be either "0" or an integer greater or equal to 90.
-    #
-    # @param value [ String ] The max staleness string.
-    #
-    # @return [ Integer | nil ] The max staleness integer parsed out if it is valid, otherwise nil
-    #   (and a warning will be logged).
-    def max_staleness(value)
-      if /\A-?\d+\z/ =~ value
-        int = value.to_i
+      if uri_options[:load_balanced]
+        if servers.length > 1
+          raise_invalid_error_no_fmt!("loadBalanced=true cannot be used with multiple seeds")
+        end
 
-        if int == -1
-          int = nil
+        if uri_options[:direct_connection]
+          raise_invalid_error_no_fmt!("directConnection=true cannot be used with loadBalanced=true")
         end
 
-        if int && (int >= 0 && int < 90 || int < 0)
-          log_warn("max staleness should be either 0 or greater than 90: #{value}")
+        if uri_options[:connect] && uri_options[:connect].to_sym == :direct
+          raise_invalid_error_no_fmt!("connect=direct cannot be used with loadBalanced=true")
         end
 
-        return int
+        if uri_options[:replica_set]
+          raise_invalid_error_no_fmt!("loadBalanced=true cannot be used with replicaSet option")
+        end
       end
 
-      log_warn("Invalid max staleness value: #{value}")
-      nil
-    end
-
-    # Ruby's convention is to provide timeouts in seconds, not milliseconds and
-    # to use fractions where more precision is necessary. The connection string
-    # options are always in MS so we provide an easy conversion type.
-    #
-    # @param [ Integer ] value The millisecond value.
-    #
-    # @return [ Float ] The seconds value.
-    #
-    # @since 2.0.0
-    def convert_ms(name, value)
-      unless /\A-?\d+(\.\d+)?\z/ =~ value
-        log_warn("Invalid ms value for #{name}: #{value}")
-        return nil
-      end
+      unless self.is_a?(URI::SRVProtocol)
+        if uri_options[:srv_max_hosts]
+          raise_invalid_error_no_fmt!("srvMaxHosts cannot be used on non-SRV URI")
+        end
 
-      if value[0] == '-'
-        log_warn("#{name} cannot be a negative number")
-        return nil
+        if uri_options[:srv_service_name]
+          raise_invalid_error_no_fmt!("srvServiceName cannot be used on non-SRV URI")
+        end
       end
 
-      value.to_f / 1000
-    end
-
-    # Extract values from the string and put them into a nested hash.
-    #
-    # @param value [ String ] The string to build a hash from.
-    #
-    # @return [ Hash ] The hash built from the string.
-    def hash_extractor(name, value)
-      value.split(',').reduce({}) do |set, tag|
-        k, v = tag.split(':')
-        if v.nil?
-          log_warn("Invalid hash value for #{name}: #{value}")
-          return nil
+      if uri_options[:srv_max_hosts] && uri_options[:srv_max_hosts] > 0
+        if uri_options[:replica_set]
+          raise_invalid_error_no_fmt!("srvMaxHosts > 0 cannot be used with replicaSet option")
         end
 
-        set.merge(k.downcase.to_sym => v)
+        if options[:load_balanced]
+          raise_invalid_error_no_fmt!("srvMaxHosts > 0 cannot be used with loadBalanced=true")
+        end
       end
     end
-
-    # Extract values from the string and put them into an array.
-    #
-    # @param [ String ] value The string to build an array from.
-    #
-    # @return [ Array ] The array built from the string.
-    def array(value)
-      value.split(',')
-    end
   end
 end
 
+require 'mongo/uri/options_mapper'
 require 'mongo/uri/srv_protocol'