This file is indexed.

/usr/share/httpry/plugins/sample_plugin.pm is in httpry-tools 0.1.7-3.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
#
#  ----------------------------------------------------
#  httpry - HTTP logging and information retrieval tool
#  ----------------------------------------------------
#
#  Copyright (c) 2005-2012 Jason Bittel <jason.bittel@gmail.com>
#

# This is an example plugin for the perl parse script parse_log.pl.  It shows
# the basic structure of a simple plugin and provides a good starting point for
# writing a custom plugin. Some of the other included plugins will also provide
# a good idea of how the different pieces work. Each plugin is essentially a
# Perl module dynamically loaded at runtime. A plugin has two required
# functions, new() and main().

package sample_plugin;

# -----------------------------------------------------------------------------
# GLOBAL CONSTANTS
# -----------------------------------------------------------------------------

# -----------------------------------------------------------------------------
# GLOBAL VARIABLES
# -----------------------------------------------------------------------------

# -----------------------------------------------------------------------------
# Plugin core
# -----------------------------------------------------------------------------

# On initialization, this call registers the plugin with the core
main::register_plugin();

# This sub is called once at initialization to create the callback
sub new {
        return bless {};
}

# This sub is called once at initialization; all startup code should be
# included here. Currently this sub only loads the configuration file, but
# any startup specific code or subs are handled here. This function may
# be omitted completely if it is unneeded.
sub init {
        my $self = shift;
        my $cfg_dir = shift;

        # Call a function to load the config file; this can be good to
        # break out into a separate sub like this, particularly if you
        # end up with many checks on the config variables
        _load_config($cfg_dir);

        return;
}

# This sub returns a list of fields that the plugin requires. This list
# is compared against the header fields, and the plugin is disabled if
# the input file does not contain all of the required fields. This
# function may be omitted completely if it is unneeded.
sub list {
        return qw();
}

# This sub is called once for each data line in the input file(s). Note
# that the data is sent here as a single line and so must be parsed (if
# necessary) to act on individual components of the line. This function
# is required to be present.
sub main {
        my $self = shift;
        my $record = shift; # Reference to hash containing record data

        # Simple processing can be handled here; more complex processing
        # would probably be better handled in a different sub

        return;
}

# This sub is called once at program termination; all shutdown code (i.e.
# closing files, deleting temp files, etc) should be included here. This
# function may be omitted completely if it is unneeded.
sub end {

        return;
}

# -----------------------------------------------------------------------------
# Load config file and check for required options
# -----------------------------------------------------------------------------
sub _load_config {
        my $cfg_dir = shift;

        # Load config file; by default in same directory as plugin
        if (-e "$cfg_dir/" . __PACKAGE__ . ".cfg") {
                require "$cfg_dir/" . __PACKAGE__ . ".cfg";
        }

        # Check for required options and combinations from the configuration
        # file variables. This can also be a good place to do file reads for
        # initializing run time data structures.

        return;
}

1;