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_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, #run_command_for_each_arg, #subcommand_aliases, #subcommand_usage, #subcommands, #usage, #verify_access_token!
Constructor Details
#initialize ⇒ Shell
Returns a new instance of Shell.
38
39
40
41
|
# File 'lib/morpheus/cli/shell.rb', line 38
def initialize()
@@instance = self
reinitialize()
end
|
Instance Attribute Details
#prompt ⇒ Object
36
37
38
|
# File 'lib/morpheus/cli/shell.rb', line 36
def prompt
@prompt
end
|
Class Method Details
.has_instance? ⇒ Boolean
20
21
22
|
# File 'lib/morpheus/cli/shell.rb', line 20
def self.has_instance?
defined?(@@instance) && @@instance
end
|
.insecure ⇒ Object
32
33
34
|
# File 'lib/morpheus/cli/shell.rb', line 32
def self.insecure
!!(defined?(@@insecure) && @@insecure == true)
end
|
.instance ⇒ Object
24
25
26
|
# File 'lib/morpheus/cli/shell.rb', line 24
def self.instance
@@instance ||= reload_instance
end
|
.reload_instance ⇒ Object
28
29
30
|
# File 'lib/morpheus/cli/shell.rb', line 28
def self.reload_instance
@@instance = self.new
end
|
Instance Method Details
#execute(input) ⇒ Object
same as Terminal instance
258
259
260
261
262
263
264
265
266
267
268
|
# File 'lib/morpheus/cli/shell.rb', line 258
def execute(input)
result = execute_commands_as_expression(input)
unless input.strip.empty? || (["exit", "history"].include?(input.strip)) || input.strip[0].to_s.chr == "!"
log_history_command(input.strip)
end
return result
end
|
#execute_command(input) ⇒ Object
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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
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 337
def execute_command(input)
input = input.to_s.strip
if !input.empty?
if input == 'exit'
@history_logger.info "exit" if @history_logger
@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 "comment ignored" if Morpheus::Logging.debug?
return 0
elsif input =~ /^history/
n_commands = input.sub(/^history\s?/, '').sub(/\-n\s?/, '')
n_commands = n_commands.empty? ? 25 : n_commands.to_i
cmd_numbers = @history.keys.last(n_commands)
if cmd_numbers.size == 1
puts "Last command"
else
puts "Last #{cmd_numbers.size} commands"
end
cmd_numbers.each do |cmd_number|
cmd = @history[cmd_number]
puts "#{cmd_number.to_s.rjust(3, ' ')} #{cmd}"
end
last_cmd = cmd_numbers.last ? @history[cmd_numbers.last] : nil
if input != last_cmd log_history_command(input)
end
return 0
elsif input == 'clear'
print "\e[H\e[2J"
return 0
elsif input == 'flush-history' || input == 'flush_history'
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
puts "history cleared!"
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 input == "debug"
log_history_command(input)
return Morpheus::Cli::LogLevelCommand.new.handle(["debug"])
elsif ["hello","hi","hey","hola"].include?(input.strip.downcase)
print "#{input.capitalize}, how may I #{cyan}help#{reset} you?\n"
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
unless input =~ /log-level/
@return_to_log_level = Morpheus::Logging.log_level
end
unless input =~ /coloring/
@return_to_coloring = Term::ANSIColor::coloring?
end
begin
argv = Shellwords.shellsplit(input)
cmd_name = argv[0]
cmd_args = argv[1..-1]
if Morpheus::Cli::CliRegistry.has_command?(cmd_name) || Morpheus::Cli::CliRegistry.has_alias?(cmd_name)
cmd_result = Morpheus::Cli::CliRegistry.exec(cmd_name, cmd_args)
else
puts_error "#{Morpheus::Terminal.angry_prompt}'#{cmd_name}' is not a morpheus command. Use 'help' to see the list of available commands."
@history_logger.warn "Unrecognized Command #{cmd_name}" if @history_logger
cmd_result = -1
end
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
end
if cmd_result == true
cmd_result = 0
end
return cmd_result
end
end
|
#execute_commands_as_expression(input) ⇒ Object
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
|
# File 'lib/morpheus/cli/shell.rb', line 270
def execute_commands_as_expression(input)
flow = input
if input.is_a?(String)
begin
flow = Morpheus::Cli::ExpressionParser.parse(input)
rescue Morpheus::Cli::ExpressionParser::InvalidExpression => e
@history_logger.error "#{e.message}" if @history_logger
return Morpheus::Cli::ErrorHandler.new(my_terminal.stderr).handle_error(e) end
end
final_command_result = nil
if flow.size == 0
else
last_command_result = nil
if ['&&','||', '|'].include?(flow.first)
puts_error "#{Morpheus::Terminal.angry_prompt}invalid command format, begins with an operator: #{input}"
return 99
elsif ['&&','||', '|'].include?(flow.last)
puts_error "#{Morpheus::Terminal.angry_prompt}invalid command format, ends with an operator: #{input}"
return 99
else
previous_command = nil
previous_command_result = nil
current_operator = nil
still_executing = true
flow.each do |flow_cmd|
if still_executing
if flow_cmd == '&&'
current_operator = flow_cmd
if parse_result_exitstatus(previous_command_result) != 0
still_executing = false
end
elsif flow_cmd == '||' current_operator = flow_cmd
if parse_result_exitstatus(previous_command_result) == 0
still_executing = false
end
elsif flow_cmd == '|' puts_error "The PIPE (|) operator is not yet supported =["
previous_command_result = nil
still_executing = false
elsif flow_cmd.is_a?(Array)
current_operator = nil
previous_command_result = execute_commands_as_expression(flow_cmd)
else current_operator = nil
previous_command_result = execute_command(flow_cmd)
end
previous_command = flow_cmd
else
end
end
final_command_result = previous_command_result
end
end
return final_command_result
end
|
#get_prompt ⇒ Object
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
|
# File 'lib/morpheus/cli/shell.rb', line 584
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
112
113
114
115
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
|
# File 'lib/morpheus/cli/shell.rb', line 112
def handle(args)
usage = "Usage: morpheus #{command_name}"
optparse = Morpheus::Cli::OptionParser.new do |opts|
opts.banner = usage
opts.on('-e','--exec COMMAND', "Execute the provided morpheus commands 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, no saved credentials and no history.") 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 |json|
Morpheus::Logging.set_log_level(Morpheus::Logging::Logger::DEBUG)
::RestClient.log = Morpheus::Logging.debug? ? Morpheus::Logging::DarkPrinter.instance : nil
end
opts.on( '-h', '--help', "Prints 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_file_path ⇒ Object
602
603
604
|
# File 'lib/morpheus/cli/shell.rb', line 602
def history_file_path
File.join(Morpheus::Cli.home_directory, "shell_history")
end
|
#load_history_from_log_file(n_commands = 1000) ⇒ Object
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
|
# File 'lib/morpheus/cli/shell.rb', line 622
def 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
|
#load_history_logger ⇒ Object
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
|
# File 'lib/morpheus/cli/shell.rb', line 606
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
660
661
662
663
664
665
666
667
668
|
# File 'lib/morpheus/cli/shell.rb', line 660
def log_history_command(cmd)
@history ||= {}
@last_command_number ||= 0
@last_command_number += 1
@history[@last_command_number] = cmd
if @history_logger
@history_logger.info "(cmd #{@last_command_number}) #{cmd}"
end
end
|
#parse_result_exitstatus(result) ⇒ Object
return exitstatus integer for a given command result todo: clean up CliCommand return values, handle a few diff types for now
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
# File 'lib/morpheus/cli/shell.rb', line 239
def parse_result_exitstatus(result)
exit_code, err = 0, nil
if result.is_a?(Array) exit_code = result[0].to_i
err = result[1]
elsif result == nil || result == true || result == 0
exit_code = 0
elsif result == false
exit_code = 1
else
exit_code = result.to_i
end
return exit_code
end
|
#recalculate_auto_complete_commands ⇒ Object
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
# File 'lib/morpheus/cli/shell.rb', line 88
def recalculate_auto_complete_commands
@morpheus_commands = Morpheus::Cli::CliRegistry.all.keys.reject {|k| [:shell].include?(k) }
@shell_commands = [:clear, :history, :'flush-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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
# File 'lib/morpheus/cli/shell.rb', line 64
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
# File 'lib/morpheus/cli/shell.rb', line 43
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] || '(anonymous)'
else
@appliance_name, @appliance_url = nil, nil
@current_username = nil
end
@@instance = self
recalculate_prompt()
recalculate_auto_complete_commands()
end
|