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;
74 use HTML::TableExtract qw(tree);
78 # use XMLRPC::Transport::HTTP;
79 # use XMLRPC::Lite; # for XMLRPC::Serializer
84 #not actually using this yet anyway...# use IPC::Run3 0.036;
85 use Net::Whois::Raw qw(whois);
87 eval "use Net::Whois::Raw 0.32 qw(whois)";
91 use Spreadsheet::WriteExcel;
92 use Spreadsheet::WriteExcel::Utility;
93 use Business::CreditCard 0.30; #for mask-aware cardtype()
96 use Net::Ping::External;
97 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
99 no warnings 'redefine';
100 eval 'sub Net::Ping::External::_ping_linux {
102 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
103 return Net::Ping::External::_ping_system($command, 0);
108 use String::Approx qw(amatch);
109 use Chart::LinesPoints;
113 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
116 use Business::US::USPS::WebTools::AddressStandardization;
118 use Storable qw( nfreeze thaw );
120 use FS::UID qw( getotaker dbh datasrc driver_name );
121 use FS::Record qw( qsearch qsearchs fields dbdef
122 str2time_sql str2time_sql_closing
125 use FS::CGI qw(header menubar table itable ntable idiot
126 eidiot myexit http_header);
127 use FS::UI::Web qw(svc_url);
128 use FS::UI::Web::small_custview qw(small_custview);
129 use FS::UI::bytecount;
130 use FS::Msgcat qw(gettext geterror);
131 use FS::Misc qw( send_email send_fax ocr_image
132 states_hash counties cities state_label
134 use FS::Misc::eps2png qw( eps2png );
135 use FS::Report::FCC_477;
136 use FS::Report::Table::Monthly;
137 use FS::TicketSystem;
138 use FS::NetworkMonitoringSystem;
139 use FS::Tron qw( tron_lint );
143 use FS::domain_record;
145 use FS::cust_bill_pay;
147 use FS::cust_credit_bill;
149 use FS::cust_main::Search qw(smart_search);
150 use FS::cust_main::Import;
151 use FS::cust_main_county;
152 use FS::cust_location;
155 use FS::cust_pkg::Import;
156 use FS::part_pkg_taxclass;
157 use FS::cust_pkg_reason;
159 use FS::cust_credit_refund;
160 use FS::cust_pay_refund;
163 use FS::part_bill_event;
165 use FS::part_event_condition;
167 use FS::part_referral;
169 use FS::part_svc_router;
170 use FS::part_virtual_field;
174 use FS::queue qw(joblisting);
178 use FS::svc_acct_pop qw(popselector);
179 use FS::acct_rt_transaction;
185 use FS::svc_broadband;
186 use FS::svc_external;
189 use FS::part_export_option;
191 use FS::export_device;
198 use FS::payment_gateway;
199 use FS::agent_payment_gateway;
204 use FS::inventory_class;
205 use FS::inventory_item;
206 use FS::pkg_category;
209 use FS::access_user_pref;
210 use FS::access_group;
211 use FS::access_usergroup;
212 use FS::access_groupagent;
213 use FS::access_right;
216 use FS::phone_device;
220 use FS::cust_main_note;
222 use FS::cust_tax_location;
223 use FS::part_pkg_taxproduct;
224 use FS::part_pkg_taxoverride;
225 use FS::part_pkg_taxrate;
227 use FS::part_pkg_report_option;
228 use FS::cust_attachment;
230 use FS::h_inventory_item;
232 use FS::h_svc_broadband;
233 use FS::h_svc_domain;
234 #use FS::h_domain_record;
235 use FS::h_svc_external;
236 use FS::h_svc_forward;
238 #use FS::h_phone_device;
240 use FS::cust_statement;
242 use FS::cust_category;
243 use FS::prospect_main;
247 use FS::cust_pkg_discount;
248 use FS::cust_bill_pkg_discount;
249 use FS::svc_mailinglist;
251 use FS::cgp_rule_condition;
252 use FS::cgp_rule_action;
254 use FS::cust_bill_batch;
256 use FS::rate_time_interval;
257 use FS::msg_template;
260 use FS::part_pkg_discount;
266 use FS::part_pkg_vendor;
267 use FS::cust_note_class;
274 if ( $FS::Mason::addl_handler_use ) {
275 eval $FS::Mason::addl_handler_use;
279 if ( %%%RT_ENABLED%%% ) {
281 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
282 use vars qw($Nobody $SystemUser);
286 use RT::Transactions;
291 use RT::ScripActions;
292 use RT::ScripConditions;
295 use RT::GroupMembers;
296 use RT::CustomFields;
297 use RT::CustomFieldValues;
298 use RT::ObjectCustomFieldValues;
300 #blah. manually updated from RT::Interface::Web::Handler
301 use RT::Interface::Web;
308 #blah. not even in RT::Interface::Web::Handler, just in
309 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
310 #to throw a real error instead of just a mysterious unstyled RT
311 use CSS::Squish 0.06;
313 use RT::Interface::Web::Request;
315 #nother undeclared web UI dep (for ticket links graph)
316 use IPC::Run::SafeHandles;
318 #slow, unreliable, segfaults and is optional
319 #see rt/html/Ticket/Elements/ShowTransactionAttachments
322 #?#use File::Path qw( rmtree );
323 #?#use File::Glob qw( bsd_glob );
324 #?#use File::Spec::Unix;
330 *CGI::redirect = sub {
333 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
334 (my $x, $cookie) = (shift, shift);
335 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
337 my $location = shift;
341 # false laziness w/below
342 if ( defined(@DBIx::Profile::ISA) ) {
344 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
349 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
351 ( UNIVERSAL::can(dbh, 'sprintProfile')
352 ? encode_entities(dbh->sprintProfile())
353 : 'DBIx::Profile missing sprintProfile method;'.
354 'unpatched or too old?' ).
355 #"\n\n". &sprintAutoProfile(). '</PRE>'.
360 dbh->{'private_profile'} = {};
365 #clear db profile, but normal redirect
366 dbh->{'private_profile'} = {};
367 $m->redirect($location);
372 } else { #normal redirect
374 $m->redirect($location);
383 #carp #should just switch to <& &> syntax
389 $m->comp('/elements/errorpage.html', @_);
392 sub errorpage_popup {
394 $m->comp('/elements/errorpage-popup.html', @_);
398 my( $location ) = @_;
401 #false laziness w/above
402 if ( defined(@DBIx::Profile::ISA) ) {
404 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
409 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
411 ( UNIVERSAL::can(dbh, 'sprintProfile')
412 ? encode_entities(dbh->sprintProfile())
413 : 'DBIx::Profile missing sprintProfile method;'.
414 'unpatched or too old?' ).
415 #"\n\n". &sprintAutoProfile(). '</PRE>'.
420 dbh->{'private_profile'} = {};
424 #clear db profile, but normal redirect
425 dbh->{'private_profile'} = {};
426 $m->redirect($location);
430 } else { #normal redirect
432 $m->redirect($location);
438 } # end package HTML::Mason::Commands;
444 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
446 Returns a list consisting of two HTML::Mason::Interp objects, the first for
447 Freeside pages, and the second for RT pages.
449 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
451 Options and values can be passed following mode. Currently available options
454 I<outbuf> should be set to a scalar reference in standalone mode.
458 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
461 my $mode = shift || 'apache';
464 #my $request_class = 'HTML::Mason::Request'.
465 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
466 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
467 : 'FS::Mason::Request';
469 #not entirely sure it belongs here, but what the hey
470 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
474 # A hook supporting strange legacy ways people (well, SG) have added stuff on
476 my @addl_comp_root = ();
477 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
478 if ( -e $addl_comp_root_file ) {
479 warn "reading $addl_comp_root_file\n";
480 my $text = slurp( $addl_comp_root_file );
481 my @addl = eval $text;
482 if ( @addl && ! $@ ) {
483 @addl_comp_root = @addl;
485 warn "error parsing $addl_comp_root_file: $@\n";
490 scalar(@addl_comp_root)
492 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
495 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
498 request_class => $request_class,
499 data_dir => '%%%MASONDATA%%%',
500 error_mode => 'output',
501 error_format => 'html',
502 ignore_warnings_expr => '.',
505 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
507 my $html_defang = new HTML::Defang (%defang_opts);
509 my $js_string_sub = sub {
510 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
511 ${$_[0]} =~ s/(['\\])/\\$1/g;
512 ${$_[0]} =~ s/\r/\\r/g;
513 ${$_[0]} =~ s/\n/\\n/g;
514 ${$_[0]} = "'". ${$_[0]}. "'";
517 my $fs_interp = new HTML::Mason::Interp (
519 comp_root => $fs_comp_root,
520 escape_flags => { 'js_string' => $js_string_sub,
522 ${$_[0]} = $html_defang->defang(${$_[0]});
525 compiler => HTML::Mason::Compiler::ToObject->new(
526 allow_globals => [qw(%session)],
530 my $rt_interp = new HTML::Mason::Interp (
533 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
534 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
536 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
537 'js_string' => $js_string_sub,
539 compiler => HTML::Mason::Compiler::ToObject->new(
540 default_escape_flags => 'h',
541 allow_globals => [qw(%session)],
545 ( $fs_interp, $rt_interp );
553 Lurking in the darkness...
557 L<HTML::Mason>, L<FS>, L<RT>