wingate_w3c = {

  plugin_version = "1.2"

  info.1.manfacturer = "QBIK"
  info.1.device = "WinGate"
  info.1.version.1 = ""

  # 2012-09-17 - 1.0 - GMF - Initial implementation.
  # 2012-09-17 - 1.1 - GMF - Added simplification filters, and top_level_domains snapon
  # 2013-03-22 - 1.2 - GMF - Added gateway_reports (and fixed a broken partial implementation of gateway_reports which somehow made it in here without being versioned).
  # 2013-05-30 - 1.3 - gas - added requires_fields to file_type filter, and moved W3C detection into the plug-in to cope with a DateTime field
  # 2014-02-26 - 1.4 - GMF - Switched to log.filter_preprocessor to handle header, since it starts with space-tab and cannot be handled by the standard W3C parser.

  # The name of the log format
  log.format.format_label = "QBIK WinGate (W3C)"
  log.miscellaneous.log_data_type = "generic_csv"  
  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 = `#Software: WinGate`

  log.format.field_separator = "	"

  # This handles #Fields lines, and creates log and database fields from them
  log.filter_preprocessor = `
# if (matches_regular_expression(current_log_line(), '^#Fields: +([^ ].*)$')) then (
# 2013-02-26 - added support for a tab after #Fields in the header.
if (matches_regular_expression(current_log_line(), '^#Fields: 	(.*)$')) then (
  string fields = $1;
  string fieldname;
  v.logfieldindex = 1;
  string numerical_fields = "profiles." . internal.profile_name . ".database.numerical_fields";

  # This subroutine creates a database field
  subroutine(create_database_field(string fieldname, int top, int bottom), (
    #echo("create_database_field: " . fieldname); # debug
    debug_message("create_database_field(" . fieldname . ")\n");
    string databasefieldpath = "profiles." . internal.profile_name . ".database.fields." . fieldname;
    (databasefieldpath . "") = "";
    node databasefield = databasefieldpath;
    if (top ne 0) then
      set_subnode_value(databasefield, "suppress_top", top);
    if (bottom ne 0) then
      set_subnode_value(databasefield, "suppress_bottom", bottom);
    databasefield;
  ));

  subroutine(create_log_field(string fieldname, string type, bool withindex), (
    debug_message("create_log_field(" . fieldname . "; type=" . type . ")\n");
    string logfieldpath = "profiles." . internal.profile_name . ".log.fields." . fieldname;
    (logfieldpath . "") = "";
    node logfield = logfieldpath;
    if (withindex) then (
      set_subnode_value(logfield, "index", v.logfieldindex);
      v.logfieldindex++;
    );
    set_subnode_value(logfield, "subindex", 0);
    if (type ne '') then
      set_subnode_value(logfield, "type", type);
    logfield;
  ));

  # Assume there isn't a localtime field until we see one.
  v.parse_localtime = false;

  # Extract the fields on at a time
  while (matches_regular_expression(fields, '^([^ 	]+)[ 	](.*)$') or matches_regular_expression(fields, '^([^ 	]+)$')) (

    string unconverted_fieldname = $1;
    fields = $2;

    # Clean up the field name
    fieldname = '';
    for (int i = 0; i < length(unconverted_fieldname); i++) (
      string c = lowercase(substr(unconverted_fieldname, i, 1));
      if (!matches_regular_expression(c, '^[a-z0-9]$')) then
        c = '_';
      fieldname .= c;
    );
    while (matches_regular_expression(fieldname, '^(.*)_$'))
      fieldname = $1;

    # Get the log field type
    string log_field_type = '';
    if (fieldname eq 'cs_referrer') then (
      fieldname = 'cs_referer';
    );
    if (fieldname eq 'cs_uri') then (
      fieldname = 'cs_uri_stem';
    );
    if (fieldname eq 'cs_referer') then (
      log_field_type = 'url';
    );
    else if (fieldname eq 'cs_uri_stem') then (
      log_field_type = 'page';
    );
    else if (fieldname eq 'cs_user_agent') then (
      log_field_type = 'agent';
    );
    else if (fieldname eq 'c_ip') then (
      log_field_type = 'host';
    );

    # Create the log field
    create_log_field(fieldname, log_field_type, true);

    if (fieldname eq "localtime") then
      v.parse_localtime = true;

    # If we're creating a profile, create the database fields too.
    if (node_exists("volatile.creating_profile")) then (

      # Handle localtime by creating date_time and derived database fields
      if (fieldname eq "datetime") then (
        create_log_field('date', '', false);
        create_log_field('time', '', false);
        create_database_field('date_time', 0,  0);
        create_database_field('day_of_week', 0,  0);
        create_database_field('hour_of_day', 0,  0);
      ); # if localtime

      # Don't add a database field for numerical fields
      else if (subnode_exists(numerical_fields, fieldname)) then (
        debug_message("Not adding numerical field: " . fieldname . "\n");
      );

      # Create a normal database field
      else
        create_database_field(fieldname, 0,  0);

    ); # if creating profile

  ); # while another field

  # Don't parse the #Fields line as a data line
  'reject';

); # if #Fields

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

  # Extract date and time from localtime
  log.parsing_filters.parse_datetime = {
#    disabled = true
    value = `
#    echo("v.parse_datetime=" . " " . v.parse_datetime);
#if (v.parse_datetime) then (
  if (matches_regular_expression(datetime, '^([0-9]{2}/[0-9]{2}/[0-9]{4}) ([0-9]+:[0-9]+:[0-9]+)')) then (
    date = $1;
    time = $2;
  );
  else if (matches_regular_expression(datetime, '^([0-9]{2})[.]([0-9]{2})[.]([0-9]{4}) ([0-9]+:[0-9]+:[0-9]+)')) then (
    date = $3 . '/' . $2 . '/' . $1;
    time = $4;
  );

#);
`
      requires_fields = {
        datetime = true
      }
}


  # Get search engine and search phrase information from the referrer field (before it gets simplified).
  log.parsing_filters.compute_se_sp = {
    value = `if (get_search_engine_info(cs_referer)) then (
  search_engine = volatile.search_engine;
  search_phrase = volatile.search_phrase;
);
`
    requires_fields = {
      cs_referer = true
    }
  }

  # Get web browser, operating system, web browser, and spider information from the user-agent field.
  log.parsing_filters.derive_from_user_agent = {
    value = `get_user_agent_info(replace_all(c_agent, '+', ' '));
web_browser = volatile.web_browser;
operating_system = volatile.operating_system;
spider = volatile.spider;
`
    requires_fields = {
      c_agent = true
    }
  }

  # Log Filters
  log.filters = {

    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 = {
        file_type = true
      }
    } # detect_page_views

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

    remove_query = {
      label = "$lang_admin.log_filters.remove_query_label"
      comment = "$lang_admin.log_filters.remove_query_comment"
      value = "cs_uri_query = '[omitted]';"
      requires_fields = {
        cs_uri_query = true
      }
    } # remove_query

    simplify_referrer = {
      label = "$lang_admin.log_filters.simplify_referrer_label"
      comment = "$lang_admin.log_filters.simplify_referrer_comment"
      value = "if (referrer eq '-') then referrer = '(no referrer)' else if (matches_regular_expression(referrer, '^([^:]+://[^/]+/)')) then referrer = $1 . '(omitted)'"
      requires_fields = {
        referrer = true
      }
    } # simplify_referrer

    remove_session_id = {
      label = "$lang_admin.log_filters.suppress_field_value_label"
      comment = "$lang_admin.log_filters.suppress_field_value_comment"
      value = "session_id = '[omitted]';"
      requires_fields = {
        session_id = true
      }
    } # remove_session_id

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

  } # log.filters

  database.numerical_fields = {

    accesses = {
      requires_log_field = false
      default = true
      entries_field = true
    } # accesses

    page_views = {
      requires_log_field = false
    } # page_views

    sc_bytes = {
      integer_bits = 64
      display_format_type = "bandwidth"
    }

    cs_bytes = {
      integer_bits = 64
      display_format_type = "bandwidth"
    }

    unique_client_ips = {
      log_field = "c_ip"
      type = "unique"
    } # unique_client_ips

    time_taken = {
      label = $lang_stats.field_labels.time_taken
      integer_bits = 64
      display_format_type = duration_milliseconds
    } # time_taken

  } # database.numerical_fields

  create_profile_wizard_options = {

    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
      content_group = {
        cs_uri = true
        file_type = true
        cs_uri_query = true
      } # content_group
      client_group = {
        cs_username = true
        c_ip = true
        location = true
        domain_description = true
        organization = true
        domain = true
        isp = true
      } # client_group
      server_group = {
        s_ip = true
      } # s_ip
      referrer_group = {
        referrer = true
        search_engine = true
        search_phrase = true
        referrer_description = true
      } # referrer_group
      user_systems_group = {
        web_browser = true
        operating_system = true
        screen_dimensions = true
        screen_depth = true
      } # user_systems_group
      other_group = {
        session_id = true
        cs_method = true
        spider = true
        worm = true
        sc_status = true
        cs_protocol = true
      } # other_group
    } # report_groups

    snapons = {
  
      # Attach a top_level_domain snapon
      top_level_domain = {
				snapon = "top_level_domain"
				name = "top_level_domain"
				label = "$lang_admin.snapons.top_level_domain.label"
        parameters = {
          url_field.parameter_value = "cs_uri"
          field_name = {
            parameter_value = "$lang_admin.field_labels.top_level_domain"
            final_node_name = "top_level_domain"
          }
        } # parameters
  	    requires_database_fields = {
	   	     cs_uri = true
	      }
      } # top_level_domain

      # Attach a gateway_reports snapon
      gateway_reports = {
				snapon = "gateway_reports"
				name = "gateway_reports"
				label = "$lang_admin.snapons.gateway_reports.label"
        parameters = {
          user_field.parameter_value = "cs_username"
          have_client_ip.parameter_value = true
          client_ip_field.parameter_value = "c_ip"
          have_category_field.parameter_value = false
#          category_field.parameter_value = "category"
          host_field.parameter_value = "top_level_domain"
#          have_additional_field.parameter_value = true
#          additional_field.parameter_value = "virtual_ip"
          page_views_field.parameter_value = "page_views"
          have_bytes_in_field.parameter_value = true
          bytes_in_field.parameter_value = "sc_bytes"
          have_bytes_out_field.parameter_value = true
          bytes_out_field.parameter_value = "cs_bytes"
          have_duration_field.parameter_value = false
#          duration_field.parameter_value = "tunnel_duration"
          sort_by_field.parameter_value = "sc_bytes"
        } # parameters
      } # gateway_reports

# 2013-02-06 - GMF - Now added in gateway_reports
#      # Add the standard reports
#      add_standard_reports = {
#        name = "add_standard_reports"
#	label = "add_standard_reports"
#	snapon = "add_standard_reports"
#      } # add_standard_reports

    } # snapons

  } # create_profile_wizard_options

} # wingate_w3c