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

  plugin_version = "1.0.1"

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

  info.1.manufacturer = "CCMedia"
  info.1.device = "Webnibbler"
  info.1.version.1 = ""

  # The name of the log format
  log.format.format_label = "WebNibbler Log Format"
  log.miscellaneous.log_data_type = "http_access"  
  log.miscellaneous.log_format_type = "application"

  # The log is in this format if any of the first ten lines match this regular expression
  log.format.autodetect_regular_expression = "^HTTP_CC_GUID="

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

  # All log field parsing will be done using the parsing filters
  log.format.parse_only_with_filters = "true"

  # Log fields
  log.fields = {

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

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

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

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

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

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

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

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

    referrer = {
      label = "$lang_stats.field_labels.referrer"
      type = "URL"
      index = 0
      subindex = 0
      hierarchy_dividers = "/?"
      left_to_right = true
      leading_divider = "false"
    } # referrer

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

    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

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

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

  } # log.fields


  #          
  # Log Parsing Filters
  log.parsing_filters = {


    # Parse out the space-separated, =-divided variables
    1 = {
      label = "1"
      comment = ""
      value = "collect_listed_fields_using_regexp('^()(.*)$', ' ', '=', 'SERVER_HOST=server_host|SERVER_URL=page|REMOTE_ADDR=remote_address|REMOTE_USER=remote_user|USER_AGENT=user_agent|HTTP_URI=uri|HTTP_REFERER=referrer|HTTP_COOKIE=cookie|HTTP_METHOD=operation|HTTP_TIME=date_time|HTTP_QUERY=query')"
    } # 1


    # Accept the collected entry
    2 = {
      label = "2"
      comment = ""
      value = "

# Get web browser, operating system, web browser, and spider information from the user-agent field.
get_user_agent_info(get_collected_field('', 'agent')));
set_collected_field('', 'web_browser', volatile.web_browser);
set_collected_field('', 'operating_system', volatile.operating_system);
set_collected_field('', 'spider', volatile.spider);

accept_collected_entry_using_regexp('()', false);

"
    } # 2


  } # log.parsing_filters


  # 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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  } # database.fields


  # Get search engine and search phrase information from the referrer field (before it gets simplified).
  log.parsing_filters.compute_se_sp = `
if (get_search_engine_info(referrer)) then (
  search_engine = volatile.search_engine;
  search_phrase = volatile.search_phrase;
);
`


  # Log Filters
  log.filters = {

    # This filter uses the http_cc_guid as the visitor id
    simplify_referrer = {
      label = "$lang_admin.log_filters.simplify_referrer_label"
      comment = "$lang_admin.log_filters.simplify_referrer_comment"
      value = "if (referrer eq '-') then referrer = '(no referrer)' else if (matches_regular_expression(referrer, '^([^:]+://[^/]+/)')) then referrer = $1 . '(omitted)'"
    } # simplify_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)';"
      disabled = true
    } # 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

    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 = "http_cc_guid"
    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 = "http_cc_guid"
      type = "unique"
      display_format_type = "integer"
    } # visitors

  } # 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 = ""
      page = true
      server_host = true
      remote_address = true
      location = true
      remote_user = true
      web_browser = true
      operating_system = true
      spider = true
      uri = true
      referrer = true
      referrer_description = true
      search_engine = true
      search_phrase = true
      cookie = true
    } # report_groups

  } # create_profile_wizard_options

  not_supported = {
    bandwidth = true
  } # not_supported

} # web_nibbler