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 );
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 Locale::Currency;
125 use Locale::Currency::Format;
126 use Business::US::USPS::WebTools::AddressStandardization;
127 use Geo::GoogleEarth::Pluggable;
129 use Storable qw( nfreeze thaw );
131 use FS::UID qw( dbh datasrc driver_name );
132 use FS::Record qw( qsearch qsearchs fields dbdef
133 str2time_sql str2time_sql_closing
137 use FS::CGI qw(header menubar table itable ntable idiot
138 eidiot myexit http_header);
139 use FS::UI::Web qw(svc_url);
140 use FS::UI::Web::small_custview qw(small_custview);
141 use FS::UI::bytecount;
142 use FS::UI::REST qw( rest_auth rest_uri_remain encode_rest );
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
147 use FS::Misc::eps2png qw( eps2png );
148 use FS::Report::FCC_477;
149 use FS::Report::Table;
150 use FS::Report::Table::Monthly;
151 use FS::Report::Table::Daily;
153 use FS::TicketSystem;
154 use FS::NetworkMonitoringSystem;
155 use FS::Tron qw( tron_lint );
157 use FS::Maketext qw( mt emt js_mt );
161 use FS::domain_record;
163 use FS::cust_bill_pay;
165 use FS::cust_credit_bill;
168 use FS::cust_main::Search qw(smart_search);
169 use FS::cust_main::Import;
170 use FS::cust_main::Import_Charges;
171 use FS::cust_main_county;
172 use FS::cust_location;
175 use FS::cust_pkg::Import;
176 use FS::part_pkg_taxclass;
177 use FS::cust_pkg_reason;
179 use FS::cust_credit_refund;
180 use FS::cust_pay_refund;
183 use FS::part_bill_event;
185 use FS::part_event_condition;
187 use FS::part_referral;
189 use FS::part_svc_router;
190 use FS::part_virtual_field;
194 use FS::queue qw(joblisting);
198 use FS::svc_acct_pop qw(popselector);
199 use FS::acct_rt_transaction;
205 use FS::svc_broadband;
206 use FS::svc_external;
209 use FS::part_export_option;
211 use FS::export_device;
218 use FS::payment_gateway;
219 use FS::agent_payment_gateway;
223 use FS::inventory_class;
224 use FS::inventory_item;
225 use FS::pkg_category;
228 use FS::access_user_pref;
229 use FS::access_group;
230 use FS::access_usergroup;
231 use FS::access_groupagent;
232 use FS::access_right;
235 use FS::phone_device;
239 use FS::cust_main_note;
241 use FS::cust_tax_location;
242 use FS::part_pkg_taxproduct;
243 use FS::part_pkg_taxoverride;
244 use FS::part_pkg_taxrate;
246 use FS::part_pkg_report_option;
247 use FS::cust_attachment;
249 use FS::h_inventory_item;
251 use FS::h_svc_broadband;
252 use FS::h_svc_domain;
253 #use FS::h_domain_record;
254 use FS::h_svc_external;
255 use FS::h_svc_forward;
257 #use FS::h_phone_device;
259 use FS::cust_statement;
261 use FS::cust_category;
262 use FS::prospect_main;
267 use FS::cust_pkg_discount;
268 use FS::cust_bill_pkg_discount;
269 use FS::svc_mailinglist;
271 use FS::cgp_rule_condition;
272 use FS::cgp_rule_action;
274 use FS::cust_bill_batch;
276 use FS::rate_time_interval;
277 use FS::msg_template;
280 use FS::part_pkg_discount;
286 use FS::part_pkg_vendor;
287 use FS::cust_note_class;
292 use FS::torrus_srvderive;
293 use FS::torrus_srvderive_component;
297 use FS::svc_hardware;
298 use FS::h_svc_hardware;
299 use FS::hardware_class;
300 use FS::hardware_type;
301 use FS::hardware_status;
302 use FS::did_order_item;
306 use FS::radius_group;
307 use FS::template_content;
312 use FS::legacy_cust_bill;
314 use FS::rate_tier_detail;
316 use FS::discount_plan;
318 use FS::tower_sector;
320 use FS::contact_class;
321 use FS::part_svc_class;
322 use FS::upload_target;
324 use FS::quotation_pkg;
325 use FS::quotation_pkg_discount;
326 use FS::cust_bill_void;
327 use FS::cust_bill_pkg_void;
328 use FS::cust_bill_pkg_detail_void;
329 use FS::cust_bill_pkg_display_void;
330 use FS::cust_bill_pkg_tax_location_void;
331 use FS::cust_bill_pkg_tax_rate_location_void;
332 use FS::cust_tax_exempt_pkg_void;
333 use FS::cust_bill_pkg_discount_void;
334 use FS::agent_pkg_class;
335 use FS::svc_export_machine;
336 use FS::GeocodeCache;
339 use FS::part_pkg_usage_class;
340 use FS::cust_pkg_usage;
341 use FS::part_pkg_usage_class;
342 use FS::part_pkg_usage;
343 use FS::cdr_cust_pkg_usage;
344 use FS::part_pkg_msgcat;
346 use FS::agent_currency;
347 use FS::currency_exchange;
348 use FS::part_pkg_currency;
354 use FS::vend_bill_pay;
355 use FS::sales_pkg_class;
358 use FS::invoice_mode;
359 use FS::invoice_conf;
360 use FS::cable_provider;
361 use FS::cust_credit_void;
362 use FS::discount_class;
363 use FS::alarm_system;
365 use FS::alarm_station;
367 use FS::svc_conferencing;
368 use FS::conferencing_type;
369 use FS::conferencing_quality;
371 use FS::part_pkg_usageprice;
372 use FS::cust_pkg_usageprice;
373 use FS::pbx_extension;
375 use FS::extension_device;
376 use FS::cust_main_credit_limit;
377 use FS::cust_event_fee;
379 use FS::cust_bill_pkg_fee;
380 use FS::part_fee_msgcat;
381 use FS::part_fee_usage;
384 use FS::export_batch;
385 use FS::export_batch_item;
386 use FS::part_pkg_fcc_option;
391 use FS::deploy_zone_block;
392 use FS::deploy_zone_vertex;
395 if ( $FS::Mason::addl_handler_use ) {
396 eval $FS::Mason::addl_handler_use;
400 if ( %%%RT_ENABLED%%% ) {
402 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
403 use vars qw($Nobody $SystemUser);
407 use RT::Transactions;
412 use RT::ScripActions;
413 use RT::ScripConditions;
416 use RT::GroupMembers;
417 use RT::CustomFields;
418 use RT::CustomFieldValues;
419 use RT::ObjectCustomFieldValues;
421 #blah. manually updated from RT::Interface::Web::Handler
422 use RT::Interface::Web;
429 #blah. not even in RT::Interface::Web::Handler, just in
430 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
431 #to throw a real error instead of just a mysterious unstyled RT
432 use CSS::Squish 0.06;
434 use RT::Interface::Web::Request;
436 #another undeclared web UI dep (for ticket links graph)
437 use IPC::Run::SafeHandles;
439 #slow, unreliable, segfaults and is optional
440 #see rt/html/Ticket/Elements/ShowTransactionAttachments
443 #?#use File::Path qw( rmtree );
444 #?#use File::Glob qw( bsd_glob );
445 #?#use File::Spec::Unix;
451 *CGI::redirect = sub {
454 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
455 (my $x, $cookie) = (shift, shift);
456 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
458 my $location = shift;
462 # false laziness w/below
463 if ( @DBIx::Profile::ISA ) {
465 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
470 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
472 ( UNIVERSAL::can(dbh, 'sprintProfile')
473 ? encode_entities(dbh->sprintProfile())
474 : 'DBIx::Profile missing sprintProfile method;'.
475 'unpatched or too old?' ).
476 #"\n\n". &sprintAutoProfile(). '</PRE>'.
481 dbh->{'private_profile'} = {};
486 #clear db profile, but normal redirect
487 dbh->{'private_profile'} = {};
488 $m->redirect($location);
493 } else { #normal redirect
495 $m->redirect($location);
504 #carp #should just switch to <& &> syntax
510 $m->comp('/elements/errorpage.html', @_);
513 sub errorpage_popup {
515 $m->comp('/elements/errorpage-popup.html', @_);
519 my( $location ) = @_;
522 #false laziness w/above
523 if ( @DBIx::Profile::ISA ) {
525 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
530 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
532 ( UNIVERSAL::can(dbh, 'sprintProfile')
533 ? encode_entities(dbh->sprintProfile())
534 : 'DBIx::Profile missing sprintProfile method;'.
535 'unpatched or too old?' ).
536 #"\n\n". &sprintAutoProfile(). '</PRE>'.
541 dbh->{'private_profile'} = {};
545 #clear db profile, but normal redirect
546 dbh->{'private_profile'} = {};
547 $m->redirect($location);
551 } else { #normal redirect
553 $m->redirect($location);
559 } # end package HTML::Mason::Commands;
565 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
567 Returns a list consisting of two HTML::Mason::Interp objects, the first for
568 Freeside pages, and the second for RT pages.
570 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
572 Options and values can be passed following mode. Currently available options
575 I<outbuf> should be set to a scalar reference in standalone mode.
579 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
582 my $mode = shift || 'apache';
585 #my $request_class = 'HTML::Mason::Request'.
586 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
587 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
588 : 'FS::Mason::Request';
590 #not entirely sure it belongs here, but what the hey
591 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
595 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
598 request_class => $request_class,
599 data_dir => '%%%MASONDATA%%%',
600 error_mode => 'output',
601 error_format => 'html',
602 ignore_warnings_expr => '.',
605 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
607 my $html_defang = new HTML::Defang (%defang_opts);
609 #false laziness w/ FS::Maketext js_mt
610 my $js_string_sub = sub {
611 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
612 ${$_[0]} =~ s/(['\\])/\\$1/g;
613 ${$_[0]} =~ s/\r/\\r/g;
614 ${$_[0]} =~ s/\n/\\n/g;
615 # prevent premature termination of the script
616 ${$_[0]} =~ s[</script>][<\\/script>]ig;
617 ${$_[0]} = "'". ${$_[0]}. "'";
620 my $defang_sub = sub {
621 ${$_[0]} = $html_defang->defang(${$_[0]});
624 my $fs_interp = new HTML::Mason::Interp (
626 comp_root => $fs_comp_root,
627 escape_flags => { 'js_string' => $js_string_sub,
628 'defang' => $defang_sub,
630 compiler => HTML::Mason::Compiler::ToObject->new(
631 allow_globals => [qw(%session)],
635 my $rt_interp = new HTML::Mason::Interp (
638 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
639 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
641 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
642 'u' => \&RT::Interface::Web::EscapeURI,
643 'j' => \&RT::Interface::Web::EscapeJS,
644 'js_string' => $js_string_sub,
646 compiler => HTML::Mason::Compiler::ToObject->new(
647 default_escape_flags => 'h',
648 allow_globals => [qw(%session $DECODED_ARGS)],
652 ( $fs_interp, $rt_interp );
660 Lurking in the darkness...
664 L<HTML::Mason>, L<FS>, L<RT>