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 );
65 use DateTime::Format::Strptime;
66 use FS::Misc::DateTime qw( parse_datetime );
67 use Lingua::EN::Inflect qw(PL);
68 Lingua::EN::Inflect::classical names=>0; #Categorys
73 use HTML::TreeBuilder;
74 use HTML::TableExtract qw(tree);
78 # use XMLRPC::Transport::HTTP;
79 # use XMLRPC::Lite; # for XMLRPC::Serializer
84 #not actually using this yet anyway...# use IPC::Run3 0.036;
85 use Net::Whois::Raw qw(whois);
87 eval "use Net::Whois::Raw 0.32 qw(whois)";
91 use Spreadsheet::WriteExcel;
92 use Spreadsheet::WriteExcel::Utility;
93 use Business::CreditCard 0.30; #for mask-aware cardtype()
96 use Net::Ping::External;
97 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
99 no warnings 'redefine';
100 eval 'sub Net::Ping::External::_ping_linux {
102 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
103 return Net::Ping::External::_ping_system($command, 0);
108 use String::Approx qw(amatch);
109 use Chart::LinesPoints;
113 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
116 use Business::US::USPS::WebTools::AddressStandardization;
118 use Storable qw( nfreeze thaw );
120 use FS::UID qw( getotaker dbh datasrc driver_name );
121 use FS::Record qw( qsearch qsearchs fields dbdef
122 str2time_sql str2time_sql_closing
125 use FS::CGI qw(header menubar table itable ntable idiot
126 eidiot myexit http_header);
127 use FS::UI::Web qw(svc_url);
128 use FS::UI::Web::small_custview qw(small_custview);
129 use FS::UI::bytecount;
130 use FS::Msgcat qw(gettext geterror);
131 use FS::Misc qw( send_email send_fax ocr_image
132 states_hash counties cities state_label
134 use FS::Misc::eps2png qw( eps2png );
135 use FS::Report::FCC_477;
136 use FS::Report::Table::Monthly;
137 use FS::TicketSystem;
138 use FS::NetworkMonitoringSystem;
139 use FS::Tron qw( tron_lint );
145 use FS::domain_record;
147 use FS::cust_bill_pay;
149 use FS::cust_credit_bill;
151 use FS::cust_main::Search qw(smart_search);
152 use FS::cust_main::Import;
153 use FS::cust_main_county;
154 use FS::cust_location;
157 use FS::cust_pkg::Import;
158 use FS::part_pkg_taxclass;
159 use FS::cust_pkg_reason;
161 use FS::cust_credit_refund;
162 use FS::cust_pay_refund;
165 use FS::part_bill_event;
167 use FS::part_event_condition;
169 use FS::part_referral;
171 use FS::part_svc_router;
172 use FS::part_virtual_field;
176 use FS::queue qw(joblisting);
180 use FS::svc_acct_pop qw(popselector);
181 use FS::acct_rt_transaction;
187 use FS::svc_broadband;
188 use FS::svc_external;
191 use FS::part_export_option;
193 use FS::export_device;
200 use FS::payment_gateway;
201 use FS::agent_payment_gateway;
206 use FS::inventory_class;
207 use FS::inventory_item;
208 use FS::pkg_category;
211 use FS::access_user_pref;
212 use FS::access_group;
213 use FS::access_usergroup;
214 use FS::access_groupagent;
215 use FS::access_right;
218 use FS::phone_device;
222 use FS::cust_main_note;
224 use FS::cust_tax_location;
225 use FS::part_pkg_taxproduct;
226 use FS::part_pkg_taxoverride;
227 use FS::part_pkg_taxrate;
229 use FS::part_pkg_report_option;
230 use FS::cust_attachment;
232 use FS::h_inventory_item;
234 use FS::h_svc_broadband;
235 use FS::h_svc_domain;
236 #use FS::h_domain_record;
237 use FS::h_svc_external;
238 use FS::h_svc_forward;
240 #use FS::h_phone_device;
242 use FS::cust_statement;
244 use FS::cust_category;
245 use FS::prospect_main;
250 use FS::cust_pkg_discount;
251 use FS::cust_bill_pkg_discount;
252 use FS::svc_mailinglist;
254 use FS::cgp_rule_condition;
255 use FS::cgp_rule_action;
257 use FS::cust_bill_batch;
259 use FS::rate_time_interval;
260 use FS::msg_template;
263 use FS::part_pkg_discount;
269 use FS::part_pkg_vendor;
270 use FS::cust_note_class;
275 use FS::torrus_srvderive;
276 use FS::torrus_srvderive_component;
279 use FS::svc_hardware;
280 use FS::hardware_class;
281 use FS::hardware_type;
282 use FS::hardware_status;
283 use FS::did_order_item;
288 if ( $FS::Mason::addl_handler_use ) {
289 eval $FS::Mason::addl_handler_use;
293 if ( %%%RT_ENABLED%%% ) {
295 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
296 use vars qw($Nobody $SystemUser);
300 use RT::Transactions;
305 use RT::ScripActions;
306 use RT::ScripConditions;
309 use RT::GroupMembers;
310 use RT::CustomFields;
311 use RT::CustomFieldValues;
312 use RT::ObjectCustomFieldValues;
314 #blah. manually updated from RT::Interface::Web::Handler
315 use RT::Interface::Web;
322 #blah. not even in RT::Interface::Web::Handler, just in
323 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
324 #to throw a real error instead of just a mysterious unstyled RT
325 use CSS::Squish 0.06;
327 use RT::Interface::Web::Request;
329 #nother undeclared web UI dep (for ticket links graph)
330 use IPC::Run::SafeHandles;
332 #slow, unreliable, segfaults and is optional
333 #see rt/html/Ticket/Elements/ShowTransactionAttachments
336 #?#use File::Path qw( rmtree );
337 #?#use File::Glob qw( bsd_glob );
338 #?#use File::Spec::Unix;
344 *CGI::redirect = sub {
347 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
348 (my $x, $cookie) = (shift, shift);
349 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
351 my $location = shift;
355 # false laziness w/below
356 if ( defined(@DBIx::Profile::ISA) ) {
358 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
363 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
365 ( UNIVERSAL::can(dbh, 'sprintProfile')
366 ? encode_entities(dbh->sprintProfile())
367 : 'DBIx::Profile missing sprintProfile method;'.
368 'unpatched or too old?' ).
369 #"\n\n". &sprintAutoProfile(). '</PRE>'.
374 dbh->{'private_profile'} = {};
379 #clear db profile, but normal redirect
380 dbh->{'private_profile'} = {};
381 $m->redirect($location);
386 } else { #normal redirect
388 $m->redirect($location);
397 #carp #should just switch to <& &> syntax
403 $m->comp('/elements/errorpage.html', @_);
406 sub errorpage_popup {
408 $m->comp('/elements/errorpage-popup.html', @_);
417 my( $location ) = @_;
420 #false laziness w/above
421 if ( defined(@DBIx::Profile::ISA) ) {
423 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
428 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
430 ( UNIVERSAL::can(dbh, 'sprintProfile')
431 ? encode_entities(dbh->sprintProfile())
432 : 'DBIx::Profile missing sprintProfile method;'.
433 'unpatched or too old?' ).
434 #"\n\n". &sprintAutoProfile(). '</PRE>'.
439 dbh->{'private_profile'} = {};
443 #clear db profile, but normal redirect
444 dbh->{'private_profile'} = {};
445 $m->redirect($location);
449 } else { #normal redirect
451 $m->redirect($location);
457 } # end package HTML::Mason::Commands;
463 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
465 Returns a list consisting of two HTML::Mason::Interp objects, the first for
466 Freeside pages, and the second for RT pages.
468 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
470 Options and values can be passed following mode. Currently available options
473 I<outbuf> should be set to a scalar reference in standalone mode.
477 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
480 my $mode = shift || 'apache';
483 #my $request_class = 'HTML::Mason::Request'.
484 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
485 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
486 : 'FS::Mason::Request';
488 #not entirely sure it belongs here, but what the hey
489 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
493 # A hook supporting strange legacy ways people (well, SG) have added stuff on
495 my @addl_comp_root = ();
496 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
497 if ( -e $addl_comp_root_file ) {
498 warn "reading $addl_comp_root_file\n";
499 my $text = slurp( $addl_comp_root_file );
500 my @addl = eval $text;
501 if ( @addl && ! $@ ) {
502 @addl_comp_root = @addl;
504 warn "error parsing $addl_comp_root_file: $@\n";
509 scalar(@addl_comp_root)
511 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
514 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
517 request_class => $request_class,
518 data_dir => '%%%MASONDATA%%%',
519 error_mode => 'output',
520 error_format => 'html',
521 ignore_warnings_expr => '.',
524 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
526 my $html_defang = new HTML::Defang (%defang_opts);
528 my $js_string_sub = sub {
529 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
530 ${$_[0]} =~ s/(['\\])/\\$1/g;
531 ${$_[0]} =~ s/\r/\\r/g;
532 ${$_[0]} =~ s/\n/\\n/g;
533 ${$_[0]} = "'". ${$_[0]}. "'";
536 my $defang_sub = sub {
537 ${$_[0]} = $html_defang->defang(${$_[0]});
540 my $fs_interp = new HTML::Mason::Interp (
542 comp_root => $fs_comp_root,
543 escape_flags => { 'js_string' => $js_string_sub,
544 'defang' => $defang_sub,
546 compiler => HTML::Mason::Compiler::ToObject->new(
547 allow_globals => [qw(%session)],
551 my $rt_interp = new HTML::Mason::Interp (
554 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
555 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
557 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
558 'js_string' => $js_string_sub,
560 compiler => HTML::Mason::Compiler::ToObject->new(
561 default_escape_flags => 'h',
562 allow_globals => [qw(%session)],
566 ( $fs_interp, $rt_interp );
574 Lurking in the darkness...
578 L<HTML::Mason>, L<FS>, L<RT>