4 use vars qw( @ISA @EXPORT_OK $addl_handler_use );
6 use File::Slurp qw( slurp );
7 use HTML::Mason 1.27; #http://www.masonhq.com/?ApacheModPerl2Redirect
8 use HTML::Mason::Interp;
9 use HTML::Mason::Compiler::ToObject;
11 @ISA = qw( Exporter );
12 @EXPORT_OK = qw( mason_interps );
16 FS::Mason - Initialize the Mason environment
20 use FS::Mason qw( mason_interps );
22 my( $fs_interp, $rt_interp ) = mason_interps('apache');
26 my( $fs_interp, $rt_interp ) = mason_interps('standalone'); #XXX name?
30 Initializes the Mason environment, loads all Freeside and RT libraries, etc.
34 $addl_handler_use = '';
35 my $addl_handler_use_file = '%%%FREESIDE_CONF%%%/addl_handler_use.pl';
36 if ( -e $addl_handler_use_file ) {
37 $addl_handler_use = slurp( $addl_handler_use_file );
40 # List of modules that you want to use from components (see Admin
43 package HTML::Mason::Commands;
46 use vars qw( %session );
47 use CGI 3.29 qw(-private_tempfiles); #3.29 to fix RT attachment problems
49 #breaks quick payment entry
50 #http://rt.cpan.org/Public/Bug/Display.html?id=37365
51 die "CGI.pm v3.38 is broken, use any other version >= 3.29".
52 " (Debian 5.0? aptitude remove libcgi-pm-perl)"
53 if $CGI::VERSION == 3.38;
55 #use CGI::Carp qw(fatalsToBrowser);
57 use List::Util qw( max min );
64 use DateTime::Format::Strptime;
65 use FS::Misc::DateTime qw( parse_datetime );
66 use Lingua::EN::Inflect qw(PL);
67 Lingua::EN::Inflect::classical names=>0; #Categorys
72 use HTML::TreeBuilder;
79 #not actually using this yet anyway...# use IPC::Run3 0.036;
80 use Net::Whois::Raw qw(whois);
82 eval "use Net::Whois::Raw 0.32 qw(whois)";
86 use Spreadsheet::WriteExcel;
87 use Business::CreditCard 0.30; #for mask-aware cardtype()
90 use Net::Ping::External;
91 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
93 no warnings 'redefine';
94 eval 'sub Net::Ping::External::_ping_linux {
96 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
97 return Net::Ping::External::_ping_system($command, 0);
102 use String::Approx qw(amatch);
103 use Chart::LinesPoints;
106 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
109 use Business::US::USPS::WebTools::AddressStandardization;
112 use FS::UID qw( getotaker dbh datasrc driver_name );
113 use FS::Record qw( qsearch qsearchs fields dbdef
114 str2time_sql str2time_sql_closing
117 use FS::CGI qw(header menubar table itable ntable idiot
118 eidiot myexit http_header);
119 use FS::UI::Web qw(svc_url);
120 use FS::UI::Web::small_custview qw(small_custview);
121 use FS::UI::bytecount;
122 use FS::Msgcat qw(gettext geterror);
123 use FS::Misc qw( send_email send_fax states_hash counties state_label );
124 use FS::Misc::eps2png qw( eps2png );
125 use FS::Report::FCC_477;
126 use FS::Report::Table::Monthly;
127 use FS::TicketSystem;
128 use FS::Tron qw( tron_lint );
132 use FS::domain_record;
134 use FS::cust_bill_pay;
136 use FS::cust_credit_bill;
137 use FS::cust_main qw(smart_search);
138 use FS::cust_main::Import;
139 use FS::cust_main_county;
140 use FS::cust_location;
143 use FS::part_pkg_taxclass;
144 use FS::cust_pkg_reason;
146 use FS::cust_credit_refund;
147 use FS::cust_pay_refund;
150 use FS::part_bill_event;
152 use FS::part_event_condition;
154 use FS::part_referral;
156 use FS::part_svc_router;
157 use FS::part_virtual_field;
161 use FS::queue qw(joblisting);
165 use FS::svc_acct_pop qw(popselector);
166 use FS::acct_rt_transaction;
172 use FS::svc_broadband;
173 use FS::svc_external;
176 use FS::part_export_option;
178 use FS::export_device;
185 use FS::payment_gateway;
186 use FS::agent_payment_gateway;
191 use FS::inventory_class;
192 use FS::inventory_item;
193 use FS::pkg_category;
196 use FS::access_user_pref;
197 use FS::access_group;
198 use FS::access_usergroup;
199 use FS::access_groupagent;
200 use FS::access_right;
203 use FS::phone_device;
207 use FS::cust_main_note;
209 use FS::cust_tax_location;
210 use FS::part_pkg_taxproduct;
211 use FS::part_pkg_taxoverride;
212 use FS::part_pkg_taxrate;
214 use FS::part_pkg_report_option;
215 use FS::cust_attachment;
218 use FS::h_svc_broadband;
219 use FS::h_svc_domain;
220 #use FS::h_domain_record;
221 use FS::h_svc_external;
222 use FS::h_svc_forward;
224 #use FS::h_phone_device;
226 use FS::cust_statement;
228 use FS::svc_mailinglist;
230 use FS::cgp_rule_condition;
231 use FS::cgp_rule_action;
232 use FS::msg_template;
237 if ( $FS::Mason::addl_handler_use ) {
238 eval $FS::Mason::addl_handler_use;
242 if ( %%%RT_ENABLED%%% ) {
244 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
245 use vars qw($Nobody $SystemUser);
248 use RT::Transactions;
253 use RT::ScripActions;
254 use RT::ScripConditions;
257 use RT::GroupMembers;
258 use RT::CustomFields;
259 use RT::CustomFieldValues;
260 use RT::ObjectCustomFieldValues;
262 #blah. manually updated from RT::Interface::Web::Handler
263 use RT::Interface::Web;
270 #blah. not even in RT::Interface::Web::Handler, just in
271 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
272 #to throw a real error instead of just a mysterious unstyled RT
273 use CSS::Squish 0.06;
275 #slow, unreliable, segfaults and is optional
276 #see rt/html/Ticket/Elements/ShowTransactionAttachments
279 #?#use File::Path qw( rmtree );
280 #?#use File::Glob qw( bsd_glob );
281 #?#use File::Spec::Unix;
287 *CGI::redirect = sub {
290 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
291 (my $x, $cookie) = (shift, shift);
292 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
294 my $location = shift;
298 # false laziness w/below
299 if ( defined(@DBIx::Profile::ISA) ) {
301 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
306 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
308 ( UNIVERSAL::can(dbh, 'sprintProfile')
309 ? encode_entities(dbh->sprintProfile())
310 : 'DBIx::Profile missing sprintProfile method;'.
311 'unpatched or too old?' ).
312 #"\n\n". &sprintAutoProfile(). '</PRE>'.
317 dbh->{'private_profile'} = {};
322 #clear db profile, but normal redirect
323 dbh->{'private_profile'} = {};
324 $m->redirect($location);
329 } else { #normal redirect
331 $m->redirect($location);
345 $m->comp('/elements/errorpage.html', @_);
349 my( $location ) = @_;
352 #false laziness w/above
353 if ( defined(@DBIx::Profile::ISA) ) {
355 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
360 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
362 ( UNIVERSAL::can(dbh, 'sprintProfile')
363 ? encode_entities(dbh->sprintProfile())
364 : 'DBIx::Profile missing sprintProfile method;'.
365 'unpatched or too old?' ).
366 #"\n\n". &sprintAutoProfile(). '</PRE>'.
371 dbh->{'private_profile'} = {};
375 #clear db profile, but normal redirect
376 dbh->{'private_profile'} = {};
377 $m->redirect($location);
381 } else { #normal redirect
383 $m->redirect($location);
389 } # end package HTML::Mason::Commands;
395 =item mason_interps [ MODE ]
397 Returns a list consisting of two HTML::Mason::Interp objects, the first for
398 Freeside pages, and the second for RT pages.
400 #MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
405 my $mode = shift || 'apache';
408 #my $request_class = 'HTML::Mason::Request'.
409 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
410 my $request_class = 'FS::Mason::Request';
412 #not entirely sure it belongs here, but what the hey
413 if ( %%%RT_ENABLED%%% ) {
417 # A hook supporting strange legacy ways people have added stuff on
419 my @addl_comp_root = ();
420 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
421 if ( -e $addl_comp_root_file ) {
422 warn "reading $addl_comp_root_file\n";
423 my $text = slurp( $addl_comp_root_file );
424 my @addl = eval $text;
425 if ( @addl && ! $@ ) {
426 @addl_comp_root = @addl;
428 warn "error parsing $addl_comp_root_file: $@\n";
433 request_class => $request_class,
434 data_dir => '%%%MASONDATA%%%',
435 error_mode => 'output',
436 error_format => 'html',
437 ignore_warnings_expr => '.',
439 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
440 [ 'rt' =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
445 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
447 my $fs_interp = new HTML::Mason::Interp (
449 escape_flags => { 'js_string' => sub {
450 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
451 ${$_[0]} =~ s/(['\\])/\\$1/g;
452 ${$_[0]} =~ s/\r/\\r/g;
453 ${$_[0]} =~ s/\n/\\n/g;
454 ${$_[0]} = "'". ${$_[0]}. "'";
457 compiler => HTML::Mason::Compiler::ToObject->new(
458 allow_globals => [qw(%session)],
462 my $rt_interp = new HTML::Mason::Interp (
464 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8 },
465 compiler => HTML::Mason::Compiler::ToObject->new(
466 default_escape_flags => 'h',
467 allow_globals => [qw(%session)],
471 ( $fs_interp, $rt_interp );
479 Lurking in the darkness...
483 L<HTML::Mason>, L<FS>, L<RT>