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
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
|
package FS::Misc;
use strict;
use vars qw ( @ISA @EXPORT_OK $DEBUG $DISABLE_ALL_NOTICES );
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
use File::Temp;
use Tie::IxHash;
use Encode;
#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 generate_email send_fax _sendmail
states_hash counties cities state_label
card_types
pkg_freqs
generate_ps generate_pdf do_print
csv_from_fixed
ocr_image
money_pretty
);
$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 eliminate code duplication.
=head1 DISABLE ALL NOTICES
Set $FS::Misc::DISABLE_ALL_NOTICES to suppress:
=over 4
=item FS::cust_bill::send_csv
=item FS::cust_bill::spool_csv
=item FS::msg_template::email::send_prepared
=item FS::Misc::send_email
=item FS::Misc::do_print
=item FS::Misc::send_fax
=item FS::Template_Mixin::postal_mail_fsinc
=back
=cut
$DISABLE_ALL_NOTICES = 0;
=head1 SUBROUTINES
=over 4
=item send_email OPTION => VALUE ...
Options:
=over 4
=item from
(required)
=item to
(required) comma-separated scalar or arrayref of recipients
=item subject
(required)
=item content-type
(optional) MIME type for the body
=item body
(required unless I<nobody> is true) arrayref of body text lines
=item 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().
=item 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.
=item content-encoding
(optional) when using nobody, optional top-level MIME
encoding which, if specified, overrides the default "7bit".
=item type
(optional) type parameter for multipart/related messages
=item custnum
(optional) L<FS::cust_main> key; if passed, the message will be logged
(if logging is enabled) with this custnum.
=item msgnum
(optional) L<FS::msg_template> key, for logging.
=back
=cut
use vars qw( $conf );
use Date::Format;
use MIME::Entity;
use Email::Sender::Simple qw(sendmail);
use Email::Sender::Transport::SMTP;
use FS::UID;
FS::UID->install_callback( sub {
$conf = new FS::Conf;
} );
sub send_email {
my(%options) = @_;
if ( $DISABLE_ALL_NOTICES ) {
warn 'send_email() disabled by $FS::Misc::DISABLE_ALL_NOTICES' if $DEBUG;
return;
}
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"
}
my @to = ref($options{to}) ? @{ $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' ),
'Charset' => 'UTF-8',
'Data' => ( $options{'content-type'} =~ /^text\//
? Encode::encode_utf8( $options{'body'} )
: $options{'body'}
),
'Encoding' => ( $options{'content-type'} ? '-SUGGEST' : '7bit' ),
'Disposition' => 'inline',
};
} else {
@mimeargs = (
'Type' => ( $options{'content-type'} || 'text/plain' ),
'Data' => ( $options{'content-type'} =~ /^text\//
? Encode::encode_utf8( $options{'body'} )
: $options{'body'}
),
'Encoding' => ( $options{'content-type'} ? '-SUGGEST' : '7bit' ),
'Charset' => 'UTF-8',
);
}
}
my $from = $options{from};
$from =~ s/^\s*//; $from =~ s/\s*$//;
if ( $from =~ /^(.*)\s*<(.*@.*)>$/ ) {
# a common idiom
$from = $2;
}
my $domain;
if ( $from =~ /\@([\w\.\-]+)/ ) {
$domain = $1;
} else {
warn 'no domain found in invoice from address '. $options{'from'}.
'; constructing Message-ID (and saying HELO) @example.com';
$domain = 'example.com';
}
my $message_id = join('.', rand()*(2**32), $$, time). "\@$domain";
my $time = time;
my $message = MIME::Entity->build(
'From' => $options{'from'},
'To' => join(', ', @to),
'Sender' => $options{'from'},
'Reply-To' => $options{'from'},
'Date' => time2str("%a, %d %b %Y %X %z", $time),
'Subject' => Encode::encode('MIME-Header', $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!";
}
}
#send the email
push @to, $options{bcc} if defined($options{bcc});
# fully unpack all addresses found in @to (including Bcc) to make the
# envelope list
my @env_to;
foreach my $dest (@to) {
push @env_to, map { $_->address } Email::Address->parse($dest);
}
my $error = _sendmail( $message, { 'from' => $from,
'to' => \@env_to,
'domain' => $domain,
}
);
# Logging
if ( $conf->exists('log_sent_mail') ) {
my $cust_msg = FS::cust_msg->new({
'env_from' => $options{'from'},
'env_to' => join(', ', @env_to),
'header' => $message->header_as_string,
'body' => $message->body_as_string,
'_date' => $time,
'error' => $error,
'custnum' => $options{'custnum'},
'msgnum' => $options{'msgnum'},
'status' => ($error ? 'failed' : 'sent'),
'msgtype' => $options{'msgtype'},
});
my $log_error = $cust_msg->insert;
warn "Error logging message: $log_error\n" if $log_error; # at least warn
}
$error;
}
sub _sendmail {
my($message, $options) = @_;
my $domain = delete $options->{'domain'};
my %smtp_opt = ( 'host' => $conf->config('smtpmachine'),
'helo' => $domain,
);
my($port, $enc) = split('-', ($conf->config('smtp-encryption') || '25') );
$smtp_opt{'port'} = $port;
if ( $conf->exists('smtp-username') && $conf->exists('smtp-password') ) {
$smtp_opt{"sasl_$_"} = $conf->config("smtp-$_") for qw(username password);
} elsif ( defined($enc) && $enc eq 'starttls') {
return "SMTP settings misconfiguration: STARTTLS enabled in ".
"smtp-encryption but smtp-username or smtp-password missing";
}
if ( defined($enc) ) {
$smtp_opt{'ssl'} = 'starttls' if $enc eq 'starttls';
$smtp_opt{'ssl'} = 1 if $enc eq 'tls';
}
$options->{'transport'} = Email::Sender::Transport::SMTP->new( %smtp_opt );
my $error = '';
local $SIG{__DIE__}; # don't want Mason __DIE__ handler active
local $@; # just in case
eval { sendmail($message, $options) };
if (ref($@) and $@->isa('Email::Sender::Failure')) {
$error = $@->code.' ' if $@->code;
$error .= $@->message;
} else {
$error = $@;
}
$error;
}
=item generate_email OPTION => VALUE ...
Options:
=over 4
=item from
Sender address, required
=item to
Recipient address, required
=item bcc
Blind copy address, optional
=item subject
email subject, required
=item html_body
Email body (HTML alternative). Arrayref of lines, or scalar.
Will be placed inside an HTML <BODY> tag.
=item text_body
Email body (Text alternative). Arrayref of lines, or scalar.
=item custnum, msgnum (optional)
Customer and template numbers, passed through to send_email for logging.
=back
Constructs a multipart message from text_body and html_body.
=cut
#false laziness w/FS::cust_bill::generate_email
use MIME::Entity;
use HTML::Entities;
sub generate_email {
my %args = @_;
my $me = '[FS::Misc::generate_email]';
my @fields = qw(from to bcc subject custnum msgnum msgtype);
my %return;
@return{@fields} = @args{@fields};
warn "$me creating HTML/text multipart message"
if $DEBUG;
$return{'nobody'} = 1;
my $alternative = build MIME::Entity
'Type' => 'multipart/alternative',
'Encoding' => '7bit',
'Disposition' => 'inline'
;
my $data;
if ( ref($args{'text_body'}) eq 'ARRAY' ) {
$data = join("\n", @{ $args{'text_body'} });
} else {
$data = $args{'text_body'};
}
$alternative->attach(
'Type' => 'text/plain',
'Encoding' => 'quoted-printable',
'Charset' => 'UTF-8',
#'Encoding' => '7bit',
'Data' => Encode::encode_utf8($data),
'Disposition' => 'inline',
);
my @html_data;
if ( ref($args{'html_body'}) eq 'ARRAY' ) {
@html_data = @{ $args{'html_body'} };
} else {
@html_data = split(/\n/, $args{'html_body'});
}
$alternative->attach(
'Type' => 'text/html',
'Encoding' => 'quoted-printable',
'Data' => [ '<html>',
' <head>',
' <title>',
' '. encode_entities($return{'subject'}),
' </title>',
' </head>',
' <body bgcolor="#ffffff">',
( map Encode::encode_utf8($_), @html_data ),
' </body>',
'</html>',
],
'Disposition' => 'inline',
#'Filename' => 'invoice.pdf',
);
#no other attachment:
# multipart/related
# multipart/alternative
# text/plain
# text/html
$return{'content-type'} = 'multipart/related';
$return{'mimeparts'} = [ $alternative ];
$return{'type'} = 'multipart/alternative'; #Content-Type of first part...
#$return{'disposition'} = 'inline';
%return;
}
=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');
if ( $DISABLE_ALL_NOTICES ) {
warn 'send_fax() disabled by $FS::Misc::DISABLE_ALL_NOTICES' if $DEBUG;
return;
}
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) = @_;
#a hash? not expecting an explosion of business from unrecognized countries..
return states_hash_nosubcountry($country) if $country eq 'XC';
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;
}
sub states_hash_nosubcountry {
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',
});
#"i see your schwartz is as big as mine!"
map { ( $_->[0] => $_->[1] ) }
sort { $a->[1] cmp $b->[1] }
map { [ $_ => $_ ] }
@states;
}
=item counties STATE COUNTRY
Returns a list of counties for this state and country.
=cut
sub counties {
my( $state, $country ) = @_;
map { $_ } #return num_counties($state, $country) unless wantarray;
sort map { s/[\n\r]//g; $_; }
map { $_->county }
qsearch({
'select' => 'DISTINCT county',
'table' => 'cust_main_county',
'hashref' => { 'state' => $state,
'country' => $country,
},
});
}
=item cities COUNTY STATE COUNTRY
Returns a list of cities for this county, state and country.
=cut
sub cities {
my( $county, $state, $country ) = @_;
map { $_ } #return num_cities($county, $state, $country) unless wantarray;
sort map { s/[\n\r]//g; $_; }
map { $_->city }
qsearch({
'select' => 'DISTINCT city',
'table' => 'cust_main_county',
'hashref' => { 'county' => $county,
'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 pkg_freqs
Returns a hash reference of allowed package billing frequencies.
=cut
sub pkg_freqs {
tie my %freq, 'Tie::IxHash', (
'0' => '(no recurring fee)',
'1h' => 'hourly',
'1d' => 'daily',
'2d' => 'every two days',
'3d' => 'every three days',
'1w' => 'weekly',
'2w' => 'biweekly (every 2 weeks)',
'1' => 'monthly',
'45d' => 'every 45 days',
'2' => 'bimonthly (every 2 months)',
'3' => 'quarterly (every 3 months)',
'4' => 'every 4 months',
'137d' => 'every 4 1/2 months (137 days)',
'6' => 'semiannually (every 6 months)',
'12' => 'annually',
'13' => 'every 13 months (annually +1 month)',
'24' => 'biannually (every 2 years)',
'36' => 'triannually (every 3 years)',
'48' => '(every 4 years)',
'60' => '(every 5 years)',
'120' => '(every 10 years)',
) ;
\%freq;
}
=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);
my $papersize = $conf->config('papersize') || 'letter';
local($SIG{CHLD}) = sub {};
system('dvips', '-q', '-t', $papersize, "$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")
unless $FS::CurrentUser::CurrentUser->option('save_tmp_typesetting');
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" );
my $papersize = $conf->config('papersize') || 'letter';
local($SIG{CHLD}) = sub {};
system(
"dvips -q -f $sfile.dvi -t $papersize ".
"| 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")
unless $FS::CurrentUser::CurrentUser->option('save_tmp_typesetting');
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) )
or warn "bad exit status from pslatex pass $_\n";
}
return if -e "$file.dvi" && -s "$file.dvi";
die "pslatex $file.tex failed, see $file.log for details?\n";
}
=item do_print ARRAYREF [, OPTION => VALUE ... ]
Sends the lines in ARRAYREF to the printer.
Options available are:
=over 4
=item agentnum
Uses this agent's 'lpr' configuration setting override instead of the global
value.
=item lpr
Uses this command instead of the configured lpr command (overrides both the
global value and agentnum).
=cut
sub do_print {
my( $data, %opt ) = @_;
if ( $DISABLE_ALL_NOTICES ) {
warn 'do_print() disabled by $FS::Misc::DISABLE_ALL_NOTICES' if $DEBUG;
return;
}
my $lpr = ( exists($opt{'lpr'}) && $opt{'lpr'} )
? $opt{'lpr'}
: $conf->config('lpr', $opt{'agentnum'} );
my $outerr = '';
local($SIG{CHLD}) = sub {};
run3 $lpr, $data, \$outerr, \$outerr;
if ( $? ) {
$outerr = ": $outerr" if length($outerr);
die "Error from $lpr (exit status ". ($?>>8). ")$outerr\n";
}
}
=item csv_from_fixed, FILEREF COUNTREF, [ LENGTH_LISTREF, [ CALLBACKS_LISTREF ] ]
Converts the filehandle referenced by FILEREF from fixed length record
lines to a CSV file according to the lengths specified in LENGTH_LISTREF.
The CALLBACKS_LISTREF refers to a correpsonding list of coderefs. Each
should return the value to be substituted in place of its single argument.
Returns false on success or an error if one occurs.
=cut
sub csv_from_fixed {
my( $fhref, $countref, $lengths, $callbacks) = @_;
eval { require Text::CSV_XS; };
return $@ if $@;
my $ofh = $$fhref;
my $unpacker = new Text::CSV_XS;
my $total = 0;
my $template = join('', map {$total += $_; "A$_"} @$lengths) if $lengths;
my $dir = "%%%FREESIDE_CACHE%%%/cache.$FS::UID::datasrc";
my $fh = new File::Temp( TEMPLATE => "FILE.csv.XXXXXXXX",
DIR => $dir,
UNLINK => 0,
) or return "can't open temp file: $!\n"
if $template;
while ( defined(my $line=<$ofh>) ) {
$$countref++;
if ( $template ) {
my $column = 0;
chomp $line;
return "unexpected input at line $$countref: $line".
" -- expected $total but received ". length($line)
unless length($line) == $total;
$unpacker->combine( map { my $i = $column++;
defined( $callbacks->[$i] )
? &{ $callbacks->[$i] }( $_ )
: $_
} unpack( $template, $line )
)
or return "invalid data for CSV: ". $unpacker->error_input;
print $fh $unpacker->string(), "\n"
or return "can't write temp file: $!\n";
}
}
if ( $template ) { close $$fhref; $$fhref = $fh }
seek $$fhref, 0, 0;
'';
}
=item ocr_image IMAGE_SCALAR
Runs OCR on the provided image data and returns a list of text lines.
=cut
sub ocr_image {
my $logo_data = shift;
#XXX use conf dir location from Makefile
my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
my $fh = new File::Temp(
TEMPLATE => 'bizcard.XXXXXXXX',
SUFFIX => '.png', #XXX assuming, but should handle jpg, gif, etc. too
DIR => $dir,
UNLINK => 0,
) or die "can't open temp file: $!\n";
my $filename = $fh->filename;
print $fh $logo_data;
close $fh;
local($SIG{CHLD}) = sub {};
run( [qw(ocroscript recognize), $filename], '>'=>"$filename.hocr" )
or die "ocroscript recognize failed\n";
run( [qw(ocroscript hocr-to-text), "$filename.hocr"], '>pipe'=>\*OUT )
or die "ocroscript hocr-to-text failed\n";
my @lines = split(/\n/, <OUT> );
foreach (@lines) { s/\.c0m\s*$/.com/; }
@lines;
}
=item bytes_substr STRING, OFFSET[, LENGTH[, REPLACEMENT] ]
DEPRECATED
Use Unicode::Truncate truncate_egc instead
A replacement for "substr" that counts raw bytes rather than logical
characters. Unlike "bytes::substr", will suppress fragmented UTF-8 characters
rather than output them. Unlike real "substr", is not an lvalue.
=cut
# sub bytes_substr {
# my ($string, $offset, $length, $repl) = @_;
# my $bytes = substr(
# Encode::encode('utf8', $string),
# $offset,
# $length,
# Encode::encode('utf8', $repl)
# );
# my $chk = $DEBUG ? Encode::FB_WARN : Encode::FB_QUIET;
# return Encode::decode('utf8', $bytes, $chk);
# }
=item money_pretty
Accepts a postive or negative numerical value.
Returns amount formatted for display,
including money character.
=cut
sub money_pretty {
my $amount = shift;
my $money_char = $conf->{'money_char'} || '$';
$amount = sprintf("%0.2f",$amount);
$amount =~ s/^(-?)/$1$money_char/;
return $amount;
}
=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;
|
