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);
86 #not actually using this yet anyway...# use IPC::Run3 0.036;
87 use Net::Whois::Raw qw(whois);
89 eval "use Net::Whois::Raw 0.32 qw(whois)";
93 use Spreadsheet::WriteExcel;
94 use Spreadsheet::WriteExcel::Utility;
95 use OLE::Storage_Lite;
96 use Excel::Writer::XLSX;
97 #use Excel::Writer::XLSX::Utility; #redundant with above
99 use Business::CreditCard 0.30; #for mask-aware cardtype()
102 use Net::Ping::External;
103 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
105 no warnings 'redefine';
106 eval 'sub Net::Ping::External::_ping_linux {
108 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
109 return Net::Ping::External::_ping_system($command, 0);
114 use String::Approx qw(amatch);
115 use Chart::LinesPoints;
119 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
122 use Locale::Currency;
123 use Locale::Currency::Format;
124 use Business::US::USPS::WebTools::AddressStandardization;
125 use Geo::GoogleEarth::Pluggable;
127 use Storable qw( nfreeze thaw );
129 use FS::UID qw( dbh datasrc driver_name );
130 use FS::Record qw( qsearch qsearchs fields dbdef
131 str2time_sql str2time_sql_closing
135 use FS::CGI qw(header menubar table itable ntable idiot
136 eidiot myexit http_header);
137 use FS::UI::Web qw(svc_url);
138 use FS::UI::Web::small_custview qw(small_custview);
139 use FS::UI::bytecount;
140 use FS::Msgcat qw(gettext geterror);
141 use FS::Misc qw( send_email send_fax ocr_image
142 states_hash counties cities state_label
144 use FS::Misc::eps2png qw( eps2png );
145 use FS::Report::FCC_477;
146 use FS::Report::Table;
147 use FS::Report::Table::Monthly;
148 use FS::Report::Table::Daily;
149 use FS::TicketSystem;
150 use FS::NetworkMonitoringSystem;
151 use FS::Tron qw( tron_lint );
153 use FS::Maketext qw( mt emt js_mt );
157 use FS::domain_record;
159 use FS::cust_bill_pay;
161 use FS::cust_credit_bill;
164 use FS::cust_main::Search qw(smart_search);
165 use FS::cust_main::Import;
166 use FS::cust_main::Import_Charges;
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;
219 use FS::inventory_class;
220 use FS::inventory_item;
221 use FS::pkg_category;
224 use FS::access_user_pref;
225 use FS::access_group;
226 use FS::access_usergroup;
227 use FS::access_groupagent;
228 use FS::access_right;
231 use FS::phone_device;
235 use FS::cust_main_note;
237 use FS::cust_tax_location;
238 use FS::part_pkg_taxproduct;
239 use FS::part_pkg_taxoverride;
240 use FS::part_pkg_taxrate;
242 use FS::part_pkg_report_option;
243 use FS::cust_attachment;
245 use FS::h_inventory_item;
247 use FS::h_svc_broadband;
248 use FS::h_svc_domain;
249 #use FS::h_domain_record;
250 use FS::h_svc_external;
251 use FS::h_svc_forward;
253 #use FS::h_phone_device;
255 use FS::cust_statement;
257 use FS::cust_category;
258 use FS::prospect_main;
263 use FS::cust_pkg_discount;
264 use FS::cust_bill_pkg_discount;
265 use FS::svc_mailinglist;
267 use FS::cgp_rule_condition;
268 use FS::cgp_rule_action;
270 use FS::cust_bill_batch;
272 use FS::rate_time_interval;
273 use FS::msg_template;
276 use FS::part_pkg_discount;
282 use FS::part_pkg_vendor;
283 use FS::cust_note_class;
288 use FS::torrus_srvderive;
289 use FS::torrus_srvderive_component;
293 use FS::svc_hardware;
294 use FS::h_svc_hardware;
295 use FS::hardware_class;
296 use FS::hardware_type;
297 use FS::hardware_status;
298 use FS::did_order_item;
302 use FS::radius_group;
303 use FS::template_content;
308 use FS::legacy_cust_bill;
310 use FS::rate_tier_detail;
312 use FS::discount_plan;
314 use FS::tower_sector;
316 use FS::contact_class;
317 use FS::part_svc_class;
318 use FS::upload_target;
320 use FS::quotation_pkg;
321 use FS::quotation_pkg_discount;
322 use FS::cust_bill_void;
323 use FS::cust_bill_pkg_void;
324 use FS::cust_bill_pkg_detail_void;
325 use FS::cust_bill_pkg_display_void;
326 use FS::cust_bill_pkg_tax_location_void;
327 use FS::cust_bill_pkg_tax_rate_location_void;
328 use FS::cust_tax_exempt_pkg_void;
329 use FS::cust_bill_pkg_discount_void;
330 use FS::agent_pkg_class;
331 use FS::svc_export_machine;
332 use FS::GeocodeCache;
335 use FS::part_pkg_usage_class;
336 use FS::cust_pkg_usage;
337 use FS::part_pkg_usage_class;
338 use FS::part_pkg_usage;
339 use FS::cdr_cust_pkg_usage;
340 use FS::part_pkg_msgcat;
342 use FS::agent_currency;
343 use FS::currency_exchange;
344 use FS::part_pkg_currency;
350 use FS::vend_bill_pay;
351 use FS::sales_pkg_class;
354 use FS::invoice_mode;
355 use FS::invoice_conf;
356 use FS::cable_provider;
357 use FS::cust_credit_void;
358 use FS::discount_class;
359 use FS::alarm_system;
361 use FS::alarm_station;
363 use FS::svc_conferencing;
364 use FS::conferencing_type;
365 use FS::conferencing_quality;
367 use FS::part_pkg_usageprice;
368 use FS::cust_pkg_usageprice;
369 use FS::pbx_extension;
371 use FS::extension_device;
372 use FS::cust_main_credit_limit;
373 use FS::cust_event_fee;
375 use FS::cust_bill_pkg_fee;
376 use FS::part_fee_msgcat;
377 use FS::part_fee_usage;
380 if ( $FS::Mason::addl_handler_use ) {
381 eval $FS::Mason::addl_handler_use;
385 if ( %%%RT_ENABLED%%% ) {
387 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
388 use vars qw($Nobody $SystemUser);
392 use RT::Transactions;
397 use RT::ScripActions;
398 use RT::ScripConditions;
401 use RT::GroupMembers;
402 use RT::CustomFields;
403 use RT::CustomFieldValues;
404 use RT::ObjectCustomFieldValues;
406 #blah. manually updated from RT::Interface::Web::Handler
407 use RT::Interface::Web;
414 #blah. not even in RT::Interface::Web::Handler, just in
415 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
416 #to throw a real error instead of just a mysterious unstyled RT
417 use CSS::Squish 0.06;
419 use RT::Interface::Web::Request;
421 #another undeclared web UI dep (for ticket links graph)
422 use IPC::Run::SafeHandles;
424 #slow, unreliable, segfaults and is optional
425 #see rt/html/Ticket/Elements/ShowTransactionAttachments
428 #?#use File::Path qw( rmtree );
429 #?#use File::Glob qw( bsd_glob );
430 #?#use File::Spec::Unix;
436 *CGI::redirect = sub {
439 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
440 (my $x, $cookie) = (shift, shift);
441 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
443 my $location = shift;
447 # false laziness w/below
448 if ( @DBIx::Profile::ISA ) {
450 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
455 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
457 ( UNIVERSAL::can(dbh, 'sprintProfile')
458 ? encode_entities(dbh->sprintProfile())
459 : 'DBIx::Profile missing sprintProfile method;'.
460 'unpatched or too old?' ).
461 #"\n\n". &sprintAutoProfile(). '</PRE>'.
466 dbh->{'private_profile'} = {};
471 #clear db profile, but normal redirect
472 dbh->{'private_profile'} = {};
473 $m->redirect($location);
478 } else { #normal redirect
480 $m->redirect($location);
489 #carp #should just switch to <& &> syntax
495 $m->comp('/elements/errorpage.html', @_);
498 sub errorpage_popup {
500 $m->comp('/elements/errorpage-popup.html', @_);
504 my( $location ) = @_;
507 #false laziness w/above
508 if ( @DBIx::Profile::ISA ) {
510 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
515 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
517 ( UNIVERSAL::can(dbh, 'sprintProfile')
518 ? encode_entities(dbh->sprintProfile())
519 : 'DBIx::Profile missing sprintProfile method;'.
520 'unpatched or too old?' ).
521 #"\n\n". &sprintAutoProfile(). '</PRE>'.
526 dbh->{'private_profile'} = {};
530 #clear db profile, but normal redirect
531 dbh->{'private_profile'} = {};
532 $m->redirect($location);
536 } else { #normal redirect
538 $m->redirect($location);
544 } # end package HTML::Mason::Commands;
550 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
552 Returns a list consisting of two HTML::Mason::Interp objects, the first for
553 Freeside pages, and the second for RT pages.
555 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
557 Options and values can be passed following mode. Currently available options
560 I<outbuf> should be set to a scalar reference in standalone mode.
564 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
567 my $mode = shift || 'apache';
570 #my $request_class = 'HTML::Mason::Request'.
571 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
572 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
573 : 'FS::Mason::Request';
575 #not entirely sure it belongs here, but what the hey
576 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
580 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
583 request_class => $request_class,
584 data_dir => '%%%MASONDATA%%%',
585 error_mode => 'output',
586 error_format => 'html',
587 ignore_warnings_expr => '.',
590 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
592 my $html_defang = new HTML::Defang (%defang_opts);
594 #false laziness w/ FS::Maketext js_mt
595 my $js_string_sub = sub {
596 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
597 ${$_[0]} =~ s/(['\\])/\\$1/g;
598 ${$_[0]} =~ s/\r/\\r/g;
599 ${$_[0]} =~ s/\n/\\n/g;
600 # prevent premature termination of the script
601 ${$_[0]} =~ s[</script>][<\\/script>]ig;
602 ${$_[0]} = "'". ${$_[0]}. "'";
605 my $defang_sub = sub {
606 ${$_[0]} = $html_defang->defang(${$_[0]});
609 my $fs_interp = new HTML::Mason::Interp (
611 comp_root => $fs_comp_root,
612 escape_flags => { 'js_string' => $js_string_sub,
613 'defang' => $defang_sub,
615 compiler => HTML::Mason::Compiler::ToObject->new(
616 allow_globals => [qw(%session)],
620 my $rt_interp = new HTML::Mason::Interp (
623 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
624 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
626 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
627 'u' => \&RT::Interface::Web::EscapeURI,
628 'j' => \&RT::Interface::Web::EscapeJS,
629 'js_string' => $js_string_sub,
631 compiler => HTML::Mason::Compiler::ToObject->new(
632 default_escape_flags => 'h',
633 allow_globals => [qw(%session $DECODED_ARGS)],
637 ( $fs_interp, $rt_interp );
645 Lurking in the darkness...
649 L<HTML::Mason>, L<FS>, L<RT>