#
# Ronin Web - A Ruby library for Ronin that provides support for web
# scraping and spidering functionality.
#
# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# This file is part of Ronin Web.
#
# 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 <http://www.gnu.org/licenses/>.
#

require 'ronin/web/middleware/base'

module Ronin
  module Web
    module Middleware
      #
      # A Rack middleware to host local files at specific remote paths.
      #
      #     use Ronin::Web::Middleware::Files do |files|
      #       files.map '/foo.txt', 'foo.txt'
      #       files.map /\.exe$/, 'trojan.exe'
      #     end
      #
      class Files < Base

        # The mapping of remote paths to local paths
        attr_reader :paths

        #
        # Creates a new {Files} middleware.
        #
        # @param [#call] app
        #   The application the middleware sits in front of.
        #
        # @param [Hash] options
        #   Additional options.
        #
        # @option options [Integer] :status (200)
        #   The status code to return.
        #
        # @option options [Hash] :headers
        #   The headers to return.
        #
        # @option options [Hash] :paths
        #   The mapping of remote paths to local paths.
        #
        # @yield [files]
        #   If a block is given, it will be passed the new files middleware.
        #
        # @yieldparam [Files] files
        #   The new files middleware object.
        #
        # @since 0.3.0
        #
        # @api public
        #
        def initialize(app,options={},&block)
          @paths = {}

          if options.has_key?(:paths)
            options[:paths].each do |remote_path,local_path|
              map(remote_path,local_path)
            end
          end

          super(app,&block)
        end

        #
        # Maps the local path to a remote path.
        #
        # @param [Regexp, String] remote_path
        #   The remote path to expose.
        #
        # @param [String] local_path
        #   The local path to host.
        #
        # @return [true]
        #
        # @example Mapping a path
        #   map '/foo.txt', 'foo.txt'
        #
        # @example Mapping multiple paths using a regular expression
        #   map /\.exe$/, 'trojan.exe'
        #
        # @since 0.3.0
        #
        # @api public
        #
        def map(remote_path,local_path)
          @paths[remote_path] = local_path
          return true
        end

        #
        # Returns a local file if it was mapped to a remote path.
        #
        # @param [Hash, Rack::Request] env
        #   The request.
        #
        # @return [Array, Response]
        #   The response.
        #
        # @since 0.3.0
        #
        # @api public
        #
        def call(env)
          path = sanitize_path(env['PATH_INFO'])

          @paths.each do |pattern,local_path|
            matched = if pattern.kind_of?(Regexp)
                        path =~ pattern
                      else
                        path == pattern
                      end

            if matched
              request = Request.new(env)

              print_info "Returning file #{local_path.dump} for #{request.address}"
              return response_for(local_path)
            end
          end

          super(env)
        end

      end
    end
  end
end