webgui/lib/WebGUI/Node.pm

package WebGUI::Node;

=head1 LEGAL 

 -------------------------------------------------------------------
  WebGUI is Copyright 2001-2004 Plain Black LLC.
 -------------------------------------------------------------------
  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 Archive::Tar;
use File::Path;
use POSIX;
use strict;
use WebGUI::ErrorHandler;
use WebGUI::Session;

=head1 NAME

Package WebGUI::Node

=head1 DESCRIPTION

Package to manipulate WebGUI storage nodes. The nodes system is a two-tiered filesystem hash that WebGUI uses to keep attachment data separated. There should be no need for anyone other than Plain Black Software to use this package.

=head1 SYNOPSIS

 use WebGUI::Node;
 $node = WebGUI::Node->new("100","20");

 $node->create;
 $node->delete;
 $node->getPath;
 $node->getURL;
 $node->tar($filename);
 $node->untar($filename);

=head1 METHODS

These methods are available from this package:

=cut


#-------------------------------------------------------------------

=head2 create ( )
 
Creates this node on the file system.

=cut

sub create {
	my ($node);
	$node = $session{config}{uploadsPath}.$session{os}{slash}.$_[0]->{_node1};
	mkdir($node);
	unless ($! eq "File exists" || $! eq "") {
		WebGUI::ErrorHandler::warn("Couldn't create node: $node : $!");
	}
        if ($_[0]->{_node2} ne "") {
		$node = $session{config}{uploadsPath}.$session{os}{slash}.$_[0]->{_node1}.$session{os}{slash}.$_[0]->{_node2};
		mkdir($node);
		unless ($! eq "File exists" || $! eq "") {
                	WebGUI::ErrorHandler::warn("Couldn't create node: $node : $!");
        	}
       	}	
}

#-------------------------------------------------------------------

=head2 delete ( )

Deletes this node and its contents (if any) from the filesystem. 

=cut

sub delete {
        rmtree($_[0]->getPath);
}


#-------------------------------------------------------------------

=head2 getFiles ( )

Returns a list of the files in this node.

=cut

sub getFiles ( ) {
	my @list;
	if (opendir (DIR,$_[0]->getPath)) {
        	my @files = readdir(DIR);
        	closedir(DIR);
        	foreach my $file (@files) {
                	if ($file ne ".." && $file ne ".") {
				push(@list,$file);
			}
                }
		return @list;
        }
}


#-------------------------------------------------------------------

=head2 getPath ( )

Returns a full path to this node.

=cut

sub getPath {
        my ($path);
        $path = $session{config}{uploadsPath}.$session{os}{slash}.$_[0]->{_node1};
        if ($_[0]->{_node2} ne "") {
                $path .= $session{os}{slash}.$_[0]->{_node2};
        }
        return $path;
}


#-------------------------------------------------------------------

=head2 getURL ( )

Returns a full URL to this node.

=cut

sub getURL {
	my ($url);
	$url = $session{config}{uploadsURL}.'/'.$_[0]->{_node1};
	if ($_[0]->{_node2} ne "") {
		$url .= '/'.$_[0]->{_node2};
	}
	return $url;
}


#-------------------------------------------------------------------

=head2 new ( node1 [, node2 ] )

Constructor.

=over

=item node1

 The first level of the hash heirarchy.

=item node2

 The second level of the hash heirarchy.

=back

=cut

sub new {
	my ($class, $node1, $node2) = @_;
	bless {_node1 => $node1, _node2 => $node2}, $class;
}

#-------------------------------------------------------------------

=head2 tar ( filename [ , node1, node2 ] )

Archives this node into a tar file and then compresses it with a zlib algorithm.

=over

=item filename

The name of the tar file to be created. Should ideally end with ".tar.gz".

=item node1

The node where you would like to create this tar file. Defaults to "temp".

=item node2

If you need a second level node to store the file, then specify it here.

=back

=cut

sub tar {
	my $self = $_[0];
	my $filename = $_[1] || $self->{_node1}."_".$self->{_node2}.".tar.gz";
	my $node1 = $_[2] || "temp";
	my $node2 = $_[3];
	chdir $self->getPath;
	my $temp = WebGUI::Node->new($node1,$node2);
	$temp->create;
	if ($Archive::Tar::VERSION eq '0.072') {
		my $tar = Archive::Tar->new();
		$tar->add_files($_[0]->getFiles);
		$tar->write($temp->getPath.$session{os}{slash}.$filename,1);
		
	} else {
		Archive::Tar->create_archive($temp->getPath.$session{os}{slash}.$filename,1,$_[0]->getFiles);
	}
}

#-------------------------------------------------------------------

=head2 untar ( filename [ , node1, node2 ] )

Unarchives a file into this node.

=over

=item filename

The name of the tar file to be untarred.

=item node1

The node where the tar file exists. Defaults to "temp".

=item node2

If the file exists in a sub-node, then specifiy it here.

=back

=cut

sub untar {
        my $self = $_[0];
	$self->create;
        my $filename = $_[1];
        my $node1 = $_[2] || "temp";
        my $node2 = $_[3];
        chdir $self->getPath;
	my $temp = WebGUI::Node->new($node1,$node2);
	Archive::Tar->extract_archive($temp->getPath.$session{os}{slash}.$filename,1);
	WebGUI::ErrorHandler::warn(Archive::Tar->error) if (Archive::Tar->error);
}


1;