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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
# --
# Copyright (C) 2001-2021 OTRS AG, https://otrs.com/
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
# the enclosed file COPYING for license information (GPL). If you
# did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.
# --
package Kernel::System::FileTemp;
use strict;
use warnings;
use File::Temp qw( tempfile tempdir );
our @ObjectDependencies = (
'Kernel::Config',
);
=head1 NAME
Kernel::System::FileTemp - tmp files
=head1 DESCRIPTION
This module is managing temporary files and directories.
=head1 PUBLIC INTERFACE
=head2 new()
Don't use the constructor directly, use the ObjectManager instead:
my $FileTempObject = $Kernel::OM->Get('Kernel::System::FileTemp');
=cut
sub new {
my ( $Type, %Param ) = @_;
# allocate new hash for object
my $Self = {};
bless( $Self, $Type );
$Self->{FileHandleList} = [];
return $Self;
}
=head2 TempFile()
returns an opened temporary file handle and its file name.
Please note that you need to close the file handle for other processes to write to it.
my ($FileHandle, $Filename) = $TempObject->TempFile(
Suffix => '.png', # optional, defaults to '.tmp'
);
=cut
sub TempFile {
my ( $Self, %Param ) = @_;
my $TempDir = $Kernel::OM->Get('Kernel::Config')->Get('TempDir');
my ( $FH, $Filename ) = tempfile(
DIR => $TempDir,
SUFFIX => $Param{Suffix} // '.tmp',
UNLINK => 1,
);
# remember created tmp files and handles
push @{ $Self->{FileHandleList} }, $FH;
return ( $FH, $Filename );
}
=head2 TempDir()
returns a temp directory. The directory and its contents will be removed
if the FileTemp object goes out of scope.
=cut
sub TempDir {
my $Self = shift;
my $TempDir = $Kernel::OM->Get('Kernel::Config')->Get('TempDir');
my $DirName = tempdir(
DIR => $TempDir,
CLEANUP => 1,
);
return $DirName;
}
sub DESTROY {
my ( $Self, %Param ) = @_;
# close all existing file handles
FILEHANDLE:
for my $FileHandle ( @{ $Self->{FileHandleList} } ) {
next FILEHANDLE if !$FileHandle;
close $FileHandle;
}
File::Temp::cleanup();
return 1;
}
1;
=head1 TERMS AND CONDITIONS
This software is part of the OTRS project (L<https://otrs.org/>).
This software comes with ABSOLUTELY NO WARRANTY. For details, see
the enclosed file COPYING for license information (GPL). If you
did not receive this file, see L<https://www.gnu.org/licenses/gpl-3.0.txt>.
=cut
|
