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_county;
177 use FS::cust_location;
180 use FS::cust_pkg::Import;
181 use FS::part_pkg_taxclass;
182 use FS::cust_pkg_reason;
184 use FS::cust_credit_refund;
185 use FS::cust_pay_refund;
188 use FS::part_bill_event;
190 use FS::part_event_condition;
192 use FS::part_referral;
194 use FS::part_svc_router;
195 use FS::part_virtual_field;
199 use FS::queue qw(joblisting);
203 use FS::svc_acct_pop qw(popselector);
204 use FS::acct_rt_transaction;
210 use FS::svc_broadband;
211 use FS::svc_external;
214 use FS::part_export_option;
216 use FS::export_device;
223 use FS::payment_gateway;
224 use FS::agent_payment_gateway;
229 use FS::inventory_class;
230 use FS::inventory_item;
231 use FS::pkg_category;
234 use FS::access_user_pref;
235 use FS::access_group;
236 use FS::access_usergroup;
237 use FS::access_groupagent;
238 use FS::access_right;
241 use FS::phone_device;
245 use FS::cust_main_note;
247 use FS::cust_tax_location;
248 use FS::part_pkg_taxproduct;
249 use FS::part_pkg_taxoverride;
250 use FS::part_pkg_taxrate;
252 use FS::part_pkg_report_option;
253 use FS::cust_attachment;
255 use FS::h_inventory_item;
257 use FS::h_svc_broadband;
258 use FS::h_svc_domain;
259 #use FS::h_domain_record;
260 use FS::h_svc_external;
261 use FS::h_svc_forward;
263 #use FS::h_phone_device;
265 use FS::cust_statement;
267 use FS::cust_category;
268 use FS::prospect_main;
273 use FS::cust_pkg_discount;
274 use FS::cust_bill_pkg_discount;
275 use FS::svc_mailinglist;
277 use FS::cgp_rule_condition;
278 use FS::cgp_rule_action;
280 use FS::cust_bill_batch;
282 use FS::rate_time_interval;
283 use FS::msg_template;
286 use FS::part_pkg_discount;
292 use FS::part_pkg_vendor;
293 use FS::cust_note_class;
298 use FS::torrus_srvderive;
299 use FS::torrus_srvderive_component;
303 use FS::svc_hardware;
304 use FS::h_svc_hardware;
305 use FS::hardware_class;
306 use FS::hardware_type;
307 use FS::hardware_status;
308 use FS::did_order_item;
312 use FS::radius_group;
313 use FS::template_content;
318 use FS::legacy_cust_bill;
320 use FS::rate_tier_detail;
322 use FS::discount_plan;
324 use FS::tower_sector;
326 use FS::contact_class;
327 use FS::part_svc_class;
328 use FS::upload_target;
330 use FS::quotation_pkg;
331 use FS::quotation_pkg_discount;
332 use FS::cust_bill_void;
333 use FS::cust_bill_pkg_void;
334 use FS::cust_bill_pkg_detail_void;
335 use FS::cust_bill_pkg_display_void;
336 use FS::cust_bill_pkg_tax_location_void;
337 use FS::cust_bill_pkg_tax_rate_location_void;
338 use FS::cust_tax_exempt_pkg_void;
339 use FS::cust_bill_pkg_discount_void;
340 use FS::agent_pkg_class;
341 use FS::svc_export_machine;
342 use FS::GeocodeCache;
345 use FS::part_pkg_usage_class;
346 use FS::cust_pkg_usage;
347 use FS::part_pkg_usage_class;
348 use FS::part_pkg_usage;
349 use FS::cdr_cust_pkg_usage;
350 use FS::part_pkg_msgcat;
352 use FS::sales_pkg_class;
355 use FS::invoice_mode;
356 use FS::invoice_conf;
357 use FS::cable_provider;
358 use FS::cust_credit_void;
359 use FS::discount_class;
360 use FS::alarm_system;
362 use FS::alarm_station;
364 use FS::pbx_extension;
365 use FS::cust_event_fee;
367 use FS::cust_bill_pkg_fee;
368 use FS::part_fee_msgcat;
369 use FS::part_fee_usage;
372 use FS::export_batch;
373 use FS::export_batch_item;
374 use FS::part_pkg_fcc_option;
378 use FS::deploy_zone_block;
379 use FS::deploy_zone_vertex;
380 use FS::circuit_type;
381 use FS::circuit_provider;
382 use FS::circuit_termination;
384 use FS::legacy_cust_history;
385 use FS::quotation_pkg_tax;
386 use FS::cust_pkg_reason_fee;
387 use FS::access_user_log;
388 use FS::report_batch;
389 use FS::report_batch;
390 use FS::report_batch;
391 use FS::report_batch;
392 use FS::password_history;
396 use FS::access_user_page_pref;
397 use FS::part_svc_msgcat;
398 use FS::saved_search;
401 if ( $FS::Mason::addl_handler_use ) {
402 eval $FS::Mason::addl_handler_use;
406 if ( %%%RT_ENABLED%%% ) {
408 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
409 use vars qw($Nobody $SystemUser);
413 use RT::Transactions;
418 use RT::ScripActions;
419 use RT::ScripConditions;
422 use RT::GroupMembers;
423 use RT::CustomFields;
424 use RT::CustomFieldValues;
425 use RT::ObjectCustomFieldValues;
427 #blah. manually updated from RT::Interface::Web::Handler
428 use RT::Interface::Web;
435 #blah. not even in RT::Interface::Web::Handler, just in
436 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
437 #to throw a real error instead of just a mysterious unstyled RT
438 use CSS::Squish 0.06;
440 use RT::Interface::Web::Request;
442 #another undeclared web UI dep (for ticket links graph)
443 use IPC::Run::SafeHandles;
445 #slow, unreliable, segfaults and is optional
446 #see rt/html/Ticket/Elements/ShowTransactionAttachments
449 #?#use File::Path qw( rmtree );
450 #?#use File::Glob qw( bsd_glob );
451 #?#use File::Spec::Unix;
457 no warnings 'redefine';
458 *CGI::redirect = sub {
461 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
462 (my $x, $cookie) = (shift, shift);
463 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
465 my $location = shift;
469 # false laziness w/below
470 if ( @DBIx::Profile::ISA ) {
472 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
477 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
479 ( UNIVERSAL::can(dbh, 'sprintProfile')
480 ? encode_entities(dbh->sprintProfile())
481 : 'DBIx::Profile missing sprintProfile method;'.
482 'unpatched or too old?' ).
483 #"\n\n". &sprintAutoProfile(). '</PRE>'.
488 dbh->{'private_profile'} = {};
493 #clear db profile, but normal redirect
494 dbh->{'private_profile'} = {};
495 $m->redirect($location);
500 } else { #normal redirect
502 $m->redirect($location);
511 #carp #should just switch to <& &> syntax
517 $m->comp('/elements/errorpage.html', @_);
520 sub errorpage_popup {
522 $m->comp('/elements/errorpage-popup.html', @_);
526 my( $location ) = @_;
529 #false laziness w/above
530 if ( @DBIx::Profile::ISA ) {
532 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
537 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
539 ( UNIVERSAL::can(dbh, 'sprintProfile')
540 ? encode_entities(dbh->sprintProfile())
541 : 'DBIx::Profile missing sprintProfile method;'.
542 'unpatched or too old?' ).
543 #"\n\n". &sprintAutoProfile(). '</PRE>'.
548 dbh->{'private_profile'} = {};
552 #clear db profile, but normal redirect
553 dbh->{'private_profile'} = {};
554 $m->redirect($location);
558 } else { #normal redirect
560 $m->redirect($location);
566 } # end package HTML::Mason::Commands;
572 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
574 Returns a list consisting of two HTML::Mason::Interp objects, the first for
575 Freeside pages, and the second for RT pages.
577 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
579 Options and values can be passed following mode. Currently available options
582 I<outbuf> should be set to a scalar reference in standalone mode.
586 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
589 my $mode = shift || 'apache';
592 #my $request_class = 'HTML::Mason::Request'.
593 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
594 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
595 : 'FS::Mason::Request';
597 #not entirely sure it belongs here, but what the hey
598 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
602 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
605 request_class => $request_class,
606 data_dir => '%%%MASONDATA%%%',
607 error_mode => 'output',
608 error_format => 'html',
609 ignore_warnings_expr => '.',
612 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
614 my $html_defang = new HTML::Defang (%defang_opts);
616 #false laziness w/ FS::Maketext js_mt
617 my $js_string_sub = sub {
618 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
619 ${$_[0]} =~ s/(['\\])/\\$1/g;
620 ${$_[0]} =~ s/\r/\\r/g;
621 ${$_[0]} =~ s/\n/\\n/g;
622 # prevent premature termination of the script
623 ${$_[0]} =~ s[</script>][<\\/script>]ig;
624 ${$_[0]} = "'". ${$_[0]}. "'";
627 my $defang_sub = sub {
628 ${$_[0]} = $html_defang->defang(${$_[0]});
631 my $fs_interp = new HTML::Mason::Interp (
633 comp_root => $fs_comp_root,
634 escape_flags => { 'js_string' => $js_string_sub,
635 'defang' => $defang_sub,
637 compiler => HTML::Mason::Compiler::ToObject->new(
638 allow_globals => [qw(%session)],
642 my $rt_interp = new HTML::Mason::Interp (
645 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
646 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
648 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
649 'u' => \&RT::Interface::Web::EscapeURI,
650 'j' => \&RT::Interface::Web::EscapeJS,
651 'js_string' => $js_string_sub,
653 compiler => HTML::Mason::Compiler::ToObject->new(
654 default_escape_flags => 'h',
655 allow_globals => [qw(%session $DECODED_ARGS)],
659 ( $fs_interp, $rt_interp );
665 Per-process Apache child initialization code.
667 Calls srand() to re-seed Perl's PRNG so that multiple children do not generate
668 the same "random" numbers.
670 Works around a Net::SSLeay connection error by creating and deleting an SSL
671 context, so subsequent connections do not error out with a CTX_new (900 NET OR
672 SSL ERROR). See http://bugs.debian.org/830152
677 #my ($pool, $server) = @_; #the child process pool (APR::Pool) and the server object (Apache2::ServerRec).
685 my $bad_ctx = new_x_ctx();
686 while ( ERR_get_error() ) {}; #print_errs('CTX_new');
696 Lurking in the darkness...
700 L<HTML::Mason>, L<FS>, L<RT>