# Copyright (c) 2014 Flowerfire, Inc.  All Rights Reserved.
free_proxy = {

  plugin_version = "1.0"

  info.1.manufacturer = "Hand-Crafted Software"
  info.1.device = "FreeProxy"
  info.1.version = ""

  # 2014-03-10 - GMF - 1.0 - Initial implementation

  # The name of the log format
  log.format.format_label = "Hand-Crafted Software FreeProxy Log Format"
  log.miscellaneous.log_data_type = "firewall"
  log.miscellaneous.log_format_type = "proxy_server"

  # The log is in this format if any of the first ten lines match this regular expression
#Wed 05 Mar 2014 20:07:25 : CONN STAT : Instance:'Abadux' Protocol:'HTTP-Proxy' Port:'4444' Client IP:'10.10.10.51' User:'DefaultUser' Website:'en.wikipedia.org' URL:'/wiki/Software_testing' From Client: 736 bytes To Client: 53575 bytes
  log.format.autodetect_regular_expression = `^[A-Z][a-z][a-z] [0-9][0-9] [A-Z][a-z][a-z] [0-9][0-9][0-9][0-9] [0-9][0-9]:[0-9][0-9]:[0-9][0-9] : CONN STAT : `

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

  # Log fields
  log.fields = {

    date = ""
    time = ""
    instance = ""
    protocol = ""
    port = ""
    client_ip = ""
    user = ""
    website = ""
    url = ""
    from_client_bytes = ""
    to_client_bytes = ""

#    accesses = ""

  } # log.fields

  log.parsing_filters.parse = `
if (matches_regular_expression(current_log_line(), '^[A-Z][a-z][a-z] ([0-9][0-9] [A-Z][a-z][a-z] [0-9][0-9][0-9][0-9]) ([0-9][0-9]:[0-9][0-9]:[0-9][0-9]) : CONN STAT : (.*)$')) then (
  set_collected_field('', 'date', $1);
  set_collected_field('', 'time', $2);

  v.remainder = ' ' . $3;
  while (matches_regular_expression(v.remainder, "^ ([A-Za-z ]+):'([^']+)'(.*)$") or
         matches_regular_expression(v.remainder, "^ ([A-Za-z ]+): ([0-9]+) bytes(.*)$")) (
   v.fieldname = replace_all(lowercase($1), ' ', '_');
   if ((v.fieldname eq 'from_client') or (v.fieldname eq 'to_client')) then
     v.fieldname .= "_bytes";
   set_collected_field('', v.fieldname, $2);
   v.remainder = $3;
  );
#  collect_listed_fields('', $3, ' ', ':', '');

  v.scheme = 'http';
  set_collected_field('', 'url', v.scheme . '://' . get_collected_field('', 'website') . get_collected_field('', 'url'));

  accept_collected_entry('', false);
);
`


  # Database fields
  database.fields = {

    date_time = ""
    hour_of_day = ""
    day_of_week = ""
    instance = ""
    protocol = ""
    port = ""
    client_ip = ""
    user = ""
    website = ""
    url = ""

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

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

    from_client_bytes = {
      integer_bits = 64
      display_format_type = "bandwidth"
    } # from_client_bytes

    to_client_bytes = {
      integer_bits = 64
      display_format_type = "bandwidth"
    } # to_client_bytes

  } # database.numerical_fields

  create_profile_wizard_options = {

    # How the reports should be grouped in the report menu
    report_groups = {
      date_time_group = ""
    } # report_groups

    snapons = {

      # Attach proxy_direction, to prompt for whether this is a forward or reverse proxy
#      proxy_direction = {
#        snapon = "proxy_direction"
#        name = "proxy_direction"
#        label = "$lang_admin.snapons.proxy_direction.label"
#        parameters = {
#          proxy_direction.parameter_value = ""
#          source_ip_field.parameter_value = "source_ip"
#          server_ip_field.parameter_value = "server_ip"
#        } # parameters
#
#        parameters_form = {
#          group_1 = {
#            description = "$lang_admin.snapons.proxy_direction.parameters_form.group_1.description"
#            parameters = {
#              proxy_direction = true
#            } # parameters
#          } # group 1
#        } # parameters_form
#
#      } # proxy_direction
  
      # Attach a gateway_reports snapon
      gateway_reports = {
	snapon = "gateway_reports"
	name = "gateway_reports"
	label = "$lang_admin.snapons.gateway_reports.label"
        parameters = {
          user_field.parameter_value = "user"
#          user_field.parameter_value = "source_ip"
          have_category_field.parameter_value = false
#          category_field.parameter_value = "category"
          host_field.parameter_value = "top_level_domain"
          url_field.parameter_value = "url"
          page_views_field.parameter_value = "accesses"
          bytes_in_field.parameter_value = "from_client_bytes"
          sort_by_field.parameter_value = "accesses"

          accesses_field = {
            parameter_value = "$lang_stats.field_labels.accesses"
            final_node_name = "accesses"
          } # accesses

        } # parameters
  
      } # gateway_reports

    } # snapons

  } # create_profile_wizard_options

} # free_proxy