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);
86 use File::Slurp qw( slurp );
87 #not actually using this yet anyway...# use IPC::Run3 0.036;
88 use Net::Whois::Raw qw(whois);
90 eval "use Net::Whois::Raw 0.32 qw(whois)";
94 use Spreadsheet::WriteExcel;
95 use Spreadsheet::WriteExcel::Utility;
96 use OLE::Storage_Lite;
97 use Excel::Writer::XLSX;
98 #use Excel::Writer::XLSX::Utility; #redundant with above
100 use Business::CreditCard 0.30; #for mask-aware cardtype()
102 use Net::MAC::Vendor;
104 use Net::Ping::External;
105 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
107 no warnings 'redefine';
108 eval 'sub Net::Ping::External::_ping_linux {
110 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
111 return Net::Ping::External::_ping_system($command, 0);
116 use String::Approx qw(amatch);
117 use Chart::LinesPoints;
121 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
124 #use FS::geocode_Mixin; #for its code2country
125 use Locale::Currency;
126 use Locale::Currency::Format;
127 use Business::US::USPS::WebTools::AddressStandardization;
128 use Geo::GoogleEarth::Pluggable;
130 use Storable qw( nfreeze thaw );
132 use FS::UID qw( 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 use FS::UI::Web::small_custview qw(small_custview);
142 use FS::UI::bytecount;
143 use FS::UI::REST qw( rest_auth rest_uri_remain encode_rest );
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
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;
154 use FS::TicketSystem;
155 use FS::NetworkMonitoringSystem;
156 use FS::Tron qw( tron_lint );
158 use FS::Maketext qw( mt emt js_mt );
164 use FS::domain_record;
166 use FS::cust_bill_pay;
168 use FS::cust_credit_bill;
171 use FS::cust_main::Search qw(smart_search);
172 use FS::cust_main::Import;
173 use FS::cust_main::Import_Charges;
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;
187 use FS::part_event_condition;
189 use FS::part_referral;
191 use FS::part_svc_router;
192 use FS::part_virtual_field;
196 use FS::queue qw(joblisting);
200 use FS::svc_acct_pop qw(popselector);
201 use FS::acct_rt_transaction;
207 use FS::svc_broadband;
208 use FS::svc_external;
211 use FS::part_export_option;
213 use FS::export_device;
220 use FS::payment_gateway;
221 use FS::agent_payment_gateway;
225 use FS::inventory_class;
226 use FS::inventory_item;
227 use FS::pkg_category;
230 use FS::access_user_pref;
231 use FS::access_group;
232 use FS::access_usergroup;
233 use FS::access_groupagent;
234 use FS::access_right;
237 use FS::phone_device;
241 use FS::cust_main_note;
243 use FS::cust_tax_location;
244 use FS::part_pkg_taxproduct;
245 use FS::part_pkg_taxoverride;
246 use FS::part_pkg_taxrate;
248 use FS::part_pkg_report_option;
249 use FS::cust_attachment;
251 use FS::h_inventory_item;
253 use FS::h_svc_broadband;
254 use FS::h_svc_domain;
255 #use FS::h_domain_record;
256 use FS::h_svc_external;
257 use FS::h_svc_forward;
259 #use FS::h_phone_device;
261 use FS::cust_statement;
263 use FS::cust_category;
264 use FS::prospect_main;
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;
393 use FS::deploy_zone_block;
394 use FS::deploy_zone_vertex;
397 use FS::circuit_type;
398 use FS::circuit_provider;
399 use FS::circuit_termination;
401 use FS::cust_credit_source_bill_pkg;
402 use FS::prospect_contact;
403 use FS::cust_contact;
404 use FS::legacy_cust_history;
405 use FS::quotation_pkg_tax;
406 use FS::cust_pkg_reason_fee;
407 use FS::part_svc_link;
408 use FS::access_user_log;
409 use FS::report_batch;
410 use FS::report_batch;
411 use FS::report_batch;
412 use FS::report_batch;
413 use FS::password_history;
416 if ( $FS::Mason::addl_handler_use ) {
417 eval $FS::Mason::addl_handler_use;
421 if ( %%%RT_ENABLED%%% ) {
423 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
424 use vars qw($Nobody $SystemUser);
428 use RT::Transactions;
433 use RT::ScripActions;
434 use RT::ScripConditions;
437 use RT::GroupMembers;
438 use RT::CustomFields;
439 use RT::CustomFieldValues;
440 use RT::ObjectCustomFieldValues;
442 use RT::Interface::Web::Handler;
444 #blah. not even in RT::Interface::Web::Handler, just in
445 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
446 #to throw a real error instead of just a mysterious unstyled RT
447 use CSS::Squish 0.06;
449 #another undeclared web UI dep (for ticket links graph)
450 use IPC::Run::SafeHandles;
452 #slow, unreliable, segfaults and is optional
453 #see rt/html/Ticket/Elements/ShowTransactionAttachments
456 #?#use File::Path qw( rmtree );
457 #?#use File::Glob qw( bsd_glob );
458 #?#use File::Spec::Unix;
464 no warnings 'redefine';
465 *CGI::redirect = sub {
468 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
469 (my $x, $cookie) = (shift, shift);
470 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
472 my $location = shift;
476 # false laziness w/below
477 if ( @DBIx::Profile::ISA ) {
479 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
484 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
486 ( UNIVERSAL::can(dbh, 'sprintProfile')
487 ? encode_entities(dbh->sprintProfile())
488 : 'DBIx::Profile missing sprintProfile method;'.
489 'unpatched or too old?' ).
490 #"\n\n". &sprintAutoProfile(). '</PRE>'.
495 dbh->{'private_profile'} = {};
500 #clear db profile, but normal redirect
501 dbh->{'private_profile'} = {};
502 $m->redirect($location);
507 } else { #normal redirect
509 $m->redirect($location);
518 #warn 'include deprecated; use an HTML::Mason <& &> style include (or $m->scomp) at '. $m->callers(0)->path. "\n";
524 $m->comp('/elements/errorpage.html', @_);
527 sub errorpage_popup {
529 $m->comp('/elements/errorpage-popup.html', @_);
533 my( $location ) = @_;
536 #false laziness w/above
537 if ( @DBIx::Profile::ISA ) {
539 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
544 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
546 ( UNIVERSAL::can(dbh, 'sprintProfile')
547 ? encode_entities(dbh->sprintProfile())
548 : 'DBIx::Profile missing sprintProfile method;'.
549 'unpatched or too old?' ).
550 #"\n\n". &sprintAutoProfile(). '</PRE>'.
555 dbh->{'private_profile'} = {};
559 #clear db profile, but normal redirect
560 dbh->{'private_profile'} = {};
561 $m->redirect($location);
565 } else { #normal redirect
567 $m->redirect($location);
573 } # end package HTML::Mason::Commands;
579 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
581 Returns a list consisting of two HTML::Mason::Interp objects, the first for
582 Freeside pages, and the second for RT pages.
584 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
586 Options and values can be passed following mode. Currently available options
589 I<outbuf> should be set to a scalar reference in standalone mode.
593 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
596 my $mode = shift || 'apache';
599 #my $request_class = 'HTML::Mason::Request'.
600 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
601 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
602 : 'FS::Mason::Request';
604 #not entirely sure it belongs here, but what the hey
605 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
609 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
612 request_class => $request_class,
613 data_dir => '%%%MASONDATA%%%',
614 error_mode => 'output',
615 error_format => 'html',
616 ignore_warnings_expr => '.',
619 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
621 my $html_defang = new HTML::Defang (%defang_opts);
623 #false laziness w/ FS::Maketext js_mt
624 my $js_string_sub = sub {
625 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
626 ${$_[0]} =~ s/(['\\])/\\$1/g;
627 ${$_[0]} =~ s/\r/\\r/g;
628 ${$_[0]} =~ s/\n/\\n/g;
629 # prevent premature termination of the script
630 ${$_[0]} =~ s[</script>][<\\/script>]ig;
631 ${$_[0]} = "'". ${$_[0]}. "'";
634 my $defang_sub = sub {
635 ${$_[0]} = $html_defang->defang(${$_[0]});
638 my $fs_interp = new HTML::Mason::Interp (
640 comp_root => $fs_comp_root,
641 escape_flags => { 'js_string' => $js_string_sub,
642 'defang' => $defang_sub,
644 compiler => HTML::Mason::Compiler::ToObject->new(
645 allow_globals => [qw(%session)],
649 my $rt_interp = new HTML::Mason::Interp (
652 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
653 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
655 escape_flags => { 'h' => \&RT::Interface::Web::EscapeHTML,
656 #u and j aren't used anymore? :/
657 'u' => \&RT::Interface::Web::EscapeURI,
658 'j' => \&RT::Interface::Web::EscapeJS,
659 'js_string' => $js_string_sub,
661 compiler => HTML::Mason::Compiler::ToObject->new(
662 default_escape_flags => 'h',
663 allow_globals => [qw(%session $DECODED_ARGS)],
667 ( $fs_interp, $rt_interp );
675 Lurking in the darkness...
679 L<HTML::Mason>, L<FS>, L<RT>