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;
80 #not actually using this yet anyway...# use IPC::Run3 0.036;
81 use Net::Whois::Raw qw(whois);
83 eval "use Net::Whois::Raw 0.32 qw(whois)";
87 use Spreadsheet::WriteExcel;
88 use Business::CreditCard 0.30; #for mask-aware cardtype()
91 use Net::Ping::External;
92 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
94 no warnings 'redefine';
95 eval 'sub Net::Ping::External::_ping_linux {
97 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
98 return Net::Ping::External::_ping_system($command, 0);
103 use String::Approx qw(amatch);
104 use Chart::LinesPoints;
108 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
111 use Business::US::USPS::WebTools::AddressStandardization;
113 use FS::UID qw( getotaker dbh datasrc driver_name );
114 use FS::Record qw( qsearch qsearchs fields dbdef
115 str2time_sql str2time_sql_closing
118 use FS::CGI qw(header menubar table itable ntable idiot
119 eidiot myexit http_header);
120 use FS::UI::Web qw(svc_url);
121 use FS::UI::Web::small_custview qw(small_custview);
122 use FS::UI::bytecount;
123 use FS::Msgcat qw(gettext geterror);
124 use FS::Misc qw( send_email send_fax
125 states_hash counties cities state_label
127 use FS::Misc::eps2png qw( eps2png );
128 use FS::Report::FCC_477;
129 use FS::Report::Table::Monthly;
130 use FS::TicketSystem;
131 use FS::Tron qw( tron_lint );
135 use FS::domain_record;
137 use FS::cust_bill_pay;
139 use FS::cust_credit_bill;
140 use FS::cust_main qw(smart_search);
141 use FS::cust_main::Import;
142 use FS::cust_main_county;
143 use FS::cust_location;
146 use FS::part_pkg_taxclass;
147 use FS::cust_pkg_reason;
149 use FS::cust_credit_refund;
150 use FS::cust_pay_refund;
153 use FS::part_bill_event;
155 use FS::part_event_condition;
157 use FS::part_referral;
159 use FS::part_svc_router;
160 use FS::part_virtual_field;
164 use FS::queue qw(joblisting);
168 use FS::svc_acct_pop qw(popselector);
169 use FS::acct_rt_transaction;
175 use FS::svc_broadband;
176 use FS::svc_external;
179 use FS::part_export_option;
181 use FS::export_device;
188 use FS::payment_gateway;
189 use FS::agent_payment_gateway;
194 use FS::inventory_class;
195 use FS::inventory_item;
196 use FS::pkg_category;
199 use FS::access_user_pref;
200 use FS::access_group;
201 use FS::access_usergroup;
202 use FS::access_groupagent;
203 use FS::access_right;
206 use FS::phone_device;
210 use FS::cust_main_note;
212 use FS::cust_tax_location;
213 use FS::part_pkg_taxproduct;
214 use FS::part_pkg_taxoverride;
215 use FS::part_pkg_taxrate;
217 use FS::part_pkg_report_option;
218 use FS::cust_attachment;
220 use FS::h_inventory_item;
222 use FS::h_svc_broadband;
223 use FS::h_svc_domain;
224 #use FS::h_domain_record;
225 use FS::h_svc_external;
226 use FS::h_svc_forward;
228 #use FS::h_phone_device;
230 use FS::cust_statement;
232 use FS::cust_category;
233 use FS::prospect_main;
237 use FS::cust_pkg_discount;
238 use FS::cust_bill_pkg_discount;
239 use FS::svc_mailinglist;
241 use FS::cgp_rule_condition;
242 use FS::cgp_rule_action;
244 use FS::cust_bill_batch;
247 if ( $FS::Mason::addl_handler_use ) {
248 eval $FS::Mason::addl_handler_use;
252 if ( %%%RT_ENABLED%%% ) {
254 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
255 use vars qw($Nobody $SystemUser);
258 use RT::Transactions;
263 use RT::ScripActions;
264 use RT::ScripConditions;
267 use RT::GroupMembers;
268 use RT::CustomFields;
269 use RT::CustomFieldValues;
270 use RT::ObjectCustomFieldValues;
272 #blah. manually updated from RT::Interface::Web::Handler
273 use RT::Interface::Web;
280 #blah. not even in RT::Interface::Web::Handler, just in
281 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
282 #to throw a real error instead of just a mysterious unstyled RT
283 use CSS::Squish 0.06;
285 use RT::Interface::Web::Request;
287 #slow, unreliable, segfaults and is optional
288 #see rt/html/Ticket/Elements/ShowTransactionAttachments
291 #?#use File::Path qw( rmtree );
292 #?#use File::Glob qw( bsd_glob );
293 #?#use File::Spec::Unix;
299 *CGI::redirect = sub {
302 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
303 (my $x, $cookie) = (shift, shift);
304 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
306 my $location = shift;
310 # false laziness w/below
311 if ( defined(@DBIx::Profile::ISA) ) {
313 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
318 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
320 ( UNIVERSAL::can(dbh, 'sprintProfile')
321 ? encode_entities(dbh->sprintProfile())
322 : 'DBIx::Profile missing sprintProfile method;'.
323 'unpatched or too old?' ).
324 #"\n\n". &sprintAutoProfile(). '</PRE>'.
329 dbh->{'private_profile'} = {};
334 #clear db profile, but normal redirect
335 dbh->{'private_profile'} = {};
336 $m->redirect($location);
341 } else { #normal redirect
343 $m->redirect($location);
357 $m->comp('/elements/errorpage.html', @_);
360 sub errorpage_popup {
362 $m->comp('/elements/errorpage-popup.html', @_);
366 my( $location ) = @_;
369 #false laziness w/above
370 if ( defined(@DBIx::Profile::ISA) ) {
372 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
377 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
379 ( UNIVERSAL::can(dbh, 'sprintProfile')
380 ? encode_entities(dbh->sprintProfile())
381 : 'DBIx::Profile missing sprintProfile method;'.
382 'unpatched or too old?' ).
383 #"\n\n". &sprintAutoProfile(). '</PRE>'.
388 dbh->{'private_profile'} = {};
392 #clear db profile, but normal redirect
393 dbh->{'private_profile'} = {};
394 $m->redirect($location);
398 } else { #normal redirect
400 $m->redirect($location);
406 } # end package HTML::Mason::Commands;
412 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
414 Returns a list consisting of two HTML::Mason::Interp objects, the first for
415 Freeside pages, and the second for RT pages.
417 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
419 Options and values can be passed following mode. Currently available options
422 I<outbuf> should be set to a scalar reference in standalone mode.
426 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
429 my $mode = shift || 'apache';
432 #my $request_class = 'HTML::Mason::Request'.
433 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
434 my $request_class = 'FS::Mason::Request';
436 #not entirely sure it belongs here, but what the hey
437 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
441 # A hook supporting strange legacy ways people have added stuff on
443 my @addl_comp_root = ();
444 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
445 if ( -e $addl_comp_root_file ) {
446 warn "reading $addl_comp_root_file\n";
447 my $text = slurp( $addl_comp_root_file );
448 my @addl = eval $text;
449 if ( @addl && ! $@ ) {
450 @addl_comp_root = @addl;
452 warn "error parsing $addl_comp_root_file: $@\n";
457 request_class => $request_class,
458 data_dir => '%%%MASONDATA%%%',
459 error_mode => 'output',
460 error_format => 'html',
461 ignore_warnings_expr => '.',
463 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
464 [ 'rt' =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
469 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
471 my $html_defang = new HTML::Defang (%defang_opts);
473 my $fs_interp = new HTML::Mason::Interp (
475 escape_flags => { 'js_string' => sub {
476 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
477 ${$_[0]} =~ s/(['\\])/\\$1/g;
478 ${$_[0]} =~ s/\n/\\n/g;
479 ${$_[0]} = "'". ${$_[0]}. "'";
482 ${$_[0]} = $html_defang->defang(${$_[0]});
485 compiler => HTML::Mason::Compiler::ToObject->new(
486 allow_globals => [qw(%session)],
490 my $rt_interp = new HTML::Mason::Interp (
492 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8 },
493 compiler => HTML::Mason::Compiler::ToObject->new(
494 default_escape_flags => 'h',
495 allow_globals => [qw(%session)],
499 ( $fs_interp, $rt_interp );
507 Lurking in the darkness...
511 L<HTML::Mason>, L<FS>, L<RT>