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
13 #do NOT depend on any FS:: modules here, causes weird (sometimes unreproducable
14 #until on client machine) dependancy loops. put them in FS::Misc::Something
17 @ISA = qw( Exporter );
18 @EXPORT_OK = qw( send_email generate_email send_fax
19 states_hash counties cities state_label
22 generate_ps generate_pdf do_print
33 FS::Misc - Miscellaneous subroutines
37 use FS::Misc qw(send_email);
43 Miscellaneous subroutines. This module contains miscellaneous subroutines
44 called from multiple other modules. These are not OO or necessarily related,
45 but are collected here to eliminate code duplication.
51 =item send_email OPTION => VALUE ...
63 (required) comma-separated scalar or arrayref of recipients
71 (optional) MIME type for the body
75 (required unless I<nobody> is true) arrayref of body text lines
79 (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().
83 (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,
84 I<content-type>, if specified, overrides the default "multipart/mixed" for the outermost MIME container.
86 =item content-encoding
88 (optional) when using nobody, optional top-level MIME
89 encoding which, if specified, overrides the default "7bit".
93 (optional) type parameter for multipart/related messages
97 (optional) L<FS::cust_main> key; if passed, the message will be logged
98 (if logging is enabled) with this custnum.
102 (optional) L<FS::msg_template> key, for logging.
108 use vars qw( $conf );
111 use Email::Sender::Simple qw(sendmail);
112 use Email::Sender::Transport::SMTP;
113 use Email::Sender::Transport::SMTP::TLS 0.11;
116 FS::UID->install_callback( sub {
117 $conf = new FS::Conf;
123 my %doptions = %options;
124 $doptions{'body'} = '(full body not shown in debug)';
125 warn "FS::Misc::send_email called with options:\n ". Dumper(\%doptions);
126 # join("\n", map { " $_: ". $options{$_} } keys %options ). "\n"
129 my @to = ref($options{to}) ? @{ $options{to} } : ( $options{to} );
133 if ( $options{'nobody'} ) {
135 croak "'mimeparts' option required when 'nobody' option given\n"
136 unless $options{'mimeparts'};
138 @mimeparts = @{$options{'mimeparts'}};
141 'Type' => ( $options{'content-type'} || 'multipart/mixed' ),
142 'Encoding' => ( $options{'content-encoding'} || '7bit' ),
147 @mimeparts = @{$options{'mimeparts'}}
148 if ref($options{'mimeparts'}) eq 'ARRAY';
150 if (scalar(@mimeparts)) {
153 'Type' => 'multipart/mixed',
154 'Encoding' => '7bit',
157 unshift @mimeparts, {
158 'Type' => ( $options{'content-type'} || 'text/plain' ),
159 'Charset' => 'UTF-8',
160 'Data' => $options{'body'},
161 'Encoding' => ( $options{'content-type'} ? '-SUGGEST' : '7bit' ),
162 'Disposition' => 'inline',
168 'Type' => ( $options{'content-type'} || 'text/plain' ),
169 'Data' => $options{'body'},
170 'Encoding' => ( $options{'content-type'} ? '-SUGGEST' : '7bit' ),
171 'Charset' => 'UTF-8',
178 my $from = $options{from};
179 $from =~ s/^\s*//; $from =~ s/\s*$//;
180 if ( $from =~ /^(.*)\s*<(.*@.*)>$/ ) {
186 if ( $from =~ /\@([\w\.\-]+)/ ) {
189 warn 'no domain found in invoice from address '. $options{'from'}.
190 '; constructing Message-ID (and saying HELO) @example.com';
191 $domain = 'example.com';
193 my $message_id = join('.', rand()*(2**32), $$, time). "\@$domain";
196 my $message = MIME::Entity->build(
197 'From' => $options{'from'},
198 'To' => join(', ', @to),
199 'Sender' => $options{'from'},
200 'Reply-To' => $options{'from'},
201 'Date' => time2str("%a, %d %b %Y %X %z", $time),
202 'Subject' => Encode::encode('MIME-Header', $options{'subject'}),
203 'Message-ID' => "<$message_id>",
207 if ( $options{'type'} ) {
208 #false laziness w/cust_bill::generate_email
209 $message->head->replace('Content-type',
211 '; boundary="'. $message->head->multipart_boundary. '"'.
212 '; type='. $options{'type'}
216 foreach my $part (@mimeparts) {
218 if ( UNIVERSAL::isa($part, 'MIME::Entity') ) {
220 warn "attaching MIME part from MIME::Entity object\n"
222 $message->add_part($part);
224 } elsif ( ref($part) eq 'HASH' ) {
226 warn "attaching MIME part from hashref:\n".
227 join("\n", map " $_: ".$part->{$_}, keys %$part ). "\n"
229 $message->attach(%$part);
232 croak "mimepart $part isn't a hashref or MIME::Entity object!";
239 my %smtp_opt = ( 'host' => $conf->config('smtpmachine'),
243 my($port, $enc) = split('-', ($conf->config('smtp-encryption') || '25') );
244 $smtp_opt{'port'} = $port;
247 if ( defined($enc) && $enc eq 'starttls' ) {
248 $smtp_opt{$_} = $conf->config("smtp-$_") for qw(username password);
249 $transport = Email::Sender::Transport::SMTP::TLS->new( %smtp_opt );
251 if ( $conf->exists('smtp-username') && $conf->exists('smtp-password') ) {
252 $smtp_opt{"sasl_$_"} = $conf->config("smtp-$_") for qw(username password);
254 $smtp_opt{'ssl'} = 1 if defined($enc) && $enc eq 'tls';
255 $transport = Email::Sender::Transport::SMTP->new( %smtp_opt );
258 push @to, $options{bcc} if defined($options{bcc});
259 local $@; # just in case
260 eval { sendmail($message, { transport => $transport,
265 if(ref($@) and $@->isa('Email::Sender::Failure')) {
266 $error = $@->code.' ' if $@->code;
267 $error .= $@->message;
274 if ( $conf->exists('log_sent_mail') ) {
275 my $cust_msg = FS::cust_msg->new({
276 'env_from' => $options{'from'},
277 'env_to' => join(', ', @to),
278 'header' => $message->header_as_string,
279 'body' => $message->body_as_string,
282 'custnum' => $options{'custnum'},
283 'msgnum' => $options{'msgnum'},
284 'status' => ($error ? 'failed' : 'sent'),
285 'msgtype' => $options{'msgtype'},
287 $cust_msg->insert; # ignore errors
293 =item generate_email OPTION => VALUE ...
301 Sender address, required
305 Recipient address, required
309 Blind copy address, optional
313 email subject, required
317 Email body (HTML alternative). Arrayref of lines, or scalar.
319 Will be placed inside an HTML <BODY> tag.
323 Email body (Text alternative). Arrayref of lines, or scalar.
325 =item custnum, msgnum (optional)
327 Customer and template numbers, passed through to send_email for logging.
331 Constructs a multipart message from text_body and html_body.
335 #false laziness w/FS::cust_bill::generate_email
343 my $me = '[FS::Misc::generate_email]';
345 my @fields = qw(from to bcc subject custnum msgnum msgtype);
347 @return{@fields} = @args{@fields};
349 warn "$me creating HTML/text multipart message"
352 $return{'nobody'} = 1;
354 my $alternative = build MIME::Entity
355 'Type' => 'multipart/alternative',
356 'Encoding' => '7bit',
357 'Disposition' => 'inline'
361 if ( ref($args{'text_body'}) eq 'ARRAY' ) {
362 $data = join("\n", @{ $args{'text_body'} });
364 $data = $args{'text_body'};
367 $alternative->attach(
368 'Type' => 'text/plain',
369 'Encoding' => 'quoted-printable',
370 'Charset' => 'UTF-8',
371 #'Encoding' => '7bit',
373 'Disposition' => 'inline',
377 if ( ref($args{'html_body'}) eq 'ARRAY' ) {
378 @html_data = @{ $args{'html_body'} };
380 @html_data = split(/\n/, $args{'html_body'});
383 $alternative->attach(
384 'Type' => 'text/html',
385 'Encoding' => 'quoted-printable',
386 'Data' => [ '<html>',
389 ' '. encode_entities($return{'subject'}),
392 ' <body bgcolor="#ffffff">',
397 'Disposition' => 'inline',
398 #'Filename' => 'invoice.pdf',
401 #no other attachment:
403 # multipart/alternative
407 $return{'content-type'} = 'multipart/related';
408 $return{'mimeparts'} = [ $alternative ];
409 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
410 #$return{'disposition'} = 'inline';
416 =item send_fax OPTION => VALUE ...
420 I<dialstring> - (required) 10-digit phone number w/ area code
422 I<docdata> - (required) Array ref containing PostScript or TIFF Class F document
426 I<docfile> - (required) Filename of PostScript TIFF Class F document
428 ...any other options will be passed to L<Fax::Hylafax::Client::sendfax>
437 die 'HylaFAX support has not been configured.'
438 unless $conf->exists('hylafax');
441 require Fax::Hylafax::Client;
445 if ($@ =~ /^Can't locate Fax.*/) {
446 die "You must have Fax::Hylafax::Client installed to use invoice faxing."
452 my %hylafax_opts = map { split /\s+/ } $conf->config('hylafax');
454 die 'Called send_fax without a \'dialstring\'.'
455 unless exists($options{'dialstring'});
457 if (exists($options{'docdata'}) and ref($options{'docdata'}) eq 'ARRAY') {
458 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
459 my $fh = new File::Temp(
460 TEMPLATE => 'faxdoc.'. $options{'dialstring'} . '.XXXXXXXX',
463 ) or die "can't open temp file: $!\n";
465 $options{docfile} = $fh->filename;
467 print $fh @{$options{'docdata'}};
470 delete $options{'docdata'};
473 die 'Called send_fax without a \'docfile\' or \'docdata\'.'
474 unless exists($options{'docfile'});
476 #FIXME: Need to send canonical dialstring to HylaFAX, but this only
479 $options{'dialstring'} =~ s/[^\d\+]//g;
480 if ($options{'dialstring'} =~ /^\d{10}$/) {
481 $options{dialstring} = '+1' . $options{'dialstring'};
483 return 'Invalid dialstring ' . $options{'dialstring'} . '.';
486 my $faxjob = &Fax::Hylafax::Client::sendfax(%options, %hylafax_opts);
488 if ($faxjob->success) {
489 warn "Successfully queued fax to '$options{dialstring}' with jobid " .
494 return 'Error while sending FAX: ' . $faxjob->trace;
499 =item states_hash COUNTRY
501 Returns a list of key/value pairs containing state (or other sub-country
502 division) abbriviations and names.
506 use FS::Record qw(qsearch);
507 use Locale::SubCountry;
514 map { s/[\n\r]//g; $_; }
518 'table' => 'cust_main_county',
519 'hashref' => { 'country' => $country },
520 'extra_sql' => 'GROUP BY state',
523 #it could throw a fatal "Invalid country code" error (for example "AX")
524 my $subcountry = eval { new Locale::SubCountry($country) }
525 or return (); # ( '', '(n/a)' );
527 #"i see your schwartz is as big as mine!"
528 map { ( $_->[0] => $_->[1] ) }
529 sort { $a->[1] cmp $b->[1] }
530 map { [ $_ => state_label($_, $subcountry) ] }
534 =item counties STATE COUNTRY
536 Returns a list of counties for this state and country.
541 my( $state, $country ) = @_;
543 map { $_ } #return num_counties($state, $country) unless wantarray;
544 sort map { s/[\n\r]//g; $_; }
547 'select' => 'DISTINCT county',
548 'table' => 'cust_main_county',
549 'hashref' => { 'state' => $state,
550 'country' => $country,
555 =item cities COUNTY STATE COUNTRY
557 Returns a list of cities for this county, state and country.
562 my( $county, $state, $country ) = @_;
564 map { $_ } #return num_cities($county, $state, $country) unless wantarray;
565 sort map { s/[\n\r]//g; $_; }
568 'select' => 'DISTINCT city',
569 'table' => 'cust_main_county',
570 'hashref' => { 'county' => $county,
572 'country' => $country,
577 =item state_label STATE COUNTRY_OR_LOCALE_SUBCOUNRY_OBJECT
582 my( $state, $country ) = @_;
584 unless ( ref($country) ) {
585 $country = eval { new Locale::SubCountry($country) }
590 # US kludge to avoid changing existing behaviour
591 # also we actually *use* the abbriviations...
592 my $full_name = $country->country_code eq 'US'
594 : $country->full_name($state);
596 $full_name = '' if $full_name eq 'unknown';
597 $full_name =~ s/\(see also.*\)\s*$//;
598 $full_name .= " ($state)" if $full_name;
600 $full_name || $state || '(n/a)';
606 Returns a hash reference of the accepted credit card types. Keys are shorter
607 identifiers and values are the longer strings used by the system (see
608 L<Business::CreditCard>).
615 my $conf = new FS::Conf;
618 #displayname #value (Business::CreditCard)
619 "VISA" => "VISA card",
620 "MasterCard" => "MasterCard",
621 "Discover" => "Discover card",
622 "American Express" => "American Express card",
623 "Diner's Club/Carte Blanche" => "Diner's Club/Carte Blanche",
624 "enRoute" => "enRoute",
626 "BankCard" => "BankCard",
627 "Switch" => "Switch",
630 my @conf_card_types = grep { ! /^\s*$/ } $conf->config('card-types');
631 if ( @conf_card_types ) {
632 #perhaps the hash is backwards for this, but this way works better for
633 #usage in selfservice
634 %card_types = map { $_ => $card_types{$_} }
637 grep { $card_types{$d} eq $_ } @conf_card_types
647 Returns a hash reference of allowed package billing frequencies.
652 tie my %freq, 'Tie::IxHash', (
653 '0' => '(no recurring fee)',
656 '2d' => 'every two days',
657 '3d' => 'every three days',
659 '2w' => 'biweekly (every 2 weeks)',
661 '45d' => 'every 45 days',
662 '2' => 'bimonthly (every 2 months)',
663 '3' => 'quarterly (every 3 months)',
664 '4' => 'every 4 months',
665 '137d' => 'every 4 1/2 months (137 days)',
666 '6' => 'semiannually (every 6 months)',
668 '13' => 'every 13 months (annually +1 month)',
669 '24' => 'biannually (every 2 years)',
670 '36' => 'triannually (every 3 years)',
671 '48' => '(every 4 years)',
672 '60' => '(every 5 years)',
673 '120' => '(every 10 years)',
678 =item generate_ps FILENAME
680 Returns an postscript rendition of the LaTex file, as a scalar.
681 FILENAME does not contain the .tex suffix and is unlinked by this function.
685 use String::ShellQuote;
690 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
695 my $papersize = $conf->config('papersize') || 'letter';
697 system('dvips', '-q', '-t', $papersize, "$file.dvi", '-o', "$file.ps" ) == 0
698 or die "dvips failed";
700 open(POSTSCRIPT, "<$file.ps")
701 or die "can't open $file.ps: $! (error in LaTeX template?)\n";
703 unlink("$file.dvi", "$file.log", "$file.aux", "$file.ps", "$file.tex")
704 unless $FS::CurrentUser::CurrentUser->option('save_tmp_typesetting');
708 if ( $conf->exists('lpr-postscript_prefix') ) {
709 my $prefix = $conf->config('lpr-postscript_prefix');
710 $ps .= eval qq("$prefix");
713 while (<POSTSCRIPT>) {
719 if ( $conf->exists('lpr-postscript_suffix') ) {
720 my $suffix = $conf->config('lpr-postscript_suffix');
721 $ps .= eval qq("$suffix");
728 =item generate_pdf FILENAME
730 Returns an PDF rendition of the LaTex file, as a scalar. FILENAME does not
731 contain the .tex suffix and is unlinked by this function.
735 use String::ShellQuote;
740 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
743 #system('pdflatex', "$file.tex");
744 #system('pdflatex', "$file.tex");
745 #! LaTeX Error: Unknown graphics extension: .eps.
749 my $sfile = shell_quote $file;
751 #system('dvipdf', "$file.dvi", "$file.pdf" );
752 my $papersize = $conf->config('papersize') || 'letter';
755 "dvips -q -f $sfile.dvi -t $papersize ".
756 "| gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=$sfile.pdf ".
759 or die "dvips | gs failed: $!";
761 open(PDF, "<$file.pdf")
762 or die "can't open $file.pdf: $! (error in LaTeX template?)\n";
764 unlink("$file.dvi", "$file.log", "$file.aux", "$file.pdf", "$file.tex")
765 unless $FS::CurrentUser::CurrentUser->option('save_tmp_typesetting');
781 #my $sfile = shell_quote $file;
785 '-interaction=batchmode',
786 '\AtBeginDocument{\RequirePackage{pslatex}}',
787 '\def\PSLATEXTMP{\futurelet\PSLATEXTMP\PSLATEXTMPB}',
788 '\def\PSLATEXTMPB{\ifx\PSLATEXTMP\nonstopmode\else\input\fi}',
793 my $timeout = 30; #? should be more than enough
797 local($SIG{CHLD}) = sub {};
798 run( \@cmd, '>'=>'/dev/null', '2>'=>'/dev/null', timeout($timeout) )
799 or warn "bad exit status from pslatex pass $_\n";
803 return if -e "$file.dvi" && -s "$file.dvi";
804 die "pslatex $file.tex failed, see $file.log for details?\n";
808 =item do_print ARRAYREF [, OPTION => VALUE ... ]
810 Sends the lines in ARRAYREF to the printer.
812 Options available are:
818 Uses this agent's 'lpr' configuration setting override instead of the global
823 Uses this command instead of the configured lpr command (overrides both the
824 global value and agentnum).
829 my( $data, %opt ) = @_;
831 my $lpr = ( exists($opt{'lpr'}) && $opt{'lpr'} )
833 : $conf->config('lpr', $opt{'agentnum'} );
836 run3 $lpr, $data, \$outerr, \$outerr;
838 $outerr = ": $outerr" if length($outerr);
839 die "Error from $lpr (exit status ". ($?>>8). ")$outerr\n";
844 =item csv_from_fixed, FILEREF COUNTREF, [ LENGTH_LISTREF, [ CALLBACKS_LISTREF ] ]
846 Converts the filehandle referenced by FILEREF from fixed length record
847 lines to a CSV file according to the lengths specified in LENGTH_LISTREF.
848 The CALLBACKS_LISTREF refers to a correpsonding list of coderefs. Each
849 should return the value to be substituted in place of its single argument.
851 Returns false on success or an error if one occurs.
856 my( $fhref, $countref, $lengths, $callbacks) = @_;
858 eval { require Text::CSV_XS; };
862 my $unpacker = new Text::CSV_XS;
864 my $template = join('', map {$total += $_; "A$_"} @$lengths) if $lengths;
866 my $dir = "%%%FREESIDE_CACHE%%%/cache.$FS::UID::datasrc";
867 my $fh = new File::Temp( TEMPLATE => "FILE.csv.XXXXXXXX",
870 ) or return "can't open temp file: $!\n"
873 while ( defined(my $line=<$ofh>) ) {
879 return "unexpected input at line $$countref: $line".
880 " -- expected $total but received ". length($line)
881 unless length($line) == $total;
883 $unpacker->combine( map { my $i = $column++;
884 defined( $callbacks->[$i] )
885 ? &{ $callbacks->[$i] }( $_ )
887 } unpack( $template, $line )
889 or return "invalid data for CSV: ". $unpacker->error_input;
891 print $fh $unpacker->string(), "\n"
892 or return "can't write temp file: $!\n";
896 if ( $template ) { close $$fhref; $$fhref = $fh }
902 =item ocr_image IMAGE_SCALAR
904 Runs OCR on the provided image data and returns a list of text lines.
909 my $logo_data = shift;
911 #XXX use conf dir location from Makefile
912 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
913 my $fh = new File::Temp(
914 TEMPLATE => 'bizcard.XXXXXXXX',
915 SUFFIX => '.png', #XXX assuming, but should handle jpg, gif, etc. too
918 ) or die "can't open temp file: $!\n";
920 my $filename = $fh->filename;
922 print $fh $logo_data;
925 run( [qw(ocroscript recognize), $filename], '>'=>"$filename.hocr" )
926 or die "ocroscript recognize failed\n";
928 run( [qw(ocroscript hocr-to-text), "$filename.hocr"], '>pipe'=>\*OUT )
929 or die "ocroscript hocr-to-text failed\n";
931 my @lines = split(/\n/, <OUT> );
933 foreach (@lines) { s/\.c0m\s*$/.com/; }
938 =item bytes_substr STRING, OFFSET[, LENGTH[, REPLACEMENT] ]
940 A replacement for "substr" that counts raw bytes rather than logical
941 characters. Unlike "bytes::substr", will suppress fragmented UTF-8 characters
942 rather than output them. Unlike real "substr", is not an lvalue.
947 my ($string, $offset, $length, $repl) = @_;
949 Encode::encode('utf8', $string),
952 Encode::encode('utf8', $repl)
954 my $chk = $DEBUG ? Encode::FB_WARN : Encode::FB_QUIET;
955 return Encode::decode('utf8', $bytes, $chk);
960 Accepts a postive or negative numerical value.
961 Returns amount formatted for display,
962 including money character.
968 my $money_char = $conf->{'money_char'} || '$';
969 $amount = sprintf("%0.2f",$amount);
970 $amount =~ s/^(-?)/$1$money_char/;
982 L<FS::UID>, L<FS::CGI>, L<FS::Record>, the base documentation.
984 L<Fax::Hylafax::Client>