4 use vars qw( @ISA @EXPORT_OK $addl_handler_use );
7 use File::Slurp qw( slurp );
8 use HTML::Mason 1.27; #http://www.masonhq.com/?ApacheModPerl2Redirect
9 use HTML::Mason::Interp;
10 use HTML::Mason::Compiler::ToObject;
12 @ISA = qw( Exporter );
13 @EXPORT_OK = qw( mason_interps );
17 FS::Mason - Initialize the Mason environment
21 use FS::Mason qw( mason_interps );
23 my( $fs_interp, $rt_interp ) = mason_interps('apache');
27 my( $fs_interp, $rt_interp ) = mason_interps('standalone'); #XXX name?
31 Initializes the Mason environment, loads all Freeside and RT libraries, etc.
35 $addl_handler_use = '';
36 my $addl_handler_use_file = '%%%FREESIDE_CONF%%%/addl_handler_use.pl';
37 if ( -e $addl_handler_use_file ) {
38 $addl_handler_use = slurp( $addl_handler_use_file );
41 # List of modules that you want to use from components (see Admin
44 package HTML::Mason::Commands;
47 use vars qw( %session );
48 use CGI 3.29 qw(-private_tempfiles); #3.29 to fix RT attachment problems
50 #breaks quick payment entry
51 #http://rt.cpan.org/Public/Bug/Display.html?id=37365
52 die "CGI.pm v3.38 is broken, use any other version >= 3.29".
53 " (Debian 5.0? aptitude remove libcgi-pm-perl)"
54 if $CGI::VERSION == 3.38;
56 #use CGI::Carp qw(fatalsToBrowser);
58 use List::Util qw( max min );
65 use DateTime::Format::Strptime;
66 use FS::Misc::DateTime qw( parse_datetime );
67 use Lingua::EN::Inflect qw(PL);
68 Lingua::EN::Inflect::classical names=>0; #Categorys
73 use HTML::TreeBuilder;
77 # use XMLRPC::Transport::HTTP;
78 # use XMLRPC::Lite; # for XMLRPC::Serializer
83 #not actually using this yet anyway...# use IPC::Run3 0.036;
84 use Net::Whois::Raw qw(whois);
86 eval "use Net::Whois::Raw 0.32 qw(whois)";
90 use Spreadsheet::WriteExcel;
91 use Business::CreditCard 0.30; #for mask-aware cardtype()
94 use Net::Ping::External;
95 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
97 no warnings 'redefine';
98 eval 'sub Net::Ping::External::_ping_linux {
100 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
101 return Net::Ping::External::_ping_system($command, 0);
106 use String::Approx qw(amatch);
107 use Chart::LinesPoints;
111 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
114 use Business::US::USPS::WebTools::AddressStandardization;
116 use Storable qw( nfreeze thaw );
118 use FS::UID qw( getotaker dbh datasrc driver_name );
119 use FS::Record qw( qsearch qsearchs fields dbdef
120 str2time_sql str2time_sql_closing
123 use FS::CGI qw(header menubar table itable ntable idiot
124 eidiot myexit http_header);
125 use FS::UI::Web qw(svc_url);
126 use FS::UI::Web::small_custview qw(small_custview);
127 use FS::UI::bytecount;
128 use FS::Msgcat qw(gettext geterror);
129 use FS::Misc qw( send_email send_fax
130 states_hash counties cities state_label
132 use FS::Misc::eps2png qw( eps2png );
133 use FS::Report::FCC_477;
134 use FS::Report::Table::Monthly;
135 use FS::TicketSystem;
136 use FS::Tron qw( tron_lint );
140 use FS::domain_record;
142 use FS::cust_bill_pay;
144 use FS::cust_credit_bill;
145 use FS::cust_main qw(smart_search);
146 use FS::cust_main::Import;
147 use FS::cust_main_county;
148 use FS::cust_location;
151 use FS::cust_pkg::Import;
152 use FS::part_pkg_taxclass;
153 use FS::cust_pkg_reason;
155 use FS::cust_credit_refund;
156 use FS::cust_pay_refund;
159 use FS::part_bill_event;
161 use FS::part_event_condition;
163 use FS::part_referral;
165 use FS::part_svc_router;
166 use FS::part_virtual_field;
170 use FS::queue qw(joblisting);
174 use FS::svc_acct_pop qw(popselector);
175 use FS::acct_rt_transaction;
181 use FS::svc_broadband;
182 use FS::svc_external;
185 use FS::part_export_option;
187 use FS::export_device;
194 use FS::payment_gateway;
195 use FS::agent_payment_gateway;
200 use FS::inventory_class;
201 use FS::inventory_item;
202 use FS::pkg_category;
205 use FS::access_user_pref;
206 use FS::access_group;
207 use FS::access_usergroup;
208 use FS::access_groupagent;
209 use FS::access_right;
212 use FS::phone_device;
216 use FS::cust_main_note;
218 use FS::cust_tax_location;
219 use FS::part_pkg_taxproduct;
220 use FS::part_pkg_taxoverride;
221 use FS::part_pkg_taxrate;
223 use FS::part_pkg_report_option;
224 use FS::cust_attachment;
226 use FS::h_inventory_item;
228 use FS::h_svc_broadband;
229 use FS::h_svc_domain;
230 #use FS::h_domain_record;
231 use FS::h_svc_external;
232 use FS::h_svc_forward;
234 #use FS::h_phone_device;
236 use FS::cust_statement;
238 use FS::cust_category;
239 use FS::prospect_main;
243 use FS::cust_pkg_discount;
244 use FS::cust_bill_pkg_discount;
245 use FS::svc_mailinglist;
247 use FS::cgp_rule_condition;
248 use FS::cgp_rule_action;
250 use FS::cust_bill_batch;
252 use FS::rate_time_interval;
253 use FS::msg_template;
258 if ( $FS::Mason::addl_handler_use ) {
259 eval $FS::Mason::addl_handler_use;
263 if ( %%%RT_ENABLED%%% ) {
265 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
266 use vars qw($Nobody $SystemUser);
270 use RT::Transactions;
275 use RT::ScripActions;
276 use RT::ScripConditions;
279 use RT::GroupMembers;
280 use RT::CustomFields;
281 use RT::CustomFieldValues;
282 use RT::ObjectCustomFieldValues;
284 #blah. manually updated from RT::Interface::Web::Handler
285 use RT::Interface::Web;
292 #blah. not even in RT::Interface::Web::Handler, just in
293 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
294 #to throw a real error instead of just a mysterious unstyled RT
295 use CSS::Squish 0.06;
297 use RT::Interface::Web::Request;
299 #nother undeclared web UI dep (for ticket links graph)
300 use IPC::Run::SafeHandles;
302 #slow, unreliable, segfaults and is optional
303 #see rt/html/Ticket/Elements/ShowTransactionAttachments
306 #?#use File::Path qw( rmtree );
307 #?#use File::Glob qw( bsd_glob );
308 #?#use File::Spec::Unix;
314 *CGI::redirect = sub {
317 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
318 (my $x, $cookie) = (shift, shift);
319 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
321 my $location = shift;
325 # false laziness w/below
326 if ( defined(@DBIx::Profile::ISA) ) {
328 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
333 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
335 ( UNIVERSAL::can(dbh, 'sprintProfile')
336 ? encode_entities(dbh->sprintProfile())
337 : 'DBIx::Profile missing sprintProfile method;'.
338 'unpatched or too old?' ).
339 #"\n\n". &sprintAutoProfile(). '</PRE>'.
344 dbh->{'private_profile'} = {};
349 #clear db profile, but normal redirect
350 dbh->{'private_profile'} = {};
351 $m->redirect($location);
356 } else { #normal redirect
358 $m->redirect($location);
367 #carp #should just switch to <& &> syntax
373 $m->comp('/elements/errorpage.html', @_);
376 sub errorpage_popup {
378 $m->comp('/elements/errorpage-popup.html', @_);
382 my( $location ) = @_;
385 #false laziness w/above
386 if ( defined(@DBIx::Profile::ISA) ) {
388 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
393 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
395 ( UNIVERSAL::can(dbh, 'sprintProfile')
396 ? encode_entities(dbh->sprintProfile())
397 : 'DBIx::Profile missing sprintProfile method;'.
398 'unpatched or too old?' ).
399 #"\n\n". &sprintAutoProfile(). '</PRE>'.
404 dbh->{'private_profile'} = {};
408 #clear db profile, but normal redirect
409 dbh->{'private_profile'} = {};
410 $m->redirect($location);
414 } else { #normal redirect
416 $m->redirect($location);
422 } # end package HTML::Mason::Commands;
428 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
430 Returns a list consisting of two HTML::Mason::Interp objects, the first for
431 Freeside pages, and the second for RT pages.
433 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
435 Options and values can be passed following mode. Currently available options
438 I<outbuf> should be set to a scalar reference in standalone mode.
442 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
445 my $mode = shift || 'apache';
448 #my $request_class = 'HTML::Mason::Request'.
449 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
450 my $request_class = 'FS::Mason::Request';
452 #not entirely sure it belongs here, but what the hey
453 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
457 # A hook supporting strange legacy ways people (well, SG) have added stuff on
459 my @addl_comp_root = ();
460 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
461 if ( -e $addl_comp_root_file ) {
462 warn "reading $addl_comp_root_file\n";
463 my $text = slurp( $addl_comp_root_file );
464 my @addl = eval $text;
465 if ( @addl && ! $@ ) {
466 @addl_comp_root = @addl;
468 warn "error parsing $addl_comp_root_file: $@\n";
473 scalar(@addl_comp_root)
475 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
478 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
481 request_class => $request_class,
482 data_dir => '%%%MASONDATA%%%',
483 error_mode => 'output',
484 error_format => 'html',
485 ignore_warnings_expr => '.',
488 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
490 my $html_defang = new HTML::Defang (%defang_opts);
492 my $js_string_sub = sub {
493 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
494 ${$_[0]} =~ s/(['\\])/\\$1/g;
495 ${$_[0]} =~ s/\r/\\r/g;
496 ${$_[0]} =~ s/\n/\\n/g;
497 ${$_[0]} = "'". ${$_[0]}. "'";
500 my $fs_interp = new HTML::Mason::Interp (
502 comp_root => $fs_comp_root,
503 escape_flags => { 'js_string' => $js_string_sub,
505 ${$_[0]} = $html_defang->defang(${$_[0]});
508 compiler => HTML::Mason::Compiler::ToObject->new(
509 allow_globals => [qw(%session)],
513 my $rt_interp = new HTML::Mason::Interp (
516 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
517 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
519 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
520 'js_string' => $js_string_sub,
522 compiler => HTML::Mason::Compiler::ToObject->new(
523 default_escape_flags => 'h',
524 allow_globals => [qw(%session)],
528 ( $fs_interp, $rt_interp );
536 Lurking in the darkness...
540 L<HTML::Mason>, L<FS>, L<RT>