.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "POE::Component::IRC::Plugin::Logger 3pm"
.TH POE::Component::IRC::Plugin::Logger 3pm "2021-09-30" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
POE::Component::IRC::Plugin::Logger \- A PoCo\-IRC plugin which
logs public, private, and DCC chat messages to disk
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use POE::Component::IRC::Plugin::Logger;
\&
\& $irc\->plugin_add(\*(AqLogger\*(Aq, POE::Component::IRC::Plugin::Logger\->new(
\&     Path    => \*(Aq/home/me/irclogs\*(Aq,
\&     DCC     => 0,
\&     Private => 0,
\&     Public  => 1,
\& ));
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
POE::Component::IRC::Plugin::Logger is a POE::Component::IRC
plugin. It logs messages and \s-1CTCP\s0 ACTIONs to either \fI#some_channel.log\fR or
\&\fIsome_nickname.log\fR in the supplied path. In the case of \s-1DCC\s0 chats, a '=' is
prepended to the nickname (like in irssi).
.PP
The plugin tries to detect \s-1UTF\-8\s0 encoding of every message or else falls back
to \s-1CP1252,\s0 like irssi (and, supposedly, mIRC) does by default. Resulting log
files will be \s-1UTF\-8\s0 encoded. The default log format is similar to xchat's,
except that it's sane and parsable.
.PP
This plugin requires the \s-1IRC\s0 component to be POE::Component::IRC::State
or a subclass thereof. It also requires a POE::Component::IRC::Plugin::BotTraffic
to be in the plugin pipeline. It will be added automatically if it is not
present.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
Arguments:
.PP
\&\fB'Path'\fR, the place where you want the logs saved.
.PP
\&\fB'Private'\fR, whether or not to log private messages. Defaults to 1.
.PP
\&\fB'Public'\fR, whether or not to log public messages. Defaults to 1.
.PP
\&\fB'\s-1DCC\s0'\fR, whether or not to log \s-1DCC\s0 chats. Defaults to 1.
.PP
\&\fB'Notices'\fR, whether or not to log NOTICEs. Defaults to 0.
.PP
\&\fB'Sort_by_date'\fR, whether or not to split log files by date, i.e.
\&\fI#channel/YYYY\-MM\-DD.log\fR instead of \fI#channel.log\fR. If enabled, the date
will be omitted from the timestamp. Defaults to 0.
.PP
\&\fB'Strip_color'\fR, whether or not to strip all color codes from messages. Defaults
to 0.
.PP
\&\fB'Strip_formatting'\fR, whether or not to strip all formatting codes from messages.
Defaults to 0.
.PP
\&\fB'Restricted'\fR, set this to 1 if you want all directories/files to be created
without read permissions for other users (i.e. 700 for dirs and 600 for files).
Defaults to 1.
.PP
\&\fB'Format'\fR, a hash reference representing the log format, if you want to define
your own. See the source for details.
.PP
\&\fB'Log_sub'\fR, a subroutine reference which can be used to override the file
logging. Use this if you want to store logs in a database instead, for
example. It will be called with 3 arguments: the context (a channel name or
nickname), a type (e.g. 'privmsg' or '+b', and any arguments to that type.
You can make use \*(L"default_format\*(R" to create logs that match the default
log format. \fBNote:\fR You must take care of handling date/time and stripping
colors/formatting codes yourself.
.PP
Returns a plugin object suitable for feeding to
POE::Component::IRC's \f(CW\*(C`plugin_add\*(C'\fR method.
.ie n .SS """default_format"""
.el .SS "\f(CWdefault_format\fP"
.IX Subsection "default_format"
Returns a hash reference of type/subroutine pairs, for formatting logs
according to the default log format.
.SH "AUTHOR"
.IX Header "AUTHOR"
Hinrik Örn Sigurðsson, hinrik.sig@gmail.com