422 lines
9.4 KiB
Perl
422 lines
9.4 KiB
Perl
package WebGUI::AdminConsole;
|
|
|
|
=head1 LEGAL
|
|
|
|
-------------------------------------------------------------------
|
|
WebGUI is Copyright 2001-2004 Plain Black Corporation.
|
|
-------------------------------------------------------------------
|
|
Please read the legal notices (docs/legal.txt) and the license
|
|
(docs/license.txt) that came with this distribution before using
|
|
this software.
|
|
-------------------------------------------------------------------
|
|
http://www.plainblack.com info@plainblack.com
|
|
-------------------------------------------------------------------
|
|
|
|
=cut
|
|
|
|
use strict;
|
|
use WebGUI::Grouping;
|
|
use WebGUI::International;
|
|
use WebGUI::Session;
|
|
use WebGUI::Style;
|
|
use WebGUI::Asset::Template;
|
|
use WebGUI::URL;
|
|
|
|
=head1 NAME
|
|
|
|
Package WebGUI::Asset
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Package to manipulate items in WebGUI's asset system. Replaces Collateral.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
An asset is the basic class of content in WebGUI. This handles security, urls, and other basic information common to all content items.
|
|
|
|
A lineage is a concatenated series of sequence numbers, each six digits long, that explain an asset's position in its familiy tree. Lineage describes who the asset's anscestors are, how many ancestors the asset has in its family tree (lineage length), and the asset's position (rank) amongst its siblings. In addition, lineage provides enough information about an asset to generate a list of its siblings and descendants.
|
|
|
|
use WebGUI::Asset;
|
|
|
|
_formatFunction
|
|
addSubmenuItem
|
|
getAdminConsoleParams
|
|
getAdminFunction
|
|
new
|
|
render
|
|
setHelp
|
|
setIcon
|
|
|
|
=head1 METHODS
|
|
|
|
These methods are available from this class:
|
|
|
|
=cut
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 _formatFunction ( function )
|
|
|
|
Returns a Hash of title, icon, url, and canUse. title is the Internationalized title of the function. icon is the function icon, currently in extras/adminConsole/. url is current page with func= or op= depending on if the function is a function or operation. canUse checks if the current user is in the function group.
|
|
|
|
=head3 function
|
|
|
|
A hash ref to a function. Required.
|
|
|
|
=cut
|
|
|
|
sub _formatFunction {
|
|
my $self = shift;
|
|
my $function = shift;
|
|
my $url;
|
|
if (exists $function->{func}) {
|
|
$url = WebGUI::URL::page("func=".$function->{func});
|
|
} else {
|
|
$url = WebGUI::URL::page("op=".$function->{op});
|
|
}
|
|
return {
|
|
title=>WebGUI::International::get($function->{title}{id}, $function->{title}{namespace}),
|
|
icon=>$session{config}{extrasURL}."/adminConsole/".$function->{icon},
|
|
url=>$url,
|
|
canUse=>WebGUI::Grouping::isInGroup($function->{group})
|
|
};
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 addSubmenuItem ( url, label, extras )
|
|
|
|
Puts params into the current AdminConsole submenu.
|
|
|
|
=head3 url
|
|
|
|
A string representing a URL.
|
|
|
|
=head3 label
|
|
|
|
A (hopefully informative) string.
|
|
|
|
=head3 extras
|
|
|
|
Additional information.
|
|
|
|
=cut
|
|
|
|
sub addSubmenuItem {
|
|
my $self = shift;
|
|
my $url = shift;
|
|
my $label = shift;
|
|
my $extras = shift;
|
|
push (@{$self->{_submenuItem}}, {
|
|
url=>$url,
|
|
label=>$label,
|
|
extras=>$extras
|
|
});
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 getAdminConsoleParams ( )
|
|
|
|
Returns a Hash of title, url, canUse, and icon. title is the Internationalization of "Admin Console". url is the page with op=adminConsole, canUse checks if is in group 12. icon is image located in extras/adminConsole/adminConsole.gif.
|
|
|
|
=cut
|
|
|
|
sub getAdminConsoleParams {
|
|
return { 'title' => WebGUI::International::get("admin console","AdminConsole"),
|
|
url => WebGUI::URL::page("op=adminConsole"),
|
|
canUse => WebGUI::Grouping::isInGroup("12"),
|
|
icon => $session{config}{extrasURL}."/adminConsole/adminConsole.gif"
|
|
};
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 getAdminFunction ( [id] )
|
|
|
|
Returns _formatFunction list of available AdminFunctions.
|
|
|
|
=head3 id
|
|
|
|
If present, returns a _formatFunction hash based upon the given parameter.
|
|
|
|
=cut
|
|
|
|
sub getAdminFunction {
|
|
my $self = shift;
|
|
my $id = shift;
|
|
my $functions = { # at some point in the future we'll need to make this pluggable/configurable
|
|
"assets"=>{
|
|
title=>{
|
|
id=>"assets",
|
|
namespace=>"Asset"
|
|
},
|
|
icon=>"assets.gif",
|
|
func=>"manageAssets",
|
|
group=>"12"
|
|
},
|
|
"users"=>{
|
|
title=>{
|
|
id=>"149",
|
|
namespace=>"WebGUI"
|
|
},
|
|
icon=>"users.gif",
|
|
op=>"listUsers",
|
|
group=>"11"
|
|
},
|
|
"clipboard"=>{
|
|
title=>{
|
|
id=>"948",
|
|
namespace=>"WebGUI"
|
|
},
|
|
icon=>"clipboard.gif",
|
|
func=>"manageClipboard",
|
|
group=>"12"
|
|
},
|
|
"trash"=>{
|
|
title=>{
|
|
id=>"trash",
|
|
namespace=>"WebGUI"
|
|
},
|
|
icon=>"trash.gif",
|
|
func=>"manageTrash",
|
|
group=>"4"
|
|
},
|
|
"databases"=>{
|
|
title=>{
|
|
id=>"databases",
|
|
namespace=>"WebGUI"
|
|
},
|
|
icon=>"databases.gif",
|
|
op=>"listDatabaseLinks",
|
|
group=>"3"
|
|
},
|
|
"groups"=>{
|
|
title=>{
|
|
id=>"89",
|
|
namespace=>"WebGUI"
|
|
},
|
|
icon=>"groups.gif",
|
|
op=>"listGroups",
|
|
group=>"11"
|
|
},
|
|
"settings"=>{
|
|
title=>{
|
|
id=>"settings",
|
|
namespace=>"WebGUI"
|
|
},
|
|
icon=>"settings.gif",
|
|
op=>"editSettings",
|
|
group=>"3"
|
|
},
|
|
"themes"=>{
|
|
title=>{
|
|
id=>"themes",
|
|
namespace=>"WebGUI"
|
|
},
|
|
icon=>"themes.gif",
|
|
op=>"listThemes",
|
|
group=>"9"
|
|
},
|
|
"help"=>{
|
|
title=>{
|
|
id=>"help",
|
|
namespace=>"WebGUI"
|
|
},
|
|
icon=>"help.gif",
|
|
op=>"viewHelpIndex",
|
|
group=>"12"
|
|
},
|
|
"statistics"=>{
|
|
title=>{
|
|
id=>"437",
|
|
namespace=>"WebGUI"
|
|
},
|
|
icon=>"statistics.gif",
|
|
op=>"viewStatistics",
|
|
group=>"12"
|
|
},
|
|
"contentProfiling"=>{
|
|
title=>{
|
|
id=>"content profiling",
|
|
namespace=>"Asset"
|
|
},
|
|
icon=>"contentProfiling.gif",
|
|
func=>"manageMetaData",
|
|
group=>"4"
|
|
},
|
|
"contentFilters"=>{
|
|
title=>{
|
|
id=>"content filters",
|
|
namespace=>"WebGUI"
|
|
},
|
|
icon=>"contentFilters.gif",
|
|
op=>"listReplacements",
|
|
group=>"4"
|
|
},
|
|
"userProfiling"=>{
|
|
title=>{
|
|
id=>"user profiling",
|
|
namespace=>"WebGUIProfile"
|
|
},
|
|
icon=>"userProfiling.gif",
|
|
op=>"editProfileSettings",
|
|
group=>"3"
|
|
},
|
|
"loginHistory"=>{
|
|
title=>{
|
|
id=>"426",
|
|
namespace=>"WebGUI"
|
|
},
|
|
icon=>"loginHistory.gif",
|
|
op=>"viewLoginHistory",
|
|
group=>"3"
|
|
},
|
|
"activeSessions"=>{
|
|
title=>{
|
|
id=>"425",
|
|
namespace=>"WebGUI"
|
|
},
|
|
icon=>"activeSessions.gif",
|
|
op=>"viewActiveSessions",
|
|
group=>"3"
|
|
},
|
|
"commerce"=>{
|
|
title=>{
|
|
id=>"commerce settings",
|
|
namespace=>"Commerce"
|
|
},
|
|
icon=>"commerce.gif",
|
|
op=>"editCommerceSettings",
|
|
group=>"3"
|
|
},
|
|
"subscriptions"=>{
|
|
title=>{
|
|
id=>"manage subscriptions",
|
|
namespace=>"Subscription"
|
|
},
|
|
icon=>"subscriptions.gif",
|
|
op=>"listSubscriptions",
|
|
group=>"3"
|
|
},
|
|
};
|
|
if ($id) {
|
|
return $self->_formatFunction($functions->{$id});
|
|
} else {
|
|
my %names;
|
|
foreach my $id (keys %{$functions}) {
|
|
my $func = $self->_formatFunction($functions->{$id});
|
|
$names{$func->{title}} = $func;
|
|
}
|
|
my @sorted = sort {$a cmp $b} keys %names;
|
|
my @list;
|
|
foreach my $key (@sorted) {
|
|
push(@list,$names{$key});
|
|
}
|
|
return \@list;
|
|
}
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 new ( [id] )
|
|
|
|
Constructor.
|
|
|
|
=head3 id
|
|
|
|
If supplied, updates the _function of the AdminFunction.
|
|
|
|
=cut
|
|
|
|
sub new {
|
|
my $class = shift;
|
|
my $id = shift;
|
|
my %self;
|
|
$self{_function} = $class->getAdminFunction($id) if ($id);
|
|
bless \%self, $class;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 render ( application.workarea [,application.title] )
|
|
|
|
Prepares internationalization of variables. Returns a Style-processed AdminConsole.
|
|
|
|
=head3 application.workarea
|
|
|
|
=head3 application.title
|
|
|
|
A string that defaults to _function's title.
|
|
|
|
=cut
|
|
|
|
sub render {
|
|
my $self = shift;
|
|
my %var;
|
|
$var{"application.workarea"} = shift;
|
|
$var{"application.title"} = shift || $self->{_function}{title};
|
|
$var{"backtosite.label"} = WebGUI::International::get("493");
|
|
$var{"toggle.on.label"} = WebGUI::International::get("toggle on", "AdminConsole");
|
|
$var{"toggle.off.label"} = WebGUI::International::get("toggle off","AdminConsole");
|
|
$var{"application.icon"} = $self->{_function}{icon};
|
|
$var{"application.canUse"} = $self->{_function}{canUse};
|
|
$var{"application.url"} = $self->{_function}{url};
|
|
if (exists $self->{_submenuItem}) {
|
|
$var{submenu_loop} = $self->{_submenuItem};
|
|
}
|
|
my $acParams = $self->getAdminConsoleParams;
|
|
$var{"console.title"} = $acParams->{title};
|
|
$var{"console.url"} = $acParams->{url};
|
|
$var{"console.canUse"} = $acParams->{canUse};
|
|
$var{"console.icon"} = $acParams->{icon};
|
|
$var{"help.url"} = $self->{_helpUrl};
|
|
$var{"application_loop"} = $self->getAdminFunction;
|
|
return WebGUI::Style::process(WebGUI::Asset::Template->new($session{setting}{AdminConsoleTemplate})->process(\%var),"PBtmpl0000000000000137");
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 setHelp ( id[,namespace] )
|
|
|
|
Sets the _helpUrl to the urlized page.
|
|
|
|
=head3 id
|
|
|
|
If not provided, this method does nothing.
|
|
|
|
=head3 namespace
|
|
|
|
A string representing the namespace of the Help. Defaults to "WebGUI" as a namespace.
|
|
|
|
=cut
|
|
|
|
sub setHelp {
|
|
my $self = shift;
|
|
my $id = shift;
|
|
my $namespace = shift || "WebGUI";
|
|
$self->{_helpUrl} = WebGUI::URL::page('op=viewHelp&hid='.$id.'&namespace='.$namespace) if ($id);
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 setIcon ( icon)
|
|
|
|
Sets the _function icon to parameter.
|
|
|
|
=head3 icon
|
|
|
|
A string representing the location of the icon.
|
|
|
|
=cut
|
|
|
|
sub setIcon {
|
|
my $self = shift;
|
|
my $icon = shift;
|
|
if ($icon) {
|
|
$self->{_function}{icon} = $icon;
|
|
}
|
|
}
|
|
|
|
1;
|
|
|