From bd2dcdb5c3de3340194c099aa52c35a2dd0569e8 Mon Sep 17 00:00:00 2001
From: James Lee <James_Lee@rapid7.com>
Date: Wed, 19 Jan 2011 16:01:12 +0000
Subject: [PATCH] add the scriptable mixin.  fixes #3550, see #3541.  /me
 grumbles

git-svn-id: file:///home/svn/framework3/trunk@11600 4d416f70-5f16-0410-b530-b9f4589650da
---
 lib/msf/base/sessions/scriptable.rb | 86 +++++++++++++++++++++++++++++
 1 file changed, 86 insertions(+)
 create mode 100644 lib/msf/base/sessions/scriptable.rb

diff --git a/lib/msf/base/sessions/scriptable.rb b/lib/msf/base/sessions/scriptable.rb
new file mode 100644
index 0000000000..a567f47212
--- /dev/null
+++ b/lib/msf/base/sessions/scriptable.rb
@@ -0,0 +1,86 @@
+
+module Msf::Session
+
+module Scriptable
+
+	def self.included(base)
+		base.extend(ClassMethods)
+	end
+
+	module ClassMethods
+		#
+		# If the +script+ exists, return its path. Otherwise return nil
+		#
+		def find_script_path(script)
+			# Find the full file path of the specified argument
+			check_paths =
+				[
+					script,
+					::File.join(script_base, "#{script}"),
+					::File.join(script_base, "#{script}.rb"),
+					::File.join(user_script_base, "#{script}"),
+					::File.join(user_script_base, "#{script}.rb)")
+				]
+
+			full_path = nil
+
+			# Scan all of the path combinations
+			check_paths.each { |path|
+				if ::File.exists?(path)
+					full_path = path
+					break
+				end
+			}
+
+			full_path
+		end
+		def script_base
+			::File.join(Msf::Config.script_directory, self.type)
+		end
+		def user_script_base
+			::File.join(Msf::Config.user_script_directory, self.type)
+		end
+
+	end
+
+	#
+	# Override
+	#
+	def execute_file
+		raise NotImplementedError
+	end
+
+	#
+	# Executes the supplied script or Post module with arguments +args+
+	#
+	# Will search the script path.
+	#
+	def execute_script(script_name, *args)
+		mod = framework.modules.create(script_name)
+		if (mod and mod.type == "post")
+			opts = (args + [ "SESSION=#{self.sid}" ]).join(',')
+			mod.run_simple(
+				# Run with whatever the default stance is for now.  At some
+				# point in the future, we'll probably want a way to force a
+				# module to run in the background
+				#'RunAsJob' => true,
+				'LocalInput'  => self.user_input,
+				'LocalOutput' => self.user_output,
+				'OptionStr'   => opts
+			)
+		else
+			full_path = self.class.find_script_path(script_name)
+
+			# No path found?  Weak.
+			if full_path.nil?
+				print_error("The specified script could not be found: #{script_name}")
+				return true
+			end
+			execute_file(full_path, args)
+		end
+	end
+
+end
+
+end
+