299 lines
8 KiB
Perl
299 lines
8 KiB
Perl
package WebGUI::Asset::File::ZipArchive;
|
|
|
|
=head1 LEGAL
|
|
|
|
-------------------------------------------------------------------
|
|
WebGUI is Copyright 2001-2006 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::Asset::File;
|
|
use WebGUI::HTMLForm;
|
|
use WebGUI::SQL;
|
|
use WebGUI::Utility;
|
|
|
|
use Archive::Tar;
|
|
use Archive::Zip;
|
|
|
|
our @ISA = qw(WebGUI::Asset::File);
|
|
|
|
|
|
=head1 NAME
|
|
|
|
Package WebGUI::Asset::ZipArchive
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Provides a mechanism to upload and automatically extract a zip archive
|
|
containing related items. An asset setting will set the launch point of the archive.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use WebGUI::Asset::ZipArchive;
|
|
|
|
|
|
=head1 METHODS
|
|
|
|
These methods are available from this class:
|
|
|
|
=cut
|
|
|
|
#-------------------------------------------------------------------
|
|
sub unzip {
|
|
my $self = shift;
|
|
my $storage = $_[0];
|
|
my $filename = $_[1];
|
|
|
|
my $filepath = $storage->getPath();
|
|
chdir $filepath;
|
|
|
|
my $i18n = WebGUI::International->new($self->session,"Asset_ZipArchive");
|
|
if($filename =~ m/\.zip/i){
|
|
my $zip = Archive::Zip->new();
|
|
unless ($zip->read($filename) == $zip->AZ_OK){
|
|
$self->session->errorHandler->warn($i18n->get("zip_error"));
|
|
return 0;
|
|
}
|
|
$zip->extractTree();
|
|
} elsif($filename =~ m/\.tar/i){
|
|
Archive::Tar->extract_archive($filepath.'/'.$filename,1);
|
|
if (Archive::Tar->error){
|
|
$self->session->errorHandler->warn(Archive::Tar->error);
|
|
return 0;
|
|
}
|
|
} else{
|
|
$self->session->errorHandler->warn($i18n->get("bad_archive"));
|
|
}
|
|
|
|
return 1;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
=head2 addRevision
|
|
|
|
This method exists for demonstration purposes only. The superclass
|
|
handles revisions to ZipArchive Assets.
|
|
|
|
=cut
|
|
|
|
sub addRevision {
|
|
my $self = shift;
|
|
my $newSelf = $self->SUPER::addRevision(@_);
|
|
return $newSelf;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
=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_ZipArchive");
|
|
push(@{$definition}, {
|
|
assetName=>$i18n->get('assetName'),
|
|
tableName=>'ZipArchiveAsset',
|
|
icon=>'ziparchive.gif',
|
|
className=>'WebGUI::Asset::File::ZipArchive',
|
|
properties=>{
|
|
showPage=>{
|
|
fieldType=>'text',
|
|
defaultValue=>'index.html'
|
|
},
|
|
templateId=>{
|
|
fieldType=>'template',
|
|
defaultValue=>''
|
|
},
|
|
}
|
|
});
|
|
return $class->SUPER::definition($session,$definition);
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
=head2 duplicate
|
|
|
|
This method exists for demonstration purposes only. The superclass
|
|
handles duplicating ZipArchive Assets. This method will be called
|
|
whenever a copy action is executed
|
|
|
|
=cut
|
|
|
|
sub duplicate {
|
|
my $self = shift;
|
|
my $newAsset = $self->SUPER::duplicate(shift);
|
|
return $newAsset;
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
=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_ZipArchive");
|
|
$tabform->getTab("display")->template(
|
|
-value=>$self->getValue("templateId"),
|
|
-label=>$i18n->get('template label'),
|
|
-namespace=>"ZipArchiveAsset"
|
|
);
|
|
$tabform->getTab("properties")->text (
|
|
-name=>"showPage",
|
|
-label=>$i18n->get('show page'),
|
|
-value=>$self->getValue("showPage"),
|
|
-hoverHelp=>$i18n->get('show page description'),
|
|
);
|
|
return $tabform;
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 prepareView ( )
|
|
|
|
See WebGUI::Asset::prepareView() for details.
|
|
|
|
=cut
|
|
|
|
sub prepareView {
|
|
my $self = shift;
|
|
$self->SUPER::prepareView();
|
|
my $template = WebGUI::Asset::Template->new($self->session, $self->get("templateId"));
|
|
$template->prepare;
|
|
$self->{_viewTemplate} = $template;
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
=head2 processPropertiesFromFormPost ( )
|
|
|
|
Used to process properties from the form posted. In this asset, we use
|
|
this method to deflate the zip file into the proper folder
|
|
|
|
=cut
|
|
|
|
sub processPropertiesFromFormPost {
|
|
my $self = shift;
|
|
#File should be saved here by the superclass
|
|
$self->SUPER::processPropertiesFromFormPost;
|
|
my $storage = $self->getStorageLocation();
|
|
|
|
my $file = $self->get("filename");
|
|
|
|
#return unless $file;
|
|
my $i18n = WebGUI::International->new($self->session, 'Asset_ZipArchive');
|
|
unless($self->session->form->process("showPage")) {
|
|
$storage->delete;
|
|
$self->session->db->write("update FileAsset set filename=NULL where assetId=".$self->session->db->quote($self->getId));
|
|
$self->session->scratch->set("za_error",$i18n->get("za_show_error"));
|
|
return;
|
|
}
|
|
|
|
unless($file =~ m/\.tar/i || $file =~ m/\.zip/i) {
|
|
$storage->delete;
|
|
$self->session->db->write("update FileAsset set filename=NULL where assetId=".$self->session->db->quote($self->getId));
|
|
$self->session->scratch->set("za_error",$i18n->get("za_error"));
|
|
return;
|
|
}
|
|
|
|
unless ($self->unzip($storage,$self->get("filename"))) {
|
|
$self->session->errorHandler->warn($i18n->get("unzip_error"));
|
|
}
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
=head2 view ( )
|
|
|
|
method called by the container www_view method. In this asset, this is
|
|
used to show the file to administrators.
|
|
|
|
=cut
|
|
|
|
sub view {
|
|
my $self = shift;
|
|
if (!$self->session->var->isAdminOn && $self->get("cacheTimeout") > 10) {
|
|
my $out = WebGUI::Cache->new($self->session,"view_".$self->getId)->get;
|
|
return $out if $out;
|
|
}
|
|
my %var = %{$self->get};
|
|
#$self->session->errorHandler->warn($self->getId);
|
|
$var{controls} = $self->getToolbar;
|
|
if($self->session->scratch->get("za_error")) {
|
|
$var{error} = $self->session->scratch->get("za_error");
|
|
}
|
|
$self->session->scratch->delete("za_error");
|
|
my $storage = $self->getStorageLocation;
|
|
if($self->get("filename") ne "") {
|
|
$var{fileUrl} = $storage->getUrl($self->get("showPage"));
|
|
$var{fileIcon} = $storage->getFileIconUrl($self->get("showPage"));
|
|
}
|
|
unless($self->get("showPage")) {
|
|
$var{pageError} = "true";
|
|
}
|
|
my $out = $self->processTemplate(\%var,undef,$self->{_viewTemplate});
|
|
if (!$self->session->var->isAdminOn && $self->get("cacheTimeout") > 10) {
|
|
WebGUI::Cache->new($self->session,"view_".$self->getId)->set($out,$self->get("cacheTimeout"));
|
|
}
|
|
return $out;
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
=head2 www_edit ( )
|
|
|
|
Web facing method which is the default edit page
|
|
|
|
=cut
|
|
|
|
sub www_edit {
|
|
my $self = shift;
|
|
return $self->session->privilege->insufficient() unless $self->canEdit;
|
|
$self->getAdminConsole->setHelp("zip archive add/edit", "Asset_ZipArchive");
|
|
my $i18n = WebGUI::International->new($self->session,"Asset_ZipArchive");
|
|
return $self->getAdminConsole->render($self->getEditForm->print,
|
|
$i18n->get('zip archive add/edit title'));
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
=head2 www_view ( )
|
|
|
|
Web facing method which is the default view page. This method does a
|
|
302 redirect to the "showPage" file in the storage location.
|
|
|
|
=cut
|
|
|
|
sub www_view {
|
|
my $self = shift;
|
|
return $self->session->privilege->noAccess() unless $self->canView;
|
|
if ($self->session->var->isAdminOn) {
|
|
return $self->getContainer->www_view;
|
|
}
|
|
$self->session->http->setRedirect($self->getFileUrl($self->getValue("showPage")));
|
|
return "1";
|
|
}
|
|
|
|
|
|
1;
|
|
|