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