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 Scalar::Util qw( blessed );
66 use DateTime::Format::Strptime;
67 use FS::Misc::DateTime qw( parse_datetime );
68 use FS::Misc::Geo qw( get_district );
69 use Lingua::EN::Inflect qw(PL);
70 Lingua::EN::Inflect::classical names=>0; #Categorys
75 use HTML::TreeBuilder;
76 use HTML::TableExtract qw(tree);
80 # use XMLRPC::Transport::HTTP;
81 # use XMLRPC::Lite; # for XMLRPC::Serializer
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()
103 use Net::Ping::External;
104 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
106 no warnings 'redefine';
107 eval 'sub Net::Ping::External::_ping_linux {
109 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
110 return Net::Ping::External::_ping_system($command, 0);
115 use String::Approx qw(amatch);
116 use Chart::LinesPoints;
120 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
123 use Business::US::USPS::WebTools::AddressStandardization;
124 use Geo::GoogleEarth::Pluggable;
126 use Storable qw( nfreeze thaw );
128 use FS::UID qw( getotaker dbh datasrc driver_name );
129 use FS::Record qw( qsearch qsearchs fields dbdef
130 str2time_sql str2time_sql_closing
134 use FS::CGI qw(header menubar table itable ntable idiot
135 eidiot myexit http_header);
136 use FS::UI::Web qw(svc_url);
137 use FS::UI::Web::small_custview qw(small_custview);
138 use FS::UI::bytecount;
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
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;
148 use FS::TicketSystem;
149 use FS::NetworkMonitoringSystem;
150 use FS::Tron qw( tron_lint );
152 use FS::Maketext qw( mt emt js_mt );
156 use FS::domain_record;
158 use FS::cust_bill_pay;
160 use FS::cust_credit_bill;
162 use FS::cust_main::Search qw(smart_search);
163 use FS::cust_main::Import;
164 use FS::cust_main_county;
165 use FS::cust_location;
168 use FS::cust_pkg::Import;
169 use FS::part_pkg_taxclass;
170 use FS::cust_pkg_reason;
172 use FS::cust_credit_refund;
173 use FS::cust_pay_refund;
176 use FS::part_bill_event;
178 use FS::part_event_condition;
180 use FS::part_referral;
182 use FS::part_svc_router;
183 use FS::part_virtual_field;
187 use FS::queue qw(joblisting);
191 use FS::svc_acct_pop qw(popselector);
192 use FS::acct_rt_transaction;
198 use FS::svc_broadband;
199 use FS::svc_external;
202 use FS::part_export_option;
204 use FS::export_device;
211 use FS::payment_gateway;
212 use FS::agent_payment_gateway;
217 use FS::inventory_class;
218 use FS::inventory_item;
219 use FS::pkg_category;
222 use FS::access_user_pref;
223 use FS::access_group;
224 use FS::access_usergroup;
225 use FS::access_groupagent;
226 use FS::access_right;
229 use FS::phone_device;
233 use FS::cust_main_note;
235 use FS::cust_tax_location;
236 use FS::part_pkg_taxproduct;
237 use FS::part_pkg_taxoverride;
238 use FS::part_pkg_taxrate;
240 use FS::part_pkg_report_option;
241 use FS::cust_attachment;
243 use FS::h_inventory_item;
245 use FS::h_svc_broadband;
246 use FS::h_svc_domain;
247 #use FS::h_domain_record;
248 use FS::h_svc_external;
249 use FS::h_svc_forward;
251 #use FS::h_phone_device;
253 use FS::cust_statement;
255 use FS::cust_category;
256 use FS::prospect_main;
261 use FS::cust_pkg_discount;
262 use FS::cust_bill_pkg_discount;
263 use FS::svc_mailinglist;
265 use FS::cgp_rule_condition;
266 use FS::cgp_rule_action;
268 use FS::cust_bill_batch;
270 use FS::rate_time_interval;
271 use FS::msg_template;
274 use FS::part_pkg_discount;
280 use FS::part_pkg_vendor;
281 use FS::cust_note_class;
286 use FS::torrus_srvderive;
287 use FS::torrus_srvderive_component;
291 use FS::svc_hardware;
292 use FS::h_svc_hardware;
293 use FS::hardware_class;
294 use FS::hardware_type;
295 use FS::hardware_status;
296 use FS::did_order_item;
300 use FS::radius_group;
301 use FS::template_content;
306 use FS::legacy_cust_bill;
308 use FS::rate_tier_detail;
310 use FS::discount_plan;
312 use FS::tower_sector;
314 use FS::access_groupsales;
315 use FS::contact_class;
316 use FS::part_svc_class;
317 use FS::upload_target;
319 use FS::quotation_pkg;
320 use FS::quotation_pkg_discount;
321 use FS::cust_bill_void;
322 use FS::cust_bill_pkg_void;
323 use FS::cust_bill_pkg_detail_void;
324 use FS::cust_bill_pkg_display_void;
325 use FS::cust_bill_pkg_tax_location_void;
326 use FS::cust_bill_pkg_tax_rate_location_void;
327 use FS::cust_tax_exempt_pkg_void;
328 use FS::cust_bill_pkg_discount_void;
329 use FS::agent_pkg_class;
330 use FS::svc_export_machine;
331 use FS::GeocodeCache;
334 if ( $FS::Mason::addl_handler_use ) {
335 eval $FS::Mason::addl_handler_use;
339 if ( %%%RT_ENABLED%%% ) {
341 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
342 use vars qw($Nobody $SystemUser);
346 use RT::Transactions;
351 use RT::ScripActions;
352 use RT::ScripConditions;
355 use RT::GroupMembers;
356 use RT::CustomFields;
357 use RT::CustomFieldValues;
358 use RT::ObjectCustomFieldValues;
360 #blah. manually updated from RT::Interface::Web::Handler
361 use RT::Interface::Web;
368 #blah. not even in RT::Interface::Web::Handler, just in
369 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
370 #to throw a real error instead of just a mysterious unstyled RT
371 use CSS::Squish 0.06;
373 use RT::Interface::Web::Request;
375 #another undeclared web UI dep (for ticket links graph)
376 use IPC::Run::SafeHandles;
378 #slow, unreliable, segfaults and is optional
379 #see rt/html/Ticket/Elements/ShowTransactionAttachments
382 #?#use File::Path qw( rmtree );
383 #?#use File::Glob qw( bsd_glob );
384 #?#use File::Spec::Unix;
390 *CGI::redirect = sub {
393 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
394 (my $x, $cookie) = (shift, shift);
395 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
397 my $location = shift;
401 # false laziness w/below
402 if ( defined(@DBIx::Profile::ISA) ) {
404 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
409 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
411 ( UNIVERSAL::can(dbh, 'sprintProfile')
412 ? encode_entities(dbh->sprintProfile())
413 : 'DBIx::Profile missing sprintProfile method;'.
414 'unpatched or too old?' ).
415 #"\n\n". &sprintAutoProfile(). '</PRE>'.
420 dbh->{'private_profile'} = {};
425 #clear db profile, but normal redirect
426 dbh->{'private_profile'} = {};
427 $m->redirect($location);
432 } else { #normal redirect
434 $m->redirect($location);
443 #carp #should just switch to <& &> syntax
449 $m->comp('/elements/errorpage.html', @_);
452 sub errorpage_popup {
454 $m->comp('/elements/errorpage-popup.html', @_);
458 my( $location ) = @_;
461 #false laziness w/above
462 if ( defined(@DBIx::Profile::ISA) ) {
464 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
469 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
471 ( UNIVERSAL::can(dbh, 'sprintProfile')
472 ? encode_entities(dbh->sprintProfile())
473 : 'DBIx::Profile missing sprintProfile method;'.
474 'unpatched or too old?' ).
475 #"\n\n". &sprintAutoProfile(). '</PRE>'.
480 dbh->{'private_profile'} = {};
484 #clear db profile, but normal redirect
485 dbh->{'private_profile'} = {};
486 $m->redirect($location);
490 } else { #normal redirect
492 $m->redirect($location);
498 } # end package HTML::Mason::Commands;
504 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
506 Returns a list consisting of two HTML::Mason::Interp objects, the first for
507 Freeside pages, and the second for RT pages.
509 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
511 Options and values can be passed following mode. Currently available options
514 I<outbuf> should be set to a scalar reference in standalone mode.
518 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
521 my $mode = shift || 'apache';
524 #my $request_class = 'HTML::Mason::Request'.
525 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
526 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
527 : 'FS::Mason::Request';
529 #not entirely sure it belongs here, but what the hey
530 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
534 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
537 request_class => $request_class,
538 data_dir => '%%%MASONDATA%%%',
539 error_mode => 'output',
540 error_format => 'html',
541 ignore_warnings_expr => '.',
544 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
546 my $html_defang = new HTML::Defang (%defang_opts);
548 #false laziness w/ FS::Maketext js_mt
549 my $js_string_sub = sub {
550 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
551 ${$_[0]} =~ s/(['\\])/\\$1/g;
552 ${$_[0]} =~ s/\r/\\r/g;
553 ${$_[0]} =~ s/\n/\\n/g;
554 # prevent premature termination of the script
555 ${$_[0]} =~ s[</script>][<\\/script>]ig;
556 ${$_[0]} = "'". ${$_[0]}. "'";
559 my $defang_sub = sub {
560 ${$_[0]} = $html_defang->defang(${$_[0]});
563 my $fs_interp = new HTML::Mason::Interp (
565 comp_root => $fs_comp_root,
566 escape_flags => { 'js_string' => $js_string_sub,
567 'defang' => $defang_sub,
569 compiler => HTML::Mason::Compiler::ToObject->new(
570 allow_globals => [qw(%session)],
574 my $rt_interp = new HTML::Mason::Interp (
577 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
578 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
580 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
581 'u' => \&RT::Interface::Web::EscapeURI,
582 'j' => \&RT::Interface::Web::EscapeJS,
583 'js_string' => $js_string_sub,
585 compiler => HTML::Mason::Compiler::ToObject->new(
586 default_escape_flags => 'h',
587 allow_globals => [qw(%session $DECODED_ARGS)],
591 ( $fs_interp, $rt_interp );
599 Lurking in the darkness...
603 L<HTML::Mason>, L<FS>, L<RT>