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 );
64 use DateTime::Format::Strptime;
65 use FS::Misc::DateTime qw( parse_datetime );
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;
238 use FS::cgp_rule_condition;
239 use FS::cgp_rule_action;
242 if ( $FS::Mason::addl_handler_use ) {
243 eval $FS::Mason::addl_handler_use;
247 if ( %%%RT_ENABLED%%% ) {
249 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
250 use vars qw($Nobody $SystemUser);
253 use RT::Transactions;
258 use RT::ScripActions;
259 use RT::ScripConditions;
262 use RT::GroupMembers;
263 use RT::CustomFields;
264 use RT::CustomFieldValues;
265 use RT::ObjectCustomFieldValues;
267 #blah. manually updated from RT::Interface::Web::Handler
268 use RT::Interface::Web;
275 #blah. not even in RT::Interface::Web::Handler, just in
276 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
277 #to throw a real error instead of just a mysterious unstyled RT
278 use CSS::Squish 0.06;
280 use RT::Interface::Web::Request;
282 #slow, unreliable, segfaults and is optional
283 #see rt/html/Ticket/Elements/ShowTransactionAttachments
286 #?#use File::Path qw( rmtree );
287 #?#use File::Glob qw( bsd_glob );
288 #?#use File::Spec::Unix;
294 *CGI::redirect = sub {
297 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
298 (my $x, $cookie) = (shift, shift);
299 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
301 my $location = shift;
305 # false laziness w/below
306 if ( defined(@DBIx::Profile::ISA) ) {
308 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
313 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
315 ( UNIVERSAL::can(dbh, 'sprintProfile')
316 ? encode_entities(dbh->sprintProfile())
317 : 'DBIx::Profile missing sprintProfile method;'.
318 'unpatched or too old?' ).
319 #"\n\n". &sprintAutoProfile(). '</PRE>'.
324 dbh->{'private_profile'} = {};
329 #clear db profile, but normal redirect
330 dbh->{'private_profile'} = {};
331 $m->redirect($location);
336 } else { #normal redirect
338 $m->redirect($location);
352 $m->comp('/elements/errorpage.html', @_);
356 my( $location ) = @_;
359 #false laziness w/above
360 if ( defined(@DBIx::Profile::ISA) ) {
362 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
367 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
369 ( UNIVERSAL::can(dbh, 'sprintProfile')
370 ? encode_entities(dbh->sprintProfile())
371 : 'DBIx::Profile missing sprintProfile method;'.
372 'unpatched or too old?' ).
373 #"\n\n". &sprintAutoProfile(). '</PRE>'.
378 dbh->{'private_profile'} = {};
382 #clear db profile, but normal redirect
383 dbh->{'private_profile'} = {};
384 $m->redirect($location);
388 } else { #normal redirect
390 $m->redirect($location);
396 } # end package HTML::Mason::Commands;
402 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
404 Returns a list consisting of two HTML::Mason::Interp objects, the first for
405 Freeside pages, and the second for RT pages.
407 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
409 Options and values can be passed following mode. Currently available options
412 I<outbuf> should be set to a scalar reference in standalone mode.
416 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
419 my $mode = shift || 'apache';
422 #my $request_class = 'HTML::Mason::Request'.
423 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
424 my $request_class = 'FS::Mason::Request';
426 #not entirely sure it belongs here, but what the hey
427 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
431 # A hook supporting strange legacy ways people have added stuff on
433 my @addl_comp_root = ();
434 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
435 if ( -e $addl_comp_root_file ) {
436 warn "reading $addl_comp_root_file\n";
437 my $text = slurp( $addl_comp_root_file );
438 my @addl = eval $text;
439 if ( @addl && ! $@ ) {
440 @addl_comp_root = @addl;
442 warn "error parsing $addl_comp_root_file: $@\n";
447 request_class => $request_class,
448 data_dir => '%%%MASONDATA%%%',
449 error_mode => 'output',
450 error_format => 'html',
451 ignore_warnings_expr => '.',
453 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
454 [ 'rt' =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
459 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
461 my $html_defang = new HTML::Defang (%defang_opts);
463 my $fs_interp = new HTML::Mason::Interp (
465 escape_flags => { 'js_string' => sub {
466 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
467 ${$_[0]} =~ s/(['\\])/\\$1/g;
468 ${$_[0]} =~ s/\n/\\n/g;
469 ${$_[0]} = "'". ${$_[0]}. "'";
472 ${$_[0]} = $html_defang->defang(${$_[0]});
475 compiler => HTML::Mason::Compiler::ToObject->new(
476 allow_globals => [qw(%session)],
480 my $rt_interp = new HTML::Mason::Interp (
482 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8 },
483 compiler => HTML::Mason::Compiler::ToObject->new(
484 default_escape_flags => 'h',
485 allow_globals => [qw(%session)],
489 ( $fs_interp, $rt_interp );
497 Lurking in the darkness...
501 L<HTML::Mason>, L<FS>, L<RT>