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 get_page_pref set_page_pref);
136 use FS::UI::Web::small_custview qw(small_custview);
137 use FS::UI::bytecount;
138 use FS::UI::REST qw( rest_auth rest_uri_remain encode_rest );
139 use FS::Msgcat qw(gettext geterror);
140 use FS::Misc qw( send_email send_fax ocr_image
141 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;
149 use FS::Report::Tax::ByName;
150 use FS::Report::Tax::All;
151 use FS::TicketSystem;
152 use FS::NetworkMonitoringSystem;
153 use FS::Tron qw( tron_lint );
155 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;
184 use FS::part_event_condition;
186 use FS::part_referral;
188 use FS::part_svc_router;
189 use FS::part_virtual_field;
193 use FS::queue qw(joblisting);
197 use FS::svc_acct_pop qw(popselector);
198 use FS::acct_rt_transaction;
204 use FS::svc_broadband;
205 use FS::svc_external;
208 use FS::part_export_option;
210 use FS::export_device;
217 use FS::payment_gateway;
218 use FS::agent_payment_gateway;
222 use FS::inventory_class;
223 use FS::inventory_item;
224 use FS::pkg_category;
227 use FS::access_user_pref;
228 use FS::access_group;
229 use FS::access_usergroup;
230 use FS::access_groupagent;
231 use FS::access_right;
234 use FS::phone_device;
238 use FS::cust_main_note;
240 use FS::cust_tax_location;
241 use FS::part_pkg_taxproduct;
242 use FS::part_pkg_taxoverride;
243 use FS::part_pkg_taxrate;
245 use FS::part_pkg_report_option;
246 use FS::cust_attachment;
248 use FS::h_inventory_item;
250 use FS::h_svc_broadband;
251 use FS::h_svc_domain;
252 #use FS::h_domain_record;
253 use FS::h_svc_external;
254 use FS::h_svc_forward;
256 #use FS::h_phone_device;
258 use FS::cust_statement;
260 use FS::cust_category;
261 use FS::prospect_main;
266 use FS::cust_pkg_discount;
267 use FS::cust_bill_pkg_discount;
268 use FS::svc_mailinglist;
270 use FS::cgp_rule_condition;
271 use FS::cgp_rule_action;
273 use FS::cust_bill_batch;
275 use FS::rate_time_interval;
276 use FS::msg_template;
279 use FS::part_pkg_discount;
285 use FS::part_pkg_vendor;
286 use FS::cust_note_class;
291 use FS::torrus_srvderive;
292 use FS::torrus_srvderive_component;
296 use FS::svc_hardware;
297 use FS::h_svc_hardware;
298 use FS::hardware_class;
299 use FS::hardware_type;
300 use FS::hardware_status;
301 use FS::did_order_item;
305 use FS::radius_group;
306 use FS::template_content;
311 use FS::legacy_cust_bill;
313 use FS::rate_tier_detail;
315 use FS::discount_plan;
317 use FS::tower_sector;
319 use FS::contact_class;
320 use FS::part_svc_class;
321 use FS::upload_target;
323 use FS::quotation_pkg;
324 use FS::quotation_pkg_discount;
325 use FS::cust_bill_void;
326 use FS::cust_bill_pkg_void;
327 use FS::cust_bill_pkg_detail_void;
328 use FS::cust_bill_pkg_display_void;
329 use FS::cust_bill_pkg_tax_location_void;
330 use FS::cust_bill_pkg_tax_rate_location_void;
331 use FS::cust_tax_exempt_pkg_void;
332 use FS::cust_bill_pkg_discount_void;
333 use FS::agent_pkg_class;
334 use FS::svc_export_machine;
335 use FS::GeocodeCache;
338 use FS::part_pkg_usage_class;
339 use FS::cust_pkg_usage;
340 use FS::part_pkg_usage_class;
341 use FS::part_pkg_usage;
342 use FS::cdr_cust_pkg_usage;
343 use FS::part_pkg_msgcat;
345 use FS::agent_currency;
346 use FS::currency_exchange;
347 use FS::part_pkg_currency;
353 use FS::vend_bill_pay;
354 use FS::sales_pkg_class;
357 use FS::invoice_mode;
358 use FS::invoice_conf;
359 use FS::cable_provider;
360 use FS::cust_credit_void;
361 use FS::discount_class;
362 use FS::alarm_system;
364 use FS::alarm_station;
366 use FS::svc_conferencing;
367 use FS::conferencing_type;
368 use FS::conferencing_quality;
370 use FS::part_pkg_usageprice;
371 use FS::cust_pkg_usageprice;
372 use FS::pbx_extension;
374 use FS::extension_device;
375 use FS::cust_main_credit_limit;
376 use FS::cust_event_fee;
378 use FS::cust_bill_pkg_fee;
379 use FS::part_fee_msgcat;
380 use FS::part_fee_usage;
383 use FS::export_batch;
384 use FS::export_batch_item;
385 use FS::part_pkg_fcc_option;
390 use FS::deploy_zone_block;
391 use FS::deploy_zone_vertex;
394 use FS::circuit_type;
395 use FS::circuit_provider;
396 use FS::circuit_termination;
398 use FS::cust_credit_source_bill_pkg;
399 use FS::prospect_contact;
400 use FS::cust_contact;
401 use FS::legacy_cust_history;
402 use FS::quotation_pkg_tax;
403 use FS::cust_pkg_reason_fee;
404 use FS::part_svc_link;
405 use FS::access_user_log;
406 use FS::report_batch;
407 use FS::report_batch;
408 use FS::report_batch;
409 use FS::report_batch;
410 use FS::password_history;
414 use FS::access_user_page_pref;
417 if ( $FS::Mason::addl_handler_use ) {
418 eval $FS::Mason::addl_handler_use;
422 if ( %%%RT_ENABLED%%% ) {
424 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
425 use vars qw($Nobody $SystemUser);
429 use RT::Transactions;
434 use RT::ScripActions;
435 use RT::ScripConditions;
438 use RT::GroupMembers;
439 use RT::CustomFields;
440 use RT::CustomFieldValues;
441 use RT::ObjectCustomFieldValues;
443 use RT::Interface::Web::Handler;
445 #blah. not even in RT::Interface::Web::Handler, just in
446 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
447 #to throw a real error instead of just a mysterious unstyled RT
448 use CSS::Squish 0.06;
450 #another undeclared web UI dep (for ticket links graph)
451 use IPC::Run::SafeHandles;
453 #slow, unreliable, segfaults and is optional
454 #see rt/html/Ticket/Elements/ShowTransactionAttachments
457 #?#use File::Path qw( rmtree );
458 #?#use File::Glob qw( bsd_glob );
459 #?#use File::Spec::Unix;
465 no warnings 'redefine';
466 *CGI::redirect = sub {
469 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
470 (my $x, $cookie) = (shift, shift);
471 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
473 my $location = shift;
477 # false laziness w/below
478 if ( @DBIx::Profile::ISA ) {
480 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
485 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
487 ( UNIVERSAL::can(dbh, 'sprintProfile')
488 ? encode_entities(dbh->sprintProfile())
489 : 'DBIx::Profile missing sprintProfile method;'.
490 'unpatched or too old?' ).
491 #"\n\n". &sprintAutoProfile(). '</PRE>'.
496 dbh->{'private_profile'} = {};
501 #clear db profile, but normal redirect
502 dbh->{'private_profile'} = {};
503 $m->redirect($location);
508 } else { #normal redirect
510 $m->redirect($location);
519 #warn 'include deprecated; use an HTML::Mason <& &> style include (or $m->scomp) at '. $m->callers(0)->path. "\n";
525 $m->comp('/elements/errorpage.html', @_);
528 sub errorpage_popup {
530 $m->comp('/elements/errorpage-popup.html', @_);
534 my( $location ) = @_;
537 #false laziness w/above
538 if ( @DBIx::Profile::ISA ) {
540 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
545 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
547 ( UNIVERSAL::can(dbh, 'sprintProfile')
548 ? encode_entities(dbh->sprintProfile())
549 : 'DBIx::Profile missing sprintProfile method;'.
550 'unpatched or too old?' ).
551 #"\n\n". &sprintAutoProfile(). '</PRE>'.
556 dbh->{'private_profile'} = {};
560 #clear db profile, but normal redirect
561 dbh->{'private_profile'} = {};
562 $m->redirect($location);
566 } else { #normal redirect
568 $m->redirect($location);
574 } # end package HTML::Mason::Commands;
580 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
582 Returns a list consisting of two HTML::Mason::Interp objects, the first for
583 Freeside pages, and the second for RT pages.
585 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
587 Options and values can be passed following mode. Currently available options
590 I<outbuf> should be set to a scalar reference in standalone mode.
594 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
597 my $mode = shift || 'apache';
600 #my $request_class = 'HTML::Mason::Request'.
601 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
602 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
603 : 'FS::Mason::Request';
605 #not entirely sure it belongs here, but what the hey
606 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
610 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
613 request_class => $request_class,
614 data_dir => '%%%MASONDATA%%%',
615 error_mode => 'output',
616 error_format => 'html',
617 ignore_warnings_expr => '.',
620 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
622 my $html_defang = new HTML::Defang (%defang_opts);
624 #false laziness w/ FS::Maketext js_mt
625 my $js_string_sub = sub {
626 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
627 ${$_[0]} =~ s/(['\\])/\\$1/g;
628 ${$_[0]} =~ s/\r/\\r/g;
629 ${$_[0]} =~ s/\n/\\n/g;
630 # prevent premature termination of the script
631 ${$_[0]} =~ s[</script>][<\\/script>]ig;
632 ${$_[0]} = "'". ${$_[0]}. "'";
635 my $defang_sub = sub {
636 ${$_[0]} = $html_defang->defang(${$_[0]});
639 my $fs_interp = new HTML::Mason::Interp (
641 comp_root => $fs_comp_root,
642 escape_flags => { 'js_string' => $js_string_sub,
643 'defang' => $defang_sub,
645 compiler => HTML::Mason::Compiler::ToObject->new(
646 allow_globals => [qw(%session)],
650 my $rt_interp = new HTML::Mason::Interp (
653 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
654 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
656 escape_flags => { 'h' => \&RT::Interface::Web::EscapeHTML,
657 #u and j aren't used anymore? :/
658 'u' => \&RT::Interface::Web::EscapeURI,
659 'j' => \&RT::Interface::Web::EscapeJS,
660 'js_string' => $js_string_sub,
662 compiler => HTML::Mason::Compiler::ToObject->new(
663 default_escape_flags => 'h',
664 allow_globals => [qw(%session $DECODED_ARGS)],
668 ( $fs_interp, $rt_interp );
676 Lurking in the darkness...
680 L<HTML::Mason>, L<FS>, L<RT>