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.30; #for mask-aware cardtype()
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;
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_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;
185 use FS::part_bill_event;
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;
226 use FS::inventory_class;
227 use FS::inventory_item;
228 use FS::pkg_category;
231 use FS::access_user_pref;
232 use FS::access_group;
233 use FS::access_usergroup;
234 use FS::access_groupagent;
235 use FS::access_right;
238 use FS::phone_device;
242 use FS::cust_main_note;
244 use FS::cust_tax_location;
245 use FS::part_pkg_taxproduct;
246 use FS::part_pkg_taxoverride;
247 use FS::part_pkg_taxrate;
249 use FS::part_pkg_report_option;
250 use FS::cust_attachment;
252 use FS::h_inventory_item;
254 use FS::h_svc_broadband;
255 use FS::h_svc_domain;
256 #use FS::h_domain_record;
257 use FS::h_svc_external;
258 use FS::h_svc_forward;
260 #use FS::h_phone_device;
262 use FS::cust_statement;
264 use FS::cust_category;
265 use FS::prospect_main;
270 use FS::cust_pkg_discount;
271 use FS::cust_bill_pkg_discount;
272 use FS::svc_mailinglist;
274 use FS::cgp_rule_condition;
275 use FS::cgp_rule_action;
277 use FS::cust_bill_batch;
279 use FS::rate_time_interval;
280 use FS::msg_template;
283 use FS::part_pkg_discount;
289 use FS::part_pkg_vendor;
290 use FS::cust_note_class;
295 use FS::torrus_srvderive;
296 use FS::torrus_srvderive_component;
300 use FS::svc_hardware;
301 use FS::h_svc_hardware;
302 use FS::hardware_class;
303 use FS::hardware_type;
304 use FS::hardware_status;
305 use FS::did_order_item;
309 use FS::radius_group;
310 use FS::template_content;
315 use FS::legacy_cust_bill;
317 use FS::rate_tier_detail;
319 use FS::discount_plan;
321 use FS::tower_sector;
323 use FS::contact_class;
324 use FS::part_svc_class;
325 use FS::upload_target;
327 use FS::quotation_pkg;
328 use FS::quotation_pkg_discount;
329 use FS::cust_bill_void;
330 use FS::cust_bill_pkg_void;
331 use FS::cust_bill_pkg_detail_void;
332 use FS::cust_bill_pkg_display_void;
333 use FS::cust_bill_pkg_tax_location_void;
334 use FS::cust_bill_pkg_tax_rate_location_void;
335 use FS::cust_tax_exempt_pkg_void;
336 use FS::cust_bill_pkg_discount_void;
337 use FS::agent_pkg_class;
338 use FS::svc_export_machine;
339 use FS::GeocodeCache;
342 use FS::part_pkg_usage_class;
343 use FS::cust_pkg_usage;
344 use FS::part_pkg_usage_class;
345 use FS::part_pkg_usage;
346 use FS::cdr_cust_pkg_usage;
347 use FS::part_pkg_msgcat;
349 use FS::sales_pkg_class;
352 use FS::invoice_mode;
353 use FS::invoice_conf;
354 use FS::cable_provider;
355 use FS::cust_credit_void;
356 use FS::discount_class;
357 use FS::alarm_system;
359 use FS::alarm_station;
361 use FS::pbx_extension;
362 use FS::cust_event_fee;
364 use FS::cust_bill_pkg_fee;
365 use FS::part_fee_msgcat;
366 use FS::part_fee_usage;
369 use FS::export_batch;
370 use FS::export_batch_item;
371 use FS::part_pkg_fcc_option;
375 use FS::deploy_zone_block;
376 use FS::deploy_zone_vertex;
377 use FS::circuit_type;
378 use FS::circuit_provider;
379 use FS::circuit_termination;
381 use FS::legacy_cust_history;
382 use FS::quotation_pkg_tax;
383 use FS::cust_pkg_reason_fee;
384 use FS::access_user_log;
385 use FS::report_batch;
386 use FS::report_batch;
387 use FS::report_batch;
388 use FS::report_batch;
389 use FS::password_history;
393 use FS::access_user_page_pref;
396 if ( $FS::Mason::addl_handler_use ) {
397 eval $FS::Mason::addl_handler_use;
401 if ( %%%RT_ENABLED%%% ) {
403 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
404 use vars qw($Nobody $SystemUser);
408 use RT::Transactions;
413 use RT::ScripActions;
414 use RT::ScripConditions;
417 use RT::GroupMembers;
418 use RT::CustomFields;
419 use RT::CustomFieldValues;
420 use RT::ObjectCustomFieldValues;
422 #blah. manually updated from RT::Interface::Web::Handler
423 use RT::Interface::Web;
430 #blah. not even in RT::Interface::Web::Handler, just in
431 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
432 #to throw a real error instead of just a mysterious unstyled RT
433 use CSS::Squish 0.06;
435 use RT::Interface::Web::Request;
437 #another undeclared web UI dep (for ticket links graph)
438 use IPC::Run::SafeHandles;
440 #slow, unreliable, segfaults and is optional
441 #see rt/html/Ticket/Elements/ShowTransactionAttachments
444 #?#use File::Path qw( rmtree );
445 #?#use File::Glob qw( bsd_glob );
446 #?#use File::Spec::Unix;
452 no warnings 'redefine';
453 *CGI::redirect = sub {
456 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
457 (my $x, $cookie) = (shift, shift);
458 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
460 my $location = shift;
464 # false laziness w/below
465 if ( defined(@DBIx::Profile::ISA) ) {
467 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
472 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
474 ( UNIVERSAL::can(dbh, 'sprintProfile')
475 ? encode_entities(dbh->sprintProfile())
476 : 'DBIx::Profile missing sprintProfile method;'.
477 'unpatched or too old?' ).
478 #"\n\n". &sprintAutoProfile(). '</PRE>'.
483 dbh->{'private_profile'} = {};
488 #clear db profile, but normal redirect
489 dbh->{'private_profile'} = {};
490 $m->redirect($location);
495 } else { #normal redirect
497 $m->redirect($location);
506 #carp #should just switch to <& &> syntax
512 $m->comp('/elements/errorpage.html', @_);
515 sub errorpage_popup {
517 $m->comp('/elements/errorpage-popup.html', @_);
521 my( $location ) = @_;
524 #false laziness w/above
525 if ( defined(@DBIx::Profile::ISA) ) {
527 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
532 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
534 ( UNIVERSAL::can(dbh, 'sprintProfile')
535 ? encode_entities(dbh->sprintProfile())
536 : 'DBIx::Profile missing sprintProfile method;'.
537 'unpatched or too old?' ).
538 #"\n\n". &sprintAutoProfile(). '</PRE>'.
543 dbh->{'private_profile'} = {};
547 #clear db profile, but normal redirect
548 dbh->{'private_profile'} = {};
549 $m->redirect($location);
553 } else { #normal redirect
555 $m->redirect($location);
561 } # end package HTML::Mason::Commands;
567 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
569 Returns a list consisting of two HTML::Mason::Interp objects, the first for
570 Freeside pages, and the second for RT pages.
572 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
574 Options and values can be passed following mode. Currently available options
577 I<outbuf> should be set to a scalar reference in standalone mode.
581 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
584 my $mode = shift || 'apache';
587 #my $request_class = 'HTML::Mason::Request'.
588 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
589 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
590 : 'FS::Mason::Request';
592 #not entirely sure it belongs here, but what the hey
593 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
597 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
600 request_class => $request_class,
601 data_dir => '%%%MASONDATA%%%',
602 error_mode => 'output',
603 error_format => 'html',
604 ignore_warnings_expr => '.',
607 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
609 my $html_defang = new HTML::Defang (%defang_opts);
611 #false laziness w/ FS::Maketext js_mt
612 my $js_string_sub = sub {
613 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
614 ${$_[0]} =~ s/(['\\])/\\$1/g;
615 ${$_[0]} =~ s/\r/\\r/g;
616 ${$_[0]} =~ s/\n/\\n/g;
617 # prevent premature termination of the script
618 ${$_[0]} =~ s[</script>][<\\/script>]ig;
619 ${$_[0]} = "'". ${$_[0]}. "'";
622 my $defang_sub = sub {
623 ${$_[0]} = $html_defang->defang(${$_[0]});
626 my $fs_interp = new HTML::Mason::Interp (
628 comp_root => $fs_comp_root,
629 escape_flags => { 'js_string' => $js_string_sub,
630 'defang' => $defang_sub,
632 compiler => HTML::Mason::Compiler::ToObject->new(
633 allow_globals => [qw(%session)],
637 my $rt_interp = new HTML::Mason::Interp (
640 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
641 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
643 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
644 'u' => \&RT::Interface::Web::EscapeURI,
645 'j' => \&RT::Interface::Web::EscapeJS,
646 'js_string' => $js_string_sub,
648 compiler => HTML::Mason::Compiler::ToObject->new(
649 default_escape_flags => 'h',
650 allow_globals => [qw(%session $DECODED_ARGS)],
654 ( $fs_interp, $rt_interp );
662 Lurking in the darkness...
666 L<HTML::Mason>, L<FS>, L<RT>