ronin-rb/ronin-support

# frozen_string_literal: true
#
# Copyright (c) 2006-2023 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/gzip/reader'
require 'ronin/support/compression/gzip/writer'

module Ronin
  module Support
    module Compression
      #
      # Handles gzip compression/decompression.
      #
      # @api public
      #
      # @since 1.0.0
      #
      module Gzip
        #
        # Creates a gzip stream around the IO object.
        #
        # @param [IO, StringIO, String] io
        #   The IO or buffer 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 [Reader, Writer] gz
        #   The gzip reader or writer object.
        #
        # @return [Reader, Writer]
        #   The gzip reader or writer object.
        #
        # @raise [ArgumentError]
        #   The mode must include either `r`, `w`, or `a`.
        #
        # @api public
        #
        def self.new(io, mode: 'r', &block)
          gzip_class = if mode.include?('w') || mode.include?('a')
                         Writer
                       elsif mode.include?('r')
                         Reader
                       else
                         raise(ArgumentError,"mode argument must include either 'r', 'w', or 'a': #{mode.inspect}")
                       end

          return gzip_class.wrap(io,&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 [Reader, Writer] gz
        #   The gzip writer object.
        #
        # @return [Reader, Writer]
        #   The gzip writer object.
        #
        # @raise [ArgumentError]
        #   The mode must include either `r`, `w`, or `a`.
        #
        # @api public
        #
        def self.open(path, mode: 'r', &block)
          gzip_class = if mode.include?('w') || mode.include?('a')
                         Writer
                       elsif mode.include?('r')
                         Reader
                       else
                         raise(ArgumentError,"mode argument must include either 'r', 'w', or 'a'")
                       end

          return gzip_class.open(path,&block)
        end
      end
    end
  end
end