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