4 use vars qw( @ISA @EXPORT_OK $addl_handler_use );
6 use File::Slurp qw( slurp );
7 use HTML::Mason 1.27; #http://www.masonhq.com/?ApacheModPerl2Redirect
8 use HTML::Mason::Interp;
9 use HTML::Mason::Compiler::ToObject;
11 @ISA = qw( Exporter );
12 @EXPORT_OK = qw( mason_interps );
16 FS::Mason - Initialize the Mason environment
20 use FS::Mason qw( mason_interps );
22 my( $fs_interp, $rt_interp ) = mason_interps('apache');
26 my( $fs_interp, $rt_interp ) = mason_interps('standalone'); #XXX name?
30 Initializes the Mason environment, loads all Freeside and RT libraries, etc.
34 $addl_handler_use = '';
35 my $addl_handler_use_file = '%%%FREESIDE_CONF%%%/addl_handler_use.pl';
36 if ( -e $addl_handler_use_file ) {
37 $addl_handler_use = slurp( $addl_handler_use_file );
40 # List of modules that you want to use from components (see Admin
43 package HTML::Mason::Commands;
46 use vars qw( %session );
47 use CGI 3.29 qw(-private_tempfiles); #3.29 to fix RT attachment problems
49 #breaks quick payment entry
50 #http://rt.cpan.org/Public/Bug/Display.html?id=37365
51 die "CGI.pm v3.38 is broken, use any other version >= 3.29".
52 " (Debian 5.0? aptitude remove libcgi-pm-perl)"
53 if $CGI::VERSION == 3.38;
55 #use CGI::Carp qw(fatalsToBrowser);
57 use List::Util qw( max min );
65 use DateTime::Format::Strptime;
66 use Lingua::EN::Inflect qw(PL);
71 use HTML::TreeBuilder;
78 #not actually using this yet anyway...# use IPC::Run3 0.036;
79 use Net::Whois::Raw qw(whois);
81 eval "use Net::Whois::Raw 0.32 qw(whois)";
85 use Spreadsheet::WriteExcel;
86 use Business::CreditCard 0.30; #for mask-aware cardtype()
89 use Net::Ping::External;
90 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
92 no warnings 'redefine';
93 eval 'sub Net::Ping::External::_ping_linux {
95 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
96 return Net::Ping::External::_ping_system($command, 0);
101 use String::Approx qw(amatch);
102 use Chart::LinesPoints;
105 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
108 use Business::US::USPS::WebTools::AddressStandardization;
110 use FS::UID qw( getotaker dbh datasrc driver_name );
111 use FS::Record qw( qsearch qsearchs fields dbdef
112 str2time_sql str2time_sql_closing
115 use FS::CGI qw(header menubar table itable ntable idiot
116 eidiot myexit http_header);
117 use FS::UI::Web qw(svc_url);
118 use FS::UI::Web::small_custview qw(small_custview);
119 use FS::UI::bytecount;
120 use FS::Msgcat qw(gettext geterror);
121 use FS::Misc qw( send_email send_fax states_hash counties state_label );
122 use FS::Misc::eps2png qw( eps2png );
123 use FS::Report::Table::Monthly;
124 use FS::TicketSystem;
125 use FS::Tron qw( tron_lint );
129 use FS::domain_record;
131 use FS::cust_bill_pay;
133 use FS::cust_credit_bill;
134 use FS::cust_main qw(smart_search);
135 use FS::cust_main::Import;
136 use FS::cust_main_county;
137 use FS::cust_location;
140 use FS::part_pkg_taxclass;
141 use FS::cust_pkg_reason;
143 use FS::cust_credit_refund;
144 use FS::cust_pay_refund;
147 use FS::part_bill_event;
149 use FS::part_event_condition;
151 use FS::part_referral;
153 use FS::part_svc_router;
154 use FS::part_virtual_field;
158 use FS::queue qw(joblisting);
162 use FS::svc_acct_pop qw(popselector);
163 use FS::acct_rt_transaction;
169 use FS::svc_broadband;
170 use FS::svc_external;
173 use FS::part_export_option;
181 use FS::payment_gateway;
182 use FS::agent_payment_gateway;
187 use FS::inventory_class;
188 use FS::inventory_item;
189 use FS::pkg_category;
192 use FS::access_user_pref;
193 use FS::access_group;
194 use FS::access_usergroup;
195 use FS::access_groupagent;
196 use FS::access_right;
199 use FS::phone_device;
203 use FS::cust_main_note;
205 use FS::cust_tax_location;
206 use FS::part_pkg_taxproduct;
207 use FS::part_pkg_taxoverride;
208 use FS::part_pkg_taxrate;
210 use FS::part_pkg_report_option;
211 use FS::cust_attachment;
214 use FS::h_svc_broadband;
215 use FS::h_svc_domain;
216 #use FS::h_domain_record;
217 use FS::h_svc_external;
218 use FS::h_svc_forward;
220 #use FS::h_phone_device;
222 use FS::cust_statement;
225 if ( $FS::Mason::addl_handler_use ) {
226 eval $FS::Mason::addl_handler_use;
230 if ( %%%RT_ENABLED%%% ) {
232 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
233 use vars qw($Nobody $SystemUser);
236 use RT::Transactions;
241 use RT::ScripActions;
242 use RT::ScripConditions;
245 use RT::GroupMembers;
246 use RT::CustomFields;
247 use RT::CustomFieldValues;
248 use RT::ObjectCustomFieldValues;
250 #blah. manually updated from RT::Interface::Web::Handler
251 use RT::Interface::Web;
258 #blah. not even in RT::Interface::Web::Handler, just in
259 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
260 #to throw a real error instead of just a mysterious unstyled RT
261 use CSS::Squish 0.06;
263 #slow, unreliable, segfaults and is optional
264 #see rt/html/Ticket/Elements/ShowTransactionAttachments
267 #?#use File::Path qw( rmtree );
268 #?#use File::Glob qw( bsd_glob );
269 #?#use File::Spec::Unix;
275 *CGI::redirect = sub {
278 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
279 (my $x, $cookie) = (shift, shift);
280 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
282 my $location = shift;
286 # false laziness w/below
287 if ( defined(@DBIx::Profile::ISA) ) {
289 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
294 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
296 ( UNIVERSAL::can(dbh, 'sprintProfile')
297 ? encode_entities(dbh->sprintProfile())
298 : 'DBIx::Profile missing sprintProfile method;'.
299 'unpatched or too old?' ).
300 #"\n\n". &sprintAutoProfile(). '</PRE>'.
305 dbh->{'private_profile'} = {};
310 #clear db profile, but normal redirect
311 dbh->{'private_profile'} = {};
312 $m->redirect($location);
317 } else { #normal redirect
319 $m->redirect($location);
333 $m->comp('/elements/errorpage.html', @_);
337 my( $location ) = @_;
340 #false laziness w/above
341 if ( defined(@DBIx::Profile::ISA) ) {
343 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
348 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
350 ( UNIVERSAL::can(dbh, 'sprintProfile')
351 ? encode_entities(dbh->sprintProfile())
352 : 'DBIx::Profile missing sprintProfile method;'.
353 'unpatched or too old?' ).
354 #"\n\n". &sprintAutoProfile(). '</PRE>'.
359 dbh->{'private_profile'} = {};
363 #clear db profile, but normal redirect
364 dbh->{'private_profile'} = {};
365 $m->redirect($location);
369 } else { #normal redirect
371 $m->redirect($location);
377 } # end package HTML::Mason::Commands;
383 =item mason_interps [ MODE ]
385 Returns a list consisting of two HTML::Mason::Interp objects, the first for
386 Freeside pages, and the second for RT pages.
388 #MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
393 my $mode = shift || 'apache';
396 #my $request_class = 'HTML::Mason::Request'.
397 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
398 my $request_class = 'FS::Mason::Request';
400 #not entirely sure it belongs here, but what the hey
401 if ( %%%RT_ENABLED%%% ) {
405 # A hook supporting strange legacy ways people have added stuff on
407 my @addl_comp_root = ();
408 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
409 if ( -e $addl_comp_root_file ) {
410 warn "reading $addl_comp_root_file\n";
411 my $text = slurp( $addl_comp_root_file );
412 my @addl = eval $text;
413 if ( @addl && ! $@ ) {
414 @addl_comp_root = @addl;
416 warn "error parsing $addl_comp_root_file: $@\n";
421 request_class => $request_class,
422 data_dir => '%%%MASONDATA%%%',
423 error_mode => 'output',
424 error_format => 'html',
425 ignore_warnings_expr => '.',
427 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
428 [ 'rt' =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
433 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
435 my $fs_interp = new HTML::Mason::Interp (
437 escape_flags => { 'js_string' => sub {
438 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
439 ${$_[0]} =~ s/(['\\])/\\$1/g;
440 ${$_[0]} =~ s/\n/\\n/g;
441 ${$_[0]} = "'". ${$_[0]}. "'";
444 compiler => HTML::Mason::Compiler::ToObject->new(
445 allow_globals => [qw(%session)],
449 my $rt_interp = new HTML::Mason::Interp (
451 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8 },
452 compiler => HTML::Mason::Compiler::ToObject->new(
453 default_escape_flags => 'h',
454 allow_globals => [qw(%session)],
458 ( $fs_interp, $rt_interp );
466 Lurking in the darkness...
470 L<HTML::Mason>, L<FS>, L<RT>