X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2FMisc.pm;h=1f6eece504c7c45d40a8a3703adca66859e2e34d;hb=b4679a8258e9a0e2fb14ec6e6d0beb8c393adbae;hp=56dc72e36ec061f6d42170a59f712f6e1aed9d6a;hpb=fd9138f66cf7f3ab9557e0beebb4e2657a59e34c;p=freeside.git diff --git a/FS/FS/Misc.pm b/FS/FS/Misc.pm index 56dc72e36..1f6eece50 100644 --- a/FS/FS/Misc.pm +++ b/FS/FS/Misc.pm @@ -1,11 +1,24 @@ package FS::Misc; use strict; -use vars qw ( @ISA @EXPORT_OK ); +use vars qw ( @ISA @EXPORT_OK $DEBUG ); use Exporter; +use Carp; +use Data::Dumper; +use IPC::Run qw( run timeout ); # for _pslatex +use IPC::Run3; # for do_print... should just use IPC::Run i guess +#do NOT depend on any FS:: modules here, causes weird (sometimes unreproducable +#until on client machine) dependancy loops. put them in FS::Misc::Something +#instead @ISA = qw( Exporter ); -@EXPORT_OK = qw( send_email ); +@EXPORT_OK = qw( send_email send_fax + states_hash counties state_label + card_types + generate_ps generate_pdf do_print + ); + +$DEBUG = 0; =head1 NAME @@ -37,16 +50,27 @@ I - (required) comma-separated scalar or arrayref of recipients I - (required) -I - (optional) MIME type +I - (optional) MIME type for the body + +I - (required unless I is true) arrayref of body text lines + +I - (optional, but required if I is true) arrayref of MIME::Entity->build PARAMHASH refs or MIME::Entity objects. These will be passed as arguments to MIME::Entity->attach(). -I - (required) arrayref of body text lines +I - (optional) when set true, send_email will ignore the I option and simply construct a message with the given I. In this case, +I, if specified, overrides the default "multipart/mixed" for the outermost MIME container. + +I - (optional) when using nobody, optional top-level MIME +encoding which, if specified, overrides the default "7bit". + +I - (optional) type parameter for multipart/related messages =cut use vars qw( $conf ); use Date::Format; use Mail::Header; -use Mail::Internet 1.44; +use Mail::Internet 2.00; +use MIME::Entity; use FS::UID; FS::UID->install_callback( sub { @@ -54,34 +78,559 @@ FS::UID->install_callback( sub { } ); sub send_email { - my(%options) = shift; + my(%options) = @_; + if ( $DEBUG ) { + my %doptions = %options; + $doptions{'body'} = '(full body not shown in debug)'; + warn "FS::Misc::send_email called with options:\n ". Dumper(\%doptions); +# join("\n", map { " $_: ". $options{$_} } keys %options ). "\n" + } $ENV{MAILADDRESS} = $options{'from'}; my $to = ref($options{to}) ? join(', ', @{ $options{to} } ) : $options{to}; - my @header = ( - 'From: '. $options{'from'}, - 'To: '. $to, - 'Sender: '. $options{'from'}, - 'Reply-To: '. $options{'from'}, - 'Date: '. time2str("%a, %d %b %Y %X %z", time), - 'Subject: '. $options{'subject'}, - ); - push @header, 'Content-Type: '. $options{'content-type'} - if exists($options{'content-type'}); - my $header = new Mail::Header ( \@header ); - my $message = new Mail::Internet ( - 'Header' => $header, - 'Body' => $options{'body'}, + my @mimeargs = (); + my @mimeparts = (); + if ( $options{'nobody'} ) { + + croak "'mimeparts' option required when 'nobody' option given\n" + unless $options{'mimeparts'}; + + @mimeparts = @{$options{'mimeparts'}}; + + @mimeargs = ( + 'Type' => ( $options{'content-type'} || 'multipart/mixed' ), + 'Encoding' => ( $options{'content-encoding'} || '7bit' ), + ); + + } else { + + @mimeparts = @{$options{'mimeparts'}} + if ref($options{'mimeparts'}) eq 'ARRAY'; + + if (scalar(@mimeparts)) { + + @mimeargs = ( + 'Type' => 'multipart/mixed', + 'Encoding' => '7bit', + ); + + unshift @mimeparts, { + 'Type' => ( $options{'content-type'} || 'text/plain' ), + 'Data' => $options{'body'}, + 'Encoding' => ( $options{'content-type'} ? '-SUGGEST' : '7bit' ), + 'Disposition' => 'inline', + }; + + } else { + + @mimeargs = ( + 'Type' => ( $options{'content-type'} || 'text/plain' ), + 'Data' => $options{'body'}, + 'Encoding' => ( $options{'content-type'} ? '-SUGGEST' : '7bit' ), + ); + + } + + } + + my $domain; + if ( $options{'from'} =~ /\@([\w\.\-]+)/ ) { + $domain = $1; + } else { + warn 'no domain found in invoice from address '. $options{'from'}. + '; constructing Message-ID @example.com'; + $domain = 'example.com'; + } + my $message_id = join('.', rand()*(2**32), $$, time). "\@$domain"; + + my $message = MIME::Entity->build( + 'From' => $options{'from'}, + 'To' => $to, + 'Sender' => $options{'from'}, + 'Reply-To' => $options{'from'}, + 'Date' => time2str("%a, %d %b %Y %X %z", time), + 'Subject' => $options{'subject'}, + 'Message-ID' => "<$message_id>", + @mimeargs, ); + if ( $options{'type'} ) { + #false laziness w/cust_bill::generate_email + $message->head->replace('Content-type', + $message->mime_type. + '; boundary="'. $message->head->multipart_boundary. '"'. + '; type='. $options{'type'} + ); + } + + foreach my $part (@mimeparts) { + + if ( UNIVERSAL::isa($part, 'MIME::Entity') ) { + + warn "attaching MIME part from MIME::Entity object\n" + if $DEBUG; + $message->add_part($part); + + } elsif ( ref($part) eq 'HASH' ) { + + warn "attaching MIME part from hashref:\n". + join("\n", map " $_: ".$part->{$_}, keys %$part ). "\n" + if $DEBUG; + $message->attach(%$part); + + } else { + croak "mimepart $part isn't a hashref or MIME::Entity object!"; + } + + } + my $smtpmachine = $conf->config('smtpmachine'); $!=0; - $message->smtpsend( 'Host' => $smtpmachine ) - or $message->smtpsend( Host => $smtpmachine, Debug => 1 ) - or return "can't send email to $to via server $smtpmachine with SMTP: $!"; + + $message->mysmtpsend( 'Host' => $smtpmachine, + 'MailFrom' => $options{'from'}, + ); + +} + +#this kludges a "mysmtpsend" method into Mail::Internet for send_email above +#now updated for MailTools v2! +package Mail::Internet; + +use Mail::Address; +use Net::SMTP; +use Net::Domain; + +sub Mail::Internet::mysmtpsend($@) { + my ($self, %opt) = @_; + + my $host = $opt{Host}; + my $envelope = $opt{MailFrom}; # || mailaddress(); + my $quit = 1; + + my ($smtp, @hello); + + push @hello, Hello => $opt{Hello} + if defined $opt{Hello}; + + push @hello, Port => $opt{Port} + if exists $opt{Port}; + + push @hello, Debug => $opt{Debug} + if exists $opt{Debug}; + +# if(!defined $host) +# { local $SIG{__DIE__}; +# my @hosts = qw(mailhost localhost); +# unshift @hosts, split /\:/, $ENV{SMTPHOSTS} +# if defined $ENV{SMTPHOSTS}; +# +# foreach $host (@hosts) +# { $smtp = eval { Net::SMTP->new($host, @hello) }; +# last if defined $smtp; +# } +# } +# elsif(ref($host) && UNIVERSAL::isa($host,'Net::SMTP')) + if(ref($host) && UNIVERSAL::isa($host,'Net::SMTP')) + { $smtp = $host; + $quit = 0; + } + else + { #local $SIG{__DIE__}; + #$smtp = eval { Net::SMTP->new($host, @hello) }; + $smtp = Net::SMTP->new($host, @hello); + } + + unless ( defined($smtp) ) { + my $err = $!; + $err =~ s/Invalid argument/Unknown host/; + return "can't connect to $host: $err" + } + + my $head = $self->cleaned_header_dup; + + $head->delete('Bcc'); + + # Who is it to + + my @rcpt = map { ref $_ ? @$_ : $_ } grep { defined } @opt{'To','Cc','Bcc'}; + @rcpt = map { $head->get($_) } qw(To Cc Bcc) + unless @rcpt; + + my @addr = map {$_->address} Mail::Address->parse(@rcpt); + #@addr or return (); + return 'No valid destination addresses found!' + unless(@addr); + + # Send it + + my $ok = $smtp->mail($envelope) + && $smtp->to(@addr) + && $smtp->data(join("", @{$head->header}, "\n", @{$self->body})); + + #$quit && $smtp->quit; + #$ok ? @addr : (); + if ( $ok ) { + $quit && $smtp->quit; + return ''; + } else { + return $smtp->code. ' '. $smtp->message; + } +} +package FS::Misc; +#eokludge + +=item send_fax OPTION => VALUE ... + +Options: + +I - (required) 10-digit phone number w/ area code + +I - (required) Array ref containing PostScript or TIFF Class F document + +-or- + +I - (required) Filename of PostScript TIFF Class F document + +...any other options will be passed to L + + +=cut + +sub send_fax { + + my %options = @_; + + die 'HylaFAX support has not been configured.' + unless $conf->exists('hylafax'); + + eval { + require Fax::Hylafax::Client; + }; + + if ($@) { + if ($@ =~ /^Can't locate Fax.*/) { + die "You must have Fax::Hylafax::Client installed to use invoice faxing." + } else { + die $@; + } + } + + my %hylafax_opts = map { split /\s+/ } $conf->config('hylafax'); + + die 'Called send_fax without a \'dialstring\'.' + unless exists($options{'dialstring'}); + + if (exists($options{'docdata'}) and ref($options{'docdata'}) eq 'ARRAY') { + my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc; + my $fh = new File::Temp( + TEMPLATE => 'faxdoc.'. $options{'dialstring'} . '.XXXXXXXX', + DIR => $dir, + UNLINK => 0, + ) or die "can't open temp file: $!\n"; + + $options{docfile} = $fh->filename; + + print $fh @{$options{'docdata'}}; + close $fh; + + delete $options{'docdata'}; + } + + die 'Called send_fax without a \'docfile\' or \'docdata\'.' + unless exists($options{'docfile'}); + + #FIXME: Need to send canonical dialstring to HylaFAX, but this only + # works in the US. + + $options{'dialstring'} =~ s/[^\d\+]//g; + if ($options{'dialstring'} =~ /^\d{10}$/) { + $options{dialstring} = '+1' . $options{'dialstring'}; + } else { + return 'Invalid dialstring ' . $options{'dialstring'} . '.'; + } + + my $faxjob = &Fax::Hylafax::Client::sendfax(%options, %hylafax_opts); + + if ($faxjob->success) { + warn "Successfully queued fax to '$options{dialstring}' with jobid " . + $faxjob->jobid + if $DEBUG; + return ''; + } else { + return 'Error while sending FAX: ' . $faxjob->trace; + } + +} + +=item states_hash COUNTRY + +Returns a list of key/value pairs containing state (or other sub-country +division) abbriviations and names. + +=cut + +use FS::Record qw(qsearch); +use Locale::SubCountry; + +sub states_hash { + my($country) = @_; + + my @states = +# sort + map { s/[\n\r]//g; $_; } + map { $_->state; } + qsearch({ + 'select' => 'state', + 'table' => 'cust_main_county', + 'hashref' => { 'country' => $country }, + 'extra_sql' => 'GROUP BY state', + }); + + #it could throw a fatal "Invalid country code" error (for example "AX") + my $subcountry = eval { new Locale::SubCountry($country) } + or return ( '', '(n/a)' ); + + #"i see your schwartz is as big as mine!" + map { ( $_->[0] => $_->[1] ) } + sort { $a->[1] cmp $b->[1] } + map { [ $_ => state_label($_, $subcountry) ] } + @states; } +=item counties STATE COUNTRY + +Returns a list of counties for this state and country. + +=cut + +sub counties { + my( $state, $country ) = @_; + + sort map { s/[\n\r]//g; $_; } + map { $_->county } + qsearch({ + 'select' => 'DISTINCT county', + 'table' => 'cust_main_county', + 'hashref' => { 'state' => $state, + 'country' => $country, + }, + }); +} + +=item state_label STATE COUNTRY_OR_LOCALE_SUBCOUNRY_OBJECT + +=cut + +sub state_label { + my( $state, $country ) = @_; + + unless ( ref($country) ) { + $country = eval { new Locale::SubCountry($country) } + or return'(n/a)'; + + } + + # US kludge to avoid changing existing behaviour + # also we actually *use* the abbriviations... + my $full_name = $country->country_code eq 'US' + ? '' + : $country->full_name($state); + + $full_name = '' if $full_name eq 'unknown'; + $full_name =~ s/$see also.*$\s*$//; + $full_name .= " ($state)" if $full_name; + + $full_name || $state || '(n/a)'; + +} + +=item card_types + +Returns a hash reference of the accepted credit card types. Keys are shorter +identifiers and values are the longer strings used by the system (see +L). + +=cut + +#$conf from above + +sub card_types { + my $conf = new FS::Conf; + + my %card_types = ( + #displayname #value (Business::CreditCard) + "VISA" => "VISA card", + "MasterCard" => "MasterCard", + "Discover" => "Discover card", + "American Express" => "American Express card", + "Diner's Club/Carte Blanche" => "Diner's Club/Carte Blanche", + "enRoute" => "enRoute", + "JCB" => "JCB", + "BankCard" => "BankCard", + "Switch" => "Switch", + "Solo" => "Solo", + ); + my @conf_card_types = grep { ! /^\s*$/ } $conf->config('card-types'); + if ( @conf_card_types ) { + #perhaps the hash is backwards for this, but this way works better for + #usage in selfservice + %card_types = map { $_ => $card_types{$_} } + grep { + my $d = $_; + grep { $card_types{$d} eq $_ } @conf_card_types + } + keys %card_types; + } + + \%card_types; +} + +=item generate_ps FILENAME + +Returns an postscript rendition of the LaTex file, as a scalar. +FILENAME does not contain the .tex suffix and is unlinked by this function. + +=cut + +use String::ShellQuote; + +sub generate_ps { + my $file = shift; + + my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc; + chdir($dir); + + _pslatex($file); + + system('dvips', '-q', '-t', 'letter', "$file.dvi", '-o', "$file.ps" ) == 0 + or die "dvips failed"; + + open(POSTSCRIPT, "<$file.ps") + or die "can't open $file.ps: $! (error in LaTeX template?)\n"; + + unlink("$file.dvi", "$file.log", "$file.aux", "$file.ps", "$file.tex"); + + my $ps = ''; + + if ( $conf->exists('lpr-postscript_prefix') ) { + my $prefix = $conf->config('lpr-postscript_prefix'); + $ps .= eval qq("$prefix"); + } + + while () { + $ps .= $_; + } + + close POSTSCRIPT; + + if ( $conf->exists('lpr-postscript_suffix') ) { + my $suffix = $conf->config('lpr-postscript_suffix'); + $ps .= eval qq("$suffix"); + } + + return $ps; + +} + +=item generate_pdf FILENAME + +Returns an PDF rendition of the LaTex file, as a scalar. FILENAME does not +contain the .tex suffix and is unlinked by this function. + +=cut + +use String::ShellQuote; + +sub generate_pdf { + my $file = shift; + + my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc; + chdir($dir); + + #system('pdflatex', "$file.tex"); + #system('pdflatex', "$file.tex"); + #! LaTeX Error: Unknown graphics extension: .eps. + + _pslatex($file); + + my $sfile = shell_quote $file; + + #system('dvipdf', "$file.dvi", "$file.pdf" ); + system( + "dvips -q -t letter -f $sfile.dvi ". + "| gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=$sfile.pdf ". + " -c save pop -" + ) == 0 + or die "dvips | gs failed: $!"; + + open(PDF, "<$file.pdf") + or die "can't open $file.pdf: $! (error in LaTeX template?)\n"; + + unlink("$file.dvi", "$file.log", "$file.aux", "$file.pdf", "$file.tex"); + + my $pdf = ''; + while () { + $pdf .= $_; + } + + close PDF; + + return $pdf; + +} + +sub _pslatex { + my $file = shift; + + #my $sfile = shell_quote $file; + + my @cmd = ( + 'latex', + '-interaction=batchmode', + '\AtBeginDocument{\RequirePackage{pslatex}}', + '\def\PSLATEXTMP{\futurelet\PSLATEXTMP\PSLATEXTMPB}', + '\def\PSLATEXTMPB{\ifx\PSLATEXTMP\nonstopmode\else\input\fi}', + '\PSLATEXTMP', + "$file.tex" + ); + + my $timeout = 30; #? should be more than enough + + for ( 1, 2 ) { + + local($SIG{CHLD}) = sub {}; + #run( \@cmd, '>'=>'/dev/null', '2>'=>'/dev/null', timeout($timeout) ) + run( \@cmd, timeout($timeout) ) + or die "pslatex $file.tex failed; see $file.log for details?\n"; + + } + +} + +=item print ARRAYREF + +Sends the lines in ARRAYREF to the printer. + +=cut + +sub do_print { + my $data = shift; + + my $lpr = $conf->config('lpr'); + + my $outerr = ''; + run3 $lpr, $data, \$outerr, \$outerr; + if ( $? ) { + $outerr = ": $outerr" if length($outerr); + die "Error from $lpr (exit status ". ($?>>8). ")$outerr\n"; + } + +} + +=back + =head1 BUGS This package exists. @@ -90,6 +639,8 @@ This package exists. L, L, L, the base documentation. +L + =cut 1;