.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "Mail::SpamAssassin::Util 3pm"
.TH Mail::SpamAssassin::Util 3pm 2024-04-02 "perl v5.38.2" "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
Mail::SpamAssassin::Util \- utility functions
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A general class for utility functions.  Please use this for functions that
stand alone, without requiring a \f(CW$self\fR object, Portability functions
especially.
.PP
NOTE: The functions in this module are to be considered private.  Their API may
change at any point, and it's expected that they'll only be used by other
Mail::SpamAssassin modules. (TODO: we should probably revisit this if
it's useful for plugin development.)
.PP
NOTE: Utility functions should not be changing global variables such
as \f(CW$_\fR, \f(CW$1\fR, \f(CW$2\fR, ... $/, etc. unless explicitly documented.  If these
variables are in use by these functions, they should be localized.
.ie n .IP "$module = first_available_module (@module_list)" 4
.el .IP "\f(CW$module\fR = first_available_module (@module_list)" 4
.IX Item "$module = first_available_module (@module_list)"
Return the name of the first module that can be successfully loaded with
\&\f(CW\*(C`require\*(C'\fR from the list.  Returns \f(CW\*(C`undef\*(C'\fR if none are available.
.Sp
This is used instead of \f(CW\*(C`AnyDBM_File\*(C'\fR as follows:
.Sp
.Vb 3
\&  my $module = Mail::SpamAssassin::Util::first_available_module
\&                        (qw(DB_File GDBM_File NDBM_File SDBM_File));
\&  tie %hash, $module, $path, [... args];
.Ve
.Sp
Note that \f(CW\*(C`SDBM_File\*(C'\fR is guaranteed to be present, since it comes
with Perl.
.IP "touch_file(file, { args });" 4
.IX Item "touch_file(file, { args });"
Touch or create a file.
.Sp
Possible args:
.Sp
create_exclusive => 1
  Create a new empty file safely, only if not existing before
.ie n .IP "my ($filepath, $filehandle) = \fBsecure_tmpfile()\fR;" 4
.el .IP "my ($filepath, \f(CW$filehandle\fR) = \fBsecure_tmpfile()\fR;" 4
.IX Item "my ($filepath, $filehandle) = secure_tmpfile();"
Generates a filename for a temporary file, opens it exclusively and
securely, and returns a filehandle to the open file (opened O_RDWR).
.Sp
If it cannot open a file after 20 tries, it returns \f(CW\*(C`undef\*(C'\fR.
.IP "my ($dirpath) = \fBsecure_tmpdir()\fR;" 4
.IX Item "my ($dirpath) = secure_tmpdir();"
Generates a directory for temporary files.  Creates it securely and
returns the path to the directory.
.Sp
If it cannot create a directory after 20 tries, it returns \f(CW\*(C`undef\*(C'\fR.