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()
101 use Net::MAC::Vendor;
103 use Net::Ping::External;
104 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
106 no warnings 'redefine';
107 eval 'sub Net::Ping::External::_ping_linux {
109 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
110 return Net::Ping::External::_ping_system($command, 0);
115 use String::Approx qw(amatch);
116 use Chart::LinesPoints;
120 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
123 use Locale::Currency;
124 use Locale::Currency::Format;
125 use Business::US::USPS::WebTools::AddressStandardization;
126 use Geo::GoogleEarth::Pluggable;
128 use Storable qw( nfreeze thaw );
130 use FS::UID qw( 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;
151 use FS::TicketSystem;
152 use FS::NetworkMonitoringSystem;
153 use FS::Tron qw( tron_lint );
155 use FS::Maketext qw( mt emt js_mt );
159 use FS::domain_record;
161 use FS::cust_bill_pay;
163 use FS::cust_credit_bill;
166 use FS::cust_main::Search qw(smart_search);
167 use FS::cust_main::Import;
168 use FS::cust_main::Import_Charges;
169 use FS::cust_main_county;
170 use FS::cust_location;
173 use FS::cust_pkg::Import;
174 use FS::part_pkg_taxclass;
175 use FS::cust_pkg_reason;
177 use FS::cust_credit_refund;
178 use FS::cust_pay_refund;
181 use FS::part_bill_event;
183 use FS::part_event_condition;
185 use FS::part_referral;
187 use FS::part_svc_router;
188 use FS::part_virtual_field;
192 use FS::queue qw(joblisting);
196 use FS::svc_acct_pop qw(popselector);
197 use FS::acct_rt_transaction;
203 use FS::svc_broadband;
204 use FS::svc_external;
207 use FS::part_export_option;
209 use FS::export_device;
216 use FS::payment_gateway;
217 use FS::agent_payment_gateway;
221 use FS::inventory_class;
222 use FS::inventory_item;
223 use FS::pkg_category;
226 use FS::access_user_pref;
227 use FS::access_group;
228 use FS::access_usergroup;
229 use FS::access_groupagent;
230 use FS::access_right;
233 use FS::phone_device;
237 use FS::cust_main_note;
239 use FS::cust_tax_location;
240 use FS::part_pkg_taxproduct;
241 use FS::part_pkg_taxoverride;
242 use FS::part_pkg_taxrate;
244 use FS::part_pkg_report_option;
245 use FS::cust_attachment;
247 use FS::h_inventory_item;
249 use FS::h_svc_broadband;
250 use FS::h_svc_domain;
251 #use FS::h_domain_record;
252 use FS::h_svc_external;
253 use FS::h_svc_forward;
255 #use FS::h_phone_device;
257 use FS::cust_statement;
259 use FS::cust_category;
260 use FS::prospect_main;
265 use FS::cust_pkg_discount;
266 use FS::cust_bill_pkg_discount;
267 use FS::svc_mailinglist;
269 use FS::cgp_rule_condition;
270 use FS::cgp_rule_action;
272 use FS::cust_bill_batch;
274 use FS::rate_time_interval;
275 use FS::msg_template;
278 use FS::part_pkg_discount;
284 use FS::part_pkg_vendor;
285 use FS::cust_note_class;
290 use FS::torrus_srvderive;
291 use FS::torrus_srvderive_component;
295 use FS::svc_hardware;
296 use FS::h_svc_hardware;
297 use FS::hardware_class;
298 use FS::hardware_type;
299 use FS::hardware_status;
300 use FS::did_order_item;
304 use FS::radius_group;
305 use FS::template_content;
310 use FS::legacy_cust_bill;
312 use FS::rate_tier_detail;
314 use FS::discount_plan;
316 use FS::tower_sector;
318 use FS::contact_class;
319 use FS::part_svc_class;
320 use FS::upload_target;
322 use FS::quotation_pkg;
323 use FS::quotation_pkg_discount;
324 use FS::cust_bill_void;
325 use FS::cust_bill_pkg_void;
326 use FS::cust_bill_pkg_detail_void;
327 use FS::cust_bill_pkg_display_void;
328 use FS::cust_bill_pkg_tax_location_void;
329 use FS::cust_bill_pkg_tax_rate_location_void;
330 use FS::cust_tax_exempt_pkg_void;
331 use FS::cust_bill_pkg_discount_void;
332 use FS::agent_pkg_class;
333 use FS::svc_export_machine;
334 use FS::GeocodeCache;
337 use FS::part_pkg_usage_class;
338 use FS::cust_pkg_usage;
339 use FS::part_pkg_usage_class;
340 use FS::part_pkg_usage;
341 use FS::cdr_cust_pkg_usage;
342 use FS::part_pkg_msgcat;
344 use FS::agent_currency;
345 use FS::currency_exchange;
346 use FS::part_pkg_currency;
352 use FS::vend_bill_pay;
353 use FS::sales_pkg_class;
356 use FS::invoice_mode;
357 use FS::invoice_conf;
358 use FS::cable_provider;
359 use FS::cust_credit_void;
360 use FS::discount_class;
361 use FS::alarm_system;
363 use FS::alarm_station;
365 use FS::svc_conferencing;
366 use FS::conferencing_type;
367 use FS::conferencing_quality;
369 use FS::part_pkg_usageprice;
370 use FS::cust_pkg_usageprice;
371 use FS::pbx_extension;
373 use FS::extension_device;
374 use FS::cust_main_credit_limit;
375 use FS::cust_event_fee;
377 use FS::cust_bill_pkg_fee;
378 use FS::part_fee_msgcat;
379 use FS::part_fee_usage;
382 use FS::export_batch;
383 use FS::export_batch_item;
386 if ( $FS::Mason::addl_handler_use ) {
387 eval $FS::Mason::addl_handler_use;
391 if ( %%%RT_ENABLED%%% ) {
393 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
394 use vars qw($Nobody $SystemUser);
398 use RT::Transactions;
403 use RT::ScripActions;
404 use RT::ScripConditions;
407 use RT::GroupMembers;
408 use RT::CustomFields;
409 use RT::CustomFieldValues;
410 use RT::ObjectCustomFieldValues;
412 #blah. manually updated from RT::Interface::Web::Handler
413 use RT::Interface::Web;
420 #blah. not even in RT::Interface::Web::Handler, just in
421 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
422 #to throw a real error instead of just a mysterious unstyled RT
423 use CSS::Squish 0.06;
425 use RT::Interface::Web::Request;
427 #another undeclared web UI dep (for ticket links graph)
428 use IPC::Run::SafeHandles;
430 #slow, unreliable, segfaults and is optional
431 #see rt/html/Ticket/Elements/ShowTransactionAttachments
434 #?#use File::Path qw( rmtree );
435 #?#use File::Glob qw( bsd_glob );
436 #?#use File::Spec::Unix;
442 *CGI::redirect = sub {
445 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
446 (my $x, $cookie) = (shift, shift);
447 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
449 my $location = shift;
453 # false laziness w/below
454 if ( @DBIx::Profile::ISA ) {
456 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
461 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
463 ( UNIVERSAL::can(dbh, 'sprintProfile')
464 ? encode_entities(dbh->sprintProfile())
465 : 'DBIx::Profile missing sprintProfile method;'.
466 'unpatched or too old?' ).
467 #"\n\n". &sprintAutoProfile(). '</PRE>'.
472 dbh->{'private_profile'} = {};
477 #clear db profile, but normal redirect
478 dbh->{'private_profile'} = {};
479 $m->redirect($location);
484 } else { #normal redirect
486 $m->redirect($location);
495 #carp #should just switch to <& &> syntax
501 $m->comp('/elements/errorpage.html', @_);
504 sub errorpage_popup {
506 $m->comp('/elements/errorpage-popup.html', @_);
510 my( $location ) = @_;
513 #false laziness w/above
514 if ( @DBIx::Profile::ISA ) {
516 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
521 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
523 ( UNIVERSAL::can(dbh, 'sprintProfile')
524 ? encode_entities(dbh->sprintProfile())
525 : 'DBIx::Profile missing sprintProfile method;'.
526 'unpatched or too old?' ).
527 #"\n\n". &sprintAutoProfile(). '</PRE>'.
532 dbh->{'private_profile'} = {};
536 #clear db profile, but normal redirect
537 dbh->{'private_profile'} = {};
538 $m->redirect($location);
542 } else { #normal redirect
544 $m->redirect($location);
550 } # end package HTML::Mason::Commands;
556 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
558 Returns a list consisting of two HTML::Mason::Interp objects, the first for
559 Freeside pages, and the second for RT pages.
561 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
563 Options and values can be passed following mode. Currently available options
566 I<outbuf> should be set to a scalar reference in standalone mode.
570 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
573 my $mode = shift || 'apache';
576 #my $request_class = 'HTML::Mason::Request'.
577 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
578 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
579 : 'FS::Mason::Request';
581 #not entirely sure it belongs here, but what the hey
582 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
586 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
589 request_class => $request_class,
590 data_dir => '%%%MASONDATA%%%',
591 error_mode => 'output',
592 error_format => 'html',
593 ignore_warnings_expr => '.',
596 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
598 my $html_defang = new HTML::Defang (%defang_opts);
600 #false laziness w/ FS::Maketext js_mt
601 my $js_string_sub = sub {
602 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
603 ${$_[0]} =~ s/(['\\])/\\$1/g;
604 ${$_[0]} =~ s/\r/\\r/g;
605 ${$_[0]} =~ s/\n/\\n/g;
606 # prevent premature termination of the script
607 ${$_[0]} =~ s[</script>][<\\/script>]ig;
608 ${$_[0]} = "'". ${$_[0]}. "'";
611 my $defang_sub = sub {
612 ${$_[0]} = $html_defang->defang(${$_[0]});
615 my $fs_interp = new HTML::Mason::Interp (
617 comp_root => $fs_comp_root,
618 escape_flags => { 'js_string' => $js_string_sub,
619 'defang' => $defang_sub,
621 compiler => HTML::Mason::Compiler::ToObject->new(
622 allow_globals => [qw(%session)],
626 my $rt_interp = new HTML::Mason::Interp (
629 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
630 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
632 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
633 'u' => \&RT::Interface::Web::EscapeURI,
634 'j' => \&RT::Interface::Web::EscapeJS,
635 'js_string' => $js_string_sub,
637 compiler => HTML::Mason::Compiler::ToObject->new(
638 default_escape_flags => 'h',
639 allow_globals => [qw(%session $DECODED_ARGS)],
643 ( $fs_interp, $rt_interp );
651 Lurking in the darkness...
655 L<HTML::Mason>, L<FS>, L<RT>