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::Tron qw( tron_lint );
142 use FS::domain_record;
144 use FS::cust_bill_pay;
146 use FS::cust_credit_bill;
148 use FS::cust_main::Search qw(smart_search);
149 use FS::cust_main::Import;
150 use FS::cust_main_county;
151 use FS::cust_location;
154 use FS::cust_pkg::Import;
155 use FS::part_pkg_taxclass;
156 use FS::cust_pkg_reason;
158 use FS::cust_credit_refund;
159 use FS::cust_pay_refund;
162 use FS::part_bill_event;
164 use FS::part_event_condition;
166 use FS::part_referral;
168 use FS::part_svc_router;
169 use FS::part_virtual_field;
173 use FS::queue qw(joblisting);
177 use FS::svc_acct_pop qw(popselector);
178 use FS::acct_rt_transaction;
184 use FS::svc_broadband;
185 use FS::svc_external;
188 use FS::part_export_option;
190 use FS::export_device;
197 use FS::payment_gateway;
198 use FS::agent_payment_gateway;
203 use FS::inventory_class;
204 use FS::inventory_item;
205 use FS::pkg_category;
208 use FS::access_user_pref;
209 use FS::access_group;
210 use FS::access_usergroup;
211 use FS::access_groupagent;
212 use FS::access_right;
215 use FS::phone_device;
219 use FS::cust_main_note;
221 use FS::cust_tax_location;
222 use FS::part_pkg_taxproduct;
223 use FS::part_pkg_taxoverride;
224 use FS::part_pkg_taxrate;
226 use FS::part_pkg_report_option;
227 use FS::cust_attachment;
229 use FS::h_inventory_item;
231 use FS::h_svc_broadband;
232 use FS::h_svc_domain;
233 #use FS::h_domain_record;
234 use FS::h_svc_external;
235 use FS::h_svc_forward;
237 #use FS::h_phone_device;
239 use FS::cust_statement;
241 use FS::cust_category;
242 use FS::prospect_main;
246 use FS::cust_pkg_discount;
247 use FS::cust_bill_pkg_discount;
248 use FS::svc_mailinglist;
250 use FS::cgp_rule_condition;
251 use FS::cgp_rule_action;
253 use FS::cust_bill_batch;
255 use FS::rate_time_interval;
256 use FS::msg_template;
259 use FS::part_pkg_discount;
265 use FS::part_pkg_vendor;
266 use FS::cust_note_class;
269 if ( $FS::Mason::addl_handler_use ) {
270 eval $FS::Mason::addl_handler_use;
274 if ( %%%RT_ENABLED%%% ) {
276 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
277 use vars qw($Nobody $SystemUser);
281 use RT::Transactions;
286 use RT::ScripActions;
287 use RT::ScripConditions;
290 use RT::GroupMembers;
291 use RT::CustomFields;
292 use RT::CustomFieldValues;
293 use RT::ObjectCustomFieldValues;
295 #blah. manually updated from RT::Interface::Web::Handler
296 use RT::Interface::Web;
303 #blah. not even in RT::Interface::Web::Handler, just in
304 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
305 #to throw a real error instead of just a mysterious unstyled RT
306 use CSS::Squish 0.06;
308 use RT::Interface::Web::Request;
310 #nother undeclared web UI dep (for ticket links graph)
311 use IPC::Run::SafeHandles;
313 #slow, unreliable, segfaults and is optional
314 #see rt/html/Ticket/Elements/ShowTransactionAttachments
317 #?#use File::Path qw( rmtree );
318 #?#use File::Glob qw( bsd_glob );
319 #?#use File::Spec::Unix;
325 *CGI::redirect = sub {
328 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
329 (my $x, $cookie) = (shift, shift);
330 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
332 my $location = shift;
336 # false laziness w/below
337 if ( defined(@DBIx::Profile::ISA) ) {
339 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
344 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
346 ( UNIVERSAL::can(dbh, 'sprintProfile')
347 ? encode_entities(dbh->sprintProfile())
348 : 'DBIx::Profile missing sprintProfile method;'.
349 'unpatched or too old?' ).
350 #"\n\n". &sprintAutoProfile(). '</PRE>'.
355 dbh->{'private_profile'} = {};
360 #clear db profile, but normal redirect
361 dbh->{'private_profile'} = {};
362 $m->redirect($location);
367 } else { #normal redirect
369 $m->redirect($location);
378 #carp #should just switch to <& &> syntax
384 $m->comp('/elements/errorpage.html', @_);
387 sub errorpage_popup {
389 $m->comp('/elements/errorpage-popup.html', @_);
393 my( $location ) = @_;
396 #false laziness w/above
397 if ( defined(@DBIx::Profile::ISA) ) {
399 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
404 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
406 ( UNIVERSAL::can(dbh, 'sprintProfile')
407 ? encode_entities(dbh->sprintProfile())
408 : 'DBIx::Profile missing sprintProfile method;'.
409 'unpatched or too old?' ).
410 #"\n\n". &sprintAutoProfile(). '</PRE>'.
415 dbh->{'private_profile'} = {};
419 #clear db profile, but normal redirect
420 dbh->{'private_profile'} = {};
421 $m->redirect($location);
425 } else { #normal redirect
427 $m->redirect($location);
433 } # end package HTML::Mason::Commands;
439 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
441 Returns a list consisting of two HTML::Mason::Interp objects, the first for
442 Freeside pages, and the second for RT pages.
444 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
446 Options and values can be passed following mode. Currently available options
449 I<outbuf> should be set to a scalar reference in standalone mode.
453 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
456 my $mode = shift || 'apache';
459 #my $request_class = 'HTML::Mason::Request'.
460 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
461 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
462 : 'FS::Mason::Request';
464 #not entirely sure it belongs here, but what the hey
465 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
469 # A hook supporting strange legacy ways people (well, SG) have added stuff on
471 my @addl_comp_root = ();
472 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
473 if ( -e $addl_comp_root_file ) {
474 warn "reading $addl_comp_root_file\n";
475 my $text = slurp( $addl_comp_root_file );
476 my @addl = eval $text;
477 if ( @addl && ! $@ ) {
478 @addl_comp_root = @addl;
480 warn "error parsing $addl_comp_root_file: $@\n";
485 scalar(@addl_comp_root)
487 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
490 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
493 request_class => $request_class,
494 data_dir => '%%%MASONDATA%%%',
495 error_mode => 'output',
496 error_format => 'html',
497 ignore_warnings_expr => '.',
500 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
502 my $html_defang = new HTML::Defang (%defang_opts);
504 my $js_string_sub = sub {
505 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
506 ${$_[0]} =~ s/(['\\])/\\$1/g;
507 ${$_[0]} =~ s/\r/\\r/g;
508 ${$_[0]} =~ s/\n/\\n/g;
509 ${$_[0]} = "'". ${$_[0]}. "'";
512 my $fs_interp = new HTML::Mason::Interp (
514 comp_root => $fs_comp_root,
515 escape_flags => { 'js_string' => $js_string_sub,
517 ${$_[0]} = $html_defang->defang(${$_[0]});
520 compiler => HTML::Mason::Compiler::ToObject->new(
521 allow_globals => [qw(%session)],
525 my $rt_interp = new HTML::Mason::Interp (
528 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
529 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
531 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
532 'js_string' => $js_string_sub,
534 compiler => HTML::Mason::Compiler::ToObject->new(
535 default_escape_flags => 'h',
536 allow_globals => [qw(%session)],
540 ( $fs_interp, $rt_interp );
548 Lurking in the darkness...
552 L<HTML::Mason>, L<FS>, L<RT>