wingate_w3c = {

  plugin_version = "1.1"

  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

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

  # 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;"
    } # 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 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

      # 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
      } # top_level_domain

      # 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