# frozen_string_literal: true
#
# Copyright (c) 2006-2022 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/compression'

module Ronin
  module Support
    module Compression
      #
      # Provides helper methods for compression algorithms/formats.
      #
      # @api public
      #
      # @since 1.0.0
      #
      module Mixin
        #
        # Zlib inflate a string.
        #
        # @param [String] string
        #   The Zlib compressed input.
        #
        # @return [String]
        #   The Zlib inflated form of the input.
        #
        # @example
        #   zlib_inflate("x\x9C\xCBH\xCD\xC9\xC9\a\x00\x06,\x02\x15")
        #   # => "hello"
        #
        # @api public
        #
        def zlib_inflate(string)
          Compression.zlib_inflate(string)
        end

        #
        # Zlib deflate a string.
        #
        # @param [String] string
        #   The uncompressed input.
        #
        # @return [String]
        #   The Zlib deflated form of the input.
        #
        # @example
        #   zlib_deflate("hello")
        #   # => "x\x9C\xCBH\xCD\xC9\xC9\a\x00\x06,\x02\x15"
        #
        # @api public
        #
        def zlib_deflate(string)
          Compression.zlib_deflate(string)
        end

        #
        # Creates a gzip stream around the IO object.
        #
        # @param [IO, Tempfile, StringIO, String] io
        #   The IO object to read or write data to.
        #
        # @param [String] mode
        #   The mode to open the gzip stream in.
        #
        # @yield [gz]
        #   If a block is given, it will be passed the gzip stream object.
        #
        # @yieldparam [Ronin::Support::Compression::Gzip::Reader, Ronin::Support::Compression::Gzip::Writer] gz
        #   The gzip reader or writer object.
        #
        # @return [Ronin::Support::Compression::Gzip::Reader, Ronin::Support::Compression::Gzip::Writer]
        #   The gzip reader or writer object.
        #
        # @raise [ArgumentError]
        #   The IO object must be either an `IO`, `Tempfile`, `StringIO`, or
        #   `String` object. The mode must include either `r`, `w`, or `a`.
        #
        # @see https://rubydoc.info/stdlib/zlib/Zlib/GzipReader
        # @see https://rubydoc.info/stdlib/zlib/Zlib/GzipWriter
        # @see Gzip.new
        #
        # @api public
        #
        def gzip_stream(io, mode: 'r', &block)
          Compression.gzip_stream(io,mode: mode,&block)
        end

        #
        # Opens a gzip file for reading or writing.
        #
        # @param [String] path
        #   The path to the gzip file.
        #
        # @param [String] mode
        #   The mode to open the file as.
        #
        # @yield [gz]
        #   If a block is given, it will be passed the gzip writer object.
        #
        # @yieldparam [Ronin::Support::Compression::Gzip::Reader, Ronin::Support::Compression::Gzip::Writer] gz
        #   The gzip stream object.
        #
        # @return [Ronin::Support::Compression::Gzip::Reader, Ronin::Support::Compression::Gzip::Writer]
        #   The gzip stream object.
        #
        # @raise [ArgumentError]
        #   The mode must include either `r`, `w`, or `a`.
        #
        # @see https://rubydoc.info/stdlib/zlib/Zlib/GzipWriter
        # @see Gzip.open
        #
        # @api public
        #
        def gzip_open(path, mode: 'r', &block)
          Compression.gzip_open(path,mode: mode,&block)
        end

        #
        # Opens the gzipped file for reading.
        #
        # @param [String] path
        #   The path to the file to read.
        #
        # @yield [gz]
        #   If a block is given, it will be passed the gzip reader object.
        #
        # @yieldparam [Ronin::Support::Compression::Gzip::Reader] gz
        #   The gzip reader object.
        #
        # @return [Ronin::Support::Compression::Gzip::Reader]
        #   The gzip reader object.
        #
        # @see #gzip_open
        #
        # @api public
        #
        def gunzip(path,&block)
          Compression.gunzip(path,&block)
        end

        #
        # Opens the gzip file for writing.
        #
        # @param [String] path
        #   The path to the file to write to.
        #
        # @yield [gz]
        #   If a block is given, it will be passed the gzip writer object.
        #
        # @yieldparam [Ronin::Support::Compression::Gzip::Writer] gz
        #   The gzip writer object.
        #
        # @return [Ronin::Support::Compression::Gzip::Writer]
        #   The gzip writer object.
        #
        # @see #gzip_open
        #
        # @api public
        #
        def gzip(path,&block)
          Compression.gzip(path,&block)
        end
      end
    end
  end
end