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;
137 use FS::Report::Table::Monthly;
138 use FS::Report::Table::Daily;
139 use FS::TicketSystem;
140 use FS::NetworkMonitoringSystem;
141 use FS::Tron qw( tron_lint );
143 use FS::Maketext qw( mt emt js_mt );
147 use FS::domain_record;
149 use FS::cust_bill_pay;
151 use FS::cust_credit_bill;
153 use FS::cust_main::Search qw(smart_search);
154 use FS::cust_main::Import;
155 use FS::cust_main_county;
156 use FS::cust_location;
159 use FS::cust_pkg::Import;
160 use FS::part_pkg_taxclass;
161 use FS::cust_pkg_reason;
163 use FS::cust_credit_refund;
164 use FS::cust_pay_refund;
167 use FS::part_bill_event;
169 use FS::part_event_condition;
171 use FS::part_referral;
173 use FS::part_svc_router;
174 use FS::part_virtual_field;
178 use FS::queue qw(joblisting);
182 use FS::svc_acct_pop qw(popselector);
183 use FS::acct_rt_transaction;
189 use FS::svc_broadband;
190 use FS::svc_external;
193 use FS::part_export_option;
195 use FS::export_device;
202 use FS::payment_gateway;
203 use FS::agent_payment_gateway;
208 use FS::inventory_class;
209 use FS::inventory_item;
210 use FS::pkg_category;
213 use FS::access_user_pref;
214 use FS::access_group;
215 use FS::access_usergroup;
216 use FS::access_groupagent;
217 use FS::access_right;
220 use FS::phone_device;
224 use FS::cust_main_note;
226 use FS::cust_tax_location;
227 use FS::part_pkg_taxproduct;
228 use FS::part_pkg_taxoverride;
229 use FS::part_pkg_taxrate;
231 use FS::part_pkg_report_option;
232 use FS::cust_attachment;
234 use FS::h_inventory_item;
236 use FS::h_svc_broadband;
237 use FS::h_svc_domain;
238 #use FS::h_domain_record;
239 use FS::h_svc_external;
240 use FS::h_svc_forward;
242 #use FS::h_phone_device;
244 use FS::cust_statement;
246 use FS::cust_category;
247 use FS::prospect_main;
252 use FS::cust_pkg_discount;
253 use FS::cust_bill_pkg_discount;
254 use FS::svc_mailinglist;
256 use FS::cgp_rule_condition;
257 use FS::cgp_rule_action;
259 use FS::cust_bill_batch;
261 use FS::rate_time_interval;
262 use FS::msg_template;
265 use FS::part_pkg_discount;
271 use FS::part_pkg_vendor;
272 use FS::cust_note_class;
277 use FS::torrus_srvderive;
278 use FS::torrus_srvderive_component;
282 use FS::svc_hardware;
283 use FS::h_svc_hardware;
284 use FS::hardware_class;
285 use FS::hardware_type;
286 use FS::hardware_status;
287 use FS::did_order_item;
291 use FS::radius_group;
292 use FS::template_content;
297 use FS::legacy_cust_bill;
301 if ( $FS::Mason::addl_handler_use ) {
302 eval $FS::Mason::addl_handler_use;
306 if ( %%%RT_ENABLED%%% ) {
308 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
309 use vars qw($Nobody $SystemUser);
313 use RT::Transactions;
318 use RT::ScripActions;
319 use RT::ScripConditions;
322 use RT::GroupMembers;
323 use RT::CustomFields;
324 use RT::CustomFieldValues;
325 use RT::ObjectCustomFieldValues;
327 #blah. manually updated from RT::Interface::Web::Handler
328 use RT::Interface::Web;
335 #blah. not even in RT::Interface::Web::Handler, just in
336 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
337 #to throw a real error instead of just a mysterious unstyled RT
338 use CSS::Squish 0.06;
340 use RT::Interface::Web::Request;
342 #nother undeclared web UI dep (for ticket links graph)
343 use IPC::Run::SafeHandles;
345 #slow, unreliable, segfaults and is optional
346 #see rt/html/Ticket/Elements/ShowTransactionAttachments
349 #?#use File::Path qw( rmtree );
350 #?#use File::Glob qw( bsd_glob );
351 #?#use File::Spec::Unix;
357 *CGI::redirect = sub {
360 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
361 (my $x, $cookie) = (shift, shift);
362 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
364 my $location = shift;
368 # false laziness w/below
369 if ( defined(@DBIx::Profile::ISA) ) {
371 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
376 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
378 ( UNIVERSAL::can(dbh, 'sprintProfile')
379 ? encode_entities(dbh->sprintProfile())
380 : 'DBIx::Profile missing sprintProfile method;'.
381 'unpatched or too old?' ).
382 #"\n\n". &sprintAutoProfile(). '</PRE>'.
387 dbh->{'private_profile'} = {};
392 #clear db profile, but normal redirect
393 dbh->{'private_profile'} = {};
394 $m->redirect($location);
399 } else { #normal redirect
401 $m->redirect($location);
410 #carp #should just switch to <& &> syntax
416 $m->comp('/elements/errorpage.html', @_);
419 sub errorpage_popup {
421 $m->comp('/elements/errorpage-popup.html', @_);
425 my( $location ) = @_;
428 #false laziness w/above
429 if ( defined(@DBIx::Profile::ISA) ) {
431 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
436 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
438 ( UNIVERSAL::can(dbh, 'sprintProfile')
439 ? encode_entities(dbh->sprintProfile())
440 : 'DBIx::Profile missing sprintProfile method;'.
441 'unpatched or too old?' ).
442 #"\n\n". &sprintAutoProfile(). '</PRE>'.
447 dbh->{'private_profile'} = {};
451 #clear db profile, but normal redirect
452 dbh->{'private_profile'} = {};
453 $m->redirect($location);
457 } else { #normal redirect
459 $m->redirect($location);
465 } # end package HTML::Mason::Commands;
471 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
473 Returns a list consisting of two HTML::Mason::Interp objects, the first for
474 Freeside pages, and the second for RT pages.
476 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
478 Options and values can be passed following mode. Currently available options
481 I<outbuf> should be set to a scalar reference in standalone mode.
485 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
488 my $mode = shift || 'apache';
491 #my $request_class = 'HTML::Mason::Request'.
492 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
493 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
494 : 'FS::Mason::Request';
496 #not entirely sure it belongs here, but what the hey
497 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
501 # A hook supporting strange legacy ways people (well, SG) have added stuff on
503 my @addl_comp_root = ();
504 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
505 if ( -e $addl_comp_root_file ) {
506 warn "reading $addl_comp_root_file\n";
507 my $text = slurp( $addl_comp_root_file );
508 my @addl = eval $text;
509 if ( @addl && ! $@ ) {
510 @addl_comp_root = @addl;
512 warn "error parsing $addl_comp_root_file: $@\n";
517 scalar(@addl_comp_root)
519 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
522 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
525 request_class => $request_class,
526 data_dir => '%%%MASONDATA%%%',
527 error_mode => 'output',
528 error_format => 'html',
529 ignore_warnings_expr => '.',
532 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
534 my $html_defang = new HTML::Defang (%defang_opts);
536 #false laziness w/ FS::Maketext js_mt
537 my $js_string_sub = sub {
538 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
539 ${$_[0]} =~ s/(['\\])/\\$1/g;
540 ${$_[0]} =~ s/\r/\\r/g;
541 ${$_[0]} =~ s/\n/\\n/g;
542 ${$_[0]} = "'". ${$_[0]}. "'";
545 my $defang_sub = sub {
546 ${$_[0]} = $html_defang->defang(${$_[0]});
549 my $fs_interp = new HTML::Mason::Interp (
551 comp_root => $fs_comp_root,
552 escape_flags => { 'js_string' => $js_string_sub,
553 'defang' => $defang_sub,
555 compiler => HTML::Mason::Compiler::ToObject->new(
556 allow_globals => [qw(%session)],
560 my $rt_interp = new HTML::Mason::Interp (
563 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
564 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
566 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
567 'js_string' => $js_string_sub,
569 compiler => HTML::Mason::Compiler::ToObject->new(
570 default_escape_flags => 'h',
571 allow_globals => [qw(%session)],
575 ( $fs_interp, $rt_interp );
583 Lurking in the darkness...
587 L<HTML::Mason>, L<FS>, L<RT>