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
|
# --
# 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::Output::HTML::NavBar::ModuleAdmin;
use parent 'Kernel::Output::HTML::Base';
use strict;
use warnings;
use Unicode::Collate::Locale;
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::Output::HTML::Layout',
'Kernel::System::Group',
'Kernel::System::JSON',
'Kernel::System::User',
);
sub Run {
my ( $Self, %Param ) = @_;
# get layout object
my $LayoutObject = $Kernel::OM->Get('Kernel::Output::HTML::Layout');
# only show it on admin start screen
return '' if $LayoutObject->{Action} ne 'Admin';
# get config object
my $ConfigObject = $Kernel::OM->Get('Kernel::Config');
# generate manual link
my $ManualVersion = $ConfigObject->Get('Version');
$ManualVersion =~ m{^(\d{1,2}).+};
$ManualVersion = $1;
# get all Frontend::Module
my %NavBarModule;
my $Config = $ConfigObject->Get('Frontend::Module') || {};
my $NavigationModule = $ConfigObject->Get('Frontend::NavigationModule') || {};
MODULE:
for my $Module ( sort keys %{$NavigationModule} ) {
my %Hash = %{ $NavigationModule->{$Module} };
next MODULE if !$Hash{Name};
next MODULE if !$Config->{$Module}; # If module is not registered, skip it.
if ( $Hash{Module} eq 'Kernel::Output::HTML::NavBar::ModuleAdmin' ) {
# check permissions (only show accessable modules)
my $Shown = 0;
my $GroupObject = $Kernel::OM->Get('Kernel::System::Group');
for my $Permission (qw(GroupRo Group)) {
# no access restriction
if (
ref $Hash{GroupRo} eq 'ARRAY'
&& !scalar @{ $Hash{GroupRo} }
&& ref $Hash{Group} eq 'ARRAY'
&& !scalar @{ $Hash{Group} }
)
{
$Shown = 1;
}
# array access restriction
elsif ( $Hash{$Permission} && ref $Hash{$Permission} eq 'ARRAY' ) {
for my $Group ( @{ $Hash{$Permission} } ) {
my $HasPermission = $GroupObject->PermissionCheck(
UserID => $Self->{UserID},
GroupName => $Group,
Type => $Permission eq 'GroupRo' ? 'ro' : 'rw',
);
if ($HasPermission) {
$Shown = 1;
}
}
}
}
next MODULE if !$Shown;
$NavBarModule{$Module} = {
'Frontend::Module' => $Module,
%Hash,
};
}
}
# get modules which were marked as favorite by the current user
my %UserPreferences = $Kernel::OM->Get('Kernel::System::User')->GetPreferences(
UserID => $Self->{UserID},
);
my @Favourites;
my @FavouriteModules;
my $PrefFavourites = $Kernel::OM->Get('Kernel::System::JSON')->Decode(
Data => $UserPreferences{AdminNavigationBarFavourites},
) || [];
@Favourites = sort {
$LayoutObject->{LanguageObject}->Translate( $a->{Name} )
cmp $LayoutObject->{LanguageObject}->Translate( $b->{Name} )
} @Favourites;
my @ModuleGroups;
my $ModuleGroupsConfig = $ConfigObject->Get('Frontend::AdminModuleGroups');
# get all registered groups
for my $Group ( sort keys %{$ModuleGroupsConfig} ) {
for my $Key ( sort keys %{ $ModuleGroupsConfig->{$Group} } ) {
push @ModuleGroups, {
'Key' => $Key,
'Order' => $ModuleGroupsConfig->{$Group}->{$Key}->{Order},
'Title' => $ModuleGroupsConfig->{$Group}->{$Key}->{Title},
};
}
}
# sort groups by order number
@ModuleGroups = sort { $a->{Order} <=> $b->{Order} } @ModuleGroups;
my %Modules;
ITEMS:
for my $Module ( sort keys %NavBarModule ) {
# dont show the admin overview as a tile
next ITEMS if ( $NavBarModule{$Module}->{'Link'} && $NavBarModule{$Module}->{'Link'} eq 'Action=Admin' );
if ( grep { $_ eq $Module } @{$PrefFavourites} ) {
push @Favourites, $NavBarModule{$Module};
$NavBarModule{$Module}->{IsFavourite} = 1;
}
# add the item to its Block
my $Block = $NavBarModule{$Module}->{'Block'} || 'Miscellaneous';
if ( !grep { $_->{Key} eq $Block } @ModuleGroups ) {
$Block = 'Miscellaneous';
}
push @{ $Modules{$Block} }, $NavBarModule{$Module};
}
# Create collator according to the user chosen language.
my $Collator = Unicode::Collate::Locale->new(
locale => $LayoutObject->{LanguageObject}->{UserLanguage},
);
@Favourites = sort {
$Collator->cmp(
$LayoutObject->{LanguageObject}->Translate( $a->{Name} ),
$LayoutObject->{LanguageObject}->Translate( $b->{Name} )
)
} @Favourites;
for my $Favourite (@Favourites) {
push @FavouriteModules, $Favourite->{'Frontend::Module'};
}
# Sort the items within the groups.
for my $Block ( sort keys %Modules ) {
for my $Entry ( @{ $Modules{$Block} } ) {
$Entry->{NameTranslated} = $LayoutObject->{LanguageObject}->Translate( $Entry->{Name} );
}
@{ $Modules{$Block} }
= sort { $Collator->cmp( $a->{NameTranslated}, $b->{NameTranslated} ) } @{ $Modules{$Block} };
}
$LayoutObject->Block(
Name => 'AdminNavBar',
Data => {
ManualVersion => $ManualVersion,
Items => \%Modules,
Groups => \@ModuleGroups,
Favourites => \@Favourites,
},
);
$LayoutObject->AddJSData(
Key => 'Favourites',
Value => \@FavouriteModules,
);
my $Output = $LayoutObject->Output(
TemplateFile => 'AdminNavigationBar',
Data => \%Param,
);
return $Output;
}
1;
|