# Copyright (c) 2010 Flowerfire, Inc.  All Rights Reserved.
gta_gbware = {

## plug-in version and changelog
  plugin_version = "1.0.2"

  # DATE HERE : ... : ... : initial creation
  # 2009-12-17 - 1.0.1 gas : added cat_site field
  # 2010-12-14 - 1.0.2 - MSG - Edited info lines.

## vendor info
  info.1.manufacturer = "GTA"
  info.1.device = "Gnatbox GB-Ware"
  info.1.version.1 = ""


  # The name of the log format
  log.format.format_label = "GTA GBWare Log Format"
  log.miscellaneous.log_data_type = "syslog_required"  
  log.miscellaneous.log_format_type = "firewall"

  # The log is in this format if any of the first ten lines match this regular expression
  log.format.autodetect_regular_expression = "time=\"[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9] [0-9][0-9]:[0-9][0-9]:[0-9][0-9]\" fw=\"[0-9]+\" pri=[0-9]+"

  # All log field parsing will be done using the parsing filters
  log.format.parse_only_with_filters = "true"

  # Log fields
  log.fields = {

    fw = {
      label = "$lang_stats.field_labels.fw"
      type = "flat"
      index = 0
      subindex = 0
    } # fw

    pri = {
      label = "$lang_stats.field_labels.pri"
      type = "flat"
      index = 0
      subindex = 0
    } # pri

    msg = {
      label = "$lang_stats.field_labels.msg"
      type = "flat"
      index = 0
      subindex = 0
    } # msg

    arg = {
      label = "$lang_stats.field_labels.arg"
      type = "flat"
      index = 0
      subindex = 0
    } # arg

    cat_action = {
      label = "$lang_stats.field_labels.cat_action"
      type = "flat"
      index = 0
      subindex = 0
    } # cat_action

    cat_site = {
      label = "$lang_stats.field_labels.cat_site"
      type = "flat"
      index = 0
      subindex = 0
    } # cat_site

    proto = {
      label = "$lang_stats.field_labels.proto"
      type = "flat"
      index = 0
      subindex = 0
    } # proto

    op = {
      label = "$lang_stats.field_labels.op"
      type = "flat"
      index = 0
      subindex = 0
    } # op

    src = {
      label = "$lang_stats.field_labels.src"
      type = "host"
      index = 0
      subindex = 0
      hierarchy_dividers = "."
      left_to_right = false
      leading_divider = "false"
    } # src

    srcport = {
      label = "$lang_stats.field_labels.src_port"
      type = "flat"
      index = 0
      subindex = 0
    } # srcport

    dst = {
      label = "$lang_stats.field_labels.dst"
      type = "flat"
      index = 0
      subindex = 0
    } # dst

    dstport = {
      label = "$lang_stats.field_labels.dst_port"
      type = "flat"
      index = 0
      subindex = 0
    } # dstport

    rule = {
      label = "$lang_stats.field_labels.rule"
      type = "flat"
      index = 0
      subindex = 0
    } # rule

    url = {
      label = "$lang_stats.field_labels.url"
      type = "page"
      index = 5
      subindex = 2
      hierarchy_dividers = "/?"
      left_to_right = true
      leading_divider = "true"
    } # url

    duration = {
      label = "$lang_stats.field_labels.duration"
      type = "flat"
      index = 0
      subindex = 0
    } # duration

    sent = {
      label = "$lang_stats.field_labels.sent"
      type = "flat"
      index = 0
      subindex = 0
    } # sent

    rcvd = {
      label = "$lang_stats.field_labels.rcvd"
      type = "flat"
      index = 0
      subindex = 0
    } # rcvd

    pkts_sent = {
      label = "$lang_stats.field_labels.pkts_sent"
      type = "flat"
      index = 0
      subindex = 0
    } # pkts_sent

    pkts_rcvd = {
      label = "$lang_stats.field_labels.pkts_rcvd"
      type = "flat"
      index = 0
      subindex = 0
    } # pkts_rcvd

  } # log.fields


  #          
  # Log Parsing Filters
  log.parsing_filters = {


    # Parse out the =seperated space divided fileds
    fields = {
      label = "parse fields"
      comment = ""
      value = "collect_listed_fields_using_regexp('()time=.[0-9-]+ [0-9:]*. (fw=.*)$', ' ', '=', '')"
    } # fields

    # Accept this log entry
    accept = {
      label = "accept all entries"
      comment = ""
      value = "accept_collected_entry_using_regexp('^()', false)"
    } # accept

  } # log.parsing_filters


  # Database fields
  database.fields = {

    date_time = {
      label = "$lang_stats.field_labels.date_time"
      log_field = "date_time"
      type = "string"
      suppress_top = 0
      suppress_bottom = 3
      display_format_type = "date_time"
    } # date_time

    day_of_week = {
      label = "$lang_stats.field_labels.day_of_week"
      log_field = "day_of_week"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
      display_format_type = "day_of_week"
    } # day_of_week

    hour_of_day = {
      label = "$lang_stats.field_labels.hour_of_day"
      log_field = "hour_of_day"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
      display_format_type = "hour_of_day"
    } # hour_of_day

    fw = {
      label = "$lang_stats.field_labels.fw"
      log_field = "fw"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # fw

    pri = {
      label = "$lang_stats.field_labels.pri"
      log_field = "pri"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # pri

    msg = {
      label = "$lang_stats.field_labels.msg"
      log_field = "msg"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # msg

    arg = {
      label = "$lang_stats.field_labels.arg"
      log_field = "arg"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # arg

    cat_action = {
      label = "$lang_stats.field_labels.cat_action"
      log_field = "cat_action"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # cat_action

    cat_site = {
      label = "$lang_stats.field_labels.cat_site"
      log_field = "cat_site"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # cat_site

    proto = {
      label = "$lang_stats.field_labels.proto"
      log_field = "proto"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # proto

    src = {
      label = "$lang_stats.field_labels.src"
      log_field = "src"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # src

    srcport = {
      label = "$lang_stats.field_labels.srcport"
      log_field = "srcport"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # srcport

    dst = {
      label = "$lang_stats.field_labels.dst"
      log_field = "dst"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # dst

    dstport = {
      label = "$lang_stats.field_labels.dstport"
      log_field = "dstport"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # dstport

    rule = {
      label = "$lang_stats.field_labels.rule"
      log_field = "rule"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # rule

    url = {
      label = "$lang_stats.field_labels.url"
      log_field = "url"
      type = "string"
      suppress_top = 1
      suppress_bottom = 3
    } # url

  } # database.fields


  # Log Filters
  log.filters = {

    build_url = {
      label = "Build URL"
      value = "if (starts_with(arg, '/')) then url = proto . '://' . dst . arg"
      comment = "Build the full URL"
    } # build_url

    simplify_url = {
      label = "$lang_admin.log_filters.simplify_url_label"
      comment = "$lang_admin.log_filters.simplify_url_comment"
      value = "if (matches_regular_expression(url, '^([^:]+://[^/]+/)')) then url = $1 . '(omitted)'"
    } # simplify_url

    mark_entry = {
      label = '$lang_admin.log_filters.mark_entry_label'
      comment = '$lang_admin.log_filters.mark_entry_comment'
      value = 'events = 1;'
    } # mark_entry

  } # log.filters

  database.numerical_fields = {

    events = {
      label = "$lang_stats.field_labels.events"
      default = true
      requires_log_field = false
      type = "int"
      display_format_type = "integer"
      entries_field = true
    } # events

    sent = {
      label = "$lang_stats.field_labels.sent"
      default = false
      requires_log_field = true
      log_field = "sent"
      type = "float"
      display_format_type = "bandwidth"
    } # sent

    pkts_sent = {
      label = "$lang_stats.field_labels.pkts_sent"
      default = false
      requires_log_field = true
      log_field = "pkts_sent"
      type = "int"
      display_format_type = "integer"
    } # pkts_sent

    rcvd = {
      label = "$lang_stats.field_labels.rcvd"
      default = false
      requires_log_field = true
      log_field = "sent"
      type = "float"
      display_format_type = "bandwidth"
    } # rcvd

    pkts_rcvd = {
      label = "$lang_stats.field_labels.pkts_rcvd"
      default = false
      requires_log_field = true
      log_field = "pkts_rcvd"
      type = "int"
      display_format_type = "integer"
    } # pkts_rcvd

    duration = {
      label = "$lang_stats.field_labels.duration"
      default = false
      requires_log_field = true
      type = "int"
      display_format_type = "duration_milliseconds"
    } # duration

  } # database.numerical_fields


  create_profile_wizard_options = {
    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
      source_group = {
        src = true
        srcport = true
      }
      destination_group = {
        dst = true
        dstport = true
      }
      content_group = {
        url = true
        op = true
        arg = true
        proto = true
      }
      other_group = {
        fw = true
        logging_device = true
        rule = true
        pri = true
        cat_action = true
        cat_site = true
        msg = true
      }
    } # report_groups

  } # create_profile_wizard_options

} # gta_gbware