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 Business::US::USPS::WebTools::AddressStandardization;
127 use Geo::GoogleEarth::Pluggable;
129 use Storable qw( nfreeze thaw );
131 use FS::UID qw( getotaker dbh datasrc driver_name );
132 use FS::Record qw( qsearch qsearchs fields dbdef
133 str2time_sql str2time_sql_closing
134 midnight_sql regexp_sql
137 use FS::CGI qw(header menubar table itable ntable idiot
138 eidiot myexit http_header);
139 use FS::UI::Web qw(svc_url random_id
140 get_page_pref set_page_pref);
141 use FS::UI::Web::small_custview qw(small_custview);
142 use FS::UI::bytecount;
143 use FS::Msgcat qw(gettext geterror);
144 use FS::Misc qw( send_email send_fax ocr_image
145 states_hash counties cities state_label
148 use FS::Misc::eps2png qw( eps2png );
149 use FS::Report::FCC_477;
150 use FS::Report::Table;
151 use FS::Report::Table::Monthly;
152 use FS::Report::Table::Daily;
153 use FS::Report::Tax::ByName;
154 use FS::Report::Tax::All;
155 use FS::TicketSystem;
156 use FS::NetworkMonitoringSystem;
157 use FS::Tron qw( tron_lint );
159 use FS::Maketext qw( mt emt js_mt );
165 use FS::domain_record;
167 use FS::cust_bill_pay;
169 use FS::cust_credit_bill;
172 use FS::cust_main::Search qw(smart_search);
173 use FS::cust_main::Import;
174 use FS::cust_main_county;
175 use FS::cust_location;
178 use FS::cust_pkg::Import;
179 use FS::part_pkg_taxclass;
180 use FS::cust_pkg_reason;
182 use FS::cust_credit_refund;
183 use FS::cust_pay_refund;
186 use FS::part_bill_event;
188 use FS::part_event_condition;
190 use FS::part_referral;
192 use FS::part_svc_router;
193 use FS::part_virtual_field;
197 use FS::queue qw(joblisting);
201 use FS::svc_acct_pop qw(popselector);
202 use FS::acct_rt_transaction;
208 use FS::svc_broadband;
209 use FS::svc_external;
212 use FS::part_export_option;
214 use FS::export_device;
221 use FS::payment_gateway;
222 use FS::agent_payment_gateway;
227 use FS::inventory_class;
228 use FS::inventory_item;
229 use FS::pkg_category;
232 use FS::access_user_pref;
233 use FS::access_group;
234 use FS::access_usergroup;
235 use FS::access_groupagent;
236 use FS::access_right;
239 use FS::phone_device;
243 use FS::cust_main_note;
245 use FS::cust_tax_location;
246 use FS::part_pkg_taxproduct;
247 use FS::part_pkg_taxoverride;
248 use FS::part_pkg_taxrate;
250 use FS::part_pkg_report_option;
251 use FS::cust_attachment;
253 use FS::h_inventory_item;
255 use FS::h_svc_broadband;
256 use FS::h_svc_domain;
257 #use FS::h_domain_record;
258 use FS::h_svc_external;
259 use FS::h_svc_forward;
261 #use FS::h_phone_device;
263 use FS::cust_statement;
265 use FS::cust_category;
266 use FS::prospect_main;
271 use FS::cust_pkg_discount;
272 use FS::cust_bill_pkg_discount;
273 use FS::svc_mailinglist;
275 use FS::cgp_rule_condition;
276 use FS::cgp_rule_action;
278 use FS::cust_bill_batch;
280 use FS::rate_time_interval;
281 use FS::msg_template;
284 use FS::part_pkg_discount;
290 use FS::part_pkg_vendor;
291 use FS::cust_note_class;
296 use FS::torrus_srvderive;
297 use FS::torrus_srvderive_component;
301 use FS::svc_hardware;
302 use FS::h_svc_hardware;
303 use FS::hardware_class;
304 use FS::hardware_type;
305 use FS::hardware_status;
306 use FS::did_order_item;
310 use FS::radius_group;
311 use FS::template_content;
316 use FS::legacy_cust_bill;
318 use FS::rate_tier_detail;
320 use FS::discount_plan;
322 use FS::tower_sector;
324 use FS::contact_class;
325 use FS::part_svc_class;
326 use FS::upload_target;
328 use FS::quotation_pkg;
329 use FS::quotation_pkg_discount;
330 use FS::cust_bill_void;
331 use FS::cust_bill_pkg_void;
332 use FS::cust_bill_pkg_detail_void;
333 use FS::cust_bill_pkg_display_void;
334 use FS::cust_bill_pkg_tax_location_void;
335 use FS::cust_bill_pkg_tax_rate_location_void;
336 use FS::cust_tax_exempt_pkg_void;
337 use FS::cust_bill_pkg_discount_void;
338 use FS::agent_pkg_class;
339 use FS::svc_export_machine;
340 use FS::GeocodeCache;
343 use FS::part_pkg_usage_class;
344 use FS::cust_pkg_usage;
345 use FS::part_pkg_usage_class;
346 use FS::part_pkg_usage;
347 use FS::cdr_cust_pkg_usage;
348 use FS::part_pkg_msgcat;
350 use FS::sales_pkg_class;
353 use FS::invoice_mode;
354 use FS::invoice_conf;
355 use FS::cable_provider;
356 use FS::cust_credit_void;
357 use FS::discount_class;
358 use FS::alarm_system;
360 use FS::alarm_station;
362 use FS::pbx_extension;
363 use FS::cust_event_fee;
365 use FS::cust_bill_pkg_fee;
366 use FS::part_fee_msgcat;
367 use FS::part_fee_usage;
370 use FS::export_batch;
371 use FS::export_batch_item;
372 use FS::part_pkg_fcc_option;
376 use FS::deploy_zone_block;
377 use FS::deploy_zone_vertex;
378 use FS::circuit_type;
379 use FS::circuit_provider;
380 use FS::circuit_termination;
382 use FS::legacy_cust_history;
383 use FS::quotation_pkg_tax;
384 use FS::cust_pkg_reason_fee;
385 use FS::access_user_log;
386 use FS::report_batch;
387 use FS::report_batch;
388 use FS::report_batch;
389 use FS::report_batch;
390 use FS::password_history;
394 use FS::access_user_page_pref;
395 use FS::part_svc_msgcat;
398 if ( $FS::Mason::addl_handler_use ) {
399 eval $FS::Mason::addl_handler_use;
403 if ( %%%RT_ENABLED%%% ) {
405 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
406 use vars qw($Nobody $SystemUser);
410 use RT::Transactions;
415 use RT::ScripActions;
416 use RT::ScripConditions;
419 use RT::GroupMembers;
420 use RT::CustomFields;
421 use RT::CustomFieldValues;
422 use RT::ObjectCustomFieldValues;
424 #blah. manually updated from RT::Interface::Web::Handler
425 use RT::Interface::Web;
432 #blah. not even in RT::Interface::Web::Handler, just in
433 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
434 #to throw a real error instead of just a mysterious unstyled RT
435 use CSS::Squish 0.06;
437 use RT::Interface::Web::Request;
439 #another undeclared web UI dep (for ticket links graph)
440 use IPC::Run::SafeHandles;
442 #slow, unreliable, segfaults and is optional
443 #see rt/html/Ticket/Elements/ShowTransactionAttachments
446 #?#use File::Path qw( rmtree );
447 #?#use File::Glob qw( bsd_glob );
448 #?#use File::Spec::Unix;
454 no warnings 'redefine';
455 *CGI::redirect = sub {
458 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
459 (my $x, $cookie) = (shift, shift);
460 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
462 my $location = shift;
466 # false laziness w/below
467 if ( @DBIx::Profile::ISA ) {
469 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
474 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
476 ( UNIVERSAL::can(dbh, 'sprintProfile')
477 ? encode_entities(dbh->sprintProfile())
478 : 'DBIx::Profile missing sprintProfile method;'.
479 'unpatched or too old?' ).
480 #"\n\n". &sprintAutoProfile(). '</PRE>'.
485 dbh->{'private_profile'} = {};
490 #clear db profile, but normal redirect
491 dbh->{'private_profile'} = {};
492 $m->redirect($location);
497 } else { #normal redirect
499 $m->redirect($location);
508 #carp #should just switch to <& &> syntax
514 $m->comp('/elements/errorpage.html', @_);
517 sub errorpage_popup {
519 $m->comp('/elements/errorpage-popup.html', @_);
523 my( $location ) = @_;
526 #false laziness w/above
527 if ( @DBIx::Profile::ISA ) {
529 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
534 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
536 ( UNIVERSAL::can(dbh, 'sprintProfile')
537 ? encode_entities(dbh->sprintProfile())
538 : 'DBIx::Profile missing sprintProfile method;'.
539 'unpatched or too old?' ).
540 #"\n\n". &sprintAutoProfile(). '</PRE>'.
545 dbh->{'private_profile'} = {};
549 #clear db profile, but normal redirect
550 dbh->{'private_profile'} = {};
551 $m->redirect($location);
555 } else { #normal redirect
557 $m->redirect($location);
563 } # end package HTML::Mason::Commands;
569 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
571 Returns a list consisting of two HTML::Mason::Interp objects, the first for
572 Freeside pages, and the second for RT pages.
574 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
576 Options and values can be passed following mode. Currently available options
579 I<outbuf> should be set to a scalar reference in standalone mode.
583 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
586 my $mode = shift || 'apache';
589 #my $request_class = 'HTML::Mason::Request'.
590 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
591 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
592 : 'FS::Mason::Request';
594 #not entirely sure it belongs here, but what the hey
595 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
599 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
602 request_class => $request_class,
603 data_dir => '%%%MASONDATA%%%',
604 error_mode => 'output',
605 error_format => 'html',
606 ignore_warnings_expr => '.',
609 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
611 my $html_defang = new HTML::Defang (%defang_opts);
613 #false laziness w/ FS::Maketext js_mt
614 my $js_string_sub = sub {
615 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
616 ${$_[0]} =~ s/(['\\])/\\$1/g;
617 ${$_[0]} =~ s/\r/\\r/g;
618 ${$_[0]} =~ s/\n/\\n/g;
619 # prevent premature termination of the script
620 ${$_[0]} =~ s[</script>][<\\/script>]ig;
621 ${$_[0]} = "'". ${$_[0]}. "'";
624 my $defang_sub = sub {
625 ${$_[0]} = $html_defang->defang(${$_[0]});
628 my $fs_interp = new HTML::Mason::Interp (
630 comp_root => $fs_comp_root,
631 escape_flags => { 'js_string' => $js_string_sub,
632 'defang' => $defang_sub,
634 compiler => HTML::Mason::Compiler::ToObject->new(
635 allow_globals => [qw(%session)],
639 my $rt_interp = new HTML::Mason::Interp (
642 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
643 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
645 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
646 'u' => \&RT::Interface::Web::EscapeURI,
647 'j' => \&RT::Interface::Web::EscapeJS,
648 'js_string' => $js_string_sub,
650 compiler => HTML::Mason::Compiler::ToObject->new(
651 default_escape_flags => 'h',
652 allow_globals => [qw(%session $DECODED_ARGS)],
656 ( $fs_interp, $rt_interp );
662 Per-process Apache child initialization code.
664 Calls srand() to re-seed Perl's PRNG so that multiple children do not generate
665 the same "random" numbers.
667 Works around a Net::SSLeay connection error by creating and deleting an SSL
668 context, so subsequent connections do not error out with a CTX_new (900 NET OR
669 SSL ERROR). See http://bugs.debian.org/830152
674 #my ($pool, $server) = @_; #the child process pool (APR::Pool) and the server object (Apache2::ServerRec).
682 my $bad_ctx = new_x_ctx();
683 while ( ERR_get_error() ) {}; #print_errs('CTX_new');
693 Lurking in the darkness...
697 L<HTML::Mason>, L<FS>, L<RT>