Class: Morpheus::Cli::Shell
- Inherits:
-
Object
- Object
- Morpheus::Cli::Shell
show all
- Includes:
- CliCommand
- Defined in:
- lib/morpheus/cli/shell.rb
Overview
class Morpheus::Cli::Shell < Morpheus::Terminal
Constant Summary
collapse
- @@instance =
nil
Instance Attribute Summary collapse
Attributes included from CliCommand
#no_prompt
Class Method Summary
collapse
Instance Method Summary
collapse
Methods included from CliCommand
#build_common_options, #build_option_type_options, #command_name, #default_refresh_interval, #default_subcommand, #establish_remote_appliance_connection, #full_command_usage, #handle_subcommand, included, #interactive?, #my_help_command, #my_terminal, #my_terminal=, #parse_id_list, #parse_list_options, #parse_list_subtitles, #print, #print_error, #puts, #puts_error, #raise_command_error, #render_with_format, #run_command_for_each_arg, #subcommand_aliases, #subcommand_usage, #subcommands, #usage, #verify_access_token!
Constructor Details
#initialize ⇒ Shell
Returns a new instance of Shell.
41
42
43
44
|
# File 'lib/morpheus/cli/shell.rb', line 41
def initialize()
@@instance = self
reinitialize()
end
|
Instance Attribute Details
#prompt ⇒ Object
39
40
41
|
# File 'lib/morpheus/cli/shell.rb', line 39
def prompt
@prompt
end
|
Class Method Details
.has_instance? ⇒ Boolean
23
24
25
|
# File 'lib/morpheus/cli/shell.rb', line 23
def self.has_instance?
defined?(@@instance) && @@instance
end
|
.insecure ⇒ Object
35
36
37
|
# File 'lib/morpheus/cli/shell.rb', line 35
def self.insecure
!!(defined?(@@insecure) && @@insecure == true)
end
|
.instance ⇒ Object
27
28
29
|
# File 'lib/morpheus/cli/shell.rb', line 27
def self.instance
@@instance ||= reload_instance
end
|
.reload_instance ⇒ Object
31
32
33
|
# File 'lib/morpheus/cli/shell.rb', line 31
def self.reload_instance
@@instance = self.new
end
|
Instance Method Details
#_old_load_history_from_log_file(n_commands = 1000) ⇒ Object
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
|
# File 'lib/morpheus/cli/shell.rb', line 585
def _old_load_history_from_log_file(n_commands=1000)
@history ||= {}
@last_command_number ||= 0
begin
if Gem.win_platform?
return @history
end
file_path = history_file_path
FileUtils.mkdir_p(File.dirname(file_path))
n_lines = n_commands + 500
history_lines = `tail -n #{n_lines} #{file_path}`.split(/\n/)
command_lines = history_lines.select do |line|
line.match(/\(cmd (\d+)\) (.+)/)
end
command_lines = command_lines.last(n_commands)
command_lines.each do |line|
matches = line.match(/\(cmd (\d+)\) (.+)/)
if matches && matches.size == 3
cmd_number = matches[1].to_i
cmd = matches[2]
@last_command_number = cmd_number
@history[@last_command_number] = cmd
Readline::HISTORY << cmd
end
end
rescue => e
@history = {}
end
return @history
end
|
#execute(input) ⇒ Object
execute the input as an expression. provides support for operators ‘(’, ‘)’, ‘&&’, ‘||’, ‘;’ logs entire input as one command in shell history logging is skipped for certain commands: exit, !, !!
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
|
# File 'lib/morpheus/cli/shell.rb', line 249
def execute(input)
unless input.strip.empty? || input.strip[0] == "!"
log_history_command(input.strip)
end
input = input.to_s.strip
if !input.empty?
if input == 'exit'
@exit_now_please = true
return 0
elsif input == 'help'
puts "You are in a morpheus client shell."
puts "See the available commands below."
puts "\nCommands:"
@morpheus_commands.sort.each {|cmd|
puts "\t#{cmd.to_s}"
}
puts "\nShell Commands:"
@shell_commands.each {|cmd|
puts "\t#{cmd.to_s}"
}
puts "\n"
puts "For more information, see https://github.com/gomorpheus/morpheus-cli/wiki"
return 0
elsif input =~ /^\s*#/
Morpheus::Logging::DarkPrinter.puts "ignored comment: #{input}" if Morpheus::Logging.debug?
return 0
elsif input == 'clear'
print "\e[H\e[2J"
return 0
elsif input == 'reload' || input == 'reload!'
Morpheus::Cli::CliRegistry.instance.flush
Morpheus::Cli.load!
if File.exists?(Morpheus::Cli::DotFile.morpheus_profile_filename)
Morpheus::Cli::DotFile.new(Morpheus::Cli::DotFile.morpheus_profile_filename).execute()
end
if File.exists?(Morpheus::Cli::DotFile.morpheusrc_filename)
Morpheus::Cli::DotFile.new(Morpheus::Cli::DotFile.morpheusrc_filename).execute()
end
reinitialize()
Morpheus::Logging::DarkPrinter.puts "shell has been reloaded" if Morpheus::Logging.debug?
return 0
elsif input == '!!'
cmd_number = @history.keys[-1]
input = @history[cmd_number]
if !input
puts "There is no previous command"
return false
end
return execute(input)
elsif input =~ /^\!.+/
cmd_number = input.sub("!", "").to_i
if cmd_number != 0
old_input = @history[cmd_number]
if !old_input
puts "Command not found by number #{cmd_number}"
return 0
end
Readline::HISTORY.pop
Readline::HISTORY << old_input
return execute(old_input)
end
elsif input == "insecure"
Morpheus::RestClient.enable_ssl_verification = false
return 0
elsif ["hello","hi","hey","hola"].include?(input.strip.downcase)
wallet = Morpheus::Cli::Credentials.new(@appliance_name, @appliance_url).load_saved_credentials
if wallet
print "#{input} #{green}#{wallet['username']}#{reset}, how may I #{cyan}help#{reset} you?\n"
else
print "#{input}, how may I #{cyan}help#{reset} you?\n"
end
return 0
elsif input == "shell"
print "#{cyan}You are already in a shell.#{reset}\n"
return false
elsif input =~ /^\.\s/
log_history_command(input)
return Morpheus::Cli::SourceCommand.new.handle(input.split[1..-1])
end
cmd_result = nil
begin
argv = Shellwords.shellsplit(input)
cmd_name = argv[0]
cmd_args = argv[1..-1]
@return_to_log_level = ["log-level","debug"].include?(cmd_name) ? nil : Morpheus::Logging.log_level
@return_to_coloring = ["coloring"].include?(cmd_name) ? nil : Term::ANSIColor::coloring?
@return_to_benchmarking = ["benchmark"].include?(cmd_name) ? nil : Morpheus::Benchmarking.enabled?
if my_terminal.benchmarking || cmd_args.include?("-B") || cmd_args.include?("--benchmark")
if cmd_name != 'benchmark' benchmark_name = argv.reject {|it| it == '-B' || it == '--benchmark' }.join(' ')
start_benchmark(benchmark_name)
end
end
cmd_exit_code, cmd_err = Morpheus::Cli::CliRegistry.exec_expression(input)
benchmark_record = stop_benchmark(cmd_exit_code, cmd_err) Morpheus::Logging::DarkPrinter.puts(cyan + dark + benchmark_record.msg) if benchmark_record
rescue Interrupt
@history_logger.warn "shell interrupt" if @history_logger
print "\nInterrupt. aborting command '#{input}'\n"
rescue SystemExit => cmdexit
cmd_result = cmdexit.status
rescue => e
@history_logger.error "#{e.message}" if @history_logger
cmd_result = Morpheus::Cli::ErrorHandler.new(my_terminal.stderr).handle_error(e) ensure
if @return_to_log_level
Morpheus::Logging.set_log_level(@return_to_log_level)
::RestClient.log = Morpheus::Logging.debug? ? Morpheus::Logging::DarkPrinter.instance : nil
@return_to_log_level = nil
end
if @return_to_coloring != nil
Term::ANSIColor::coloring = @return_to_coloring
@return_to_coloring = nil
end
if @return_to_benchmarking != nil
Morpheus::Benchmarking.enabled = @return_to_benchmarking
my_terminal.benchmarking = Morpheus::Benchmarking.enabled
@return_to_benchmarking = nil
end
end
if cmd_result == true
cmd_result = 0
end
return cmd_result
end
end
|
#flush_history(n = nil) ⇒ Object
739
740
741
742
743
744
745
746
747
748
749
750
|
# File 'lib/morpheus/cli/shell.rb', line 739
def flush_history(n=nil)
file_path = history_file_path
if File.exists?(file_path)
File.truncate(file_path, 0)
end
@history = {}
@last_command_number = 0
@history_logger = load_history_logger
print green, "Command history flushed", reset, "\n"
return 0
end
|
#get_prompt ⇒ Object
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
|
# File 'lib/morpheus/cli/shell.rb', line 513
def get_prompt
input = ''
while char=$stdin.getch do
if char == '\n'
print "\r\n"
puts "executing..."
break
end
print char
input << char
end
return input
end
|
#handle(args) ⇒ Object
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
# File 'lib/morpheus/cli/shell.rb', line 116
def handle(args)
usage = "Usage: morpheus #{command_name}"
optparse = Morpheus::Cli::OptionParser.new do |opts|
opts.banner = usage
opts.on('-e','--exec EXPRESSION', "Execute the command(s) expression and exit.") do |val|
@execute_mode = true
@execute_mode_command = val
end
opts.on('--norc','--norc', "Do not read and execute the personal initialization script .morpheusrc") do
@norc = true
end
opts.on('-I','--insecure', "Allow for insecure HTTPS communication i.e. bad SSL certificate") do |val|
@@insecure = true
Morpheus::RestClient.enable_ssl_verification = false
end
opts.on('-Z','--incognito', "Incognito mode. Use a temporary shell. Remotes are loaded without without saved credentials or history logging.") do
@incognito_mode = true
tmpdir = ENV['MORPHEUS_CLI_TMPDIR'] || ENV['TMPDIR'] || ENV['TMP']
if !tmpdir
puts_error "Temporary directory not found. Use environment variable MORPHEUS_CLI_TMPDIR or TMPDIR or TMP"
end
@original_home_directory = my_terminal.home_directory
@temporary_home_directory = File.join(tmpdir, "morpheus-temp-shell-#{rand().to_s[2..7]}")
Morpheus::Logging::DarkPrinter.puts "incognito mode" if Morpheus::Logging.debug?
Morpheus::Logging::DarkPrinter.puts "temporary home directory is #{@temporary_home_directory}" if Morpheus::Logging.debug?
my_terminal.set_home_directory(@temporary_home_directory)
Morpheus::Cli::Remote.appliances.each do |app_name, app|
app[:authenticated] = false
app.delete(:username)
app.delete(:last_login_at)
app.delete(:last_logout_at)
app.delete(:last_success_at)
app.delete(:last_check)
app.delete(:username)
app.delete(:error)
end
end
opts.on('-C','--nocolor', "Disable ANSI coloring") do
Term::ANSIColor::coloring = false
end
opts.on('-V','--debug', "Print extra output for debugging.") do
Morpheus::Logging.set_log_level(Morpheus::Logging::Logger::DEBUG)
::RestClient.log = Morpheus::Logging.debug? ? Morpheus::Logging::DarkPrinter.instance : nil
end
opts.on('-B','--benchmark', "Print benchmark time after each command is finished, including shell itself." ) do
Morpheus::Benchmarking.enabled = true
my_terminal.benchmarking = Morpheus::Benchmarking.enabled
end
opts.on( '-h', '--help', "Print this help" ) do
puts opts
exit
end
end
optparse.parse!(args)
@history_logger ||= load_history_logger rescue nil
@history_logger.info "shell started" if @history_logger
load_history_from_log_file()
if !@norc
if File.exists?(Morpheus::Cli::DotFile.morpheusrc_filename)
@history_logger.info("load source #{Morpheus::Cli::DotFile.morpheusrc_filename}") if @history_logger
Morpheus::Cli::DotFile.new(Morpheus::Cli::DotFile.morpheusrc_filename).execute()
end
end
reinitialize()
result = nil
if @execute_mode_command
result = execute(@execute_mode_command)
else
result = 0
@exit_now_please = false
while !@exit_now_please do
Readline.completion_append_character = " "
Readline.completion_proc = @auto_complete
Readline.basic_word_break_characters = ""
input = Readline.readline(@calculated_prompt, true).to_s
input = input.strip
result = execute(input)
print reset
end
end
if @temporary_home_directory
if @temporary_home_directory.include?("morpheus-temp-shell")
begin
FileUtils.remove_dir(@temporary_home_directory, true)
Morpheus::Logging::DarkPrinter.puts "cleaning up temporary home directory #{@temporary_home_directory}" if Morpheus::Logging.debug?
rescue
end
end
@temporary_home_directory = nil
if @original_home_directory
my_terminal.set_home_directory(@original_home_directory)
end
@original_home_directory = nil
end
return result
end
|
#history_commands_count ⇒ Object
734
735
736
737
|
# File 'lib/morpheus/cli/shell.rb', line 734
def history_commands_count()
load_history_from_log_file if !@history
@history.keys.size
end
|
#history_file_path ⇒ Object
531
532
533
|
# File 'lib/morpheus/cli/shell.rb', line 531
def history_file_path
File.join(Morpheus::Cli.home_directory, "shell_history")
end
|
#last_command ⇒ Object
641
642
643
644
645
646
647
|
# File 'lib/morpheus/cli/shell.rb', line 641
def last_command
if @history && @last_command_number
@history[@last_command_number]
else
nil
end
end
|
#load_history_commands(options = {}) ⇒ Object
load_history_commands paginates and sorts the command history the most recent 25 are returned by default.
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
|
# File 'lib/morpheus/cli/shell.rb', line 652
def load_history_commands(options={})
phrase = options[:phrase]
sort_key = options[:sort] ? options[:sort].to_sym : nil
offset = options[:offset].to_i > 0 ? options[:offset].to_i : 0
max = options[:max].to_i > 0 ? options[:max].to_i : 25
if !@history
load_history_from_log_file
end
history_records = []
history_count = 0
if options[:sort] && ![:number, :command].include?(options[:sort])
sort_key = :number end
if options[:phrase] || sort_key || options[:direction] || options[:offset]
sort_key ||= :number
history_records = @history.keys.collect { |k| {number: k, command: @history[k]} }
if options[:direction] == 'desc'
history_records = history_records.sort {|x,y| y[sort_key] <=> x[sort_key] }
else
history_records = history_records.sort {|x,y| x[sort_key] <=> y[sort_key] }
end
if phrase
history_records = history_records.select {|it| it[:command].include?(phrase) || it[:number].to_s == phrase }
end
command_count = history_records.size
history_records = history_records[offset..(max-1)]
else
if offset != 0
cmd_numbers = @history.keys.last(max + offset).first(max)
else
cmd_numbers = @history.keys.last(max)
end
history_records = cmd_numbers.collect { |k| {number: k, command: @history[k]} }
command_count = @history.size
end
meta = {size:history_records.size, total:command_count.to_i, max:max, offset:offset}
return {:commands => history_records, :command_count => command_count, :meta => meta}
end
|
#load_history_from_log_file ⇒ Object
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
|
# File 'lib/morpheus/cli/shell.rb', line 551
def load_history_from_log_file
@history = {}
@last_command_number = 0
begin
file_path = history_file_path
FileUtils.mkdir_p(File.dirname(file_path))
File.open(file_path).each_line do |line|
matches = line.match(/\(cmd (\d+)\) (.+)/)
if matches && matches.size == 3
cmd_number = matches[1].to_i
cmd = matches[2]
@last_command_number = cmd_number
@history[@last_command_number] = cmd
Readline::HISTORY << cmd
end
end
rescue => e
puts_error "failed to load history from log: #{e}"
@history ||= {}
end
return @history
end
|
#load_history_logger ⇒ Object
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
|
# File 'lib/morpheus/cli/shell.rb', line 535
def load_history_logger
file_path = history_file_path
if !Dir.exists?(File.dirname(file_path))
FileUtils.mkdir_p(File.dirname(file_path))
end
if !File.exists?(file_path)
FileUtils.touch(file_path)
FileUtils.chmod(0600, file_path)
end
logger = Logger.new(file_path)
return logger
end
|
#log_history_command(cmd) ⇒ Object
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
|
# File 'lib/morpheus/cli/shell.rb', line 623
def log_history_command(cmd)
load_history_from_log_file if !@history
previous_cmd = @history[@last_command_number]
if previous_cmd && previous_cmd =~ /history/ && previous_cmd == cmd
return @last_command_number
end
@last_command_number += 1
@history[@last_command_number] = cmd
if @history_logger
@history_logger.info "#{@current_username}@#{@appliance_name} -- : (cmd #{@last_command_number}) #{cmd}"
end
return @last_command_number
end
|
#print_history(options = {}) ⇒ Object
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
|
# File 'lib/morpheus/cli/shell.rb', line 703
def print_history(options={})
history_result = load_history_commands(options)
history_records = history_result[:commands]
command_count = history_result[:command_count]
if history_records.size == 0
if options[:phrase]
print cyan,"0 commands found matching '#{options[:phrase]}'.",reset,"\n"
else
print cyan,"0 commands found.",reset,"\n"
end
else
print cyan
history_records.each do |history_record|
puts "#{history_record[:number].to_s.rjust(3, ' ')} #{history_record[:command]}"
end
if options[:show_pagination]
if options[:phrase] || options[:sort] || options[:direction] || options[:offset]
({:meta => history_result[:meta]})
else
({:meta => history_result[:meta]}, {:message =>"Viewing most recent %{size} of %{total} %{label}"})
end
print reset, "\n"
else
print reset
end
end
return 0
end
|
#recalculate_auto_complete_commands ⇒ Object
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
# File 'lib/morpheus/cli/shell.rb', line 92
def recalculate_auto_complete_commands
@morpheus_commands = Morpheus::Cli::CliRegistry.all.keys.reject {|k| [:shell].include?(k) }
@shell_commands = [:clear, :history, :reload, :help, :exit]
@alias_commands = Morpheus::Cli::CliRegistry.all_aliases.keys
@exploded_commands = []
Morpheus::Cli::CliRegistry.all.each do |cmd, klass|
@exploded_commands << cmd.to_s
subcommands = klass.subcommands rescue []
subcommands.keys.each do |sub_cmd|
@exploded_commands << "#{cmd} #{sub_cmd}"
end
end
@auto_complete_commands = (@exploded_commands + @shell_commands + @alias_commands).collect {|it| it.to_s }
@auto_complete = proc do |s|
command_list = @auto_complete_commands
result = command_list.grep(/^#{Regexp.escape(s)}/)
if result.nil? || result.empty?
Readline::FILENAME_COMPLETION_PROC.call(s)
else
result
end
end
end
|
#recalculate_prompt ⇒ Object
def connect(opts)
@api_client = establish_remote_appliance_connection(opts)
end
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
# File 'lib/morpheus/cli/shell.rb', line 68
def recalculate_prompt()
@prompt = my_terminal.prompt
variable_map = Morpheus::Cli::Echo.variable_map
@calculated_prompt = @prompt.to_s.dup
variable_map.each do |k, v|
@calculated_prompt.gsub!(k.to_s, v.to_s)
end
@calculated_prompt = @calculated_prompt.gsub("[]", "").gsub("<>", "").gsub("{}", "")
@calculated_prompt
end
|
#reinitialize ⇒ Object
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
# File 'lib/morpheus/cli/shell.rb', line 46
def reinitialize()
@current_remote = ::Morpheus::Cli::Remote.load_active_remote()
if @current_remote
@appliance_name, @appliance_url = @current_remote[:name], @current_remote[:host]
@current_username = @current_remote[:username] || ''
else
@appliance_name, @appliance_url = nil, nil
@current_username = nil
end
@@instance = self
recalculate_prompt()
recalculate_auto_complete_commands()
end
|