package WebGUI::Attachment;

=head1 LEGAL

 -------------------------------------------------------------------
  WebGUI is Copyright 2001-2002 Plain Black Software.
 -------------------------------------------------------------------
  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

my $hasImageMagick=1;

use File::Copy qw(cp);
use File::Path;
use FileHandle;

# test for ImageMagick. if it's not installed set $hasImageMagick to 0,
# if it is installed it will be set to 1
eval " use Image::Magick; "; $hasImageMagick=0 if $@;

use POSIX;
use strict;
use WebGUI::ErrorHandler;
use WebGUI::Node;
use WebGUI::Session;
use WebGUI::URL;
use WebGUI::Utility;

=head1 NAME

 Package WebGUI::Attachment

=head1 SYNOPSIS

 use WebGUI::Attachment;
 $attachment = WebGUI::Attachment->new("file.txt","100","20");
 $attachment->copy("files","10");
 $attachment->delete;
 $attachment->deleteNode;
 $attachment->getFilename;
 $attachment->getIcon;
 $attachment->getPath;
 $attachment->getThumbnail;
 $attachment->getType;
 $attachment->getURL;
 $attachment->rename("thisfile.txt");
 $attachment->save("formImage");

=head1 DESCRIPTION
 
 Package to manipulate WebGUI Attachments.

=head1 METHODS

 These methods are available from this class:

=cut


#-------------------------------------------------------------------
sub _createThumbnail {
	my ($image, $error, $x, $y, $r, $n);
        if ($hasImageMagick && isIn($_[0]->getType, qw(jpg jpeg gif png tif tiff bmp))) {
		$image = Image::Magick->new;
		$error = $image->Read($_[0]->getPath);
		WebGUI::ErrorHandler::warn($error) if $error;
		($x, $y) = $image->Get('width','height');
		$n = $_[1] || $session{setting}{thumbnailSize};
		$r = $x>$y ? $x / $n : $y / $n;
		$image->Scale(width=>($x/$r),height=>($y/$r));
		if (isIn($_[0]->getType, qw(tif tiff bmp))) {
			$error = $image->Write($_[0]->{_node}->getPath.'/thumb-'.$_[0]->getFilename.'.png');
		} else {
			$error = $image->Write($_[0]->{_node}->getPath.'/thumb-'.$_[0]->getFilename);
		}
		WebGUI::ErrorHandler::warning($error) if $error;
	}
}


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

=head2 copy ( newNode [, newNodeSub ] )
 
 Copies an attachment from one node to another.

=item newNode

 Define the node to copy the attachment to.

=item newNodeSub

 If there is a subordinate element on this node define it here.

=cut

sub copy {
	my ($a, $b, $newNode);
	$newNode = WebGUI::Node->new($_[1],$_[2]);
	$newNode->create;
       	$a = FileHandle->new($_[0]->getPath,"r");
	$b = FileHandle->new(">".$newNode->getPath.'/'.$_[0]->getFilename);
	if (defined $a) {
		binmode($a); 
		$b = FileHandle->new(">".$newNode->getPath.'/'.$_[0]->getFilename);
		if (defined $b) {
			binmode($b); 
       			cp($a,$b);
			$b->close;
		}
		$a->close;
	}
}


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

=head2 delete ( )

 Deletes an attachment from its node.

=cut

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


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

=head2 deleteNode ( )

 Deletes deletes this attachment's node (and everything in it).

=cut

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


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

=head2 getFilename ( )

 Returns the attachment's filename.

=cut

sub getFilename {
        return $_[0]->{_filename};
}


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

=head2 getIcon ( )

 Returns the full URL to the file icon for this attachment.

=cut

sub getIcon {
	my ($extension, $icon);
	$extension = $_[0]->getType;
	$icon = $session{setting}{lib}."/fileIcons/";
	if (isIn($extension, qw(doc dot wri))) {
                $icon .= "doc.gif";
        } elsif (isIn($extension, qw(txt log config conf))) {
                $icon .= "txt.gif";
	} elsif (isIn($extension, qw(xlt csv xls))) {
                $icon .= "xls.gif";
        } elsif (isIn($extension, qw(ram mpeg mpg wav mp3 avi))) {
                $icon .= "wav.gif";
        } elsif (isIn($extension, qw(html htm xml))) {
                $icon .= "html.gif";
        } elsif (isIn($extension, qw(exe com bat pif))) {
                $icon .= "exe.gif";
        } elsif (isIn($extension, qw(sit hqx))) {
                $icon .= "sit.gif";
        } elsif (isIn($extension, qw(dwg dwf))) {
                $icon .= "dwg.gif";
        } elsif (isIn($extension, qw(indd p65))) {
                $icon .= "indd.gif";
        } elsif (isIn($extension, qw(tgz gz tar Z))) {
                $icon .= "gz.gif";
        } elsif ($extension eq "rar") {
                $icon .= "rar.gif";
        } elsif ($extension eq "mdb") {
                $icon .= "mdb.gif";
        } elsif ($extension eq "ppt") {
                $icon .= "ppt.gif";
        } elsif (isIn($extension, qw(psd eps ai))) {
                $icon .= "psd.gif";
        } elsif (isIn($extension, qw(tiff tif bmp psp gif jpg jpeg png))) {
                $icon .= "psp.gif";
        } elsif ($extension eq "zip") {
                $icon .= "zip.gif";
        } elsif ($extension eq "mov") {
                $icon .= "mov.gif";
        } elsif ($extension eq "pdf") {
                $icon .= "pdf.gif";
	} else {
		$icon .= "unknown.gif";
	}
	return $icon;
}


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

=head2 getPath ( )

 Returns a full path to an attachment.

=cut

sub getPath {
        return $_[0]->{_node}->getPath.'/'.$_[0]->getFilename;
}


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

=head2 getThumbnail ( )

 Returns a full URL to the thumbnail for this attachment. Thumbnails
 are only created for jpg, gif, png, tif, and bmp with Image::Magick
 installed so getThumbnail only returns a thumbnail if the file is 
 one of those types and Image::Magick is installed.

=cut

sub getThumbnail {
	if ($hasImageMagick && isIn($_[0]->getType, qw(jpg jpeg gif png))) {
        	return $_[0]->{_node}->getURL.'/thumb-'.$_[0]->getFilename;
	} elsif ($hasImageMagick && isIn($_[0]->getType, qw(tif tiff bmp))) {
        	return $_[0]->{_node}->getURL.'/thumb-'.$_[0]->getFilename.'.png';
	} else {
		return "";
	}
}


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

=head2 getType ( )

 Returns the extension or type of this attachment.

=cut

sub getType {
	my ($extension);
	$extension = $_[0]->getFilename;
	$extension =~ s/.*\.(.*?)$/$1/;
	return $extension;
}


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

=head2 getURL ( )

 Returns a full URL to an attachment.

=cut

sub getURL {
	return $_[0]->{_node}->getURL.'/'.$_[0]->getFilename;
}


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

=head2 new ( filename, node [, nodeSubordinate ] )

 Constructor.

=item filename

 What is the filename for this attachment. If you'll be uploading
 the attachment using the "save" method then you may leave this
 field blank.

=item node

 The node where this attachment is (or will be placed).

=item nodeSubordinate

 The subordinate element of the node where this attachment is (or
 will be placed).

=cut

sub new {
	my ($class, $filename, $node, $nodeSub) = @_;
	$node = WebGUI::Node->new($node, $nodeSub);
	bless {_node => $node, _filename => $filename}, $class;
}


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

=head2 rename ( newFilename )

 Renames an attachment's filename.

=item newFilename

 Define the new filename for this attachment.

=cut

sub rename {
	rename $_[0]->getPath, $_[0]->{_node}->getPath.'/'.$_[1];
	$_[0]->{_filename} = $_[1];
}


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

=head2 save ( formVariableName [, thumbnailSize ] )

 Grabs an attachment from a form POST and saves it to a node. It 
 then returns the filename of the attachment.

=item formVariableName

 Provide the form variable name to which the file being uploaded
 is assigned.

=item thumbnailSize

 If an image is being uploaded a thumbnail will be generated
 automatically. By default, WebGUI will create a thumbnail of the
 size specified in the attachment settings. You can override that
 size by specifying one here. Size is measured in pixels of the
 longest side.

=cut

sub save {
	my ($type, $file, $filename, $bytesread, $buffer, $urlizedFilename, $path);
	$filename = $session{cgi}->upload($_[1]);
	if (defined $filename) {
		if ($filename =~ /([^\/\\]+)$/) {
     			$_[0]->{_filename} = $1;
   		} else {
     			$_[0]->{_filename} = $filename;
   		}
		$type = $_[0]->getType();
		if (isIn($type, qw(pl perl sh cgi php asp))) {
			$_[0]->{_filename} =~ s/\./\_/g;
			$_[0]->{_filename} .= ".txt";
		}
		$_[0]->{_filename} = WebGUI::URL::urlize($_[0]->getFilename);
		$_[0]->{_node}->create();
		$file = FileHandle->new(">".$_[0]->getPath);
		if (defined $file) {
			binmode $file;
			while ($bytesread=read($filename,$buffer,1024)) {
        			print $file $buffer;
			}
			close($file);
			_createThumbnail($_[0],$_[2]);
		} else {
			return "";
		}
		return $_[0]->getFilename;
	} else {
		return "";
	}
}


1;