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;
299 use FS::rate_tier_detail;
301 use FS::discount_plan;
304 if ( $FS::Mason::addl_handler_use ) {
305 eval $FS::Mason::addl_handler_use;
309 if ( %%%RT_ENABLED%%% ) {
311 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
312 use vars qw($Nobody $SystemUser);
316 use RT::Transactions;
321 use RT::ScripActions;
322 use RT::ScripConditions;
325 use RT::GroupMembers;
326 use RT::CustomFields;
327 use RT::CustomFieldValues;
328 use RT::ObjectCustomFieldValues;
330 #blah. manually updated from RT::Interface::Web::Handler
331 use RT::Interface::Web;
338 #blah. not even in RT::Interface::Web::Handler, just in
339 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
340 #to throw a real error instead of just a mysterious unstyled RT
341 use CSS::Squish 0.06;
343 use RT::Interface::Web::Request;
345 #nother undeclared web UI dep (for ticket links graph)
346 use IPC::Run::SafeHandles;
348 #slow, unreliable, segfaults and is optional
349 #see rt/html/Ticket/Elements/ShowTransactionAttachments
352 #?#use File::Path qw( rmtree );
353 #?#use File::Glob qw( bsd_glob );
354 #?#use File::Spec::Unix;
360 *CGI::redirect = sub {
363 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
364 (my $x, $cookie) = (shift, shift);
365 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
367 my $location = shift;
371 # false laziness w/below
372 if ( defined(@DBIx::Profile::ISA) ) {
374 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
379 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
381 ( UNIVERSAL::can(dbh, 'sprintProfile')
382 ? encode_entities(dbh->sprintProfile())
383 : 'DBIx::Profile missing sprintProfile method;'.
384 'unpatched or too old?' ).
385 #"\n\n". &sprintAutoProfile(). '</PRE>'.
390 dbh->{'private_profile'} = {};
395 #clear db profile, but normal redirect
396 dbh->{'private_profile'} = {};
397 $m->redirect($location);
402 } else { #normal redirect
404 $m->redirect($location);
413 #carp #should just switch to <& &> syntax
419 $m->comp('/elements/errorpage.html', @_);
422 sub errorpage_popup {
424 $m->comp('/elements/errorpage-popup.html', @_);
428 my( $location ) = @_;
431 #false laziness w/above
432 if ( defined(@DBIx::Profile::ISA) ) {
434 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
439 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
441 ( UNIVERSAL::can(dbh, 'sprintProfile')
442 ? encode_entities(dbh->sprintProfile())
443 : 'DBIx::Profile missing sprintProfile method;'.
444 'unpatched or too old?' ).
445 #"\n\n". &sprintAutoProfile(). '</PRE>'.
450 dbh->{'private_profile'} = {};
454 #clear db profile, but normal redirect
455 dbh->{'private_profile'} = {};
456 $m->redirect($location);
460 } else { #normal redirect
462 $m->redirect($location);
468 } # end package HTML::Mason::Commands;
474 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
476 Returns a list consisting of two HTML::Mason::Interp objects, the first for
477 Freeside pages, and the second for RT pages.
479 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
481 Options and values can be passed following mode. Currently available options
484 I<outbuf> should be set to a scalar reference in standalone mode.
488 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
491 my $mode = shift || 'apache';
494 #my $request_class = 'HTML::Mason::Request'.
495 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
496 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
497 : 'FS::Mason::Request';
499 #not entirely sure it belongs here, but what the hey
500 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
504 # A hook supporting strange legacy ways people (well, SG) have added stuff on
506 my @addl_comp_root = ();
507 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
508 if ( -e $addl_comp_root_file ) {
509 warn "reading $addl_comp_root_file\n";
510 my $text = slurp( $addl_comp_root_file );
511 my @addl = eval $text;
512 if ( @addl && ! $@ ) {
513 @addl_comp_root = @addl;
515 warn "error parsing $addl_comp_root_file: $@\n";
520 scalar(@addl_comp_root)
522 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
525 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
528 request_class => $request_class,
529 data_dir => '%%%MASONDATA%%%',
530 error_mode => 'output',
531 error_format => 'html',
532 ignore_warnings_expr => '.',
535 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
537 my $html_defang = new HTML::Defang (%defang_opts);
539 #false laziness w/ FS::Maketext js_mt
540 my $js_string_sub = sub {
541 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
542 ${$_[0]} =~ s/(['\\])/\\$1/g;
543 ${$_[0]} =~ s/\r/\\r/g;
544 ${$_[0]} =~ s/\n/\\n/g;
545 ${$_[0]} = "'". ${$_[0]}. "'";
548 my $defang_sub = sub {
549 ${$_[0]} = $html_defang->defang(${$_[0]});
552 my $fs_interp = new HTML::Mason::Interp (
554 comp_root => $fs_comp_root,
555 escape_flags => { 'js_string' => $js_string_sub,
556 'defang' => $defang_sub,
558 compiler => HTML::Mason::Compiler::ToObject->new(
559 allow_globals => [qw(%session)],
563 my $rt_interp = new HTML::Mason::Interp (
566 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
567 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
569 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
570 'js_string' => $js_string_sub,
572 compiler => HTML::Mason::Compiler::ToObject->new(
573 default_escape_flags => 'h',
574 allow_globals => [qw(%session)],
578 ( $fs_interp, $rt_interp );
586 Lurking in the darkness...
590 L<HTML::Mason>, L<FS>, L<RT>