-
-
Notifications
You must be signed in to change notification settings - Fork 53
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add ronin compress
command
#184
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
# 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/string_methods_command' | ||
require 'ronin/support/compression' | ||
require 'ronin/support/archive' | ||
|
||
module Ronin | ||
class CLI | ||
module Commands | ||
# | ||
# Compress the files. | ||
# | ||
# ## Usage | ||
# | ||
# ronin compress [option] [FILE ...] | ||
# | ||
# ## Options | ||
# | ||
# -z, --zip zip archive the data | ||
# -t, --tar tar archive the data | ||
# -g, --gzip gzip compresses the data | ||
# | ||
# ## Arguments | ||
# | ||
# [FILE ...] Optional file(s) to compress | ||
# | ||
class Compress < StringMethodsCommand | ||
usage '[option] [FILE ...]' | ||
|
||
option :gzip, short: '-g', | ||
desc: 'gzip compresses the data' do | ||
@format = :gzip | ||
end | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If we're going to support |
||
|
||
option :tar, short: '-t', | ||
desc: 'tar archive the data' do | ||
@format = :tar | ||
end | ||
|
||
option :zip, short: '-z', | ||
desc: 'zip archive the data' do | ||
@format = :zip | ||
end | ||
|
||
description 'Compress the data' | ||
|
||
man_page 'ronin-compress.1' | ||
|
||
# | ||
# The compression format. | ||
# | ||
# @return Symbol | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I tend to explicitly list the possible values |
||
# | ||
attr_reader :format | ||
|
||
def initialize(**kwargs) | ||
postmodern marked this conversation as resolved.
Show resolved
Hide resolved
|
||
super(**kwargs) | ||
|
||
@format = :gzip | ||
end | ||
|
||
def process_file(file) | ||
compression_class.send(@format, "#{file}.#{extension}") do |c| | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe rename There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So here's a question, if you gave this command the |
||
c.write File.read(file) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The files being compressed could be very very large. Probably more efficient to open the input file and read chunks of data from it using |
||
end | ||
end | ||
|
||
private | ||
|
||
def compression_class | ||
if @format == :gzip | ||
Ronin::Support::Compression | ||
else | ||
Ronin::Support::Archive | ||
end | ||
end | ||
postmodern marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
def extension | ||
return "gz" if @format == :gzip | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We could probably set an |
||
|
||
@format.to_s | ||
end | ||
end | ||
end | ||
end | ||
end |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we only want to support processing files, then probably want to inherit from
FileProcessorCommand
, and define aprocess_input(io)
method to compress the input File or fromstdin
.If we do want to support accepting arbitrary Strings (ex:
ronin compress --string "hello world"
), then we should inherit fromStringProcessorCommand
.StringMethodsCommand
is more meant to be used by commands which simply map options to certain monkey-patch methods that are added toString
(ex:ronin decode --base64
->String#base64_decode
).