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