File Coverage

blib/lib/Nokia/File/NFB/Element.pm

Criterion	Covered	Total	%
statement	41	67	61.1
branch	6	22	27.2
condition	9	17	52.9
subroutine	10	14	71.4
pod	8	8	100.0
total	74	128	57.8

package Nokia::File::NFB::Element;

## Create and Write a Nokia NFB file element.
## Robert Price - http://www.robertprice.co.uk/

use 5.00503;
use strict;
use utf8;
use vars qw($VERSION);

use Carp;
use Encode qw(encode);

$VERSION = '0.01';


## new()
## the object creation method
## INPUT: type - the type of the entry (1 = file, 2 = directory)
##	name - the name of the entry
##	time - the timestamp of the entry
## 	data - the binary data
## OUTPUT: blessed hash representing the object
sub new {
	my $class = shift;
	my $params = shift;
	my $self = {
		'type'		=> $params->{'type'} || '',
		'name'		=> $params->{'name'} || '',
		'timestamp'	=> $params->{'time'} || CORE::time,	## default to now if no time is given.
		'data'		=> $params->{'data'} || '',
	};
	$self->{'size'} = length($self->{'data'}) || 0;
	bless $self, $class;
	return $self;
}


#use overload '""' => \&pretty_print;
## pretty_print()
## display the contents of the object nicely
## OUTPUT: string containing a version of the object suitable
##	for printing.
sub pretty_print {
	my $self = shift;
	my $string = "------------------------------------------------\n";
	$string .= ' NAME: ' . $self->{'name'} . "\n";
	$string .= ' TYPE: ' . $self->{'type'} . "\n";
	if ($self->{'type'} == 1) {
		$string .= 'SIZE: ' . $self->{'size'} . "\n";
		if ($self->{'time'}) {
			$string .= 'TIME: ' . $self->{'time'} . ' - ' . localtime($self->{'time'}) . "\n";
		}
	}
	$string .= "------------------------------------------------\n";
	return $string;
}


## type()
## get or set the entry type for the element.
## INPUT: type - the type (1 = file, 2 = directory) (optional)
## OUTPUT: the type
sub type {
	my $self = shift;
	if ($_[0]) {
		my $type = shift;
		croak("Unknown type $type\nCan only be 1 or 2\n")	unless ($type == 1 || $type ==2);
		$self->{'type'} = $type;
	}
	return $self->{'type'};
}


## timestamp()
## get or set the timestamp for the element.
## INPUT: timestamp - creation time in seconds since epoch (optional)
## OUTPUT: timestamp - the timestmap of the element.
sub timestamp {
	my $self = shift;
	if ($_[0]) {
		my $time = shift;
		croak("Unknown time format, must be seconds since epoch\n")	unless ($time =~ /^\d+$/);
		$self->{'time'} = $time;
	}
	return $self->{'time'};
}


## name()
## get or set the filename of the element.
## INPUT: name - the name of the file / directory (optional).
## OUTPUT: name - the name of the file / directory.
sub name {
	my $self = shift;
	$self->{'name'}	= $_[0]	if ($_[0]);
	return $self->{'name'};
}


## data()
## get or set the data in the element.
## INPUT: data - the data of the file.
## OUTPUT: data - the data of the file.
sub data {
	my $self = shift;
	if ($_[0]) {
		$self->{'data'}	= $_[0];
		$self->{'size'} = length($self->{'data'});
	}
	return $self->{'data'};
}


## size()
## get the size of the data.
## OUTPUT: size - the size of the data.
sub size {
	my $self = shift;
	return $self->{'size'};
}


## binary
## return the object in a binary format suitable for insertion
## in a NFB file.
## OUTPUT: binary - the binary representation of the data.
sub binary {
	my $self = shift;
	my $binfile;

	croak("Need at least a name and type to generate binary element\n")
		unless(($self->{'type'}) && ($self->{'name'}));

	$binfile .= pack('V',$self->{'type'});
	$binfile .= pack('V', length($self->{'name'}));
	$binfile .= encode('UCS-2LE', $self->{'name'});

	if ($self->{'type'} == 1) {
		$binfile .= pack('V', length($self->{'data'}));
		$binfile .= $self->{'data'};
		$binfile .= pack('V', ($self->{'time'} ? $self->{'time'} : CORE::time()));
	}
	return $binfile;
}

1;
__END__