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;
117 use FS::UID qw( getotaker dbh datasrc driver_name );
118 use FS::Record qw( qsearch qsearchs fields dbdef
119 str2time_sql str2time_sql_closing
122 use FS::CGI qw(header menubar table itable ntable idiot
123 eidiot myexit http_header);
124 use FS::UI::Web qw(svc_url);
125 use FS::UI::Web::small_custview qw(small_custview);
126 use FS::UI::bytecount;
127 use FS::Msgcat qw(gettext geterror);
128 use FS::Misc qw( send_email send_fax
129 states_hash counties cities state_label
131 use FS::Misc::eps2png qw( eps2png );
132 use FS::Report::FCC_477;
133 use FS::Report::Table::Monthly;
134 use FS::TicketSystem;
135 use FS::Tron qw( tron_lint );
139 use FS::domain_record;
141 use FS::cust_bill_pay;
143 use FS::cust_credit_bill;
144 use FS::cust_main qw(smart_search);
145 use FS::cust_main::Import;
146 use FS::cust_main_county;
147 use FS::cust_location;
150 use FS::cust_pkg::Import;
151 use FS::part_pkg_taxclass;
152 use FS::cust_pkg_reason;
154 use FS::cust_credit_refund;
155 use FS::cust_pay_refund;
158 use FS::part_bill_event;
160 use FS::part_event_condition;
162 use FS::part_referral;
164 use FS::part_svc_router;
165 use FS::part_virtual_field;
169 use FS::queue qw(joblisting);
173 use FS::svc_acct_pop qw(popselector);
174 use FS::acct_rt_transaction;
180 use FS::svc_broadband;
181 use FS::svc_external;
184 use FS::part_export_option;
186 use FS::export_device;
193 use FS::payment_gateway;
194 use FS::agent_payment_gateway;
199 use FS::inventory_class;
200 use FS::inventory_item;
201 use FS::pkg_category;
204 use FS::access_user_pref;
205 use FS::access_group;
206 use FS::access_usergroup;
207 use FS::access_groupagent;
208 use FS::access_right;
211 use FS::phone_device;
215 use FS::cust_main_note;
217 use FS::cust_tax_location;
218 use FS::part_pkg_taxproduct;
219 use FS::part_pkg_taxoverride;
220 use FS::part_pkg_taxrate;
222 use FS::part_pkg_report_option;
223 use FS::cust_attachment;
225 use FS::h_inventory_item;
227 use FS::h_svc_broadband;
228 use FS::h_svc_domain;
229 #use FS::h_domain_record;
230 use FS::h_svc_external;
231 use FS::h_svc_forward;
233 #use FS::h_phone_device;
235 use FS::cust_statement;
237 use FS::cust_category;
238 use FS::prospect_main;
242 use FS::cust_pkg_discount;
243 use FS::cust_bill_pkg_discount;
244 use FS::svc_mailinglist;
246 use FS::cgp_rule_condition;
247 use FS::cgp_rule_action;
249 use FS::cust_bill_batch;
251 use FS::rate_time_interval;
252 use FS::msg_template;
257 if ( $FS::Mason::addl_handler_use ) {
258 eval $FS::Mason::addl_handler_use;
262 if ( %%%RT_ENABLED%%% ) {
264 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
265 use vars qw($Nobody $SystemUser);
269 use RT::Transactions;
274 use RT::ScripActions;
275 use RT::ScripConditions;
278 use RT::GroupMembers;
279 use RT::CustomFields;
280 use RT::CustomFieldValues;
281 use RT::ObjectCustomFieldValues;
283 #blah. manually updated from RT::Interface::Web::Handler
284 use RT::Interface::Web;
291 #blah. not even in RT::Interface::Web::Handler, just in
292 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
293 #to throw a real error instead of just a mysterious unstyled RT
294 use CSS::Squish 0.06;
296 use RT::Interface::Web::Request;
298 #nother undeclared web UI dep (for ticket links graph)
299 use IPC::Run::SafeHandles;
301 #slow, unreliable, segfaults and is optional
302 #see rt/html/Ticket/Elements/ShowTransactionAttachments
305 #?#use File::Path qw( rmtree );
306 #?#use File::Glob qw( bsd_glob );
307 #?#use File::Spec::Unix;
313 *CGI::redirect = sub {
316 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
317 (my $x, $cookie) = (shift, shift);
318 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
320 my $location = shift;
324 # false laziness w/below
325 if ( defined(@DBIx::Profile::ISA) ) {
327 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
332 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
334 ( UNIVERSAL::can(dbh, 'sprintProfile')
335 ? encode_entities(dbh->sprintProfile())
336 : 'DBIx::Profile missing sprintProfile method;'.
337 'unpatched or too old?' ).
338 #"\n\n". &sprintAutoProfile(). '</PRE>'.
343 dbh->{'private_profile'} = {};
348 #clear db profile, but normal redirect
349 dbh->{'private_profile'} = {};
350 $m->redirect($location);
355 } else { #normal redirect
357 $m->redirect($location);
366 #carp #should just switch to <& &> syntax
372 $m->comp('/elements/errorpage.html', @_);
375 sub errorpage_popup {
377 $m->comp('/elements/errorpage-popup.html', @_);
381 my( $location ) = @_;
384 #false laziness w/above
385 if ( defined(@DBIx::Profile::ISA) ) {
387 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
392 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
394 ( UNIVERSAL::can(dbh, 'sprintProfile')
395 ? encode_entities(dbh->sprintProfile())
396 : 'DBIx::Profile missing sprintProfile method;'.
397 'unpatched or too old?' ).
398 #"\n\n". &sprintAutoProfile(). '</PRE>'.
403 dbh->{'private_profile'} = {};
407 #clear db profile, but normal redirect
408 dbh->{'private_profile'} = {};
409 $m->redirect($location);
413 } else { #normal redirect
415 $m->redirect($location);
421 } # end package HTML::Mason::Commands;
427 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
429 Returns a list consisting of two HTML::Mason::Interp objects, the first for
430 Freeside pages, and the second for RT pages.
432 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
434 Options and values can be passed following mode. Currently available options
437 I<outbuf> should be set to a scalar reference in standalone mode.
441 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
444 my $mode = shift || 'apache';
447 #my $request_class = 'HTML::Mason::Request'.
448 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
449 my $request_class = 'FS::Mason::Request';
451 #not entirely sure it belongs here, but what the hey
452 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
456 # A hook supporting strange legacy ways people (well, SG) have added stuff on
458 my @addl_comp_root = ();
459 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
460 if ( -e $addl_comp_root_file ) {
461 warn "reading $addl_comp_root_file\n";
462 my $text = slurp( $addl_comp_root_file );
463 my @addl = eval $text;
464 if ( @addl && ! $@ ) {
465 @addl_comp_root = @addl;
467 warn "error parsing $addl_comp_root_file: $@\n";
472 scalar(@addl_comp_root)
474 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
477 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
480 request_class => $request_class,
481 data_dir => '%%%MASONDATA%%%',
482 error_mode => 'output',
483 error_format => 'html',
484 ignore_warnings_expr => '.',
487 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
489 my $html_defang = new HTML::Defang (%defang_opts);
491 my $js_string_sub = sub {
492 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
493 ${$_[0]} =~ s/(['\\])/\\$1/g;
494 ${$_[0]} =~ s/\r/\\r/g;
495 ${$_[0]} =~ s/\n/\\n/g;
496 ${$_[0]} = "'". ${$_[0]}. "'";
499 my $fs_interp = new HTML::Mason::Interp (
501 comp_root => $fs_comp_root,
502 escape_flags => { 'js_string' => $js_string_sub,
504 ${$_[0]} = $html_defang->defang(${$_[0]});
507 compiler => HTML::Mason::Compiler::ToObject->new(
508 allow_globals => [qw(%session)],
512 my $rt_interp = new HTML::Mason::Interp (
515 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
516 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
518 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
519 'js_string' => $js_string_sub,
521 compiler => HTML::Mason::Compiler::ToObject->new(
522 default_escape_flags => 'h',
523 allow_globals => [qw(%session)],
527 ( $fs_interp, $rt_interp );
535 Lurking in the darkness...
539 L<HTML::Mason>, L<FS>, L<RT>