1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
|
package FS::Misc;
use strict;
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 send_fax
states_hash counties state_label
card_types
generate_ps generate_pdf do_print
);
$DEBUG = 0;
=head1 NAME
FS::Misc - Miscellaneous subroutines
=head1 SYNOPSIS
use FS::Misc qw(send_email);
send_email();
=head1 DESCRIPTION
Miscellaneous subroutines. This module contains miscellaneous subroutines
called from multiple other modules. These are not OO or necessarily related,
but are collected here to elimiate code duplication.
=head1 SUBROUTINES
=over 4
=item send_email OPTION => VALUE ...
Options:
I<from> - (required)
I<to> - (required) comma-separated scalar or arrayref of recipients
I<subject> - (required)
I<content-type> - (optional) MIME type for the body
I<body> - (required unless I<nobody> is true) arrayref of body text lines
I<mimeparts> - (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().
I<nobody> - (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,
I<content-type>, if specified, overrides the default "multipart/mixed" for the outermost MIME container.
I<content-encoding> - (optional) when using nobody, optional top-level MIME
encoding which, if specified, overrides the default "7bit".
I<type> - (optional) type parameter for multipart/related messages
=cut
use vars qw( $conf );
use Date::Format;
use Mail::Header;
use Mail::Internet 2.00;
use MIME::Entity;
use FS::UID;
FS::UID->install_callback( sub {
$conf = new FS::Conf;
} );
sub send_email {
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 @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->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<dialstring> - (required) 10-digit phone number w/ area code
I<docdata> - (required) Array ref containing PostScript or TIFF Class F document
-or-
I<docfile> - (required) Filename of PostScript TIFF Class F document
...any other options will be passed to L<Fax::Hylafax::Client::sendfax>
=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<Business::CreditCard>).
=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 (<POSTSCRIPT>) {
$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>) {
$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.
=head1 SEE ALSO
L<FS::UID>, L<FS::CGI>, L<FS::Record>, the base documentation.
L<Fax::Hylafax::Client>
=cut
1;
|
