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 sum );
65 use DateTime::Format::Strptime;
66 use FS::Misc::DateTime qw( parse_datetime );
67 use FS::Misc::Geo qw( get_censustract get_district );
68 use Lingua::EN::Inflect qw(PL);
69 Lingua::EN::Inflect::classical names=>0; #Categorys
74 use HTML::TreeBuilder;
75 use HTML::TableExtract qw(tree);
79 # use XMLRPC::Transport::HTTP;
80 # use XMLRPC::Lite; # for XMLRPC::Serializer
85 #not actually using this yet anyway...# use IPC::Run3 0.036;
86 use Net::Whois::Raw qw(whois);
88 eval "use Net::Whois::Raw 0.32 qw(whois)";
92 use Spreadsheet::WriteExcel;
93 use Spreadsheet::WriteExcel::Utility;
94 use OLE::Storage_Lite;
95 use Excel::Writer::XLSX;
96 #use Excel::Writer::XLSX::Utility; #redundant with above
98 use Business::CreditCard 0.30; #for mask-aware cardtype()
101 use Net::Ping::External;
102 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
104 no warnings 'redefine';
105 eval 'sub Net::Ping::External::_ping_linux {
107 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
108 return Net::Ping::External::_ping_system($command, 0);
113 use String::Approx qw(amatch);
114 use Chart::LinesPoints;
118 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
121 use Business::US::USPS::WebTools::AddressStandardization;
122 use Geo::GoogleEarth::Pluggable;
124 use Storable qw( nfreeze thaw );
126 use FS::UID qw( getotaker dbh datasrc driver_name );
127 use FS::Record qw( qsearch qsearchs fields dbdef
128 str2time_sql str2time_sql_closing
132 use FS::CGI qw(header menubar table itable ntable idiot
133 eidiot myexit http_header);
134 use FS::UI::Web qw(svc_url);
135 use FS::UI::Web::small_custview qw(small_custview);
136 use FS::UI::bytecount;
137 use FS::Msgcat qw(gettext geterror);
138 use FS::Misc qw( send_email send_fax ocr_image
139 states_hash counties cities state_label
141 use FS::Misc::eps2png qw( eps2png );
142 use FS::Report::FCC_477;
143 use FS::Report::Table;
144 use FS::Report::Table::Monthly;
145 use FS::Report::Table::Daily;
146 use FS::TicketSystem;
147 use FS::NetworkMonitoringSystem;
148 use FS::Tron qw( tron_lint );
150 use FS::Maketext qw( mt emt js_mt );
154 use FS::domain_record;
156 use FS::cust_bill_pay;
158 use FS::cust_credit_bill;
160 use FS::cust_main::Search qw(smart_search);
161 use FS::cust_main::Import;
162 use FS::cust_main_county;
163 use FS::cust_location;
166 use FS::cust_pkg::Import;
167 use FS::part_pkg_taxclass;
168 use FS::cust_pkg_reason;
170 use FS::cust_credit_refund;
171 use FS::cust_pay_refund;
174 use FS::part_bill_event;
176 use FS::part_event_condition;
178 use FS::part_referral;
180 use FS::part_svc_router;
181 use FS::part_virtual_field;
185 use FS::queue qw(joblisting);
189 use FS::svc_acct_pop qw(popselector);
190 use FS::acct_rt_transaction;
196 use FS::svc_broadband;
197 use FS::svc_external;
200 use FS::part_export_option;
202 use FS::export_device;
209 use FS::payment_gateway;
210 use FS::agent_payment_gateway;
215 use FS::inventory_class;
216 use FS::inventory_item;
217 use FS::pkg_category;
220 use FS::access_user_pref;
221 use FS::access_group;
222 use FS::access_usergroup;
223 use FS::access_groupagent;
224 use FS::access_right;
227 use FS::phone_device;
231 use FS::cust_main_note;
233 use FS::cust_tax_location;
234 use FS::part_pkg_taxproduct;
235 use FS::part_pkg_taxoverride;
236 use FS::part_pkg_taxrate;
238 use FS::part_pkg_report_option;
239 use FS::cust_attachment;
241 use FS::h_inventory_item;
243 use FS::h_svc_broadband;
244 use FS::h_svc_domain;
245 #use FS::h_domain_record;
246 use FS::h_svc_external;
247 use FS::h_svc_forward;
249 #use FS::h_phone_device;
251 use FS::cust_statement;
253 use FS::cust_category;
254 use FS::prospect_main;
259 use FS::cust_pkg_discount;
260 use FS::cust_bill_pkg_discount;
261 use FS::svc_mailinglist;
263 use FS::cgp_rule_condition;
264 use FS::cgp_rule_action;
266 use FS::cust_bill_batch;
268 use FS::rate_time_interval;
269 use FS::msg_template;
272 use FS::part_pkg_discount;
278 use FS::part_pkg_vendor;
279 use FS::cust_note_class;
284 use FS::torrus_srvderive;
285 use FS::torrus_srvderive_component;
289 use FS::svc_hardware;
290 use FS::h_svc_hardware;
291 use FS::hardware_class;
292 use FS::hardware_type;
293 use FS::hardware_status;
294 use FS::did_order_item;
298 use FS::radius_group;
299 use FS::template_content;
304 use FS::legacy_cust_bill;
306 use FS::rate_tier_detail;
308 use FS::discount_plan;
310 use FS::tower_sector;
312 use FS::access_groupsales;
313 use FS::contact_class;
314 use FS::part_svc_class;
317 use FS::quotation_pkg;
318 use FS::quotation_pkg_discount;
319 use FS::cust_bill_void;
320 use FS::cust_bill_pkg_void;
321 use FS::cust_bill_pkg_detail_void;
322 use FS::cust_bill_pkg_display_void;
323 use FS::cust_bill_pkg_tax_location_void;
324 use FS::cust_bill_pkg_tax_rate_location_void;
325 use FS::cust_tax_exempt_pkg_void;
326 use FS::cust_bill_pkg_discount_void;
327 use FS::agent_pkg_class;
328 use FS::svc_export_machine;
331 if ( $FS::Mason::addl_handler_use ) {
332 eval $FS::Mason::addl_handler_use;
336 if ( %%%RT_ENABLED%%% ) {
338 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
339 use vars qw($Nobody $SystemUser);
343 use RT::Transactions;
348 use RT::ScripActions;
349 use RT::ScripConditions;
352 use RT::GroupMembers;
353 use RT::CustomFields;
354 use RT::CustomFieldValues;
355 use RT::ObjectCustomFieldValues;
357 #blah. manually updated from RT::Interface::Web::Handler
358 use RT::Interface::Web;
365 #blah. not even in RT::Interface::Web::Handler, just in
366 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
367 #to throw a real error instead of just a mysterious unstyled RT
368 use CSS::Squish 0.06;
370 use RT::Interface::Web::Request;
372 #another undeclared web UI dep (for ticket links graph)
373 use IPC::Run::SafeHandles;
375 #slow, unreliable, segfaults and is optional
376 #see rt/html/Ticket/Elements/ShowTransactionAttachments
379 #?#use File::Path qw( rmtree );
380 #?#use File::Glob qw( bsd_glob );
381 #?#use File::Spec::Unix;
387 *CGI::redirect = sub {
390 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
391 (my $x, $cookie) = (shift, shift);
392 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
394 my $location = shift;
398 # false laziness w/below
399 if ( defined(@DBIx::Profile::ISA) ) {
401 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
406 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
408 ( UNIVERSAL::can(dbh, 'sprintProfile')
409 ? encode_entities(dbh->sprintProfile())
410 : 'DBIx::Profile missing sprintProfile method;'.
411 'unpatched or too old?' ).
412 #"\n\n". &sprintAutoProfile(). '</PRE>'.
417 dbh->{'private_profile'} = {};
422 #clear db profile, but normal redirect
423 dbh->{'private_profile'} = {};
424 $m->redirect($location);
429 } else { #normal redirect
431 $m->redirect($location);
440 #carp #should just switch to <& &> syntax
446 $m->comp('/elements/errorpage.html', @_);
449 sub errorpage_popup {
451 $m->comp('/elements/errorpage-popup.html', @_);
455 my( $location ) = @_;
458 #false laziness w/above
459 if ( defined(@DBIx::Profile::ISA) ) {
461 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
466 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
468 ( UNIVERSAL::can(dbh, 'sprintProfile')
469 ? encode_entities(dbh->sprintProfile())
470 : 'DBIx::Profile missing sprintProfile method;'.
471 'unpatched or too old?' ).
472 #"\n\n". &sprintAutoProfile(). '</PRE>'.
477 dbh->{'private_profile'} = {};
481 #clear db profile, but normal redirect
482 dbh->{'private_profile'} = {};
483 $m->redirect($location);
487 } else { #normal redirect
489 $m->redirect($location);
495 } # end package HTML::Mason::Commands;
501 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
503 Returns a list consisting of two HTML::Mason::Interp objects, the first for
504 Freeside pages, and the second for RT pages.
506 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
508 Options and values can be passed following mode. Currently available options
511 I<outbuf> should be set to a scalar reference in standalone mode.
515 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
518 my $mode = shift || 'apache';
521 #my $request_class = 'HTML::Mason::Request'.
522 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
523 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
524 : 'FS::Mason::Request';
526 #not entirely sure it belongs here, but what the hey
527 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
531 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
534 request_class => $request_class,
535 data_dir => '%%%MASONDATA%%%',
536 error_mode => 'output',
537 error_format => 'html',
538 ignore_warnings_expr => '.',
541 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
543 my $html_defang = new HTML::Defang (%defang_opts);
545 #false laziness w/ FS::Maketext js_mt
546 my $js_string_sub = sub {
547 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
548 ${$_[0]} =~ s/(['\\])/\\$1/g;
549 ${$_[0]} =~ s/\r/\\r/g;
550 ${$_[0]} =~ s/\n/\\n/g;
551 # prevent premature termination of the script
552 ${$_[0]} =~ s[</script>][<\\/script>]ig;
553 ${$_[0]} = "'". ${$_[0]}. "'";
556 my $defang_sub = sub {
557 ${$_[0]} = $html_defang->defang(${$_[0]});
560 my $fs_interp = new HTML::Mason::Interp (
562 comp_root => $fs_comp_root,
563 escape_flags => { 'js_string' => $js_string_sub,
564 'defang' => $defang_sub,
566 compiler => HTML::Mason::Compiler::ToObject->new(
567 allow_globals => [qw(%session)],
571 my $rt_interp = new HTML::Mason::Interp (
574 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
575 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
577 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
578 'u' => \&RT::Interface::Web::EscapeURI,
579 'j' => \&RT::Interface::Web::EscapeJS,
580 'js_string' => $js_string_sub,
582 compiler => HTML::Mason::Compiler::ToObject->new(
583 default_escape_flags => 'h',
584 allow_globals => [qw(%session $DECODED_ARGS)],
588 ( $fs_interp, $rt_interp );
596 Lurking in the darkness...
600 L<HTML::Mason>, L<FS>, L<RT>