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 );
65 use DateTime::Format::Strptime;
66 use FS::Misc::DateTime qw( parse_datetime );
67 use Lingua::EN::Inflect qw(PL);
68 Lingua::EN::Inflect::classical names=>0; #Categorys
73 use HTML::TreeBuilder;
74 use HTML::TableExtract qw(tree);
78 # use XMLRPC::Transport::HTTP;
79 # use XMLRPC::Lite; # for XMLRPC::Serializer
84 #not actually using this yet anyway...# use IPC::Run3 0.036;
85 use Net::Whois::Raw qw(whois);
87 eval "use Net::Whois::Raw 0.32 qw(whois)";
91 use Spreadsheet::WriteExcel;
92 use Spreadsheet::WriteExcel::Utility;
93 use Business::CreditCard 0.30; #for mask-aware cardtype()
96 use Net::Ping::External;
97 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
99 no warnings 'redefine';
100 eval 'sub Net::Ping::External::_ping_linux {
102 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
103 return Net::Ping::External::_ping_system($command, 0);
108 use String::Approx qw(amatch);
109 use Chart::LinesPoints;
113 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
116 use Business::US::USPS::WebTools::AddressStandardization;
118 use Storable qw( nfreeze thaw );
120 use FS::UID qw( getotaker dbh datasrc driver_name );
121 use FS::Record qw( qsearch qsearchs fields dbdef
122 str2time_sql str2time_sql_closing
125 use FS::CGI qw(header menubar table itable ntable idiot
126 eidiot myexit http_header);
127 use FS::UI::Web qw(svc_url);
128 use FS::UI::Web::small_custview qw(small_custview);
129 use FS::UI::bytecount;
130 use FS::Msgcat qw(gettext geterror);
131 use FS::Misc qw( send_email send_fax ocr_image
132 states_hash counties cities state_label
134 use FS::Misc::eps2png qw( eps2png );
135 use FS::Report::FCC_477;
136 use FS::Report::Table::Monthly;
137 use FS::TicketSystem;
138 use FS::NetworkMonitoringSystem;
139 use FS::Tron qw( tron_lint );
143 use FS::domain_record;
145 use FS::cust_bill_pay;
147 use FS::cust_credit_bill;
149 use FS::cust_main::Search qw(smart_search);
150 use FS::cust_main::Import;
151 use FS::cust_main_county;
152 use FS::cust_location;
155 use FS::cust_pkg::Import;
156 use FS::part_pkg_taxclass;
157 use FS::cust_pkg_reason;
159 use FS::cust_credit_refund;
160 use FS::cust_pay_refund;
163 use FS::part_bill_event;
165 use FS::part_event_condition;
167 use FS::part_referral;
169 use FS::part_svc_router;
170 use FS::part_virtual_field;
174 use FS::queue qw(joblisting);
178 use FS::svc_acct_pop qw(popselector);
179 use FS::acct_rt_transaction;
185 use FS::svc_broadband;
186 use FS::svc_external;
189 use FS::part_export_option;
191 use FS::export_device;
198 use FS::payment_gateway;
199 use FS::agent_payment_gateway;
204 use FS::inventory_class;
205 use FS::inventory_item;
206 use FS::pkg_category;
209 use FS::access_user_pref;
210 use FS::access_group;
211 use FS::access_usergroup;
212 use FS::access_groupagent;
213 use FS::access_right;
216 use FS::phone_device;
220 use FS::cust_main_note;
222 use FS::cust_tax_location;
223 use FS::part_pkg_taxproduct;
224 use FS::part_pkg_taxoverride;
225 use FS::part_pkg_taxrate;
227 use FS::part_pkg_report_option;
228 use FS::cust_attachment;
230 use FS::h_inventory_item;
232 use FS::h_svc_broadband;
233 use FS::h_svc_domain;
234 #use FS::h_domain_record;
235 use FS::h_svc_external;
236 use FS::h_svc_forward;
238 #use FS::h_phone_device;
240 use FS::cust_statement;
242 use FS::cust_category;
243 use FS::prospect_main;
248 use FS::cust_pkg_discount;
249 use FS::cust_bill_pkg_discount;
250 use FS::svc_mailinglist;
252 use FS::cgp_rule_condition;
253 use FS::cgp_rule_action;
255 use FS::cust_bill_batch;
257 use FS::rate_time_interval;
258 use FS::msg_template;
261 use FS::part_pkg_discount;
267 use FS::part_pkg_vendor;
268 use FS::cust_note_class;
273 use FS::torrus_srvderive;
274 use FS::torrus_srvderive_component;
278 if ( $FS::Mason::addl_handler_use ) {
279 eval $FS::Mason::addl_handler_use;
283 if ( %%%RT_ENABLED%%% ) {
285 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
286 use vars qw($Nobody $SystemUser);
290 use RT::Transactions;
295 use RT::ScripActions;
296 use RT::ScripConditions;
299 use RT::GroupMembers;
300 use RT::CustomFields;
301 use RT::CustomFieldValues;
302 use RT::ObjectCustomFieldValues;
304 #blah. manually updated from RT::Interface::Web::Handler
305 use RT::Interface::Web;
312 #blah. not even in RT::Interface::Web::Handler, just in
313 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
314 #to throw a real error instead of just a mysterious unstyled RT
315 use CSS::Squish 0.06;
317 use RT::Interface::Web::Request;
319 #nother undeclared web UI dep (for ticket links graph)
320 use IPC::Run::SafeHandles;
322 #slow, unreliable, segfaults and is optional
323 #see rt/html/Ticket/Elements/ShowTransactionAttachments
326 #?#use File::Path qw( rmtree );
327 #?#use File::Glob qw( bsd_glob );
328 #?#use File::Spec::Unix;
334 *CGI::redirect = sub {
337 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
338 (my $x, $cookie) = (shift, shift);
339 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
341 my $location = shift;
345 # false laziness w/below
346 if ( defined(@DBIx::Profile::ISA) ) {
348 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
353 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
355 ( UNIVERSAL::can(dbh, 'sprintProfile')
356 ? encode_entities(dbh->sprintProfile())
357 : 'DBIx::Profile missing sprintProfile method;'.
358 'unpatched or too old?' ).
359 #"\n\n". &sprintAutoProfile(). '</PRE>'.
364 dbh->{'private_profile'} = {};
369 #clear db profile, but normal redirect
370 dbh->{'private_profile'} = {};
371 $m->redirect($location);
376 } else { #normal redirect
378 $m->redirect($location);
387 #carp #should just switch to <& &> syntax
393 $m->comp('/elements/errorpage.html', @_);
396 sub errorpage_popup {
398 $m->comp('/elements/errorpage-popup.html', @_);
402 my( $location ) = @_;
405 #false laziness w/above
406 if ( defined(@DBIx::Profile::ISA) ) {
408 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
413 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
415 ( UNIVERSAL::can(dbh, 'sprintProfile')
416 ? encode_entities(dbh->sprintProfile())
417 : 'DBIx::Profile missing sprintProfile method;'.
418 'unpatched or too old?' ).
419 #"\n\n". &sprintAutoProfile(). '</PRE>'.
424 dbh->{'private_profile'} = {};
428 #clear db profile, but normal redirect
429 dbh->{'private_profile'} = {};
430 $m->redirect($location);
434 } else { #normal redirect
436 $m->redirect($location);
442 } # end package HTML::Mason::Commands;
448 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
450 Returns a list consisting of two HTML::Mason::Interp objects, the first for
451 Freeside pages, and the second for RT pages.
453 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
455 Options and values can be passed following mode. Currently available options
458 I<outbuf> should be set to a scalar reference in standalone mode.
462 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
465 my $mode = shift || 'apache';
468 #my $request_class = 'HTML::Mason::Request'.
469 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
470 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
471 : 'FS::Mason::Request';
473 #not entirely sure it belongs here, but what the hey
474 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
478 # A hook supporting strange legacy ways people (well, SG) have added stuff on
480 my @addl_comp_root = ();
481 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
482 if ( -e $addl_comp_root_file ) {
483 warn "reading $addl_comp_root_file\n";
484 my $text = slurp( $addl_comp_root_file );
485 my @addl = eval $text;
486 if ( @addl && ! $@ ) {
487 @addl_comp_root = @addl;
489 warn "error parsing $addl_comp_root_file: $@\n";
494 scalar(@addl_comp_root)
496 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
499 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
502 request_class => $request_class,
503 data_dir => '%%%MASONDATA%%%',
504 error_mode => 'output',
505 error_format => 'html',
506 ignore_warnings_expr => '.',
509 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
511 my $html_defang = new HTML::Defang (%defang_opts);
513 my $js_string_sub = sub {
514 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
515 ${$_[0]} =~ s/(['\\])/\\$1/g;
516 ${$_[0]} =~ s/\r/\\r/g;
517 ${$_[0]} =~ s/\n/\\n/g;
518 ${$_[0]} = "'". ${$_[0]}. "'";
521 my $fs_interp = new HTML::Mason::Interp (
523 comp_root => $fs_comp_root,
524 escape_flags => { 'js_string' => $js_string_sub,
526 ${$_[0]} = $html_defang->defang(${$_[0]});
529 compiler => HTML::Mason::Compiler::ToObject->new(
530 allow_globals => [qw(%session)],
534 my $rt_interp = new HTML::Mason::Interp (
537 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
538 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
540 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
541 'js_string' => $js_string_sub,
543 compiler => HTML::Mason::Compiler::ToObject->new(
544 default_escape_flags => 'h',
545 allow_globals => [qw(%session)],
549 ( $fs_interp, $rt_interp );
557 Lurking in the darkness...
561 L<HTML::Mason>, L<FS>, L<RT>