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);
81 # use XMLRPC::Transport::HTTP;
82 # use XMLRPC::Lite; # for XMLRPC::Serializer
88 use File::Slurp qw( slurp );
89 #not actually using this yet anyway...# use IPC::Run3 0.036;
90 use Net::Whois::Raw qw(whois);
92 eval "use Net::Whois::Raw 0.32 qw(whois)";
96 use Spreadsheet::WriteExcel;
97 use Spreadsheet::WriteExcel::Utility;
98 use OLE::Storage_Lite;
99 use Excel::Writer::XLSX;
100 #use Excel::Writer::XLSX::Utility; #redundant with above
102 use Business::CreditCard 0.35; #for new mastercard ranges and visa lengths
104 use Net::MAC::Vendor;
106 use Net::Ping::External;
107 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
109 no warnings 'redefine';
110 eval 'sub Net::Ping::External::_ping_linux {
112 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
113 return Net::Ping::External::_ping_system($command, 0);
118 use String::Approx qw(amatch);
119 use Chart::LinesPoints;
123 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
126 use Number::Phone::Country qw( noexport );
127 use Business::US::USPS::WebTools::AddressStandardization;
128 use Geo::GoogleEarth::Pluggable;
130 use Storable qw( nfreeze thaw );
132 use FS::UID qw( getotaker dbh datasrc driver_name );
133 use FS::Record qw( qsearch qsearchs fields dbdef
134 str2time_sql str2time_sql_closing
135 midnight_sql regexp_sql
138 use FS::CGI qw(header menubar table itable ntable idiot
139 eidiot myexit http_header);
140 use FS::UI::Web qw(svc_url random_id
141 get_page_pref set_page_pref);
142 use FS::UI::Web::small_custview qw(small_custview);
143 use FS::UI::bytecount;
144 use FS::Msgcat qw(gettext geterror);
145 use FS::Misc qw( send_email send_fax ocr_image
146 states_hash counties cities state_label
149 use FS::Misc::eps2png qw( eps2png );
150 use FS::Report::FCC_477;
151 use FS::Report::Table;
152 use FS::Report::Table::Monthly;
153 use FS::Report::Table::Daily;
154 use FS::Report::Tax::ByName;
155 use FS::Report::Tax::All;
156 use FS::TicketSystem;
157 use FS::NetworkMonitoringSystem;
158 use FS::Tron qw( tron_lint );
160 use FS::Maketext qw( mt emt js_mt );
166 use FS::domain_record;
168 use FS::cust_bill_pay;
170 use FS::cust_credit_bill;
173 use FS::cust_main::Search qw(smart_search);
174 use FS::cust_main::Import;
175 use FS::cust_main_county;
176 use FS::cust_location;
179 use FS::cust_pkg::Import;
180 use FS::part_pkg_taxclass;
181 use FS::cust_pkg_reason;
183 use FS::cust_credit_refund;
184 use FS::cust_pay_refund;
187 use FS::part_bill_event;
189 use FS::part_event_condition;
191 use FS::part_referral;
193 use FS::part_svc_router;
194 use FS::part_virtual_field;
198 use FS::queue qw(joblisting);
202 use FS::svc_acct_pop qw(popselector);
203 use FS::acct_rt_transaction;
209 use FS::svc_broadband;
210 use FS::svc_external;
213 use FS::part_export_option;
215 use FS::export_device;
222 use FS::payment_gateway;
223 use FS::agent_payment_gateway;
228 use FS::inventory_class;
229 use FS::inventory_item;
230 use FS::pkg_category;
233 use FS::access_user_pref;
234 use FS::access_group;
235 use FS::access_usergroup;
236 use FS::access_groupagent;
237 use FS::access_right;
240 use FS::phone_device;
244 use FS::cust_main_note;
246 use FS::cust_tax_location;
247 use FS::part_pkg_taxproduct;
248 use FS::part_pkg_taxoverride;
249 use FS::part_pkg_taxrate;
251 use FS::part_pkg_report_option;
252 use FS::cust_attachment;
254 use FS::h_inventory_item;
256 use FS::h_svc_broadband;
257 use FS::h_svc_domain;
258 #use FS::h_domain_record;
259 use FS::h_svc_external;
260 use FS::h_svc_forward;
262 #use FS::h_phone_device;
264 use FS::cust_statement;
266 use FS::cust_category;
267 use FS::prospect_main;
272 use FS::cust_pkg_discount;
273 use FS::cust_bill_pkg_discount;
274 use FS::svc_mailinglist;
276 use FS::cgp_rule_condition;
277 use FS::cgp_rule_action;
279 use FS::cust_bill_batch;
281 use FS::rate_time_interval;
282 use FS::msg_template;
285 use FS::part_pkg_discount;
291 use FS::part_pkg_vendor;
292 use FS::cust_note_class;
297 use FS::torrus_srvderive;
298 use FS::torrus_srvderive_component;
302 use FS::svc_hardware;
303 use FS::h_svc_hardware;
304 use FS::hardware_class;
305 use FS::hardware_type;
306 use FS::hardware_status;
307 use FS::did_order_item;
311 use FS::radius_group;
312 use FS::template_content;
317 use FS::legacy_cust_bill;
319 use FS::rate_tier_detail;
321 use FS::discount_plan;
323 use FS::tower_sector;
325 use FS::contact_class;
326 use FS::part_svc_class;
327 use FS::upload_target;
329 use FS::quotation_pkg;
330 use FS::quotation_pkg_discount;
331 use FS::cust_bill_void;
332 use FS::cust_bill_pkg_void;
333 use FS::cust_bill_pkg_detail_void;
334 use FS::cust_bill_pkg_display_void;
335 use FS::cust_bill_pkg_tax_location_void;
336 use FS::cust_bill_pkg_tax_rate_location_void;
337 use FS::cust_tax_exempt_pkg_void;
338 use FS::cust_bill_pkg_discount_void;
339 use FS::agent_pkg_class;
340 use FS::svc_export_machine;
341 use FS::GeocodeCache;
344 use FS::part_pkg_usage_class;
345 use FS::cust_pkg_usage;
346 use FS::part_pkg_usage_class;
347 use FS::part_pkg_usage;
348 use FS::cdr_cust_pkg_usage;
349 use FS::part_pkg_msgcat;
351 use FS::sales_pkg_class;
354 use FS::invoice_mode;
355 use FS::invoice_conf;
356 use FS::cable_provider;
357 use FS::cust_credit_void;
358 use FS::discount_class;
359 use FS::alarm_system;
361 use FS::alarm_station;
363 use FS::pbx_extension;
364 use FS::cust_event_fee;
366 use FS::cust_bill_pkg_fee;
367 use FS::part_fee_msgcat;
368 use FS::part_fee_usage;
371 use FS::export_batch;
372 use FS::export_batch_item;
373 use FS::part_pkg_fcc_option;
377 use FS::deploy_zone_block;
378 use FS::deploy_zone_vertex;
379 use FS::circuit_type;
380 use FS::circuit_provider;
381 use FS::circuit_termination;
383 use FS::legacy_cust_history;
384 use FS::quotation_pkg_tax;
385 use FS::cust_pkg_reason_fee;
386 use FS::access_user_log;
387 use FS::report_batch;
388 use FS::report_batch;
389 use FS::report_batch;
390 use FS::report_batch;
391 use FS::password_history;
395 use FS::access_user_page_pref;
396 use FS::part_svc_msgcat;
397 use FS::saved_search;
400 if ( $FS::Mason::addl_handler_use ) {
401 eval $FS::Mason::addl_handler_use;
405 if ( %%%RT_ENABLED%%% ) {
407 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
408 use vars qw($Nobody $SystemUser);
412 use RT::Transactions;
417 use RT::ScripActions;
418 use RT::ScripConditions;
421 use RT::GroupMembers;
422 use RT::CustomFields;
423 use RT::CustomFieldValues;
424 use RT::ObjectCustomFieldValues;
426 #blah. manually updated from RT::Interface::Web::Handler
427 use RT::Interface::Web;
434 #blah. not even in RT::Interface::Web::Handler, just in
435 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
436 #to throw a real error instead of just a mysterious unstyled RT
437 use CSS::Squish 0.06;
439 use RT::Interface::Web::Request;
441 #another undeclared web UI dep (for ticket links graph)
442 use IPC::Run::SafeHandles;
444 #slow, unreliable, segfaults and is optional
445 #see rt/html/Ticket/Elements/ShowTransactionAttachments
448 #?#use File::Path qw( rmtree );
449 #?#use File::Glob qw( bsd_glob );
450 #?#use File::Spec::Unix;
456 no warnings 'redefine';
457 *CGI::redirect = sub {
460 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
461 (my $x, $cookie) = (shift, shift);
462 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
464 my $location = shift;
468 # false laziness w/below
469 if ( @DBIx::Profile::ISA ) {
471 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
476 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
478 ( UNIVERSAL::can(dbh, 'sprintProfile')
479 ? encode_entities(dbh->sprintProfile())
480 : 'DBIx::Profile missing sprintProfile method;'.
481 'unpatched or too old?' ).
482 #"\n\n". &sprintAutoProfile(). '</PRE>'.
487 dbh->{'private_profile'} = {};
492 #clear db profile, but normal redirect
493 dbh->{'private_profile'} = {};
494 $m->redirect($location);
499 } else { #normal redirect
501 $m->redirect($location);
510 #carp #should just switch to <& &> syntax
516 $m->comp('/elements/errorpage.html', @_);
519 sub errorpage_popup {
521 $m->comp('/elements/errorpage-popup.html', @_);
525 my( $location ) = @_;
528 #false laziness w/above
529 if ( @DBIx::Profile::ISA ) {
531 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
536 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
538 ( UNIVERSAL::can(dbh, 'sprintProfile')
539 ? encode_entities(dbh->sprintProfile())
540 : 'DBIx::Profile missing sprintProfile method;'.
541 'unpatched or too old?' ).
542 #"\n\n". &sprintAutoProfile(). '</PRE>'.
547 dbh->{'private_profile'} = {};
551 #clear db profile, but normal redirect
552 dbh->{'private_profile'} = {};
553 $m->redirect($location);
557 } else { #normal redirect
559 $m->redirect($location);
565 } # end package HTML::Mason::Commands;
571 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
573 Returns a list consisting of two HTML::Mason::Interp objects, the first for
574 Freeside pages, and the second for RT pages.
576 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
578 Options and values can be passed following mode. Currently available options
581 I<outbuf> should be set to a scalar reference in standalone mode.
585 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
588 my $mode = shift || 'apache';
591 #my $request_class = 'HTML::Mason::Request'.
592 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
593 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
594 : 'FS::Mason::Request';
596 #not entirely sure it belongs here, but what the hey
597 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
601 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
604 request_class => $request_class,
605 data_dir => '%%%MASONDATA%%%',
606 error_mode => 'output',
607 error_format => 'html',
608 ignore_warnings_expr => '.',
611 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
613 my $html_defang = new HTML::Defang (%defang_opts);
615 #false laziness w/ FS::Maketext js_mt
616 my $js_string_sub = sub {
617 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
618 ${$_[0]} =~ s/(['\\])/\\$1/g;
619 ${$_[0]} =~ s/\r/\\r/g;
620 ${$_[0]} =~ s/\n/\\n/g;
621 # prevent premature termination of the script
622 ${$_[0]} =~ s[</script>][<\\/script>]ig;
623 ${$_[0]} = "'". ${$_[0]}. "'";
626 my $defang_sub = sub {
627 ${$_[0]} = $html_defang->defang(${$_[0]});
630 my $fs_interp = new HTML::Mason::Interp (
632 comp_root => $fs_comp_root,
633 escape_flags => { 'js_string' => $js_string_sub,
634 'defang' => $defang_sub,
636 compiler => HTML::Mason::Compiler::ToObject->new(
637 allow_globals => [qw(%session)],
641 my $rt_interp = new HTML::Mason::Interp (
644 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
645 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
647 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
648 'u' => \&RT::Interface::Web::EscapeURI,
649 'j' => \&RT::Interface::Web::EscapeJS,
650 'js_string' => $js_string_sub,
652 compiler => HTML::Mason::Compiler::ToObject->new(
653 default_escape_flags => 'h',
654 allow_globals => [qw(%session $DECODED_ARGS)],
658 ( $fs_interp, $rt_interp );
664 Per-process Apache child initialization code.
666 Calls srand() to re-seed Perl's PRNG so that multiple children do not generate
667 the same "random" numbers.
669 Works around a Net::SSLeay connection error by creating and deleting an SSL
670 context, so subsequent connections do not error out with a CTX_new (900 NET OR
671 SSL ERROR). See http://bugs.debian.org/830152
676 #my ($pool, $server) = @_; #the child process pool (APR::Pool) and the server object (Apache2::ServerRec).
684 my $bad_ctx = new_x_ctx();
685 while ( ERR_get_error() ) {}; #print_errs('CTX_new');
695 Lurking in the darkness...
699 L<HTML::Mason>, L<FS>, L<RT>