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

  plugin_version = "1.0.1"

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

  info.1.manufacturer = "Apple"
  info.1.device = "MacOS X FTP"
  info.1.version.1 = ""

  # The name of the log format
  log.format.format_label = "MacOS X FTP Log Format"
  log.miscellaneous.log_data_type = "ftp"  
  log.miscellaneous.log_format_type = "ftp_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][a-z][a-z] [0-9 ][0-9] [0-9][0-9]:[0-9][0-9]:[0-9][0-9] [^ ]* ftpd\\[[0-9]*\\]: "

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

  # An entry is called a download
  statistics.miscellaneous.entry_name = "downloads"

  # A visitor is called a unique IP
  statistics.miscellaneous.visitor_name = "unique IP"

  # The format of dates and times in this log
  log.format.date_format = "mmm dd"
  log.format.time_format = "hh:mm:ss"

  # 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

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

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

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

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

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

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

  } # log.fields


  #          
  # Log Parsing Filters
  log.parsing_filters = {


    # Parse out all the beginning fields
    1 = {
      label = "1"
      comment = ""
      value = "collect_fields_using_regexp('^()([A-Z][a-z][a-z] [0-9 ][0-9]) ([0-9][0-9]:[0-9][0-9]:[0-9][0-9]) ([^ ]*) ', '*KEY*,date,time,server')"
    } # 1


    # Handle connection and ANONYMOUS FTP LOGIN REFUSED lines lines
    2 = {
      label = "2"
      comment = ""
      value = "collect_fields_using_regexp(' ()(connection|ANONYMOUS FTP LOGIN REFUSED) (from|FROM) (.*)$', '*KEY*,operation,x,hostname')"
    } # 2


    # Handle FTP LOGIN FAILED from lines
    3 = {
      label = "3"
      comment = ""
      value = "collect_fields_using_regexp(': ()(FTP LOGIN FAILED) FROM ([^,]*), (.*)$', '*KEY*,operation,hostname,authenticated_user')"
    } # 3


    # Handle FTP LOGIN lines
    4 = {
      label = "4"
      comment = ""
      value = "collect_fields_using_regexp(': ()(FTP LOGIN) FROM ([^ ]*) as (.*)$', '*KEY*,operation,hostname,authenticated_user')"
    } # 4


    # Handle GET lines
    5 = {
      label = "5"
      comment = ""
      value = "collect_fields_using_regexp(': ()([Gg][Ee][Tt]) (.*) = ([0-9]+) bytes$', '*KEY*,operation,file,size')"
    } # 5


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


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

    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

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

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

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

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

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

  } # database.fields


  # Log Filters
  log.filters = {

    not_authenticated = {
      label = "$lang_admin.log_filters.not_authenticated_label"
      comment = "$lang_admin.log_filters.not_authenticated_comment"
      value = "if (authenticated_user eq '-') then authenticated_user = '(not authenticated)';"
    } # not_authenticated


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

  } # log.filters

  log.field_options = {

    sessions_page_field = "file"
    sessions_visitor_id_field = "hostname"
    sessions_event_field = "page_views"

  } # log.field_options


  database.numerical_fields = {

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

    visitors = {
      label = "$lang_stats.field_labels.visitors"
      default = false
      requires_log_field = true
      log_field = "hostname"
      type = "unique"
      display_format_type = "integer"
    } # visitors

    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
    host_tracking = true

    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
      hostname = true
      domain_description = true
      location = true
      authenticated_user = true
      operation = true
      file = true
      file_type = true
      server = true
    } # report_groups

  } # create_profile_wizard_options

  not_supported = {
    pageviews = true
  } # not_supported

} # mac_osxftp