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

  plugin_version = "1.0.1"

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

  info.1.manufacturer = "NCSA"
  info.1.device = "Common Referrer"
  info.1.version.1 = ""

  # The name of the log format
  log.format.format_label = "Common Referrer Log Format"
  log.miscellaneous.log_data_type = "http_referrer"  
  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 regular expression to extract the data
  log.format.parsing_regular_expression = "^(.*) -> (.*)$"

  # Log fields
  log.fields = {

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

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

  } # log.fields


  # Database fields
  database.fields = {

    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

    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

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


  # 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

    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

  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

  } # database.numerical_fields


  create_profile_wizard_options = {

    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
      page = true
      file_type = true
      worm = true
      referrer = true
      referrer_description = true
      search_engine = true
      search_phrase = true
    } # report_groups

  } # create_profile_wizard_options

  not_supported = {
    daybyday = true
    visitors = true
    sessions = true
    bandwidth = true
  } # not_supported

} # common_referrer