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 );
65 use DateTime::Format::Strptime;
66 use FS::Misc::DateTime qw( parse_datetime );
67 use FS::Misc::Geo qw( get_censustract get_district );
68 use Lingua::EN::Inflect qw(PL);
69 Lingua::EN::Inflect::classical names=>0; #Categorys
74 use HTML::TreeBuilder;
75 use HTML::TableExtract qw(tree);
79 # use XMLRPC::Transport::HTTP;
80 # use XMLRPC::Lite; # for XMLRPC::Serializer
85 #not actually using this yet anyway...# use IPC::Run3 0.036;
86 use Net::Whois::Raw qw(whois);
88 eval "use Net::Whois::Raw 0.32 qw(whois)";
92 use Spreadsheet::WriteExcel;
93 use Spreadsheet::WriteExcel::Utility;
94 use Business::CreditCard 0.30; #for mask-aware cardtype()
97 use Net::Ping::External;
98 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
100 no warnings 'redefine';
101 eval 'sub Net::Ping::External::_ping_linux {
103 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
104 return Net::Ping::External::_ping_system($command, 0);
109 use String::Approx qw(amatch);
110 use Chart::LinesPoints;
114 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
117 use Business::US::USPS::WebTools::AddressStandardization;
118 use Geo::GoogleEarth::Pluggable;
120 use Storable qw( nfreeze thaw );
122 use FS::UID qw( getotaker dbh datasrc driver_name );
123 use FS::Record qw( qsearch qsearchs fields dbdef
124 str2time_sql str2time_sql_closing
128 use FS::CGI qw(header menubar table itable ntable idiot
129 eidiot myexit http_header);
130 use FS::UI::Web qw(svc_url);
131 use FS::UI::Web::small_custview qw(small_custview);
132 use FS::UI::bytecount;
133 use FS::Msgcat qw(gettext geterror);
134 use FS::Misc qw( send_email send_fax ocr_image
135 states_hash counties cities state_label
137 use FS::Misc::eps2png qw( eps2png );
138 use FS::Report::FCC_477;
139 use FS::Report::Table;
140 use FS::Report::Table::Monthly;
141 use FS::Report::Table::Daily;
142 use FS::TicketSystem;
143 use FS::NetworkMonitoringSystem;
144 use FS::Tron qw( tron_lint );
146 use FS::Maketext qw( mt emt js_mt );
150 use FS::domain_record;
152 use FS::cust_bill_pay;
154 use FS::cust_credit_bill;
156 use FS::cust_main::Search qw(smart_search);
157 use FS::cust_main::Import;
158 use FS::cust_main_county;
159 use FS::cust_location;
162 use FS::cust_pkg::Import;
163 use FS::part_pkg_taxclass;
164 use FS::cust_pkg_reason;
166 use FS::cust_credit_refund;
167 use FS::cust_pay_refund;
170 use FS::part_bill_event;
172 use FS::part_event_condition;
174 use FS::part_referral;
176 use FS::part_svc_router;
177 use FS::part_virtual_field;
181 use FS::queue qw(joblisting);
185 use FS::svc_acct_pop qw(popselector);
186 use FS::acct_rt_transaction;
192 use FS::svc_broadband;
193 use FS::svc_external;
196 use FS::part_export_option;
198 use FS::export_device;
205 use FS::payment_gateway;
206 use FS::agent_payment_gateway;
211 use FS::inventory_class;
212 use FS::inventory_item;
213 use FS::pkg_category;
216 use FS::access_user_pref;
217 use FS::access_group;
218 use FS::access_usergroup;
219 use FS::access_groupagent;
220 use FS::access_right;
223 use FS::phone_device;
227 use FS::cust_main_note;
229 use FS::cust_tax_location;
230 use FS::part_pkg_taxproduct;
231 use FS::part_pkg_taxoverride;
232 use FS::part_pkg_taxrate;
234 use FS::part_pkg_report_option;
235 use FS::cust_attachment;
237 use FS::h_inventory_item;
239 use FS::h_svc_broadband;
240 use FS::h_svc_domain;
241 #use FS::h_domain_record;
242 use FS::h_svc_external;
243 use FS::h_svc_forward;
245 #use FS::h_phone_device;
247 use FS::cust_statement;
249 use FS::cust_category;
250 use FS::prospect_main;
255 use FS::cust_pkg_discount;
256 use FS::cust_bill_pkg_discount;
257 use FS::svc_mailinglist;
259 use FS::cgp_rule_condition;
260 use FS::cgp_rule_action;
262 use FS::cust_bill_batch;
264 use FS::rate_time_interval;
265 use FS::msg_template;
268 use FS::part_pkg_discount;
274 use FS::part_pkg_vendor;
275 use FS::cust_note_class;
280 use FS::torrus_srvderive;
281 use FS::torrus_srvderive_component;
285 use FS::svc_hardware;
286 use FS::h_svc_hardware;
287 use FS::hardware_class;
288 use FS::hardware_type;
289 use FS::hardware_status;
290 use FS::did_order_item;
294 use FS::radius_group;
295 use FS::template_content;
300 use FS::legacy_cust_bill;
302 use FS::rate_tier_detail;
304 use FS::discount_plan;
306 use FS::tower_sector;
308 use FS::access_groupsales;
309 use FS::contact_class;
310 use FS::part_svc_class;
313 use FS::quotation_pkg;
314 use FS::quotation_pkg_discount;
317 if ( $FS::Mason::addl_handler_use ) {
318 eval $FS::Mason::addl_handler_use;
322 if ( %%%RT_ENABLED%%% ) {
324 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
325 use vars qw($Nobody $SystemUser);
329 use RT::Transactions;
334 use RT::ScripActions;
335 use RT::ScripConditions;
338 use RT::GroupMembers;
339 use RT::CustomFields;
340 use RT::CustomFieldValues;
341 use RT::ObjectCustomFieldValues;
343 #blah. manually updated from RT::Interface::Web::Handler
344 use RT::Interface::Web;
351 #blah. not even in RT::Interface::Web::Handler, just in
352 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
353 #to throw a real error instead of just a mysterious unstyled RT
354 use CSS::Squish 0.06;
356 use RT::Interface::Web::Request;
358 #nother undeclared web UI dep (for ticket links graph)
359 use IPC::Run::SafeHandles;
361 #slow, unreliable, segfaults and is optional
362 #see rt/html/Ticket/Elements/ShowTransactionAttachments
365 #?#use File::Path qw( rmtree );
366 #?#use File::Glob qw( bsd_glob );
367 #?#use File::Spec::Unix;
373 *CGI::redirect = sub {
376 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
377 (my $x, $cookie) = (shift, shift);
378 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
380 my $location = shift;
384 # false laziness w/below
385 if ( defined(@DBIx::Profile::ISA) ) {
387 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
392 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
394 ( UNIVERSAL::can(dbh, 'sprintProfile')
395 ? encode_entities(dbh->sprintProfile())
396 : 'DBIx::Profile missing sprintProfile method;'.
397 'unpatched or too old?' ).
398 #"\n\n". &sprintAutoProfile(). '</PRE>'.
403 dbh->{'private_profile'} = {};
408 #clear db profile, but normal redirect
409 dbh->{'private_profile'} = {};
410 $m->redirect($location);
415 } else { #normal redirect
417 $m->redirect($location);
426 #carp #should just switch to <& &> syntax
432 $m->comp('/elements/errorpage.html', @_);
435 sub errorpage_popup {
437 $m->comp('/elements/errorpage-popup.html', @_);
441 my( $location ) = @_;
444 #false laziness w/above
445 if ( defined(@DBIx::Profile::ISA) ) {
447 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
452 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
454 ( UNIVERSAL::can(dbh, 'sprintProfile')
455 ? encode_entities(dbh->sprintProfile())
456 : 'DBIx::Profile missing sprintProfile method;'.
457 'unpatched or too old?' ).
458 #"\n\n". &sprintAutoProfile(). '</PRE>'.
463 dbh->{'private_profile'} = {};
467 #clear db profile, but normal redirect
468 dbh->{'private_profile'} = {};
469 $m->redirect($location);
473 } else { #normal redirect
475 $m->redirect($location);
481 } # end package HTML::Mason::Commands;
487 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
489 Returns a list consisting of two HTML::Mason::Interp objects, the first for
490 Freeside pages, and the second for RT pages.
492 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
494 Options and values can be passed following mode. Currently available options
497 I<outbuf> should be set to a scalar reference in standalone mode.
501 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
504 my $mode = shift || 'apache';
507 #my $request_class = 'HTML::Mason::Request'.
508 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
509 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
510 : 'FS::Mason::Request';
512 #not entirely sure it belongs here, but what the hey
513 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
517 # A hook supporting strange legacy ways people (well, SG) have added stuff on
519 my @addl_comp_root = ();
520 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
521 if ( -e $addl_comp_root_file ) {
522 warn "reading $addl_comp_root_file\n";
523 my $text = slurp( $addl_comp_root_file );
524 my @addl = eval $text;
525 if ( @addl && ! $@ ) {
526 @addl_comp_root = @addl;
528 warn "error parsing $addl_comp_root_file: $@\n";
533 scalar(@addl_comp_root)
535 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
538 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
541 request_class => $request_class,
542 data_dir => '%%%MASONDATA%%%',
543 error_mode => 'output',
544 error_format => 'html',
545 ignore_warnings_expr => '.',
548 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
550 my $html_defang = new HTML::Defang (%defang_opts);
552 #false laziness w/ FS::Maketext js_mt
553 my $js_string_sub = sub {
554 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
555 ${$_[0]} =~ s/(['\\])/\\$1/g;
556 ${$_[0]} =~ s/\r/\\r/g;
557 ${$_[0]} =~ s/\n/\\n/g;
558 # prevent premature termination of the script
559 ${$_[0]} =~ s[</script>][<\\/script>]ig;
560 ${$_[0]} = "'". ${$_[0]}. "'";
563 my $defang_sub = sub {
564 ${$_[0]} = $html_defang->defang(${$_[0]});
567 my $fs_interp = new HTML::Mason::Interp (
569 comp_root => $fs_comp_root,
570 escape_flags => { 'js_string' => $js_string_sub,
571 'defang' => $defang_sub,
573 compiler => HTML::Mason::Compiler::ToObject->new(
574 allow_globals => [qw(%session)],
578 my $rt_interp = new HTML::Mason::Interp (
581 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
582 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
584 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
585 'u' => \&RT::Interface::Web::EscapeURI,
586 'j' => \&RT::Interface::Web::EscapeJS,
587 'js_string' => $js_string_sub,
589 compiler => HTML::Mason::Compiler::ToObject->new(
590 default_escape_flags => 'h',
591 allow_globals => [qw(%session $DECODED_ARGS)],
595 ( $fs_interp, $rt_interp );
603 Lurking in the darkness...
607 L<HTML::Mason>, L<FS>, L<RT>