# Copyright (c) 2010 Flowerfire, Inc.  All Rights Reserved.
common_access = {
  
  plugin_version = "1.1.4"

  info.1.manufacturer = "NCSA"
  info.1.device = "Common Access"
  info.1.version = "2.2"

  #            -     - 1.0 - Initial creation
  # 2008-01-02 - KBB - 1.1 - Added two time based reports for Authenicated User.
  # 2008-07-10 - KBB - 1.1.1 - Removed special timestamp field from menu and summary.
  # 2009-03-20 - DMG - 1.1.2 - Commented out time_stamp field.  This field is too complex to be on by default for a common format like this.
  #                            It caused a moderate dataset to use 3GB+ of RAM when building on wisteria.
  # 2010-05-13 - GMF - 1.1.3 - Added server_domain as a database field
  # 2010-10-27 - MSG - 1.1.4 - Edited info lines

  # The name of the log format
  log.format.format_label = "Common Access Log Format"
  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]* *$"

  # 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"

  # 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

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

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

    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

    # 2009-05-20 - GMF - Commented this out, because the time_stamp field is horribly complex.  Uncomment it if you need this, but it will make the database unwieldy.
#    time_stamp = {
#      label = "Time Stamp"
#    }

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

    page = {
      label = "$lang_stats.field_labels.page"
      type = "page"
      index = 5
      subindex = 2
      hierarchy_dividers = "/?"
      left_to_right = true
      leading_divider = "true"
    } # page

    protocol = {
      label = "$lang_stats.field_labels.protocol"
      type = "flat"
      index = 5
      subindex = 3
    } # protocol

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

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

  } # log.fields

  # 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

    # 2009-05-20 - GMF - Commented this out, because the time_stamp field is horribly complex.  Uncomment it if you need this, but it will make the database unwieldy.
#    time_stamp = {
#      display_format_type = "date_time"
#    } # time_stamp

    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

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

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

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

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

    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

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

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

    server_domain = ""

  } # database.fields

  # Log Filters
  log.filters = {

    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

    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

    # 2009-05-20 - GMF - Commented this out, because it makes the timestamp field horribly complex.  Uncomment it if you need this, but it will make the database unwieldy.
#    copy_date_time = {
#      label = 'Copy Date/Time'
#      comment = 'Copy date_time field to time_stamp field.'
#      value = 'time_stamp = date_time;'
#    } # copy_date_time

  } # log.filters

  log.field_options = {

    sessions_page_field = "page"
    sessions_visitor_id_field = "hostname"
    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 = "hostname"
      type = "unique"
      display_format_type = "integer"
    } # visitors

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

  } # database.numerical_fields

  create_profile_wizard_options = {

    # 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
        authenticated_user_by_hour_of_day = true

        # 2009-05-20 - GMF - Commented this out, because the time_stamp field is horribly complex.  Uncomment it if you need this, but it will make the database unwieldy.
#        authenticated_user_by_time_stamp = true
      }
      visitor_systems_group = {
        screen_dimensions = true
        screen_depth = true
      }
      other_group = {
        worm = true
        server_domain = true
        server_response = true
      }
    } # report_groups

    final_step = `

include "templates.admin.profiles.setup_reports_util";

string profile = "profiles." . volatile.new_profile_name;
string summary = profile . ".statistics.reports.single_page_summary.report_elements";
string menu = profile . ".statistics.reports_menu";

# Create the standard reports
add_standard_reports(profile);

# 2009-05-20 - GMF - Commented this out, because the time_stamp field is horribly complex.  Uncomment it if you need this, but it will make the database unwieldy.
#delete_node(summary . ".time_stamp");
#delete_node(menu . ".time_stamp");

`

  } # create_profile_wizard_options

} # common_access