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

  plugin_version = "1.0.1"

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

  info.1.manfacturer = "Critical Path"
  info.1.device = "Mail Server (SMTP)"
  info.1.version.1 = ""

  # The name of this format
  log.format.format_label = "Critical Path Mail Server SMTP Log Format"

  # This log is the following type
  log.miscellaneous.log_data_type = "mail_server"
  log.miscellaneous.log_format_type = "mail_server"

  # The format of dates in this log
  log.format.date_format = "yyyymmdd"

  # The format of times in this log
  log.format.time_format = "hh:mm:ss"

  # The name of an entry in this log
  statistics.miscellaneous.entry_name = "messages"

  # We use this to recognise the format and "auto-detect".
  log.format.autodetect_regular_expression = "^[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9] [0-9][0-9]:[0-9][0-9]:[0-9][0-9] [A-F0-9]+"

  # when we need to use parsing filters only, we set this to true
  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 = true
      leading_divider = "false"
    } # date

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

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

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

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

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

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

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


  } # log.fields


  # Log Parsing Filters
  log.parsing_filters = {


    # date/time
    1 = {
      label = "1"
      comment = ""
      value = "collect_fields_using_regexp('([0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]) ([0-9][0-9]:[0-9][0-9]:[0-9][0-9]) ([-A-F0-9]+)', 'date,time,*KEY*')"
    } # 1


    # sender/size/relay and recipient lines
    2 = {
      label = "2"
      comment = ""
      value = "collect_fields_using_regexp(' ([-A-F0-9]+) (QUEUE|VIRUS-CLEANER) From=<([^>]*)> Size=([0-9]*) Relay=([^ ]*)', '*KEY*,type,sender,size,relay')"
    } # 2

    3 = {
      label = "3"
      comment = ""
      value = "collect_fields_using_regexp(' ([-A-F0-9]+) (QUEUE|VIRUS-CLEANER) Recipient=<([^>]*)>', '*KEY*,type,recipient')"
    } # 3


    # other detail not used here but may be useful in some circumstances (messageID/subject etc)
    4 = {
      label = "4"
      comment = ""
      value = "collect_fields_using_regexp(' ([-A-F0-9]+) QUEUE Message-ID=<([^>]*)>', '*KEY*,messageid')"
    } # 4

    5 = {
      label = "5"
      comment = ""
      value = "collect_fields_using_regexp(' ([-A-F0-9]+) QUEUE Subject=(.*)', '*KEY*,subject')"
    } # 5

    # Accept this log entry
    accept_virus = {
      label = "accept virus"
      comment = "accept virus"
      value = "accept_collected_entry_using_regexp(' ([-A-F0-9]+) VIRUS-CLEANER Recipient=<([^>]*)>', false)"
    } # accept_virus

    # Accept this log entry
    accept = {
      label = "accept"
      comment = "accept"
      value = "accept_collected_entry_using_regexp('^[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9] [0-9][0-9]:[0-9][0-9]:[0-9][0-9] ([-A-F0-9]+) .* [Mm]essage accepted for delivery[^$]*$', false)"
    } # accept


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


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

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

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

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

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

  } # database.fields


  # Log Filters
  log.filters = {


    mark_entry = {
      label = '$lang_admin.log_filters.mark_entry_label'
      comment = '$lang_admin.log_filters.mark_entry_comment'
      value = 'messages = 1;'
    } # mark_entry

  } # log.filters

  database.numerical_fields = {

    messages = {
      label = "$lang_stats.field_labels.messages"
      default = true
      requires_log_field = false
      type = "int"
      display_format_type = "integer"
      entries_field = true
    } # messages

    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 = {
    date_time_tracking = true

    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
      type = true
      sender = true
      recipient = true
      relay = true
      subject = true
    } # report_groups

  } # create_profile_wizard_options

  not_supported = {
    individualhosts = true
    sessions = true
    pageviews = true
    visitors = true
  } # not_supported

} # critical_path_smtp