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

  plugin_version = "1.0.1"

  # Initial creation - 1.0
  # 2010-10-14 - 1.0.1 - MSG - Edited info lines.
  ## 03/11/2010 16:42:32 - gas - 1.0.2 - added support for sessions

  info.1.manufacturer = "Bluecoat"
  info.1.device = "Squid Log Format"
  info.1.version.1 = ""

  # The name of the log format
  log.format.format_label = "Blue Coat Squid 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.]* [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"

  statistics.miscellaneous.entry_name = "requests"

  # Log fields
  log.fields = {

  # NOTE: Blue Coat Squid format doesn't quite match the standard Squid format.
  # Here's how the fields are defined in Blue Coat logs (p497 of SGOS3 PDF):
  # timestamp elapsed host action/status size method uri user hierarchy/server content

    date_time = {
      label = "date/time"
      type = "date_time"
      index = 0
      subindex = 0
      dividers = ""
      left_to_right = false
      leading_divider = "false"
    } # date_time

    source_ip = {
      label = "source IP"
      type = "host"
      index = 0
      subindex = 0
      dividers = ""
      left_to_right = false
      leading_divider = "false"
      is_sessions_visitor_id = true
    } # source_ip

    action = {
      label = "action"
      type = "flat"
      index = 0
      subindex = 0
    } # action

    server_response = {
      label = "server response"
      type = "response"
      index = 0
      subindex = 0
      dividers = ""
      left_to_right = false
      leading_divider = "false"
    } # server_response

    size = {
      label = "size"
      type = "size"
      index = 0
      subindex = 0
      dividers = ""
      left_to_right = false
      leading_divider = "false"
    } # size

    operation = {
      label = "operation"
      type = "flat"
      index = 0
      subindex = 0
    } # operation

    url = {
      label = "URL"
      type = "page"
      index = 0
      subindex = 0
      dividers = ""
      left_to_right = false
      leading_divider = "false"
      is_sessions_page = true
    } # url

    authenticated_user = {
      label = "authenticated user"
      type = "flat"
      index = 0
      subindex = 0
    } # authenticated_user

    hierarchy = {
      label = "hierarchy"
      type = "flat"
      index = 0
      subindex = 0
    } # hierarchy

    server = {
      label = "server"
      type = "flat"
      index = 0
      subindex = 0
    } # server

    mime_type = {
      label = "MIME type"
      type = "flat"
      index = 0
      subindex = 0
    } # mime_type

  } # log.fields

  # Database fields
  database.fields = {

    date_time = {
      label = "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 = "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 = "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 = "source IP"
      log_field = "source_ip"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # source_ip

    url = {
      label = "URL"
      log_field = "url"
      type = "string"
      suppress_top = 1
      suppress_bottom = 2
    } # url

    file_type = {
      label = "file type"
      log_field = "file_type"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # file_type

    worm = {
      label = "worm"
      log_field = "worm"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # worm

    server_response = {
      label = "server response"
      log_field = "server_response"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # server_response

    action = {
      label = "action"
      log_field = "action"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # action

    operation = {
      label = "operation"
      log_field = "operation"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # operation

    hierarchy = {
      label = "hierarchy"
      log_field = "hierarchy"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # hierarchy

    server = {
      label = "server"
      log_field = "server"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # server

    authenticated_user = {
      label = "authenticated user"
      log_field = "authenticated_user"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # authenticated_user

    mime_type = {
      label = "MIME type"
      log_field = "mime_type"
      type = "string"
      suppress_top = 0
      suppress_bottom = 2
    } # mime_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 (matches_regular_expression(url, '^(.*\\?).*\$')) then 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 = 'requests = 1;'
    } # mark_entry

  } # log.filters

  database.numerical_fields = {

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

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

    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 = "size"
      default = false
      requires_log_field = true
      log_field = "size"
      type = "float"
      display_format_type = "bandwidth"
    } # size

  } # database.numerical_fields

  log.field_options = {

    sessions_page_field = "url"
    sessions_visitor_id_field = "source_ip"
    sessions_event_field = "page_views"

  } # log.field_options

  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

} # blue_coat_squid