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

  plugin_version = "1.0.1"

  # Initial creation - 1.0
  # 2010-12-14 - 1.0.1 - MSG - Edited info lines.

  info.1.manufacturer = "St. Bernard Software"
  info.1.device = "iPrism  (with syslog)"
  info.1.version.1 = ""

  # The name of the log format
  log.format.format_label = "iPrism (with syslog)"
  log.miscellaneous.log_data_type = "syslog_required"  
  log.miscellaneous.log_format_type = "internet_device"

  # The log is in this format if any of the first ten lines match this regular expression
  log.format.autodetect_regular_expression = "[A-Za-z]+\\[[0-9]+\\]: [a-z]+	[0-9]+	[0-9]+	[0-9]+\\.[0-9]+\\.[0-9]+\\.[0-9]+[^	]*	[^	]+	[0-9]+	[A-Z]+	[^	]+	[^	]+	[^	]+	.*$"

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

  # The format of dates and times in this log

  #log_date_format seconds_since_jan1_1970

  #log_time_format seconds_since_jan1_1970

  # Log fields
  log.fields = {

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

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

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

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

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

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

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

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

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

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

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

  } # log.fields


  #          
  # Log Parsing Filters
  log.parsing_filters = {


    # Parse each line with this regex
    1 = {
      label = "1"
      comment = ""
      value = "collect_fields_using_regexp('()[A-Za-z]+\\\\[[0-9]+\\\\]: ([a-z]+)	[0-9]+	[0-9]+	([0-9]+\\\\.[0-9]+\\\\.[0-9]+\\\\.[0-9]+) *\\\\(*([^()]*)\\\\)* *	([A-Z_]+)/([0-9]+)	([0-9]+)	([A-Z]+)	([^	]+)	([^	]+	[^	]+)	([^	]+)	(.*)$', '*KEY*,protocol,source_ip,source_hostname,result_code,http_code,size,method,url,hierarchy,mime-type,category')"
    } # 1


    # Accept this log entry
    2 = {
      label = "2"
      comment = ""
      value = "accept_collected_entry_using_regexp('^()', false)"
    } # 2


  } # log.parsing_filters


  # Database fields
  database.fields = {

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

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

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

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

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

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

    url = {
      label = "$lang_stats.field_labels.url"
      log_field = "url"
      type = "string"
      suppress_top = 1
      suppress_bottom = 9
    } # url

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

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

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

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

  } # database.fields


  # Log Filters
  log.filters = {


    #set Mime-type to empty when -
    1 = {
      label = "1"
      comment = ""
      value = "if (mime_type eq '-') then mime_type = '(empty)';"
    } # 1

    remove_query = {
      label = "$lang_admin.log_filters.remove_query_label"
      comment = "$lang_admin.log_filters.remove_query_comment"
      value = "if (contains(url, '?')) then url = substr(url, 0, index(url, '?') + 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 url = substr(url, 0, last_index(url, '/') + 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 = "url"
    sessions_visitor_id_field = "source_ip"
    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 = "source_ip"
      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 = {
    host_tracking = true

    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
      protocol = true
      source_ip = true
      source_hostname = true
      result_code = true
      http_code = true
      method = true
      url = true
      hierarchy = true
      mime_type = true
      category = true
      file_type = true
    } # report_groups

  } # create_profile_wizard_options

  not_supported = {
  } # not_supported

} # i_prism_with_syslog