# Copyright (C) 2009-2013 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

module Mongo
  # Generic Mongo Ruby Driver exception class.
  class MongoRubyError < StandardError; end

  # Raised when MongoDB itself has returned an error.
  class MongoDBError < RuntimeError

     # @return The entire failed command's response object, if available.
     attr_reader :result

     # @return The failed command's error code, if availab.e
     attr_reader :error_code

     def initialize(message=nil, error_code=nil, result=nil)
       @error_code = error_code
       @result = result
       super(message)
     end
  end

  # Raised on fatal errors to GridFS.
  class GridError < MongoRubyError; end

  # Raised on fatal errors to GridFS.
  class GridFileNotFound < GridError; end

  # Raised on fatal errors to GridFS.
  class GridMD5Failure < GridError; end

  # Raised when invalid arguments are sent to Mongo Ruby methods.
  class MongoArgumentError < MongoRubyError; end

  # Raised on failures in connection to the database server.
  class ConnectionError < MongoRubyError; end

  # Raised on failures in connection to the database server.
  class ReplicaSetConnectionError < ConnectionError; end

  # Raised on failures in connection to the database server.
  class ConnectionTimeoutError < MongoRubyError; end

  # Raised when no tags in a read preference maps to a given connection.
  class NodeWithTagsNotFound < MongoRubyError; end

  # Raised when a connection operation fails.
  class ConnectionFailure < MongoDBError; end

  # Raised when authentication fails.
  class AuthenticationError < MongoDBError; end

  # Raised when a database operation fails.
  class OperationFailure < MongoDBError; end

  # Raised when a database operation exceeds maximum specified time.
  class ExecutionTimeout < OperationFailure; end

  # Raised when a database operation has a write concern error.
  class WriteConcernError < OperationFailure; end

  # Raised when a socket read operation times out.
  class OperationTimeout < SocketError; end

  # Raised when a client attempts to perform an invalid operation.
  class InvalidOperation < MongoDBError; end

  # Raised when an invalid collection or database name is used (invalid namespace name).
  class InvalidNSName < RuntimeError; end

  # Raised when the client supplies an invalid value to sort by.
  class InvalidSortValueError < MongoRubyError; end

  # Raised for bulk write errors.
  class BulkWriteError < OperationFailure; end

  # This exception is raised when the server nonce returned does not
  # match the client nonce sent to it.
  #
  # @since 1.12.0
  class InvalidNonce < OperationFailure

    # @return [ String ] nonce The client nonce.
    attr_reader :nonce

    # @return [ String ] rnonce The server nonce.
    attr_reader :rnonce

    # Instantiate the new exception.
    #
    # @example Create the exception.
    #   InvalidNonce.new(nonce, rnonce)
    #
    # @param [ String ] nonce The client nonce.
    # @param [ String ] rnonce The server nonce.
    #
    # @since 1.12.0
    def initialize(nonce, rnonce)
      @nonce = nonce
      @rnonce = rnonce
      super("Expected server rnonce '#{rnonce}' to start with client nonce '#{nonce}'.")
    end
  end

  # This exception is raised when the server verifier does not match the
  # expected signature on the client.
  #
  # @since 1.12.0
  class InvalidSignature < OperationFailure

    # @return [ String ] verifier The server verifier string.
    attr_reader :verifier

    # @return [ String ] server_signature The expected server signature.
    attr_reader :server_signature

    # Create the new exception.
    #
    # @example Create the new exception.
    #   InvalidSignature.new(verifier, server_signature)
    #
    # @param [ String ] verifier The verifier returned from the server.
    # @param [ String ] server_signature The expected value from the
    #   server.
    #
    # @since 1.12.0
    def initialize(verifier, server_signature)
      @verifier = verifier
      @server_signature = server_signature
      super("Expected server verifier '#{verifier}' to match '#{server_signature}'.")
    end
  end
end