Refactor change host methods, remove debug output

Author: mkienow-r7

lib/metasploit/framework/data_service/proxy/host_data_proxy.rb

@@ -42,7 +42,6 @@ def report_hosts(hosts)
 
   def update_host(opts)
     begin
-      $stderr.puts "HostDataProxy.update_host(): opts = #{opts}"  # TODO: remove
       data_service = self.get_data_service()
       data_service.update_host(opts)
     rescue Exception => e

lib/metasploit/framework/data_service/remote/http/remote_host_data_service.rb

@@ -24,7 +24,6 @@ def report_hosts(hosts)
   end
 
   def update_host(opts)
-    $stderr.puts "RemoteHostDataService.update_host(): opts = #{opts}"  # TODO: remove
     path = HOST_API_PATH
     if opts && opts[:id]
       id = opts.delete(:id)

lib/msf/core/db_manager/host.rb

@@ -143,7 +143,6 @@ def has_host?(wspace,addr)
 
   # Returns a list of all hosts in the database
   def hosts(opts)
-    $stderr.puts "DBManager::Host.hosts(): opts = #{opts}"  # TODO: remove
     wspace = opts[:workspace] || opts[:wspace] || workspace
     if wspace.kind_of? String
       wspace = find_workspace(wspace)
@@ -155,7 +154,6 @@ def hosts(opts)
       conditions[:state] = [Msf::HostState::Alive, Msf::HostState::Unknown] if opts[:non_dead]
       conditions[:address] = opts[:address] if opts[:address] && !opts[:address].empty?
       conditions[:id] = opts[:id] if opts[:id] && !opts[:id].empty?
-      $stderr.puts "DBManager::Host.hosts(): conditions = #{conditions}"  # TODO: remove
 
       if opts[:search_term] && !opts[:search_term].empty?
         column_search_conditions = Msf::Util::DBManager.create_all_column_search_conditions(Mdm::Host, opts[:search_term])
@@ -272,14 +270,11 @@ def report_host(opts)
   end
 
   def update_host(opts)
-    $stderr.puts "DBManager::Host.update_host(): opts = #{opts}"  # TODO: remove
     # TODO: remove unneeded workspace from opts until it's not automatically added to remote requests
-    wspace = opts.delete(:workspace)
-    $stderr.puts "DBManager::Host.update_host(): delete workspace from opts; wspace = #{wspace}"  # TODO: remove
+    opts.delete(:workspace)
 
     ::ActiveRecord::Base.connection_pool.with_connection {
       id = opts.delete(:id)
-      $stderr.puts "DBManager::Host.update_host(): id = #{id}, opts = #{opts}"  # TODO: remove
       Mdm::Host.update(id, opts)
     }
   end

lib/msf/core/db_manager/http/servlet/host_servlet.rb

@@ -22,7 +22,6 @@ def self.registered(app)
   def self.get_host
     lambda {
       begin
-        $stderr.puts "HostServlet.get_host(): params[:id] = #{params[:id]}" if params[:id]  # TODO: remove
         opts = parse_json_request(request, false)
         data = get_db().hosts(params.symbolize_keys)
         includes = [:loots]
@@ -50,12 +49,8 @@ def self.update_host
     lambda {
       begin
         opts = parse_json_request(request, false)
-        $stderr.puts "HostServlet.update_host(): opts = #{opts}"  # TODO: remove
-        $stderr.puts "HostServlet.update_host(): params = #{params}"  # TODO: remove
-        # opts_and_params = params ? opts.merge(params.symbolize_keys) : opts
         tmp_params = params.symbolize_keys
         opts[:id] = tmp_params[:id] if tmp_params[:id]
-        $stderr.puts "HostServlet.update_host(): opts = #{opts}"  # TODO: remove
         data = get_db().update_host(opts)
         set_json_response(data)
       rescue Exception => e

lib/msf/ui/console/command_dispatcher/db.rb

@@ -231,52 +231,28 @@ def cmd_hosts_help
             cmd_hosts("-h")
           end
 
-          def change_host_info(host_ranges, data)
+          # Changes the specified host data
+          #
+          # @param host_ranges - range of hosts to process
+          # @param host_data - hash of host data to be updated
+          def change_host_data(host_ranges, host_data)
+            if !host_data || host_data.length != 1
+              print_error("A single key-value data hash is required to change the host data")
+              return
+            end
+            attribute = host_data.keys[0]
+
             if host_ranges == [nil]
-              print_error("In order to change the host info, you must provide a range of hosts")
+              print_error("In order to change the host #{attribute}, you must provide a range of hosts")
               return
             end
 
-            $stderr.puts "Msf::Ui::Console::CommandDispatcher::Db.change_host_info(): host_ranges = #{host_ranges}"
             each_host_range_chunk(host_ranges) do |host_search|
-              $stderr.puts "Msf::Ui::Console::CommandDispatcher::Db.change_host_info(): host_search = #{host_search}\n"
               break if !host_search.nil? && host_search.empty?
 
               framework.db.hosts(framework.db.workspace, false, host_search).each do |host|
-                $stderr.puts "Msf::Ui::Console::CommandDispatcher::Db.change_host_info(): host = #{host}, host.id = #{host.id}, host.address = #{host.address}, host.workspace_id = #{host.workspace_id}"
-                framework.db.update_host(id: host.id, info: data)
-                framework.db.report_note(:host => host.address, :type => 'host.info', :data => data)
-                $stderr.puts "************************************\n"
-              end
-            end
-          end
-
-          def change_host_name(rws, data)
-            if rws == [nil]
-              print_error("In order to change the host name, you must provide a range of hosts")
-              return
-            end
-
-            rws.each do |rw|
-              rw.each do |ip|
-                id = framework.db.get_host(:address => ip).id
-                framework.db.hosts.update(id, :name => data)
-                framework.db.report_note(:host => ip, :type => 'host.name', :data => data)
-              end
-            end
-          end
-
-          def change_host_comment(rws, data)
-            if rws == [nil]
-              print_error("In order to change the comment, you must provide a range of hosts")
-              return
-            end
-
-            rws.each do |rw|
-              rw.each do |ip|
-                id = framework.db.get_host(:address => ip).id
-                framework.db.hosts.update(id, :comments => data)
-                framework.db.report_note(:host => ip, :type => 'host.comments', :data => data)
+                framework.db.update_host(host_data.merge(id: host.id))
+                framework.db.report_note(host: host.address, type: "host.#{attribute}", data: host_data[attribute])
               end
             end
           end
@@ -497,13 +473,13 @@ def cmd_hosts(*args)
 
             case
               when mode == [:new_info]
-                change_host_info(host_ranges, info_data)
+                change_host_data(host_ranges, info: info_data)
                 return
               when mode == [:new_name]
-                change_host_name(host_ranges, name_data)
+                change_host_data(host_ranges, name: name_data)
                 return
               when mode == [:new_comment]
-                change_host_comment(host_ranges, comment_data)
+                change_host_data(host_ranges, comments: comment_data)
                 return
               when mode == [:tag]
                 begin