Class: Ronin::Web::Spider::Archive

Inherits:
Object
  • Object
show all
Defined in:
lib/ronin/web/spider/archive.rb

Overview

Represents a web archive directory.

Example

Spider a host and archive every web page:

require 'ronin/web/spider'
require 'ronin/web/spider/archive'

Ronin::Web::Spider::Archive.open('path/to/root') do |archive|
  Ronin::Web::Spider.every_page(host: 'example.com') do |page|
    archive.write(page.url,page.body)
  end
end

Direct Known Subclasses

GitArchive

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(root) ⇒ Archive

Initializes the archive.

Parameters:

  • root (String) —

    The path to the root directory.



54
55
56
 
# File 'lib/ronin/web/spider/archive.rb', line 54

def initialize(root)
  @root = File.expand_path(root)
end

Instance Attribute Details

#root ⇒ String (readonly)

The path to the archive root directory.

Returns:

  • (String) 


46
47
48
 
# File 'lib/ronin/web/spider/archive.rb', line 46

def root
  @root
end

Class Method Details

.open(root) {|archive| ... } ⇒ GitArchive

Creates the archive and the archive's directory, if it already does not exist.

Parameters:

  • root (String) —

    The path to the new archive.

Yields:

  • (archive) —

    If a block is given, it will be passed the newly created archive.

Yield Parameters:

  • archive (Archive) —

    The newly created archive.

Returns:



74
75
76
77
78
79
80
81
 
# File 'lib/ronin/web/spider/archive.rb', line 74

def self.open(root)
  archive = new(root)

  FileUtils.mkdir_p(archive.root)

  yield archive if block_given?
  return archive
end

Instance Method Details

#to_s ⇒ String

Converts the archive to a String.

Returns:

  • (String) —

    The path of the archive directory.



112
113
114
 
# File 'lib/ronin/web/spider/archive.rb', line 112

def to_s
  @root
end

#write(url, body) ⇒ String

Archives a webpage.

Parameters:

  • url (URI::HTTP) —

    The URL of the response.

  • body (String) —

    The response body to save.

Returns:

  • (String) —

    The full path to the archived page.



95
96
97
98
99
100
101
102
103
104
 
# File 'lib/ronin/web/spider/archive.rb', line 95

def write(url,body)
  absolute_path = File.join(@root,url.request_uri[1..])
  absolute_path << 'index.html' if absolute_path.end_with?('/')

  parent_dir = File.dirname(absolute_path)

  FileUtils.mkdir_p(parent_dir) unless File.directory?(parent_dir)
  File.write(absolute_path,body)
  return absolute_path
end