fa2768ea50
Put the new dragger tags into the template variables generated by the Layout. Update the Layout Help now that dragger.icon is inside the position loops. Remove the gotcha text for the manual modification solution.
358 lines
12 KiB
Perl
358 lines
12 KiB
Perl
package WebGUI::Asset::Wobject::Layout;
|
|
|
|
=head1 LEGAL
|
|
|
|
-------------------------------------------------------------------
|
|
WebGUI is Copyright 2001-2009 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::AdSpace;
|
|
use WebGUI::Asset::Wobject;
|
|
use WebGUI::Utility;
|
|
use WebGUI::Cache;
|
|
|
|
our @ISA = qw(WebGUI::Asset::Wobject);
|
|
|
|
=head1 NAME
|
|
|
|
Package WebGUI::Asset::Wobject::Layout
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Provides a mechanism to layout multiple assets on a single page.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use WebGUI::Asset::Wobject::Layout;
|
|
|
|
|
|
=head1 METHODS
|
|
|
|
These methods are available from this class:
|
|
|
|
=cut
|
|
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 definition ( definition )
|
|
|
|
Defines the properties of this asset.
|
|
|
|
=head3 definition
|
|
|
|
A hash reference passed in from a subclass definition.
|
|
|
|
=cut
|
|
|
|
sub definition {
|
|
my $class = shift;
|
|
my $session = shift;
|
|
my $definition = shift;
|
|
my $i18n = WebGUI::International->new($session,"Asset_Layout");
|
|
|
|
push(@{$definition}, {
|
|
assetName=>$i18n->get("assetName"),
|
|
icon=>'layout.gif',
|
|
tableName=>'Layout',
|
|
className=>'WebGUI::Asset::Wobject::Layout',
|
|
properties=>{
|
|
templateId =>{
|
|
fieldType =>"template",
|
|
namespace => "Layout",
|
|
defaultValue =>'PBtmpl0000000000000054',
|
|
},
|
|
contentPositions => {
|
|
noFormPost =>1,
|
|
defaultValue =>undef,
|
|
fieldType =>"hidden"
|
|
},
|
|
assetsToHide => {
|
|
defaultValue =>undef,
|
|
fieldType =>"checkList"
|
|
},
|
|
assetOrder => {
|
|
defaultValue =>'asc',
|
|
fieldType =>'selectBox',
|
|
}
|
|
}
|
|
});
|
|
return $class->SUPER::definition($session, $definition);
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 getEditForm ( )
|
|
|
|
Returns the TabForm object that will be used in generating the edit page for this asset.
|
|
|
|
=cut
|
|
|
|
sub getEditForm {
|
|
my $self = shift;
|
|
my $tabform = $self->SUPER::getEditForm();
|
|
my $i18n = WebGUI::International->new($self->session,"Asset_Layout");
|
|
|
|
my ($templateId);
|
|
if (($self->get("assetId") eq "new") && ($self->getParent->get('className') eq 'WebGUI::Asset::Wobject::Layout')) {
|
|
$templateId = $self->getParent->getValue('templateId');
|
|
} else {
|
|
$templateId = $self->getValue('templateId');
|
|
}
|
|
$tabform->getTab("display")->template(
|
|
-value=>$templateId,
|
|
-label=>$i18n->get('layout template title'),
|
|
-hoverHelp=>$i18n->get('template description'),
|
|
-namespace=>"Layout"
|
|
);
|
|
|
|
tie my %assetOrder, "Tie::IxHash";
|
|
%assetOrder = (
|
|
"asc" =>$i18n->get("asset order asc"),
|
|
"desc" =>$i18n->get("asset order desc"),
|
|
);
|
|
$tabform->getTab("display")->selectBox(
|
|
-name => 'assetOrder',
|
|
-label => $i18n->get('asset order label'),
|
|
-hoverHelp => $i18n->get('asset order hoverHelp'),
|
|
-value => $self->getValue('assetOrder'),
|
|
-options => \%assetOrder
|
|
);
|
|
if ($self->get("assetId") eq "new") {
|
|
$tabform->getTab("properties")->whatNext(
|
|
-options=>{
|
|
view=>$i18n->get(823),
|
|
viewParent=>$i18n->get(847)
|
|
},
|
|
-value=>"view"
|
|
);
|
|
} else {
|
|
my @assetsToHide = split("\n",$self->getValue("assetsToHide"));
|
|
my $children = $self->getLineage(["children"],{"returnObjects"=>1, excludeClasses=>["WebGUI::Asset::Wobject::Layout"]});
|
|
my %childIds;
|
|
foreach my $child (@{$children}) {
|
|
$childIds{$child->getId} = $child->getTitle;
|
|
}
|
|
$tabform->getTab("display")->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;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
sub prepareView {
|
|
my $self = shift;
|
|
$self->SUPER::prepareView;
|
|
my $session = $self->session;
|
|
my $template = WebGUI::Asset->new($session,$self->get("templateId"),"WebGUI::Asset::Template");
|
|
$template->prepare( $self->getMetaDataAsTemplateVariables );
|
|
$self->{_viewTemplate} = $template;
|
|
|
|
my $templateContent = $template->get("template");
|
|
my $numPositions = 1;
|
|
while ($templateContent =~ /position(\d+)_loop/g) {
|
|
$numPositions = $1
|
|
if $1 > $numPositions;
|
|
}
|
|
|
|
my %vars;
|
|
$vars{showAdmin} = ($session->var->isAdminOn && $self->canEdit && $self->canEditIfLocked);
|
|
|
|
my $splitter = $self->{_viewSplitter} = $self->getSeparator;
|
|
|
|
my %hidden = map { $_ => 1 }
|
|
split "\n", $self->get("assetsToHide");
|
|
|
|
my %placeHolder;
|
|
my @children;
|
|
|
|
for my $child ( @{ $self->getLineage( ["children"], {
|
|
returnObjects => 1,
|
|
excludeClasses => ["WebGUI::Asset::Wobject::Layout"],
|
|
} ) } ) {
|
|
my $assetId = $child->getId;
|
|
next
|
|
if ($hidden{$assetId} || ! $child->canView);
|
|
$child->prepareView;
|
|
$placeHolder{$assetId} = $child;
|
|
push @children, {
|
|
id => $assetId,
|
|
isUncommitted => $child->get('status') eq 'pending',
|
|
content => $splitter . $assetId . '~~',
|
|
};
|
|
if ($vars{showAdmin}) {
|
|
$children[-1]->{'dragger.icon'} = sprintf '<div id="td%s_handle" class="dragable"><div class="dragTrigger dragTriggerWrap">%s</div></div>', $assetId, $session->icon->drag('class="dragTrigger"');
|
|
};
|
|
}
|
|
|
|
my @positions = split /\./, $self->get("contentPositions");
|
|
# cut positions off at the number we found in the template
|
|
$#positions = $numPositions - 1
|
|
if $numPositions < scalar @positions;
|
|
|
|
my $positionIndex = 0;
|
|
my @found;
|
|
foreach my $position (@positions) {
|
|
$positionIndex++;
|
|
my @assets = split ',', $position;
|
|
for my $assetId (@assets) {
|
|
CHILD: for my $childIndex (0..$#children) {
|
|
if ($children[$childIndex]{id} eq $assetId) {
|
|
# remove found child from child list, add it to the appropriate position loop
|
|
push @{ $vars{'position' . $positionIndex . '_loop'} },
|
|
splice @children, $childIndex, 1;
|
|
last CHILD;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
# deal with unplaced children
|
|
# Add children to the top or bottom of the first content position based on assetOrder setting
|
|
if($self->getValue("assetOrder") eq "asc") {
|
|
push @{ $vars{"position1_loop"} }, @children;
|
|
}
|
|
else {
|
|
unshift @{ $vars{"position1_loop"} }, reverse @children;
|
|
}
|
|
|
|
if ($vars{showAdmin}) {
|
|
# under normal circumstances we don't put HTML stuff in our code, but this will make it much easier
|
|
# for end users to work with our templates
|
|
$session->style->setScript($session->url->extras("yui/build/yahoo-dom-event/yahoo-dom-event.js"),{ type=>"text/javascript" });
|
|
$session->style->setScript($session->url->extras("yui/build/animation/animation-min.js"),{ type=>"text/javascript" });
|
|
$session->style->setScript($session->url->extras("yui/build/dragdrop/dragdrop.js"),{ type=>"text/javascript" });
|
|
$session->style->setScript($session->url->extras("yui-webgui/build/layout/draggable.js"),{ type=>"text/javascript" });
|
|
|
|
$session->style->setLink($session->url->extras("draggable.css"),{ type=>"text/css", rel=>"stylesheet", media=>"all" });
|
|
$session->style->setRawHeadTags('
|
|
<style type="text/css">
|
|
.dragging, .empty {
|
|
background-image: url("'.$session->url->extras('opaque.gif').'");
|
|
}
|
|
</style>
|
|
');
|
|
$vars{"dragger.init"} = '
|
|
<iframe id="dragSubmitter" style="display: none;" src="'.$session->url->extras('spacer.gif').'"></iframe>
|
|
<script type="text/javascript">
|
|
dragable_init("'.$self->getUrl("func=setContentPositions;map=").'");
|
|
</script>
|
|
';
|
|
}
|
|
|
|
$self->{_viewVars} = \%vars;
|
|
$self->{_viewPlaceholder} = \%placeHolder;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
sub view {
|
|
my $self = shift;
|
|
my $session = $self->session;
|
|
my $showPerformance = $session->errorHandler->canShowPerformanceIndicators;
|
|
my @parts = split $self->{_viewSplitter},
|
|
$self->processTemplate($self->{_viewVars}, undef, $self->{_viewTemplate});
|
|
my $output = "";
|
|
|
|
if ($self->{_viewPrintOverride}) {
|
|
$session->output->print(shift @parts);
|
|
}
|
|
else {
|
|
$output .= shift @parts;
|
|
}
|
|
foreach my $part (@parts) {
|
|
my ($assetId, $outputPart) = split '~~', $part, 2;
|
|
my $asset = $self->{_viewPlaceholder}{$assetId};
|
|
if (defined $asset) {
|
|
my $t = [Time::HiRes::gettimeofday()] if ($showPerformance);
|
|
my $assetOutput = $asset->view;
|
|
$assetOutput .= "Asset:".Time::HiRes::tv_interval($t) if ($showPerformance);
|
|
if ($self->{_viewPrintOverride}) {
|
|
$session->output->print($assetOutput);
|
|
} else {
|
|
$output .= $assetOutput;
|
|
}
|
|
}
|
|
if ($self->{_viewPrintOverride}) {
|
|
$session->output->print($outputPart);
|
|
} else {
|
|
$output .= $outputPart;
|
|
}
|
|
}
|
|
return $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
sub www_setContentPositions {
|
|
my $self = shift;
|
|
return $self->session->privilege->insufficient() unless ($self->canEdit);
|
|
$self->addRevision({
|
|
contentPositions=>$self->session->form->process("map")
|
|
});
|
|
WebGUI::VersionTag->autoCommitWorkingIfEnabled($self->session);
|
|
return "Map set: ".$self->session->form->process("map");
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
sub getContentLastModified {
|
|
# Buggo: this is a little too conservative. Children that are hidden maybe shouldn't count. Hm.
|
|
my $self = shift;
|
|
my $mtime = $self->SUPER::getContentLastModified;
|
|
foreach my $child (@{$self->getLineage(["children"],{returnObjects=>1, excludeClasses=>['WebGUI::Asset::Wobject::Layout']})}) {
|
|
my $child_mtime = $child->getContentLastModified;
|
|
$mtime = $child_mtime if ($child_mtime > $mtime);
|
|
}
|
|
return $mtime;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
sub www_view {
|
|
my $self = shift;
|
|
# slashdot / burst protection hack
|
|
if ($self->session->var->get("userId") eq "1" && $self->session->form->param() == 0) {
|
|
my $check = $self->checkView;
|
|
return $check if (defined $check);
|
|
my $cache = WebGUI::Cache->new($self->session, "view_".$self->getId);
|
|
my $out = $cache->get if defined $cache;
|
|
unless ($out) {
|
|
$self->prepareView;
|
|
$self->session->stow->set("cacheFixOverride", 1);
|
|
$out = $self->processStyle($self->view);
|
|
$cache->set($out, 60);
|
|
$self->session->stow->delete("cacheFixOverride");
|
|
}
|
|
# keep those ads rotating
|
|
while ($out =~ /(\[AD\:([^\]]+)\])/gs) {
|
|
my $code = $1;
|
|
my $adSpace = WebGUI::AdSpace->newByName($self->session, $2);
|
|
my $ad = $adSpace->displayImpression if (defined $adSpace);
|
|
$out =~ s/\Q$code/$ad/ges;
|
|
}
|
|
$self->session->http->setLastModified($self->getContentLastModified);
|
|
$self->session->http->sendHeader;
|
|
$self->session->output->print($out, 1);
|
|
return "chunked";
|
|
}
|
|
$self->{_viewPrintOverride} = 1; # we do this to make it output each asset as it goes, rather than waiting until the end
|
|
return $self->SUPER::www_view;
|
|
}
|
|
|
|
1;
|
|
|