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;
106 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
109 use Business::US::USPS::WebTools::AddressStandardization;
111 use FS::UID qw( getotaker dbh datasrc driver_name );
112 use FS::Record qw( qsearch qsearchs fields dbdef
113 str2time_sql str2time_sql_closing
116 use FS::CGI qw(header menubar table itable ntable idiot
117 eidiot myexit http_header);
118 use FS::UI::Web qw(svc_url);
119 use FS::UI::Web::small_custview qw(small_custview);
120 use FS::UI::bytecount;
121 use FS::Msgcat qw(gettext geterror);
122 use FS::Misc qw( send_email send_fax
123 states_hash counties cities state_label
125 use FS::Misc::eps2png qw( eps2png );
126 use FS::Report::Table::Monthly;
127 use FS::TicketSystem;
128 use FS::Tron qw( tron_lint );
132 use FS::domain_record;
134 use FS::cust_bill_pay;
136 use FS::cust_credit_bill;
137 use FS::cust_main qw(smart_search);
138 use FS::cust_main::Import;
139 use FS::cust_main_county;
140 use FS::cust_location;
143 use FS::part_pkg_taxclass;
144 use FS::cust_pkg_reason;
146 use FS::cust_credit_refund;
147 use FS::cust_pay_refund;
150 use FS::part_bill_event;
152 use FS::part_event_condition;
154 use FS::part_referral;
156 use FS::part_svc_router;
157 use FS::part_virtual_field;
161 use FS::queue qw(joblisting);
165 use FS::svc_acct_pop qw(popselector);
166 use FS::acct_rt_transaction;
172 use FS::svc_broadband;
173 use FS::svc_external;
176 use FS::part_export_option;
178 use FS::export_device;
185 use FS::payment_gateway;
186 use FS::agent_payment_gateway;
191 use FS::inventory_class;
192 use FS::inventory_item;
193 use FS::pkg_category;
196 use FS::access_user_pref;
197 use FS::access_group;
198 use FS::access_usergroup;
199 use FS::access_groupagent;
200 use FS::access_right;
203 use FS::phone_device;
207 use FS::cust_main_note;
209 use FS::cust_tax_location;
210 use FS::part_pkg_taxproduct;
211 use FS::part_pkg_taxoverride;
212 use FS::part_pkg_taxrate;
214 use FS::part_pkg_report_option;
215 use FS::cust_attachment;
218 use FS::h_svc_broadband;
219 use FS::h_svc_domain;
220 #use FS::h_domain_record;
221 use FS::h_svc_external;
222 use FS::h_svc_forward;
224 #use FS::h_phone_device;
226 use FS::cust_statement;
228 use FS::cust_category;
229 use FS::prospect_main;
233 use FS::cust_pkg_discount;
234 use FS::cust_bill_pkg_discount;
235 use FS::svc_mailinglist;
238 if ( $FS::Mason::addl_handler_use ) {
239 eval $FS::Mason::addl_handler_use;
243 if ( %%%RT_ENABLED%%% ) {
245 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
246 use vars qw($Nobody $SystemUser);
249 use RT::Transactions;
254 use RT::ScripActions;
255 use RT::ScripConditions;
258 use RT::GroupMembers;
259 use RT::CustomFields;
260 use RT::CustomFieldValues;
261 use RT::ObjectCustomFieldValues;
263 #blah. manually updated from RT::Interface::Web::Handler
264 use RT::Interface::Web;
271 #blah. not even in RT::Interface::Web::Handler, just in
272 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
273 #to throw a real error instead of just a mysterious unstyled RT
274 use CSS::Squish 0.06;
276 use RT::Interface::Web::Request;
278 #slow, unreliable, segfaults and is optional
279 #see rt/html/Ticket/Elements/ShowTransactionAttachments
282 #?#use File::Path qw( rmtree );
283 #?#use File::Glob qw( bsd_glob );
284 #?#use File::Spec::Unix;
290 *CGI::redirect = sub {
293 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
294 (my $x, $cookie) = (shift, shift);
295 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
297 my $location = shift;
301 # false laziness w/below
302 if ( defined(@DBIx::Profile::ISA) ) {
304 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
309 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
311 ( UNIVERSAL::can(dbh, 'sprintProfile')
312 ? encode_entities(dbh->sprintProfile())
313 : 'DBIx::Profile missing sprintProfile method;'.
314 'unpatched or too old?' ).
315 #"\n\n". &sprintAutoProfile(). '</PRE>'.
320 dbh->{'private_profile'} = {};
325 #clear db profile, but normal redirect
326 dbh->{'private_profile'} = {};
327 $m->redirect($location);
332 } else { #normal redirect
334 $m->redirect($location);
348 $m->comp('/elements/errorpage.html', @_);
352 my( $location ) = @_;
355 #false laziness w/above
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'} = {};
378 #clear db profile, but normal redirect
379 dbh->{'private_profile'} = {};
380 $m->redirect($location);
384 } else { #normal redirect
386 $m->redirect($location);
392 } # end package HTML::Mason::Commands;
398 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
400 Returns a list consisting of two HTML::Mason::Interp objects, the first for
401 Freeside pages, and the second for RT pages.
403 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
405 Options and values can be passed following mode. Currently available options
408 I<outbuf> should be set to a scalar reference in standalone mode.
412 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
415 my $mode = shift || 'apache';
418 #my $request_class = 'HTML::Mason::Request'.
419 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
420 my $request_class = 'FS::Mason::Request';
422 #not entirely sure it belongs here, but what the hey
423 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
427 # A hook supporting strange legacy ways people have added stuff on
429 my @addl_comp_root = ();
430 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
431 if ( -e $addl_comp_root_file ) {
432 warn "reading $addl_comp_root_file\n";
433 my $text = slurp( $addl_comp_root_file );
434 my @addl = eval $text;
435 if ( @addl && ! $@ ) {
436 @addl_comp_root = @addl;
438 warn "error parsing $addl_comp_root_file: $@\n";
443 request_class => $request_class,
444 data_dir => '%%%MASONDATA%%%',
445 error_mode => 'output',
446 error_format => 'html',
447 ignore_warnings_expr => '.',
449 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
450 [ 'rt' =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
455 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
457 my $html_defang = new HTML::Defang (%defang_opts);
459 my $fs_interp = new HTML::Mason::Interp (
461 escape_flags => { 'js_string' => sub {
462 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
463 ${$_[0]} =~ s/(['\\])/\\$1/g;
464 ${$_[0]} =~ s/\n/\\n/g;
465 ${$_[0]} = "'". ${$_[0]}. "'";
468 ${$_[0]} = $html_defang->defang(${$_[0]});
471 compiler => HTML::Mason::Compiler::ToObject->new(
472 allow_globals => [qw(%session)],
476 my $rt_interp = new HTML::Mason::Interp (
478 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8 },
479 compiler => HTML::Mason::Compiler::ToObject->new(
480 default_escape_flags => 'h',
481 allow_globals => [qw(%session)],
485 ( $fs_interp, $rt_interp );
493 Lurking in the darkness...
497 L<HTML::Mason>, L<FS>, L<RT>