4 use vars qw( @ISA @EXPORT_OK $addl_handler_use );
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;
12 @ISA = qw( Exporter );
13 @EXPORT_OK = qw( mason_interps );
17 FS::Mason - Initialize the Mason environment
21 use FS::Mason qw( mason_interps );
23 my( $fs_interp, $rt_interp ) = mason_interps('apache');
27 my( $fs_interp, $rt_interp ) = mason_interps('standalone'); #XXX name?
31 Initializes the Mason environment, loads all Freeside and RT libraries, etc.
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 );
41 # List of modules that you want to use from components (see Admin
44 package HTML::Mason::Commands;
47 use vars qw( %session );
48 use CGI 3.29 qw(-private_tempfiles); #3.29 to fix RT attachment problems
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;
56 #use CGI::Carp qw(fatalsToBrowser);
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 );
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
76 use HTML::TreeBuilder;
77 use HTML::TableExtract qw(tree);
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
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);
93 eval "use Net::Whois::Raw 0.32 qw(whois)";
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
103 use Business::CreditCard 0.35; #for new mastercard ranges and visa lengths
105 use Net::MAC::Vendor;
107 use Net::Ping::External;
108 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
110 no warnings 'redefine';
111 eval 'sub Net::Ping::External::_ping_linux {
113 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
114 return Net::Ping::External::_ping_system($command, 0);
119 use String::Approx qw(amatch);
120 use Chart::LinesPoints;
124 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
127 use Number::Phone::Country qw( noexport );
128 use Business::US::USPS::WebTools::AddressStandardization;
129 use Geo::GoogleEarth::Pluggable;
131 use Storable qw( nfreeze thaw );
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
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
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 );
161 use FS::Maketext qw( mt emt js_mt );
167 use FS::domain_record;
169 use FS::cust_bill_pay;
171 use FS::cust_credit_bill;
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;
181 use FS::cust_pkg::Import;
182 use FS::part_pkg_taxclass;
183 use FS::cust_pkg_reason;
185 use FS::cust_credit_refund;
186 use FS::cust_pay_refund;
189 use FS::part_bill_event;
191 use FS::part_event_condition;
193 use FS::part_referral;
195 use FS::part_svc_router;
196 use FS::part_virtual_field;
200 use FS::queue qw(joblisting);
204 use FS::svc_acct_pop qw(popselector);
205 use FS::acct_rt_transaction;
211 use FS::svc_broadband;
212 use FS::svc_external;
215 use FS::part_export_option;
217 use FS::export_device;
224 use FS::payment_gateway;
225 use FS::agent_payment_gateway;
230 use FS::inventory_class;
231 use FS::inventory_item;
232 use FS::pkg_category;
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;
242 use FS::phone_device;
246 use FS::cust_main_note;
248 use FS::cust_tax_location;
249 use FS::part_pkg_taxproduct;
250 use FS::part_pkg_taxoverride;
251 use FS::part_pkg_taxrate;
253 use FS::part_pkg_report_option;
254 use FS::cust_attachment;
256 use FS::h_inventory_item;
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;
264 #use FS::h_phone_device;
266 use FS::cust_statement;
268 use FS::cust_category;
269 use FS::prospect_main;
274 use FS::cust_pkg_discount;
275 use FS::cust_bill_pkg_discount;
276 use FS::svc_mailinglist;
278 use FS::cgp_rule_condition;
279 use FS::cgp_rule_action;
281 use FS::cust_bill_batch;
283 use FS::rate_time_interval;
284 use FS::msg_template;
287 use FS::part_pkg_discount;
293 use FS::part_pkg_vendor;
294 use FS::cust_note_class;
299 use FS::torrus_srvderive;
300 use FS::torrus_srvderive_component;
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;
313 use FS::radius_group;
314 use FS::template_content;
319 use FS::legacy_cust_bill;
321 use FS::rate_tier_detail;
323 use FS::discount_plan;
325 use FS::tower_sector;
327 use FS::contact_class;
328 use FS::part_svc_class;
329 use FS::upload_target;
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;
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;
353 use FS::sales_pkg_class;
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;
363 use FS::alarm_station;
365 use FS::pbx_extension;
366 use FS::cust_event_fee;
368 use FS::cust_bill_pkg_fee;
369 use FS::part_fee_msgcat;
370 use FS::part_fee_usage;
373 use FS::export_batch;
374 use FS::export_batch_item;
375 use FS::part_pkg_fcc_option;
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;
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;
397 use FS::access_user_page_pref;
398 use FS::part_svc_msgcat;
399 use FS::saved_search;
402 if ( $FS::Mason::addl_handler_use ) {
403 eval $FS::Mason::addl_handler_use;
407 if ( %%%RT_ENABLED%%% ) {
409 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
410 use vars qw($Nobody $SystemUser);
414 use RT::Transactions;
419 use RT::ScripActions;
420 use RT::ScripConditions;
423 use RT::GroupMembers;
424 use RT::CustomFields;
425 use RT::CustomFieldValues;
426 use RT::ObjectCustomFieldValues;
428 #blah. manually updated from RT::Interface::Web::Handler
429 use RT::Interface::Web;
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;
441 use RT::Interface::Web::Request;
443 #another undeclared web UI dep (for ticket links graph)
444 use IPC::Run::SafeHandles;
446 #slow, unreliable, segfaults and is optional
447 #see rt/html/Ticket/Elements/ShowTransactionAttachments
450 #?#use File::Path qw( rmtree );
451 #?#use File::Glob qw( bsd_glob );
452 #?#use File::Spec::Unix;
458 no warnings 'redefine';
459 *CGI::redirect = sub {
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 );
466 my $location = shift;
470 # false laziness w/below
471 if ( @DBIx::Profile::ISA ) {
473 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
478 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
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>'.
489 dbh->{'private_profile'} = {};
494 #clear db profile, but normal redirect
495 dbh->{'private_profile'} = {};
496 $m->redirect($location);
501 } else { #normal redirect
503 $m->redirect($location);
512 #carp #should just switch to <& &> syntax
518 $m->comp('/elements/errorpage.html', @_);
521 sub errorpage_popup {
523 $m->comp('/elements/errorpage-popup.html', @_);
527 my( $location ) = @_;
530 #false laziness w/above
531 if ( @DBIx::Profile::ISA ) {
533 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
538 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
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>'.
549 dbh->{'private_profile'} = {};
553 #clear db profile, but normal redirect
554 dbh->{'private_profile'} = {};
555 $m->redirect($location);
559 } else { #normal redirect
561 $m->redirect($location);
567 } # end package HTML::Mason::Commands;
573 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
575 Returns a list consisting of two HTML::Mason::Interp objects, the first for
576 Freeside pages, and the second for RT pages.
578 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
580 Options and values can be passed following mode. Currently available options
583 I<outbuf> should be set to a scalar reference in standalone mode.
587 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
590 my $mode = shift || 'apache';
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';
598 #not entirely sure it belongs here, but what the hey
599 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
603 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
606 request_class => $request_class,
607 data_dir => '%%%MASONDATA%%%',
608 error_mode => 'output',
609 error_format => 'html',
610 ignore_warnings_expr => '.',
613 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
615 my $html_defang = new HTML::Defang (%defang_opts);
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]}. "'";
628 my $defang_sub = sub {
629 ${$_[0]} = $html_defang->defang(${$_[0]});
632 my $fs_interp = new HTML::Mason::Interp (
634 comp_root => $fs_comp_root,
635 escape_flags => { 'js_string' => $js_string_sub,
636 'defang' => $defang_sub,
638 compiler => HTML::Mason::Compiler::ToObject->new(
639 allow_globals => [qw(%session)],
643 my $rt_interp = new HTML::Mason::Interp (
646 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
647 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
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,
654 compiler => HTML::Mason::Compiler::ToObject->new(
655 default_escape_flags => 'h',
656 allow_globals => [qw(%session $DECODED_ARGS)],
660 ( $fs_interp, $rt_interp );
666 Per-process Apache child initialization code.
668 Calls srand() to re-seed Perl's PRNG so that multiple children do not generate
669 the same "random" numbers.
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
678 #my ($pool, $server) = @_; #the child process pool (APR::Pool) and the server object (Apache2::ServerRec).
686 my $bad_ctx = new_x_ctx();
687 while ( ERR_get_error() ) {}; #print_errs('CTX_new');
697 Lurking in the darkness...
701 L<HTML::Mason>, L<FS>, L<RT>