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
31 FS::Misc - Miscellaneous subroutines
35 use FS::Misc qw(send_email);
41 Miscellaneous subroutines. This module contains miscellaneous subroutines
42 called from multiple other modules. These are not OO or necessarily related,
43 but are collected here to eliminate code duplication.
49 =item send_email OPTION => VALUE ...
61 (required) comma-separated scalar or arrayref of recipients
69 (optional) MIME type for the body
73 (required unless I<nobody> is true) arrayref of body text lines
77 (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().
81 (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,
82 I<content-type>, if specified, overrides the default "multipart/mixed" for the outermost MIME container.
84 =item content-encoding
86 (optional) when using nobody, optional top-level MIME
87 encoding which, if specified, overrides the default "7bit".
91 (optional) type parameter for multipart/related messages
95 (optional) L<FS::cust_main> key; if passed, the message will be logged
96 (if logging is enabled) with this custnum.
100 (optional) L<FS::msg_template> key, for logging.
106 use vars qw( $conf );
109 use Email::Sender::Simple qw(sendmail);
110 use Email::Sender::Transport::SMTP;
111 use Email::Sender::Transport::SMTP::TLS;
114 FS::UID->install_callback( sub {
115 $conf = new FS::Conf;
121 my %doptions = %options;
122 $doptions{'body'} = '(full body not shown in debug)';
123 warn "FS::Misc::send_email called with options:\n ". Dumper(\%doptions);
124 # join("\n", map { " $_: ". $options{$_} } keys %options ). "\n"
127 my @to = ref($options{to}) ? @{ $options{to} } : ( $options{to} );
131 if ( $options{'nobody'} ) {
133 croak "'mimeparts' option required when 'nobody' option given\n"
134 unless $options{'mimeparts'};
136 @mimeparts = @{$options{'mimeparts'}};
139 'Type' => ( $options{'content-type'} || 'multipart/mixed' ),
140 'Encoding' => ( $options{'content-encoding'} || '7bit' ),
145 @mimeparts = @{$options{'mimeparts'}}
146 if ref($options{'mimeparts'}) eq 'ARRAY';
148 if (scalar(@mimeparts)) {
151 'Type' => 'multipart/mixed',
152 'Encoding' => '7bit',
155 unshift @mimeparts, {
156 'Type' => ( $options{'content-type'} || 'text/plain' ),
157 'Data' => $options{'body'},
158 'Encoding' => ( $options{'content-type'} ? '-SUGGEST' : '7bit' ),
159 'Disposition' => 'inline',
165 'Type' => ( $options{'content-type'} || 'text/plain' ),
166 'Data' => $options{'body'},
167 'Encoding' => ( $options{'content-type'} ? '-SUGGEST' : '7bit' ),
175 if ( $options{'from'} =~ /\@([\w\.\-]+)/ ) {
178 warn 'no domain found in invoice from address '. $options{'from'}.
179 '; constructing Message-ID (and saying HELO) @example.com';
180 $domain = 'example.com';
182 my $message_id = join('.', rand()*(2**32), $$, time). "\@$domain";
185 my $message = MIME::Entity->build(
186 'From' => $options{'from'},
187 'To' => join(', ', @to),
188 'Sender' => $options{'from'},
189 'Reply-To' => $options{'from'},
190 'Date' => time2str("%a, %d %b %Y %X %z", $time),
191 'Subject' => Encode::encode('MIME-Header', $options{'subject'}),
192 'Message-ID' => "<$message_id>",
196 if ( $options{'type'} ) {
197 #false laziness w/cust_bill::generate_email
198 $message->head->replace('Content-type',
200 '; boundary="'. $message->head->multipart_boundary. '"'.
201 '; type='. $options{'type'}
205 foreach my $part (@mimeparts) {
207 if ( UNIVERSAL::isa($part, 'MIME::Entity') ) {
209 warn "attaching MIME part from MIME::Entity object\n"
211 $message->add_part($part);
213 } elsif ( ref($part) eq 'HASH' ) {
215 warn "attaching MIME part from hashref:\n".
216 join("\n", map " $_: ".$part->{$_}, keys %$part ). "\n"
218 $message->attach(%$part);
221 croak "mimepart $part isn't a hashref or MIME::Entity object!";
228 my %smtp_opt = ( 'host' => $conf->config('smtpmachine'),
232 my($port, $enc) = split('-', ($conf->config('smtp-encryption') || '25') );
233 $smtp_opt{'port'} = $port;
236 if ( defined($enc) && $enc eq 'starttls' ) {
237 $smtp_opt{$_} = $conf->config("smtp-$_") for qw(username password);
238 $transport = Email::Sender::Transport::SMTP::TLS->new( %smtp_opt );
240 if ( $conf->exists('smtp-username') && $conf->exists('smtp-password') ) {
241 $smtp_opt{"sasl_$_"} = $conf->config("smtp-$_") for qw(username password);
243 $smtp_opt{'ssl'} = 1 if defined($enc) && $enc eq 'tls';
244 $transport = Email::Sender::Transport::SMTP->new( %smtp_opt );
247 push @to, $options{bcc} if defined($options{bcc});
248 local $@; # just in case
249 eval { sendmail($message, { transport => $transport,
250 from => $options{from},
254 if(ref($@) and $@->isa('Email::Sender::Failure')) {
255 $error = $@->code.' ' if $@->code;
256 $error .= $@->message;
263 if ( $conf->exists('log_sent_mail') and $options{'custnum'} ) {
264 my $cust_msg = FS::cust_msg->new({
265 'env_from' => $options{'from'},
266 'env_to' => join(', ', @to),
267 'header' => $message->header_as_string,
268 'body' => $message->body_as_string,
271 'custnum' => $options{'custnum'},
272 'msgnum' => $options{'msgnum'},
273 'status' => ($error ? 'failed' : 'sent'),
275 $cust_msg->insert; # ignore errors
281 =item generate_email OPTION => VALUE ...
289 Sender address, required
293 Recipient address, required
297 Blind copy address, optional
301 email subject, required
305 Email body (HTML alternative). Arrayref of lines, or scalar.
307 Will be placed inside an HTML <BODY> tag.
311 Email body (Text alternative). Arrayref of lines, or scalar.
313 =item custnum, msgnum (optional)
315 Customer and template numbers, passed through to send_email for logging.
319 Constructs a multipart message from text_body and html_body.
323 #false laziness w/FS::cust_bill::generate_email
331 my $me = '[FS::Misc::generate_email]';
333 my @fields = qw(from to bcc subject custnum msgnum);
335 @return{@fields} = @args{@fields};
337 warn "$me creating HTML/text multipart message"
340 $return{'nobody'} = 1;
342 my $alternative = build MIME::Entity
343 'Type' => 'multipart/alternative',
344 'Encoding' => '7bit',
345 'Disposition' => 'inline'
349 if ( ref($args{'text_body'}) eq 'ARRAY' ) {
350 $data = join("\n", @{ $args{'text_body'} });
352 $data = $args{'text_body'};
355 $alternative->attach(
356 'Type' => 'text/plain',
357 'Encoding' => 'quoted-printable',
358 #'Encoding' => '7bit',
360 'Disposition' => 'inline',
364 if ( ref($args{'html_body'}) eq 'ARRAY' ) {
365 @html_data = @{ $args{'html_body'} };
367 @html_data = split(/\n/, $args{'html_body'});
370 $alternative->attach(
371 'Type' => 'text/html',
372 'Encoding' => 'quoted-printable',
373 'Data' => [ '<html>',
376 ' '. encode_entities($return{'subject'}),
379 ' <body bgcolor="#ffffff">',
384 'Disposition' => 'inline',
385 #'Filename' => 'invoice.pdf',
388 #no other attachment:
390 # multipart/alternative
394 $return{'content-type'} = 'multipart/related';
395 $return{'mimeparts'} = [ $alternative ];
396 $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
397 #$return{'disposition'} = 'inline';
403 =item process_send_email OPTION => VALUE ...
405 Takes arguments as per generate_email() and sends the message. This
406 will die on any error and can be used in the job queue.
410 sub process_send_email {
412 my $error = send_email(generate_email(%message));
413 die "$error\n" if $error;
417 =item send_fax OPTION => VALUE ...
421 I<dialstring> - (required) 10-digit phone number w/ area code
423 I<docdata> - (required) Array ref containing PostScript or TIFF Class F document
427 I<docfile> - (required) Filename of PostScript TIFF Class F document
429 ...any other options will be passed to L<Fax::Hylafax::Client::sendfax>
438 die 'HylaFAX support has not been configured.'
439 unless $conf->exists('hylafax');
442 require Fax::Hylafax::Client;
446 if ($@ =~ /^Can't locate Fax.*/) {
447 die "You must have Fax::Hylafax::Client installed to use invoice faxing."
453 my %hylafax_opts = map { split /\s+/ } $conf->config('hylafax');
455 die 'Called send_fax without a \'dialstring\'.'
456 unless exists($options{'dialstring'});
458 if (exists($options{'docdata'}) and ref($options{'docdata'}) eq 'ARRAY') {
459 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
460 my $fh = new File::Temp(
461 TEMPLATE => 'faxdoc.'. $options{'dialstring'} . '.XXXXXXXX',
464 ) or die "can't open temp file: $!\n";
466 $options{docfile} = $fh->filename;
468 print $fh @{$options{'docdata'}};
471 delete $options{'docdata'};
474 die 'Called send_fax without a \'docfile\' or \'docdata\'.'
475 unless exists($options{'docfile'});
477 #FIXME: Need to send canonical dialstring to HylaFAX, but this only
480 $options{'dialstring'} =~ s/[^\d\+]//g;
481 if ($options{'dialstring'} =~ /^\d{10}$/) {
482 $options{dialstring} = '+1' . $options{'dialstring'};
484 return 'Invalid dialstring ' . $options{'dialstring'} . '.';
487 my $faxjob = &Fax::Hylafax::Client::sendfax(%options, %hylafax_opts);
489 if ($faxjob->success) {
490 warn "Successfully queued fax to '$options{dialstring}' with jobid " .
495 return 'Error while sending FAX: ' . $faxjob->trace;
500 =item states_hash COUNTRY
502 Returns a list of key/value pairs containing state (or other sub-country
503 division) abbriviations and names.
507 use FS::Record qw(qsearch);
508 use Locale::SubCountry;
515 map { s/[\n\r]//g; $_; }
519 'table' => 'cust_main_county',
520 'hashref' => { 'country' => $country },
521 'extra_sql' => 'GROUP BY state',
524 #it could throw a fatal "Invalid country code" error (for example "AX")
525 my $subcountry = eval { new Locale::SubCountry($country) }
526 or return ( '', '(n/a)' );
528 #"i see your schwartz is as big as mine!"
529 map { ( $_->[0] => $_->[1] ) }
530 sort { $a->[1] cmp $b->[1] }
531 map { [ $_ => state_label($_, $subcountry) ] }
535 =item counties STATE COUNTRY
537 Returns a list of counties for this state and country.
542 my( $state, $country ) = @_;
544 map { $_ } #return num_counties($state, $country) unless wantarray;
545 sort map { s/[\n\r]//g; $_; }
548 'select' => 'DISTINCT county',
549 'table' => 'cust_main_county',
550 'hashref' => { 'state' => $state,
551 'country' => $country,
556 =item cities COUNTY STATE COUNTRY
558 Returns a list of cities for this county, state and country.
563 my( $county, $state, $country ) = @_;
565 map { $_ } #return num_cities($county, $state, $country) unless wantarray;
566 sort map { s/[\n\r]//g; $_; }
569 'select' => 'DISTINCT city',
570 'table' => 'cust_main_county',
571 'hashref' => { 'county' => $county,
573 'country' => $country,
578 =item state_label STATE COUNTRY_OR_LOCALE_SUBCOUNRY_OBJECT
583 my( $state, $country ) = @_;
585 unless ( ref($country) ) {
586 $country = eval { new Locale::SubCountry($country) }
591 # US kludge to avoid changing existing behaviour
592 # also we actually *use* the abbriviations...
593 my $full_name = $country->country_code eq 'US'
595 : $country->full_name($state);
597 $full_name = '' if $full_name eq 'unknown';
598 $full_name =~ s/\(see also.*\)\s*$//;
599 $full_name .= " ($state)" if $full_name;
601 $full_name || $state || '(n/a)';
607 Returns a hash reference of the accepted credit card types. Keys are shorter
608 identifiers and values are the longer strings used by the system (see
609 L<Business::CreditCard>).
616 my $conf = new FS::Conf;
619 #displayname #value (Business::CreditCard)
620 "VISA" => "VISA card",
621 "MasterCard" => "MasterCard",
622 "Discover" => "Discover card",
623 "American Express" => "American Express card",
624 "Diner's Club/Carte Blanche" => "Diner's Club/Carte Blanche",
625 "enRoute" => "enRoute",
627 "BankCard" => "BankCard",
628 "Switch" => "Switch",
631 my @conf_card_types = grep { ! /^\s*$/ } $conf->config('card-types');
632 if ( @conf_card_types ) {
633 #perhaps the hash is backwards for this, but this way works better for
634 #usage in selfservice
635 %card_types = map { $_ => $card_types{$_} }
638 grep { $card_types{$d} eq $_ } @conf_card_types
648 Returns a hash reference of allowed package billing frequencies.
653 tie my %freq, 'Tie::IxHash', (
654 '0' => '(no recurring fee)',
657 '2d' => 'every two days',
658 '3d' => 'every three days',
660 '2w' => 'biweekly (every 2 weeks)',
662 '45d' => 'every 45 days',
663 '2' => 'bimonthly (every 2 months)',
664 '3' => 'quarterly (every 3 months)',
665 '4' => 'every 4 months',
666 '137d' => 'every 4 1/2 months (137 days)',
667 '6' => 'semiannually (every 6 months)',
669 '13' => 'every 13 months (annually +1 month)',
670 '24' => 'biannually (every 2 years)',
671 '36' => 'triannually (every 3 years)',
672 '48' => '(every 4 years)',
673 '60' => '(every 5 years)',
674 '120' => '(every 10 years)',
679 =item generate_ps FILENAME
681 Returns an postscript rendition of the LaTex file, as a scalar.
682 FILENAME does not contain the .tex suffix and is unlinked by this function.
686 use String::ShellQuote;
691 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
696 system('dvips', '-q', '-t', 'letter', "$file.dvi", '-o', "$file.ps" ) == 0
697 or die "dvips failed";
699 open(POSTSCRIPT, "<$file.ps")
700 or die "can't open $file.ps: $! (error in LaTeX template?)\n";
702 unlink("$file.dvi", "$file.log", "$file.aux", "$file.ps", "$file.tex")
703 unless $FS::CurrentUser::CurrentUser->option('save_tmp_typesetting');
707 if ( $conf->exists('lpr-postscript_prefix') ) {
708 my $prefix = $conf->config('lpr-postscript_prefix');
709 $ps .= eval qq("$prefix");
712 while (<POSTSCRIPT>) {
718 if ( $conf->exists('lpr-postscript_suffix') ) {
719 my $suffix = $conf->config('lpr-postscript_suffix');
720 $ps .= eval qq("$suffix");
727 =item generate_pdf FILENAME
729 Returns an PDF rendition of the LaTex file, as a scalar. FILENAME does not
730 contain the .tex suffix and is unlinked by this function.
734 use String::ShellQuote;
739 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
742 #system('pdflatex', "$file.tex");
743 #system('pdflatex', "$file.tex");
744 #! LaTeX Error: Unknown graphics extension: .eps.
748 my $sfile = shell_quote $file;
750 #system('dvipdf', "$file.dvi", "$file.pdf" );
752 "dvips -q -t letter -f $sfile.dvi ".
753 "| gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=$sfile.pdf ".
756 or die "dvips | gs failed: $!";
758 open(PDF, "<$file.pdf")
759 or die "can't open $file.pdf: $! (error in LaTeX template?)\n";
761 unlink("$file.dvi", "$file.log", "$file.aux", "$file.pdf", "$file.tex")
762 unless $FS::CurrentUser::CurrentUser->option('save_tmp_typesetting');
778 #my $sfile = shell_quote $file;
782 '-interaction=batchmode',
783 '\AtBeginDocument{\RequirePackage{pslatex}}',
784 '\def\PSLATEXTMP{\futurelet\PSLATEXTMP\PSLATEXTMPB}',
785 '\def\PSLATEXTMPB{\ifx\PSLATEXTMP\nonstopmode\else\input\fi}',
790 my $timeout = 30; #? should be more than enough
794 local($SIG{CHLD}) = sub {};
795 run( \@cmd, '>'=>'/dev/null', '2>'=>'/dev/null', timeout($timeout) )
796 or warn "bad exit status from pslatex pass $_\n";
800 return if -e "$file.dvi" && -s "$file.dvi";
801 die "pslatex $file.tex failed; see $file.log for details?\n";
805 =item do_print ARRAYREF [, OPTION => VALUE ... ]
807 Sends the lines in ARRAYREF to the printer.
809 Options available are:
815 Uses this agent's 'lpr' configuration setting override instead of the global
820 Uses this command instead of the configured lpr command (overrides both the
821 global value and agentnum).
826 my( $data, %opt ) = @_;
828 my $lpr = ( exists($opt{'lpr'}) && $opt{'lpr'} )
830 : $conf->config('lpr', $opt{'agentnum'} );
833 run3 $lpr, $data, \$outerr, \$outerr;
835 $outerr = ": $outerr" if length($outerr);
836 die "Error from $lpr (exit status ". ($?>>8). ")$outerr\n";
841 =item csv_from_fixed, FILEREF COUNTREF, [ LENGTH_LISTREF, [ CALLBACKS_LISTREF ] ]
843 Converts the filehandle referenced by FILEREF from fixed length record
844 lines to a CSV file according to the lengths specified in LENGTH_LISTREF.
845 The CALLBACKS_LISTREF refers to a correpsonding list of coderefs. Each
846 should return the value to be substituted in place of its single argument.
848 Returns false on success or an error if one occurs.
853 my( $fhref, $countref, $lengths, $callbacks) = @_;
855 eval { require Text::CSV_XS; };
859 my $unpacker = new Text::CSV_XS;
861 my $template = join('', map {$total += $_; "A$_"} @$lengths) if $lengths;
863 my $dir = "%%%FREESIDE_CACHE%%%/cache.$FS::UID::datasrc";
864 my $fh = new File::Temp( TEMPLATE => "FILE.csv.XXXXXXXX",
867 ) or return "can't open temp file: $!\n"
870 while ( defined(my $line=<$ofh>) ) {
876 return "unexpected input at line $$countref: $line".
877 " -- expected $total but received ". length($line)
878 unless length($line) == $total;
880 $unpacker->combine( map { my $i = $column++;
881 defined( $callbacks->[$i] )
882 ? &{ $callbacks->[$i] }( $_ )
884 } unpack( $template, $line )
886 or return "invalid data for CSV: ". $unpacker->error_input;
888 print $fh $unpacker->string(), "\n"
889 or return "can't write temp file: $!\n";
893 if ( $template ) { close $$fhref; $$fhref = $fh }
899 =item ocr_image IMAGE_SCALAR
901 Runs OCR on the provided image data and returns a list of text lines.
906 my $logo_data = shift;
908 #XXX use conf dir location from Makefile
909 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
910 my $fh = new File::Temp(
911 TEMPLATE => 'bizcard.XXXXXXXX',
912 SUFFIX => '.png', #XXX assuming, but should handle jpg, gif, etc. too
915 ) or die "can't open temp file: $!\n";
917 my $filename = $fh->filename;
919 print $fh $logo_data;
922 run( [qw(ocroscript recognize), $filename], '>'=>"$filename.hocr" )
923 or die "ocroscript recognize failed\n";
925 run( [qw(ocroscript hocr-to-text), "$filename.hocr"], '>pipe'=>\*OUT )
926 or die "ocroscript hocr-to-text failed\n";
928 my @lines = split(/\n/, <OUT> );
930 foreach (@lines) { s/\.c0m\s*$/.com/; }
943 L<FS::UID>, L<FS::CGI>, L<FS::Record>, the base documentation.
945 L<Fax::Hylafax::Client>