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

  plugin_version = "1.0.1"

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

  info.1.manufacturer = "Stairways"
  info.1.device = "NetPresenz (d/m/y dates)"
  info.1.version.1 = ""

  # The name of the log format
  log.format.format_label = "NetPresenz Log Format (d/m/y dates)"
  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 = "^[0-9][0-9]*:[0-9][0-9] [AP]M	[0-9][0-9]*/[0-9][0-9]*/[0-9][0-9]*	[0-9.]*	NetPresenz.*starting up"

  # The format of dates and times in this log
  log.format.date_format = "d/m/y"
  log.format.time_format = "h:mm AM/PM"

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

  # Log fields
  log.fields = {

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

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

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

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

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

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

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

  } # log.fields


  #          
  # Log Parsing Filters
  log.parsing_filters = {


    # Reject status lines
    1 = {
      label = "1"
      comment = ""
      value = "if (contains(entire_line, 'NetPresenz')) then 'reject';"
    } # 1


    # Parse out all the fields in a get file or put file line
    2 = {
      label = "2"
      comment = ""
      value = "collect_fields_using_regexp('^()([0-9][0-9]*:[0-9][0-9] [AP]M)	([0-9][0-9]*/[0-9][0-9]*/[0-9][0-9]*)	([0-9.]*)	([^	 ]*)	[0-9]*	(get file|put file)	[^@]*	', '*key,time,date,hostname,user,operation')"
    } # 2


    # Parse out the page from a page line, or the referrer from a referrer line
    3 = {
      label = "3"
      comment = ""
      value = "if (starts_with(entire_line, 'Referer: ')) then collect_fields_using_regexp('^()Referer: (.*)$', '*KEY*,referrer') else collect_fields_using_regexp('^()([^@	]*:[^@	]*)$', '*KEY*,page')"
    } # 3


    # Accept this log entry when we get to the page field
    4 = {
      label = "4"
      comment = ""
      value = "if (starts_with(entire_line, 'Referer: ')) then '' else accept_collected_entry_using_regexp('^()[^@	]*:[^@	]*$', false)"
    } # 4


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

    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

    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

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

  } # database.fields


  # Log Filters
  log.filters = {


    # This filter replaces the : characters with / characters, to bring NetPresenz's page divider

    # in line with what Sawmill expects.
    1 = {
      label = "1"
      comment = ""
      value = "page = replace_all(page, ':', '/');"
    } # 1

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

  } # 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
      file_type = true
      worm = true
      screen_dimensions = true
      screen_depth = true
      hostname = true
      domain_description = true
      location = true
      referrer = true
      referrer_description = true
      search_engine = true
      search_phrase = true
      authenticated_user = true
    } # report_groups

  } # create_profile_wizard_options

  not_supported = {
    bandwidth = true
  } # not_supported

} # net_presenz_dmy