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
122 states_hash counties cities state_label
124 use FS::Misc::eps2png qw( eps2png );
125 use FS::Report::Table::Monthly;
126 use FS::TicketSystem;
127 use FS::Tron qw( tron_lint );
131 use FS::domain_record;
133 use FS::cust_bill_pay;
135 use FS::cust_credit_bill;
136 use FS::cust_main qw(smart_search);
137 use FS::cust_main::Import;
138 use FS::cust_main_county;
139 use FS::cust_location;
142 use FS::part_pkg_taxclass;
143 use FS::cust_pkg_reason;
145 use FS::cust_credit_refund;
146 use FS::cust_pay_refund;
149 use FS::part_bill_event;
151 use FS::part_event_condition;
153 use FS::part_referral;
155 use FS::part_svc_router;
156 use FS::part_virtual_field;
160 use FS::queue qw(joblisting);
164 use FS::svc_acct_pop qw(popselector);
165 use FS::acct_rt_transaction;
171 use FS::svc_broadband;
172 use FS::svc_external;
175 use FS::part_export_option;
177 use FS::export_device;
184 use FS::payment_gateway;
185 use FS::agent_payment_gateway;
190 use FS::inventory_class;
191 use FS::inventory_item;
192 use FS::pkg_category;
195 use FS::access_user_pref;
196 use FS::access_group;
197 use FS::access_usergroup;
198 use FS::access_groupagent;
199 use FS::access_right;
202 use FS::phone_device;
206 use FS::cust_main_note;
208 use FS::cust_tax_location;
209 use FS::part_pkg_taxproduct;
210 use FS::part_pkg_taxoverride;
211 use FS::part_pkg_taxrate;
213 use FS::part_pkg_report_option;
214 use FS::cust_attachment;
217 use FS::h_svc_broadband;
218 use FS::h_svc_domain;
219 #use FS::h_domain_record;
220 use FS::h_svc_external;
221 use FS::h_svc_forward;
223 #use FS::h_phone_device;
225 use FS::cust_statement;
227 use FS::cust_category;
228 use FS::prospect_main;
232 use FS::cust_pkg_discount;
233 use FS::cust_bill_pkg_discount;
236 if ( $FS::Mason::addl_handler_use ) {
237 eval $FS::Mason::addl_handler_use;
241 if ( %%%RT_ENABLED%%% ) {
243 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
244 use vars qw($Nobody $SystemUser);
247 use RT::Transactions;
252 use RT::ScripActions;
253 use RT::ScripConditions;
256 use RT::GroupMembers;
257 use RT::CustomFields;
258 use RT::CustomFieldValues;
259 use RT::ObjectCustomFieldValues;
261 #blah. manually updated from RT::Interface::Web::Handler
262 use RT::Interface::Web;
269 #blah. not even in RT::Interface::Web::Handler, just in
270 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
271 #to throw a real error instead of just a mysterious unstyled RT
272 use CSS::Squish 0.06;
274 use RT::Interface::Web::Request;
276 #slow, unreliable, segfaults and is optional
277 #see rt/html/Ticket/Elements/ShowTransactionAttachments
280 #?#use File::Path qw( rmtree );
281 #?#use File::Glob qw( bsd_glob );
282 #?#use File::Spec::Unix;
288 *CGI::redirect = sub {
291 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
292 (my $x, $cookie) = (shift, shift);
293 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
295 my $location = shift;
299 # false laziness w/below
300 if ( defined(@DBIx::Profile::ISA) ) {
302 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
307 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
309 ( UNIVERSAL::can(dbh, 'sprintProfile')
310 ? encode_entities(dbh->sprintProfile())
311 : 'DBIx::Profile missing sprintProfile method;'.
312 'unpatched or too old?' ).
313 #"\n\n". &sprintAutoProfile(). '</PRE>'.
318 dbh->{'private_profile'} = {};
323 #clear db profile, but normal redirect
324 dbh->{'private_profile'} = {};
325 $m->redirect($location);
330 } else { #normal redirect
332 $m->redirect($location);
346 $m->comp('/elements/errorpage.html', @_);
350 my( $location ) = @_;
353 #false laziness w/above
354 if ( defined(@DBIx::Profile::ISA) ) {
356 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
361 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
363 ( UNIVERSAL::can(dbh, 'sprintProfile')
364 ? encode_entities(dbh->sprintProfile())
365 : 'DBIx::Profile missing sprintProfile method;'.
366 'unpatched or too old?' ).
367 #"\n\n". &sprintAutoProfile(). '</PRE>'.
372 dbh->{'private_profile'} = {};
376 #clear db profile, but normal redirect
377 dbh->{'private_profile'} = {};
378 $m->redirect($location);
382 } else { #normal redirect
384 $m->redirect($location);
390 } # end package HTML::Mason::Commands;
396 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
398 Returns a list consisting of two HTML::Mason::Interp objects, the first for
399 Freeside pages, and the second for RT pages.
401 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
403 Options and values can be passed following mode. Currently available options
406 I<outbuf> should be set to a scalar reference in standalone mode.
411 my $mode = shift || 'apache';
414 #my $request_class = 'HTML::Mason::Request'.
415 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
416 my $request_class = 'FS::Mason::Request';
418 #not entirely sure it belongs here, but what the hey
419 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
423 # A hook supporting strange legacy ways people have added stuff on
425 my @addl_comp_root = ();
426 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
427 if ( -e $addl_comp_root_file ) {
428 warn "reading $addl_comp_root_file\n";
429 my $text = slurp( $addl_comp_root_file );
430 my @addl = eval $text;
431 if ( @addl && ! $@ ) {
432 @addl_comp_root = @addl;
434 warn "error parsing $addl_comp_root_file: $@\n";
439 request_class => $request_class,
440 data_dir => '%%%MASONDATA%%%',
441 error_mode => 'output',
442 error_format => 'html',
443 ignore_warnings_expr => '.',
445 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
446 [ 'rt' =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
451 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
453 my $fs_interp = new HTML::Mason::Interp (
455 escape_flags => { 'js_string' => sub {
456 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
457 ${$_[0]} =~ s/(['\\])/\\$1/g;
458 ${$_[0]} =~ s/\n/\\n/g;
459 ${$_[0]} = "'". ${$_[0]}. "'";
462 compiler => HTML::Mason::Compiler::ToObject->new(
463 allow_globals => [qw(%session)],
467 my $rt_interp = new HTML::Mason::Interp (
469 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8 },
470 compiler => HTML::Mason::Compiler::ToObject->new(
471 default_escape_flags => 'h',
472 allow_globals => [qw(%session)],
476 ( $fs_interp, $rt_interp );
484 Lurking in the darkness...
488 L<HTML::Mason>, L<FS>, L<RT>