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;
234 use FS::svc_mailinglist;
237 if ( $FS::Mason::addl_handler_use ) {
238 eval $FS::Mason::addl_handler_use;
242 if ( %%%RT_ENABLED%%% ) {
244 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
245 use vars qw($Nobody $SystemUser);
248 use RT::Transactions;
253 use RT::ScripActions;
254 use RT::ScripConditions;
257 use RT::GroupMembers;
258 use RT::CustomFields;
259 use RT::CustomFieldValues;
260 use RT::ObjectCustomFieldValues;
262 #blah. manually updated from RT::Interface::Web::Handler
263 use RT::Interface::Web;
270 #blah. not even in RT::Interface::Web::Handler, just in
271 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
272 #to throw a real error instead of just a mysterious unstyled RT
273 use CSS::Squish 0.06;
275 use RT::Interface::Web::Request;
277 #slow, unreliable, segfaults and is optional
278 #see rt/html/Ticket/Elements/ShowTransactionAttachments
281 #?#use File::Path qw( rmtree );
282 #?#use File::Glob qw( bsd_glob );
283 #?#use File::Spec::Unix;
289 *CGI::redirect = sub {
292 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
293 (my $x, $cookie) = (shift, shift);
294 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
296 my $location = shift;
300 # false laziness w/below
301 if ( defined(@DBIx::Profile::ISA) ) {
303 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
308 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
310 ( UNIVERSAL::can(dbh, 'sprintProfile')
311 ? encode_entities(dbh->sprintProfile())
312 : 'DBIx::Profile missing sprintProfile method;'.
313 'unpatched or too old?' ).
314 #"\n\n". &sprintAutoProfile(). '</PRE>'.
319 dbh->{'private_profile'} = {};
324 #clear db profile, but normal redirect
325 dbh->{'private_profile'} = {};
326 $m->redirect($location);
331 } else { #normal redirect
333 $m->redirect($location);
347 $m->comp('/elements/errorpage.html', @_);
351 my( $location ) = @_;
354 #false laziness w/above
355 if ( defined(@DBIx::Profile::ISA) ) {
357 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
362 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
364 ( UNIVERSAL::can(dbh, 'sprintProfile')
365 ? encode_entities(dbh->sprintProfile())
366 : 'DBIx::Profile missing sprintProfile method;'.
367 'unpatched or too old?' ).
368 #"\n\n". &sprintAutoProfile(). '</PRE>'.
373 dbh->{'private_profile'} = {};
377 #clear db profile, but normal redirect
378 dbh->{'private_profile'} = {};
379 $m->redirect($location);
383 } else { #normal redirect
385 $m->redirect($location);
391 } # end package HTML::Mason::Commands;
397 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
399 Returns a list consisting of two HTML::Mason::Interp objects, the first for
400 Freeside pages, and the second for RT pages.
402 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
404 Options and values can be passed following mode. Currently available options
407 I<outbuf> should be set to a scalar reference in standalone mode.
412 my $mode = shift || 'apache';
415 #my $request_class = 'HTML::Mason::Request'.
416 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
417 my $request_class = 'FS::Mason::Request';
419 #not entirely sure it belongs here, but what the hey
420 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
424 # A hook supporting strange legacy ways people have added stuff on
426 my @addl_comp_root = ();
427 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
428 if ( -e $addl_comp_root_file ) {
429 warn "reading $addl_comp_root_file\n";
430 my $text = slurp( $addl_comp_root_file );
431 my @addl = eval $text;
432 if ( @addl && ! $@ ) {
433 @addl_comp_root = @addl;
435 warn "error parsing $addl_comp_root_file: $@\n";
440 request_class => $request_class,
441 data_dir => '%%%MASONDATA%%%',
442 error_mode => 'output',
443 error_format => 'html',
444 ignore_warnings_expr => '.',
446 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
447 [ 'rt' =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
452 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
454 my $fs_interp = new HTML::Mason::Interp (
456 escape_flags => { 'js_string' => sub {
457 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
458 ${$_[0]} =~ s/(['\\])/\\$1/g;
459 ${$_[0]} =~ s/\n/\\n/g;
460 ${$_[0]} = "'". ${$_[0]}. "'";
463 compiler => HTML::Mason::Compiler::ToObject->new(
464 allow_globals => [qw(%session)],
468 my $rt_interp = new HTML::Mason::Interp (
470 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8 },
471 compiler => HTML::Mason::Compiler::ToObject->new(
472 default_escape_flags => 'h',
473 allow_globals => [qw(%session)],
477 ( $fs_interp, $rt_interp );
485 Lurking in the darkness...
489 L<HTML::Mason>, L<FS>, L<RT>