rex-text 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c21a0eef12185e5d77b4ab24904765c42f464004
-  data.tar.gz: 6f588d580a7b84a6eddfcf4a07cf0ec617e16d21
+  metadata.gz: a213d45ce77b442cf80cc9e8c302d705c9f63128
+  data.tar.gz: 739aabf270a14239b68f9bdc3f394eebaa949efc
 SHA512:
-  metadata.gz: 91d1531cc4a260903fa59357a6b4aeea72ddce6b3018953e6084f1943149ddedfcd2f7378d6638992020c9e2244a44ca2ab63a48809b4648230388d1d3601304
-  data.tar.gz: 2cab8cb2862e871ea5cdde228266a1796c23ffaadb46f71118976108a7bff008d6aebd11e09a7e3f43825790a856d8ee3502b4a139a454c7f617ee1d3c9b2403
+  metadata.gz: cd856ab7b00383f19e189e4da9f55e8b078a6ef1429535b4e6c223ce853dd83bbdd8fb562cb0f7fe295db52de89c538e11fa1b677f0d97a15684271de22671d7
+  data.tar.gz: e77455056b8e1ffa80af71886deae1576a21b8f92bc2450f296dc4430ec6cd5c9a229d03c95fc3cc6cb788aeef5aa9e829103d88116d751bc6046c20b5e1dd33

data/lib/rex/text.rb

@@ -25,6 +25,10 @@ require 'rex/text/ebcdic'
 require 'rex/text/pattern'
 require 'rex/text/badchars'
 
+require 'rex/text/color'
+require 'rex/text/table'
+
+
 module Rex
 
 ###

data/lib/rex/text/color.rb

@@ -0,0 +1,106 @@
+# -*- coding: binary -*-
+module Rex
+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)
+    # Background Color
+    str.gsub!(/%bgblu/, pre_color+colorize('on_blue')+post_color)
+    str.gsub!(/%bgyel/, pre_color+colorize('on_yellow')+post_color)
+    str.gsub!(/%bggrn/, pre_color+colorize('on_green')+post_color)
+    str.gsub!(/%bgmag/, pre_color+colorize('on_magenta')+post_color)
+    str.gsub!(/%bgblk/, pre_color+colorize('on_black')+post_color)
+    str.gsub!(/%bgred/, pre_color+colorize('on_red')+post_color)
+    str.gsub!(/%bgcyn/, pre_color+colorize('on_cyan')+post_color)
+    str.gsub!(/%bgwhi/, pre_color+colorize('on_white')+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

data/lib/rex/text/table.rb

@@ -0,0 +1,418 @@
+# -*- coding: binary -*-
+
+module Rex
+module Text
+
+###
+#
+# Prints text in a tablized format.  Pretty lame at the moment, but
+# whatever.
+#
+###
+class Table
+
+  #
+  # Initializes a text table instance using the supplied properties.  The
+  # Table class supports the following hash attributes:
+  #
+  # Header
+  #
+  #	The string to display as a heading above the table.  If none is
+  #	specified, no header will be displayed.
+  #
+  # HeaderIndent
+  #
+  # 	The amount of space to indent the header.  The default is zero.
+  #
+  # Columns
+  #
+  # 	The array of columns that will exist within the table.
+  #
+  # Rows
+  #
+  # 	The array of rows that will exist.
+  #
+  # Width
+  #
+  # 	The maximum width of the table in characters.
+  #
+  # Indent
+  #
+  # 	The number of characters to indent the table.
+  #
+  # CellPad
+  #
+  # 	The number of characters to put between each horizontal cell.
+  #
+  # Prefix
+  #
+  # 	The text to prefix before the table.
+  #
+  # Postfix
+  #
+  # 	The text to affix to the end of the table.
+  #
+  # Sortindex
+  #
+  #	The column to sort the table on, -1 disables sorting.
+  #
+  def initialize(opts = {})
+    self.header   = opts['Header']
+    self.headeri  = opts['HeaderIndent'] || 0
+    self.columns  = opts['Columns'] || []
+    # updated below if we got a "Rows" option
+    self.rows     = []
+
+    self.width    = opts['Width']   || 80
+    self.indent   = opts['Indent']  || 0
+    self.cellpad  = opts['CellPad'] || 2
+    self.prefix   = opts['Prefix']  || ''
+    self.postfix  = opts['Postfix'] || ''
+    self.colprops = []
+    self.scterm   = /#{opts['SearchTerm']}/mi if opts['SearchTerm']
+
+    self.sort_index  = opts['SortIndex'] || 0
+    self.sort_order  = opts['SortOrder'] || :forward
+
+    # Default column properties
+    self.columns.length.times { |idx|
+      self.colprops[idx] = {}
+      self.colprops[idx]['MaxWidth'] = self.columns[idx].length
+    }
+
+    # ensure all our internal state gets updated with the given rows by
+    # using add_row instead of just adding them to self.rows.  See #3825.
+    opts['Rows'].each { |row| add_row(row) } if opts['Rows']
+
+    # Merge in options
+    if (opts['ColProps'])
+      opts['ColProps'].each_key { |col|
+        idx = self.columns.index(col)
+
+        if (idx)
+          self.colprops[idx].merge!(opts['ColProps'][col])
+        end
+      }
+    end
+
+  end
+
+  #
+  # Converts table contents to a string.
+  #
+  def to_s
+    str  = prefix.dup
+    str << header_to_s || ''
+    str << columns_to_s || ''
+    str << hr_to_s || ''
+
+    sort_rows
+    rows.each { |row|
+      if (is_hr(row))
+        str << hr_to_s
+      else
+        str << row_to_s(row) if row_visible(row)
+      end
+    }
+
+    str << postfix
+
+    return str
+  end
+
+  #
+  # Converts table contents to a csv
+  #
+  def to_csv
+    str = ''
+    str << ( columns.join(",") + "\n" )
+    rows.each { |row|
+      next if is_hr(row) || !row_visible(row)
+      str << ( row.map{|x|
+        x = x.to_s
+        x.gsub(/[\r\n]/, ' ').gsub(/\s+/, ' ').gsub('"', '""')
+      }.map{|x| "\"#{x}\"" }.join(",") + "\n" )
+    }
+    str
+  end
+
+  #
+  #
+  # Returns the header string.
+  #
+  def header_to_s # :nodoc:
+    if (header)
+      pad = " " * headeri
+
+      return pad + header + "\n" + pad + "=" * header.length + "\n\n"
+    end
+
+    return ''
+  end
+
+  #
+  # Prints the contents of the table.
+  #
+  def print
+    puts to_s
+  end
+
+  #
+  # Adds a row using the supplied fields.
+  #
+  def <<(fields)
+    add_row(fields)
+  end
+
+  #
+  # Adds a row with the supplied fields.
+  #
+  def add_row(fields = [])
+    if fields.length != self.columns.length
+      raise RuntimeError, 'Invalid number of columns!'
+    end
+    fields.each_with_index { |field, idx|
+      # Remove whitespace and ensure String format
+      field = field.to_s.strip
+      if (colprops[idx]['MaxWidth'] < field.to_s.length)
+        old = colprops[idx]['MaxWidth']
+        colprops[idx]['MaxWidth'] = field.to_s.length
+      end
+    }
+
+    rows << fields
+  end
+
+  #
+  # Sorts the rows based on the supplied index of sub-arrays
+  # If the supplied index is an IPv4 address, handle it differently, but
+  # avoid actually resolving domain names.
+  #
+  def sort_rows(index = sort_index, order = sort_order)
+    return if index == -1
+    return unless rows
+    rows.sort! do |a,b|
+      if a[index].nil?
+        cmp = -1
+      elsif b[index].nil?
+        cmp = 1
+      elsif valid_ip?(a[index]) and valid_ip?(b[index])
+        cmp = IPAddr.new(a[index]) <=> IPAddr.new(b[index])
+      elsif a[index] =~ /^[0-9]+$/ and b[index] =~ /^[0-9]+$/
+        cmp = a[index].to_i <=> b[index].to_i
+      elsif a[index].kind_of?(IPAddr) && a[index].kind_of?(IPAddr) && a[index].ipv6? && b[index].ipv4?
+        cmp = 1
+      elsif a[index].kind_of?(IPAddr) && b[index].kind_of?(IPAddr) && a[index].ipv4? && b[index].ipv6?
+        cmp = -1
+      else
+        cmp = a[index] <=> b[index] # assumes otherwise comparable.
+      end
+      order == :forward ? cmp : -cmp
+    end
+  end
+
+  #
+  # Adds a horizontal line.
+  #
+  def add_hr
+    rows << '__hr__'
+  end
+
+  #
+  # Returns new sub-table with headers and rows maching column names submitted
+  #
+  #
+  # Flips table 90 degrees left
+  #
+  def drop_left
+    tbl = self.class.new(
+      'Columns' => Array.new(self.rows.count+1,'  '),
+      'Header' => self.header,
+      'Indent' => self.indent)
+    (self.columns.count+1).times do |ti|
+      row = self.rows.map {|r| r[ti]}.unshift(self.columns[ti]).flatten
+      # insert our col|row break. kind of hackish
+      row[1] = "| #{row[1]}" unless row.all? {|e| e.nil? || e.empty?}
+      tbl << row
+    end
+    return tbl
+  end
+
+  def valid_ip?(value)
+    begin
+      IPAddr.new value
+      true
+    rescue IPAddr::InvalidAddressError
+      false
+    end
+  end
+
+  #
+  # Build table from CSV dump
+  #
+  def self.new_from_csv(csv)
+    # Read in or keep data, get CSV or die
+    if csv.is_a?(String)
+      csv = File.file?(csv) ? CSV.read(csv) : CSV.parse(csv)
+    end
+    # Adjust for skew
+    if csv.first == ["Keys", "Values"]
+      csv.shift # drop marker
+      cols = []
+      rows = []
+      csv.each do |row|
+        cols << row.shift
+        rows << row
+      end
+      tbl = self.new('Columns' => cols)
+      rows.in_groups_of(cols.count) {|r| tbl << r.flatten}
+    else
+      tbl = self.new('Columns' => csv.shift)
+      while !csv.empty? do
+        tbl << csv.shift
+      end
+    end
+    return tbl
+  end
+
+  def [](*col_names)
+    tbl = self.class.new('Indent' => self.indent,
+                         'Header' => self.header,
+                         'Columns' => col_names)
+    indexes = []
+
+    col_names.each do |col_name|
+      index = self.columns.index(col_name)
+      raise RuntimeError, "Invalid column name #{col_name}" if index.nil?
+      indexes << index
+    end
+
+    self.rows.each do |old_row|
+      new_row = []
+      indexes.map {|i| new_row << old_row[i]}
+      tbl << new_row
+    end
+
+    return tbl
+  end
+
+
+  alias p print
+
+  attr_accessor :header, :headeri # :nodoc:
+  attr_accessor :columns, :rows, :colprops # :nodoc:
+  attr_accessor :width, :indent, :cellpad # :nodoc:
+  attr_accessor :prefix, :postfix # :nodoc:
+  attr_accessor :sort_index, :sort_order, :scterm # :nodoc:
+
+protected
+
+  #
+  # Returns if a row should be visible or not
+  #
+  def row_visible(row)
+    return true if self.scterm.nil?
+    row_to_s(row).match(self.scterm)
+  end
+
+  #
+  # Defaults cell widths and alignments.
+  #
+  def defaults # :nodoc:
+    self.columns.length.times { |idx|
+    }
+  end
+
+  #
+  # Checks to see if the row is an hr.
+  #
+  def is_hr(row) # :nodoc:
+    return ((row.kind_of?(String)) && (row == '__hr__'))
+  end
+
+  #
+  # Converts the columns to a string.
+  #
+  def columns_to_s # :nodoc:
+    nameline = ' ' * indent
+    barline  = nameline.dup
+    last_col = nil
+    last_idx = nil
+    columns.each_with_index { |col,idx|
+      if (last_col)
+        # This produces clean to_s output without truncation
+        # Preserves full string in cells for to_csv output
+        padding = pad(' ', last_col, last_idx)
+        nameline << padding
+        remainder = padding.length - cellpad
+        remainder = 0 if remainder < 0
+        barline << (' ' * (cellpad + remainder))
+      end
+
+      nameline << col
+      barline << ('-' * col.length)
+
+      last_col = col
+      last_idx = idx
+    }
+
+    return "#{nameline}\n#{barline}"
+  end
+
+  #
+  # Converts an hr to a string.
+  #
+  def hr_to_s # :nodoc:
+    return "\n"
+  end
+
+  #
+  # Converts a row to a string.
+  #
+  def row_to_s(row) # :nodoc:
+    line = ' ' * indent
+    last_cell = nil
+    last_idx = nil
+    row.each_with_index { |cell, idx|
+      if (idx != 0)
+        line << pad(' ', last_cell.to_s, last_idx)
+      end
+      # Limit wide cells
+      if colprops[idx]['MaxChar']
+        last_cell = cell.to_s[0..colprops[idx]['MaxChar'].to_i]
+        line << last_cell
+      else
+        line << cell.to_s
+        last_cell = cell
+      end
+      last_idx = idx
+    }
+
+    return line + "\n"
+  end
+
+  #
+  # Pads out with the supplied character for the remainder of the space given
+  # some text and a column index.
+  #
+  def pad(chr, buf, colidx, use_cell_pad = true) # :nodoc:
+    # Ensure we pad the minimum required amount
+    max = colprops[colidx]['MaxChar'] || colprops[colidx]['MaxWidth']
+    max = colprops[colidx]['MaxWidth'] if max.to_i > colprops[colidx]['MaxWidth'].to_i
+    remainder = max - buf.length
+    remainder = 0 if remainder < 0
+    val       = chr * remainder
+
+    if (use_cell_pad)
+      val << ' ' * cellpad
+    end
+
+    return val
+  end
+
+
+end
+
+end
+end
+

data/lib/rex/text/version.rb

@@ -1,5 +1,5 @@
 module Rex
   module Text
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rex-text
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - David 'thelightcosine' Maloney
@@ -85,7 +85,7 @@ cert_chain:
   2SpuQH+SWteq3NXkAmFEEqvLJQ4sbptZt8OP8ghL3pVAvZNFmww/YVszSkShSzcg
   QdihYCSEL2drS2cFd50jBeq71sxUtxbv82DUa2b+
   -----END CERTIFICATE-----
-date: 2016-06-21 00:00:00.000000000 Z
+date: 2016-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -155,6 +155,7 @@ files:
 - lib/rex/text/binary_manipulation.rb
 - lib/rex/text/block_api.rb
 - lib/rex/text/checksum.rb
+- lib/rex/text/color.rb
 - lib/rex/text/compress.rb
 - lib/rex/text/ebcdic.rb
 - lib/rex/text/encode.rb
@@ -166,6 +167,7 @@ files:
 - lib/rex/text/rand.rb
 - lib/rex/text/randomize.rb
 - lib/rex/text/silly.rb
+- lib/rex/text/table.rb
 - lib/rex/text/unicode.rb
 - lib/rex/text/version.rb
 - rex-text.gemspec