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;
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;
403 if ( $FS::Mason::addl_handler_use ) {
404 eval $FS::Mason::addl_handler_use;
408 if ( %%%RT_ENABLED%%% ) {
410 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
411 use vars qw($Nobody $SystemUser);
415 use RT::Transactions;
420 use RT::ScripActions;
421 use RT::ScripConditions;
424 use RT::GroupMembers;
425 use RT::CustomFields;
426 use RT::CustomFieldValues;
427 use RT::ObjectCustomFieldValues;
429 #blah. manually updated from RT::Interface::Web::Handler
430 use RT::Interface::Web;
437 #blah. not even in RT::Interface::Web::Handler, just in
438 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
439 #to throw a real error instead of just a mysterious unstyled RT
440 use CSS::Squish 0.06;
442 use RT::Interface::Web::Request;
444 #another undeclared web UI dep (for ticket links graph)
445 use IPC::Run::SafeHandles;
447 #slow, unreliable, segfaults and is optional
448 #see rt/html/Ticket/Elements/ShowTransactionAttachments
451 #?#use File::Path qw( rmtree );
452 #?#use File::Glob qw( bsd_glob );
453 #?#use File::Spec::Unix;
459 *CGI::redirect = sub {
462 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
463 (my $x, $cookie) = (shift, shift);
464 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
466 my $location = shift;
470 # false laziness w/below
471 if ( @DBIx::Profile::ISA ) {
473 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
478 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
480 ( UNIVERSAL::can(dbh, 'sprintProfile')
481 ? encode_entities(dbh->sprintProfile())
482 : 'DBIx::Profile missing sprintProfile method;'.
483 'unpatched or too old?' ).
484 #"\n\n". &sprintAutoProfile(). '</PRE>'.
489 dbh->{'private_profile'} = {};
494 #clear db profile, but normal redirect
495 dbh->{'private_profile'} = {};
496 $m->redirect($location);
501 } else { #normal redirect
503 $m->redirect($location);
512 #carp #should just switch to <& &> syntax
518 $m->comp('/elements/errorpage.html', @_);
521 sub errorpage_popup {
523 $m->comp('/elements/errorpage-popup.html', @_);
527 my( $location ) = @_;
530 #false laziness w/above
531 if ( @DBIx::Profile::ISA ) {
533 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
538 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
540 ( UNIVERSAL::can(dbh, 'sprintProfile')
541 ? encode_entities(dbh->sprintProfile())
542 : 'DBIx::Profile missing sprintProfile method;'.
543 'unpatched or too old?' ).
544 #"\n\n". &sprintAutoProfile(). '</PRE>'.
549 dbh->{'private_profile'} = {};
553 #clear db profile, but normal redirect
554 dbh->{'private_profile'} = {};
555 $m->redirect($location);
559 } else { #normal redirect
561 $m->redirect($location);
567 } # end package HTML::Mason::Commands;
573 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
575 Returns a list consisting of two HTML::Mason::Interp objects, the first for
576 Freeside pages, and the second for RT pages.
578 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
580 Options and values can be passed following mode. Currently available options
583 I<outbuf> should be set to a scalar reference in standalone mode.
587 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
590 my $mode = shift || 'apache';
593 #my $request_class = 'HTML::Mason::Request'.
594 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
595 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
596 : 'FS::Mason::Request';
598 #not entirely sure it belongs here, but what the hey
599 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
603 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
606 request_class => $request_class,
607 data_dir => '%%%MASONDATA%%%',
608 error_mode => 'output',
609 error_format => 'html',
610 ignore_warnings_expr => '.',
613 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
615 my $html_defang = new HTML::Defang (%defang_opts);
617 #false laziness w/ FS::Maketext js_mt
618 my $js_string_sub = sub {
619 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
620 ${$_[0]} =~ s/(['\\])/\\$1/g;
621 ${$_[0]} =~ s/\r/\\r/g;
622 ${$_[0]} =~ s/\n/\\n/g;
623 # prevent premature termination of the script
624 ${$_[0]} =~ s[</script>][<\\/script>]ig;
625 ${$_[0]} = "'". ${$_[0]}. "'";
628 my $defang_sub = sub {
629 ${$_[0]} = $html_defang->defang(${$_[0]});
632 my $fs_interp = new HTML::Mason::Interp (
634 comp_root => $fs_comp_root,
635 escape_flags => { 'js_string' => $js_string_sub,
636 'defang' => $defang_sub,
638 compiler => HTML::Mason::Compiler::ToObject->new(
639 allow_globals => [qw(%session)],
643 my $rt_interp = new HTML::Mason::Interp (
646 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
647 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
649 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
650 'u' => \&RT::Interface::Web::EscapeURI,
651 'j' => \&RT::Interface::Web::EscapeJS,
652 'js_string' => $js_string_sub,
654 compiler => HTML::Mason::Compiler::ToObject->new(
655 default_escape_flags => 'h',
656 allow_globals => [qw(%session $DECODED_ARGS)],
660 ( $fs_interp, $rt_interp );
668 Lurking in the darkness...
672 L<HTML::Mason>, L<FS>, L<RT>