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;
76 # use XMLRPC::Transport::HTTP;
77 # use XMLRPC::Lite; # for XMLRPC::Serializer
82 #not actually using this yet anyway...# use IPC::Run3 0.036;
83 use Net::Whois::Raw qw(whois);
85 eval "use Net::Whois::Raw 0.32 qw(whois)";
89 use Spreadsheet::WriteExcel;
90 use Business::CreditCard 0.30; #for mask-aware cardtype()
93 use Net::Ping::External;
94 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
96 no warnings 'redefine';
97 eval 'sub Net::Ping::External::_ping_linux {
99 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
100 return Net::Ping::External::_ping_system($command, 0);
105 use String::Approx qw(amatch);
106 use Chart::LinesPoints;
110 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
113 use Business::US::USPS::WebTools::AddressStandardization;
115 use FS::UID qw( getotaker dbh datasrc driver_name );
116 use FS::Record qw( qsearch qsearchs fields dbdef
117 str2time_sql str2time_sql_closing
120 use FS::CGI qw(header menubar table itable ntable idiot
121 eidiot myexit http_header);
122 use FS::UI::Web qw(svc_url);
123 use FS::UI::Web::small_custview qw(small_custview);
124 use FS::UI::bytecount;
125 use FS::Msgcat qw(gettext geterror);
126 use FS::Misc qw( send_email send_fax
127 states_hash counties cities state_label
129 use FS::Misc::eps2png qw( eps2png );
130 use FS::Report::FCC_477;
131 use FS::Report::Table::Monthly;
132 use FS::TicketSystem;
133 use FS::Tron qw( tron_lint );
137 use FS::domain_record;
139 use FS::cust_bill_pay;
141 use FS::cust_credit_bill;
142 use FS::cust_main qw(smart_search);
143 use FS::cust_main::Import;
144 use FS::cust_main_county;
145 use FS::cust_location;
148 use FS::part_pkg_taxclass;
149 use FS::cust_pkg_reason;
151 use FS::cust_credit_refund;
152 use FS::cust_pay_refund;
155 use FS::part_bill_event;
157 use FS::part_event_condition;
159 use FS::part_referral;
161 use FS::part_svc_router;
162 use FS::part_virtual_field;
166 use FS::queue qw(joblisting);
170 use FS::svc_acct_pop qw(popselector);
171 use FS::acct_rt_transaction;
177 use FS::svc_broadband;
178 use FS::svc_external;
181 use FS::part_export_option;
183 use FS::export_device;
190 use FS::payment_gateway;
191 use FS::agent_payment_gateway;
196 use FS::inventory_class;
197 use FS::inventory_item;
198 use FS::pkg_category;
201 use FS::access_user_pref;
202 use FS::access_group;
203 use FS::access_usergroup;
204 use FS::access_groupagent;
205 use FS::access_right;
208 use FS::phone_device;
212 use FS::cust_main_note;
214 use FS::cust_tax_location;
215 use FS::part_pkg_taxproduct;
216 use FS::part_pkg_taxoverride;
217 use FS::part_pkg_taxrate;
219 use FS::part_pkg_report_option;
220 use FS::cust_attachment;
222 use FS::h_inventory_item;
224 use FS::h_svc_broadband;
225 use FS::h_svc_domain;
226 #use FS::h_domain_record;
227 use FS::h_svc_external;
228 use FS::h_svc_forward;
230 #use FS::h_phone_device;
232 use FS::cust_statement;
234 use FS::cust_category;
235 use FS::prospect_main;
239 use FS::cust_pkg_discount;
240 use FS::cust_bill_pkg_discount;
241 use FS::svc_mailinglist;
243 use FS::cgp_rule_condition;
244 use FS::cgp_rule_action;
246 use FS::cust_bill_batch;
248 use FS::rate_time_interval;
251 if ( $FS::Mason::addl_handler_use ) {
252 eval $FS::Mason::addl_handler_use;
256 if ( %%%RT_ENABLED%%% ) {
258 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
259 use vars qw($Nobody $SystemUser);
263 use RT::Transactions;
268 use RT::ScripActions;
269 use RT::ScripConditions;
272 use RT::GroupMembers;
273 use RT::CustomFields;
274 use RT::CustomFieldValues;
275 use RT::ObjectCustomFieldValues;
277 #blah. manually updated from RT::Interface::Web::Handler
278 use RT::Interface::Web;
285 #blah. not even in RT::Interface::Web::Handler, just in
286 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
287 #to throw a real error instead of just a mysterious unstyled RT
288 use CSS::Squish 0.06;
290 use RT::Interface::Web::Request;
292 #nother undeclared web UI dep (for ticket links graph)
293 use IPC::Run::SafeHandles;
295 #slow, unreliable, segfaults and is optional
296 #see rt/html/Ticket/Elements/ShowTransactionAttachments
299 #?#use File::Path qw( rmtree );
300 #?#use File::Glob qw( bsd_glob );
301 #?#use File::Spec::Unix;
307 *CGI::redirect = sub {
310 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
311 (my $x, $cookie) = (shift, shift);
312 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
314 my $location = shift;
318 # false laziness w/below
319 if ( defined(@DBIx::Profile::ISA) ) {
321 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
326 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
328 ( UNIVERSAL::can(dbh, 'sprintProfile')
329 ? encode_entities(dbh->sprintProfile())
330 : 'DBIx::Profile missing sprintProfile method;'.
331 'unpatched or too old?' ).
332 #"\n\n". &sprintAutoProfile(). '</PRE>'.
337 dbh->{'private_profile'} = {};
342 #clear db profile, but normal redirect
343 dbh->{'private_profile'} = {};
344 $m->redirect($location);
349 } else { #normal redirect
351 $m->redirect($location);
365 $m->comp('/elements/errorpage.html', @_);
368 sub errorpage_popup {
370 $m->comp('/elements/errorpage-popup.html', @_);
374 my( $location ) = @_;
377 #false laziness w/above
378 if ( defined(@DBIx::Profile::ISA) ) {
380 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
385 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
387 ( UNIVERSAL::can(dbh, 'sprintProfile')
388 ? encode_entities(dbh->sprintProfile())
389 : 'DBIx::Profile missing sprintProfile method;'.
390 'unpatched or too old?' ).
391 #"\n\n". &sprintAutoProfile(). '</PRE>'.
396 dbh->{'private_profile'} = {};
400 #clear db profile, but normal redirect
401 dbh->{'private_profile'} = {};
402 $m->redirect($location);
406 } else { #normal redirect
408 $m->redirect($location);
414 } # end package HTML::Mason::Commands;
420 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
422 Returns a list consisting of two HTML::Mason::Interp objects, the first for
423 Freeside pages, and the second for RT pages.
425 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
427 Options and values can be passed following mode. Currently available options
430 I<outbuf> should be set to a scalar reference in standalone mode.
434 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
437 my $mode = shift || 'apache';
440 #my $request_class = 'HTML::Mason::Request'.
441 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
442 my $request_class = 'FS::Mason::Request';
444 #not entirely sure it belongs here, but what the hey
445 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
449 # A hook supporting strange legacy ways people have added stuff on
451 my @addl_comp_root = ();
452 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
453 if ( -e $addl_comp_root_file ) {
454 warn "reading $addl_comp_root_file\n";
455 my $text = slurp( $addl_comp_root_file );
456 my @addl = eval $text;
457 if ( @addl && ! $@ ) {
458 @addl_comp_root = @addl;
460 warn "error parsing $addl_comp_root_file: $@\n";
465 request_class => $request_class,
466 data_dir => '%%%MASONDATA%%%',
467 error_mode => 'output',
468 error_format => 'html',
469 ignore_warnings_expr => '.',
471 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
472 [ 'rt' =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
477 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
479 my $html_defang = new HTML::Defang (%defang_opts);
481 my $fs_interp = new HTML::Mason::Interp (
483 escape_flags => { 'js_string' => sub {
484 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
485 ${$_[0]} =~ s/(['\\])/\\$1/g;
486 ${$_[0]} =~ s/\n/\\n/g;
487 ${$_[0]} = "'". ${$_[0]}. "'";
490 ${$_[0]} = $html_defang->defang(${$_[0]});
493 compiler => HTML::Mason::Compiler::ToObject->new(
494 allow_globals => [qw(%session)],
498 my $rt_interp = new HTML::Mason::Interp (
500 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8 },
501 compiler => HTML::Mason::Compiler::ToObject->new(
502 default_escape_flags => 'h',
503 allow_globals => [qw(%session)],
507 ( $fs_interp, $rt_interp );
515 Lurking in the darkness...
519 L<HTML::Mason>, L<FS>, L<RT>