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
194
195
196
197
198
199
200
201
202
203
|
# --
# Kernel/System/Cache.pm - all cache functions
# Copyright (C) 2001-2007 OTRS GmbH, http://otrs.org/
# --
# $Id: Cache.pm,v 1.3.2.1 2007/10/22 16:09:42 martin Exp $
# --
# 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 http://www.gnu.org/licenses/gpl.txt.
# --
package Kernel::System::Cache;
use strict;
use warnings;
use vars qw(@ISA $VERSION);
$VERSION = '$Revision: 1.3.2.1 $';
$VERSION =~ s/^\$.*:\W(.*)\W.+?$/$1/;
=head1 NAME
Kernel::System::Cache - valid lib
=head1 SYNOPSIS
All cache functions.
=head1 PUBLIC INTERFACE
=over 4
=cut
=item new()
create a object
use Kernel::Config;
use Kernel::System::Log;
use Kernel::System::Main;
use Kernel::System::Cache;
my $ConfigObject = Kernel::Config->new();
my $LogObject = Kernel::System::Log->new(
ConfigObject => $ConfigObject,
);
my $MainObject = Kernel::System::Main->new(
ConfigObject => $ConfigObject,
LogObject => $LogObject,
);
my $CacheObject = Kernel::System::Cache->new(
ConfigObject => $ConfigObject,
LogObject => $LogObject,
MainObject => $MainObject,
);
=cut
sub new {
my $Type = shift;
my %Param = @_;
# allocate new hash for object
my $Self = {};
bless ($Self, $Type);
# 0=off; 1=set+get_cache; 2=+delete+get_request;
$Self->{Debug} = $Param{Debug} || 0;
# check needed objects
foreach (qw(MainObject ConfigObject LogObject)) {
$Self->{$_} = $Param{$_} || die "Got no $_!";
}
# cache backend
my $CacheModule = $Self->{ConfigObject}->Get('Cache::Module')
|| 'Kernel::System::Cache::File';
if (!$Self->{MainObject}->Require($CacheModule)) {
die "Can't load backend module $CacheModule! $@";
}
$Self->{CacheObject} = $CacheModule->new(%Param);
return $Self;
}
=item Set()
set a new cache
$CacheObject->Set(
Key => 'SomeKey',
Value => 'Some Value',
TTL => 24*60*60, # in sec. in this case 24h
);
=cut
sub Set {
my $Self = shift;
my %Param = @_;
foreach (qw(Key Value)) {
if (!defined($Param{$_})) {
$Self->{LogObject}->Log(Priority => 'error', Message => "Need $_!");
return;
}
}
# debug
if ($Self->{Debug} > 0) {
$Self->{LogObject}->Log(
Priority => 'notice',
Message => "Set Key:$Param{Key} TTL:$Param{TTL}!",
);
}
return $Self->{CacheObject}->Set(%Param);
}
=item Get()
return a cache
my $Value = $CacheObject->Get(
Key => 'SomeKey',
);
=cut
sub Get {
my $Self = shift;
my %Param = @_;
# check needed stuff
foreach (qw(Key)) {
if (!$Param{$_}) {
$Self->{LogObject}->Log(Priority => 'error', Message => "Need $_!");
return;
}
}
# debug
if ($Self->{Debug} > 1) {
$Self->{LogObject}->Log(
Priority => 'notice',
Message => "Get Key:$Param{Key}!",
);
}
my $Value = $Self->{CacheObject}->Get(%Param);
if (defined($Value)) {
if ($Self->{Debug} > 0) {
$Self->{LogObject}->Log(
Priority => 'notice',
Message => "Get cached Key:$Param{Key}!",
);
}
}
return $Value;
}
=item Delete()
delete a cache
$CacheObject->Delete(
Key => 'SomeKey',
);
=cut
sub Delete {
my $Self = shift;
my %Param = @_;
# check needed stuff
foreach (qw(Key)) {
if (!$Param{$_}) {
$Self->{LogObject}->Log(Priority => 'error', Message => "Need $_!");
return;
}
}
# debug
if ($Self->{Debug} > 1) {
$Self->{LogObject}->Log(
Priority => 'notice',
Message => "Delete Key:$Param{Key}!",
);
}
return $Self->{CacheObject}->Delete(%Param);
}
1;
=back
=head1 TERMS AND CONDITIONS
This Software is part of the OTRS project (http://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 http://www.gnu.org/licenses/gpl.txt.
=cut
=head1 VERSION
$Revision: 1.3.2.1 $ $Date: 2007/10/22 16:09:42 $
=cut
|
