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 use File::Slurp qw( slurp );
87 #not actually using this yet anyway...# use IPC::Run3 0.036;
88 use Net::Whois::Raw qw(whois);
90 eval "use Net::Whois::Raw 0.32 qw(whois)";
94 use Spreadsheet::WriteExcel;
95 use Spreadsheet::WriteExcel::Utility;
96 use OLE::Storage_Lite;
97 use Excel::Writer::XLSX;
98 #use Excel::Writer::XLSX::Utility; #redundant with above
100 use Business::CreditCard 0.30; #for mask-aware cardtype()
102 use Net::MAC::Vendor;
104 use Net::Ping::External;
105 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
107 no warnings 'redefine';
108 eval 'sub Net::Ping::External::_ping_linux {
110 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
111 return Net::Ping::External::_ping_system($command, 0);
116 use String::Approx qw(amatch);
117 use Chart::LinesPoints;
121 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
124 use Locale::Currency;
125 use Locale::Currency::Format;
126 use Business::US::USPS::WebTools::AddressStandardization;
127 use Geo::GoogleEarth::Pluggable;
129 use Storable qw( nfreeze thaw );
131 use FS::UID qw( dbh datasrc driver_name );
132 use FS::Record qw( qsearch qsearchs fields dbdef
133 str2time_sql str2time_sql_closing
137 use FS::CGI qw(header menubar table itable ntable idiot
138 eidiot myexit http_header);
139 use FS::UI::Web qw(svc_url);
140 use FS::UI::Web::small_custview qw(small_custview);
141 use FS::UI::bytecount;
142 use FS::UI::REST qw( rest_auth rest_uri_remain encode_rest );
143 use FS::Msgcat qw(gettext geterror);
144 use FS::Misc qw( send_email send_fax ocr_image
145 states_hash counties cities state_label
147 use FS::Misc::eps2png qw( eps2png );
148 use FS::Report::FCC_477;
149 use FS::Report::Table;
150 use FS::Report::Table::Monthly;
151 use FS::Report::Table::Daily;
153 use FS::TicketSystem;
154 use FS::NetworkMonitoringSystem;
155 use FS::Tron qw( tron_lint );
157 use FS::Maketext qw( mt emt js_mt );
161 use FS::domain_record;
163 use FS::cust_bill_pay;
165 use FS::cust_credit_bill;
168 use FS::cust_main::Search qw(smart_search);
169 use FS::cust_main::Import;
170 use FS::cust_main::Import_Charges;
171 use FS::cust_main_county;
172 use FS::cust_location;
175 use FS::cust_pkg::Import;
176 use FS::part_pkg_taxclass;
177 use FS::cust_pkg_reason;
179 use FS::cust_credit_refund;
180 use FS::cust_pay_refund;
183 use FS::part_bill_event;
185 use FS::part_event_condition;
187 use FS::part_referral;
189 use FS::part_svc_router;
190 use FS::part_virtual_field;
194 use FS::queue qw(joblisting);
198 use FS::svc_acct_pop qw(popselector);
199 use FS::acct_rt_transaction;
205 use FS::svc_broadband;
206 use FS::svc_external;
209 use FS::part_export_option;
211 use FS::export_device;
218 use FS::payment_gateway;
219 use FS::agent_payment_gateway;
223 use FS::inventory_class;
224 use FS::inventory_item;
225 use FS::pkg_category;
228 use FS::access_user_pref;
229 use FS::access_group;
230 use FS::access_usergroup;
231 use FS::access_groupagent;
232 use FS::access_right;
235 use FS::phone_device;
239 use FS::cust_main_note;
241 use FS::cust_tax_location;
242 use FS::part_pkg_taxproduct;
243 use FS::part_pkg_taxoverride;
244 use FS::part_pkg_taxrate;
246 use FS::part_pkg_report_option;
247 use FS::cust_attachment;
249 use FS::h_inventory_item;
251 use FS::h_svc_broadband;
252 use FS::h_svc_domain;
253 #use FS::h_domain_record;
254 use FS::h_svc_external;
255 use FS::h_svc_forward;
257 #use FS::h_phone_device;
259 use FS::cust_statement;
261 use FS::cust_category;
262 use FS::prospect_main;
267 use FS::cust_pkg_discount;
268 use FS::cust_bill_pkg_discount;
269 use FS::svc_mailinglist;
271 use FS::cgp_rule_condition;
272 use FS::cgp_rule_action;
274 use FS::cust_bill_batch;
276 use FS::rate_time_interval;
277 use FS::msg_template;
280 use FS::part_pkg_discount;
286 use FS::part_pkg_vendor;
287 use FS::cust_note_class;
292 use FS::torrus_srvderive;
293 use FS::torrus_srvderive_component;
297 use FS::svc_hardware;
298 use FS::h_svc_hardware;
299 use FS::hardware_class;
300 use FS::hardware_type;
301 use FS::hardware_status;
302 use FS::did_order_item;
306 use FS::radius_group;
307 use FS::template_content;
312 use FS::legacy_cust_bill;
314 use FS::rate_tier_detail;
316 use FS::discount_plan;
318 use FS::tower_sector;
320 use FS::contact_class;
321 use FS::part_svc_class;
322 use FS::upload_target;
324 use FS::quotation_pkg;
325 use FS::quotation_pkg_discount;
326 use FS::cust_bill_void;
327 use FS::cust_bill_pkg_void;
328 use FS::cust_bill_pkg_detail_void;
329 use FS::cust_bill_pkg_display_void;
330 use FS::cust_bill_pkg_tax_location_void;
331 use FS::cust_bill_pkg_tax_rate_location_void;
332 use FS::cust_tax_exempt_pkg_void;
333 use FS::cust_bill_pkg_discount_void;
334 use FS::agent_pkg_class;
335 use FS::svc_export_machine;
336 use FS::GeocodeCache;
339 use FS::part_pkg_usage_class;
340 use FS::cust_pkg_usage;
341 use FS::part_pkg_usage_class;
342 use FS::part_pkg_usage;
343 use FS::cdr_cust_pkg_usage;
344 use FS::part_pkg_msgcat;
346 use FS::agent_currency;
347 use FS::currency_exchange;
348 use FS::part_pkg_currency;
354 use FS::vend_bill_pay;
355 use FS::sales_pkg_class;
358 use FS::invoice_mode;
359 use FS::invoice_conf;
360 use FS::cable_provider;
361 use FS::cust_credit_void;
362 use FS::discount_class;
363 use FS::alarm_system;
365 use FS::alarm_station;
367 use FS::svc_conferencing;
368 use FS::conferencing_type;
369 use FS::conferencing_quality;
371 use FS::part_pkg_usageprice;
372 use FS::cust_pkg_usageprice;
373 use FS::pbx_extension;
375 use FS::extension_device;
376 use FS::cust_main_credit_limit;
377 use FS::cust_event_fee;
379 use FS::cust_bill_pkg_fee;
380 use FS::part_fee_msgcat;
381 use FS::part_fee_usage;
384 use FS::export_batch;
385 use FS::export_batch_item;
386 use FS::part_pkg_fcc_option;
391 use FS::deploy_zone_block;
392 use FS::deploy_zone_vertex;
395 use FS::circuit_type;
396 use FS::circuit_provider;
397 use FS::circuit_termination;
399 use FS::cust_credit_source_bill_pkg;
400 use FS::prospect_contact;
401 use FS::cust_contact;
404 if ( $FS::Mason::addl_handler_use ) {
405 eval $FS::Mason::addl_handler_use;
409 if ( %%%RT_ENABLED%%% ) {
411 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
412 use vars qw($Nobody $SystemUser);
416 use RT::Transactions;
421 use RT::ScripActions;
422 use RT::ScripConditions;
425 use RT::GroupMembers;
426 use RT::CustomFields;
427 use RT::CustomFieldValues;
428 use RT::ObjectCustomFieldValues;
430 #blah. manually updated from RT::Interface::Web::Handler
431 use RT::Interface::Web;
438 #blah. not even in RT::Interface::Web::Handler, just in
439 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
440 #to throw a real error instead of just a mysterious unstyled RT
441 use CSS::Squish 0.06;
443 use RT::Interface::Web::Request;
445 #another undeclared web UI dep (for ticket links graph)
446 use IPC::Run::SafeHandles;
448 #slow, unreliable, segfaults and is optional
449 #see rt/html/Ticket/Elements/ShowTransactionAttachments
452 #?#use File::Path qw( rmtree );
453 #?#use File::Glob qw( bsd_glob );
454 #?#use File::Spec::Unix;
460 *CGI::redirect = sub {
463 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
464 (my $x, $cookie) = (shift, shift);
465 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
467 my $location = shift;
471 # false laziness w/below
472 if ( @DBIx::Profile::ISA ) {
474 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
479 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
481 ( UNIVERSAL::can(dbh, 'sprintProfile')
482 ? encode_entities(dbh->sprintProfile())
483 : 'DBIx::Profile missing sprintProfile method;'.
484 'unpatched or too old?' ).
485 #"\n\n". &sprintAutoProfile(). '</PRE>'.
490 dbh->{'private_profile'} = {};
495 #clear db profile, but normal redirect
496 dbh->{'private_profile'} = {};
497 $m->redirect($location);
502 } else { #normal redirect
504 $m->redirect($location);
513 #carp #should just switch to <& &> syntax
519 $m->comp('/elements/errorpage.html', @_);
522 sub errorpage_popup {
524 $m->comp('/elements/errorpage-popup.html', @_);
528 my( $location ) = @_;
531 #false laziness w/above
532 if ( @DBIx::Profile::ISA ) {
534 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
539 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
541 ( UNIVERSAL::can(dbh, 'sprintProfile')
542 ? encode_entities(dbh->sprintProfile())
543 : 'DBIx::Profile missing sprintProfile method;'.
544 'unpatched or too old?' ).
545 #"\n\n". &sprintAutoProfile(). '</PRE>'.
550 dbh->{'private_profile'} = {};
554 #clear db profile, but normal redirect
555 dbh->{'private_profile'} = {};
556 $m->redirect($location);
560 } else { #normal redirect
562 $m->redirect($location);
568 } # end package HTML::Mason::Commands;
574 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
576 Returns a list consisting of two HTML::Mason::Interp objects, the first for
577 Freeside pages, and the second for RT pages.
579 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
581 Options and values can be passed following mode. Currently available options
584 I<outbuf> should be set to a scalar reference in standalone mode.
588 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
591 my $mode = shift || 'apache';
594 #my $request_class = 'HTML::Mason::Request'.
595 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
596 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
597 : 'FS::Mason::Request';
599 #not entirely sure it belongs here, but what the hey
600 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
604 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
607 request_class => $request_class,
608 data_dir => '%%%MASONDATA%%%',
609 error_mode => 'output',
610 error_format => 'html',
611 ignore_warnings_expr => '.',
614 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
616 my $html_defang = new HTML::Defang (%defang_opts);
618 #false laziness w/ FS::Maketext js_mt
619 my $js_string_sub = sub {
620 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
621 ${$_[0]} =~ s/(['\\])/\\$1/g;
622 ${$_[0]} =~ s/\r/\\r/g;
623 ${$_[0]} =~ s/\n/\\n/g;
624 # prevent premature termination of the script
625 ${$_[0]} =~ s[</script>][<\\/script>]ig;
626 ${$_[0]} = "'". ${$_[0]}. "'";
629 my $defang_sub = sub {
630 ${$_[0]} = $html_defang->defang(${$_[0]});
633 my $fs_interp = new HTML::Mason::Interp (
635 comp_root => $fs_comp_root,
636 escape_flags => { 'js_string' => $js_string_sub,
637 'defang' => $defang_sub,
639 compiler => HTML::Mason::Compiler::ToObject->new(
640 allow_globals => [qw(%session)],
644 my $rt_interp = new HTML::Mason::Interp (
647 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
648 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
650 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
651 'u' => \&RT::Interface::Web::EscapeURI,
652 'j' => \&RT::Interface::Web::EscapeJS,
653 'js_string' => $js_string_sub,
655 compiler => HTML::Mason::Compiler::ToObject->new(
656 default_escape_flags => 'h',
657 allow_globals => [qw(%session $DECODED_ARGS)],
661 ( $fs_interp, $rt_interp );
669 Lurking in the darkness...
673 L<HTML::Mason>, L<FS>, L<RT>