File Coverage

blib/lib/Fax/Hylafax/Client.pm

Criterion	Covered	Total	%
statement	39	304	12.8
branch	2	158	1.2
condition	21	244	8.6
subroutine	6	22	27.2
pod	5	5	100.0
total	73	733	9.9

######################################################################
# Description: Hylafax client that connects directly to the server   #
#              via Hylafax's proprietory FTP protocol                #
# Author:      Alex Rak ([e-mail])                              #
# Copyright:   See COPYRIGHT section in POD text below for usage and #
#              distribution rights                                   #
######################################################################

package Fax::Hylafax::Client;

use 5.006;
use strict;
use warnings;

use Carp;
use Net::FTP;
require Exporter;

our @ISA = qw(Exporter);
our @EXPORT_OK = qw(faxinfo faxrm faxstat sendfax sendpage);

our $VERSION = "1.02";

our $Host;
our $Port;
our $User;
our $Password;
our $Passive;
our $Debug;
our $NotifyAddr;


sub faxinfo
{
	shift if $_[0] eq __PACKAGE__;
	my %param  = scalar @_ == 1 ? ('jobid', shift) : @_;
	my $self = {
		TRACE	=> '',
		SUCCESS	=> '',
		CONTENT	=> '',
	};

	##  Set defaults
	$param{host}		||= $Host		|| 'localhost';
	$param{port}		||= $Port		|| '4559';
	$param{user}		||= $User		|| 'anonymous';
	$param{password}	||= $Password	|| 'anonymous';
	$param{passive}		||= $Passive	|| '0';

	##  Basic error checking
	croak __PACKAGE__ . ": *jobid* parameter is missing" unless $param{jobid};

	##  Try to connect
	my $client = Net::FTP->new($param{host}, Port => $param{port}, Passive => $param{passive}) || croak __PACKAGE__ . ": " . $@;
	$client->login($param{user}, $param{password}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	##  Process the task
	$client->quot("job", $param{jobid}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("jparm state") || _com_error($client);
	$self->{TRACE} .= $client->message;
	$self->{CONTENT} = $client->message;

	##  Disconnect
	$client->quit;
	$self->{TRACE} .= $client->message;

	return bless $self, __PACKAGE__ . "::Instant";
}


sub faxrm
{
	shift if $_[0] eq __PACKAGE__;
	my %param  = scalar @_ == 1 ? ('jobid', shift) : @_;
	my $self = {
		TRACE	=> '',
		SUCCESS	=> '',
	};

	##  Set defaults
	$param{host}		||= $Host		|| 'localhost';
	$param{port}		||= $Port		|| '4559';
	$param{user}		||= $User		|| 'anonymous';
	$param{password}	||= $Password	|| 'anonymous';
	$param{passive}		||= $Passive	|| '0';

	##  Basic error checking
	croak __PACKAGE__ . ": *jobid* parameter is missing" unless $param{jobid};

	##  Try to connect
	my $client = Net::FTP->new($param{host}, Port => $param{port}, Passive => $param{passive}) || croak __PACKAGE__ . ": " . $@;
	$client->login($param{user}, $param{password}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	##  Process the task
	$client->quot("jkill", $param{jobid}) || _com_error($client);
	$self->{TRACE} .= $client->message;
	$self->{SUCCESS} = $client->message =~ /failed/i || $client->message =~ /cannot/i ? 0 : 1;

	##  Disconnect
	$client->quit;
	$self->{TRACE} .= $client->message;

	return bless $self, __PACKAGE__ . "::Instant";
}


sub faxstat
{
	shift if $_[0] eq __PACKAGE__;
	my %param  = @_;
	my $self = {
		TRACE	=> '',
		SUCCESS	=> '',
		CONTENT	=> '',
	};

	##  Set defaults
	$param{host}		||= $Host		|| 'localhost';
	$param{port}		||= $Port		|| '4559';
	$param{user}		||= $User		|| 'anonymous';
	$param{password}	||= $Password	|| 'anonymous';
	$param{passive}		||= $Passive	|| '0';
	$param{filefmt}		||= '';
	$param{jobfmt}		||= '%-4j %3i %1a %6.6o %-12.12e %5P %5D %7z %.25s';
	$param{rcvfmt}		||= '%-7m %4p%1z %-8.8o %14.14s %7t %f';
	$param{info}		||= '0';  #  -i flag
	$param{files}		||= '0';  #  -f flag
	$param{queue}		||= '0';  #  -s flag
	$param{done}		||= '0';  #  -d flag
	$param{received}	||= '0';  #  -r flag

	##  Try to connect
	my $client = Net::FTP->new($param{host}, Port => $param{port}, Passive => $param{passive}) || croak __PACKAGE__ . ": " . $@;
	$client->login($param{user}, $param{password}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	##  Process the task
	if ($param{info})
	{
		my $dataconn = $client->retr("status/any.info") || _com_error($client);
		while ($dataconn->read(my $buffer, 1024))
		{
			$self->{CONTENT} .= $buffer;
		}
		$dataconn->close;
		$self->{TRACE} .= $client->message;
	}

	my $dataconn = $client->list("status") || _com_error($client);
	while ($dataconn->read(my $buffer, 1024))
	{
		$self->{CONTENT} .= $buffer;
	}
	$dataconn->close;
	$self->{TRACE} .= $client->message;

	if ($param{files})
	{
		$client->quot("filefmt", $param{filefmt}) || _com_error($client);
		my $dataconn = $client->list("docq") || _com_error($client);
		my $content;
		while ($dataconn->read(my $buffer, 1024))
		{
			$content .= $buffer;
		}
		$dataconn->close;
		$self->{CONTENT} .= "\n$content" if $content;
		$self->{TRACE} .= $client->message;
	}

	if ($param{queue})
	{
		$client->quot("jobfmt", $param{jobfmt}) || _com_error($client);
		my $dataconn = $client->list("sendq") || _com_error($client);
		my $content;
		while ($dataconn->read(my $buffer, 1024))
		{
			$content .= $buffer;
		}
		$dataconn->close;
		$self->{CONTENT} .= "\n$content" if $content;
		$self->{TRACE} .= $client->message;
	}

	if ($param{done})
	{
		$client->quot("jobfmt", $param{jobfmt}) || _com_error($client);
		my $dataconn = $client->list("doneq") || _com_error($client);
		my $content;
		while ($dataconn->read(my $buffer, 1024))
		{
			$content .= $buffer;
		}
		$dataconn->close;
		$self->{CONTENT} .= "\n$content" if $content;
		$self->{TRACE} .= $client->message;
	}

	if ($param{received})
	{
		$client->quot("rcvfmt", $param{rcvfmt}) || _com_error($client);
		my $dataconn = $client->list("recvq") || _com_error($client);
		my $content;
		while ($dataconn->read(my $buffer, 1024))
		{
			$content .= $buffer;
		}
		$dataconn->close;
		$self->{CONTENT} .= "\n$content" if $content;
		$self->{TRACE} .= $client->message;
	}

	##  Disconnect
	$client->quit;
	$self->{TRACE} .= $client->message;

	return bless $self, __PACKAGE__ . "::Instant";
}


sub sendfax
{
	shift if $_[0] eq __PACKAGE__;
	my %param  = @_;
	my $hostname = `hostname`; chomp $hostname;
	my $self = {
		JOB_ID	=> '',
		TRACE	=> '',
		SUCCESS	=> '',
	};

	##  Set defaults
	$param{host}			||= $Host		|| 'localhost';
	$param{port}			||= $Port		|| '4559';
	$param{user}			||= $User		|| 'anonymous';
	$param{password}		||= $Password	|| 'anonymous';
	$param{passive}			||= $Passive	|| '0';
	$param{debug}			||= $Debug		|| '0';
	$param{lasttime}		||= '000259';
	$param{maxdials}		||= '12';
	$param{maxtries}		||= '3';
	$param{pagewidth}		||= '216';
	$param{pagelength}		||= '279';
	$param{vres}			||= '196';
	$param{schedpri}		||= '127';
	$param{chopthreshold}	||= '3';
	$param{notify}			||= 'none';
	$param{notifyaddr}		||= $NotifyAddr	|| $param{'user'} . '@' . $hostname;
	$param{sendtime}		||= 'now';

	$self->{PARAM} = \%param;

	##  Basic error checking
	croak __PACKAGE__ . ": *dialstring* parameter is missing" unless $param{dialstring};
	croak __PACKAGE__ . ": *docfile* parameter is missing" if (! $param{docfile} && ! $param{poll});
	croak __PACKAGE__ . ": $param{coverfile} does not exist" if ($param{coverfile} && ! -e $param{coverfile});

	if (ref(\$param{docfile}) eq 'SCALAR')
	{
		$param{docfiles} = [ $param{docfile} ];
	}
	elsif (ref($param{docfile}) eq 'ARRAY')
	{
		$param{docfiles} = $param{docfile};
	}
	else
	{
		croak __PACKAGE__ . ": *docfile* parameter must be a SCALAR or an ARRAY REFERENCE";
	}

	foreach my $docfile (@{$param{docfiles}})
	{
		croak __PACKAGE__ . ": $docfile does not exist" if (! -e $docfile);
	}

	delete $param{docfile};

	##  Try to connect
	my $client = Net::FTP->new($param{'host'}, Port => $param{'port'}, Passive => $param{'passive'}, Debug => $param{'debug'}) || croak __PACKAGE__ . ": " . $@;
	$client->login($param{'user'}, $param{'password'}) || _com_error($client);
	$self->{TRACE} .= $client->message;
	$client->binary || _com_error($client);
	$self->{TRACE} .= $client->message;

	##  Process the job
	my @tempfiles = ();

	if ($param{coverfile})
	{
		my $unique = time . sprintf('%05d', $$) . sprintf('%04d', int(rand 10000));
		my $remote = '/tmp/cover.' . $hostname . '.' . $unique;

		$client->put($param{coverfile}, $remote) || _com_error($client);	# (STOT would be nice, but Net::FTP doesn`t support it and STOU is broken)
		$self->{TRACE} .= $client->message;

		push (@tempfiles, $remote);
	}

	foreach my $docfile (@{$param{docfiles}})
	{
		my $unique = time . sprintf('%05d', $$) . sprintf('%04d', int(rand 10000));
		my $remote = '/tmp/doc.' . $hostname . '.' . $unique;

		$client->put($docfile, $remote) || _com_error($client);
		$self->{TRACE} .= $client->message;

		push (@tempfiles, $remote);
	}

	$client->quot("jnew") || _com_error($client);
	$self->{TRACE} .= $client->message;
	$client->message =~ /jobid: (\d+)/i;
	$self->{JOB_ID} = $1 if $1;
	$self->{PARAM}->{jobid} = $self->{JOB_ID};

	$client->quot("jparm fromuser", $param{'user'}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("jparm lasttime", $param{lasttime}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("jparm maxdials", $param{maxdials}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("jparm maxtries", $param{maxtries}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("jparm schedpri", $param{schedpri}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("jparm dialstring", $param{dialstring}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("jparm sendtime", $param{sendtime}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("jparm notifyaddr", $param{notifyaddr}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("jparm vres", $param{vres}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("jparm pagewidth", $param{pagewidth}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("jparm pagelength", $param{pagelength}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("jparm notify", $param{notify}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("jparm pagechop", "default") || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("jparm chopthreshold", $param{chopthreshold}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	foreach my $docfile (@tempfiles)
	{
		if ($param{coverfile} && $docfile eq $tempfiles[0])
		{
			$client->quot("jparm cover", $docfile) or _com_error($client);
		}
		else
		{
			$client->quot("jparm document", $docfile) or _com_error($client);
		}

		$self->{TRACE} .= $client->message;
	}

	if (defined $param{poll})
	{
		my ($selector, $passwd) = split(" ", $param{poll});
		$client->quot("jparm poll", $selector || "", $passwd || "") || _com_error($client);
		$self->{TRACE} .= $client->message;
	}

	$client->quot("jsubm") || _com_error($client);
	$self->{TRACE} .= $client->message;
	$self->{SUCCESS} = $client->message =~ /failed/i || $client->message =~ /failed/i? 0 : 1;

	##  Disconnect
	$client->quit;
	$self->{TRACE} .= $client->message;

	return bless $self, __PACKAGE__ . "::Queued";
}


sub sendpage
{
	shift if $_[0] eq __PACKAGE__;
	my %param  = @_;
	my $hostname = `hostname`; chomp $hostname;
	my $unique = time . $$ . int(rand 10000);
	my $self = {
		JOB_ID	=> '',
		TRACE	=> '',
		SUCCESS	=> '',
	};

	##  Set defaults
	$param{host}		||= $Host		|| 'localhost';
	$param{port}		||= $Port		|| '444';
	$param{user}		||= $User		|| 'anonymous';
	$param{password}	||= $Password	|| 'anonymous';
	$param{passive}		||= $Passive	|| '0';
	$param{maxdials}	||= '12';
	$param{maxtries}	||= '3';
	$param{notify}		||= 'none';
	$param{notifyaddr}	||= $NotifyAddr	|| $param{'user'} . '@' . $hostname;
	$param{level}		||= '1';

	$self->{PARAM} = \%param;

	##  Basic error checking
	croak __PACKAGE__ . ": *pin* parameter is missing" unless $param{pin};

	##  Try to connect
	my $client = Net::FTP->new($param{'host'}, Port => $param{'port'}, Passive => $param{'passive'}) || croak __PACKAGE__ . ": " . $@;
	$client->quot("logi", $param{user}, $param{password}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	##  Process the job
	$client->quot("site help", "notify") || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("leve", $param{level}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("site fromuser", $param{'user'}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("site maxdials", $param{maxdials}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("site maxtries", $param{maxtries}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("site mailaddr", $param{notifyaddr}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("site notify", $param{notify}) || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("site jqueue", "yes") || _com_error($client);
	$self->{TRACE} .= $client->message;

	$client->quot("page", $param{pin}) || _com_error($client);
	$self->{TRACE} .= $client->message;
	$client->message =~ /jobid: (\d+)\./i;
	$self->{JOB_ID} = $1 if $1;
	$self->{PARAM}->{jobid} = $self->{JOB_ID};

	if ($param{message})
	{
		$client->quot("mess", $param{message}) || _com_error($client);
		$self->{TRACE} .= $client->message;
	}

	$client->quot("send") || _com_error($client);
	$self->{TRACE} .= $client->message;
	$self->{SUCCESS} = $client->message =~ /success/i ? 1 : 0;

	##  Disconnect
	$client->quit;
	$self->{TRACE} .= $client->message;

	return bless $self, __PACKAGE__ . "::Queued";
}

######################################################################

sub _com_error
{
	my $client = shift;
	croak __PACKAGE__ . ": Communication error: " . $client->message;
}


sub _content
{
	my $class = shift;
	my $self = shift;
	return $self->{CONTENT} || undef;
}


sub _success
{
	my $class = shift;
	my $self = shift;
	return $self->{SUCCESS} || undef;
}


sub _trace
{
	my $class = shift;
	my $self = shift;
	return $self->{TRACE} || undef;
}

######################################################################

package Fax::Hylafax::Client::Queued;


sub faxinfo
{
	my $self = shift;
	my $conn = Fax::Hylafax::Client->faxinfo(%{$self->{PARAM}});
	$self->{TRACE} = $conn->trace;
	$self->{SUCCESS} = $conn->success;
	return $conn->content;
}


sub faxrm
{
	my $self = shift;
	my $conn = Fax::Hylafax::Client->faxrm(%{$self->{PARAM}});
	$self->{TRACE} = $conn->trace;
	$self->{SUCCESS} = $conn->success;
	return $conn->success;
}


sub jobid
{
	my $self = shift;
	return $self->{JOB_ID};
}


sub success
{
	return Fax::Hylafax::Client->_success(shift);
}


sub trace
{
	return Fax::Hylafax::Client->_trace(shift);
}

######################################################################

package Fax::Hylafax::Client::Instant;


sub content
{
	return Fax::Hylafax::Client->_content(shift);
}


sub success
{
	return Fax::Hylafax::Client->_success(shift);
}


sub trace
{
	return Fax::Hylafax::Client->_trace(shift);
}

######################################################################

1;

__END__