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

  plugin_version = "1.0.1"

  # Initial creation - 1.0
  # 2011-07-20 - 1.0.1 - MSG - Edited info lines.

  info.1.manufacturer = "GNU"
  info.1.device = "Squid Event"
  info.1.version.1 = ""

  # Squid Event Log

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

  # This regular expression is used to parse the log fields out of the log entry
  log.format.parsing_regular_expression = "^([0-9.]*) ([0-9]*) ([0-9.]*) ([A-Z_]*)/([0-9]*) ([0-9]*) ([A-Z]*) ([^ ]*) ([^ ]*) ([A-Z_]*)/([^ ]*) ([^ ]*)$"

  # The format of dates and times in this log
  log.format.date_format = "seconds_since_jan1_1970"
  log.format.time_format = "seconds_since_jan1_1970"

  # Log fields
  log.fields = {

    date_time = {
      label = "$lang_stats.field_labels.date_time"
      type = "date_time"
      index = 0
      subindex = 0
      hierarchy_dividers = ""
      left_to_right = false
      leading_divider = "false"
    } # date_time

    duration = {
      label = "$lang_stats.field_labels.duration"
      type = "flat"
      index = 0
      subindex = 0
    } # duration

    source_ip = {
      label = "$lang_stats.field_labels.source_ip"
      type = "host"
      index = 0
      subindex = 0
      hierarchy_dividers = "."
      left_to_right = false
      leading_divider = "false"
    } # source_ip

    cache_result = {
      label = "$lang_stats.field_labels.cache_result"
      type = "flat"
      index = 0
      subindex = 0
    } # cache_result

    server_response = {
      label = "$lang_stats.field_labels.server_response"
      type = "response"
      index = 0
      subindex = 0
      hierarchy_dividers = ""
      left_to_right = false
      leading_divider = "false"
    } # server_response

    size = {
      label = "$lang_stats.field_labels.size"
      type = "size"
      index = 0
      subindex = 0
      hierarchy_dividers = ""
      left_to_right = false
      leading_divider = "false"
    } # size

    request_method = {
      label = "$lang_stats.field_labels.request_method"
      type = "flat"
      index = 0
      subindex = 0
    } # request_method

    url = {
      label = "$lang_stats.field_labels.url"
      type = "page"
      index = 0
      subindex = 0
      hierarchy_dividers = ""
      left_to_right = false
      leading_divider = "false"
    } # url

    authenticaled_user = {
      label = "$lang_stats.field_labels.authenticaled_user"
      type = "flat"
      index = 0
      subindex = 0
    } # authenticaled_user

    proxy_route = {
      label = "$lang_stats.field_labels.proxy_route"
      type = "flat"
      index = 0
      subindex = 0
    } # proxy_route

    proxy_server = {
      label = "$lang_stats.field_labels.proxy_server"
      type = "flat"
      index = 0
      subindex = 0
    } # proxy_server

    response_type = {
      label = "$lang_stats.field_labels.response_type"
      type = "flat"
      index = 0
      subindex = 0
    } # response_type

  } # log.fields


  # Database fields
  database.fields = {

    date_time = {
      label = "$lang_stats.field_labels.date_time"
      log_field = "date_time"
      type = "string"
      suppress_top = 0
      suppress_bottom = 3
      display_format_type = "date_time"
    } # date_time

    day_of_week = {
      label = "$lang_stats.field_labels.day_of_week"
      log_field = "day_of_week"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
      display_format_type = "day_of_week"
    } # day_of_week

    hour_of_day = {
      label = "$lang_stats.field_labels.hour_of_day"
      log_field = "hour_of_day"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
      display_format_type = "hour_of_day"
    } # hour_of_day

    source_ip = {
      label = "$lang_stats.field_labels.source_ip"
      log_field = "source_ip"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # source_ip

    cache_result = {
      label = "$lang_stats.field_labels.cache_result"
      log_field = "cache_result"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # cache_result

    url = {
      label = "$lang_stats.field_labels.url"
      log_field = "url"
      type = "string"
      suppress_top = 1
      suppress_bottom = 3
    } # url

    file_type = {
      label = "$lang_stats.field_labels.file_type"
      log_field = "file_type"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # file_type

    worm = {
      label = "$lang_stats.field_labels.worm"
      log_field = "worm"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # worm

    proxy_route = {
      label = "$lang_stats.field_labels.proxy_route"
      log_field = "proxy_route"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # proxy_route

    proxy_server = {
      label = "$lang_stats.field_labels.proxy_server"
      log_field = "proxy_server"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # proxy_server

    response_type = {
      label = "$lang_stats.field_labels.response_type"
      log_field = "response_type"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # response_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 = "source_ip"
    sessions_event_field = "page_views"

  } # log.field_options


  database.numerical_fields = {

    hits = {
      label = "$lang_stats.field_labels.hits"
      default = true
      requires_log_field = false
      type = "int"
      display_format_type = "integer"
      entries_field = true
    } # hits

    visitors = {
      label = "$lang_stats.field_labels.visitors"
      default = false
      requires_log_field = true
      log_field = "source_ip"
      type = "unique"
      display_format_type = "integer"
    } # visitors

    size = {
      label = "$lang_stats.field_labels.size"
      default = false
      requires_log_field = true
      log_field = "size"
      type = "int"
      integer_bits = 64
      display_format_type = "bandwidth"
    } # size

  } # database.numerical_fields


  create_profile_wizard_options = {
    date_time_tracking = true
    host_tracking = true

    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
      source_ip = true
      cache_result = true
      url = true
      file_type = true
      worm = true
      proxy_route = true
      proxy_server = true
      response_type = true
    } # report_groups

  } # create_profile_wizard_options

  not_supported = {
    sessions = true
    pageviews = true
  } # not_supported

} # squid_event