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
142 use FS::Misc::eps2png qw( eps2png );
143 use FS::Report::FCC_477;
144 use FS::Report::Table;
145 use FS::Report::Table::Monthly;
146 use FS::Report::Table::Daily;
148 use FS::TicketSystem;
149 use FS::NetworkMonitoringSystem;
150 use FS::Tron qw( tron_lint );
152 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;
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;
380 use FS::export_batch;
381 use FS::export_batch_item;
382 use FS::part_pkg_fcc_option;
387 use FS::deploy_zone_block;
388 use FS::deploy_zone_vertex;
391 use FS::circuit_type;
392 use FS::circuit_provider;
393 use FS::circuit_termination;
395 use FS::cust_credit_source_bill_pkg;
396 use FS::prospect_contact;
397 use FS::cust_contact;
398 use FS::legacy_cust_history;
399 use FS::quotation_pkg_tax;
400 use FS::cust_pkg_reason_fee;
401 use FS::part_svc_link;
402 use FS::access_user_log;
403 use FS::report_batch;
404 use FS::report_batch;
405 use FS::report_batch;
406 use FS::report_batch;
407 use FS::password_history;
412 if ( $FS::Mason::addl_handler_use ) {
413 eval $FS::Mason::addl_handler_use;
417 if ( %%%RT_ENABLED%%% ) {
419 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
420 use vars qw($Nobody $SystemUser);
424 use RT::Transactions;
429 use RT::ScripActions;
430 use RT::ScripConditions;
433 use RT::GroupMembers;
434 use RT::CustomFields;
435 use RT::CustomFieldValues;
436 use RT::ObjectCustomFieldValues;
438 use RT::Interface::Web::Handler;
440 #blah. not even in RT::Interface::Web::Handler, just in
441 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
442 #to throw a real error instead of just a mysterious unstyled RT
443 use CSS::Squish 0.06;
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 no warnings 'redefine';
461 *CGI::redirect = sub {
464 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
465 (my $x, $cookie) = (shift, shift);
466 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
468 my $location = shift;
472 # false laziness w/below
473 if ( @DBIx::Profile::ISA ) {
475 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
480 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
482 ( UNIVERSAL::can(dbh, 'sprintProfile')
483 ? encode_entities(dbh->sprintProfile())
484 : 'DBIx::Profile missing sprintProfile method;'.
485 'unpatched or too old?' ).
486 #"\n\n". &sprintAutoProfile(). '</PRE>'.
491 dbh->{'private_profile'} = {};
496 #clear db profile, but normal redirect
497 dbh->{'private_profile'} = {};
498 $m->redirect($location);
503 } else { #normal redirect
505 $m->redirect($location);
514 #warn 'include deprecated; use an HTML::Mason <& &> style include (or $m->scomp) at '. $m->callers(0)->path. "\n";
520 $m->comp('/elements/errorpage.html', @_);
523 sub errorpage_popup {
525 $m->comp('/elements/errorpage-popup.html', @_);
529 my( $location ) = @_;
532 #false laziness w/above
533 if ( @DBIx::Profile::ISA ) {
535 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
540 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
542 ( UNIVERSAL::can(dbh, 'sprintProfile')
543 ? encode_entities(dbh->sprintProfile())
544 : 'DBIx::Profile missing sprintProfile method;'.
545 'unpatched or too old?' ).
546 #"\n\n". &sprintAutoProfile(). '</PRE>'.
551 dbh->{'private_profile'} = {};
555 #clear db profile, but normal redirect
556 dbh->{'private_profile'} = {};
557 $m->redirect($location);
561 } else { #normal redirect
563 $m->redirect($location);
569 } # end package HTML::Mason::Commands;
575 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
577 Returns a list consisting of two HTML::Mason::Interp objects, the first for
578 Freeside pages, and the second for RT pages.
580 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
582 Options and values can be passed following mode. Currently available options
585 I<outbuf> should be set to a scalar reference in standalone mode.
589 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
592 my $mode = shift || 'apache';
595 #my $request_class = 'HTML::Mason::Request'.
596 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
597 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
598 : 'FS::Mason::Request';
600 #not entirely sure it belongs here, but what the hey
601 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
605 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
608 request_class => $request_class,
609 data_dir => '%%%MASONDATA%%%',
610 error_mode => 'output',
611 error_format => 'html',
612 ignore_warnings_expr => '.',
615 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
617 my $html_defang = new HTML::Defang (%defang_opts);
619 #false laziness w/ FS::Maketext js_mt
620 my $js_string_sub = sub {
621 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
622 ${$_[0]} =~ s/(['\\])/\\$1/g;
623 ${$_[0]} =~ s/\r/\\r/g;
624 ${$_[0]} =~ s/\n/\\n/g;
625 # prevent premature termination of the script
626 ${$_[0]} =~ s[</script>][<\\/script>]ig;
627 ${$_[0]} = "'". ${$_[0]}. "'";
630 my $defang_sub = sub {
631 ${$_[0]} = $html_defang->defang(${$_[0]});
634 my $fs_interp = new HTML::Mason::Interp (
636 comp_root => $fs_comp_root,
637 escape_flags => { 'js_string' => $js_string_sub,
638 'defang' => $defang_sub,
640 compiler => HTML::Mason::Compiler::ToObject->new(
641 allow_globals => [qw(%session)],
645 my $rt_interp = new HTML::Mason::Interp (
648 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
649 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
651 escape_flags => { 'h' => \&RT::Interface::Web::EscapeHTML,
652 #u and j aren't used anymore? :/
653 'u' => \&RT::Interface::Web::EscapeURI,
654 'j' => \&RT::Interface::Web::EscapeJS,
655 'js_string' => $js_string_sub,
657 compiler => HTML::Mason::Compiler::ToObject->new(
658 default_escape_flags => 'h',
659 allow_globals => [qw(%session $DECODED_ARGS)],
663 ( $fs_interp, $rt_interp );
671 Lurking in the darkness...
675 L<HTML::Mason>, L<FS>, L<RT>