4 use vars qw ( @ISA @EXPORT_OK $DEBUG );
8 use IPC::Run qw( run timeout ); # for _pslatex
9 use IPC::Run3; # for do_print... should just use IPC::Run i guess
11 #do NOT depend on any FS:: modules here, causes weird (sometimes unreproducable
12 #until on client machine) dependancy loops. put them in FS::Misc::Something
15 @ISA = qw( Exporter );
16 @EXPORT_OK = qw( generate_email send_email send_fax
17 states_hash counties state_label
19 generate_ps generate_pdf do_print
27 FS::Misc - Miscellaneous subroutines
31 use FS::Misc qw(send_email);
37 Miscellaneous subroutines. This module contains miscellaneous subroutines
38 called from multiple other modules. These are not OO or necessarily related,
39 but are collected here to elimiate code duplication.
45 =item generate_email OPTION => VALUE ...
53 Sender address, required
57 Recipient address, required
61 email subject, required
65 Email body (HTML alternative). Arrayref of lines, or scalar.
67 Will be placed inside an HTML <BODY> tag.
71 Email body (Text alternative). Arrayref of lines, or scalar.
75 Returns an argument list to be passsed to L<send_email>.
79 #false laziness w/FS::cust_bill::generate_email
87 my $me = '[FS::Misc::generate_email]';
90 'from' => $args{'from'},
92 'subject' => $args{'subject'},
95 #if (ref($args{'to'}) eq 'ARRAY') {
96 # $return{'to'} = $args{'to'};
98 # $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
99 # $self->cust_main->invoicing_list
103 warn "$me creating HTML/text multipart message"
106 $return{'nobody'} = 1;
108 my $alternative = build MIME::Entity
109 'Type' => 'multipart/alternative',
110 'Encoding' => '7bit',
111 'Disposition' => 'inline'
115 if ( ref($args{'text_body'}) eq 'ARRAY' ) {
116 $data = $args{'text_body'};
118 $data = [ split(/\n/, $args{'text_body'}) ];
121 $alternative->attach(
122 'Type' => 'text/plain',
123 #'Encoding' => 'quoted-printable',
124 'Encoding' => '7bit',
126 'Disposition' => 'inline',
130 if ( ref($args{'html_body'}) eq 'ARRAY' ) {
131 @html_data = @{ $args{'html_body'} };
133 @html_data = split(/\n/, $args{'html_body'});
136 $alternative->attach(
137 'Type' => 'text/html',
138 'Encoding' => 'quoted-printable',
139 'Data' => [ '<html>',
142 ' '. encode_entities($return{'subject'}),
145 ' <body bgcolor="#e8e8e8">',
150 'Disposition' => 'inline',
151 #'Filename' => 'invoice.pdf',
154 #no other attachment:
156 # multipart/alternative
160 $return{'content-type'} = 'multipart/related';
161 $return{'mimeparts'} = [ $alternative ];
162 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
163 #$return{'disposition'} = 'inline';
169 =item send_email OPTION => VALUE ...
181 (required) comma-separated scalar or arrayref of recipients
189 (optional) MIME type for the body
193 (required unless I<nobody> is true) arrayref of body text lines
197 (optional, but required if I<nobody> is true) arrayref of MIME::Entity->build PARAMHASH refs or MIME::Entity objects. These will be passed as arguments to MIME::Entity->attach().
201 (optional) when set true, send_email will ignore the I<body> option and simply construct a message with the given I<mimeparts>. In this case,
202 I<content-type>, if specified, overrides the default "multipart/mixed" for the outermost MIME container.
204 =item content-encoding
206 (optional) when using nobody, optional top-level MIME
207 encoding which, if specified, overrides the default "7bit".
211 (optional) type parameter for multipart/related messages
217 use vars qw( $conf );
220 use Email::Sender::Simple qw(sendmail);
221 use Email::Sender::Transport::SMTP;
222 use Email::Sender::Transport::SMTP::TLS;
225 FS::UID->install_callback( sub {
226 $conf = new FS::Conf;
232 my %doptions = %options;
233 $doptions{'body'} = '(full body not shown in debug)';
234 warn "FS::Misc::send_email called with options:\n ". Dumper(\%doptions);
235 # join("\n", map { " $_: ". $options{$_} } keys %options ). "\n"
238 my $to = ref($options{to}) ? join(', ', @{ $options{to} } ) : $options{to};
242 if ( $options{'nobody'} ) {
244 croak "'mimeparts' option required when 'nobody' option given\n"
245 unless $options{'mimeparts'};
247 @mimeparts = @{$options{'mimeparts'}};
250 'Type' => ( $options{'content-type'} || 'multipart/mixed' ),
251 'Encoding' => ( $options{'content-encoding'} || '7bit' ),
256 @mimeparts = @{$options{'mimeparts'}}
257 if ref($options{'mimeparts'}) eq 'ARRAY';
259 if (scalar(@mimeparts)) {
262 'Type' => 'multipart/mixed',
263 'Encoding' => '7bit',
266 unshift @mimeparts, {
267 'Type' => ( $options{'content-type'} || 'text/plain' ),
268 'Data' => $options{'body'},
269 'Encoding' => ( $options{'content-type'} ? '-SUGGEST' : '7bit' ),
270 'Disposition' => 'inline',
276 'Type' => ( $options{'content-type'} || 'text/plain' ),
277 'Data' => $options{'body'},
278 'Encoding' => ( $options{'content-type'} ? '-SUGGEST' : '7bit' ),
286 if ( $options{'from'} =~ /\@([\w\.\-]+)/ ) {
289 warn 'no domain found in invoice from address '. $options{'from'}.
290 '; constructing Message-ID (and saying HELO) @example.com';
291 $domain = 'example.com';
293 my $message_id = join('.', rand()*(2**32), $$, time). "\@$domain";
295 my $message = MIME::Entity->build(
296 'From' => $options{'from'},
298 'Sender' => $options{'from'},
299 'Reply-To' => $options{'from'},
300 'Date' => time2str("%a, %d %b %Y %X %z", time),
301 'Subject' => $options{'subject'},
302 'Message-ID' => "<$message_id>",
306 if ( $options{'type'} ) {
307 #false laziness w/cust_bill::generate_email
308 $message->head->replace('Content-type',
310 '; boundary="'. $message->head->multipart_boundary. '"'.
311 '; type='. $options{'type'}
315 foreach my $part (@mimeparts) {
317 if ( UNIVERSAL::isa($part, 'MIME::Entity') ) {
319 warn "attaching MIME part from MIME::Entity object\n"
321 $message->add_part($part);
323 } elsif ( ref($part) eq 'HASH' ) {
325 warn "attaching MIME part from hashref:\n".
326 join("\n", map " $_: ".$part->{$_}, keys %$part ). "\n"
328 $message->attach(%$part);
331 croak "mimepart $part isn't a hashref or MIME::Entity object!";
338 my %smtp_opt = ( 'host' => $conf->config('smtpmachine'),
342 my($port, $enc) = split('-', ($conf->config('smtp-encryption') || '25') );
343 $smtp_opt{'port'} = $port;
346 if ( defined($enc) && $enc eq 'starttls' ) {
347 $smtp_opt{$_} = $conf->config("smtp-$_") for qw(username password);
348 $transport = Email::Sender::Transport::SMTP::TLS->new( %smtp_opt );
350 if ( $conf->exists('smtp-username') && $conf->exists('smtp-password') ) {
351 $smtp_opt{"sasl_$_"} = $conf->config("smtp-$_") for qw(username password);
353 $smtp_opt{'ssl'} = 1 if defined($enc) && $enc eq 'tls';
354 $transport = Email::Sender::Transport::SMTP->new( %smtp_opt );
357 eval { sendmail($message, { transport => $transport }); };
358 ref($@) ? ( $@->code ? $@->code.' ' : '' ). $@->message
363 =item send_fax OPTION => VALUE ...
367 I<dialstring> - (required) 10-digit phone number w/ area code
369 I<docdata> - (required) Array ref containing PostScript or TIFF Class F document
373 I<docfile> - (required) Filename of PostScript TIFF Class F document
375 ...any other options will be passed to L<Fax::Hylafax::Client::sendfax>
384 die 'HylaFAX support has not been configured.'
385 unless $conf->exists('hylafax');
388 require Fax::Hylafax::Client;
392 if ($@ =~ /^Can't locate Fax.*/) {
393 die "You must have Fax::Hylafax::Client installed to use invoice faxing."
399 my %hylafax_opts = map { split /\s+/ } $conf->config('hylafax');
401 die 'Called send_fax without a \'dialstring\'.'
402 unless exists($options{'dialstring'});
404 if (exists($options{'docdata'}) and ref($options{'docdata'}) eq 'ARRAY') {
405 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
406 my $fh = new File::Temp(
407 TEMPLATE => 'faxdoc.'. $options{'dialstring'} . '.XXXXXXXX',
410 ) or die "can't open temp file: $!\n";
412 $options{docfile} = $fh->filename;
414 print $fh @{$options{'docdata'}};
417 delete $options{'docdata'};
420 die 'Called send_fax without a \'docfile\' or \'docdata\'.'
421 unless exists($options{'docfile'});
423 #FIXME: Need to send canonical dialstring to HylaFAX, but this only
426 $options{'dialstring'} =~ s/[^\d\+]//g;
427 if ($options{'dialstring'} =~ /^\d{10}$/) {
428 $options{dialstring} = '+1' . $options{'dialstring'};
430 return 'Invalid dialstring ' . $options{'dialstring'} . '.';
433 my $faxjob = &Fax::Hylafax::Client::sendfax(%options, %hylafax_opts);
435 if ($faxjob->success) {
436 warn "Successfully queued fax to '$options{dialstring}' with jobid " .
441 return 'Error while sending FAX: ' . $faxjob->trace;
446 =item states_hash COUNTRY
448 Returns a list of key/value pairs containing state (or other sub-country
449 division) abbriviations and names.
453 use FS::Record qw(qsearch);
454 use Locale::SubCountry;
461 map { s/[\n\r]//g; $_; }
465 'table' => 'cust_main_county',
466 'hashref' => { 'country' => $country },
467 'extra_sql' => 'GROUP BY state',
470 #it could throw a fatal "Invalid country code" error (for example "AX")
471 my $subcountry = eval { new Locale::SubCountry($country) }
472 or return ( '', '(n/a)' );
474 #"i see your schwartz is as big as mine!"
475 map { ( $_->[0] => $_->[1] ) }
476 sort { $a->[1] cmp $b->[1] }
477 map { [ $_ => state_label($_, $subcountry) ] }
481 =item counties STATE COUNTRY
483 Returns a list of counties for this state and country.
488 my( $state, $country ) = @_;
490 sort map { s/[\n\r]//g; $_; }
493 'select' => 'DISTINCT county',
494 'table' => 'cust_main_county',
495 'hashref' => { 'state' => $state,
496 'country' => $country,
501 =item state_label STATE COUNTRY_OR_LOCALE_SUBCOUNRY_OBJECT
506 my( $state, $country ) = @_;
508 unless ( ref($country) ) {
509 $country = eval { new Locale::SubCountry($country) }
514 # US kludge to avoid changing existing behaviour
515 # also we actually *use* the abbriviations...
516 my $full_name = $country->country_code eq 'US'
518 : $country->full_name($state);
520 $full_name = '' if $full_name eq 'unknown';
521 $full_name =~ s/\(see also.*\)\s*$//;
522 $full_name .= " ($state)" if $full_name;
524 $full_name || $state || '(n/a)';
530 Returns a hash reference of the accepted credit card types. Keys are shorter
531 identifiers and values are the longer strings used by the system (see
532 L<Business::CreditCard>).
539 my $conf = new FS::Conf;
542 #displayname #value (Business::CreditCard)
543 "VISA" => "VISA card",
544 "MasterCard" => "MasterCard",
545 "Discover" => "Discover card",
546 "American Express" => "American Express card",
547 "Diner's Club/Carte Blanche" => "Diner's Club/Carte Blanche",
548 "enRoute" => "enRoute",
550 "BankCard" => "BankCard",
551 "Switch" => "Switch",
554 my @conf_card_types = grep { ! /^\s*$/ } $conf->config('card-types');
555 if ( @conf_card_types ) {
556 #perhaps the hash is backwards for this, but this way works better for
557 #usage in selfservice
558 %card_types = map { $_ => $card_types{$_} }
561 grep { $card_types{$d} eq $_ } @conf_card_types
569 =item generate_ps FILENAME
571 Returns an postscript rendition of the LaTex file, as a scalar.
572 FILENAME does not contain the .tex suffix and is unlinked by this function.
576 use String::ShellQuote;
581 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
586 system('dvips', '-q', '-t', 'letter', "$file.dvi", '-o', "$file.ps" ) == 0
587 or die "dvips failed";
589 open(POSTSCRIPT, "<$file.ps")
590 or die "can't open $file.ps: $! (error in LaTeX template?)\n";
592 unlink("$file.dvi", "$file.log", "$file.aux", "$file.ps", "$file.tex");
596 if ( $conf->exists('lpr-postscript_prefix') ) {
597 my $prefix = $conf->config('lpr-postscript_prefix');
598 $ps .= eval qq("$prefix");
601 while (<POSTSCRIPT>) {
607 if ( $conf->exists('lpr-postscript_suffix') ) {
608 my $suffix = $conf->config('lpr-postscript_suffix');
609 $ps .= eval qq("$suffix");
616 =item generate_pdf FILENAME
618 Returns an PDF rendition of the LaTex file, as a scalar. FILENAME does not
619 contain the .tex suffix and is unlinked by this function.
623 use String::ShellQuote;
628 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
631 #system('pdflatex', "$file.tex");
632 #system('pdflatex', "$file.tex");
633 #! LaTeX Error: Unknown graphics extension: .eps.
637 my $sfile = shell_quote $file;
639 #system('dvipdf', "$file.dvi", "$file.pdf" );
641 "dvips -q -t letter -f $sfile.dvi ".
642 "| gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=$sfile.pdf ".
645 or die "dvips | gs failed: $!";
647 open(PDF, "<$file.pdf")
648 or die "can't open $file.pdf: $! (error in LaTeX template?)\n";
650 unlink("$file.dvi", "$file.log", "$file.aux", "$file.pdf", "$file.tex");
666 #my $sfile = shell_quote $file;
670 '-interaction=batchmode',
671 '\AtBeginDocument{\RequirePackage{pslatex}}',
672 '\def\PSLATEXTMP{\futurelet\PSLATEXTMP\PSLATEXTMPB}',
673 '\def\PSLATEXTMPB{\ifx\PSLATEXTMP\nonstopmode\else\input\fi}',
678 my $timeout = 30; #? should be more than enough
682 local($SIG{CHLD}) = sub {};
683 run( \@cmd, '>'=>'/dev/null', '2>'=>'/dev/null', timeout($timeout) )
684 or die "pslatex $file.tex failed; see $file.log for details?\n";
692 Sends the lines in ARRAYREF to the printer.
699 my $lpr = $conf->config('lpr');
702 run3 $lpr, $data, \$outerr, \$outerr;
704 $outerr = ": $outerr" if length($outerr);
705 die "Error from $lpr (exit status ". ($?>>8). ")$outerr\n";
710 =item csv_from_fixed, FILEREF COUNTREF, [ LENGTH_LISTREF, [ CALLBACKS_LISTREF ] ]
712 Converts the filehandle referenced by FILEREF from fixed length record
713 lines to a CSV file according to the lengths specified in LENGTH_LISTREF.
714 The CALLBACKS_LISTREF refers to a correpsonding list of coderefs. Each
715 should return the value to be substituted in place of its single argument.
717 Returns false on success or an error if one occurs.
722 my( $fhref, $countref, $lengths, $callbacks) = @_;
724 eval { require Text::CSV_XS; };
728 my $unpacker = new Text::CSV_XS;
730 my $template = join('', map {$total += $_; "A$_"} @$lengths) if $lengths;
732 my $dir = "%%%FREESIDE_CACHE%%%/cache.$FS::UID::datasrc";
733 my $fh = new File::Temp( TEMPLATE => "FILE.csv.XXXXXXXX",
736 ) or return "can't open temp file: $!\n"
739 while ( defined(my $line=<$ofh>) ) {
745 return "unexpected input at line $$countref: $line".
746 " -- expected $total but received ". length($line)
747 unless length($line) == $total;
749 $unpacker->combine( map { my $i = $column++;
750 defined( $callbacks->[$i] )
751 ? &{ $callbacks->[$i] }( $_ )
753 } unpack( $template, $line )
755 or return "invalid data for CSV: ". $unpacker->error_input;
757 print $fh $unpacker->string(), "\n"
758 or return "can't write temp file: $!\n";
762 if ( $template ) { close $$fhref; $$fhref = $fh }
777 L<FS::UID>, L<FS::CGI>, L<FS::Record>, the base documentation.
779 L<Fax::Hylafax::Client>