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

  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
  # 2011-12-14 - GMF - 1.1.5 - Removed default values for database fields; set hostname to non-hierarchical
  # 2012-08-08 - GMF - 1.2 - Switched to web_server_package

  # 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.index = 1
    server_domain.index = 2
    authenticated_user.index = 3

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

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

    page = {
      index = 5
      subindex = 2
    } # page

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

    server_response.index = 6
    size.index = 7

  } # log.fields


  create_profile_wizard_options = {

    snapons = {

      page = {
        snapon = "non_aggregating_field"
        parameters = {
          field_name.final_node_name = "page"
          report_group_name.final_node_name = "content_group"
        } # parameters
      } # page

      date_time_fields = {
        snapon = "date_time_fields"
      } # date_time

      hostname = {
        snapon = "non_aggregating_field"
        parameters = {
          field_name.final_node_name = "hostname"
          report_group_name.final_node_name = "content_group"
        } # parameters
      } # hostname

      authenticated_user = {
        snapon = "non_aggregating_field"
        parameters = {
          field_name.final_node_name = "authenticated_user"
          report_group_name.final_node_name = "visitor_demographics_group"
        } # parameters
      } # authenticated_user

      server_response = {
        snapon = "non_aggregating_field"
        parameters = {
          field_name.final_node_name = "server_response"
          report_group_name.final_node_name = "other_group"
        } # parameters
      } # server_response

      server_domain = {
        snapon = "non_aggregating_field"
        parameters = {
          field_name.final_node_name = "server_domain"
          report_group_name.final_node_name = "content_group"
        } # parameters
      } # server_domain

      # Attach a web_server_package snapon
      web_server_package = {
	snapon = "web_server_package"
	name = "web_server_package"
	label = "$lang_admin.snapons.web_server_package.label"
        parameters = {
          user_agent_field.parameter_value = "none"
          page_field.parameter_value = "page"
          client_ip_field.parameter_value = "hostname"
          server_response_field.parameter_value = "server_response"
          referrer_field.parameter_value = "none"
          authenticated_user.parameter_value = "authenticated_user"
          hits_field = {
            parameter_value = "$lang_stats.field_labels.hits"
            final_node_name = "hits"
          } # hits
          visitors_field = {
            parameter_value = "$lang_stats.field_labels.visitors"
            final_node_name = "visitors"
          } # visitors_field
          sc_bytes_field = {
            parameter_value = "$lang_stats.field_labels.size"
            final_node_name = "size"
          } # sc_bytes_field
          cs_bytes_field = {
            parameter_value = "none"
            final_node_name = "none"
          } # cs_bytes_field
        } # parameters
      } # web_server_package

    } # snapons

  } # create_profile_wizard_options

} # common_access