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;
79 #not actually using this yet anyway...# use IPC::Run3 0.036;
80 use Net::Whois::Raw qw(whois);
82 eval "use Net::Whois::Raw 0.32 qw(whois)";
86 use Spreadsheet::WriteExcel;
87 use Business::CreditCard 0.30; #for mask-aware cardtype()
90 use Net::Ping::External;
91 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
93 no warnings 'redefine';
94 eval 'sub Net::Ping::External::_ping_linux {
96 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
97 return Net::Ping::External::_ping_system($command, 0);
102 use String::Approx qw(amatch);
103 use Chart::LinesPoints;
107 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
110 use Business::US::USPS::WebTools::AddressStandardization;
112 use FS::UID qw( getotaker dbh datasrc driver_name );
113 use FS::Record qw( qsearch qsearchs fields dbdef
114 str2time_sql str2time_sql_closing
117 use FS::CGI qw(header menubar table itable ntable idiot
118 eidiot myexit http_header);
119 use FS::UI::Web qw(svc_url);
120 use FS::UI::Web::small_custview qw(small_custview);
121 use FS::UI::bytecount;
122 use FS::Msgcat qw(gettext geterror);
123 use FS::Misc qw( send_email send_fax
124 states_hash counties cities state_label
126 use FS::Misc::eps2png qw( eps2png );
127 use FS::Report::Table::Monthly;
128 use FS::TicketSystem;
129 use FS::Tron qw( tron_lint );
133 use FS::domain_record;
135 use FS::cust_bill_pay;
137 use FS::cust_credit_bill;
138 use FS::cust_main qw(smart_search);
139 use FS::cust_main::Import;
140 use FS::cust_main_county;
141 use FS::cust_location;
144 use FS::part_pkg_taxclass;
145 use FS::cust_pkg_reason;
147 use FS::cust_credit_refund;
148 use FS::cust_pay_refund;
151 use FS::part_bill_event;
153 use FS::part_event_condition;
155 use FS::part_referral;
157 use FS::part_svc_router;
158 use FS::part_virtual_field;
162 use FS::queue qw(joblisting);
166 use FS::svc_acct_pop qw(popselector);
167 use FS::acct_rt_transaction;
173 use FS::svc_broadband;
174 use FS::svc_external;
177 use FS::part_export_option;
179 use FS::export_device;
186 use FS::payment_gateway;
187 use FS::agent_payment_gateway;
192 use FS::inventory_class;
193 use FS::inventory_item;
194 use FS::pkg_category;
197 use FS::access_user_pref;
198 use FS::access_group;
199 use FS::access_usergroup;
200 use FS::access_groupagent;
201 use FS::access_right;
204 use FS::phone_device;
208 use FS::cust_main_note;
210 use FS::cust_tax_location;
211 use FS::part_pkg_taxproduct;
212 use FS::part_pkg_taxoverride;
213 use FS::part_pkg_taxrate;
215 use FS::part_pkg_report_option;
216 use FS::cust_attachment;
219 use FS::h_svc_broadband;
220 use FS::h_svc_domain;
221 #use FS::h_domain_record;
222 use FS::h_svc_external;
223 use FS::h_svc_forward;
225 #use FS::h_phone_device;
227 use FS::cust_statement;
229 use FS::cust_category;
230 use FS::prospect_main;
234 use FS::cust_pkg_discount;
235 use FS::cust_bill_pkg_discount;
236 use FS::svc_mailinglist;
239 if ( $FS::Mason::addl_handler_use ) {
240 eval $FS::Mason::addl_handler_use;
244 if ( %%%RT_ENABLED%%% ) {
246 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
247 use vars qw($Nobody $SystemUser);
250 use RT::Transactions;
255 use RT::ScripActions;
256 use RT::ScripConditions;
259 use RT::GroupMembers;
260 use RT::CustomFields;
261 use RT::CustomFieldValues;
262 use RT::ObjectCustomFieldValues;
264 #blah. manually updated from RT::Interface::Web::Handler
265 use RT::Interface::Web;
272 #blah. not even in RT::Interface::Web::Handler, just in
273 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
274 #to throw a real error instead of just a mysterious unstyled RT
275 use CSS::Squish 0.06;
277 use RT::Interface::Web::Request;
279 #slow, unreliable, segfaults and is optional
280 #see rt/html/Ticket/Elements/ShowTransactionAttachments
283 #?#use File::Path qw( rmtree );
284 #?#use File::Glob qw( bsd_glob );
285 #?#use File::Spec::Unix;
291 *CGI::redirect = sub {
294 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
295 (my $x, $cookie) = (shift, shift);
296 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
298 my $location = shift;
302 # false laziness w/below
303 if ( defined(@DBIx::Profile::ISA) ) {
305 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
310 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
312 ( UNIVERSAL::can(dbh, 'sprintProfile')
313 ? encode_entities(dbh->sprintProfile())
314 : 'DBIx::Profile missing sprintProfile method;'.
315 'unpatched or too old?' ).
316 #"\n\n". &sprintAutoProfile(). '</PRE>'.
321 dbh->{'private_profile'} = {};
326 #clear db profile, but normal redirect
327 dbh->{'private_profile'} = {};
328 $m->redirect($location);
333 } else { #normal redirect
335 $m->redirect($location);
349 $m->comp('/elements/errorpage.html', @_);
353 my( $location ) = @_;
356 #false laziness w/above
357 if ( defined(@DBIx::Profile::ISA) ) {
359 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
364 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
366 ( UNIVERSAL::can(dbh, 'sprintProfile')
367 ? encode_entities(dbh->sprintProfile())
368 : 'DBIx::Profile missing sprintProfile method;'.
369 'unpatched or too old?' ).
370 #"\n\n". &sprintAutoProfile(). '</PRE>'.
375 dbh->{'private_profile'} = {};
379 #clear db profile, but normal redirect
380 dbh->{'private_profile'} = {};
381 $m->redirect($location);
385 } else { #normal redirect
387 $m->redirect($location);
393 } # end package HTML::Mason::Commands;
399 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
401 Returns a list consisting of two HTML::Mason::Interp objects, the first for
402 Freeside pages, and the second for RT pages.
404 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
406 Options and values can be passed following mode. Currently available options
409 I<outbuf> should be set to a scalar reference in standalone mode.
413 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
416 my $mode = shift || 'apache';
419 #my $request_class = 'HTML::Mason::Request'.
420 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
421 my $request_class = 'FS::Mason::Request';
423 #not entirely sure it belongs here, but what the hey
424 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
428 # A hook supporting strange legacy ways people have added stuff on
430 my @addl_comp_root = ();
431 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
432 if ( -e $addl_comp_root_file ) {
433 warn "reading $addl_comp_root_file\n";
434 my $text = slurp( $addl_comp_root_file );
435 my @addl = eval $text;
436 if ( @addl && ! $@ ) {
437 @addl_comp_root = @addl;
439 warn "error parsing $addl_comp_root_file: $@\n";
444 request_class => $request_class,
445 data_dir => '%%%MASONDATA%%%',
446 error_mode => 'output',
447 error_format => 'html',
448 ignore_warnings_expr => '.',
450 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
451 [ 'rt' =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
456 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
458 my $html_defang = new HTML::Defang (%defang_opts);
460 my $fs_interp = new HTML::Mason::Interp (
462 escape_flags => { 'js_string' => sub {
463 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
464 ${$_[0]} =~ s/(['\\])/\\$1/g;
465 ${$_[0]} =~ s/\n/\\n/g;
466 ${$_[0]} = "'". ${$_[0]}. "'";
469 ${$_[0]} = $html_defang->defang(${$_[0]});
472 compiler => HTML::Mason::Compiler::ToObject->new(
473 allow_globals => [qw(%session)],
477 my $rt_interp = new HTML::Mason::Interp (
479 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8 },
480 compiler => HTML::Mason::Compiler::ToObject->new(
481 default_escape_flags => 'h',
482 allow_globals => [qw(%session)],
486 ( $fs_interp, $rt_interp );
494 Lurking in the darkness...
498 L<HTML::Mason>, L<FS>, L<RT>