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;
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::Import_Charges;
168 use FS::cust_main_county;
169 use FS::cust_location;
172 use FS::cust_pkg::Import;
173 use FS::part_pkg_taxclass;
174 use FS::cust_pkg_reason;
176 use FS::cust_credit_refund;
177 use FS::cust_pay_refund;
180 use FS::part_bill_event;
182 use FS::part_event_condition;
184 use FS::part_referral;
186 use FS::part_svc_router;
187 use FS::part_virtual_field;
191 use FS::queue qw(joblisting);
195 use FS::svc_acct_pop qw(popselector);
196 use FS::acct_rt_transaction;
202 use FS::svc_broadband;
203 use FS::svc_external;
206 use FS::part_export_option;
208 use FS::export_device;
215 use FS::payment_gateway;
216 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::agent_currency;
344 use FS::currency_exchange;
345 use FS::part_pkg_currency;
351 use FS::vend_bill_pay;
352 use FS::sales_pkg_class;
355 use FS::invoice_mode;
356 use FS::invoice_conf;
357 use FS::cable_provider;
358 use FS::cust_credit_void;
359 use FS::discount_class;
360 use FS::alarm_system;
362 use FS::alarm_station;
364 use FS::svc_conferencing;
365 use FS::conferencing_type;
366 use FS::conferencing_quality;
368 use FS::part_pkg_usageprice;
369 use FS::cust_pkg_usageprice;
370 use FS::pbx_extension;
372 use FS::extension_device;
373 use FS::cust_main_credit_limit;
374 use FS::cust_event_fee;
376 use FS::cust_bill_pkg_fee;
377 use FS::part_fee_msgcat;
378 use FS::part_fee_usage;
383 if ( $FS::Mason::addl_handler_use ) {
384 eval $FS::Mason::addl_handler_use;
388 if ( %%%RT_ENABLED%%% ) {
390 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
391 use vars qw($Nobody $SystemUser);
395 use RT::Transactions;
400 use RT::ScripActions;
401 use RT::ScripConditions;
404 use RT::GroupMembers;
405 use RT::CustomFields;
406 use RT::CustomFieldValues;
407 use RT::ObjectCustomFieldValues;
409 #blah. manually updated from RT::Interface::Web::Handler
410 use RT::Interface::Web;
417 #blah. not even in RT::Interface::Web::Handler, just in
418 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
419 #to throw a real error instead of just a mysterious unstyled RT
420 use CSS::Squish 0.06;
422 use RT::Interface::Web::Request;
424 #another undeclared web UI dep (for ticket links graph)
425 use IPC::Run::SafeHandles;
427 #slow, unreliable, segfaults and is optional
428 #see rt/html/Ticket/Elements/ShowTransactionAttachments
431 #?#use File::Path qw( rmtree );
432 #?#use File::Glob qw( bsd_glob );
433 #?#use File::Spec::Unix;
439 *CGI::redirect = sub {
442 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
443 (my $x, $cookie) = (shift, shift);
444 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
446 my $location = shift;
450 # false laziness w/below
451 if ( @DBIx::Profile::ISA ) {
453 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
458 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
460 ( UNIVERSAL::can(dbh, 'sprintProfile')
461 ? encode_entities(dbh->sprintProfile())
462 : 'DBIx::Profile missing sprintProfile method;'.
463 'unpatched or too old?' ).
464 #"\n\n". &sprintAutoProfile(). '</PRE>'.
469 dbh->{'private_profile'} = {};
474 #clear db profile, but normal redirect
475 dbh->{'private_profile'} = {};
476 $m->redirect($location);
481 } else { #normal redirect
483 $m->redirect($location);
492 #carp #should just switch to <& &> syntax
498 $m->comp('/elements/errorpage.html', @_);
501 sub errorpage_popup {
503 $m->comp('/elements/errorpage-popup.html', @_);
507 my( $location ) = @_;
510 #false laziness w/above
511 if ( @DBIx::Profile::ISA ) {
513 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
518 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
520 ( UNIVERSAL::can(dbh, 'sprintProfile')
521 ? encode_entities(dbh->sprintProfile())
522 : 'DBIx::Profile missing sprintProfile method;'.
523 'unpatched or too old?' ).
524 #"\n\n". &sprintAutoProfile(). '</PRE>'.
529 dbh->{'private_profile'} = {};
533 #clear db profile, but normal redirect
534 dbh->{'private_profile'} = {};
535 $m->redirect($location);
539 } else { #normal redirect
541 $m->redirect($location);
547 } # end package HTML::Mason::Commands;
553 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
555 Returns a list consisting of two HTML::Mason::Interp objects, the first for
556 Freeside pages, and the second for RT pages.
558 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
560 Options and values can be passed following mode. Currently available options
563 I<outbuf> should be set to a scalar reference in standalone mode.
567 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
570 my $mode = shift || 'apache';
573 #my $request_class = 'HTML::Mason::Request'.
574 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
575 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
576 : 'FS::Mason::Request';
578 #not entirely sure it belongs here, but what the hey
579 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
583 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
586 request_class => $request_class,
587 data_dir => '%%%MASONDATA%%%',
588 error_mode => 'output',
589 error_format => 'html',
590 ignore_warnings_expr => '.',
593 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
595 my $html_defang = new HTML::Defang (%defang_opts);
597 #false laziness w/ FS::Maketext js_mt
598 my $js_string_sub = sub {
599 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
600 ${$_[0]} =~ s/(['\\])/\\$1/g;
601 ${$_[0]} =~ s/\r/\\r/g;
602 ${$_[0]} =~ s/\n/\\n/g;
603 # prevent premature termination of the script
604 ${$_[0]} =~ s[</script>][<\\/script>]ig;
605 ${$_[0]} = "'". ${$_[0]}. "'";
608 my $defang_sub = sub {
609 ${$_[0]} = $html_defang->defang(${$_[0]});
612 my $fs_interp = new HTML::Mason::Interp (
614 comp_root => $fs_comp_root,
615 escape_flags => { 'js_string' => $js_string_sub,
616 'defang' => $defang_sub,
618 compiler => HTML::Mason::Compiler::ToObject->new(
619 allow_globals => [qw(%session)],
623 my $rt_interp = new HTML::Mason::Interp (
626 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
627 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
629 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
630 'u' => \&RT::Interface::Web::EscapeURI,
631 'j' => \&RT::Interface::Web::EscapeJS,
632 'js_string' => $js_string_sub,
634 compiler => HTML::Mason::Compiler::ToObject->new(
635 default_escape_flags => 'h',
636 allow_globals => [qw(%session $DECODED_ARGS)],
640 ( $fs_interp, $rt_interp );
648 Lurking in the darkness...
652 L<HTML::Mason>, L<FS>, L<RT>