350 lines
9.7 KiB
Perl
350 lines
9.7 KiB
Perl
package WebGUI::Asset::Wobject;
|
|
|
|
=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 CGI::Util qw(rearrange);
|
|
use DBI;
|
|
use strict qw(subs vars);
|
|
use Tie::IxHash;
|
|
use WebGUI::AdminConsole;
|
|
use WebGUI::DateTime;
|
|
use WebGUI::FormProcessor;
|
|
use WebGUI::Grouping;
|
|
use WebGUI::HTML;
|
|
use WebGUI::HTMLForm;
|
|
use WebGUI::Icon;
|
|
use WebGUI::Id;
|
|
use WebGUI::International;
|
|
use WebGUI::Macro;
|
|
use WebGUI::Node;
|
|
use WebGUI::Page;
|
|
use WebGUI::Privilege;
|
|
use WebGUI::Session;
|
|
use WebGUI::SQL;
|
|
use WebGUI::TabForm;
|
|
use WebGUI::Template;
|
|
use WebGUI::URL;
|
|
use WebGUI::Utility;
|
|
use WebGUI::MetaData;
|
|
use WebGUI::Wobject::WobjectProxy;
|
|
|
|
=head1 NAME
|
|
|
|
Package WebGUI::Wobject
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
An abstract class for all other wobjects to extend.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use WebGUI::Wobject;
|
|
our @ISA = qw(WebGUI::Wobject);
|
|
|
|
See the subclasses in lib/WebGUI/Wobjects for details.
|
|
|
|
=head1 METHODS
|
|
|
|
These methods are available from this class:
|
|
|
|
=cut
|
|
|
|
sub definition {
|
|
my $class = shift;
|
|
my $definition = shift;
|
|
push(@{$definition}, {
|
|
tableName=>'wobject',
|
|
className=>'WebGUI::Asset::Wobject',
|
|
properties=>{
|
|
description=>{
|
|
fieldType=>'HTMLArea',
|
|
defaultValue=>undef
|
|
},
|
|
displayTitle=>{
|
|
fieldType=>'yesNo',
|
|
defaultValue=>1
|
|
},
|
|
cacheTimeout=>{
|
|
fieldType=>'interval',
|
|
defaultValue=>60
|
|
},
|
|
cacheTimeoutVisitor=>{
|
|
fieldType=>'interval',
|
|
defaultValue=>600
|
|
}
|
|
}
|
|
});
|
|
return $class->SUPER::definition($definition);
|
|
}
|
|
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 confirm ( message, yesURL, [ , noURL, vitalComparison ] )
|
|
|
|
=head3 message
|
|
|
|
A string containing the message to prompt the user for this action.
|
|
|
|
=head3 yesURL
|
|
|
|
A URL to the web method to execute if the user confirms the action.
|
|
|
|
=head3 noURL
|
|
|
|
A URL to the web method to execute if the user denies the action. Defaults back to the current page.
|
|
|
|
=head3 vitalComparison
|
|
|
|
A comparison expression to be used when checking whether the action should be allowed to continue. Typically this is used when the action is a delete of some sort.
|
|
|
|
=cut
|
|
|
|
sub confirm {
|
|
return WebGUI::Privilege::vitalComponent() if ($_[4]);
|
|
my $noURL = $_[3] || WebGUI::URL::page();
|
|
my $output = '<h1>'.WebGUI::International::get(42).'</h1>';
|
|
$output .= $_[1].'<p>';
|
|
$output .= '<div align="center"><a href="'.$_[2].'">'.WebGUI::International::get(44).'</a>';
|
|
$output .= ' <a href="'.$noURL.'">'.WebGUI::International::get(45).'</a></div>';
|
|
return $output;
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 duplicate ( [ pageId ] )
|
|
|
|
Duplicates this wobject with a new wobject Id. Returns the new wobject Id.
|
|
|
|
B<NOTE:> This method is meant to be extended by all sub-classes.
|
|
|
|
=head3 pageId
|
|
|
|
If specified the wobject will be duplicated to this pageId, otherwise it will be duplicated to the clipboard.
|
|
|
|
=cut
|
|
|
|
sub duplicate {
|
|
my $self = shift;
|
|
my $newAsset = $self->SUPER::duplicate();
|
|
WebGUI::MetaData::MetaDataDuplicate($self->getId, $newAsset->getId);
|
|
return $newAsset;
|
|
}
|
|
|
|
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 getEditForm ()
|
|
|
|
Returns the TabForm object that will be used in generating the edit page for this wobject.
|
|
|
|
=cut
|
|
|
|
sub getEditForm {
|
|
my $self = shift;
|
|
my $tabform = $self->SUPER::getEditForm();
|
|
$tabform->addTab("layout",WebGUI::International::get(105),5);
|
|
$tabform->getTab("layout")->yesNo(
|
|
-name=>"displayTitle",
|
|
-label=>WebGUI::International::get(174),
|
|
-value=>$self->getValue("displayTitle"),
|
|
-uiLevel=>5
|
|
);
|
|
$tabform->getTab("layout")->template(
|
|
-value=>$self->getValue("templateId"),
|
|
-namespace=>$self->get("namespace"),
|
|
-afterEdit=>'func=edit&wid='.$self->get("wobjectId")."&namespace=".$self->get("namespace")
|
|
);
|
|
$tabform->getTab("properties")->HTMLArea(
|
|
-name=>"description",
|
|
-label=>WebGUI::International::get(85),
|
|
-value=>$self->getValue("description")
|
|
);
|
|
$tabform->getTab("properties")->interval(
|
|
-name=>"cacheTimeout",
|
|
-label=>WebGUI::International::get(895),
|
|
-value=>$self->getValue("cacheTimeout"),
|
|
-uiLevel=>8
|
|
);
|
|
$tabform->getTab("properties")->interval(
|
|
-name=>"cacheTimeoutVisitor",
|
|
-label=>WebGUI::International::get(896),
|
|
-value=>$self->getValue("cacheTimeoutVisitor"),
|
|
-uiLevel=>8
|
|
);
|
|
}
|
|
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 getName ( )
|
|
|
|
This method should be overridden by all wobjects and should return an internationalized human friendly name for the wobject. This method only exists in the super class for reverse compatibility and will try to look up the name based on the old name definition.
|
|
|
|
=cut
|
|
|
|
sub getName {
|
|
my $self = shift;
|
|
return $self->get("className");
|
|
}
|
|
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 logView ( )
|
|
|
|
Logs the view of the wobject to the passive profiling mechanism.
|
|
=cut
|
|
|
|
sub logView {
|
|
my $self = shift;
|
|
WebGUI::PassiveProfiling::add($self->get("assetId"));
|
|
return;
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 processMacros ( output )
|
|
|
|
Decides whether or not macros should be processed and returns the
|
|
appropriate output.
|
|
|
|
=head3 output
|
|
|
|
An HTML blob to be processed for macros.
|
|
|
|
=cut
|
|
|
|
sub processMacros {
|
|
return WebGUI::Macro::process($_[1]);
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 processTemplate ( templateId, vars [ , namespace ] )
|
|
|
|
Returns the content generated from this template.
|
|
|
|
B<NOTE:> Only for use in wobjects that support templates.
|
|
|
|
=head3 templateId
|
|
|
|
An id referring to a particular template in the templates table.
|
|
|
|
=head3 hashRef
|
|
|
|
A hash reference containing variables and loops to pass to the template engine.
|
|
|
|
=head3 namespace
|
|
|
|
A namespace to use for the template. Defaults to the wobject's namespace.
|
|
|
|
=cut
|
|
|
|
sub processTemplate {
|
|
my $self = shift;
|
|
my $templateId = shift;
|
|
my $var = shift;
|
|
my $namespace = shift || $self->get("namespace");
|
|
if ($self->{_useMetaData}) {
|
|
my $meta = WebGUI::MetaData::getMetaDataFields($self->get("wobjectId"));
|
|
foreach my $field (keys %$meta) {
|
|
$var->{$meta->{$field}{fieldName}} = $meta->{$field}{value};
|
|
}
|
|
}
|
|
my %vars = (
|
|
%{$self->{_property}},
|
|
%{$var}
|
|
);
|
|
if (defined $self->get("_WobjectProxy")) {
|
|
$vars{isShortcut} = 1;
|
|
my ($originalPageURL) = WebGUI::SQL->quickArray("select urlizedTitle from page where pageId=".quote($self->get("pageId")),WebGUI::SQL->getSlave);
|
|
$vars{originalURL} = WebGUI::URL::gateway($originalPageURL."#".$self->get("wobjectId"));
|
|
}
|
|
return WebGUI::Template::process($templateId,$namespace, \%vars);
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 purge ( )
|
|
|
|
Removes this wobject and it's descendants from the database.
|
|
|
|
=cut
|
|
|
|
sub purge {
|
|
my $self = shift;
|
|
$self->SUPER::purge();
|
|
WebGUI::MetaData::metaDataDelete($self->get("wobjectId"));
|
|
}
|
|
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 www_createShortcut ( )
|
|
|
|
Creates a shortcut (using the wobject proxy) of this wobject on the clipboard.
|
|
|
|
B<NOTE:> Should never need to be overridden or extended.
|
|
|
|
=cut
|
|
|
|
sub www_createShortcut {
|
|
my $self = shift;
|
|
return WebGUI::Privilege::insufficient() unless ($self->canEdit);
|
|
my $w = WebGUI::Wobject::WobjectProxy->new({wobjectId=>"new",namespace=>"WobjectProxy"});
|
|
$w->set({
|
|
pageId=>'2',
|
|
templatePosition=>1,
|
|
title=>$self->getValue("title"),
|
|
proxiedNamespace=>$self->get("namespace"),
|
|
proxiedWobjectId=>$self->get("wobjectId"),
|
|
bufferUserId=>$session{user}{userId},
|
|
bufferDate=>WebGUI::DateTime::time(),
|
|
bufferPrevId=>$session{page}{pageId}
|
|
});
|
|
return "";
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 www_editSave ( )
|
|
|
|
Saves the default properties of any/all wobjects.
|
|
|
|
B<NOTE:> This method should only need to be extended if you need to do some special validation that you can't achieve via filters.
|
|
|
|
=cut
|
|
|
|
sub www_editSave {
|
|
my $self = shift;
|
|
$self->SUPER::www_editSave();
|
|
WebGUI::MetaData::metaDataSave($self->getId);
|
|
return "";
|
|
}
|
|
|
|
|
|
|
|
1;
|
|
|