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 );
59 use List::MoreUtils qw( first_index uniq );
60 use Scalar::Util qw( blessed );
67 use DateTime::Format::Strptime;
68 use FS::Misc::DateTime qw( parse_datetime );
69 use FS::Misc::Geo qw( get_district );
70 use Lingua::EN::Inflect qw(PL);
71 Lingua::EN::Inflect::classical names=>0; #Categorys
76 use HTML::TreeBuilder;
77 use HTML::TableExtract qw(tree);
81 # use XMLRPC::Transport::HTTP;
82 # use XMLRPC::Lite; # for XMLRPC::Serializer
88 #not actually using this yet anyway...# use IPC::Run3 0.036;
89 use Net::Whois::Raw qw(whois);
91 eval "use Net::Whois::Raw 0.32 qw(whois)";
95 use Spreadsheet::WriteExcel;
96 use Spreadsheet::WriteExcel::Utility;
97 use OLE::Storage_Lite;
98 use Excel::Writer::XLSX;
99 #use Excel::Writer::XLSX::Utility; #redundant with above
101 use Business::CreditCard 0.30; #for mask-aware cardtype()
103 use Net::MAC::Vendor;
105 use Net::Ping::External;
106 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
108 no warnings 'redefine';
109 eval 'sub Net::Ping::External::_ping_linux {
111 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
112 return Net::Ping::External::_ping_system($command, 0);
117 use String::Approx qw(amatch);
118 use Chart::LinesPoints;
122 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
125 use Business::US::USPS::WebTools::AddressStandardization;
126 use Geo::GoogleEarth::Pluggable;
128 use Storable qw( nfreeze thaw );
130 use FS::UID qw( getotaker dbh datasrc driver_name );
131 use FS::Record qw( qsearch qsearchs fields dbdef
132 str2time_sql str2time_sql_closing
136 use FS::CGI qw(header menubar table itable ntable idiot
137 eidiot myexit http_header);
138 use FS::UI::Web qw(svc_url);
139 use FS::UI::Web::small_custview qw(small_custview);
140 use FS::UI::bytecount;
141 use FS::Msgcat qw(gettext geterror);
142 use FS::Misc qw( send_email send_fax ocr_image
143 states_hash counties cities state_label
145 use FS::Misc::eps2png qw( eps2png );
146 use FS::Report::FCC_477;
147 use FS::Report::Table;
148 use FS::Report::Table::Monthly;
149 use FS::Report::Table::Daily;
150 use FS::TicketSystem;
151 use FS::NetworkMonitoringSystem;
152 use FS::Tron qw( tron_lint );
154 use FS::Maketext qw( mt emt js_mt );
158 use FS::domain_record;
160 use FS::cust_bill_pay;
162 use FS::cust_credit_bill;
165 use FS::cust_main::Search qw(smart_search);
166 use FS::cust_main::Import;
167 use FS::cust_main_county;
168 use FS::cust_location;
171 use FS::cust_pkg::Import;
172 use FS::part_pkg_taxclass;
173 use FS::cust_pkg_reason;
175 use FS::cust_credit_refund;
176 use FS::cust_pay_refund;
179 use FS::part_bill_event;
181 use FS::part_event_condition;
183 use FS::part_referral;
185 use FS::part_svc_router;
186 use FS::part_virtual_field;
190 use FS::queue qw(joblisting);
194 use FS::svc_acct_pop qw(popselector);
195 use FS::acct_rt_transaction;
201 use FS::svc_broadband;
202 use FS::svc_external;
205 use FS::part_export_option;
207 use FS::export_device;
214 use FS::payment_gateway;
215 use FS::agent_payment_gateway;
220 use FS::inventory_class;
221 use FS::inventory_item;
222 use FS::pkg_category;
225 use FS::access_user_pref;
226 use FS::access_group;
227 use FS::access_usergroup;
228 use FS::access_groupagent;
229 use FS::access_right;
232 use FS::phone_device;
236 use FS::cust_main_note;
238 use FS::cust_tax_location;
239 use FS::part_pkg_taxproduct;
240 use FS::part_pkg_taxoverride;
241 use FS::part_pkg_taxrate;
243 use FS::part_pkg_report_option;
244 use FS::cust_attachment;
246 use FS::h_inventory_item;
248 use FS::h_svc_broadband;
249 use FS::h_svc_domain;
250 #use FS::h_domain_record;
251 use FS::h_svc_external;
252 use FS::h_svc_forward;
254 #use FS::h_phone_device;
256 use FS::cust_statement;
258 use FS::cust_category;
259 use FS::prospect_main;
264 use FS::cust_pkg_discount;
265 use FS::cust_bill_pkg_discount;
266 use FS::svc_mailinglist;
268 use FS::cgp_rule_condition;
269 use FS::cgp_rule_action;
271 use FS::cust_bill_batch;
273 use FS::rate_time_interval;
274 use FS::msg_template;
277 use FS::part_pkg_discount;
283 use FS::part_pkg_vendor;
284 use FS::cust_note_class;
289 use FS::torrus_srvderive;
290 use FS::torrus_srvderive_component;
294 use FS::svc_hardware;
295 use FS::h_svc_hardware;
296 use FS::hardware_class;
297 use FS::hardware_type;
298 use FS::hardware_status;
299 use FS::did_order_item;
303 use FS::radius_group;
304 use FS::template_content;
309 use FS::legacy_cust_bill;
311 use FS::rate_tier_detail;
313 use FS::discount_plan;
315 use FS::tower_sector;
317 use FS::contact_class;
318 use FS::part_svc_class;
319 use FS::upload_target;
321 use FS::quotation_pkg;
322 use FS::quotation_pkg_discount;
323 use FS::cust_bill_void;
324 use FS::cust_bill_pkg_void;
325 use FS::cust_bill_pkg_detail_void;
326 use FS::cust_bill_pkg_display_void;
327 use FS::cust_bill_pkg_tax_location_void;
328 use FS::cust_bill_pkg_tax_rate_location_void;
329 use FS::cust_tax_exempt_pkg_void;
330 use FS::cust_bill_pkg_discount_void;
331 use FS::agent_pkg_class;
332 use FS::svc_export_machine;
333 use FS::GeocodeCache;
336 use FS::part_pkg_usage_class;
337 use FS::cust_pkg_usage;
338 use FS::part_pkg_usage_class;
339 use FS::part_pkg_usage;
340 use FS::cdr_cust_pkg_usage;
341 use FS::part_pkg_msgcat;
343 use FS::sales_pkg_class;
346 use FS::invoice_mode;
347 use FS::invoice_conf;
348 use FS::cable_provider;
349 use FS::cust_credit_void;
350 use FS::discount_class;
351 use FS::alarm_system;
353 use FS::alarm_station;
355 use FS::pbx_extension;
356 use FS::cust_event_fee;
358 use FS::cust_bill_pkg_fee;
359 use FS::part_fee_msgcat;
360 use FS::part_fee_usage;
365 if ( $FS::Mason::addl_handler_use ) {
366 eval $FS::Mason::addl_handler_use;
370 if ( %%%RT_ENABLED%%% ) {
372 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
373 use vars qw($Nobody $SystemUser);
377 use RT::Transactions;
382 use RT::ScripActions;
383 use RT::ScripConditions;
386 use RT::GroupMembers;
387 use RT::CustomFields;
388 use RT::CustomFieldValues;
389 use RT::ObjectCustomFieldValues;
391 #blah. manually updated from RT::Interface::Web::Handler
392 use RT::Interface::Web;
399 #blah. not even in RT::Interface::Web::Handler, just in
400 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
401 #to throw a real error instead of just a mysterious unstyled RT
402 use CSS::Squish 0.06;
404 use RT::Interface::Web::Request;
406 #another undeclared web UI dep (for ticket links graph)
407 use IPC::Run::SafeHandles;
409 #slow, unreliable, segfaults and is optional
410 #see rt/html/Ticket/Elements/ShowTransactionAttachments
413 #?#use File::Path qw( rmtree );
414 #?#use File::Glob qw( bsd_glob );
415 #?#use File::Spec::Unix;
421 *CGI::redirect = sub {
424 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
425 (my $x, $cookie) = (shift, shift);
426 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
428 my $location = shift;
432 # false laziness w/below
433 if ( defined(@DBIx::Profile::ISA) ) {
435 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
440 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
442 ( UNIVERSAL::can(dbh, 'sprintProfile')
443 ? encode_entities(dbh->sprintProfile())
444 : 'DBIx::Profile missing sprintProfile method;'.
445 'unpatched or too old?' ).
446 #"\n\n". &sprintAutoProfile(). '</PRE>'.
451 dbh->{'private_profile'} = {};
456 #clear db profile, but normal redirect
457 dbh->{'private_profile'} = {};
458 $m->redirect($location);
463 } else { #normal redirect
465 $m->redirect($location);
474 #carp #should just switch to <& &> syntax
480 $m->comp('/elements/errorpage.html', @_);
483 sub errorpage_popup {
485 $m->comp('/elements/errorpage-popup.html', @_);
489 my( $location ) = @_;
492 #false laziness w/above
493 if ( defined(@DBIx::Profile::ISA) ) {
495 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
500 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
502 ( UNIVERSAL::can(dbh, 'sprintProfile')
503 ? encode_entities(dbh->sprintProfile())
504 : 'DBIx::Profile missing sprintProfile method;'.
505 'unpatched or too old?' ).
506 #"\n\n". &sprintAutoProfile(). '</PRE>'.
511 dbh->{'private_profile'} = {};
515 #clear db profile, but normal redirect
516 dbh->{'private_profile'} = {};
517 $m->redirect($location);
521 } else { #normal redirect
523 $m->redirect($location);
529 } # end package HTML::Mason::Commands;
535 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
537 Returns a list consisting of two HTML::Mason::Interp objects, the first for
538 Freeside pages, and the second for RT pages.
540 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
542 Options and values can be passed following mode. Currently available options
545 I<outbuf> should be set to a scalar reference in standalone mode.
549 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
552 my $mode = shift || 'apache';
555 #my $request_class = 'HTML::Mason::Request'.
556 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
557 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
558 : 'FS::Mason::Request';
560 #not entirely sure it belongs here, but what the hey
561 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
565 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
568 request_class => $request_class,
569 data_dir => '%%%MASONDATA%%%',
570 error_mode => 'output',
571 error_format => 'html',
572 ignore_warnings_expr => '.',
575 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
577 my $html_defang = new HTML::Defang (%defang_opts);
579 #false laziness w/ FS::Maketext js_mt
580 my $js_string_sub = sub {
581 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
582 ${$_[0]} =~ s/(['\\])/\\$1/g;
583 ${$_[0]} =~ s/\r/\\r/g;
584 ${$_[0]} =~ s/\n/\\n/g;
585 # prevent premature termination of the script
586 ${$_[0]} =~ s[</script>][<\\/script>]ig;
587 ${$_[0]} = "'". ${$_[0]}. "'";
590 my $defang_sub = sub {
591 ${$_[0]} = $html_defang->defang(${$_[0]});
594 my $fs_interp = new HTML::Mason::Interp (
596 comp_root => $fs_comp_root,
597 escape_flags => { 'js_string' => $js_string_sub,
598 'defang' => $defang_sub,
600 compiler => HTML::Mason::Compiler::ToObject->new(
601 allow_globals => [qw(%session)],
605 my $rt_interp = new HTML::Mason::Interp (
608 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
609 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
611 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
612 'u' => \&RT::Interface::Web::EscapeURI,
613 'j' => \&RT::Interface::Web::EscapeJS,
614 'js_string' => $js_string_sub,
616 compiler => HTML::Mason::Compiler::ToObject->new(
617 default_escape_flags => 'h',
618 allow_globals => [qw(%session $DECODED_ARGS)],
622 ( $fs_interp, $rt_interp );
630 Lurking in the darkness...
634 L<HTML::Mason>, L<FS>, L<RT>