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);
81 # use XMLRPC::Transport::HTTP;
82 # use XMLRPC::Lite; # for XMLRPC::Serializer
88 #not actually using this yet anyway...# use IPC::Run3 0.036;
89 use Net::Whois::Raw qw(whois);
91 eval "use Net::Whois::Raw 0.32 qw(whois)";
95 use Spreadsheet::WriteExcel;
96 use Spreadsheet::WriteExcel::Utility;
97 use OLE::Storage_Lite;
98 use Excel::Writer::XLSX;
99 #use Excel::Writer::XLSX::Utility; #redundant with above
101 use Business::CreditCard 0.30; #for mask-aware cardtype()
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::Msgcat qw(gettext geterror);
143 use FS::Misc qw( send_email send_fax ocr_image
144 states_hash counties cities state_label
146 use FS::Misc::eps2png qw( eps2png );
147 use FS::Report::FCC_477;
148 use FS::Report::Table;
149 use FS::Report::Table::Monthly;
150 use FS::Report::Table::Daily;
151 use FS::TicketSystem;
152 use FS::NetworkMonitoringSystem;
153 use FS::Tron qw( tron_lint );
155 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_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;
180 use FS::part_bill_event;
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;
221 use FS::inventory_class;
222 use FS::inventory_item;
223 use FS::pkg_category;
226 use FS::access_user_pref;
227 use FS::access_group;
228 use FS::access_usergroup;
229 use FS::access_groupagent;
230 use FS::access_right;
233 use FS::phone_device;
237 use FS::cust_main_note;
239 use FS::cust_tax_location;
240 use FS::part_pkg_taxproduct;
241 use FS::part_pkg_taxoverride;
242 use FS::part_pkg_taxrate;
244 use FS::part_pkg_report_option;
245 use FS::cust_attachment;
247 use FS::h_inventory_item;
249 use FS::h_svc_broadband;
250 use FS::h_svc_domain;
251 #use FS::h_domain_record;
252 use FS::h_svc_external;
253 use FS::h_svc_forward;
255 #use FS::h_phone_device;
257 use FS::cust_statement;
259 use FS::cust_category;
260 use FS::prospect_main;
265 use FS::cust_pkg_discount;
266 use FS::cust_bill_pkg_discount;
267 use FS::svc_mailinglist;
269 use FS::cgp_rule_condition;
270 use FS::cgp_rule_action;
272 use FS::cust_bill_batch;
274 use FS::rate_time_interval;
275 use FS::msg_template;
278 use FS::part_pkg_discount;
284 use FS::part_pkg_vendor;
285 use FS::cust_note_class;
290 use FS::torrus_srvderive;
291 use FS::torrus_srvderive_component;
295 use FS::svc_hardware;
296 use FS::h_svc_hardware;
297 use FS::hardware_class;
298 use FS::hardware_type;
299 use FS::hardware_status;
300 use FS::did_order_item;
304 use FS::radius_group;
305 use FS::template_content;
310 use FS::legacy_cust_bill;
312 use FS::rate_tier_detail;
314 use FS::discount_plan;
316 use FS::tower_sector;
318 use FS::contact_class;
319 use FS::part_svc_class;
320 use FS::upload_target;
322 use FS::quotation_pkg;
323 use FS::quotation_pkg_discount;
324 use FS::cust_bill_void;
325 use FS::cust_bill_pkg_void;
326 use FS::cust_bill_pkg_detail_void;
327 use FS::cust_bill_pkg_display_void;
328 use FS::cust_bill_pkg_tax_location_void;
329 use FS::cust_bill_pkg_tax_rate_location_void;
330 use FS::cust_tax_exempt_pkg_void;
331 use FS::cust_bill_pkg_discount_void;
332 use FS::agent_pkg_class;
333 use FS::svc_export_machine;
334 use FS::GeocodeCache;
337 use FS::part_pkg_usage_class;
338 use FS::cust_pkg_usage;
339 use FS::part_pkg_usage_class;
340 use FS::part_pkg_usage;
341 use FS::cdr_cust_pkg_usage;
342 use FS::part_pkg_msgcat;
344 use FS::agent_currency;
345 use FS::currency_exchange;
346 use FS::part_pkg_currency;
352 use FS::vend_bill_pay;
353 use FS::sales_pkg_class;
356 use FS::invoice_mode;
357 use FS::invoice_conf;
358 use FS::cable_provider;
359 use FS::cust_credit_void;
360 use FS::discount_class;
361 use FS::alarm_system;
363 use FS::alarm_station;
365 use FS::svc_conferencing;
366 use FS::conferencing_type;
367 use FS::conferencing_quality;
369 use FS::part_pkg_usageprice;
370 use FS::cust_pkg_usageprice;
371 use FS::pbx_extension;
373 use FS::extension_device;
376 if ( $FS::Mason::addl_handler_use ) {
377 eval $FS::Mason::addl_handler_use;
381 if ( %%%RT_ENABLED%%% ) {
383 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
384 use vars qw($Nobody $SystemUser);
388 use RT::Transactions;
393 use RT::ScripActions;
394 use RT::ScripConditions;
397 use RT::GroupMembers;
398 use RT::CustomFields;
399 use RT::CustomFieldValues;
400 use RT::ObjectCustomFieldValues;
402 #blah. manually updated from RT::Interface::Web::Handler
403 use RT::Interface::Web;
410 #blah. not even in RT::Interface::Web::Handler, just in
411 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
412 #to throw a real error instead of just a mysterious unstyled RT
413 use CSS::Squish 0.06;
415 use RT::Interface::Web::Request;
417 #another undeclared web UI dep (for ticket links graph)
418 use IPC::Run::SafeHandles;
420 #slow, unreliable, segfaults and is optional
421 #see rt/html/Ticket/Elements/ShowTransactionAttachments
424 #?#use File::Path qw( rmtree );
425 #?#use File::Glob qw( bsd_glob );
426 #?#use File::Spec::Unix;
432 *CGI::redirect = sub {
435 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
436 (my $x, $cookie) = (shift, shift);
437 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
439 my $location = shift;
443 # false laziness w/below
444 if ( @DBIx::Profile::ISA ) {
446 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
451 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
453 ( UNIVERSAL::can(dbh, 'sprintProfile')
454 ? encode_entities(dbh->sprintProfile())
455 : 'DBIx::Profile missing sprintProfile method;'.
456 'unpatched or too old?' ).
457 #"\n\n". &sprintAutoProfile(). '</PRE>'.
462 dbh->{'private_profile'} = {};
467 #clear db profile, but normal redirect
468 dbh->{'private_profile'} = {};
469 $m->redirect($location);
474 } else { #normal redirect
476 $m->redirect($location);
485 #carp #should just switch to <& &> syntax
491 $m->comp('/elements/errorpage.html', @_);
494 sub errorpage_popup {
496 $m->comp('/elements/errorpage-popup.html', @_);
500 my( $location ) = @_;
503 #false laziness w/above
504 if ( @DBIx::Profile::ISA ) {
506 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
511 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
513 ( UNIVERSAL::can(dbh, 'sprintProfile')
514 ? encode_entities(dbh->sprintProfile())
515 : 'DBIx::Profile missing sprintProfile method;'.
516 'unpatched or too old?' ).
517 #"\n\n". &sprintAutoProfile(). '</PRE>'.
522 dbh->{'private_profile'} = {};
526 #clear db profile, but normal redirect
527 dbh->{'private_profile'} = {};
528 $m->redirect($location);
532 } else { #normal redirect
534 $m->redirect($location);
540 } # end package HTML::Mason::Commands;
546 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
548 Returns a list consisting of two HTML::Mason::Interp objects, the first for
549 Freeside pages, and the second for RT pages.
551 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
553 Options and values can be passed following mode. Currently available options
556 I<outbuf> should be set to a scalar reference in standalone mode.
560 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
563 my $mode = shift || 'apache';
566 #my $request_class = 'HTML::Mason::Request'.
567 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
568 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
569 : 'FS::Mason::Request';
571 #not entirely sure it belongs here, but what the hey
572 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
576 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
579 request_class => $request_class,
580 data_dir => '%%%MASONDATA%%%',
581 error_mode => 'output',
582 error_format => 'html',
583 ignore_warnings_expr => '.',
586 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
588 my $html_defang = new HTML::Defang (%defang_opts);
590 #false laziness w/ FS::Maketext js_mt
591 my $js_string_sub = sub {
592 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
593 ${$_[0]} =~ s/(['\\])/\\$1/g;
594 ${$_[0]} =~ s/\r/\\r/g;
595 ${$_[0]} =~ s/\n/\\n/g;
596 # prevent premature termination of the script
597 ${$_[0]} =~ s[</script>][<\\/script>]ig;
598 ${$_[0]} = "'". ${$_[0]}. "'";
601 my $defang_sub = sub {
602 ${$_[0]} = $html_defang->defang(${$_[0]});
605 my $fs_interp = new HTML::Mason::Interp (
607 comp_root => $fs_comp_root,
608 escape_flags => { 'js_string' => $js_string_sub,
609 'defang' => $defang_sub,
611 compiler => HTML::Mason::Compiler::ToObject->new(
612 allow_globals => [qw(%session)],
616 my $rt_interp = new HTML::Mason::Interp (
619 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
620 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
622 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
623 'u' => \&RT::Interface::Web::EscapeURI,
624 'j' => \&RT::Interface::Web::EscapeJS,
625 'js_string' => $js_string_sub,
627 compiler => HTML::Mason::Compiler::ToObject->new(
628 default_escape_flags => 'h',
629 allow_globals => [qw(%session $DECODED_ARGS)],
633 ( $fs_interp, $rt_interp );
641 Lurking in the darkness...
645 L<HTML::Mason>, L<FS>, L<RT>