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

  plugin_version = "1.0.1"

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

  info.1.manfacturer = "Clickcadence"
  info.1.device = "Beatbox Hits"
  info.1.version.1 = ""

  # The name of the log format
  log.format.format_label = "BeatBox Hits Log Format (default)"
  log.miscellaneous.log_data_type = "beatbox_hits"
  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 = "^#Software: BeatBox"

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

  # 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;
);
`

  # Get web browser, operating system, web browser, and spider information from the user-agent field.
  log.parsing_filters.derive_from_user_agent = {
    value = `get_user_agent_info(replace_all(cs_user_agent, '+', ' '));
web_browser = volatile.web_browser;
operating_system = volatile.operating_system;
spider = volatile.spider;
`
    requires_fields = {
      cs_user_agent = true
    }
  }

  # No need...BeatBox does this.
  log.processing.look_up_location_with_geoip = "false"

  # Log Filters
  log.filters = {

    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)'"
      requires_fields = {
        referrer = true
      }
    } # 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
      requires_fields = {
        referrer = true
      }
    } # internal_referrer

    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 cs_uri_stem = '(worm)';"
      requires_fields = {
        worm = true
      }
    } # set_page_for_worm


    # This filter tacks the page parameters ("URL query") onto the end of the page field
    empty_uri_query = {
      label = "$lang_admin.log_filters.empty_uri_query_label"
      comment = "$lang_admin.log_filters.empty_uri_query_comment"
      value = "if (cs_uri_query eq '-') then cs_uri_query = '(empty)';"
      disabled = true
      requires_fields = {
        cs_uri_query = true
      }
    } # empty_uri_query

    add_cs_uri_query = {
      label = "$lang_admin.log_filters.add_cs_uri_query_label"
      comment = "$lang_admin.log_filters.add_cs_uri_query_comment"
      value = "cs_uri_stem = cs_uri_stem . '?' . cs_uri_query"
      disabled = true
      requires_fields = {
        cs_uri_query = true
        cs_uri_stem = true
      }
    } # add_cs_uri_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;"
      requires_fields = {
        file_type = true
      }
    } # 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 cs_uri_stem = substr(cs_uri_stem, 0, last_index(cs_uri_stem, '/') + 1) . '(nonpage)';"
      requires_fields = {
        cs_uri_stem = true
      }
    } # 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

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

    bytes = {
      label = "$lang_stats.field_labels.bytes"
      default = false
      log_field = "bytes"
      requires_log_field = true
      type = "float"
      display_format_type = "bandwidth"
    }

    sc_bytes = {
      label = "$lang_stats.field_labels.sc_bytes"
      default = false
      log_field = "sc_bytes"
      requires_log_field = true
      type = "float"
      display_format_type = "bandwidth"
    }

    cs_bytes = {
      label = "$lang_stats.field_labels.cs_bytes"
      default = false
      log_field = "cs_bytes"
      requires_log_field = true
      type = "float"
      display_format_type = "bandwidth"
    }

    time_taken = {
      label = $lang_stats.field_labels.time_taken
      default = false
      requires_log_field = true
      type = float
      display_format_type = duration_microseconds
    } # time_taken

    x_ssl_time = {
      type = float
      display_format_type = duration_microseconds
    }

    cs_send_time = {
      type = float
      display_format_type = duration_microseconds
    }

    cs_ack_time = {
      type = float
      display_format_type = duration_microseconds
    }

    cs_reply_time = {
      type = float
      display_format_type = duration_microseconds
    }

    sc_send_time = {
      type = float
      display_format_type = duration_microseconds
    }

    sc_ack_time = {
      type = float
      display_format_type = duration_microseconds
    }

  } # 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 = {
        file_type = true
        cs_uri = true
        cs_uri_stem = true
        cs_uri_query = true
      }
      visitor_demographics_group = {
        c_ip = true
        cs_ip = true
        domain_description = true
        location = true
        cs_username = true
      }
      visitor_systems_group = {
        screen_dimensions = true
        screen_depth = true
        web_browser = true
        operating_system = true
      }
      referrer_group = {
        referrer = true
        search_engine = true
        search_phrase = true
        referrer_description = true
        search_phrase_by_search_engine = true
      }
      server_group = {
        s_sitename = true
        s_computername = true
        s_ip = true
        s_port = true
        cs_host = true
      }
      other_group = {
        cs_version = true
        worm = true
        spider = true
        cs_method = true
        sc_status = true
        sc_substatus = true
        sc_win32_status = true
        cs_cookie = true
      }
    } # report_groups

    final_step = `

include "templates.admin.profiles.setup_reports_util";

string profile = "profiles." . volatile.new_profile_name;

# Remove cs_uri_query and cs_cookie from the database fields
delete_database_field(profile, 'cs_uri_query');
delete_database_field(profile, 'x_post_content');
delete_database_field(profile, 'cs_cookie');
delete_database_field(profile, 'sc_set_cookie');
delete_database_field(profile, 'sc_transfer_encodings');
delete_database_field(profile, 'sc_trailers');

# Create the standard reports
add_standard_reports(profile);

# Delete referrer filters if there's no referrer field
if (!node_exists(profile . ".database.fields.referrer")) then (
  (profile . ".log.filters.no_referrer.disabled") = true;
  (profile . ".log.filters.internal_referrer.disabled") = true;
);

# The format of dates and times in this log
delete_node(profile . ".log.fields.date");
(profile . ".log.format.ignore_format_lines") = true;
(profile . ".log.format.date_format") = "seconds_since_jan1_1970";
(profile . ".log.format.time_format") = "seconds_since_jan1_1970";

    ` # end final_step

  } # create_profile_wizard_options

  log.field_options = {

    sessions_page_field = "cs_uri_stem"
    sessions_visitor_id_field = "x_session_id"
    sessions_event_field = "page_views"

  } # log.field_options

  statistics.miscellaneous = {
    maximum_session_duration = "0"
    session_timeout = "0"
    remove_reloads_from_sessions = "false"
  } # statistics.miscellaneous

  not_supported = {
  } # not_supported

} # beatbox_hits_default