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

  plugin_version = "1.1"

  info.1.manfacturer = "Fortech, Ltd"
  info.1.device = "Proxy Plus"
  info.1.version = "3.0"

  #            - 1.0 -     - Initial creation
  # 2008-04-15 - 1.1 - KBB - Added field "user" for Index 4, which was previously being ignored, and
  # corresponding numeric field "unique_users". The basis for this modified plug-in was suppied by
  # Sawmill user Carlos Díaz Caballero

  # The name of the log format
  log.format.format_label = "ProxyPlus 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
  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] [^ ]* [^ ]* [A-Z]* "[A-Z]* [^ ]* [A-Z0-9/.]*" [0-9]* [0-9]* [0-9]* [0-9]* [0-9]* [A-Z]* [^ ]* [^ ]*$'

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

  # Log fields
  log.fields = {

    date = {
      index = 1
      subindex = 0
    } # date

    time = {
      index = 2
      subindex = 0
    } # time

    browsing_host = {
      type = "host"
      index = 3
      subindex = 0
      hierarchy_dividers = "."
      left_to_right = false
      leading_divider = "false"
    } # browsing_host

    user = {
      index = 4
      subindex = 0
    } # user

    operation = {
      index = 6
      subindex = 1
    } # operation

    url = {
      type = "page"
      index = 6
      subindex = 2
      hierarchy_dividers = "/?"
      left_to_right = true
      leading_divider = "true"
    } # url

    protocol = {
      index = 6
      subindex = 3
    } # protocol

    server_response = {
      index = 7
      subindex = 0
    } # server_response

    size = {
      type = "size"
      index = 11
      subindex = 0
    } # size

    type = {
      index = 12
      subindex = 0
    } # type

  } # log.fields

  # Database fields
  database.fields = {

    date_time = ""
    day_of_week = ""
    hour_of_day = ""
    browsing_host = ""
    user = ""
    url = ""
    file_type = ""
    worm = ""
    server_response = ""
    protocol = ""
    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(url, '?')) then url = substr(url, 0, index(url, '?') + 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(url, '^([^:]+://[^/]+/)')) then url = $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 url = substr(url, 0, last_index(url, '/') + 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 = 'hits = 1;'
    } # mark_entry

  } # log.filters

  log.field_options = {

    sessions_page_field = "url"
    sessions_visitor_id_field = "browsing_host"
    sessions_event_field = "page_views"

  } # log.field_options

  database.numerical_fields = {

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

    page_views = {
      default = true
      requires_log_field = false
      type = "int"
    } # page_views

    visitors = {
      log_field = "browsing_host"
      type = "unique"
    } # visitors

    unique_users = {
      log_field = "user"
      type = "unique"
    } # unique_users

    size = {
      type = "float"
      display_format_type = "bandwidth"
    } # size

  } # database.numerical_fields

  create_profile_wizard_options = {

    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
      browsing_host = true
	  user = true
      url = true
      file_type = true
      worm = true
      server_response = true
      protocol = true
      type = true
    } # report_groups

  } # create_profile_wizard_options

} # proxy_plus