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

  plugin_version = "1.0"

  info.1.manufacturer = "Clearswift"
  info.1.device = "MIMEsweeper"
  info.1.version.1 = ""

  # 2009-07-02 - 1.0 - GMF - initial creation

  # The name of the log format
  log.format.format_label = "MIMEsweeper Log Format"
  log.miscellaneous.log_data_type = "firewall"
  log.miscellaneous.log_format_type = "proxy_server"

  # The log is in this format if any of the first ten lines match this regular expression
  # 2009-04-22 15:00:09	403	480	292	12.34.56.78	-	98.76.54.32	"Computing and Internet"	"some\user"	http://somesite.com/file.html
  log.format.autodetect_regular_expression = `^[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]+	[0-9]+	[0-9]+	[0-9.]+	[^	]+	[0-9.]+	"[^"]+"	"[^"]+"	(.*)$`

  log.format.parsing_regular_expression = `^([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]+)	([0-9]+)	([0-9]+)	([0-9.]+)	([^	]+)	([0-9.]+)	"([^"]+)"	"([^"]+)"	(.*)$`

  # Log fields
  log.fields = {

    date = ""
    time = ""
    sc_status = ""
    x_req_size = ""
    bytes = ""
    c_ip.type = "host"
    c_dns = ""
    s_ip = ""
    x_category = ""
    x_user = ""
    cs_uri = {
      type = "page"
      hierarchy_dividers = "/?"
      left_to_right = true
      leading_divider = "true"
    }
    events = ""
    page_views = ""

  } # log.fields


  # Database fields
  database.fields = {

    date_time = ""
    day_of_week = ""
    hour_of_day = ""
    sc_status = ""
    c_ip = ""
    location = ""
    c_dns = ""
    s_ip = ""
    x_category = ""
    x_user = ""
    cs_uri = ""
    file_type = ""

  } # database.fields


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

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

    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 = "c_ip"
    sessions_event_field = "page_views"

  } # log.field_options


  database.numerical_fields = {

    events = {
      default = true
      entries_field = true
    } # events

    page_views = {
      default = true
    } # page_views

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

    bytes = {
      default = true
      type = "int"
      integer_bits = 64
      display_format_type = "bandwidth"
    } # bytes

    x_req_size = {
      default = true
      type = "int"
      integer_bits = 64
      display_format_type = "bandwidth"
    } # x_req_size

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

} # mime_sweeper