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

  plugin_version = "1.0.1"

  # Initial creation - 1.0
  # 2011-06-24 - 1.0.1 - MSG - Edited info lines.

  info.1.manufacturer = "Miva Merchant"
  info.1.device = "Combined Access"
  info.1.version.1 = ""

  # The name of the log format
  log.format.format_label = "Miva Combined Access Log Format"
  log.miscellaneous.log_data_type = "generic"  
  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 = "^[^ ]* \"[^\"]*\" [0-9a-fA-F]+ \\[../.../....:..:..:.. [-+][0-9][0-9][0-9][0-9]\\] [^ ]+ [A-Z]+ \"[^\"]*\" [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"

  # 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 = {
      label = "$lang_stats.field_labels.hostname"
      type = "host"
      index = 1
      subindex = 0
      hierarchy_dividers = "."
      left_to_right = false
      leading_divider = "false"
    } # hostname

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

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

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

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

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

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

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

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

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

  } # log.fields


  # Database fields
  database.fields = {

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

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

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

    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

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

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

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

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

    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

    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

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

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

  # Get web browser, operating system, web browser, and spider information from the user-agent field.
  log.parsing_filters.derive_from_user_agent = `
get_user_agent_info(agent);
web_browser = volatile.web_browser;
operating_system = volatile.operating_system;
spider = volatile.spider;
`


  # 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)'"
    } # 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


    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 = "sessionid"
      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 = ""
      hostname = true
      domain_description = true
      location = true
      day_of_week = true
      hour_of_day = true
      store = true
      action = true
      screen = true
      attribute = true
      referrer = true
      referrer_description = true
      search_engine = true
      search_phrase = true
      web_browser = true
      operating_system = true
      spider = true
      server_response = true
    } # report_groups

  } # create_profile_wizard_options

  not_supported = {
  } # not_supported

} # miva_combined_access