# frozen_string_literal: true
#
# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# Ronin is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ronin 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
#

require 'ronin/cli/value_processor_command'
require 'ronin/support/network/ip_range'

module Ronin
  class CLI
    module Commands
      #
      # Enumerates over the IP ranges.
      #
      # ## Usage
      #
      #     ronin iprange [options] [IP_RANGE ... | --start IP --stop IP]
      #
      # ## Options
      #
      #     -f, --file FILE                  Optional file to read values from
      #         --start IP                   Starting IP address
      #         --stop IP                    Stopping IP address
      #     -s, --size                       Prints the size of the IP range
      #     -h, --help                       Print help information
      #
      # ## Arguments
      #
      #    [IP_RANGE ...]                   The IP Range to enumerate
      #
      # ## Examples
      #
      #    ronin iprange 1.1.1.0/24
      #    ronin iprange 1.1.1.*
      #    ronin iprange 1.1.2-4.10-50
      #    ronin iprange --start 1.1.1.10 --stop 1.1.4.100
      #    ronin iprange --file list.txt
      #
      class Iprange < ValueProcessorCommand

        usage '[options] [IP_RANGE ... | --start IP --stop IP]'

        option :start, value: {
                         type: String,
                         usage: 'IP'
                       },
                       desc: 'Starting IP address' do |ip|
                         @start << ip
                       end

        option :stop, value: {
                        type: String,
                        usage: 'IP'
                      },
                      desc: 'Stopping IP address' do |ip|
                        @stop << ip
                      end

        option :size, short: '-s',
                      desc:  'Prints the size of the IP range'

        argument :ip_range, required: false,
                            repeats:  true,
                            desc:     'The IP Range to enumerate'

        description 'Enumerates over IP ranges'

        examples [
          "1.1.1.0/24",
          "1.1.1.*",
          "1.1.2-4.10-50",
          "--start 1.1.1.10 --stop 1.1.4.100",
          "--input list.txt"
        ]

        man_page 'ronin-iprange.1'

        #
        # Initializes the `ronin iprange` command.
        #
        def initialize(**kwargs)
          super(**kwargs)

          @start = []
          @stop  = []
        end

        #
        # Runs the `ronin iprange` command.
        #
        # @param [Array<String>] ip_ranges
        #   Optional list of IP ranges to enumerate.
        #
        def run(*ip_ranges)
          if !@start.empty? && !@stop.empty?
            unless @start.length == @stop.length
              print_error "must specify an equal number of --start and --stop options"
              exit(-1)
            end

            @start.zip(@stop).each do |(start,stop)|
              range = Support::Network::IPRange::Range.new(start,stop)

              process_ip_range(range)
            end
          else
            super(*ip_ranges)
          end
        end

        #
        # Processes an IP range.
        #
        # @param [String] string
        #
        def process_value(string)
          range = Support::Network::IPRange.new(string)

          process_ip_range(range)
        end

        #
        # Processes a parsed IP range object.
        #
        # @param [Ronin::Support::Network::IPRange,
        #         Ronin::Support::Network::IPRange::Range] ip_range
        #   The IP range to process.
        #
        def process_ip_range(ip_range)
          if options[:size]
            puts ip_range.size
          else
            ip_range.each do |ip|
              puts ip
            end
          end
        end

      end
    end
  end
end