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

  plugin_version = "1.0.1"

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

  info.1.manufacturer = "SmoothWall"
  info.1.device = "SmoothGuardian 3.1"
  info.1.version.1 = ""

  # SmoothWall SmoothGuardian 3.1

  # The name of the log format
  log.format.format_label = "SmoothWall SmoothGuardian 3.1 Log Format"
  log.miscellaneous.log_data_type = "firewall"  
  log.miscellaneous.log_format_type = "firewall"

  # 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]*\",\"[^$]*\"$'

  # Extract data from each line with this regular expression
  log.format.parsing_regular_expression = '^\"([0-9.]+) ([0-9:]+)\",\"([^"]*)\",\"([0-9.]*)\",\"([^"]*)\",\"([^"]*)\",\"([^"]*)\",\"([0-9]*)\",\"([^$]*)\"$'

  # The format of dates and times in this log
  log.format.date_format = "yyyy/mm/dd"
  log.format.time_format = "h:mm:ss"

  # Log entries are called accesses
  statistics.miscellaneous.entry_name = "accesses"

  # 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

    username = {
      label = "$lang_stats.field_labels.username"
      type = "flat"
      index = 0
      subindex = 0
    } # username
    
    
    client_ip = {
      label = "$lang_stats.field_labels.client_ip"
      type = "host"
      index = 0
      subindex = 0
      hierarchy_dividers = "."
      left_to_right = false
      leading_divider = "false"
    } # client_ip
    
    
    url = {
      label = "$lang_stats.field_labels.url"
      type = "page"
      index = 0
      subindex = 0
      hierarchy_dividers = "/?"
      left_to_right = true
      leading_divider = "false"
    } # url
    
    
    message = {
      label = "$lang_stats.field_labels.message"
      type = "flat"
      index = 0
      subindex = 0
    } # message
    
    
    operation = {
      label = "$lang_stats.field_labels.operation"
      type = "flat"
      index = 0
      subindex = 0
    } # operation
    
    
    request_bytes = {
      label = "$lang_stats.field_labels.request_bytes"
      type = "flat"
      index = 0
      subindex = 0
    } # request_bytes
    
    
    category = {
      label = "$lang_stats.field_labels.category"
      type = "flat"
      index = 0
      subindex = 0
    } # category
    
  } # log.fields


  # 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

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

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

  } # database.fields


  # Log Filters
  log.filters = {

    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 = 'accesses = 1;'
    } # mark_entry

  } # log.filters

  database.numerical_fields = {

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

    page_views = {
      label = "$lang_stats.field_labels.page_views"
      default = false
      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

    request_bytes = {
      label = "$lang_stats.field_labels.bandwidth"
      default = false
      requires_log_field = true
      log_field = "request_bytes"
      type = "int"
      integer_bits = 64
      display_format_type = "bandwidth"
    } # request_bytes

  } # database.numerical_fields

  log.field_options = {

    sessions_page_field = "url"
    sessions_visitor_id_field = "client_ip"
    sessions_event_field = "page_views"

  } # log.field_options

  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 = ""
      content_group = {
        url = true
        file_type = true
        category = true
      }
      username = true
      client_ip = true
      message = true
      operation = true
   
    } # report_groups

  } # create_profile_wizard_options

  not_supported = {
  } # not_supported

} # smooth_wall_sg31