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 Scalar::Util qw( blessed );
66 use DateTime::Format::Strptime;
67 use FS::Misc::DateTime qw( parse_datetime );
68 use FS::Misc::Geo qw( get_censustract get_district );
69 use Lingua::EN::Inflect qw(PL);
70 Lingua::EN::Inflect::classical names=>0; #Categorys
75 use HTML::TreeBuilder;
76 use HTML::TableExtract qw(tree);
80 # use XMLRPC::Transport::HTTP;
81 # use XMLRPC::Lite; # for XMLRPC::Serializer
86 #not actually using this yet anyway...# use IPC::Run3 0.036;
87 use Net::Whois::Raw qw(whois);
89 eval "use Net::Whois::Raw 0.32 qw(whois)";
93 use Spreadsheet::WriteExcel;
94 use Spreadsheet::WriteExcel::Utility;
95 use OLE::Storage_Lite;
96 use Excel::Writer::XLSX;
97 #use Excel::Writer::XLSX::Utility; #redundant with above
99 use Business::CreditCard 0.30; #for mask-aware cardtype()
102 use Net::Ping::External;
103 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
105 no warnings 'redefine';
106 eval 'sub Net::Ping::External::_ping_linux {
108 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
109 return Net::Ping::External::_ping_system($command, 0);
114 use String::Approx qw(amatch);
115 use Chart::LinesPoints;
119 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
122 use Business::US::USPS::WebTools::AddressStandardization;
123 use Geo::GoogleEarth::Pluggable;
125 use Storable qw( nfreeze thaw );
127 use FS::UID qw( getotaker dbh datasrc driver_name );
128 use FS::Record qw( qsearch qsearchs fields dbdef
129 str2time_sql str2time_sql_closing
133 use FS::CGI qw(header menubar table itable ntable idiot
134 eidiot myexit http_header);
135 use FS::UI::Web qw(svc_url);
136 use FS::UI::Web::small_custview qw(small_custview);
137 use FS::UI::bytecount;
138 use FS::Msgcat qw(gettext geterror);
139 use FS::Misc qw( send_email send_fax ocr_image
140 states_hash counties cities state_label
142 use FS::Misc::eps2png qw( eps2png );
143 use FS::Report::FCC_477;
144 use FS::Report::Table;
145 use FS::Report::Table::Monthly;
146 use FS::Report::Table::Daily;
147 use FS::TicketSystem;
148 use FS::NetworkMonitoringSystem;
149 use FS::Tron qw( tron_lint );
151 use FS::Maketext qw( mt emt js_mt );
155 use FS::domain_record;
157 use FS::cust_bill_pay;
159 use FS::cust_credit_bill;
161 use FS::cust_main::Search qw(smart_search);
162 use FS::cust_main::Import;
163 use FS::cust_main_county;
164 use FS::cust_location;
167 use FS::cust_pkg::Import;
168 use FS::part_pkg_taxclass;
169 use FS::cust_pkg_reason;
171 use FS::cust_credit_refund;
172 use FS::cust_pay_refund;
175 use FS::part_bill_event;
177 use FS::part_event_condition;
179 use FS::part_referral;
181 use FS::part_svc_router;
182 use FS::part_virtual_field;
186 use FS::queue qw(joblisting);
190 use FS::svc_acct_pop qw(popselector);
191 use FS::acct_rt_transaction;
197 use FS::svc_broadband;
198 use FS::svc_external;
201 use FS::part_export_option;
203 use FS::export_device;
210 use FS::payment_gateway;
211 use FS::agent_payment_gateway;
216 use FS::inventory_class;
217 use FS::inventory_item;
218 use FS::pkg_category;
221 use FS::access_user_pref;
222 use FS::access_group;
223 use FS::access_usergroup;
224 use FS::access_groupagent;
225 use FS::access_right;
228 use FS::phone_device;
232 use FS::cust_main_note;
234 use FS::cust_tax_location;
235 use FS::part_pkg_taxproduct;
236 use FS::part_pkg_taxoverride;
237 use FS::part_pkg_taxrate;
239 use FS::part_pkg_report_option;
240 use FS::cust_attachment;
242 use FS::h_inventory_item;
244 use FS::h_svc_broadband;
245 use FS::h_svc_domain;
246 #use FS::h_domain_record;
247 use FS::h_svc_external;
248 use FS::h_svc_forward;
250 #use FS::h_phone_device;
252 use FS::cust_statement;
254 use FS::cust_category;
255 use FS::prospect_main;
260 use FS::cust_pkg_discount;
261 use FS::cust_bill_pkg_discount;
262 use FS::svc_mailinglist;
264 use FS::cgp_rule_condition;
265 use FS::cgp_rule_action;
267 use FS::cust_bill_batch;
269 use FS::rate_time_interval;
270 use FS::msg_template;
273 use FS::part_pkg_discount;
279 use FS::part_pkg_vendor;
280 use FS::cust_note_class;
285 use FS::torrus_srvderive;
286 use FS::torrus_srvderive_component;
290 use FS::svc_hardware;
291 use FS::h_svc_hardware;
292 use FS::hardware_class;
293 use FS::hardware_type;
294 use FS::hardware_status;
295 use FS::did_order_item;
299 use FS::radius_group;
300 use FS::template_content;
305 use FS::legacy_cust_bill;
307 use FS::rate_tier_detail;
309 use FS::discount_plan;
311 use FS::tower_sector;
312 use FS::agent_pkg_class;
315 if ( $FS::Mason::addl_handler_use ) {
316 eval $FS::Mason::addl_handler_use;
320 if ( %%%RT_ENABLED%%% ) {
322 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
323 use vars qw($Nobody $SystemUser);
327 use RT::Transactions;
332 use RT::ScripActions;
333 use RT::ScripConditions;
336 use RT::GroupMembers;
337 use RT::CustomFields;
338 use RT::CustomFieldValues;
339 use RT::ObjectCustomFieldValues;
341 #blah. manually updated from RT::Interface::Web::Handler
342 use RT::Interface::Web;
349 #blah. not even in RT::Interface::Web::Handler, just in
350 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
351 #to throw a real error instead of just a mysterious unstyled RT
352 use CSS::Squish 0.06;
354 use RT::Interface::Web::Request;
356 #another undeclared web UI dep (for ticket links graph)
357 use IPC::Run::SafeHandles;
359 #slow, unreliable, segfaults and is optional
360 #see rt/html/Ticket/Elements/ShowTransactionAttachments
363 #?#use File::Path qw( rmtree );
364 #?#use File::Glob qw( bsd_glob );
365 #?#use File::Spec::Unix;
371 *CGI::redirect = sub {
374 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
375 (my $x, $cookie) = (shift, shift);
376 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
378 my $location = shift;
382 # false laziness w/below
383 if ( defined(@DBIx::Profile::ISA) ) {
385 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
390 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
392 ( UNIVERSAL::can(dbh, 'sprintProfile')
393 ? encode_entities(dbh->sprintProfile())
394 : 'DBIx::Profile missing sprintProfile method;'.
395 'unpatched or too old?' ).
396 #"\n\n". &sprintAutoProfile(). '</PRE>'.
401 dbh->{'private_profile'} = {};
406 #clear db profile, but normal redirect
407 dbh->{'private_profile'} = {};
408 $m->redirect($location);
413 } else { #normal redirect
415 $m->redirect($location);
424 #carp #should just switch to <& &> syntax
430 $m->comp('/elements/errorpage.html', @_);
433 sub errorpage_popup {
435 $m->comp('/elements/errorpage-popup.html', @_);
439 my( $location ) = @_;
442 #false laziness w/above
443 if ( defined(@DBIx::Profile::ISA) ) {
445 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
450 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
452 ( UNIVERSAL::can(dbh, 'sprintProfile')
453 ? encode_entities(dbh->sprintProfile())
454 : 'DBIx::Profile missing sprintProfile method;'.
455 'unpatched or too old?' ).
456 #"\n\n". &sprintAutoProfile(). '</PRE>'.
461 dbh->{'private_profile'} = {};
465 #clear db profile, but normal redirect
466 dbh->{'private_profile'} = {};
467 $m->redirect($location);
471 } else { #normal redirect
473 $m->redirect($location);
479 } # end package HTML::Mason::Commands;
485 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
487 Returns a list consisting of two HTML::Mason::Interp objects, the first for
488 Freeside pages, and the second for RT pages.
490 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
492 Options and values can be passed following mode. Currently available options
495 I<outbuf> should be set to a scalar reference in standalone mode.
499 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
502 my $mode = shift || 'apache';
505 #my $request_class = 'HTML::Mason::Request'.
506 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
507 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
508 : 'FS::Mason::Request';
510 #not entirely sure it belongs here, but what the hey
511 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
515 # A hook supporting strange legacy ways people (well, SG) have added stuff on
517 my @addl_comp_root = ();
518 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
519 if ( -e $addl_comp_root_file ) {
520 warn "reading $addl_comp_root_file\n";
521 my $text = slurp( $addl_comp_root_file );
522 my @addl = eval $text;
523 if ( @addl && ! $@ ) {
524 @addl_comp_root = @addl;
526 warn "error parsing $addl_comp_root_file: $@\n";
531 scalar(@addl_comp_root)
533 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
536 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
539 request_class => $request_class,
540 data_dir => '%%%MASONDATA%%%',
541 error_mode => 'output',
542 error_format => 'html',
543 ignore_warnings_expr => '.',
546 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
548 my $html_defang = new HTML::Defang (%defang_opts);
550 #false laziness w/ FS::Maketext js_mt
551 my $js_string_sub = sub {
552 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
553 ${$_[0]} =~ s/(['\\])/\\$1/g;
554 ${$_[0]} =~ s/\r/\\r/g;
555 ${$_[0]} =~ s/\n/\\n/g;
556 # prevent premature termination of the script
557 ${$_[0]} =~ s[</script>][<\\/script>]ig;
558 ${$_[0]} = "'". ${$_[0]}. "'";
561 my $defang_sub = sub {
562 ${$_[0]} = $html_defang->defang(${$_[0]});
565 my $fs_interp = new HTML::Mason::Interp (
567 comp_root => $fs_comp_root,
568 escape_flags => { 'js_string' => $js_string_sub,
569 'defang' => $defang_sub,
571 compiler => HTML::Mason::Compiler::ToObject->new(
572 allow_globals => [qw(%session)],
576 my $rt_interp = new HTML::Mason::Interp (
579 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
580 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
582 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
583 'u' => \&RT::Interface::Web::EscapeURI,
584 'j' => \&RT::Interface::Web::EscapeJS,
585 'js_string' => $js_string_sub,
587 compiler => HTML::Mason::Compiler::ToObject->new(
588 default_escape_flags => 'h',
589 allow_globals => [qw(%session)],
593 ( $fs_interp, $rt_interp );
601 Lurking in the darkness...
605 L<HTML::Mason>, L<FS>, L<RT>