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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
# --
# 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::Web::UploadCache;
use strict;
use warnings;
our @ObjectDependencies = (
'Kernel::Config',
);
=head1 NAME
Kernel::System::Web::UploadCache - an upload file system cache
=head1 DESCRIPTION
All upload cache functions.
=head1 PUBLIC INTERFACE
=head2 new()
Don't use the constructor directly, use the ObjectManager instead:
my $WebUploadCacheObject = $Kernel::OM->Get('Kernel::System::Web::UploadCache');
=cut
sub new {
my ( $Type, %Param ) = @_;
# allocate new hash for object
my $Self = {};
bless( $Self, $Type );
my $GenericModule = $Kernel::OM->Get('Kernel::Config')->Get('WebUploadCacheModule')
|| 'Kernel::System::Web::UploadCache::DB';
# load generator auth module
$Self->{Backend} = $Kernel::OM->Get($GenericModule);
return $Self if $Self->{Backend};
return;
}
=head2 FormIDCreate()
create a new Form ID
my $FormID = $UploadCacheObject->FormIDCreate();
=cut
sub FormIDCreate {
my ( $Self, %Param ) = @_;
return $Self->{Backend}->FormIDCreate(%Param);
}
=head2 FormIDRemove()
remove all data for a provided Form ID
$UploadCacheObject->FormIDRemove( FormID => 123456 );
=cut
sub FormIDRemove {
my ( $Self, %Param ) = @_;
return $Self->{Backend}->FormIDRemove(%Param);
}
=head2 FormIDAddFile()
add a file to a Form ID
$UploadCacheObject->FormIDAddFile(
FormID => 12345,
Filename => 'somefile.html',
Content => $FileInString,
ContentType => 'text/html',
Disposition => 'inline', # optional
);
ContentID is optional (automatically generated if not given on disposition = inline)
$UploadCacheObject->FormIDAddFile(
FormID => 12345,
Filename => 'somefile.html',
Content => $FileInString,
ContentID => 'some_id@example.com',
ContentType => 'text/html',
Disposition => 'inline', # optional
);
=cut
sub FormIDAddFile {
my ( $Self, %Param ) = @_;
return $Self->{Backend}->FormIDAddFile(%Param);
}
=head2 FormIDRemoveFile()
removes a file from a form id
$UploadCacheObject->FormIDRemoveFile(
FormID => 12345,
FileID => 1,
);
=cut
sub FormIDRemoveFile {
my ( $Self, %Param ) = @_;
return $Self->{Backend}->FormIDRemoveFile(%Param);
}
=head2 FormIDGetAllFilesData()
returns an array with a hash ref of all files for a Form ID
my @Data = $UploadCacheObject->FormIDGetAllFilesData(
FormID => 12345,
);
Return data of on hash is Content, ContentType, ContentID, Filename, Filesize, FileID;
=cut
sub FormIDGetAllFilesData {
my ( $Self, %Param ) = @_;
return @{ $Self->{Backend}->FormIDGetAllFilesData(%Param) };
}
=head2 FormIDGetAllFilesMeta()
returns an array with a hash ref of all files for a Form ID
Note: returns no content, only meta data.
my @Data = $UploadCacheObject->FormIDGetAllFilesMeta(
FormID => 12345,
);
Return data of hash is ContentType, ContentID, Filename, Filesize, FileID;
=cut
sub FormIDGetAllFilesMeta {
my ( $Self, %Param ) = @_;
return @{ $Self->{Backend}->FormIDGetAllFilesMeta(%Param) };
}
=head2 FormIDCleanUp()
Removed no longer needed temporary files.
Each file older than 1 day will be removed.
$UploadCacheObject->FormIDCleanUp();
=cut
sub FormIDCleanUp {
my ( $Self, %Param ) = @_;
return $Self->{Backend}->FormIDCleanUp(%Param);
}
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
|
