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 );
65 use DateTime::Format::Strptime;
66 use FS::Misc::DateTime qw( parse_datetime );
67 use FS::Misc::Geo qw( get_censustract get_district );
68 use Lingua::EN::Inflect qw(PL);
69 Lingua::EN::Inflect::classical names=>0; #Categorys
74 use HTML::TreeBuilder;
75 use HTML::TableExtract qw(tree);
79 # use XMLRPC::Transport::HTTP;
80 # use XMLRPC::Lite; # for XMLRPC::Serializer
85 #not actually using this yet anyway...# use IPC::Run3 0.036;
86 use Net::Whois::Raw qw(whois);
88 eval "use Net::Whois::Raw 0.32 qw(whois)";
92 use Spreadsheet::WriteExcel;
93 use Spreadsheet::WriteExcel::Utility;
94 use Excel::Writer::XLSX;
95 use Excel::Writer::XLSX::Utility;
97 use Business::CreditCard 0.30; #for mask-aware cardtype()
100 use Net::Ping::External;
101 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
103 no warnings 'redefine';
104 eval 'sub Net::Ping::External::_ping_linux {
106 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
107 return Net::Ping::External::_ping_system($command, 0);
112 use String::Approx qw(amatch);
113 use Chart::LinesPoints;
117 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
120 use Business::US::USPS::WebTools::AddressStandardization;
121 use Geo::GoogleEarth::Pluggable;
123 use Storable qw( nfreeze thaw );
125 use FS::UID qw( getotaker dbh datasrc driver_name );
126 use FS::Record qw( qsearch qsearchs fields dbdef
127 str2time_sql str2time_sql_closing
131 use FS::CGI qw(header menubar table itable ntable idiot
132 eidiot myexit http_header);
133 use FS::UI::Web qw(svc_url);
134 use FS::UI::Web::small_custview qw(small_custview);
135 use FS::UI::bytecount;
136 use FS::Msgcat qw(gettext geterror);
137 use FS::Misc qw( send_email send_fax ocr_image
138 states_hash counties cities state_label
140 use FS::Misc::eps2png qw( eps2png );
141 use FS::Report::FCC_477;
142 use FS::Report::Table;
143 use FS::Report::Table::Monthly;
144 use FS::Report::Table::Daily;
145 use FS::TicketSystem;
146 use FS::NetworkMonitoringSystem;
147 use FS::Tron qw( tron_lint );
149 use FS::Maketext qw( mt emt js_mt );
153 use FS::domain_record;
155 use FS::cust_bill_pay;
157 use FS::cust_credit_bill;
159 use FS::cust_main::Search qw(smart_search);
160 use FS::cust_main::Import;
161 use FS::cust_main_county;
162 use FS::cust_location;
165 use FS::cust_pkg::Import;
166 use FS::part_pkg_taxclass;
167 use FS::cust_pkg_reason;
169 use FS::cust_credit_refund;
170 use FS::cust_pay_refund;
173 use FS::part_bill_event;
175 use FS::part_event_condition;
177 use FS::part_referral;
179 use FS::part_svc_router;
180 use FS::part_virtual_field;
184 use FS::queue qw(joblisting);
188 use FS::svc_acct_pop qw(popselector);
189 use FS::acct_rt_transaction;
195 use FS::svc_broadband;
196 use FS::svc_external;
199 use FS::part_export_option;
201 use FS::export_device;
208 use FS::payment_gateway;
209 use FS::agent_payment_gateway;
214 use FS::inventory_class;
215 use FS::inventory_item;
216 use FS::pkg_category;
219 use FS::access_user_pref;
220 use FS::access_group;
221 use FS::access_usergroup;
222 use FS::access_groupagent;
223 use FS::access_right;
226 use FS::phone_device;
230 use FS::cust_main_note;
232 use FS::cust_tax_location;
233 use FS::part_pkg_taxproduct;
234 use FS::part_pkg_taxoverride;
235 use FS::part_pkg_taxrate;
237 use FS::part_pkg_report_option;
238 use FS::cust_attachment;
240 use FS::h_inventory_item;
242 use FS::h_svc_broadband;
243 use FS::h_svc_domain;
244 #use FS::h_domain_record;
245 use FS::h_svc_external;
246 use FS::h_svc_forward;
248 #use FS::h_phone_device;
250 use FS::cust_statement;
252 use FS::cust_category;
253 use FS::prospect_main;
258 use FS::cust_pkg_discount;
259 use FS::cust_bill_pkg_discount;
260 use FS::svc_mailinglist;
262 use FS::cgp_rule_condition;
263 use FS::cgp_rule_action;
265 use FS::cust_bill_batch;
267 use FS::rate_time_interval;
268 use FS::msg_template;
271 use FS::part_pkg_discount;
277 use FS::part_pkg_vendor;
278 use FS::cust_note_class;
283 use FS::torrus_srvderive;
284 use FS::torrus_srvderive_component;
288 use FS::svc_hardware;
289 use FS::h_svc_hardware;
290 use FS::hardware_class;
291 use FS::hardware_type;
292 use FS::hardware_status;
293 use FS::did_order_item;
297 use FS::radius_group;
298 use FS::template_content;
303 use FS::legacy_cust_bill;
305 use FS::rate_tier_detail;
307 use FS::discount_plan;
309 use FS::tower_sector;
312 if ( $FS::Mason::addl_handler_use ) {
313 eval $FS::Mason::addl_handler_use;
317 if ( %%%RT_ENABLED%%% ) {
319 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
320 use vars qw($Nobody $SystemUser);
324 use RT::Transactions;
329 use RT::ScripActions;
330 use RT::ScripConditions;
333 use RT::GroupMembers;
334 use RT::CustomFields;
335 use RT::CustomFieldValues;
336 use RT::ObjectCustomFieldValues;
338 #blah. manually updated from RT::Interface::Web::Handler
339 use RT::Interface::Web;
346 #blah. not even in RT::Interface::Web::Handler, just in
347 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
348 #to throw a real error instead of just a mysterious unstyled RT
349 use CSS::Squish 0.06;
351 use RT::Interface::Web::Request;
353 #nother undeclared web UI dep (for ticket links graph)
354 use IPC::Run::SafeHandles;
356 #slow, unreliable, segfaults and is optional
357 #see rt/html/Ticket/Elements/ShowTransactionAttachments
360 #?#use File::Path qw( rmtree );
361 #?#use File::Glob qw( bsd_glob );
362 #?#use File::Spec::Unix;
368 *CGI::redirect = sub {
371 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
372 (my $x, $cookie) = (shift, shift);
373 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
375 my $location = shift;
379 # false laziness w/below
380 if ( defined(@DBIx::Profile::ISA) ) {
382 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
387 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
389 ( UNIVERSAL::can(dbh, 'sprintProfile')
390 ? encode_entities(dbh->sprintProfile())
391 : 'DBIx::Profile missing sprintProfile method;'.
392 'unpatched or too old?' ).
393 #"\n\n". &sprintAutoProfile(). '</PRE>'.
398 dbh->{'private_profile'} = {};
403 #clear db profile, but normal redirect
404 dbh->{'private_profile'} = {};
405 $m->redirect($location);
410 } else { #normal redirect
412 $m->redirect($location);
421 #carp #should just switch to <& &> syntax
427 $m->comp('/elements/errorpage.html', @_);
430 sub errorpage_popup {
432 $m->comp('/elements/errorpage-popup.html', @_);
436 my( $location ) = @_;
439 #false laziness w/above
440 if ( defined(@DBIx::Profile::ISA) ) {
442 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
447 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
449 ( UNIVERSAL::can(dbh, 'sprintProfile')
450 ? encode_entities(dbh->sprintProfile())
451 : 'DBIx::Profile missing sprintProfile method;'.
452 'unpatched or too old?' ).
453 #"\n\n". &sprintAutoProfile(). '</PRE>'.
458 dbh->{'private_profile'} = {};
462 #clear db profile, but normal redirect
463 dbh->{'private_profile'} = {};
464 $m->redirect($location);
468 } else { #normal redirect
470 $m->redirect($location);
476 } # end package HTML::Mason::Commands;
482 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
484 Returns a list consisting of two HTML::Mason::Interp objects, the first for
485 Freeside pages, and the second for RT pages.
487 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
489 Options and values can be passed following mode. Currently available options
492 I<outbuf> should be set to a scalar reference in standalone mode.
496 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
499 my $mode = shift || 'apache';
502 #my $request_class = 'HTML::Mason::Request'.
503 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
504 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
505 : 'FS::Mason::Request';
507 #not entirely sure it belongs here, but what the hey
508 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
512 # A hook supporting strange legacy ways people (well, SG) have added stuff on
514 my @addl_comp_root = ();
515 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
516 if ( -e $addl_comp_root_file ) {
517 warn "reading $addl_comp_root_file\n";
518 my $text = slurp( $addl_comp_root_file );
519 my @addl = eval $text;
520 if ( @addl && ! $@ ) {
521 @addl_comp_root = @addl;
523 warn "error parsing $addl_comp_root_file: $@\n";
528 scalar(@addl_comp_root)
530 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
533 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
536 request_class => $request_class,
537 data_dir => '%%%MASONDATA%%%',
538 error_mode => 'output',
539 error_format => 'html',
540 ignore_warnings_expr => '.',
543 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
545 my $html_defang = new HTML::Defang (%defang_opts);
547 #false laziness w/ FS::Maketext js_mt
548 my $js_string_sub = sub {
549 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
550 ${$_[0]} =~ s/(['\\])/\\$1/g;
551 ${$_[0]} =~ s/\r/\\r/g;
552 ${$_[0]} =~ s/\n/\\n/g;
553 # prevent premature termination of the script
554 ${$_[0]} =~ s[</script>][<\\/script>]ig;
555 ${$_[0]} = "'". ${$_[0]}. "'";
558 my $defang_sub = sub {
559 ${$_[0]} = $html_defang->defang(${$_[0]});
562 my $fs_interp = new HTML::Mason::Interp (
564 comp_root => $fs_comp_root,
565 escape_flags => { 'js_string' => $js_string_sub,
566 'defang' => $defang_sub,
568 compiler => HTML::Mason::Compiler::ToObject->new(
569 allow_globals => [qw(%session)],
573 my $rt_interp = new HTML::Mason::Interp (
576 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
577 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
579 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
580 'u' => \&RT::Interface::Web::EscapeURI,
581 'j' => \&RT::Interface::Web::EscapeJS,
582 'js_string' => $js_string_sub,
584 compiler => HTML::Mason::Compiler::ToObject->new(
585 default_escape_flags => 'h',
586 allow_globals => [qw(%session)],
590 ( $fs_interp, $rt_interp );
598 Lurking in the darkness...
602 L<HTML::Mason>, L<FS>, L<RT>