71513: Card tokenization [v3 test tweak]
[freeside.git] / FS / FS / Mason.pm
1 package FS::Mason;
2
3 use strict;
4 use vars qw( @ISA @EXPORT_OK $addl_handler_use );
5 use Exporter;
6 use Carp;
7 use File::Slurp qw( slurp );
8 use HTML::Mason 1.27; #http://www.masonhq.com/?ApacheModPerl2Redirect
9 use HTML::Mason::Interp;
10 use HTML::Mason::Compiler::ToObject;
11
12 @ISA = qw( Exporter );
13 @EXPORT_OK = qw( mason_interps );
14
15 =head1 NAME
16
17 FS::Mason - Initialize the Mason environment
18
19 =head1 SYNOPSIS
20
21   use FS::Mason qw( mason_interps );
22
23   my( $fs_interp, $rt_interp ) = mason_interps('apache');
24
25   #OR
26
27   my( $fs_interp, $rt_interp ) = mason_interps('standalone'); #XXX name?
28
29 =head1 DESCRIPTION
30
31 Initializes the Mason environment, loads all Freeside and RT libraries, etc.
32
33 =cut
34
35 $addl_handler_use = '';
36 my $addl_handler_use_file = '%%%FREESIDE_CONF%%%/addl_handler_use.pl';
37 if ( -e $addl_handler_use_file ) {
38   $addl_handler_use = slurp( $addl_handler_use_file );
39 }
40
41 # List of modules that you want to use from components (see Admin
42 # manual for details)
43 {
44   package HTML::Mason::Commands;
45
46   use strict;
47   use vars qw( %session );
48   use CGI 3.29 qw(-private_tempfiles); #3.29 to fix RT attachment problems
49
50   #breaks quick payment entry
51   #http://rt.cpan.org/Public/Bug/Display.html?id=37365
52   die "CGI.pm v3.38 is broken, use any other version >= 3.29".
53       " (Debian 5.0?  aptitude remove libcgi-pm-perl)"
54     if $CGI::VERSION == 3.38;
55
56   #use CGI::Carp qw(fatalsToBrowser);
57   use CGI::Cookie;
58   use List::Util qw( max min sum );
59   use List::MoreUtils qw( first_index uniq );
60   use Scalar::Util qw( blessed looks_like_number );
61   use Data::Dumper;
62   use Date::Format;
63   use Time::Local;
64   use Time::HiRes;
65   use Time::Duration;
66   use DateTime;
67   use DateTime::Format::Strptime;
68   use FS::Misc::DateTime qw( parse_datetime );
69   use FS::Misc::Geo qw( get_district );
70   use Lingua::EN::Inflect qw(PL);
71   Lingua::EN::Inflect::classical names=>0; #Categorys
72   use Tie::IxHash;
73   use URI;
74   use URI::Escape 3.31;
75   use HTML::Entities;
76   use HTML::TreeBuilder;
77   use HTML::TableExtract qw(tree);
78   use HTML::FormatText;
79   use HTML::Defang;
80   use JSON::XS;
81 #  use XMLRPC::Transport::HTTP;
82 #  use XMLRPC::Lite; # for XMLRPC::Serializer
83   use MIME::Base64;
84   use IO::Handle;
85   use IO::File;
86   use IO::Scalar;
87   use IO::String;
88   use File::Slurp qw( slurp );
89   #not actually using this yet anyway...# use IPC::Run3 0.036;
90   use Net::Whois::Raw qw(whois);
91   if ( $] < 5.006 ) {
92     eval "use Net::Whois::Raw 0.32 qw(whois)";
93     die $@ if $@;
94   }
95   use Text::CSV_XS;
96   use Spreadsheet::WriteExcel;
97   use Spreadsheet::WriteExcel::Utility;
98   use OLE::Storage_Lite;
99   use Excel::Writer::XLSX;
100   #use Excel::Writer::XLSX::Utility; #redundant with above
101
102   use Business::CreditCard 0.35; #for new mastercard ranges and visa lengths
103   use NetAddr::IP;
104   use Net::MAC::Vendor;
105   use Net::Ping;
106   use Net::Ping::External;
107   #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
108   {
109     no warnings 'redefine';
110     eval 'sub Net::Ping::External::_ping_linux { 
111             my %args = @_;
112             my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
113             return Net::Ping::External::_ping_system($command, 0);
114           }
115          ';
116     die $@ if $@;
117   }
118   use String::Approx qw(amatch);
119   use Chart::LinesPoints;
120   use Chart::Mountain;
121   use Chart::Bars;
122   use Color::Scheme;
123   use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
124                                         #selectlayers.html
125   use Locale::Country;
126   use Business::US::USPS::WebTools::AddressStandardization;
127   use Geo::GoogleEarth::Pluggable;
128   use LWP::UserAgent;
129   use Storable qw( nfreeze thaw );
130   use FS;
131   use FS::UID qw( getotaker dbh datasrc driver_name );
132   use FS::Record qw( qsearch qsearchs fields dbdef
133                     str2time_sql str2time_sql_closing
134                     midnight_sql regexp_sql
135                    );
136   use FS::Conf;
137   use FS::CGI qw(header menubar table itable ntable idiot
138                  eidiot myexit http_header);
139   use FS::UI::Web qw(svc_url random_id
140                   get_page_pref  set_page_pref);
141   use FS::UI::Web::small_custview qw(small_custview);
142   use FS::UI::bytecount;
143   use FS::Msgcat qw(gettext geterror);
144   use FS::Misc qw( send_email send_fax ocr_image
145                    states_hash counties cities state_label
146                    card_types
147                  );
148   use FS::Misc::eps2png qw( eps2png );
149   use FS::Report::FCC_477;
150   use FS::Report::Table;
151   use FS::Report::Table::Monthly;
152   use FS::Report::Table::Daily;
153   use FS::Report::Tax::ByName;
154   use FS::Report::Tax::All;
155   use FS::TicketSystem;
156   use FS::NetworkMonitoringSystem;
157   use FS::Tron qw( tron_lint );
158   use FS::Locales;
159   use FS::Maketext qw( mt emt js_mt );
160
161   use FS::Query;
162
163   use FS::agent;
164   use FS::agent_type;
165   use FS::domain_record;
166   use FS::cust_bill;
167   use FS::cust_bill_pay;
168   use FS::cust_credit;
169   use FS::cust_credit_bill;
170   use FS::cust_main;
171   use FS::h_cust_main;
172   use FS::cust_main::Search qw(smart_search);
173   use FS::cust_main::Import;
174   use FS::cust_main_county;
175   use FS::cust_location;
176   use FS::cust_pay;
177   use FS::cust_pkg;
178   use FS::cust_pkg::Import;
179   use FS::part_pkg_taxclass;
180   use FS::cust_pkg_reason;
181   use FS::cust_refund;
182   use FS::cust_credit_refund;
183   use FS::cust_pay_refund;
184   use FS::cust_svc;
185   use FS::nas;
186   use FS::part_bill_event;
187   use FS::part_event;
188   use FS::part_event_condition;
189   use FS::part_pkg;
190   use FS::part_referral;
191   use FS::part_svc;
192   use FS::part_svc_router;
193   use FS::part_virtual_field;
194   use FS::pay_batch;
195   use FS::pkg_svc;
196   use FS::port;
197   use FS::queue qw(joblisting);
198   use FS::raddb;
199   use FS::session;
200   use FS::svc_acct;
201   use FS::svc_acct_pop qw(popselector);
202   use FS::acct_rt_transaction;
203   use FS::svc_domain;
204   use FS::svc_forward;
205   use FS::svc_www;
206   use FS::router;
207   use FS::addr_block;
208   use FS::svc_broadband;
209   use FS::svc_external;
210   use FS::type_pkgs;
211   use FS::part_export;
212   use FS::part_export_option;
213   use FS::export_svc;
214   use FS::export_device;
215   use FS::msgcat;
216   use FS::rate;
217   use FS::rate_region;
218   use FS::rate_prefix;
219   use FS::rate_detail;
220   use FS::usage_class;
221   use FS::payment_gateway;
222   use FS::agent_payment_gateway;
223   use FS::XMLRPC;
224   use FS::payby;
225   use FS::cdr;
226   use FS::cdr_batch;
227   use FS::inventory_class;
228   use FS::inventory_item;
229   use FS::pkg_category;
230   use FS::pkg_class;
231   use FS::access_user;
232   use FS::access_user_pref;
233   use FS::access_group;
234   use FS::access_usergroup;
235   use FS::access_groupagent;
236   use FS::access_right;
237   use FS::AccessRight;
238   use FS::svc_phone;
239   use FS::phone_device;
240   use FS::part_device;
241   use FS::reason_type;
242   use FS::reason;
243   use FS::cust_main_note;
244   use FS::tax_class;
245   use FS::cust_tax_location;
246   use FS::part_pkg_taxproduct;
247   use FS::part_pkg_taxoverride;
248   use FS::part_pkg_taxrate;
249   use FS::tax_rate;
250   use FS::part_pkg_report_option;
251   use FS::cust_attachment;
252   use FS::h_cust_pkg;
253   use FS::h_inventory_item;
254   use FS::h_svc_acct;
255   use FS::h_svc_broadband;
256   use FS::h_svc_domain;
257   #use FS::h_domain_record;
258   use FS::h_svc_external;
259   use FS::h_svc_forward;
260   use FS::h_svc_phone;
261   #use FS::h_phone_device;
262   use FS::h_svc_www;
263   use FS::cust_statement;
264   use FS::cust_class;
265   use FS::cust_category;
266   use FS::prospect_main;
267   use FS::contact;
268   use FS::phone_type;
269   use FS::svc_pbx;
270   use FS::discount;
271   use FS::cust_pkg_discount;
272   use FS::cust_bill_pkg_discount;
273   use FS::svc_mailinglist;
274   use FS::cgp_rule;
275   use FS::cgp_rule_condition;
276   use FS::cgp_rule_action;
277   use FS::bill_batch;
278   use FS::cust_bill_batch;
279   use FS::rate_time;
280   use FS::rate_time_interval;
281   use FS::msg_template;
282   use FS::part_tag;
283   use FS::acct_snarf;
284   use FS::part_pkg_discount;
285   use FS::svc_cert;
286   use FS::svc_dsl;
287   use FS::qual;
288   use FS::qual_option;
289   use FS::dsl_note;
290   use FS::part_pkg_vendor;
291   use FS::cust_note_class;
292   use FS::svc_port;
293   use FS::lata;
294   use FS::did_vendor;
295   use FS::did_order;
296   use FS::torrus_srvderive;
297   use FS::torrus_srvderive_component;
298   use FS::areacode;
299   use FS::svc_dish;
300   use FS::h_svc_dish;
301   use FS::svc_hardware;
302   use FS::h_svc_hardware;
303   use FS::hardware_class;
304   use FS::hardware_type;
305   use FS::hardware_status;
306   use FS::did_order_item;
307   use FS::msa;
308   use FS::rate_center;
309   use FS::cust_msg;
310   use FS::radius_group;
311   use FS::template_content;
312   use FS::dsl_device;
313   use FS::nas;
314   use FS::nas;
315   use FS::export_nas;
316   use FS::legacy_cust_bill;
317   use FS::rate_tier;
318   use FS::rate_tier_detail;
319   use FS::radius_attr;
320   use FS::discount_plan;
321   use FS::tower;
322   use FS::tower_sector;
323   use FS::sales;
324   use FS::contact_class;
325   use FS::part_svc_class;
326   use FS::upload_target;
327   use FS::quotation;
328   use FS::quotation_pkg;
329   use FS::quotation_pkg_discount;
330   use FS::cust_bill_void;
331   use FS::cust_bill_pkg_void;
332   use FS::cust_bill_pkg_detail_void;
333   use FS::cust_bill_pkg_display_void;
334   use FS::cust_bill_pkg_tax_location_void;
335   use FS::cust_bill_pkg_tax_rate_location_void;
336   use FS::cust_tax_exempt_pkg_void;
337   use FS::cust_bill_pkg_discount_void;
338   use FS::agent_pkg_class;
339   use FS::svc_export_machine;
340   use FS::GeocodeCache;
341   use FS::log;
342   use FS::log_context;
343   use FS::part_pkg_usage_class;
344   use FS::cust_pkg_usage;
345   use FS::part_pkg_usage_class;
346   use FS::part_pkg_usage;
347   use FS::cdr_cust_pkg_usage;
348   use FS::part_pkg_msgcat;
349   use FS::svc_cable;
350   use FS::sales_pkg_class;
351   use FS::svc_alarm;
352   use FS::cable_model;
353   use FS::invoice_mode;
354   use FS::invoice_conf;
355   use FS::cable_provider;
356   use FS::cust_credit_void;
357   use FS::discount_class;
358   use FS::alarm_system;
359   use FS::alarm_type;
360   use FS::alarm_station;
361   use FS::addr_range;
362   use FS::pbx_extension;
363   use FS::cust_event_fee;
364   use FS::part_fee;
365   use FS::cust_bill_pkg_fee;
366   use FS::part_fee_msgcat;
367   use FS::part_fee_usage;
368   use FS::sched_item;
369   use FS::sched_avail;
370   use FS::export_batch;
371   use FS::export_batch_item;
372   use FS::part_pkg_fcc_option;
373   use FS::state;
374   use FS::queue_stat;
375   use FS::deploy_zone;
376   use FS::deploy_zone_block;
377   use FS::deploy_zone_vertex;
378   use FS::circuit_type;
379   use FS::circuit_provider;
380   use FS::circuit_termination;
381   use FS::svc_circuit;
382   use FS::legacy_cust_history;
383   use FS::quotation_pkg_tax;
384   use FS::cust_pkg_reason_fee;
385   use FS::access_user_log;
386   use FS::report_batch;
387   use FS::report_batch;
388   use FS::report_batch;
389   use FS::report_batch;
390   use FS::password_history;
391   use FS::svc_fiber;
392   use FS::fiber_olt;
393   use FS::olt_site;
394   use FS::access_user_page_pref;
395   use FS::part_svc_msgcat;
396   use FS::saved_search;
397   # Sammath Naur
398
399   if ( $FS::Mason::addl_handler_use ) {
400     eval $FS::Mason::addl_handler_use;
401     die $@ if $@;
402   }
403
404   if ( %%%RT_ENABLED%%% ) {
405     eval '
406       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
407       use vars qw($Nobody $SystemUser);
408       use RT;
409       use RT::Util;
410       use RT::Tickets;
411       use RT::Transactions;
412       use RT::Users;
413       use RT::CurrentUser;
414       use RT::Templates;
415       use RT::Queues;
416       use RT::ScripActions;
417       use RT::ScripConditions;
418       use RT::Scrips;
419       use RT::Groups;
420       use RT::GroupMembers;
421       use RT::CustomFields;
422       use RT::CustomFieldValues;
423       use RT::ObjectCustomFieldValues;
424
425       #blah.  manually updated from RT::Interface::Web::Handler
426       use RT::Interface::Web;
427       use MIME::Entity;
428       use Text::Wrapper;
429       use Time::ParseDate;
430       use Time::HiRes;
431       use HTML::Scrubber;
432
433       #blah.  not even in RT::Interface::Web::Handler, just in 
434       #html/NoAuth/css/dhandler and rt-test-dependencies.  ask for it here
435       #to throw a real error instead of just a mysterious unstyled RT
436       use CSS::Squish 0.06;
437
438       use RT::Interface::Web::Request;
439
440       #another undeclared web UI dep (for ticket links graph)
441       use IPC::Run::SafeHandles;
442
443       #slow, unreliable, segfaults and is optional
444       #see rt/html/Ticket/Elements/ShowTransactionAttachments
445       #use Text::Quoted;
446
447       #?#use File::Path qw( rmtree );
448       #?#use File::Glob qw( bsd_glob );
449       #?#use File::Spec::Unix;
450
451     ';
452     die $@ if $@;
453   }
454
455   no warnings 'redefine';
456   *CGI::redirect = sub {
457     my $self = shift;
458     my $cookie = '';
459     if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
460       (my $x, $cookie) = (shift, shift);
461       $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
462     }
463     my $location = shift;
464
465     use vars qw($m);
466
467     # false laziness w/below
468     if ( @DBIx::Profile::ISA ) {
469
470       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
471
472         #profiling redirect
473
474         my $page =
475           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
476           '<BR><BR><PRE>'.
477             ( UNIVERSAL::can(dbh, 'sprintProfile')
478                 ? encode_entities(dbh->sprintProfile())
479                 : 'DBIx::Profile missing sprintProfile method;'.
480                   'unpatched or too old?'                        ).
481           #"\n\n". &sprintAutoProfile().  '</PRE>'.
482           "\n\n".                         '</PRE>'.
483           '</BODY></HTML>';
484
485
486         dbh->{'private_profile'} = {};
487         return $page;
488
489       } else {
490
491         #clear db profile, but normal redirect
492         dbh->{'private_profile'} = {};
493         $m->redirect($location);
494         '';
495
496       }
497
498     } else { #normal redirect
499
500       $m->redirect($location);
501       '';
502
503     }
504
505   };
506   
507   sub include {
508     use vars qw($m);
509     #carp #should just switch to <& &> syntax
510     $m->scomp(@_);
511   }
512
513   sub errorpage {
514     use vars qw($m);
515     $m->comp('/elements/errorpage.html', @_);
516   }
517
518   sub errorpage_popup {
519     use vars qw($m);
520     $m->comp('/elements/errorpage-popup.html', @_);
521   }
522
523   sub redirect {
524     my( $location ) = @_;
525     use vars qw($m);
526     $m->clear_buffer;
527     #false laziness w/above
528     if ( @DBIx::Profile::ISA ) {
529
530       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
531
532         #profiling redirect
533
534         $m->print(
535           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
536           '<BR><BR><PRE>'.
537             ( UNIVERSAL::can(dbh, 'sprintProfile')
538                 ? encode_entities(dbh->sprintProfile())
539                 : 'DBIx::Profile missing sprintProfile method;'.
540                   'unpatched or too old?'                        ).
541           #"\n\n". &sprintAutoProfile().  '</PRE>'.
542           "\n\n".                         '</PRE>'.
543           '</BODY></HTML>'
544         );
545
546         dbh->{'private_profile'} = {};
547
548       } else {
549
550         #clear db profile, but normal redirect
551         dbh->{'private_profile'} = {};
552         $m->redirect($location);
553
554       }
555
556     } else { #normal redirect
557
558       $m->redirect($location);
559
560     }
561
562   }
563
564 } # end package HTML::Mason::Commands;
565
566 =head1 SUBROUTINES
567
568 =over 4
569
570 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
571
572 Returns a list consisting of two HTML::Mason::Interp objects, the first for
573 Freeside pages, and the second for RT pages.
574
575 MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
576
577 Options and values can be passed following mode.  Currently available options
578 are:
579
580 I<outbuf> should be set to a scalar reference in standalone mode.
581
582 =cut
583
584 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
585
586 sub mason_interps {
587   my $mode = shift || 'apache';
588   my %opt = @_;
589
590   #my $request_class = 'HTML::Mason::Request'.
591                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
592   my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
593                                             : 'FS::Mason::Request';
594
595   #not entirely sure it belongs here, but what the hey
596   if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
597     RT::LoadConfig();
598   }
599
600   my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
601
602   my %interp = (
603     request_class        => $request_class,
604     data_dir             => '%%%MASONDATA%%%',
605     error_mode           => 'output',
606     error_format         => 'html',
607     ignore_warnings_expr => '.',
608   );
609
610   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
611
612   my $html_defang = new HTML::Defang (%defang_opts);
613
614   #false laziness w/ FS::Maketext js_mt
615   my $js_string_sub = sub {
616     #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
617     ${$_[0]} =~ s/(['\\])/\\$1/g;
618     ${$_[0]} =~ s/\r/\\r/g;
619     ${$_[0]} =~ s/\n/\\n/g;
620     # prevent premature termination of the script
621     ${$_[0]} =~ s[</script>][<\\/script>]ig;
622     ${$_[0]} = "'". ${$_[0]}. "'";
623   };
624
625   my $defang_sub = sub {
626     ${$_[0]} = $html_defang->defang(${$_[0]});
627   };
628
629   my $fs_interp = new HTML::Mason::Interp (
630     %interp,
631     comp_root    => $fs_comp_root,
632     escape_flags => { 'js_string'   => $js_string_sub,
633                       'defang'      => $defang_sub,
634                     },
635     compiler     => HTML::Mason::Compiler::ToObject->new(
636                       allow_globals        => [qw(%session)],
637                     ),
638   );
639
640   my $rt_interp = new HTML::Mason::Interp (
641     %interp,
642     comp_root    => [
643                       [ 'rt'       => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
644                       [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
645                     ],
646     escape_flags => { 'h'         => \&RT::Interface::Web::EscapeUTF8,
647                       'u'         => \&RT::Interface::Web::EscapeURI,
648                       'j'         => \&RT::Interface::Web::EscapeJS,
649                       'js_string' => $js_string_sub,
650                     },
651     compiler     => HTML::Mason::Compiler::ToObject->new(
652                       default_escape_flags => 'h',
653                       allow_globals        => [qw(%session $DECODED_ARGS)],
654                     ),
655   );
656
657   ( $fs_interp, $rt_interp );
658
659 }
660
661 =item child_init
662
663 Per-process Apache child initialization code.
664
665 Calls srand() to re-seed Perl's PRNG so that multiple children do not generate
666 the same "random" numbers.
667
668 Works around a Net::SSLeay connection error by creating and deleting an SSL
669 context, so subsequent connections do not error out with a CTX_new (900 NET OR
670 SSL ERROR).  See http://bugs.debian.org/830152
671
672 =cut
673
674 sub child_init {
675   #my ($pool, $server) = @_; #the child process pool (APR::Pool) and the server object (Apache2::ServerRec).
676
677   srand();
678
679   #{
680     use Net::SSLeay;
681     package Net::SSLeay;
682     initialize();
683     my $bad_ctx = new_x_ctx();
684     while ( ERR_get_error() ) {}; #print_errs('CTX_new');
685     CTX_free($bad_ctx);
686   #}
687
688 }
689
690 =back
691
692 =head1 BUGS
693
694 Lurking in the darkness...
695
696 =head1 SEE ALSO
697
698 L<HTML::Mason>, L<FS>, L<RT>
699
700 =cut
701
702 1;