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

  plugin_version = "1.0.1"

  # Initial creation - 1.0
  # 2010-10-11 - 1.0.1 - MSG - Edited info lines.

  info.1.manufacturer = "Apache"
  info.1.device = "NCSA Combined (NetTracker)"
  info.1.version.1 = ""

  # Apache/NCSA Combined Format (NetTracker)

  # The name of the log format
  log.format.format_label = "Apache/NCSA Combined Format (NetTracker)"
  log.miscellaneous.log_data_type = "http_access"
  log.miscellaneous.log_format_type = "web_server"

  # The log is in this format if any of the first ten lines match this regular expression
  log.format.autodetect_regular_expression = "^[^ ]* [^ ]* .* \\[../.../....:..:..:...*\\] \"[A-Z]* [^ ]*(\"| HTTP.*\") [0-9]* [-0-9]* [^ ]* \".*\" \"[^\"]*\" \"[0-9]+\\.[0-9]+\\.[0-9]+\\.[0-9]+-[0-9]+\" [0-9]+ [0-9]+"

  # Treat fields surrounded by square brackets (e.g. the date/time field) as a single quoted field.
  log.format.treat_brackets_as_quotes = "true"
  log.format.common_log_format = "true"
  log.format.ignore_format_lines = "true"

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

  # Log fields
  log.fields = {

    hostname = {
      type = "host"
      index = 1
    } # hostname

    server_domain.index = 2
    authenticated_user.index = 3

    date_time = {
      type = "date_time"
      index = 4
      subindex = 1
    } # date_time

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

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

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

    server_response = {
      type = "response"
      index = 6
    } # server_response

    size.index = 7

    referrer = {
      type = "URL"
      index = 8
      hierarchy_dividers = "/?"
      left_to_right = true
      leading_divider = "false"
    } # referrer

    agent = {
      type = "agent"
      index = 9
    } # agent

    cookies.index = 10

    visitor_id.index = 11
    
    sane_value.index = 12

    time_taken.index = 13

  } # log.fields


  # Database fields
  database.fields = {

    date_time = ""
    day_of_week = ""
    hour_of_day = ""
    page = ""
    file_type = ""
    worm = ""
    screen_dimensions = ""
    screen_depth = ""
    hostname = ""
    domain_description = ""
    location = ""
    referrer = ""
    referrer_description = ""
    search_engine = ""
    search_phrase = ""
    web_browser = ""
    operating_system = ""
    spider = ""
    authenticated_user = ""
    server_response = ""
    visitor_id = ""

  } # database.fields


  # Log Filters
  log.filters = {

    no_referrer = {
      label = "$lang_admin.log_filters.no_referrer_label"
      comment = "$lang_admin.log_filters.no_referrer_comment"
      value = "if (referrer eq '-') then referrer = '(no referrer)';"
    } # no_referrer

    internal_referrer = {
      label = "$lang_admin.log_filters.internal_referrer_label"
      comment = "$lang_admin.log_filters.internal_referrer_comment"
      value = "if (contains(referrer, 'mydomain.com/')) then referrer = '(internal referrer)';"
      disabled = true
    } # internal_referrer

    not_authenticated = {
      label = "$lang_admin.log_filters.not_authenticated_label"
      comment = "$lang_admin.log_filters.not_authenticated_comment"
      value = "if (authenticated_user eq '-') then authenticated_user = '(not authenticated)';"
    } # not_authenticated

    set_page_for_worm = {
      label = "$lang_admin.log_filters.set_page_for_worm_label"
      comment = "$lang_admin.log_filters.set_page_for_worm_comment"
      value = "if (starts_with(worm, '(')) then '' else page = '(worm)';"
    } # set_page_for_worm

    remove_query = {
      label = "$lang_admin.log_filters.remove_query_label"
      comment = "$lang_admin.log_filters.remove_query_comment"
      value = "if (contains(page, '?')) then page = substr(page, 0, index(page, '?') + 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

    screen_info_not_page_view = {
      label = '$lang_admin.log_filters.screen_info_not_page_view_label'
      comment = '$lang_admin.log_filters.screen_info_not_page_view_comment'
      value = "if (starts_with(page, '(')) then page_views = 0"
    } # screen_info_not_page_view

    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 page = substr(page, 0, last_index(page, '/') + 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 = "page"
    sessions_visitor_id_field = "visitor_id"
    sessions_event_field = "page_views"

  } # log.field_options


  database.numerical_fields = {

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

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

    visitors = {
      label = "$lang_stats.field_labels.visitors"
      default = false
      requires_log_field = true
      log_field = "visitor_id"
      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

    time_taken = {
      label = "$lang_stats.field_labels.time_taken"
      default = false
      requires_log_field = true
      type = "int"
      integer_bits = 64
      display_format_type = "duration_compact"
    } # time_taken

    average_time_taken = {
      label = "$lang_stats.field_labels.average $lang_stats.field_labels.time_taken"
      default = false
      log_field = "time_taken"
      requires_log_field = false
      type = "int"
      integer_bits = 64
      aggregation_method = "average"
      average_denominator_field = "hits"
      display_format_type = "duration_compact"
    } # average_time_taken

  } # 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 = ""
      content_group = {
        page = true
        file_type = true
      }
      visitor_demographics_group = {
        hostname = true
        domain_description = true
        location = true
        authenticated_user = true
      }
      visitor_systems_group = {
        screen_dimensions = true
        screen_depth = true
        web_browser = true
        operating_system = true
      }
      referrer_group = {
        referrer = true
        referrer_description = true
        search_engine = true
        search_phrase = true
        search_phrases_by_search_engine = true
      }
      other_group = {
        worm = true
        spider = true
        server_domain = true
        server_response = true
      }
    } # report_groups

  } # create_profile_wizard_options

} # apache_combined_nettracker