webgui/lib/WebGUI/Asset/Wobject/Dashboard.pm
2011-12-28 11:30:38 -08:00

632 lines
23 KiB
Perl

package WebGUI::Asset::Wobject::Dashboard;
#-------------------------------------------------------------------
# WebGUI is Copyright 2001-2012 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
#-------------------------------------------------------------------
use strict;
use WebGUI::International;
use WebGUI::ProfileField;
use Time::HiRes;
use WebGUI::Asset::Wobject;
use Moose;
use WebGUI::Definition::Asset;
extends 'WebGUI::Asset::Wobject';
define assetName => [ 'assetName', 'Asset_Dashboard' ];
define icon => 'dashboard.gif';
define tableName => 'Dashboard';
property templateId => (
fieldType => "template",
default => 'DashboardViewTmpl00001',
namespace => "Dashboard",
tab => 'display',
label => [ 'dashboard template field label', 'Asset_Dashboard' ],
hoverHelp => [ 'dashboard template description', 'Asset_Dashboard' ],
);
property adminsGroupId => (
fieldType => "group",
default => '4',
tab => 'security',
label => [ 'dashboard adminsGroupId field label', 'Asset_Dashboard' ],
hoverHelp => [ 'dashboard adminsGroupId description', 'Asset_Dashboard' ],
);
property usersGroupId => (
fieldType => "group",
default => '2',
label => [ 'dashboard usersGroupId field label', 'Asset_Dashboard' ],
hoverHelp => [ 'dashboard usersGroupId description', 'Asset_Dashboard' ],
);
property isInitialized => (
fieldType => "yesNo",
default => 0,
noFormPost => 1,
);
property assetsToHide => (
default => undef,
fieldType => "checkList",
noFormPost => \&_assetsToHide_noFormPost,
label => [ 'assets to hide', 'Asset_Dashboard' ],
hoverHelp => [ 'assets to hide description', 'Asset_Dashboard' ],
vertical => 1,
uiLevel => 9,
options => \&_assetsToHide_options,
);
sub _assetsToHide_noFormPost {
my $self = shift;
return $self->session->form->process("func") eq "add" ? 1 : 0;
}
sub _assetsToHide_options {
my $self = shift;
my $session = $self->session;
my $children = $self->getLineage(["children"],{"returnObjects"=>1, excludeClasses=>["WebGUI::Asset::Wobject::Layout"]});
my %childIds;
foreach my $child (@{$children}) {
$childIds{$child->getId} = $child->getTitle.' ['.ref($child).']';
}
return \%childIds;
}
#-------------------------------------------------------------------
=head2 canManage
Determines if the current user can manage this dashboard. Returns 0
if the user is visitor. Otherwise, it checks to see if the user is
in the dashboard's adminsGroup.
=cut
sub canManage {
my $self = shift;
return 0 if $self->session->user->isVisitor;
return $self->session->user->isInGroup($self->adminsGroupId);
}
#-------------------------------------------------------------------
=head2 canPersonalize
Determines if the current user can personalize this dashboard. Returns
0 if the user is visitor. Otherwise, it checks to see if the user is
in this dashboard's userGroup.
=cut
sub canPersonalize {
my $self = shift;
return 0 if $self->session->user->isVisitor;
return $self->session->user->isInGroup($self->usersGroupId);
}
#-------------------------------------------------------------------
=head2 discernUserId
This utility method is used to determine if the user should be shown the view of the
Dashboard that Visitor would see, or their own.
=cut
sub discernUserId {
my $self = shift;
return ($self->canManage && $self->session->isAdminOn) ? '1' : $self->session->user->userId;
}
#-------------------------------------------------------------------
=head2 getContentPositions
Gets the locations of content in the dashboard. If the user has not customized this,
then return default locations.
=cut
sub getContentPositions {
my $self = shift;
my $dummy = $self->initialize unless $self->isInitialized;
my $u = WebGUI::User->new($self->session, $self->discernUserId);
return $u->profileField($self->getContentPositionsId)
|| $self->getContentPositionsDefault;
}
#-------------------------------------------------------------------
=head2 getContentPositionsId
Return the unique contentPostitions ID for this Dashboard.
=cut
sub getContentPositionsId {
my $self = shift;
my $id = "contentPositions".$self->getId;
$id =~ s/-/_/g;
return $id;
}
#-------------------------------------------------------------------
=head2 getContentPositionsDefault ( )
Returns the default content positions for this Dashboard.
=cut
sub getContentPositionsDefault {
my $self = shift;
my $dummy = $self->initialize unless $self->isInitialized;
# The default positions are saved under the "Visitor" user
my $u = WebGUI::User->new($self->session, 1);
return $u->profileField($self->getContentPositionsId);
}
#-------------------------------------------------------------------
=head2 getEditForm
Extend the base method to display lists of assets to hide or show.
=cut
override getEditForm => sub {
my $self = shift;
my $tabform = super();
if ($self->session->form->process("func") ne "add") {
my $i18n = WebGUI::International->new($self->session, "Asset_Dashboard");
my @assetsToHide = split("\n",$self->assetsToHide);
my $childIter = $self->getLineageIterator(["children"],{excludeClasses=>["WebGUI::Asset::Wobject::Layout"]});
my %childIds;
while ( 1 ) {
my $child;
eval { $child = $childIter->() };
if ( my $x = WebGUI::Error->caught('WebGUI::Error::ObjectNotFound') ) {
$self->session->log->error($x->full_message);
next;
}
last unless $child;
$childIds{$child->getId} = $child->getTitle.' ['.ref($child).']';
}
$tabform->getTab("display")->addField( "checkList",
name=>"assetsToHide",
value=>\@assetsToHide,
options=>\%childIds,
label=>$i18n->get('assets to hide'),
hoverHelp=>$i18n->get('assets to hide description'),
vertical=>1,
uiLevel=>9
);
}
return $tabform;
};
#-------------------------------------------------------------------
=head2 initialize
Add the unique profile field that holds content positions for this dashboard.
=cut
sub initialize {
my $self = shift;
my $userPrefField = WebGUI::ProfileField->create($self->session,$self->getContentPositionsId,{
label=>'\'Dashboard User Preference - Content Positions\'',
visible=>0,
protected=>1,
editable=>0,
required=>0,
fieldType=>'textarea'
});
$self->update({isInitialized=>1});
}
#-------------------------------------------------------------------
=head2 isManaging
Returns true if the current user canManage this dashboard, and they have admin mode
turned on.
=cut
sub isManaging {
my $self = shift;
return 1 if ($self->canManage && $self->session->isAdminOn());
return 0;
}
#-------------------------------------------------------------------
=head2 prepareView
Extends the base method to set the extraHeadTags for all children, and to prepare
their templates.
=cut
override prepareView => sub {
my $self = shift;
super();
my @hidden = split("\n",$self->assetsToHide);
my $childIter = $self->getLineageIterator( ["children"], {excludeClasses=>["WebGUI::Asset::Wobject::Layout","WebGUI::Asset::Wobject::Dashboard"] });
while ( 1 ) {
my $child;
eval { $child = $childIter->() };
if ( my $x = WebGUI::Error->caught('WebGUI::Error::ObjectNotFound') ) {
$self->session->log->error($x->full_message);
next;
}
last unless $child;
unless ( $child->getId ~~ @hidden || !$child->canView) {
$self->session->style->setRawHeadTags($child->getExtraHeadTags);
$child->prepareView;
}
}
};
#-------------------------------------------------------------------
=head2 processEditForm
Extends the base method to handle assetsToHide.
=cut
override processEditForm => sub {
my $self = shift;
super();
if ($self->session->form->process("assetId") eq "new" && $self->session->form->process("class") eq 'WebGUI::Asset::Wobject::Dashboard') {
$self->initialize;
if (ref $self->getParent eq 'WebGUI::Asset::Wobject::Layout') {
$self->getParent->update({assetsToHide=>$self->getParent->assetsToHide."\n".$self->getId});
}
$self->update({styleTemplateId=>'PBtmplBlankStyle000001'});
}
};
#-------------------------------------------------------------------
=head2 purge
Extends the base method to handle deleting the profile field for storing content positions
for this dashboard.
=cut
override purge => sub {
my $self = shift;
my $userPrefField = WebGUI::ProfileField->new($self->session,$self->getContentPositionsId);
if (defined $userPrefField) {
$userPrefField->delete;
}
super();
};
#-------------------------------------------------------------------
=head2 view
Render the dashboard. Of all the positions for content, position1 is reserved for hidden content
or content to be placed. Deleting content causes it to go into position1.
=cut
sub view {
my $self = shift;
my $session = $self->session;
my %vars = %{$self->get()};
$vars{canEdit} = $self->canEdit;
$vars{fullUrl} = $self->getUrl;
$self->session->style->setScript( $self->session->url->extras('yui/build/utilities/utilities.js'));
my $templateId = $self->templateId;
# XXX Not using getLineageIterator because we loop over the children three times...
# I'm sure there's a more efficient way to do this. We'll figure it out someday.
my $children = $self->getLineage( ["children"], { returnObjects=>1, excludeClasses=>["WebGUI::Asset::Wobject::Layout","WebGUI::Asset::Wobject::Dashboard"] });
my @positions = split(/\./,$self->getContentPositions);
my @hidden = split("\n",$self->assetsToHide);
foreach my $child (@{$children}) {
push(@hidden,$child->shortcutToAssetId) if ref $child eq 'WebGUI::Asset::Shortcut';
#the following loop will initially place just-dashletted assets.
for (my $i = 0; $i < scalar(@positions); $i++) {
next unless $child->shortcutToAssetId ~~ @hidden;
my $newChildId = $child->getId;
my $oldChildId = $child->shortcutToAssetId;
$positions[$i] =~ s/${oldChildId}/${newChildId}/g;
}
}
my $i = 1;
my $templateAsset = WebGUI::Asset->newById($self->session, $templateId) || WebGUI::Asset->getImportNode($self->session);
my $template = $templateAsset->template;
my $numPositions = 1;
foreach my $j (2..15) {
$numPositions = $j if $template =~ m/position${j}\_loop/;
}
my @found;
my $newStuff;
my $showPerformance = $self->session->log->performanceLogger();
my $user = $self->session->user;
foreach my $position (@positions) {
my @assets = split(",",$position);
foreach my $asset (@assets) {
CHILD: foreach my $child (@{$children}) {
if ($asset eq $child->getId) {
push(@found, $child->getId);
##Filter based on visibility
next CHILD unless $child->canView;
next CHILD if $asset ~~ @hidden;
##Detect child types
my $is_shortcut = $child->isa('WebGUI::Asset::Shortcut');
my $is_dashlet = $child->can('getOverrideFormDefinition');
$self->session->style->setRawHeadTags($child->getExtraHeadTags);
##Override the title for shortcuts
if ($is_shortcut) {
$child->{_properties}{title} = $child->getShortcut->getTitle;
}
##Fetch dashlet options from the database
my $options = $session->db->quickHashRef('select * from Dashboard_dashlets where dashboardAssetId=? and dashletAssetId=?', [$self->getId, $child->getId]);
if (!($i == 1 || $i > $numPositions)) {
$child->prepareView;
}
my $spot = $i > $numPositions ? 1 : $i;
my $canMove = $self->canPersonalize && !$options->{isStatic};
my $editFormUrl = ($is_shortcut && $child->getPrefsFieldToShow) ? $child->getUrl('func=getUserPrefsForm')
: ($is_dashlet && $child->getOverrideFormDefinition) ? $self->getUrl('func=customizeDashlet;dashletAssetId='.$child->getId)
: ''
;
my $canEditUserPrefs = $user->isRegistered && $editFormUrl;
push(@{$vars{"position".$spot."_loop"}},{
id => $child->getId,
content => $child->view,
dashletTitle => $child->get('title'),
shortcutUrl => ($is_shortcut ? $child->getUrl : ''),
editFormUrl => $editFormUrl,
dashletUrl => ($is_dashlet ? $child->getUrl : ''),
canDelete => $self->canPersonalize && !$options->{isRequired},
canMove => $canMove,
canPersonalize => $self->canPersonalize,
showReloadIcon => $is_shortcut && $child->get('showReloadIcon'),
canEditUserPrefs => $canEditUserPrefs,
});
if ($canMove) {
$newStuff .= 'available_dashlets["'.$child->getId.'"]=\''.$child->getUrl.'\';';
}
}
}
}
$i++;
}
# deal with unplaced children, they go into position 1
foreach my $child (@{$children}) {
unless ($child->getId ~~ @found || $child->getId ~~ @hidden) {
if ($child->canView) {
my $is_shortcut = $child->isa('WebGUI::Asset::Shortcut');
my $is_dashlet = $child->can('getOverrideFormDefinition');
my $title = $child->{_properties}{title} = $is_shortcut ? $child->getShortcut->getTitle : $child->getTitle;
my $options = $session->db->quickHashRef('select * from Dashboard_dashlets where dashboardAssetId=? and dashletAssetId=?', [$self->getId, $child->getId]);
my $canMove = $self->canPersonalize && !$options->{isStatic};
my $editFormUrl = ($is_shortcut && $child->getPrefFieldsToShow) ? $child->getUrl('func=getUserPrefsForm')
: ($is_dashlet && $child->getOverrideFormDefinition) ? $self->getUrl('func=customizeDashlet;dashletAssetId='.$child->getId)
: ''
;
my $canEditUserPrefs = $user->isRegistered && $editFormUrl;
push(@{$vars{"position1_loop"}},{
id => $child->getId,
content => '',
dashletTitle => $title,
shortcutUrl => ($is_shortcut ? $child->getUrl : ''),
editFormUrl => $editFormUrl,
dashletUrl => ($is_dashlet ? $child->getUrl : ''),
canDelete => $self->canPersonalize && !$options->{isRequired},
canMove => $canMove,
canPersonalize => $self->canPersonalize,
showReloadIcon => $is_shortcut && $child->{_properties}{showReloadIcon},
canEditUserPrefs => $canEditUserPrefs,
});
$newStuff .= 'available_dashlets["'.$child->getId.'"]=\''.$child->getUrl.'\';';
}
}
}
$vars{showAdmin} = ($self->session->isAdminOn && $self->canEdit);
$vars{"dragger.init"} = '
<script type="text/javascript">
var available_dashlets= new Array();
'.$newStuff.'
dragable_init("'.$self->getUrl.'");
</script>
';
return $self->processTemplate(\%vars, $templateId);
}
#-------------------------------------------------------------------
=head2 www_customizeDashlet
Web facing method for saving per dashlet configuration, such as being required, or movable.
=cut
sub www_customizeDashlet {
my $self = shift;
my $session = $self->session;
return $session->privilege->insufficient() unless ($session->user->isRegistered);
my $dashletAssetId = $session->form->get('dashletAssetId');
my $dashlet = WebGUI::Asset->newById($session, $dashletAssetId);
return $session->privilege->insufficient() unless ($dashlet && $dashlet->canView && $dashlet->can('getOverrideFormDefinition'));
my $i18n = WebGUI::International->new($session, 'Asset_Dashboard');
my $form = $session->form;
my $html_form = WebGUI::HTMLForm->new($session, action => $self->getUrl, method => 'POST', );
$html_form->hidden(name => 'func', value => 'customizeDashletSave', );
$html_form->hidden(name => 'dashletAssetId', value => $dashletAssetId, );
$html_form->readOnly(name => $i18n->get(), value => $dashlet->getTitle, );
my $overrides = $dashlet->fetchUserOverrides($self->getId);
my @dashlet_properties = $dashlet->getOverrideFormDefinition;
foreach my $property (@dashlet_properties) {
my %properties = %{ $property };
$properties{value} = $overrides->{$property->{name}} || $dashlet->get($property->{name});
$html_form->dynamicField(%properties);
}
$html_form->submit();
return $html_form->print;
}
#-------------------------------------------------------------------
=head2 www_customizeDashletSave
Web facing method for saving per dashlet configuration, such as being required, or movable.
=cut
sub www_customizeDashletSave {
my $self = shift;
my $session = $self->session;
return $session->privilege->insufficient() unless ($session->user->isRegistered);
my $dashletAssetId = $session->form->get('dashletAssetId');
my $dashlet = WebGUI::Asset->newById($session, $dashletAssetId);
return $session->privilege->insufficient() unless ($dashlet && $dashlet->canView && $dashlet->can('getOverrideFormDefinition'));
my $overrides = {};
my @dashlet_properties = $dashlet->getOverrideFormDefinition;
my $form = $session->form;
foreach my $property (@dashlet_properties) {
my $value = $form->process($property->{name}, $property->{fieldType}, $property->{value});
$overrides->{$property->{name}} = $value;
}
$dashlet->storeUserOverrides($self->getId, $overrides);
return $self->www_view;
}
##-------------------------------------------------------------------
=head2 www_editDashlet
Web facing method for saving per dashlet configuration, such as being required, or movable.
=cut
sub www_editDashlet {
my $self = shift;
my $session = $self->session;
return $session->privilege->insufficient() unless ($self->canEdit);
my $dashletAssetId = $session->form->get('dashletAssetId');
my $dashlet = WebGUI::Asset->newById($session, $dashletAssetId);
return $session->privilege->insufficient() unless ($dashletAssetId);
my $i18n = WebGUI::International->new($session, 'Asset_Dashboard');
my $form = $session->form;
my $html_form = WebGUI::HTMLForm->new($session, action => $self->getUrl, method => 'POST', );
$html_form->hidden(name => 'func', value => 'editDashletSave', );
$html_form->hidden(name => 'dashletAssetId', value => $dashletAssetId, );
$html_form->readOnly(name => $i18n->get(), value => $dashlet->getTitle, );
my $options = $session->db->quickHashRef('select * from Dashboard_dashlets where dashboardAssetId=? and dashletAssetId=?', [$self->getId, $dashletAssetId]);
$html_form->yesNo(
name => 'isStatic',
label => $i18n->get('Is static'),
hoverHelp => $i18n->get('Is static help'),
value => $form->get('isStatic') || $options->{isStatic},
);
$html_form->yesNo(
name => 'isRequired',
label => $i18n->get('Is required'),
hoverHelp => $i18n->get('Is required help'),
value => $form->get('isRequired') || $options->{isRequired},
);
$html_form->submit();
return $html_form->print;
}
#-------------------------------------------------------------------
=head2 www_editDashletSave
Web facing method for saving per dashlet configuration, such as being required, or movable.
=cut
sub www_editDashletSave {
my $self = shift;
my $session = $self->session;
return $session->privilege->insufficient() unless ($self->canEdit);
my $dashletAssetId = $session->form->get('dashletAssetId');
my $isStatic = $session->form->get('isStatic', 'yesNo');
my $isRequired = $session->form->get('isRequired', 'yesNo');
$session->db->write('DELETE FROM Dashboard_dashlets where dashboardAssetId=? and dashletAssetId=?',[$self->getId, $dashletAssetId, ]);
$session->db->write('INSERT INTO Dashboard_dashlets (dashboardAssetId, dashletAssetId, isStatic, isRequired) VALUES (?,?,?,?)', [$self->getId, $dashletAssetId, $isStatic, $isRequired, ]);
return $self->www_view;
}
#-------------------------------------------------------------------
=head2 www_setContentPositions
Web method for saving the positions of dashlets in the dashboard.
=cut
sub www_setContentPositions {
my $self = shift;
return 'Visitors cannot save settings' if($self->session->user->isVisitor);
return $self->session->privilege->insufficient() unless ($self->canPersonalize);
return 'empty' unless $self->isInitialized;
my $dummy = $self->initialize unless $self->isInitialized;
my $u = WebGUI::User->new($self->session, $self->discernUserId);
my $success = $u->profileField($self->getContentPositionsId,$self->session->form->process("map")) eq $self->session->form->process("map");
return "Map set: ".$self->session->form->process("map") if $success;
return "Map failed to set.";
}
#-------------------------------------------------------------------
=head2 www_view ( )
Renders self->view based upon current style, subject to timeouts. Returns Privilege::noAccess() if canView is False.
=cut
sub www_view {
my $self = shift;
unless ($self->canView) {
if ($self->state eq "published") { # no privileges, make em log in
return $self->session->privilege->noAccess();
} elsif ($self->session->isAdminOn && $self->state =~ /^trash/) { # show em trash
$self->session->response->setRedirect($self->getUrl("func=manageTrash"));
return undef;
} elsif ($self->session->isAdminOn && $self->state =~ /^clipboard/) { # show em clipboard
$self->session->response->setRedirect($self->getUrl("func=manageClipboard"));
return undef;
} else { # tell em it doesn't exist anymore
$self->session->response->status(410);
return WebGUI::Asset->getNotFound($self->session)->www_view;
}
}
$self->logView();
$self->prepareView;
my $style = $self->processStyle($self->view, { noHeadTags => 1});
}
__PACKAGE__->meta->make_immutable;
1;