puppet-filebucket-util/bucket-tool

429 lines
9.7 KiB
Plaintext
Raw Normal View History

2024-05-17 20:33:48 +00:00
#!/usr/bin/ruby
# BEGIN: Helper Functions
def usage
puts "#{__FILE__} [ACTION <arg>] [<flags>]
2024-05-18 18:12:27 +00:00
Description:
This utlity is meant to be used to interact with & manage the filebucket on P4 nodes due to the
utility for that `puppet filebucket -l <action>` being nonfunctional.
This implements the same functionality (minus the puppet tie-in) and will allow the user to
search the filebucket and restore from it.
2024-05-17 20:33:48 +00:00
Actions:
2024-05-25 00:13:55 +00:00
search <term> : Search for bucket entries matching a portion of the filepath
2024-05-24 13:54:04 +00:00
list : List all Bucket entries
list-files : List all files/paths that have been backed up to the bucket
get <entry-hash> : Get the content of a specific entry (by hash)
2024-05-25 00:13:55 +00:00
restore <value> : Restore previous state of file stored in bucket. Value can be hash or filename/filepath
2024-05-17 20:33:48 +00:00
Global Flags:
2024-05-24 13:54:04 +00:00
-d | --debug : Set debug flag
-h | --help : This help message
2024-05-18 18:12:27 +00:00
Author:
Name: Tristan Ancelet
Email: tristan.ancelet@acumera.com
Phone (Work) #: +1 (337) 965-1855
2024-05-17 20:33:48 +00:00
"
end
def log (message, level = 0)
if $DEBUG == true or $CONFIG[:log_file] != ""
if message == ""
puts "log was called without providing a message"
exit
end
case level
when 0
level="INFO"
when 1
level="WARN"
when 2
level="CRIT"
else
level="UNDF"
end
datestamp=Time.now
log_message="#{datestamp} : #{$HOSTNAME} : #{level} : #{caller[0]} : #{message}"
if $CONFIG[:log_file] != ""
File.open($CONFIG[:log_file],'a') do |file|
file.write("#{log_message}\n")
end
else
puts log_message
end
end
end
2024-05-18 23:40:58 +00:00
def get_verification (prompt = "Do you want to continue?")
while true
puts "#{prompt} (y/n): "
answer = STDIN.gets
answer = answer.strip()
case answer
when 'y','yes'
return true
when 'n', 'no'
return false
else
puts "#{answer} is not an acceptible answer"
end
end
end
2024-05-25 00:13:55 +00:00
def get_selections (reference_array, prompt = "Which of the following do you want to select? ", options = { :multiple => false, }, &procedure)
## Making clone of array since the selections were passed by reference
selections = reference_array.clone
def put_prompt (selections, prompt)
puts prompt
selections.each_with_index do |value,index|
puts "#{index} : #{value}"
end
end
def add_value(output_list, item, procedure)
value =
end
if options[:multiple] == true
output = Array.new
else
output = ""
end
put_prompt selections, prompt
while true
choice = Integer(STDIN.gets.strip())
if choice.is_a? Integer
if choice >= 0 and choice < selections.count
if options[:multiple] == true
output.push(selections[choice])
selections.delete_at(choice)
if get_verification "Are you done selecting?"
break
end
put_prompt selections, prompt
else
output = selections[choice]
break
end
else
puts "#{choice} is not between the values of 0 and #{selections.count}. Please try again."
end
else
puts "#{choice} is not a valid option. Please try again."
end
end
output
end
2024-05-17 20:33:48 +00:00
# END: Helper Functions
2024-05-18 18:12:27 +00:00
# BEGIN: Variables
if not (ARGV & ['-h', '--help']).empty?
usage
exit
end
if ENV["USER"] != 'root'
puts "This script should only be run by root (permissions issues). Please rerun it as root or prepend \"sudo\""
exit
end
$DEBUG=false
$CONFIG = Hash.new
2024-05-18 23:40:58 +00:00
$CONFIG[:bucket_dir]=` puppet agent --configprint clientbucketdir `.strip()
2024-05-18 18:12:27 +00:00
$CONFIG[:action]=""
$CONFIG[:search_term]=""
$CONFIG[:log_file]=""
File.open('/etc/hostname') do |file|
$HOSTNAME=file.read().strip()
end
FLAG_REGEX=/\-+\S+/
# END: Variables
2024-05-17 20:33:48 +00:00
# BEGIN: Handle CLI Args
2024-05-18 18:12:27 +00:00
2024-05-17 20:33:48 +00:00
if ARGV.count == 0
puts "No arguments were provided"
usage
exit
end
if not (ARGV & ['-d', '--debug']).empty?
$DEBUG=true
end
i=0
case ARGV[i]
2024-05-18 23:40:58 +00:00
when 'search', 'get', 'restore'
$CONFIG[:action]=ARGV[i]
2024-05-17 20:33:48 +00:00
log "$CONFIG[:action] was set to #{ARGV[i]}"
log "user provided search action ARGV[i.next] == #{ARGV[i.next]}"
if ARGV[i.next] != "" and not ARGV[i.next] =~ FLAG_REGEX
$CONFIG[:search_term]=ARGV[i.next]
log "search_term was set to #{ARGV[i.next]}"
i+=2
else
puts "Flag[#{ARGV[i]}] : Argument[#{ARGV[i.next]}] : Either the argument was not provided or it was a flag"
usage
exit
end
2024-05-18 23:40:58 +00:00
when 'list', 'list-files'
$CONFIG[:action] = ARGV[i]
2024-05-17 20:33:48 +00:00
log "$CONFIG[:action] was set to #{ARGV[i]}"
i+=1
else
puts "#{ARGV[i]} is not a valid action. Please make sure you use a valid action as the first argument of the script"
usage
exit
end
## BEGIN: Checks
if $CONFIG[:action] == ""
puts "Action was not provided"
end
case $CONFIG[:action]
when 'search', 'get'
if $CONFIG[:search_term] == ""
puts "Search Term was not provided"
usage
exit
end
2024-05-25 00:13:55 +00:00
2024-05-17 20:33:48 +00:00
end
## END: Checks
# END: Handle CLI Args
# BEGIN: Classes
class BucketEntry
attr_reader :hash, :filepaths, :mtime
2024-05-17 20:33:48 +00:00
def initialize (entry_dir)
@entry_dir = entry_dir
@hash = File.basename(entry_dir)
2024-05-17 20:33:48 +00:00
@filepaths = Array.new
File.open("#{entry_dir}/paths") do |file|
file.read().split(/\n/).each do |path|
log "BucketEntry[#{@hash}] adding #{path} to @filepaths"
2024-05-17 20:33:48 +00:00
@filepaths.push(path)
end
end
@mtime = File.mtime(entry_dir)
log "BucketEntry was created from #{entry_dir}"
end
def path_include? (path_string)
log "BucketEntry[#{hash}] was called with #{path_string}"
2024-05-17 20:33:48 +00:00
@filepaths.each.any? {|path| path.include? path_string}
end
def infostring
"Entry [#{@hash}]:
2024-05-17 20:33:48 +00:00
Paths: #{@filepaths.join(',')}
MTIME: #{@mtime}
"
end
def inline_info
"#{@mtime} : #{@hash} : #{@filepaths.join(',')}"
2024-05-17 20:33:48 +00:00
end
def content
log "BucketEntry[#{@hash}] getting contents"
2024-05-17 20:33:48 +00:00
File.open("#{@entry_dir}/contents",'r') do |file|
file.read()
end
end
end
class Bucket
attr_reader :bucketdir, :entries
def initialize (clientbucketdir)
log "Bucket is being created from #{clientbucketdir}"
@bucketdir = clientbucketdir
@entries = Hash.new
2024-05-17 20:33:48 +00:00
load_bucket
end
def load_bucket
log "Bucket[#{@bucketdir}] is loading entries"
Dir["#{@bucketdir}/**/paths"].each.map{|path| File.dirname(path)}.each do |directory|
log "\"#{directory}\" was grabbed from bucket directory. Making new BucketEntry"
entry = BucketEntry.new(directory)
@entries[entry.hash]=entry
log "BucketEntry[#{entry.hash}] was added to @entries Size=#{@entries.count()}"
2024-05-17 20:33:48 +00:00
end
log "Bucket[#{@bucketdir}] was loaded"
end
2024-05-25 00:13:55 +00:00
def filenames
filenames = Array.new
@entries.each_value do |entry|
entry.filepaths.each do |path|
if not filenames.include? path
filenames.push(path)
end
end
end
filesnames
end
2024-05-17 20:33:48 +00:00
end
# END: Classes
# BEGIN: Work Functions
def search_entries_paths (bucket)
log "user entered"
2024-05-24 13:54:04 +00:00
puts bucket.entries.each_value.select {|entry| entry.path_include? $CONFIG[:search_term]}.map{|entry| entry.inline_info}.sort.join("\n")
2024-05-17 20:33:48 +00:00
end
def get_content_of_entry_hash (bucket)
2024-05-17 20:33:48 +00:00
log "user entered"
if bucket.entries.has_key? $CONFIG[:search_term]
puts bucket.entries[$CONFIG[:search_term]].content
else
puts "There were no entries corresponding to #{$CONFIG[:search_term]}"
exit
2024-05-17 20:33:48 +00:00
end
end
def list_all_entries (bucket)
puts bucket.entries.each_value.each.map{|entry| entry.inline_info}.sort.join("\n")
2024-05-17 20:33:48 +00:00
end
def list_entry_files (bucket)
2024-05-25 00:13:55 +00:00
puts bucket.filenames.sort.join("\n")
end
def get_entry_by_file (bucket, filenames)
filename = ""
if filenames.count == 1
filename = filenames[0]
else
filename = get_selections filenames, "Your filename matched multiple files. Please select one to restore"
end
entries = bucket.entries.each_value.select{|entry| entry.filepaths.include filename}
if entries.count == 1
entry = entries[0]
else
while true {
entry_timestamp_selection = get_selections entries.map{|entry| entry.mtime}, "Which timestamp to you want to revert the file to?" {|entry| entry.hash}
entries.each_value.select
entry =
if get_verification "Do you want to see the contents of #{filename} at this time?"
puts entry.content
2024-05-17 20:33:48 +00:00
end
2024-05-25 00:13:55 +00:00
}
2024-05-17 20:33:48 +00:00
end
2024-05-25 00:13:55 +00:00
if filename[0] != '/'
filename = "/#{filename}"
end
2024-05-17 20:33:48 +00:00
end
2024-05-25 00:13:55 +00:00
def get_entry_by_hash (bucket)
2024-05-18 23:40:58 +00:00
if bucket.entries.has_key? $CONFIG[:search_term]
entry = bucket.entries[$CONFIG[:search_term]]
2024-05-25 00:13:55 +00:00
filepath = ""
2024-05-18 23:40:58 +00:00
if entry.filepaths.count == 1
filepath = entry.filepaths[0]
2024-05-25 00:13:55 +00:00
else
filepath = get_selections entry.filepaths, "What filepath do you wish to restore to?"
2024-05-18 23:40:58 +00:00
end
2024-05-25 00:13:55 +00:00
if filepath[0] != '/'
filepath = "/#{filepath}"
end
return entry, filepath
2024-05-18 23:40:58 +00:00
else
puts "There were no entries corresponding to #{$CONFIG[:search_term]}"
end
end
2024-05-25 00:13:55 +00:00
def restore_entry (bucket)
entry = nil
if bucket.filenames.any{ |filename| filename.include? $CONFIG[:search_term] }
filenames = bucket.filenames.select {|filename| filename.include $CONFIG[:search_term]}
entry, filepath = get_entry_by_file bucket, filenames
else
entry, filepath = get_entry_by_hash bucket
end
if get_verification "Are you sure you want to overwrite #{filepath}?"
File.open(filepath,'w') do |file|
file.write(entry.content)
end
else
puts "Ok not overwriting."
end
end
2024-05-17 20:33:48 +00:00
# END: Work Functions
# BEGIN: Work
if __FILE__ == $0
bucket = Bucket.new($CONFIG[:bucket_dir])
case $CONFIG[:action]
when 'search'
search_entries_paths bucket
when 'get'
get_content_of_entry_hash bucket
2024-05-17 20:33:48 +00:00
when 'list'
list_all_entries bucket
when 'list-files'
list_entry_files bucket
2024-05-18 23:40:58 +00:00
when 'restore'
restore_entry bucket
2024-05-17 20:33:48 +00:00
end
end
# END: Work