Class: Morpheus::Cli::Shell

Inherits:
Object
  • Object
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

#apply_options, #build_common_options, #build_option_type_options, #build_standard_add_options, #build_standard_delete_options, #build_standard_get_options, #build_standard_list_options, #build_standard_post_options, #build_standard_put_options, #build_standard_remove_options, #build_standard_update_options, #command_description, #command_name, #default_refresh_interval, #default_sigdig, #default_subcommand, #establish_remote_appliance_connection, #full_command_usage, #get_subcommand_description, #handle_subcommand, included, #interactive?, #my_help_command, #my_terminal, #my_terminal=, #parse_bytes_param, #parse_id_list, #parse_list_options, #parse_list_subtitles, #parse_passed_options, #parse_payload, #parse_query_options, #print, #print_error, #println, #prog_name, #puts, #puts_error, #raise_args_error, #raise_command_error, #render_response, #run_command_for_each_arg, #subcommand_aliases, #subcommand_description, #subcommand_usage, #subcommands, #usage, #validate_outfile, #verify_args!, #visible_subcommands

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

, :angry_prompt



39
40
41
 
# File 'lib/morpheus/cli/shell.rb', line 39

def prompt
  @prompt
end

Class Method Details

.has_instance? ⇒ Boolean

Returns:

  • (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

remove this..



692
693
694
695
696
697
698
699
700
701
702
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
 
# File 'lib/morpheus/cli/shell.rb', line 692

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))
    # grab extra lines because not all log entries are commands
    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

        # for Ctrl+R history searching
        Readline::HISTORY << cmd
      end
    end
  rescue => e
    # raise e
    # puts "failed to load history from log"
    @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, !, !!



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
583
584
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
 
# File 'lib/morpheus/cli/shell.rb', line 338

def execute(input)
  unless input.strip.empty? || input.strip[0] == "!"
    log_history_command(input.strip)
  end

  #Morpheus::Logging::DarkPrinter.puts "Shell command: #{input}"
  input = input.to_s.strip

  # allow pasting in commands that have 'morpheus ' prefix
  if input[0..(prog_name.size)] == "#{prog_name} "
    input = input[(prog_name.size + 1)..-1] || ""
  end

  if !input.empty?

    if input == 'exit'
      #print cyan,"Goodbye\n",reset
      #@history_logger.info "exit" if @history_logger
      @exit_now_please = true
      return 0
      #exit 0
    elsif input == 'help'
      out = ""
      if @temporary_shell_mode
        out << "You are in a (temporary) morpheus shell\n"
      else
        out << "You are in a morpheus shell.\n"
      end
      out <<  "See the available commands below.\n"

      out << "\nCommands:"
      # commands = @morpheus_commands + @shell_commands
      # @morpheus_commands.sort.each {|cmd|
      #   out <<  "\t#{cmd.to_s}\n"
      # }
      sorted_commands = Morpheus::Cli::CliRegistry.all.values.sort { |x,y| x.command_name.to_s <=> y.command_name.to_s }
      sorted_commands.each {|cmd|
        # JD: not ready to show description yet, gotta finish filling in every command first
        # maybe change 'View and manage' to something more concise like 'Manage'
        # out << "\t#{cmd.command_name.to_s.ljust(28, ' ')} #{cmd.command_description}\n"
        out << "\t#{cmd.command_name.to_s}\n"
      }
      #puts "\n"
      out <<  "\nShell Commands:\n"
      @shell_commands.each {|cmd|
        # out << "\t#{cmd.to_s.ljust(28, ' ')} #{@shell_command_descriptions ? @shell_command_descriptions[cmd] : ''}\n"
        out <<  "\t#{cmd.to_s}\n"
      }
      out << "\n"
      out << "For more information, see https://github.com/gomorpheus/morpheus-cli/wiki"
      out << "\n"
      print out
      return 0
    elsif input =~ /^\s*#/
      Morpheus::Logging::DarkPrinter.puts "ignored comment: #{input}" if Morpheus::Logging.debug?
      return 0
    # this is a full blown command now
    # elsif input =~ /^sleep/
    #   sleep_sec = input.sub("sleep ", "").to_f
    #   if (!(sleep_sec > 0))
    #     # raise_command_error "sleep requires the argument [seconds]. eg. sleep 3.14"
    #     puts_error  "sleep requires argument [seconds]. eg. sleep 3.14"
    #     return false
    #   end
    #   log_history_command(input)
    #   Morpheus::Logging::DarkPrinter.puts "sleeping for #{sleep_sec}s ... zzzZzzzZ" if Morpheus::Logging.debug?
    #   begin
    #     sleep(sleep_sec)
    #   rescue Interrupt
    #     Morpheus::Logging::DarkPrinter.puts "\nInterrupt. waking up from sleep early"
    #   end
    #   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 # no consecutive
    #     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 == "edit rc"
    #   fn = Morpheus::Cli::DotFile.morpheusrc_filename
    #   editor = ENV['EDITOR'] # || 'nano'
    #   if !editor
    #     puts "You have no EDITOR defined. Use 'export EDITOR=emacs'"
    #     #puts "Trying nano..."
    #     #editor = "nano"
    #   end
    #   system("which #{editor} > /dev/null 2>&1")
    #   has_editor = $?.success?
    #   if has_editor
    #     puts "opening #{fn} for editing with #{editor} ..."
    #     system("#{editor} #{fn}")
    #     puts "Use 'reload' to re-execute your startup script #{File.basename(fn)}"
    #   else
    #     puts_error2 Morpheus::Terminal.angry_prompt
    #     puts_error "The defined EDITOR '#{editor}' was not found on your system."
    #   end
    #   return 0 # $?
    # elsif input == "edit profile"
    #   fn = Morpheus::Cli::DotFile.morpheus_profile_filename
    #   editor = ENV['EDITOR'] # || 'nano'
    #   if !editor
    #     puts "You have no EDITOR defined. Use 'export EDITOR=emacs'."
    #     #puts "Trying nano..."
    #     #editor = "nano"
    #   end
    #   system("which #{editor} > /dev/null 2>&1")
    #   has_editor = $?.success?
    #   if has_editor
    #     puts "opening #{fn} for editing with #{editor} ..."
    #     `#{editor} #{fn}`
    #     puts "Use 'reload' to re-execute your startup script #{File.basename(fn)}"
    #   else
    #     puts_error Morpheus::Terminal.angry_prompt
    #     puts_error "The defined EDITOR '#{editor}' was not found on your system."
    #   end
    #   return 0 # $?
    elsif input == 'reload' || input == 'reload!'
      # raise RestartShellPlease
      #log_history_command(input)
      # could just fork instead?
      # clear registry
      Morpheus::Cli::CliRegistry.instance.flush
      # reload code
      Morpheus::Cli.load!

      # raise RestartShellPlease

      # execute startup scripts
      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
      
      # recalculate shell environment
      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
        #puts "executing history command: (#{cmd_number}) #{old_input}"
        # log_history_command(old_input)
        # remove this from readline, and replace it with the old command
        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)
      user_msg = input.strip.downcase
      # need a logged_in? method already damnit
      wallet = Morpheus::Cli::Credentials.new(@appliance_name, @appliance_url).load_saved_credentials
      help_msg = case user_msg
      when "hola"
        "¿como puedo ayudarte? tratar #{cyan}help#{reset}"
      else
        "how may I #{cyan}help#{reset} you?"
      end
      greeting = "#{user_msg.capitalize}#{wallet ? (' '+green+wallet['username'].to_s+reset) : ''}, #{help_msg}#{reset}"
      puts greeting
      return 0
    elsif input.strip =~ /^shell\s*/
      # just allow shell to fall through
      # we should reload the configs and history file after the sub shell process terminates though.
      # actually, that looks like it is working just fine already...?
      print cyan,"starting a subshell",reset,"\n"
    elsif input =~ /^\.\s/
      # dot alias for source <file>
      log_history_command(input)
      return Morpheus::Cli::SourceCommand.new.handle(input.split[1..-1])
    end
    exit_code, err = 0, nil
    begin
      argv = Shellwords.shellsplit(input)
      cmd_name = argv[0]
      cmd_args = argv[1..-1]
      # crap hack, naming conflicts can occur with aliases
      @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 Morpheus::Cli::CliRegistry.has_command?(cmd_name) || Morpheus::Cli::CliRegistry.has_alias?(cmd_name)
        #log_history_command(input)
        # start a benchmark, unless the command is benchmark of course
        if my_terminal.benchmarking || cmd_args.include?("-B") || cmd_args.include?("--benchmark")
          if cmd_name != 'benchmark' # jd: this does not work still 2 of them printed.. fix it!
            # benchmark_name = "morpheus " + argv.reject {|it| it == '-B' || it == '--benchmark' }.join(' ')
            benchmark_name = argv.reject {|it| it == '-B' || it == '--benchmark' }.join(' ')
            start_benchmark(benchmark_name)
          end
        end
        exit_code, err = Morpheus::Cli::CliRegistry.exec_expression(input)
        benchmark_record = stop_benchmark(exit_code, err) # if benchmarking?
        Morpheus::Logging::DarkPrinter.puts(cyan + dark + benchmark_record.msg) if benchmark_record
      # else
      #   puts_error "#{Morpheus::Terminal.angry_prompt}'#{cmd_name}' is not recognized. Use 'help' to see the list of available commands."
      #   @history_logger.warn "Unrecognized Command #{cmd_name}" if @history_logger
      #   exit_code, err = -1, "Command not recognized"
      # end
    rescue Interrupt
      # user pressed ^C to interrupt a command
      @history_logger.warn "shell interrupt" if @history_logger
      print "\nInterrupt. aborting command '#{input}'\n"
      exit_code, err = 9, "aborted command"
    rescue SystemExit => cmdexit
      # nothing to do, assume the command that exited printed an error already
      # print "\n"
      exit_code, err = cmdexit.status, "Command exited early."
    rescue => e
      # some other type of failure..
      @history_logger.error "#{e.message}" if @history_logger
      exit_code, err = Morpheus::Cli::ErrorHandler.new(my_terminal.stderr).handle_error(e) # lol
      
    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

    return exit_code, err
  end

end

#flush_history(n = nil) ⇒ Object 



846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/morpheus/cli/shell.rb', line 846

def flush_history(n=nil)
  # todo: support only flushing last n commands
    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 



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/morpheus/cli/shell.rb', line 618

def get_prompt

  # print cyan,"morpheus > ",reset
  # input = $stdin.gets.chomp!

  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 



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
244
245
246
247
248
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
 
# File 'lib/morpheus/cli/shell.rb', line 124

def handle(args)
  usage = "Usage: morpheus #{command_name}"
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = usage
    # change to a temporary home directory, delete it afterwards.
    opts.on('-e','--exec EXPRESSION', "Execute the command expression and exit. Expression can be a single morpheus command or several by using parenthesis and operators (, ), &&, ||, and ;") 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','--temporary', "Temporary shell. Use a temporary shell with the current remote configuration, credentials and history loaded. Temporary shells do not save changes to remote configuration changes and command history.") do
      @temporary_shell_mode = true
    end
    opts.on('-z','--clean', "Clean shell. Use a temporary shell without any remote configuration, credentials or command history loaded.") do
      @temporary_shell_mode = true
      @clean_shell_mode = true
    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" ) 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)

  # is this a temporary/temporary_shell shell?
  # this works just by changing the cli home directory and updating appliances
  if @temporary_shell_mode
    #Morpheus::Logging::DarkPrinter.puts "temporary shell started" if Morpheus::Logging.debug?
    # for now, always use the original home directory
    # or else this will just keep growing deeper and deeper.
    @parent_shell_directories ||= []
    @parent_shell_directories << my_terminal.home_directory
    @previous_home_directory = @parent_shell_directories.last
    if @original_home_directory.nil?
      @original_home_directory = @previous_home_directory
    end
    
    #@norc = true # perhaps?
    # instead of using TMPDIR, create tmp shell directory inside $MORPHEUS_CLI_HOME/tmp
    # should chown these files too..
    #tmpdir = ENV['MORPHEUS_CLI_TMPDIR'] || ENV['TMPDIR'] || ENV['TMP']
    tmpdir = ENV['MORPHEUS_CLI_TMPDIR']
    if !tmpdir
      tmpdir = File.join(@original_home_directory, "tmp")
    end
    if !File.exists?(tmpdir)
      # Morpheus::Logging::DarkPrinter.puts "creating tmpdir #{tmpdir}" if Morpheus::Logging.debug?
      FileUtils.mkdir_p(tmpdir)
    end
    # this won't not happen since we mkdir above
    if !File.exists?(tmpdir)
      raise_command_error "Temporary directory not found. Use environment variable MORPHEUS_CLI_TMPDIR"
    end
    # change to a temporary home directory
    @temporary_home_directory = File.join(tmpdir, "tmpshell-#{rand().to_s[2..7]}")
    
    #if !File.exists?(@temporary_home_directory)
      Morpheus::Logging::DarkPrinter.puts "starting temporary shell at #{@temporary_home_directory}" if Morpheus::Logging.debug?
      FileUtils.mkdir_p(@temporary_home_directory)
    # end
    

    my_terminal.set_home_directory(@temporary_home_directory)


    # wow..this already has cached list of Remote.appliances
    # this is kinda nice though..keep it for now, 
    #Morpheus::Cli::Remote.load_appliance_file
    if @clean_shell_mode == true
      # clean shell means no loading of remotes, aliases, history
      # @norc = true
      # todo: avoid writing files here and just work in memory for temporary shell
      Morpheus::Cli::Remote.save_appliances({})
    else
      # keep remotes and credentials and activity or history
      # this is done just by copying configuration files to the tmp home dir
      # 
      # should use Morpheus::Cli::DotFile.morpheus_profile_filename
      # and # should use Morpheus::Cli::DotFile.morpheus_profile_filename
      # this already got run though.. this temporary mode should work for any terminal command,
      # not just in shell
      # .morpheus_profile has aliases
      # this has already been loaded, probably should reload it...
      if File.exists?(File.join(@previous_home_directory, ".morpheus_profile"))
        FileUtils.cp(File.join(@previous_home_directory, ".morpheus_profile"), File.join(@temporary_home_directory, ".morpheus_profile"))
      end
      if @norc != true
        if File.exists?(File.join(@previous_home_directory, ".morpheusrc"))
          FileUtils.cp(File.join(@previous_home_directory, ".morpheusrc"), File.join(@temporary_home_directory, ".morpheusrc"))
        end
      end
      if File.exists?(File.join(@previous_home_directory, "appliances"))
        FileUtils.cp(File.join(@previous_home_directory, "appliances"), File.join(@temporary_home_directory, "appliances"))
      end
      if File.exists?(File.join(@previous_home_directory, "credentials"))
        FileUtils.cp(File.join(@previous_home_directory, "credentials"), File.join(@temporary_home_directory, "credentials"))
      end
      if File.exists?(File.join(@previous_home_directory, "groups"))
        FileUtils.cp(File.join(@previous_home_directory, "groups"), File.join(@temporary_home_directory, "groups"))
      end
      # stay logged in
      # maybe have a different option for removing just credentials, and command history..
      Morpheus::Cli::Remote.appliances.each do |app_name, app|
        #app[:username] = "(anonymous)"
        #app[:status] = "fresh"
        #app[:authenticated] = false
        # app.delete(:active) # keep remote active..
        #app.delete(:username)
        #app.delete(:last_login_at)
        #app.delete(:last_logout_at)
        # app[:last_logout_at] = Time.now.to_i
        # keep last_success and last check
        #app.delete(:last_success_at)
        #app.delete(:last_check)
        #app.delete(:username)
      end

      # Morpheus::Cli::Remote.save_appliances(new_remote_config)
      # Morpheus::Cli::Remote.clear_active_appliance
      # Morpheus::Cli::Credentials.clear_saved_credentials(@appliance_name)
      # Morpheus::Cli::Credentials.load_saved_credentials
      # Morpheus::Cli::Credentials.new(@appliance_name, @appliance_url).load_saved_credentials()
    end
  end

  @history_logger ||= load_history_logger rescue nil
  @history_logger.info "shell started" if @history_logger
  load_history_from_log_file()


  # execute startup script
  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()
  # recalculate_prompt()
  # recalculate_auto_complete_commands()

  result = nil
  if @execute_mode_command
    # execute a single command and exit
    result = execute(@execute_mode_command)
  else
    # interactive prompt
    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 = ""
      #Readline.basic_word_break_characters = "\t\n\"\‘`@$><=;|&{( "
      input = Readline.readline(@calculated_prompt, true).to_s
      input = input.strip

      result = execute(input)
      print reset
    end
  end
  
  # temporary_shell_mode, cover our tracks
  if @temporary_home_directory
    if @temporary_home_directory.include?("tmpshell")
      begin
        FileUtils.remove_dir(@temporary_home_directory, true)
        Morpheus::Logging::DarkPrinter.puts "cleaning up temporary shell at #{@temporary_home_directory}" if Morpheus::Logging.debug?
      rescue
      end
    end
    parent_shell_directory = @parent_shell_directories ? @parent_shell_directories.pop : nil
    if parent_shell_directory
      # switch terminal shell back to parent shell.  
      # should just be forking instead of all this...
      my_terminal.set_home_directory(parent_shell_directory)
      if @original_home_directory && @original_home_directory == parent_shell_directory
        # back to original shell, not temporary, right? 
        # todo: probably need to reload shell here?
        @temporary_home_directory = nil
      else
        # back to another temporary shell
        # todo: probably need to reload shell here?
        @temporary_home_directory = parent_shell_directory
      end
    else
      # there was no parent, this would be weird since temporary_home_directory was true..
    end
  end
  return result
end

#history_commands_count ⇒ Object 



841
842
843
844
 
# File 'lib/morpheus/cli/shell.rb', line 841

def history_commands_count()
  load_history_from_log_file if !@history
  @history.keys.size
end

#history_file_path ⇒ Object 



636
637
638
 
# File 'lib/morpheus/cli/shell.rb', line 636

def history_file_path
  File.join(Morpheus::Cli.home_directory, "shell_history")
end

#last_command ⇒ Object 



748
749
750
751
752
753
754
 
# File 'lib/morpheus/cli/shell.rb', line 748

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.

Returns:

  • Hash like => [], :command_count => total



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'lib/morpheus/cli/shell.rb', line 759

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
  
  
  # collect records as [{:number => 1, :command => "instances list"}, etc]
  history_records = []
  history_count = 0
  
  # sort is a bit different for this command, the default sort is by number
  # it sorts oldest -> newest, but shows the very last page by default.
  if options[:sort] && ![:number, :command].include?(options[:sort])
    sort_key = :number # nil
  end

  if options[:phrase] || sort_key || options[:direction] || options[:offset]
    # this could be a large object...need to index our shell_history file lol
    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
    # default should try to be as fast as possible..
    # no searching or sorting, default order by :number works
    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 



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
 
# File 'lib/morpheus/cli/shell.rb', line 656

def load_history_from_log_file
  
  # @history ||= {}
  # @last_command_number ||= 0
  @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|
      # this is pretty goofy, but this looks for the format: (cmd $command_number) $command_string
      matches = line.match(/\(cmd (\d+)\) (.+)/)
      if matches && matches.size == 3
        cmd_number = matches[1].to_i
        cmd = matches[2]

        if cmd_number > @last_command_number
          @last_command_number = cmd_number
        end
        @history[cmd_number] = cmd

        # for Ctrl+R history searching
        Readline::HISTORY << cmd
      end
    end
  rescue => e
    # raise e
    puts_error "failed to load history from log: #{e}"
    @history ||= {}
  end
  return @history
end

#load_history_logger ⇒ Object 



640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'lib/morpheus/cli/shell.rb', line 640

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)
  # logger.formatter = proc do |severity, datetime, progname, msg|
  #   "#{msg}\n"
  # end
  return logger
end

#log_history_command(cmd) ⇒ Object 



730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/morpheus/cli/shell.rb', line 730

def log_history_command(cmd)
  load_history_from_log_file if !@history
  #todo: a fast log_history_command, that doesnt need to load the file..
  #@history ||= {}
  #@last_command_number ||= 0
  previous_cmd = @history[@last_command_number]
  # skip logging consecutive history commands.
  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 



810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
 
# File 'lib/morpheus/cli/shell.rb', line 810

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]
        print_results_pagination({:meta => history_result[:meta]})
      else
        # default order is weird, it's the last page of results, 1-25 is misleading and showing the indexes is stranger
        print_results_pagination({:meta => history_result[:meta]}, {:message =>"Viewing most recent %{size} of %{total} %{label}"})
      end
      print reset, "\n"
    else
      print reset
    end
  end
  #print "\n"
  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
115
116
117
118
119
120
121
122
 
# 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]
  @shell_command_descriptions = {
    :clear => "Clear terminal output and move cursor to the top", 
    :history => "View morpheus shell command history", 
    :reload => "Reload the shell, can be useful when developing", 
    :help => "Print this help", 
    :exit => "Exit the morpheus shell"
  }
  @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 = klass.visible_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()
  # custom prompts.. this is overkill and perhaps a silly thing..
  # Example usage:
  # MORPHEUS_PS1="[%remote] %cyan %username morph> " morpheus shell --debug
  #@prompt = Morpheus::Terminal.instance.prompt.to_s #.dup
  @prompt = my_terminal.prompt

  variable_map = Morpheus::Cli::Echo.variable_map
  # variable_map = {
  #   '%cyan' => cyan, '%magenta' => magenta, '%red' => red, '%mgreen' => green, '%yellow' => yellow, '%dark' => dark, '%reset' => reset,
  #   '%remote' => @appliance_name.to_s, '%remote_url' => @appliance_url.to_s, 
  #   '%username' => @current_username.to_s
  # }
  @calculated_prompt = @prompt.to_s.dup
  variable_map.each do |k, v|
    @calculated_prompt.gsub!(k.to_s, v.to_s)
  end
  # cleanup empty brackets caused by var value
  @calculated_prompt = @calculated_prompt.gsub("[]", "").gsub("<>", "").gsub("{}", "")
  #@calculated_prompt = @calculated_prompt.strip
  # @calculated_prompt = "#{@calculated_prompt}#{reset} "
  @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()
  # @appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance
  @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)'
    @current_username = @current_remote[:username] || ''
  else
    @appliance_name, @appliance_url = nil, nil
    @current_username = nil
  end
  #connect()
  #raise "one shell only" if @@instance
  @@instance = self
  recalculate_prompt()
  recalculate_auto_complete_commands()
end