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;
115 use FS::UID qw( getotaker dbh datasrc driver_name );
116 use FS::Record qw( qsearch qsearchs fields dbdef
117 str2time_sql str2time_sql_closing
120 use FS::CGI qw(header menubar table itable ntable idiot
121 eidiot myexit http_header);
122 use FS::UI::Web qw(svc_url);
123 use FS::UI::Web::small_custview qw(small_custview);
124 use FS::UI::bytecount;
125 use FS::Msgcat qw(gettext geterror);
126 use FS::Misc qw( send_email send_fax
127 states_hash counties cities state_label
129 use FS::Misc::eps2png qw( eps2png );
130 use FS::Report::FCC_477;
131 use FS::Report::Table::Monthly;
132 use FS::TicketSystem;
133 use FS::Tron qw( tron_lint );
137 use FS::domain_record;
139 use FS::cust_bill_pay;
141 use FS::cust_credit_bill;
142 use FS::cust_main qw(smart_search);
143 use FS::cust_main::Import;
144 use FS::cust_main_county;
145 use FS::cust_location;
148 use FS::part_pkg_taxclass;
149 use FS::cust_pkg_reason;
151 use FS::cust_credit_refund;
152 use FS::cust_pay_refund;
155 use FS::part_bill_event;
157 use FS::part_event_condition;
159 use FS::part_referral;
161 use FS::part_svc_router;
162 use FS::part_virtual_field;
166 use FS::queue qw(joblisting);
170 use FS::svc_acct_pop qw(popselector);
171 use FS::acct_rt_transaction;
177 use FS::svc_broadband;
178 use FS::svc_external;
181 use FS::part_export_option;
183 use FS::export_device;
190 use FS::payment_gateway;
191 use FS::agent_payment_gateway;
196 use FS::inventory_class;
197 use FS::inventory_item;
198 use FS::pkg_category;
201 use FS::access_user_pref;
202 use FS::access_group;
203 use FS::access_usergroup;
204 use FS::access_groupagent;
205 use FS::access_right;
208 use FS::phone_device;
212 use FS::cust_main_note;
214 use FS::cust_tax_location;
215 use FS::part_pkg_taxproduct;
216 use FS::part_pkg_taxoverride;
217 use FS::part_pkg_taxrate;
219 use FS::part_pkg_report_option;
220 use FS::cust_attachment;
222 use FS::h_inventory_item;
224 use FS::h_svc_broadband;
225 use FS::h_svc_domain;
226 #use FS::h_domain_record;
227 use FS::h_svc_external;
228 use FS::h_svc_forward;
230 #use FS::h_phone_device;
232 use FS::cust_statement;
234 use FS::cust_category;
235 use FS::prospect_main;
239 use FS::cust_pkg_discount;
240 use FS::cust_bill_pkg_discount;
241 use FS::svc_mailinglist;
243 use FS::cgp_rule_condition;
244 use FS::cgp_rule_action;
246 use FS::cust_bill_batch;
248 use FS::rate_time_interval;
249 use FS::msg_template;
252 if ( $FS::Mason::addl_handler_use ) {
253 eval $FS::Mason::addl_handler_use;
257 if ( %%%RT_ENABLED%%% ) {
259 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
260 use vars qw($Nobody $SystemUser);
264 use RT::Transactions;
269 use RT::ScripActions;
270 use RT::ScripConditions;
273 use RT::GroupMembers;
274 use RT::CustomFields;
275 use RT::CustomFieldValues;
276 use RT::ObjectCustomFieldValues;
278 #blah. manually updated from RT::Interface::Web::Handler
279 use RT::Interface::Web;
286 #blah. not even in RT::Interface::Web::Handler, just in
287 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
288 #to throw a real error instead of just a mysterious unstyled RT
289 use CSS::Squish 0.06;
291 use RT::Interface::Web::Request;
293 #nother undeclared web UI dep (for ticket links graph)
294 use IPC::Run::SafeHandles;
296 #slow, unreliable, segfaults and is optional
297 #see rt/html/Ticket/Elements/ShowTransactionAttachments
300 #?#use File::Path qw( rmtree );
301 #?#use File::Glob qw( bsd_glob );
302 #?#use File::Spec::Unix;
308 *CGI::redirect = sub {
311 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
312 (my $x, $cookie) = (shift, shift);
313 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
315 my $location = shift;
319 # false laziness w/below
320 if ( defined(@DBIx::Profile::ISA) ) {
322 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
327 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
329 ( UNIVERSAL::can(dbh, 'sprintProfile')
330 ? encode_entities(dbh->sprintProfile())
331 : 'DBIx::Profile missing sprintProfile method;'.
332 'unpatched or too old?' ).
333 #"\n\n". &sprintAutoProfile(). '</PRE>'.
338 dbh->{'private_profile'} = {};
343 #clear db profile, but normal redirect
344 dbh->{'private_profile'} = {};
345 $m->redirect($location);
350 } else { #normal redirect
352 $m->redirect($location);
366 $m->comp('/elements/errorpage.html', @_);
369 sub errorpage_popup {
371 $m->comp('/elements/errorpage-popup.html', @_);
375 my( $location ) = @_;
378 #false laziness w/above
379 if ( defined(@DBIx::Profile::ISA) ) {
381 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
386 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
388 ( UNIVERSAL::can(dbh, 'sprintProfile')
389 ? encode_entities(dbh->sprintProfile())
390 : 'DBIx::Profile missing sprintProfile method;'.
391 'unpatched or too old?' ).
392 #"\n\n". &sprintAutoProfile(). '</PRE>'.
397 dbh->{'private_profile'} = {};
401 #clear db profile, but normal redirect
402 dbh->{'private_profile'} = {};
403 $m->redirect($location);
407 } else { #normal redirect
409 $m->redirect($location);
415 } # end package HTML::Mason::Commands;
421 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
423 Returns a list consisting of two HTML::Mason::Interp objects, the first for
424 Freeside pages, and the second for RT pages.
426 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
428 Options and values can be passed following mode. Currently available options
431 I<outbuf> should be set to a scalar reference in standalone mode.
435 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
438 my $mode = shift || 'apache';
441 #my $request_class = 'HTML::Mason::Request'.
442 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
443 my $request_class = 'FS::Mason::Request';
445 #not entirely sure it belongs here, but what the hey
446 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
450 # A hook supporting strange legacy ways people have added stuff on
452 my @addl_comp_root = ();
453 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
454 if ( -e $addl_comp_root_file ) {
455 warn "reading $addl_comp_root_file\n";
456 my $text = slurp( $addl_comp_root_file );
457 my @addl = eval $text;
458 if ( @addl && ! $@ ) {
459 @addl_comp_root = @addl;
461 warn "error parsing $addl_comp_root_file: $@\n";
466 request_class => $request_class,
467 data_dir => '%%%MASONDATA%%%',
468 error_mode => 'output',
469 error_format => 'html',
470 ignore_warnings_expr => '.',
472 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
473 [ 'rt' =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
478 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
480 my $html_defang = new HTML::Defang (%defang_opts);
482 my $fs_interp = new HTML::Mason::Interp (
484 escape_flags => { 'js_string' => sub {
485 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
486 ${$_[0]} =~ s/(['\\])/\\$1/g;
487 ${$_[0]} =~ s/\n/\\n/g;
488 ${$_[0]} = "'". ${$_[0]}. "'";
491 ${$_[0]} = $html_defang->defang(${$_[0]});
494 compiler => HTML::Mason::Compiler::ToObject->new(
495 allow_globals => [qw(%session)],
499 my $rt_interp = new HTML::Mason::Interp (
501 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8 },
502 compiler => HTML::Mason::Compiler::ToObject->new(
503 default_escape_flags => 'h',
504 allow_globals => [qw(%session)],
508 ( $fs_interp, $rt_interp );
516 Lurking in the darkness...
520 L<HTML::Mason>, L<FS>, L<RT>