librex 0.0.1

data/lib/rex/ui/output.rb

@@ -0,0 +1,80 @@
+require 'rex/ui'
+
+module Rex
+module Ui
+
+###
+#
+# This class acts as a generic base class for outputing data.  It
+# only provides stubs for the simplest form of outputing information.
+#
+###
+class Output
+
+	# General output
+	require 'rex/ui/output/none'
+
+	# Text-based output
+	require 'rex/ui/text/output'
+
+	attr_accessor :on_print_proc
+
+	#
+	# Prints an error message.
+	#
+	def print_error(msg='')
+	end
+
+	#
+	# Prints a 'good' message.
+	#
+	def print_good(msg='')
+	end
+
+	def print_debug(msg='')
+	end
+
+	#
+	# Prints a status line.
+	#
+	def print_status(msg='')
+	end
+
+	#
+	# Prints an undecorated line of information.
+	#
+	def print_line(msg='')
+	end
+
+	#
+	# Prints a message with no decoration.
+	#
+	def print(msg='')
+	end
+
+	#
+	# Flushes any buffered output.
+	#
+	def flush
+	end
+
+	#
+	# Called to tell the output medium that we're at a prompt.
+	# This is used to allow the output medium to display an extra
+	# carriage return
+	#
+	def prompting(v = true)
+		@at_prompt = v
+	end
+
+	#
+	# Returns whether or not we're at a prompt currently
+	#
+	def prompting?
+		@at_prompt
+	end
+
+end
+
+end
+end

data/lib/rex/ui/output/none.rb

@@ -0,0 +1,18 @@
+require 'rex/ui'
+
+module Rex
+module Ui
+
+###
+#
+# This output medium implements all the required output routines but does not
+# back them against any sort of device.  This is basically meant to be put in
+# place of something that expects to be able to deal with a functional output
+# device when one does not actually exist.
+#
+###
+class Output::None < Rex::Ui::Output
+end
+
+end
+end

data/lib/rex/ui/progress_tracker.rb

@@ -0,0 +1,96 @@
+module Rex
+module Ui
+
+###
+#
+# This module tracks the progress of an arbitrary task in a generic fashion.
+# The actual implementation is left up to the thing that derives from this
+# module.
+#
+###
+class ProgressTracker
+
+	require 'rex/ui/text/progress_tracker'
+
+	def initialize
+		self.start = 0
+		self.stop  = 0
+		self.pos   = 0
+	end
+
+	#
+	# Sets start and step using a range.
+	#
+	def range=(rng)
+		self.start = rng.begin
+		self.stop  = rng.end
+	end
+
+	#
+	# Sets the start and resets the position.
+	#
+	def start=(start)
+		@start   = start
+		self.pos = start
+	end
+
+	#
+	# Steps with a given message and step size.
+	#
+	def step(status = nil, n = 1)
+		self.pos += n if (self.pos + n <= self.stop)
+
+		step_status(status)
+
+		self.pos
+	end
+
+	#
+	# Resets the current step location.
+	#
+	def reset(n = self.start)
+		self.pos = n
+	end
+
+	#
+	# Passes a generic status message that isn't necessarily associated
+	# with a step event.
+	#
+	def status(msg = nil)
+	end
+
+	#
+	# Updates the status associated with the current step.
+	#
+	def step_status(msg = nil)
+	end
+
+	#
+	# An error occurred that may result in aborting the progress.
+	#
+	def error(msg = nil)
+	end
+
+	#
+	# Progress has been aborted, the reason is supplied in msg.
+	#
+	def abort(msg = nil)
+	end
+
+	#
+	# The start of the progress.
+	#
+	attr_reader   :start
+	#
+	# The last position in the progress.
+	#
+	attr_accessor :stop
+	#
+	# The current position in the progress.
+	#
+	attr_accessor :pos
+
+end
+
+end
+end

data/lib/rex/ui/subscriber.rb

@@ -0,0 +1,149 @@
+module Rex
+module Ui
+
+###
+#
+# This module provides a subscriber interface to input/output.
+#
+###
+module Subscriber
+
+	##
+	#
+	# Subscribes to the output half of the user interface.
+	#
+	##
+	module Output
+
+		#
+		# Wraps user_output.print_line
+		#
+		def print_line(msg='')
+			if (user_output)
+				print_blank_line if user_output.prompting?
+				user_output.print_line(msg) 
+			end
+		end
+
+		#
+		# Wraps user_output.print_status
+		#
+		def print_status(msg='')
+			if (user_output)
+				print_blank_line if user_output.prompting?
+				user_output.print_status(msg) 
+			end
+		end
+
+		#
+		# Wraps user_output.print_error
+		#
+		def print_error(msg='')
+			if (user_output)
+				print_blank_line if user_output.prompting?
+				user_output.print_error(msg) 
+			end
+		end
+		
+		#
+		# Wraps user_output.print_good
+		#
+		def print_good(msg='')
+			if (user_output)
+				print_blank_line if user_output.prompting?
+				user_output.print_good(msg) 
+			end
+		end
+
+		#
+		# Wraps user_output.print_debug
+		#
+		def print_debug(msg='')
+			if (user_output)
+				print_blank_line if user_output.prompting?
+				user_output.print_debug(msg)
+			end
+		end
+
+		#
+		# Wraps user_output.print
+		#
+		def print(msg='')
+			user_output.print(msg) if (user_output)
+		end
+
+		#
+		# Wraps user_output.flush
+		#
+		def flush
+			user_output.flush if (user_output)
+		end
+
+		#
+		# The user output handle.
+		#
+		attr_accessor :user_output
+	
+	protected
+
+		# 
+		# Prints a blank line.  Used when the input is prompting.
+		#
+		def print_blank_line
+			user_output.prompting(false)
+			user_output.print_line
+		end
+
+	end
+
+	##
+	#
+	# Subscribes to the input half of the user interface.
+	#
+	##
+	module Input
+
+		#
+		# Gets a line of input from the user_input handle by calling gets.
+		#
+		def gets
+			user_input.gets if (user_input)
+		end
+	
+		#
+		# The user intput handle.
+		#
+		attr_accessor :user_input
+
+	end
+
+	include Output
+	include Input
+
+	#
+	# Sets the input and output handles.
+	#
+	def init_ui(input = nil, output = nil)
+		self.user_input  = input
+		self.user_output = output
+	end
+
+	#
+	# Disables input/output
+	#
+	def reset_ui
+		self.user_input  = nil
+		self.user_output = nil
+	end
+
+	#
+	# Copy the user input and output handles from the supplied subscriber.
+	#
+	def copy_ui(subscriber)
+		init_ui(subscriber.user_input, subscriber.user_output)
+	end
+
+end
+
+end
+end

data/lib/rex/ui/text/color.rb

@@ -0,0 +1,97 @@
+module Rex
+module Ui
+module Text
+
+###
+#
+# This module provides an interface to getting ANSI color codes.
+# It's taken mostly from perl's Term::ANSIColor by Russ Allbery
+# <rra@stanford.edu> and Zenin <zenin@best.com>.
+#
+###
+module Color
+
+	AnsiAttributes =
+		{
+			'clear'      => 0,
+			'reset'      => 0,
+			'bold'       => 1,
+			'dark'       => 2,
+			'underline'  => 4,
+			'underscore' => 4,
+			'blink'      => 5,
+			'reverse'    => 7,
+			'concealed'  => 8,
+			'black'      => 30,   'on_black'   => 40,
+			'red'        => 31,   'on_red'     => 41,
+			'green'      => 32,   'on_green'   => 42,
+			'yellow'     => 33,   'on_yellow'  => 43,
+			'blue'       => 34,   'on_blue'    => 44,
+			'magenta'    => 35,   'on_magenta' => 45,
+			'cyan'       => 36,   'on_cyan'    => 46,
+			'white'      => 37,   'on_white'   => 47
+		}
+
+	#
+	# Return a string with ANSI codes substituted.  Derived from code
+	# written by The FaerieMUD Consortium.
+	#
+	def ansi(*attrs)
+		attr = attrs.collect {|a| AnsiAttributes[a] ? AnsiAttributes[a] : nil}.compact.join(';')
+		attr = "\e[%sm" % attr if (attr.empty? == false)
+		return attr
+	end
+
+	#
+	# Colorize if this shell supports it
+	#
+	def colorize(*color)
+		supports_color?() ? ansi(*color) : ''
+	end
+
+	def substitute_colors(msg, in_prompt = nil)
+		str = msg.dup
+		pre_color = post_color = ''
+		if (in_prompt)
+			pre_color = "\x01"  # RL_PROMPT_START_IGNORE
+			post_color = "\x02" # RL_PROMPT_END_IGNORE
+		end
+		str.gsub!(/%cya/, pre_color+colorize('cyan')+post_color)
+		str.gsub!(/%red/, pre_color+colorize('red')+post_color)
+		str.gsub!(/%grn/, pre_color+colorize('green')+post_color)
+		str.gsub!(/%blu/, pre_color+colorize('blue')+post_color)
+		str.gsub!(/%yel/, pre_color+colorize('yellow')+post_color)
+		str.gsub!(/%whi/, pre_color+colorize('white')+post_color)
+		str.gsub!(/%mag/, pre_color+colorize('magenta')+post_color)
+		str.gsub!(/%blk/, pre_color+colorize('black')+post_color)
+		str.gsub!(/%dred/, pre_color+colorize('dark', 'red')+post_color)
+		str.gsub!(/%dgrn/, pre_color+colorize('dark', 'green')+post_color)
+		str.gsub!(/%dblu/, pre_color+colorize('dark', 'blue')+post_color)
+		str.gsub!(/%dyel/, pre_color+colorize('dark', 'yellow')+post_color)
+		str.gsub!(/%dcya/, pre_color+colorize('dark', 'cyan')+post_color)
+		str.gsub!(/%dwhi/, pre_color+colorize('dark', 'white')+post_color)
+		str.gsub!(/%dmag/, pre_color+colorize('dark', 'magenta')+post_color)
+		str.gsub!(/%und/, pre_color+colorize('underline')+post_color)
+		str.gsub!(/%bld/, pre_color+colorize('bold')+post_color)
+		str.gsub!(/%clr/, pre_color+colorize('clear')+post_color)
+
+		str
+	end
+
+	#
+	# Resets coloring so that it's back to normal.
+	#
+	def reset_color
+		return if not supports_color?
+		print(colorize('clear'))
+	end
+
+	#
+	# Colorize if this shell supports it
+	#
+	def do_colorize(*color) 
+		supports_color?() ? ansi(*color) : ''
+	end
+end 
+
+end end end

data/lib/rex/ui/text/color.rb.ut.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', '..', '..'))
+
+require 'test/unit'
+require 'rex/ui/text/color'
+
+class Rex::Ui::Text::Color::UnitTest < Test::Unit::TestCase
+
+	def test_color
+		color  = Rex::Ui::Text::Color.new.ansi('bold', 'red')
+		color += 'hey sup'
+		color += Rex::Ui::Text::Color.new.ansi('clear')
+
+		assert_equal("\e[1;31mhey sup\e[0m", color)
+	end
+
+end