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;
163 use FS::cust_main::Search qw(smart_search);
164 use FS::cust_main::Import;
165 use FS::cust_main_county;
166 use FS::cust_location;
169 use FS::cust_pkg::Import;
170 use FS::part_pkg_taxclass;
171 use FS::cust_pkg_reason;
173 use FS::cust_credit_refund;
174 use FS::cust_pay_refund;
177 use FS::part_bill_event;
179 use FS::part_event_condition;
181 use FS::part_referral;
183 use FS::part_svc_router;
184 use FS::part_virtual_field;
188 use FS::queue qw(joblisting);
192 use FS::svc_acct_pop qw(popselector);
193 use FS::acct_rt_transaction;
199 use FS::svc_broadband;
200 use FS::svc_external;
203 use FS::part_export_option;
205 use FS::export_device;
212 use FS::payment_gateway;
213 use FS::agent_payment_gateway;
218 use FS::inventory_class;
219 use FS::inventory_item;
220 use FS::pkg_category;
223 use FS::access_user_pref;
224 use FS::access_group;
225 use FS::access_usergroup;
226 use FS::access_groupagent;
227 use FS::access_right;
230 use FS::phone_device;
234 use FS::cust_main_note;
236 use FS::cust_tax_location;
237 use FS::part_pkg_taxproduct;
238 use FS::part_pkg_taxoverride;
239 use FS::part_pkg_taxrate;
241 use FS::part_pkg_report_option;
242 use FS::cust_attachment;
244 use FS::h_inventory_item;
246 use FS::h_svc_broadband;
247 use FS::h_svc_domain;
248 #use FS::h_domain_record;
249 use FS::h_svc_external;
250 use FS::h_svc_forward;
252 #use FS::h_phone_device;
254 use FS::cust_statement;
256 use FS::cust_category;
257 use FS::prospect_main;
262 use FS::cust_pkg_discount;
263 use FS::cust_bill_pkg_discount;
264 use FS::svc_mailinglist;
266 use FS::cgp_rule_condition;
267 use FS::cgp_rule_action;
269 use FS::cust_bill_batch;
271 use FS::rate_time_interval;
272 use FS::msg_template;
275 use FS::part_pkg_discount;
281 use FS::part_pkg_vendor;
282 use FS::cust_note_class;
287 use FS::torrus_srvderive;
288 use FS::torrus_srvderive_component;
292 use FS::svc_hardware;
293 use FS::h_svc_hardware;
294 use FS::hardware_class;
295 use FS::hardware_type;
296 use FS::hardware_status;
297 use FS::did_order_item;
301 use FS::radius_group;
302 use FS::template_content;
307 use FS::legacy_cust_bill;
309 use FS::rate_tier_detail;
311 use FS::discount_plan;
313 use FS::tower_sector;
314 use FS::agent_pkg_class;
319 if ( $FS::Mason::addl_handler_use ) {
320 eval $FS::Mason::addl_handler_use;
324 if ( %%%RT_ENABLED%%% ) {
326 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
327 use vars qw($Nobody $SystemUser);
331 use RT::Transactions;
336 use RT::ScripActions;
337 use RT::ScripConditions;
340 use RT::GroupMembers;
341 use RT::CustomFields;
342 use RT::CustomFieldValues;
343 use RT::ObjectCustomFieldValues;
345 #blah. manually updated from RT::Interface::Web::Handler
346 use RT::Interface::Web;
353 #blah. not even in RT::Interface::Web::Handler, just in
354 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
355 #to throw a real error instead of just a mysterious unstyled RT
356 use CSS::Squish 0.06;
358 use RT::Interface::Web::Request;
360 #another undeclared web UI dep (for ticket links graph)
361 use IPC::Run::SafeHandles;
363 #slow, unreliable, segfaults and is optional
364 #see rt/html/Ticket/Elements/ShowTransactionAttachments
367 #?#use File::Path qw( rmtree );
368 #?#use File::Glob qw( bsd_glob );
369 #?#use File::Spec::Unix;
375 *CGI::redirect = sub {
378 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
379 (my $x, $cookie) = (shift, shift);
380 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
382 my $location = shift;
386 # false laziness w/below
387 if ( defined(@DBIx::Profile::ISA) ) {
389 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
394 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
396 ( UNIVERSAL::can(dbh, 'sprintProfile')
397 ? encode_entities(dbh->sprintProfile())
398 : 'DBIx::Profile missing sprintProfile method;'.
399 'unpatched or too old?' ).
400 #"\n\n". &sprintAutoProfile(). '</PRE>'.
405 dbh->{'private_profile'} = {};
410 #clear db profile, but normal redirect
411 dbh->{'private_profile'} = {};
412 $m->redirect($location);
417 } else { #normal redirect
419 $m->redirect($location);
428 #carp #should just switch to <& &> syntax
434 $m->comp('/elements/errorpage.html', @_);
437 sub errorpage_popup {
439 $m->comp('/elements/errorpage-popup.html', @_);
443 my( $location ) = @_;
446 #false laziness w/above
447 if ( defined(@DBIx::Profile::ISA) ) {
449 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
454 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
456 ( UNIVERSAL::can(dbh, 'sprintProfile')
457 ? encode_entities(dbh->sprintProfile())
458 : 'DBIx::Profile missing sprintProfile method;'.
459 'unpatched or too old?' ).
460 #"\n\n". &sprintAutoProfile(). '</PRE>'.
465 dbh->{'private_profile'} = {};
469 #clear db profile, but normal redirect
470 dbh->{'private_profile'} = {};
471 $m->redirect($location);
475 } else { #normal redirect
477 $m->redirect($location);
483 } # end package HTML::Mason::Commands;
489 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
491 Returns a list consisting of two HTML::Mason::Interp objects, the first for
492 Freeside pages, and the second for RT pages.
494 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
496 Options and values can be passed following mode. Currently available options
499 I<outbuf> should be set to a scalar reference in standalone mode.
503 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
506 my $mode = shift || 'apache';
509 #my $request_class = 'HTML::Mason::Request'.
510 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
511 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
512 : 'FS::Mason::Request';
514 #not entirely sure it belongs here, but what the hey
515 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
519 # A hook supporting strange legacy ways people (well, SG) have added stuff on
521 my @addl_comp_root = ();
522 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
523 if ( -e $addl_comp_root_file ) {
524 warn "reading $addl_comp_root_file\n";
525 my $text = slurp( $addl_comp_root_file );
526 my @addl = eval $text;
527 if ( @addl && ! $@ ) {
528 @addl_comp_root = @addl;
530 warn "error parsing $addl_comp_root_file: $@\n";
535 scalar(@addl_comp_root)
537 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
540 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
543 request_class => $request_class,
544 data_dir => '%%%MASONDATA%%%',
545 error_mode => 'output',
546 error_format => 'html',
547 ignore_warnings_expr => '.',
550 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
552 my $html_defang = new HTML::Defang (%defang_opts);
554 #false laziness w/ FS::Maketext js_mt
555 my $js_string_sub = sub {
556 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
557 ${$_[0]} =~ s/(['\\])/\\$1/g;
558 ${$_[0]} =~ s/\r/\\r/g;
559 ${$_[0]} =~ s/\n/\\n/g;
560 # prevent premature termination of the script
561 ${$_[0]} =~ s[</script>][<\\/script>]ig;
562 ${$_[0]} = "'". ${$_[0]}. "'";
565 my $defang_sub = sub {
566 ${$_[0]} = $html_defang->defang(${$_[0]});
569 my $fs_interp = new HTML::Mason::Interp (
571 comp_root => $fs_comp_root,
572 escape_flags => { 'js_string' => $js_string_sub,
573 'defang' => $defang_sub,
575 compiler => HTML::Mason::Compiler::ToObject->new(
576 allow_globals => [qw(%session)],
580 my $rt_interp = new HTML::Mason::Interp (
583 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
584 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
586 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
587 'u' => \&RT::Interface::Web::EscapeURI,
588 'j' => \&RT::Interface::Web::EscapeJS,
589 'js_string' => $js_string_sub,
591 compiler => HTML::Mason::Compiler::ToObject->new(
592 default_escape_flags => 'h',
593 allow_globals => [qw(%session)],
597 ( $fs_interp, $rt_interp );
605 Lurking in the darkness...
609 L<HTML::Mason>, L<FS>, L<RT>