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_censustract 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 #not actually using this yet anyway...# use IPC::Run3 0.036;
89 use Net::Whois::Raw qw(whois);
91 eval "use Net::Whois::Raw 0.32 qw(whois)";
95 use Spreadsheet::WriteExcel;
96 use Spreadsheet::WriteExcel::Utility;
97 use OLE::Storage_Lite;
98 use Excel::Writer::XLSX;
99 #use Excel::Writer::XLSX::Utility; #redundant with above
101 use Business::CreditCard 0.30; #for mask-aware cardtype()
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 Business::US::USPS::WebTools::AddressStandardization;
125 use Geo::GoogleEarth::Pluggable;
127 use Storable qw( nfreeze thaw );
129 use FS::UID qw( getotaker dbh datasrc driver_name );
130 use FS::Record qw( qsearch qsearchs fields dbdef
131 str2time_sql str2time_sql_closing
135 use FS::CGI qw(header menubar table itable ntable idiot
136 eidiot myexit http_header);
137 use FS::UI::Web qw(svc_url);
138 use FS::UI::Web::small_custview qw(small_custview);
139 use FS::UI::bytecount;
140 use FS::Msgcat qw(gettext geterror);
141 use FS::Misc qw( send_email send_fax ocr_image
142 states_hash counties cities state_label
144 use FS::Misc::eps2png qw( eps2png );
145 use FS::Report::FCC_477;
146 use FS::Report::Table;
147 use FS::Report::Table::Monthly;
148 use FS::Report::Table::Daily;
149 use FS::TicketSystem;
150 use FS::NetworkMonitoringSystem;
151 use FS::Tron qw( tron_lint );
153 use FS::Maketext qw( mt emt js_mt );
157 use FS::domain_record;
159 use FS::cust_bill_pay;
161 use FS::cust_credit_bill;
164 use FS::cust_main::Search qw(smart_search);
165 use FS::cust_main::Import;
166 use FS::cust_main_county;
167 use FS::cust_location;
170 use FS::cust_pkg::Import;
171 use FS::part_pkg_taxclass;
172 use FS::cust_pkg_reason;
174 use FS::cust_credit_refund;
175 use FS::cust_pay_refund;
178 use FS::part_bill_event;
180 use FS::part_event_condition;
182 use FS::part_referral;
184 use FS::part_svc_router;
185 use FS::part_virtual_field;
189 use FS::queue qw(joblisting);
193 use FS::svc_acct_pop qw(popselector);
194 use FS::acct_rt_transaction;
200 use FS::svc_broadband;
201 use FS::svc_external;
204 use FS::part_export_option;
206 use FS::export_device;
213 use FS::payment_gateway;
214 use FS::agent_payment_gateway;
219 use FS::inventory_class;
220 use FS::inventory_item;
221 use FS::pkg_category;
224 use FS::access_user_pref;
225 use FS::access_group;
226 use FS::access_usergroup;
227 use FS::access_groupagent;
228 use FS::access_right;
231 use FS::phone_device;
235 use FS::cust_main_note;
237 use FS::cust_tax_location;
238 use FS::part_pkg_taxproduct;
239 use FS::part_pkg_taxoverride;
240 use FS::part_pkg_taxrate;
242 use FS::part_pkg_report_option;
243 use FS::cust_attachment;
245 use FS::h_inventory_item;
247 use FS::h_svc_broadband;
248 use FS::h_svc_domain;
249 #use FS::h_domain_record;
250 use FS::h_svc_external;
251 use FS::h_svc_forward;
253 #use FS::h_phone_device;
255 use FS::cust_statement;
257 use FS::cust_category;
258 use FS::prospect_main;
263 use FS::cust_pkg_discount;
264 use FS::cust_bill_pkg_discount;
265 use FS::svc_mailinglist;
267 use FS::cgp_rule_condition;
268 use FS::cgp_rule_action;
270 use FS::cust_bill_batch;
272 use FS::rate_time_interval;
273 use FS::msg_template;
276 use FS::part_pkg_discount;
282 use FS::part_pkg_vendor;
283 use FS::cust_note_class;
288 use FS::torrus_srvderive;
289 use FS::torrus_srvderive_component;
293 use FS::svc_hardware;
294 use FS::h_svc_hardware;
295 use FS::hardware_class;
296 use FS::hardware_type;
297 use FS::hardware_status;
298 use FS::did_order_item;
302 use FS::radius_group;
303 use FS::template_content;
308 use FS::legacy_cust_bill;
310 use FS::rate_tier_detail;
312 use FS::discount_plan;
314 use FS::tower_sector;
315 use FS::agent_pkg_class;
320 if ( $FS::Mason::addl_handler_use ) {
321 eval $FS::Mason::addl_handler_use;
325 if ( %%%RT_ENABLED%%% ) {
327 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
328 use vars qw($Nobody $SystemUser);
332 use RT::Transactions;
337 use RT::ScripActions;
338 use RT::ScripConditions;
341 use RT::GroupMembers;
342 use RT::CustomFields;
343 use RT::CustomFieldValues;
344 use RT::ObjectCustomFieldValues;
346 #blah. manually updated from RT::Interface::Web::Handler
347 use RT::Interface::Web;
354 #blah. not even in RT::Interface::Web::Handler, just in
355 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
356 #to throw a real error instead of just a mysterious unstyled RT
357 use CSS::Squish 0.06;
359 use RT::Interface::Web::Request;
361 #another undeclared web UI dep (for ticket links graph)
362 use IPC::Run::SafeHandles;
364 #slow, unreliable, segfaults and is optional
365 #see rt/html/Ticket/Elements/ShowTransactionAttachments
368 #?#use File::Path qw( rmtree );
369 #?#use File::Glob qw( bsd_glob );
370 #?#use File::Spec::Unix;
376 *CGI::redirect = sub {
379 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
380 (my $x, $cookie) = (shift, shift);
381 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
383 my $location = shift;
387 # false laziness w/below
388 if ( defined(@DBIx::Profile::ISA) ) {
390 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
395 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
397 ( UNIVERSAL::can(dbh, 'sprintProfile')
398 ? encode_entities(dbh->sprintProfile())
399 : 'DBIx::Profile missing sprintProfile method;'.
400 'unpatched or too old?' ).
401 #"\n\n". &sprintAutoProfile(). '</PRE>'.
406 dbh->{'private_profile'} = {};
411 #clear db profile, but normal redirect
412 dbh->{'private_profile'} = {};
413 $m->redirect($location);
418 } else { #normal redirect
420 $m->redirect($location);
429 #carp #should just switch to <& &> syntax
435 $m->comp('/elements/errorpage.html', @_);
438 sub errorpage_popup {
440 $m->comp('/elements/errorpage-popup.html', @_);
444 my( $location ) = @_;
447 #false laziness w/above
448 if ( defined(@DBIx::Profile::ISA) ) {
450 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
455 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
457 ( UNIVERSAL::can(dbh, 'sprintProfile')
458 ? encode_entities(dbh->sprintProfile())
459 : 'DBIx::Profile missing sprintProfile method;'.
460 'unpatched or too old?' ).
461 #"\n\n". &sprintAutoProfile(). '</PRE>'.
466 dbh->{'private_profile'} = {};
470 #clear db profile, but normal redirect
471 dbh->{'private_profile'} = {};
472 $m->redirect($location);
476 } else { #normal redirect
478 $m->redirect($location);
484 } # end package HTML::Mason::Commands;
490 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
492 Returns a list consisting of two HTML::Mason::Interp objects, the first for
493 Freeside pages, and the second for RT pages.
495 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
497 Options and values can be passed following mode. Currently available options
500 I<outbuf> should be set to a scalar reference in standalone mode.
504 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
507 my $mode = shift || 'apache';
510 #my $request_class = 'HTML::Mason::Request'.
511 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
512 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
513 : 'FS::Mason::Request';
515 #not entirely sure it belongs here, but what the hey
516 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
520 # A hook supporting strange legacy ways people (well, SG) have added stuff on
522 my @addl_comp_root = ();
523 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
524 if ( -e $addl_comp_root_file ) {
525 warn "reading $addl_comp_root_file\n";
526 my $text = slurp( $addl_comp_root_file );
527 my @addl = eval $text;
528 if ( @addl && ! $@ ) {
529 @addl_comp_root = @addl;
531 warn "error parsing $addl_comp_root_file: $@\n";
536 scalar(@addl_comp_root)
538 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
541 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
544 request_class => $request_class,
545 data_dir => '%%%MASONDATA%%%',
546 error_mode => 'output',
547 error_format => 'html',
548 ignore_warnings_expr => '.',
551 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
553 my $html_defang = new HTML::Defang (%defang_opts);
555 #false laziness w/ FS::Maketext js_mt
556 my $js_string_sub = sub {
557 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
558 ${$_[0]} =~ s/(['\\])/\\$1/g;
559 ${$_[0]} =~ s/\r/\\r/g;
560 ${$_[0]} =~ s/\n/\\n/g;
561 # prevent premature termination of the script
562 ${$_[0]} =~ s[</script>][<\\/script>]ig;
563 ${$_[0]} = "'". ${$_[0]}. "'";
566 my $defang_sub = sub {
567 ${$_[0]} = $html_defang->defang(${$_[0]});
570 my $fs_interp = new HTML::Mason::Interp (
572 comp_root => $fs_comp_root,
573 escape_flags => { 'js_string' => $js_string_sub,
574 'defang' => $defang_sub,
576 compiler => HTML::Mason::Compiler::ToObject->new(
577 allow_globals => [qw(%session)],
581 my $rt_interp = new HTML::Mason::Interp (
584 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
585 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
587 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
588 'u' => \&RT::Interface::Web::EscapeURI,
589 'j' => \&RT::Interface::Web::EscapeJS,
590 'js_string' => $js_string_sub,
592 compiler => HTML::Mason::Compiler::ToObject->new(
593 default_escape_flags => 'h',
594 allow_globals => [qw(%session)],
598 ( $fs_interp, $rt_interp );
606 Lurking in the darkness...
610 L<HTML::Mason>, L<FS>, L<RT>