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);
67 Lingua::EN::Inflect::classical names=>0; #Categorys
72 use HTML::TreeBuilder;
76 # use XMLRPC::Transport::HTTP;
77 # use XMLRPC::Lite; # for XMLRPC::Serializer
82 #not actually using this yet anyway...# use IPC::Run3 0.036;
83 use Net::Whois::Raw qw(whois);
85 eval "use Net::Whois::Raw 0.32 qw(whois)";
89 use Spreadsheet::WriteExcel;
90 use Business::CreditCard 0.30; #for mask-aware cardtype()
93 use Net::Ping::External;
94 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
96 no warnings 'redefine';
97 eval 'sub Net::Ping::External::_ping_linux {
99 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
100 return Net::Ping::External::_ping_system($command, 0);
105 use String::Approx qw(amatch);
106 use Chart::LinesPoints;
110 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
113 use Business::US::USPS::WebTools::AddressStandardization;
116 use FS::UID qw( getotaker dbh datasrc driver_name );
117 use FS::Record qw( qsearch qsearchs fields dbdef
118 str2time_sql str2time_sql_closing
121 use FS::CGI qw(header menubar table itable ntable idiot
122 eidiot myexit http_header);
123 use FS::UI::Web qw(svc_url);
124 use FS::UI::Web::small_custview qw(small_custview);
125 use FS::UI::bytecount;
126 use FS::Msgcat qw(gettext geterror);
127 use FS::Misc qw( send_email send_fax
128 states_hash counties cities state_label
130 use FS::Misc::eps2png qw( eps2png );
131 use FS::Report::FCC_477;
132 use FS::Report::Table::Monthly;
133 use FS::TicketSystem;
134 use FS::Tron qw( tron_lint );
138 use FS::domain_record;
140 use FS::cust_bill_pay;
142 use FS::cust_credit_bill;
143 use FS::cust_main qw(smart_search);
144 use FS::cust_main::Import;
145 use FS::cust_main_county;
146 use FS::cust_location;
149 use FS::part_pkg_taxclass;
150 use FS::cust_pkg_reason;
152 use FS::cust_credit_refund;
153 use FS::cust_pay_refund;
156 use FS::part_bill_event;
158 use FS::part_event_condition;
160 use FS::part_referral;
162 use FS::part_svc_router;
163 use FS::part_virtual_field;
167 use FS::queue qw(joblisting);
171 use FS::svc_acct_pop qw(popselector);
172 use FS::acct_rt_transaction;
178 use FS::svc_broadband;
179 use FS::svc_external;
182 use FS::part_export_option;
184 use FS::export_device;
191 use FS::payment_gateway;
192 use FS::agent_payment_gateway;
197 use FS::inventory_class;
198 use FS::inventory_item;
199 use FS::pkg_category;
202 use FS::access_user_pref;
203 use FS::access_group;
204 use FS::access_usergroup;
205 use FS::access_groupagent;
206 use FS::access_right;
209 use FS::phone_device;
213 use FS::cust_main_note;
215 use FS::cust_tax_location;
216 use FS::part_pkg_taxproduct;
217 use FS::part_pkg_taxoverride;
218 use FS::part_pkg_taxrate;
220 use FS::part_pkg_report_option;
221 use FS::cust_attachment;
223 use FS::h_inventory_item;
225 use FS::h_svc_broadband;
226 use FS::h_svc_domain;
227 #use FS::h_domain_record;
228 use FS::h_svc_external;
229 use FS::h_svc_forward;
231 #use FS::h_phone_device;
233 use FS::cust_statement;
235 use FS::cust_category;
236 use FS::prospect_main;
240 use FS::cust_pkg_discount;
241 use FS::cust_bill_pkg_discount;
242 use FS::svc_mailinglist;
244 use FS::cgp_rule_condition;
245 use FS::cgp_rule_action;
247 use FS::cust_bill_batch;
249 use FS::rate_time_interval;
250 use FS::msg_template;
254 if ( $FS::Mason::addl_handler_use ) {
255 eval $FS::Mason::addl_handler_use;
259 if ( %%%RT_ENABLED%%% ) {
261 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
262 use vars qw($Nobody $SystemUser);
266 use RT::Transactions;
271 use RT::ScripActions;
272 use RT::ScripConditions;
275 use RT::GroupMembers;
276 use RT::CustomFields;
277 use RT::CustomFieldValues;
278 use RT::ObjectCustomFieldValues;
280 #blah. manually updated from RT::Interface::Web::Handler
281 use RT::Interface::Web;
288 #blah. not even in RT::Interface::Web::Handler, just in
289 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
290 #to throw a real error instead of just a mysterious unstyled RT
291 use CSS::Squish 0.06;
293 use RT::Interface::Web::Request;
295 #nother undeclared web UI dep (for ticket links graph)
296 use IPC::Run::SafeHandles;
298 #slow, unreliable, segfaults and is optional
299 #see rt/html/Ticket/Elements/ShowTransactionAttachments
302 #?#use File::Path qw( rmtree );
303 #?#use File::Glob qw( bsd_glob );
304 #?#use File::Spec::Unix;
310 *CGI::redirect = sub {
313 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
314 (my $x, $cookie) = (shift, shift);
315 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
317 my $location = shift;
321 # false laziness w/below
322 if ( defined(@DBIx::Profile::ISA) ) {
324 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
329 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
331 ( UNIVERSAL::can(dbh, 'sprintProfile')
332 ? encode_entities(dbh->sprintProfile())
333 : 'DBIx::Profile missing sprintProfile method;'.
334 'unpatched or too old?' ).
335 #"\n\n". &sprintAutoProfile(). '</PRE>'.
340 dbh->{'private_profile'} = {};
345 #clear db profile, but normal redirect
346 dbh->{'private_profile'} = {};
347 $m->redirect($location);
352 } else { #normal redirect
354 $m->redirect($location);
368 $m->comp('/elements/errorpage.html', @_);
371 sub errorpage_popup {
373 $m->comp('/elements/errorpage-popup.html', @_);
377 my( $location ) = @_;
380 #false laziness w/above
381 if ( defined(@DBIx::Profile::ISA) ) {
383 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
388 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
390 ( UNIVERSAL::can(dbh, 'sprintProfile')
391 ? encode_entities(dbh->sprintProfile())
392 : 'DBIx::Profile missing sprintProfile method;'.
393 'unpatched or too old?' ).
394 #"\n\n". &sprintAutoProfile(). '</PRE>'.
399 dbh->{'private_profile'} = {};
403 #clear db profile, but normal redirect
404 dbh->{'private_profile'} = {};
405 $m->redirect($location);
409 } else { #normal redirect
411 $m->redirect($location);
417 } # end package HTML::Mason::Commands;
423 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
425 Returns a list consisting of two HTML::Mason::Interp objects, the first for
426 Freeside pages, and the second for RT pages.
428 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
430 Options and values can be passed following mode. Currently available options
433 I<outbuf> should be set to a scalar reference in standalone mode.
437 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
440 my $mode = shift || 'apache';
443 #my $request_class = 'HTML::Mason::Request'.
444 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
445 my $request_class = 'FS::Mason::Request';
447 #not entirely sure it belongs here, but what the hey
448 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
452 # A hook supporting strange legacy ways people have added stuff on
454 my @addl_comp_root = ();
455 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
456 if ( -e $addl_comp_root_file ) {
457 warn "reading $addl_comp_root_file\n";
458 my $text = slurp( $addl_comp_root_file );
459 my @addl = eval $text;
460 if ( @addl && ! $@ ) {
461 @addl_comp_root = @addl;
463 warn "error parsing $addl_comp_root_file: $@\n";
468 request_class => $request_class,
469 data_dir => '%%%MASONDATA%%%',
470 error_mode => 'output',
471 error_format => 'html',
472 ignore_warnings_expr => '.',
474 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
475 [ 'rt' =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
480 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
482 my $html_defang = new HTML::Defang (%defang_opts);
484 my $js_string_sub = sub {
485 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
486 ${$_[0]} =~ s/(['\\])/\\$1/g;
487 ${$_[0]} =~ s/\r/\\r/g;
488 ${$_[0]} =~ s/\n/\\n/g;
489 ${$_[0]} = "'". ${$_[0]}. "'";
492 my $fs_interp = new HTML::Mason::Interp (
494 escape_flags => { 'js_string' => $js_string_sub,
496 ${$_[0]} = $html_defang->defang(${$_[0]});
499 compiler => HTML::Mason::Compiler::ToObject->new(
500 allow_globals => [qw(%session)],
504 my $rt_interp = new HTML::Mason::Interp (
506 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
507 'js_string' => $js_string_sub,
509 compiler => HTML::Mason::Compiler::ToObject->new(
510 default_escape_flags => 'h',
511 allow_globals => [qw(%session)],
515 ( $fs_interp, $rt_interp );
523 Lurking in the darkness...
527 L<HTML::Mason>, L<FS>, L<RT>