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

  plugin_version = "1.1"

  info.1.manufacturer = "Novell"
  info.1.device = "Border Manager (W3C)"
  info.1.version.1 = "3.8"

  # 2006-09-19 - 1.0beta - GMF - initial creation
  # 2007-09-14 - 1.0 - KBB - renumbered per new beta policy
  # 2010-10-01 - 1.1 - MSG - Edited info lines.


  # The name of the log format
  log.format.format_label = "Novell Border Manager Log Format"
  log.miscellaneous.log_data_type = "firewall"
  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 = `^#Fields: cached [[]date-time[]]`

  # The format of dates and times in this log
  log.format.date_format = "dd/mmm/yyyy:hh:mm:ss"
  log.format.time_format = "dd/mmm/yyyy:hh:mm:ss"

  # This handles #Fields lines, and creates log and database fields from them
  log.filter_preprocessor = `

if (!node_exists('v.initialized')) then (

v.initialized = true;
include 'util.parse_w3c';

); # if not initialized

if (matches_regular_expression(current_log_line(), '^#Fields: (.*)$')) then (

  string fields = $1;

  # [date-time] is bracket date-time and timezone
  fields = replace_first(fields, '[date-time]', 'date_time timezone');

  # cs-uri is actually cs-uri followed by protocol
  fields = replace_first(fields, 'cs-uri', 'cs-uri protocol');

  parse_w3c_fields(fields);

); # if #Fields

# Don't parse any other # lines as data lines
else if (starts_with(current_log_line(), '#')) then (
  'reject';
);
`


  log.fields = {
    date = ""
    time = ""
  }

  # Log Filters
  log.filters = {

    remove_query = {
      label = "$lang_admin.log_filters.remove_query_label"
      comment = "$lang_admin.log_filters.remove_query_comment"
      value = "if (contains(cs_uri, '?')) then cs_uri = substr(cs_uri, 0, index(cs_uri, '?') + 1) . '(parameters)';"
      requires_fields = {
        cs_uri = true
      }
    } # remove_query

    detect_page_views = {
      label = '$lang_admin.log_filters.detect_page_views_label'
      comment = '$lang_admin.log_filters.detect_page_views_comment'
      value = "if ((file_type eq 'JPEG') or (file_type eq 'JPG') or (file_type eq 'GIF') or (file_type eq 'ICO') or (file_type eq 'PNG') or (file_type eq 'CSS') or (file_type eq 'SWF') or (file_type eq 'JS')) then page_views = 0; else page_views = 1;"
      requires_fields = {
        cs_uri = true
      }
    } # detect_page_views

    simplify_cs_uri = {
      label = "$lang_admin.log_filters.simplify_cs_uri_label"
      comment = "$lang_admin.log_filters.simplify_cs_uri_comment"
      value = "if (matches_regular_expression(cs_uri, '^([^:]+://[^/]+/)')) then cs_uri = $1 . '(omitted)'"
      requires_fields = {
        cs_uri = true
      }
    } # simplify_cs_uri

    strip_non_page_views = {
      label = '$lang_admin.log_filters.strip_non_page_views_label'
      comment = '$lang_admin.log_filters.strip_non_page_views_comment'
      value = "if (page_views == 0) then cs_uri = substr(cs_uri, 0, last_index(cs_uri, '/') + 1) . '(nonpage)';"
      requires_fields = {
        cs_uri = true
      }
    } # strip_non_page_views

    set_page_for_worm = {
      label = "$lang_admin.log_filters.set_page_for_worm_label"
      comment = "$lang_admin.log_filters.set_page_for_worm_comment"
      value = "if (starts_with(worm, '(')) then '' else cs_uri = '(worm)';"
      requires_fields = {
        worm = true
      }
    } # set_page_for_worm


    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

  log.field_options = {

    sessions_page_field = "cs_uri"
    sessions_visitor_id_field = "browsing_host"
    sessions_event_field = "page_views"

  } # log.field_options

#  log.parsing_filters.parse = `
#if (matches_regular_expression(date_time, '^[[]([^:]+):([^ ]+)$')) then (
#  date = $1;
#  time = $2;
#);
#`


  database.numerical_fields = {

    events = {
      requires_log_field = false
      entries_field = true
    } # events

    page_views = {
      default = true
      requires_log_field = false
    } # page_views

    unique_client_ips = {
      requires_log_field = true
      log_field = "client_ip"
      type = "unique"
    } # unique_client_ips

  } # database.numerical_fields


  create_profile_wizard_options = {

    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
    } # report_groups

  } # create_profile_wizard_options

} # border_manager