# frozen_string_literal: true
#
# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# ronin-support is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# ronin-support is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
#

require 'ronin/support/encoding/uri'

class String

  #
  # URI escapes the String.
  #
  # @param [Hash{Symbol => Object}] kwargs
  #   Additional keyword arguments.
  #
  # @option kwargs [:lower, :upper, nil] :case
  #   Controls whether to output lowercase or uppercase hexadecimal.
  #   Defaults to uppercase hexadecimal.
  #
  # @return [String]
  #   The URI escaped form of the String.
  #
  # @example
  #   "x > y".uri_escape
  #   # => "x%20%3E%20y"
  #
  # @example Lowercase encoding:
  #   "x > y".uri_escape(case: :lower)
  #   # => "x%20%3e%20y"
  #
  # @see Ronin::Support::Encoding::URI.escape
  #
  # @api public
  #
  def uri_escape(**kwargs)
    Ronin::Support::Encoding::URI.escape(self,**kwargs)
  end

  #
  # URI unescapes the String.
  #
  # @return [String]
  #   The unescaped URI form of the String.
  #
  # @example
  #   "sweet%20%26%20sour".uri_unescape
  #   # => "sweet & sour"
  #
  # @see Ronin::Support::Encoding::URI.unescape
  #
  # @api public
  #
  def uri_unescape
    Ronin::Support::Encoding::URI.unescape(self)
  end

  #
  # URI encodes the String.
  #
  # @param [Hash{Symbol => Object}] kwargs
  #   Additional keyword arguments.
  #
  # @option kwargs [:lower, :upper, nil] :case
  #   Controls whether to output lowercase or uppercase hexadecimal.
  #   Defaults to uppercase hexadecimal.
  #
  # @return [String]
  #   The URI encoded form of the String.
  #
  # @example
  #   "plain text".uri_encode
  #   # => "%70%6C%61%69%6E%20%74%65%78%74"
  #
  # @example Lowercase encoding:
  #   "plain text".uri_encode(case: :lower)
  #   # => "%70%6c%61%69%6e%20%74%65%78%74"
  #
  # @see Ronin::Support::Encoding::URI.encode
  #
  # @api public
  #
  def uri_encode(**kwargs)
    Ronin::Support::Encoding::URI.encode(self,**kwargs)
  end

  alias uri_decode uri_unescape

  #
  # URI Form escapes the String.
  #
  # @param [Hash{Symbol => Object}] kwargs
  #   Additional keyword arguments.
  #
  # @option kwargs [:lower, :upper, nil] :case
  #   Controls whether to output lowercase or uppercase hexadecimal.
  #   Defaults to uppercase hexadecimal.
  #
  # @return [String]
  #   The URI Form escaped String.
  #
  # @example
  #   "hello world".uri_form_escape
  #   # => "hello+world"
  #   "hello\0world".uri_form_escape
  #   # => "hello%00world"
  #
  # @example Lowercase encoding:
  #   "hello\xffworld".uri_form_escape(case: :lower)
  #   # => "hello%ffworld"
  #
  # @see https://www.w3.org/TR/2013/CR-html5-20130806/forms.html#url-encoded-form-data
  # @see Ronin::Support::Encoding::URI::Form.escape
  #
  # @api public
  #
  # @since 1.0.0
  #
  def uri_form_escape(**kwargs)
    Ronin::Support::Encoding::URI::Form.escape(self,**kwargs)
  end

  alias www_form_escape uri_form_escape

  #
  # URI Form unescapes the String.
  #
  # @return [String]
  #   The URI Form unescaped String.
  #
  # @example
  #   "hello+world".uri_form_unescape
  #   # => "hello world"
  #   "hello%00world".uri_form_unescape
  #   # => "hello\u0000world"
  #
  # @see Ronin::Support::Encoding::URI::Form.unescape
  #
  # @api public
  #
  def uri_form_unescape
    Ronin::Support::Encoding::URI::Form.unescape(self)
  end

  alias www_form_unescape uri_form_unescape

  #
  # URI Form encodes every character in the String.
  #
  # @param [Hash{Symbol => Object}] kwargs
  #   Additional keyword arguments.
  #
  # @option kwargs [:lower, :upper, nil] :case
  #   Controls whether to output lowercase or uppercase hexadecimal.
  #   Defaults to uppercase hexadecimal.
  #
  # @return [String]
  #   The URI Form encoded String.
  #
  # @example
  #   "hello world".uri_form_encode
  #   # => "%68%65%6C%6C%6F+%77%6F%72%6C%64"
  #
  # @example Lowercase encoding:
  #   "hello world".uri_form_encode(case: :lower)
  #   # => "%68%65%6c%6c%6f+%77%6f%72%6c%64"
  #
  # @see Ronin::Support::Encoding::URI::Form.unescape
  #
  # @api public
  #
  # @since 1.0.0
  #
  def uri_form_encode(**kwargs)
    Ronin::Support::Encoding::URI::Form.encode(self,**kwargs)
  end

  alias www_form_encode uri_form_encode

  alias uri_form_decode uri_form_unescape
  alias www_form_decode uri_form_decode

end