Class: Nexpose::ReportConfig

Inherits:
AdhocReportConfig show all
Defined in:
lib/nexpose/report.rb

Overview

Definition object for a report configuration.

Instance Attribute Summary collapse

Attributes inherited from AdhocReportConfig

#baseline, #filters, #format, #owner, #template_id, #time_zone

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AdhocReportConfig

#add_filter

Methods included from XMLUtils

#make_xml, #parse_xml

Constructor Details

#initialize(name, template_id, format, id = -1,, owner = nil, time_zone = nil) ⇒ ReportConfig

Construct a basic ReportConfig object.



290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/nexpose/report.rb', line 290

def initialize(name, template_id, format, id = -1, owner = nil, time_zone = nil)
  @name = name
  @template_id = template_id
  @format = format
  @id = id
  @owner = owner
  @time_zone = time_zone

  @filters = []
  @users = []
end

Instance Attribute Details

#db_export ⇒ Object

Database export configuration.



287
288
289
 
# File 'lib/nexpose/report.rb', line 287

def db_export
  @db_export
end

#delivery ⇒ Object

Report delivery configuration.



285
286
287
 
# File 'lib/nexpose/report.rb', line 285

def delivery
  @delivery
end

#description ⇒ Object

Description associated with this report.



279
280
281
 
# File 'lib/nexpose/report.rb', line 279

def description
  @description
end

#generate(connection, wait = false) ⇒ Object

Generate a new report using this report definition.



283
284
285
 
# File 'lib/nexpose/report.rb', line 283

def generate
  @generate
end

#id ⇒ Object

The ID of the report definition (config). Use -1 to create a new definition.



274
275
276
 
# File 'lib/nexpose/report.rb', line 274

def id
  @id
end

#name ⇒ Object

The unique name assigned to the report definition.



276
277
278
 
# File 'lib/nexpose/report.rb', line 276

def name
  @name
end

#users ⇒ Object

Array of user IDs which have access to resulting reports.



281
282
283
 
# File 'lib/nexpose/report.rb', line 281

def users
  @users
end

Class Method Details

.build(connection, site_id, site_name, type, format, generate_now = false) ⇒ Object

Build and save a report configuration against the specified site using the supplied type and format.

Returns the new configuration.



313
314
315
316
317
318
319
320
 
# File 'lib/nexpose/report.rb', line 313

def self.build(connection, site_id, site_name, type, format, generate_now = false)
  name = %Q{#{site_name} #{type} report in #{format}}
  config = ReportConfig.new(name, type, format)
  config.generate = Generate.new(true, false)
  config.filters << Filter.new('site', site_id)
  config.save(connection, generate_now)
  config
end

.load(connection, report_config_id) ⇒ Object

Retrieve the configuration for an existing report definition.



303
304
305
 
# File 'lib/nexpose/report.rb', line 303

def self.load(connection, report_config_id)
  connection.get_report_config(report_config_id)
end

.parse(xml) ⇒ Object 



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/nexpose/report.rb', line 365

def self.parse(xml)
  xml.res.elements.each('//ReportConfig') do |cfg|
    config = ReportConfig.new(cfg.attributes['name'],
                              cfg.attributes['template-id'],
                              cfg.attributes['format'],
                              cfg.attributes['id'],
                              cfg.attributes['owner'],
                              cfg.attributes['timezone'])

    cfg.elements.each('//description') do |desc|
      config.description = desc.text
    end

    config.filters = Filter.parse(xml)

    cfg.elements.each('//user') do |user|
      config.users << user.attributes['id'].to_i
    end

    cfg.elements.each('//Baseline') do |baseline|
      config.baseline = baseline.attributes['compareTo']
    end

    config.generate = Generate.parse(cfg)
    config.delivery = Delivery.parse(cfg)
    config.db_export = DBExport.parse(cfg)

    return config
  end
  nil
end

Instance Method Details

#delete(connection) ⇒ Object

Delete this report definition from the Security Console. Deletion will also remove all reports previously generated from the configuration.



341
342
343
 
# File 'lib/nexpose/report.rb', line 341

def delete(connection)
  connection.delete_report_config(@id)
end

#save(connection, generate_now = false) ⇒ Object

Save the configuration of this report definition.



323
324
325
326
327
328
329
330
331
 
# File 'lib/nexpose/report.rb', line 323

def save(connection, generate_now = false)
  xml = %Q{<ReportSaveRequest session-id='#{connection.session_id}' generate-now='#{generate_now ? 1 : 0}'>}
  xml << to_xml
  xml << '</ReportSaveRequest>'
  response = connection.execute(xml)
  if response.success
    @id = response.attributes['reportcfg-id'].to_i
  end
end

#to_xml ⇒ Object 



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/nexpose/report.rb', line 345

def to_xml
  xml = %Q{<ReportConfig format='#{@format}' id='#{@id}' name='#{@name}' owner='#{@owner}' template-id='#{@template_id}' timezone='#{@time_zone}'>}
  xml << %Q{<description>#{@description}</description>} if @description

  xml << '<Filters>'
  @filters.each { |filter| xml << filter.to_xml }
  xml << '</Filters>'

  xml << '<Users>'
  @users.each { |user| xml << %Q{<user id='#{user}' />} }
  xml << '</Users>'

  xml << %Q{<Baseline compareTo='#{@baseline}' />} if @baseline
  xml << @generate.to_xml if @generate
  xml << @delivery.to_xml if @delivery
  xml << @db_export.to_xml if @db_export

  xml << '</ReportConfig>'
end