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;
268 use FS::cust_pkg_discount;
269 use FS::cust_bill_pkg_discount;
270 use FS::svc_mailinglist;
272 use FS::cgp_rule_condition;
273 use FS::cgp_rule_action;
275 use FS::cust_bill_batch;
277 use FS::rate_time_interval;
278 use FS::msg_template;
281 use FS::part_pkg_discount;
287 use FS::part_pkg_vendor;
288 use FS::cust_note_class;
293 use FS::torrus_srvderive;
294 use FS::torrus_srvderive_component;
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;
307 use FS::radius_group;
308 use FS::template_content;
313 use FS::legacy_cust_bill;
315 use FS::rate_tier_detail;
317 use FS::discount_plan;
319 use FS::tower_sector;
321 use FS::contact_class;
322 use FS::part_svc_class;
323 use FS::upload_target;
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;
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;
347 use FS::agent_currency;
348 use FS::currency_exchange;
349 use FS::part_pkg_currency;
355 use FS::vend_bill_pay;
356 use FS::sales_pkg_class;
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;
366 use FS::alarm_station;
368 use FS::svc_conferencing;
369 use FS::conferencing_type;
370 use FS::conferencing_quality;
372 use FS::part_pkg_usageprice;
373 use FS::cust_pkg_usageprice;
374 use FS::pbx_extension;
376 use FS::extension_device;
377 use FS::cust_main_credit_limit;
378 use FS::cust_event_fee;
380 use FS::cust_bill_pkg_fee;
381 use FS::part_fee_msgcat;
382 use FS::part_fee_usage;
385 use FS::export_batch;
386 use FS::export_batch_item;
387 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::saved_search;
421 use FS::sector_coverage;
424 if ( $FS::Mason::addl_handler_use ) {
425 eval $FS::Mason::addl_handler_use;
429 if ( %%%RT_ENABLED%%% ) {
431 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
432 use vars qw($Nobody $SystemUser);
436 use RT::Transactions;
441 use RT::ScripActions;
442 use RT::ScripConditions;
445 use RT::GroupMembers;
446 use RT::CustomFields;
447 use RT::CustomFieldValues;
448 use RT::ObjectCustomFieldValues;
450 use RT::Interface::Web::Handler;
452 #blah. not even in RT::Interface::Web::Handler, just in
453 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
454 #to throw a real error instead of just a mysterious unstyled RT
455 use CSS::Squish 0.06;
457 #another undeclared web UI dep (for ticket links graph)
458 use IPC::Run::SafeHandles;
460 #slow, unreliable, segfaults and is optional
461 #see rt/html/Ticket/Elements/ShowTransactionAttachments
464 #?#use File::Path qw( rmtree );
465 #?#use File::Glob qw( bsd_glob );
466 #?#use File::Spec::Unix;
472 no warnings 'redefine';
473 *CGI::redirect = sub {
479 if ( $_[0] =~ /^-/ ) {
481 $location = $opt{'-uri'};
482 my $cookie = $opt{'-cookie'};
483 $m->apache_req->err_headers_out->{'Set-cookie'} = $cookie if $cookie;
488 # false laziness w/below
489 if ( @DBIx::Profile::ISA ) {
491 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
496 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
498 ( UNIVERSAL::can(dbh, 'sprintProfile')
499 ? encode_entities(dbh->sprintProfile())
500 : 'DBIx::Profile missing sprintProfile method;'.
501 'unpatched or too old?' ).
502 #"\n\n". &sprintAutoProfile(). '</PRE>'.
507 dbh->{'private_profile'} = {};
512 #clear db profile, but normal redirect
513 dbh->{'private_profile'} = {};
514 $m->redirect($location);
519 } else { #normal redirect
521 $m->redirect($location);
530 #warn 'include deprecated; use an HTML::Mason <& &> style include (or $m->scomp) at '. $m->callers(0)->path. "\n";
536 $m->comp('/elements/errorpage.html', @_);
539 sub errorpage_popup {
541 $m->comp('/elements/errorpage-popup.html', @_);
545 my( $location ) = @_;
548 #false laziness w/above
549 if ( @DBIx::Profile::ISA ) {
551 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
556 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
558 ( UNIVERSAL::can(dbh, 'sprintProfile')
559 ? encode_entities(dbh->sprintProfile())
560 : 'DBIx::Profile missing sprintProfile method;'.
561 'unpatched or too old?' ).
562 #"\n\n". &sprintAutoProfile(). '</PRE>'.
567 dbh->{'private_profile'} = {};
571 #clear db profile, but normal redirect
572 dbh->{'private_profile'} = {};
573 $m->redirect($location);
577 } else { #normal redirect
579 $m->redirect($location);
585 } # end package HTML::Mason::Commands;
591 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
593 Returns a list consisting of two HTML::Mason::Interp objects, the first for
594 Freeside pages, and the second for RT pages.
596 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
598 Options and values can be passed following mode. Currently available options
601 I<outbuf> should be set to a scalar reference in standalone mode.
605 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
608 my $mode = shift || 'apache';
611 #my $request_class = 'HTML::Mason::Request'.
612 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
613 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
614 : 'FS::Mason::Request';
616 #not entirely sure it belongs here, but what the hey
617 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
621 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
624 request_class => $request_class,
625 data_dir => '%%%MASONDATA%%%',
626 error_mode => 'output',
627 error_format => 'html',
628 ignore_warnings_expr => '.',
631 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
633 my $html_defang = new HTML::Defang (%defang_opts);
635 #false laziness w/ FS::Maketext js_mt
636 my $js_string_sub = sub {
637 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
638 ${$_[0]} =~ s/(['\\])/\\$1/g;
639 ${$_[0]} =~ s/\r/\\r/g;
640 ${$_[0]} =~ s/\n/\\n/g;
641 # prevent premature termination of the script
642 ${$_[0]} =~ s[</script>][<\\/script>]ig;
643 ${$_[0]} = "'". ${$_[0]}. "'";
646 my $defang_sub = sub {
647 ${$_[0]} = $html_defang->defang(${$_[0]});
650 my $fs_interp = new HTML::Mason::Interp (
652 comp_root => $fs_comp_root,
653 escape_flags => { 'js_string' => $js_string_sub,
654 'defang' => $defang_sub,
656 compiler => HTML::Mason::Compiler::ToObject->new(
657 allow_globals => [qw(%session)],
661 my $rt_interp = new HTML::Mason::Interp (
664 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
665 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
667 escape_flags => { 'h' => \&RT::Interface::Web::EscapeHTML,
668 #u and j aren't used anymore? :/
669 'u' => \&RT::Interface::Web::EscapeURI,
670 'j' => \&RT::Interface::Web::EscapeJS,
671 'js_string' => $js_string_sub,
673 compiler => HTML::Mason::Compiler::ToObject->new(
674 default_escape_flags => 'h',
675 allow_globals => [qw(%session $DECODED_ARGS)],
679 ( $fs_interp, $rt_interp );
685 Per-process Apache child initialization code.
687 Calls srand() to re-seed Perl's PRNG so that multiple children do not generate
688 the same "random" numbers.
690 Works around a Net::SSLeay connection error by creating and deleting an SSL
691 context, so subsequent connections do not error out with a CTX_new (900 NET OR
692 SSL ERROR). See http://bugs.debian.org/830152
697 #my ($pool, $server) = @_; #the child process pool (APR::Pool) and the server object (Apache2::ServerRec).
705 my $bad_ctx = new_x_ctx();
706 while ( ERR_get_error() ) {}; #print_errs('CTX_new');
716 Lurking in the darkness...
720 L<HTML::Mason>, L<FS>, L<RT>