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;
382 if ( $FS::Mason::addl_handler_use ) {
383 eval $FS::Mason::addl_handler_use;
387 if ( %%%RT_ENABLED%%% ) {
389 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
390 use vars qw($Nobody $SystemUser);
394 use RT::Transactions;
399 use RT::ScripActions;
400 use RT::ScripConditions;
403 use RT::GroupMembers;
404 use RT::CustomFields;
405 use RT::CustomFieldValues;
406 use RT::ObjectCustomFieldValues;
408 #blah. manually updated from RT::Interface::Web::Handler
409 use RT::Interface::Web;
416 #blah. not even in RT::Interface::Web::Handler, just in
417 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
418 #to throw a real error instead of just a mysterious unstyled RT
419 use CSS::Squish 0.06;
421 use RT::Interface::Web::Request;
423 #another undeclared web UI dep (for ticket links graph)
424 use IPC::Run::SafeHandles;
426 #slow, unreliable, segfaults and is optional
427 #see rt/html/Ticket/Elements/ShowTransactionAttachments
430 #?#use File::Path qw( rmtree );
431 #?#use File::Glob qw( bsd_glob );
432 #?#use File::Spec::Unix;
438 *CGI::redirect = sub {
441 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
442 (my $x, $cookie) = (shift, shift);
443 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
445 my $location = shift;
449 # false laziness w/below
450 if ( @DBIx::Profile::ISA ) {
452 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
457 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
459 ( UNIVERSAL::can(dbh, 'sprintProfile')
460 ? encode_entities(dbh->sprintProfile())
461 : 'DBIx::Profile missing sprintProfile method;'.
462 'unpatched or too old?' ).
463 #"\n\n". &sprintAutoProfile(). '</PRE>'.
468 dbh->{'private_profile'} = {};
473 #clear db profile, but normal redirect
474 dbh->{'private_profile'} = {};
475 $m->redirect($location);
480 } else { #normal redirect
482 $m->redirect($location);
491 #carp #should just switch to <& &> syntax
497 $m->comp('/elements/errorpage.html', @_);
500 sub errorpage_popup {
502 $m->comp('/elements/errorpage-popup.html', @_);
506 my( $location ) = @_;
509 #false laziness w/above
510 if ( @DBIx::Profile::ISA ) {
512 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
517 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
519 ( UNIVERSAL::can(dbh, 'sprintProfile')
520 ? encode_entities(dbh->sprintProfile())
521 : 'DBIx::Profile missing sprintProfile method;'.
522 'unpatched or too old?' ).
523 #"\n\n". &sprintAutoProfile(). '</PRE>'.
528 dbh->{'private_profile'} = {};
532 #clear db profile, but normal redirect
533 dbh->{'private_profile'} = {};
534 $m->redirect($location);
538 } else { #normal redirect
540 $m->redirect($location);
546 } # end package HTML::Mason::Commands;
552 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
554 Returns a list consisting of two HTML::Mason::Interp objects, the first for
555 Freeside pages, and the second for RT pages.
557 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
559 Options and values can be passed following mode. Currently available options
562 I<outbuf> should be set to a scalar reference in standalone mode.
566 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
569 my $mode = shift || 'apache';
572 #my $request_class = 'HTML::Mason::Request'.
573 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
574 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
575 : 'FS::Mason::Request';
577 #not entirely sure it belongs here, but what the hey
578 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
582 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
585 request_class => $request_class,
586 data_dir => '%%%MASONDATA%%%',
587 error_mode => 'output',
588 error_format => 'html',
589 ignore_warnings_expr => '.',
592 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
594 my $html_defang = new HTML::Defang (%defang_opts);
596 #false laziness w/ FS::Maketext js_mt
597 my $js_string_sub = sub {
598 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
599 ${$_[0]} =~ s/(['\\])/\\$1/g;
600 ${$_[0]} =~ s/\r/\\r/g;
601 ${$_[0]} =~ s/\n/\\n/g;
602 # prevent premature termination of the script
603 ${$_[0]} =~ s[</script>][<\\/script>]ig;
604 ${$_[0]} = "'". ${$_[0]}. "'";
607 my $defang_sub = sub {
608 ${$_[0]} = $html_defang->defang(${$_[0]});
611 my $fs_interp = new HTML::Mason::Interp (
613 comp_root => $fs_comp_root,
614 escape_flags => { 'js_string' => $js_string_sub,
615 'defang' => $defang_sub,
617 compiler => HTML::Mason::Compiler::ToObject->new(
618 allow_globals => [qw(%session)],
622 my $rt_interp = new HTML::Mason::Interp (
625 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
626 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
628 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
629 'u' => \&RT::Interface::Web::EscapeURI,
630 'j' => \&RT::Interface::Web::EscapeJS,
631 'js_string' => $js_string_sub,
633 compiler => HTML::Mason::Compiler::ToObject->new(
634 default_escape_flags => 'h',
635 allow_globals => [qw(%session $DECODED_ARGS)],
639 ( $fs_interp, $rt_interp );
647 Lurking in the darkness...
651 L<HTML::Mason>, L<FS>, L<RT>