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.39 qw(-private_tempfiles); #3.39 for cpan#37365
50 #use CGI::Carp qw(fatalsToBrowser);
52 use List::Util qw( max min sum );
53 use List::MoreUtils qw( first_index uniq );
54 use Scalar::Util qw( blessed looks_like_number );
61 use DateTime::Format::Strptime;
62 use FS::Misc::DateTime qw( parse_datetime );
63 use FS::Misc::Geo qw( get_district );
64 use Lingua::EN::Inflect qw(PL);
65 Lingua::EN::Inflect::classical names=>0; #Categorys
70 use HTML::TreeBuilder;
71 use HTML::TableExtract qw(tree);
80 use File::Slurp qw( slurp );
81 #not actually using this yet anyway...# use IPC::Run3 0.036;
82 use Net::Whois::Raw qw(whois);
84 eval "use Net::Whois::Raw 0.32 qw(whois)";
88 use Spreadsheet::WriteExcel;
89 use Spreadsheet::WriteExcel::Utility;
90 use OLE::Storage_Lite;
91 use Excel::Writer::XLSX;
92 #use Excel::Writer::XLSX::Utility; #redundant with above
94 use Business::CreditCard 0.30; #for mask-aware cardtype()
98 use Net::Ping::External;
99 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
101 no warnings 'redefine';
102 eval 'sub Net::Ping::External::_ping_linux {
104 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
105 return Net::Ping::External::_ping_system($command, 0);
110 use String::Approx qw(amatch);
111 use Chart::LinesPoints;
115 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
118 #use FS::geocode_Mixin; #for its code2country
119 use Locale::Currency;
120 use Locale::Currency::Format;
121 use Business::US::USPS::WebTools::AddressStandardization;
122 use Geo::GoogleEarth::Pluggable;
124 use Storable qw( nfreeze thaw );
126 use FS::UID qw( dbh datasrc driver_name );
127 use FS::Record qw( qsearch qsearchs fields dbdef
128 str2time_sql str2time_sql_closing
129 midnight_sql regexp_sql
132 use FS::CGI qw(header menubar table itable ntable idiot
133 eidiot myexit http_header);
134 use FS::UI::Web qw(svc_url random_id);
135 use FS::UI::Web::small_custview qw(small_custview);
136 use FS::UI::bytecount;
137 use FS::UI::REST qw( rest_auth rest_uri_remain encode_rest );
138 use FS::Msgcat qw(gettext geterror);
139 use FS::Misc qw( send_email send_fax ocr_image
140 states_hash counties cities state_label
143 use FS::Misc::eps2png qw( eps2png );
144 use FS::Report::FCC_477;
145 use FS::Report::Table;
146 use FS::Report::Table::Monthly;
147 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 );
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;
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;
381 use FS::export_batch;
382 use FS::export_batch_item;
383 use FS::part_pkg_fcc_option;
388 use FS::deploy_zone_block;
389 use FS::deploy_zone_vertex;
392 use FS::circuit_type;
393 use FS::circuit_provider;
394 use FS::circuit_termination;
396 use FS::cust_credit_source_bill_pkg;
397 use FS::prospect_contact;
398 use FS::cust_contact;
399 use FS::legacy_cust_history;
400 use FS::quotation_pkg_tax;
401 use FS::cust_pkg_reason_fee;
402 use FS::part_svc_link;
403 use FS::access_user_log;
404 use FS::report_batch;
405 use FS::report_batch;
406 use FS::report_batch;
407 use FS::report_batch;
408 use FS::password_history;
413 if ( $FS::Mason::addl_handler_use ) {
414 eval $FS::Mason::addl_handler_use;
418 if ( %%%RT_ENABLED%%% ) {
420 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
421 use vars qw($Nobody $SystemUser);
425 use RT::Transactions;
430 use RT::ScripActions;
431 use RT::ScripConditions;
434 use RT::GroupMembers;
435 use RT::CustomFields;
436 use RT::CustomFieldValues;
437 use RT::ObjectCustomFieldValues;
439 use RT::Interface::Web::Handler;
441 #blah. not even in RT::Interface::Web::Handler, just in
442 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
443 #to throw a real error instead of just a mysterious unstyled RT
444 use CSS::Squish 0.06;
446 #another undeclared web UI dep (for ticket links graph)
447 use IPC::Run::SafeHandles;
449 #slow, unreliable, segfaults and is optional
450 #see rt/html/Ticket/Elements/ShowTransactionAttachments
453 #?#use File::Path qw( rmtree );
454 #?#use File::Glob qw( bsd_glob );
455 #?#use File::Spec::Unix;
461 no warnings 'redefine';
462 *CGI::redirect = sub {
465 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
466 (my $x, $cookie) = (shift, shift);
467 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
469 my $location = shift;
473 # false laziness w/below
474 if ( @DBIx::Profile::ISA ) {
476 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
481 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
483 ( UNIVERSAL::can(dbh, 'sprintProfile')
484 ? encode_entities(dbh->sprintProfile())
485 : 'DBIx::Profile missing sprintProfile method;'.
486 'unpatched or too old?' ).
487 #"\n\n". &sprintAutoProfile(). '</PRE>'.
492 dbh->{'private_profile'} = {};
497 #clear db profile, but normal redirect
498 dbh->{'private_profile'} = {};
499 $m->redirect($location);
504 } else { #normal redirect
506 $m->redirect($location);
515 #warn 'include deprecated; use an HTML::Mason <& &> style include (or $m->scomp) at '. $m->callers(0)->path. "\n";
521 $m->comp('/elements/errorpage.html', @_);
524 sub errorpage_popup {
526 $m->comp('/elements/errorpage-popup.html', @_);
530 my( $location ) = @_;
533 #false laziness w/above
534 if ( @DBIx::Profile::ISA ) {
536 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
541 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
543 ( UNIVERSAL::can(dbh, 'sprintProfile')
544 ? encode_entities(dbh->sprintProfile())
545 : 'DBIx::Profile missing sprintProfile method;'.
546 'unpatched or too old?' ).
547 #"\n\n". &sprintAutoProfile(). '</PRE>'.
552 dbh->{'private_profile'} = {};
556 #clear db profile, but normal redirect
557 dbh->{'private_profile'} = {};
558 $m->redirect($location);
562 } else { #normal redirect
564 $m->redirect($location);
570 } # end package HTML::Mason::Commands;
576 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
578 Returns a list consisting of two HTML::Mason::Interp objects, the first for
579 Freeside pages, and the second for RT pages.
581 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
583 Options and values can be passed following mode. Currently available options
586 I<outbuf> should be set to a scalar reference in standalone mode.
590 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
593 my $mode = shift || 'apache';
596 #my $request_class = 'HTML::Mason::Request'.
597 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
598 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
599 : 'FS::Mason::Request';
601 #not entirely sure it belongs here, but what the hey
602 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
606 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
609 request_class => $request_class,
610 data_dir => '%%%MASONDATA%%%',
611 error_mode => 'output',
612 error_format => 'html',
613 ignore_warnings_expr => '.',
616 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
618 my $html_defang = new HTML::Defang (%defang_opts);
620 #false laziness w/ FS::Maketext js_mt
621 my $js_string_sub = sub {
622 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
623 ${$_[0]} =~ s/(['\\])/\\$1/g;
624 ${$_[0]} =~ s/\r/\\r/g;
625 ${$_[0]} =~ s/\n/\\n/g;
626 # prevent premature termination of the script
627 ${$_[0]} =~ s[</script>][<\\/script>]ig;
628 ${$_[0]} = "'". ${$_[0]}. "'";
631 my $defang_sub = sub {
632 ${$_[0]} = $html_defang->defang(${$_[0]});
635 my $fs_interp = new HTML::Mason::Interp (
637 comp_root => $fs_comp_root,
638 escape_flags => { 'js_string' => $js_string_sub,
639 'defang' => $defang_sub,
641 compiler => HTML::Mason::Compiler::ToObject->new(
642 allow_globals => [qw(%session)],
646 my $rt_interp = new HTML::Mason::Interp (
649 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
650 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
652 escape_flags => { 'h' => \&RT::Interface::Web::EscapeHTML,
653 #u and j aren't used anymore? :/
654 'u' => \&RT::Interface::Web::EscapeURI,
655 'j' => \&RT::Interface::Web::EscapeJS,
656 'js_string' => $js_string_sub,
658 compiler => HTML::Mason::Compiler::ToObject->new(
659 default_escape_flags => 'h',
660 allow_globals => [qw(%session $DECODED_ARGS)],
664 ( $fs_interp, $rt_interp );
672 Lurking in the darkness...
676 L<HTML::Mason>, L<FS>, L<RT>