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 4.08 qw(-private_tempfiles); #4.08 for multi_param
50 #use CGI::Carp qw(fatalsToBrowser);
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 );
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
70 use HTML::TreeBuilder;
71 use HTML::TableExtract qw(tree);
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);
84 eval "use Net::Whois::Raw 0.32 qw(whois)";
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
94 use Business::CreditCard 0.36; #for best-effort cardtype() (60xx as Discover)
98 use Net::Ping::External;
99 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
101 no warnings 'redefine';
102 eval 'sub Net::Ping::External::_ping_linux {
104 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
105 return Net::Ping::External::_ping_system($command, 0);
110 use String::Approx qw(amatch);
111 use Chart::LinesPoints;
115 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
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;
125 use Storable qw( nfreeze thaw );
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
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
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 );
157 use FS::Maketext qw( mt emt js_mt );
163 use FS::domain_record;
165 use FS::cust_bill_pay;
167 use FS::cust_credit_bill;
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;
177 use FS::cust_pkg::Import;
178 use FS::part_pkg_taxclass;
179 use FS::cust_pkg_reason;
181 use FS::cust_credit_refund;
182 use FS::cust_pay_refund;
186 use FS::part_event_condition;
188 use FS::part_referral;
190 use FS::part_svc_router;
191 use FS::part_virtual_field;
195 use FS::queue qw(joblisting);
199 use FS::svc_acct_pop qw(popselector);
200 use FS::acct_rt_transaction;
206 use FS::svc_broadband;
207 use FS::svc_external;
210 use FS::part_export_option;
212 use FS::export_device;
219 use FS::payment_gateway;
220 use FS::agent_payment_gateway;
224 use FS::inventory_class;
225 use FS::inventory_item;
226 use FS::pkg_category;
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;
236 use FS::phone_device;
240 use FS::cust_main_note;
242 use FS::cust_tax_location;
243 use FS::part_pkg_taxproduct;
244 use FS::part_pkg_taxoverride;
245 use FS::part_pkg_taxrate;
247 use FS::part_pkg_report_option;
248 use FS::cust_attachment;
250 use FS::h_inventory_item;
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;
258 #use FS::h_phone_device;
260 use FS::cust_statement;
262 use FS::cust_category;
263 use FS::prospect_main;
265 use FS::contact::Import;
269 use FS::cust_pkg_discount;
270 use FS::cust_bill_pkg_discount;
271 use FS::svc_mailinglist;
273 use FS::cgp_rule_condition;
274 use FS::cgp_rule_action;
276 use FS::cust_bill_batch;
278 use FS::rate_time_interval;
279 use FS::msg_template;
282 use FS::part_pkg_discount;
288 use FS::part_pkg_vendor;
289 use FS::cust_note_class;
294 use FS::torrus_srvderive;
295 use FS::torrus_srvderive_component;
299 use FS::svc_hardware;
300 use FS::h_svc_hardware;
301 use FS::hardware_class;
302 use FS::hardware_type;
303 use FS::hardware_status;
304 use FS::did_order_item;
308 use FS::radius_group;
309 use FS::template_content;
314 use FS::legacy_cust_bill;
316 use FS::rate_tier_detail;
318 use FS::discount_plan;
320 use FS::tower_sector;
322 use FS::contact_class;
323 use FS::part_svc_class;
324 use FS::upload_target;
326 use FS::quotation_pkg;
327 use FS::quotation_pkg_discount;
328 use FS::cust_bill_void;
329 use FS::cust_bill_pkg_void;
330 use FS::cust_bill_pkg_detail_void;
331 use FS::cust_bill_pkg_display_void;
332 use FS::cust_bill_pkg_tax_location_void;
333 use FS::cust_bill_pkg_tax_rate_location_void;
334 use FS::cust_tax_exempt_pkg_void;
335 use FS::cust_bill_pkg_discount_void;
336 use FS::agent_pkg_class;
337 use FS::svc_export_machine;
338 use FS::GeocodeCache;
341 use FS::part_pkg_usage_class;
342 use FS::cust_pkg_usage;
343 use FS::part_pkg_usage_class;
344 use FS::part_pkg_usage;
345 use FS::cdr_cust_pkg_usage;
346 use FS::part_pkg_msgcat;
348 use FS::agent_currency;
349 use FS::currency_exchange;
350 use FS::part_pkg_currency;
356 use FS::vend_bill_pay;
357 use FS::sales_pkg_class;
360 use FS::invoice_mode;
361 use FS::invoice_conf;
362 use FS::cable_provider;
363 use FS::cust_credit_void;
364 use FS::discount_class;
365 use FS::alarm_system;
367 use FS::alarm_station;
369 use FS::svc_conferencing;
370 use FS::conferencing_type;
371 use FS::conferencing_quality;
373 use FS::part_pkg_usageprice;
374 use FS::cust_pkg_usageprice;
375 use FS::pbx_extension;
377 use FS::extension_device;
378 use FS::cust_main_credit_limit;
379 use FS::cust_event_fee;
381 use FS::cust_bill_pkg_fee;
382 use FS::part_fee_msgcat;
383 use FS::part_fee_usage;
386 use FS::export_batch;
387 use FS::export_batch_item;
388 use FS::part_pkg_fcc_option;
392 use FS::deploy_zone_block;
393 use FS::deploy_zone_vertex;
396 use FS::circuit_type;
397 use FS::circuit_provider;
398 use FS::circuit_termination;
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;
416 use FS::access_user_page_pref;
417 use FS::part_svc_msgcat;
418 use FS::commission_schedule;
419 use FS::commission_rate;
420 use FS::realestate_location;
421 use FS::realestate_unit;
422 use FS::svc_realestate;
423 use FS::saved_search;
424 use FS::sector_coverage;
426 use FS::Misc::DepositSlip qw( deposit_slip_pdf );
429 if ( $FS::Mason::addl_handler_use ) {
430 eval $FS::Mason::addl_handler_use;
434 if ( %%%RT_ENABLED%%% ) {
436 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
437 use vars qw($Nobody $SystemUser);
441 use RT::Transactions;
446 use RT::ScripActions;
447 use RT::ScripConditions;
450 use RT::GroupMembers;
451 use RT::CustomFields;
452 use RT::CustomFieldValues;
453 use RT::ObjectCustomFieldValues;
455 use RT::Interface::Web::Handler;
457 #blah. not even in RT::Interface::Web::Handler, just in
458 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
459 #to throw a real error instead of just a mysterious unstyled RT
460 use CSS::Squish 0.06;
462 #another undeclared web UI dep (for ticket links graph)
463 use IPC::Run::SafeHandles;
465 #slow, unreliable, segfaults and is optional
466 #see rt/html/Ticket/Elements/ShowTransactionAttachments
469 #?#use File::Path qw( rmtree );
470 #?#use File::Glob qw( bsd_glob );
471 #?#use File::Spec::Unix;
477 no warnings 'redefine';
478 *CGI::redirect = sub {
484 if ( $_[0] =~ /^-/ ) {
486 $location = $opt{'-uri'};
487 my $cookie = $opt{'-cookie'};
488 $m->apache_req->err_headers_out->{'Set-cookie'} = $cookie if $cookie;
493 # false laziness w/below
494 if ( @DBIx::Profile::ISA ) {
496 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
501 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
503 ( UNIVERSAL::can(dbh, 'sprintProfile')
504 ? encode_entities(dbh->sprintProfile())
505 : 'DBIx::Profile missing sprintProfile method;'.
506 'unpatched or too old?' ).
507 #"\n\n". &sprintAutoProfile(). '</PRE>'.
512 dbh->{'private_profile'} = {};
517 #clear db profile, but normal redirect
518 dbh->{'private_profile'} = {};
519 $m->redirect($location);
524 } else { #normal redirect
526 $m->redirect($location);
535 #warn 'include deprecated; use an HTML::Mason <& &> style include (or $m->scomp) at '. $m->callers(0)->path. "\n";
541 $m->comp('/elements/errorpage.html', @_);
544 sub errorpage_popup {
546 $m->comp('/elements/errorpage-popup.html', @_);
550 my( $location ) = @_;
553 #false laziness w/above
554 if ( @DBIx::Profile::ISA ) {
556 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
561 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
563 ( UNIVERSAL::can(dbh, 'sprintProfile')
564 ? encode_entities(dbh->sprintProfile())
565 : 'DBIx::Profile missing sprintProfile method;'.
566 'unpatched or too old?' ).
567 #"\n\n". &sprintAutoProfile(). '</PRE>'.
572 dbh->{'private_profile'} = {};
576 #clear db profile, but normal redirect
577 dbh->{'private_profile'} = {};
578 $m->redirect($location);
582 } else { #normal redirect
584 $m->redirect($location);
590 } # end package HTML::Mason::Commands;
596 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
598 Returns a list consisting of two HTML::Mason::Interp objects, the first for
599 Freeside pages, and the second for RT pages.
601 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
603 Options and values can be passed following mode. Currently available options
606 I<outbuf> should be set to a scalar reference in standalone mode.
610 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
613 my $mode = shift || 'apache';
616 #my $request_class = 'HTML::Mason::Request'.
617 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
618 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
619 : 'FS::Mason::Request';
621 #not entirely sure it belongs here, but what the hey
622 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
626 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
629 request_class => $request_class,
630 data_dir => '%%%MASONDATA%%%',
631 error_mode => 'output',
632 error_format => 'html',
633 ignore_warnings_expr => '.',
636 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
638 my $html_defang = new HTML::Defang (%defang_opts);
640 #false laziness w/ FS::Maketext js_mt
641 my $js_string_sub = sub {
642 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
643 ${$_[0]} =~ s/(['\\])/\\$1/g;
644 ${$_[0]} =~ s/\r/\\r/g;
645 ${$_[0]} =~ s/\n/\\n/g;
646 # prevent premature termination of the script
647 ${$_[0]} =~ s[</script>][<\\/script>]ig;
648 ${$_[0]} = "'". ${$_[0]}. "'";
651 my $defang_sub = sub {
652 ${$_[0]} = $html_defang->defang(${$_[0]});
655 my $fs_interp = new HTML::Mason::Interp (
657 comp_root => $fs_comp_root,
658 escape_flags => { 'js_string' => $js_string_sub,
659 'defang' => $defang_sub,
661 compiler => HTML::Mason::Compiler::ToObject->new(
662 allow_globals => [qw(%session)],
666 my $rt_interp = new HTML::Mason::Interp (
669 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
670 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
672 escape_flags => { 'h' => \&RT::Interface::Web::EscapeHTML,
673 #u and j aren't used anymore? :/
674 'u' => \&RT::Interface::Web::EscapeURI,
675 'j' => \&RT::Interface::Web::EscapeJS,
676 'js_string' => $js_string_sub,
678 compiler => HTML::Mason::Compiler::ToObject->new(
679 default_escape_flags => 'h',
680 allow_globals => [qw(%session $DECODED_ARGS)],
684 ( $fs_interp, $rt_interp );
690 Per-process Apache child initialization code.
692 Calls srand() to re-seed Perl's PRNG so that multiple children do not generate
693 the same "random" numbers.
695 Works around a Net::SSLeay connection error by creating and deleting an SSL
696 context, so subsequent connections do not error out with a CTX_new (900 NET OR
697 SSL ERROR). See http://bugs.debian.org/830152
702 #my ($pool, $server) = @_; #the child process pool (APR::Pool) and the server object (Apache2::ServerRec).
710 my $bad_ctx = new_x_ctx();
711 while ( ERR_get_error() ) {}; #print_errs('CTX_new');
721 Lurking in the darkness...
725 L<HTML::Mason>, L<FS>, L<RT>