init III
This commit is contained in:
254
Perl OTRS/Kernel/System/Lock.pm
Normal file
254
Perl OTRS/Kernel/System/Lock.pm
Normal file
@@ -0,0 +1,254 @@
|
||||
# --
|
||||
# Copyright (C) 2001-2019 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::Lock;
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
our @ObjectDependencies = (
|
||||
'Kernel::Config',
|
||||
'Kernel::System::Cache',
|
||||
'Kernel::System::DB',
|
||||
'Kernel::System::Log',
|
||||
'Kernel::System::Valid',
|
||||
);
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Kernel::System::Lock - lock lib
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
All lock functions.
|
||||
|
||||
The whole lock API is just for "reading" lock states. By default, there is "unlock", "lock" and "lock-tmp".
|
||||
Usually you would not modify those lock states, because there is no use case for this.
|
||||
|
||||
=head1 PUBLIC INTERFACE
|
||||
|
||||
=head2 new()
|
||||
|
||||
create an object
|
||||
|
||||
my $LockObject = $Kernel::OM->Get('Kernel::System::Lock');
|
||||
|
||||
=cut
|
||||
|
||||
sub new {
|
||||
my ( $Type, %Param ) = @_;
|
||||
|
||||
# allocate new hash for object
|
||||
my $Self = {};
|
||||
bless( $Self, $Type );
|
||||
|
||||
$Self->{CacheType} = 'Lock';
|
||||
$Self->{CacheTTL} = 60 * 60 * 24 * 20;
|
||||
|
||||
$Self->{ViewableLocks} = $Kernel::OM->Get('Kernel::Config')->Get('Ticket::ViewableLocks')
|
||||
|| die 'No Config entry "Ticket::ViewableLocks"!';
|
||||
|
||||
return $Self;
|
||||
}
|
||||
|
||||
=head2 LockViewableLock()
|
||||
|
||||
get list of view-able lock types (used to show available tickets)
|
||||
|
||||
my @List = $LockObject->LockViewableLock(
|
||||
Type => 'Name', # ID|Name
|
||||
);
|
||||
|
||||
Returns:
|
||||
|
||||
@List = ( 'unlock', 'lock', 'lock-tmp' );
|
||||
|
||||
my @ListID = $LockObject->LockViewableLock(
|
||||
Type => 'ID', # ID|Name
|
||||
);
|
||||
|
||||
Returns:
|
||||
|
||||
@List = ( 1, 2, 3 );
|
||||
|
||||
=cut
|
||||
|
||||
sub LockViewableLock {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
for (qw(Type)) {
|
||||
if ( !$Param{$_} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "Need $_!"
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
# check cache
|
||||
my $CacheKey = 'LockViewableLock::' . $Param{Type};
|
||||
my $Cache = $Kernel::OM->Get('Kernel::System::Cache')->Get(
|
||||
Type => $Self->{CacheType},
|
||||
TTL => $Self->{CacheTTL},
|
||||
Key => $CacheKey,
|
||||
);
|
||||
return @{$Cache} if $Cache;
|
||||
|
||||
# sql
|
||||
return if !$Kernel::OM->Get('Kernel::System::DB')->Prepare(
|
||||
SQL => "
|
||||
SELECT id, name
|
||||
FROM ticket_lock_type
|
||||
WHERE name IN ( ${\(join ', ', @{$Self->{ViewableLocks}})} )
|
||||
AND valid_id IN ( ${\(join ', ', $Kernel::OM->Get('Kernel::System::Valid')->ValidIDsGet())} )",
|
||||
);
|
||||
|
||||
my @Name;
|
||||
my @ID;
|
||||
while ( my @Data = $Kernel::OM->Get('Kernel::System::DB')->FetchrowArray() ) {
|
||||
push @Name, $Data[1];
|
||||
push @ID, $Data[0];
|
||||
}
|
||||
|
||||
# set cache
|
||||
$Kernel::OM->Get('Kernel::System::Cache')->Set(
|
||||
Type => $Self->{CacheType},
|
||||
TTL => $Self->{CacheTTL},
|
||||
Key => 'LockViewableLock::Name',
|
||||
Value => \@Name,
|
||||
);
|
||||
$Kernel::OM->Get('Kernel::System::Cache')->Set(
|
||||
Type => $Self->{CacheType},
|
||||
TTL => $Self->{CacheTTL},
|
||||
Key => 'LockViewableLock::ID',
|
||||
Value => \@ID,
|
||||
);
|
||||
|
||||
return @Name if $Param{Type} eq 'Name';
|
||||
return @ID;
|
||||
}
|
||||
|
||||
=head2 LockLookup()
|
||||
|
||||
lock state lookup by ID or Name
|
||||
|
||||
my $LockID = $LockObject->LockLookup( Lock => 'lock' );
|
||||
|
||||
my $Lock = $LockObject->LockLookup( LockID => 2 );
|
||||
|
||||
=cut
|
||||
|
||||
sub LockLookup {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# get (already cached) lock list
|
||||
my %LockList = $Self->LockList(
|
||||
UserID => 1,
|
||||
);
|
||||
|
||||
my $Key;
|
||||
my $Value;
|
||||
my $ReturnData;
|
||||
if ( $Param{LockID} ) {
|
||||
$Key = 'LockID';
|
||||
$Value = $Param{LockID};
|
||||
$ReturnData = $LockList{ $Param{LockID} };
|
||||
}
|
||||
else {
|
||||
$Key = 'Lock';
|
||||
$Value = $Param{Lock};
|
||||
my %LockListReverse = reverse %LockList;
|
||||
$ReturnData = $LockListReverse{ $Param{Lock} };
|
||||
}
|
||||
|
||||
# check if data exists
|
||||
if ( !defined $ReturnData ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => "No $Key for $Value found!",
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
return $ReturnData;
|
||||
}
|
||||
|
||||
=head2 LockList()
|
||||
|
||||
get lock state list
|
||||
|
||||
my %List = $LockObject->LockList(
|
||||
UserID => 123,
|
||||
);
|
||||
|
||||
Returns:
|
||||
|
||||
%List = (
|
||||
1 => 'unlock',
|
||||
2 => 'lock',
|
||||
3 => 'tmp_lock',
|
||||
);
|
||||
|
||||
=cut
|
||||
|
||||
sub LockList {
|
||||
my ( $Self, %Param ) = @_;
|
||||
|
||||
# check needed stuff
|
||||
if ( !$Param{UserID} ) {
|
||||
$Kernel::OM->Get('Kernel::System::Log')->Log(
|
||||
Priority => 'error',
|
||||
Message => 'UserID!'
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
# check cache
|
||||
my $CacheKey = 'LockList';
|
||||
my $Cache = $Kernel::OM->Get('Kernel::System::Cache')->Get(
|
||||
Type => $Self->{CacheType},
|
||||
TTL => $Self->{CacheTTL},
|
||||
Key => $CacheKey,
|
||||
);
|
||||
return %{$Cache} if $Cache;
|
||||
|
||||
# sql
|
||||
return if !$Kernel::OM->Get('Kernel::System::DB')->Prepare(
|
||||
SQL => 'SELECT id, name FROM ticket_lock_type',
|
||||
);
|
||||
|
||||
# fetch the result
|
||||
my %Data;
|
||||
while ( my @Row = $Kernel::OM->Get('Kernel::System::DB')->FetchrowArray() ) {
|
||||
$Data{ $Row[0] } = $Row[1];
|
||||
}
|
||||
|
||||
# set cache
|
||||
$Kernel::OM->Get('Kernel::System::Cache')->Set(
|
||||
Type => $Self->{CacheType},
|
||||
TTL => $Self->{CacheTTL},
|
||||
Key => $CacheKey,
|
||||
Value => \%Data,
|
||||
);
|
||||
|
||||
return %Data;
|
||||
}
|
||||
|
||||
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
|
||||
Reference in New Issue
Block a user