Class: Rex::Ui::Text::Table

Inherits:
Object
  • Object
show all
Defined in:
lib/rex/ui/text/table.rb

Overview

Prints text in a tablized format. Pretty lame at the moment, but whatever.

Direct Known Subclasses

Msf::Ui::Console::Table

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ 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.


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/rex/ui/text/table.rb', line 62

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.sort_index  = opts['SortIndex'] || 0

  # 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

Instance Attribute Details

#cellpadObject

:nodoc:


244
245
246
# File 'lib/rex/ui/text/table.rb', line 244

def cellpad
  @cellpad
end

#colpropsObject

:nodoc:


243
244
245
# File 'lib/rex/ui/text/table.rb', line 243

def colprops
  @colprops
end

#columnsObject

:nodoc:


243
244
245
# File 'lib/rex/ui/text/table.rb', line 243

def columns
  @columns
end

#headerObject

:nodoc:


242
243
244
# File 'lib/rex/ui/text/table.rb', line 242

def header
  @header
end

#headeriObject

:nodoc:


242
243
244
# File 'lib/rex/ui/text/table.rb', line 242

def headeri
  @headeri
end

#indentObject

:nodoc:


244
245
246
# File 'lib/rex/ui/text/table.rb', line 244

def indent
  @indent
end

#postfixObject

:nodoc:


245
246
247
# File 'lib/rex/ui/text/table.rb', line 245

def postfix
  @postfix
end

#prefixObject

:nodoc:


245
246
247
# File 'lib/rex/ui/text/table.rb', line 245

def prefix
  @prefix
end

#rowsObject

:nodoc:


243
244
245
# File 'lib/rex/ui/text/table.rb', line 243

def rows
  @rows
end

#sort_indexObject

:nodoc:


246
247
248
# File 'lib/rex/ui/text/table.rb', line 246

def sort_index
  @sort_index
end

#widthObject

:nodoc:


244
245
246
# File 'lib/rex/ui/text/table.rb', line 244

def width
  @width
end

Instance Method Details

#<<(fields) ⇒ Object

Adds a row using the supplied fields.


165
166
167
# File 'lib/rex/ui/text/table.rb', line 165

def <<(fields)
  add_row(fields)
end

#[](*col_names) ⇒ Object

Returns new sub-table with headers and rows maching column names submitted


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'lib/rex/ui/text/table.rb', line 218

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

#add_hrObject

Adds a horizontal line.


211
212
213
# File 'lib/rex/ui/text/table.rb', line 211

def add_hr
  rows << '__hr__'
end

#add_row(fields = []) ⇒ Object

Adds a row with the supplied fields.


172
173
174
175
176
177
178
179
180
181
182
183
# File 'lib/rex/ui/text/table.rb', line 172

def add_row(fields = [])
  if fields.length != self.columns.length
    raise RuntimeError, 'Invalid number of columns!'
  end
  fields.each_with_index { |field, idx|
    if (colprops[idx]['MaxWidth'] < field.to_s.length)
      colprops[idx]['MaxWidth'] = field.to_s.length
    end
  }

  rows << fields
end

#header_to_sObject

Returns the header string.


145
146
147
148
149
150
151
152
153
# File 'lib/rex/ui/text/table.rb', line 145

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.


158
159
160
# File 'lib/rex/ui/text/table.rb', line 158

def print
  puts to_s
end

#sort_rows(index = sort_index) ⇒ Object

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.


190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
# File 'lib/rex/ui/text/table.rb', line 190

def sort_rows(index=sort_index)
  return if index == -1
  return unless rows
  rows.sort! do |a,b|
    if a[index].nil?
      -1
    elsif b[index].nil?
      1
    elsif Rex::Socket.dotted_ip?(a[index]) and Rex::Socket.dotted_ip?(b[index])
      Rex::Socket::addr_atoi(a[index]) <=> Rex::Socket::addr_atoi(b[index])
    elsif a[index] =~ /^[0-9]+$/ and b[index] =~ /^[0-9]+$/
      a[index].to_i <=> b[index].to_i
    else
      a[index] <=> b[index] # assumes otherwise comparable.
    end
  end
end

#to_csvObject

Converts table contents to a csv


127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'lib/rex/ui/text/table.rb', line 127

def to_csv
  str = ''
  str << ( columns.join(",") + "\n" )
  rows.each { |row|
    next if is_hr(row)
    str << ( row.map{|x|
      x = x.to_s

      x.gsub(/[\r\n]/, ' ').gsub(/\s+/, ' ').gsub('"', '""')
    }.map{|x| "\"#{x}\"" }.join(",") + "\n" )
  }
  str
end

#to_sObject

Converts table contents to a string.


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/rex/ui/text/table.rb', line 104

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)
    end
  }

  str << postfix

  return str
end