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
127 use FS::CGI qw(header menubar table itable ntable idiot
128 eidiot myexit http_header);
129 use FS::UI::Web qw(svc_url);
130 use FS::UI::Web::small_custview qw(small_custview);
131 use FS::UI::bytecount;
132 use FS::Msgcat qw(gettext geterror);
133 use FS::Misc qw( send_email send_fax ocr_image
134 states_hash counties cities state_label
136 use FS::Misc::eps2png qw( eps2png );
137 use FS::Report::FCC_477;
138 use FS::Report::Table;
139 use FS::Report::Table::Monthly;
140 use FS::Report::Table::Daily;
141 use FS::TicketSystem;
142 use FS::NetworkMonitoringSystem;
143 use FS::Tron qw( tron_lint );
145 use FS::Maketext qw( mt emt js_mt );
149 use FS::domain_record;
151 use FS::cust_bill_pay;
153 use FS::cust_credit_bill;
155 use FS::cust_main::Search qw(smart_search);
156 use FS::cust_main::Import;
157 use FS::cust_main_county;
158 use FS::cust_location;
161 use FS::cust_pkg::Import;
162 use FS::part_pkg_taxclass;
163 use FS::cust_pkg_reason;
165 use FS::cust_credit_refund;
166 use FS::cust_pay_refund;
169 use FS::part_bill_event;
171 use FS::part_event_condition;
173 use FS::part_referral;
175 use FS::part_svc_router;
176 use FS::part_virtual_field;
180 use FS::queue qw(joblisting);
184 use FS::svc_acct_pop qw(popselector);
185 use FS::acct_rt_transaction;
191 use FS::svc_broadband;
192 use FS::svc_external;
195 use FS::part_export_option;
197 use FS::export_device;
204 use FS::payment_gateway;
205 use FS::agent_payment_gateway;
210 use FS::inventory_class;
211 use FS::inventory_item;
212 use FS::pkg_category;
215 use FS::access_user_pref;
216 use FS::access_group;
217 use FS::access_usergroup;
218 use FS::access_groupagent;
219 use FS::access_right;
222 use FS::phone_device;
226 use FS::cust_main_note;
228 use FS::cust_tax_location;
229 use FS::part_pkg_taxproduct;
230 use FS::part_pkg_taxoverride;
231 use FS::part_pkg_taxrate;
233 use FS::part_pkg_report_option;
234 use FS::cust_attachment;
236 use FS::h_inventory_item;
238 use FS::h_svc_broadband;
239 use FS::h_svc_domain;
240 #use FS::h_domain_record;
241 use FS::h_svc_external;
242 use FS::h_svc_forward;
244 #use FS::h_phone_device;
246 use FS::cust_statement;
248 use FS::cust_category;
249 use FS::prospect_main;
254 use FS::cust_pkg_discount;
255 use FS::cust_bill_pkg_discount;
256 use FS::svc_mailinglist;
258 use FS::cgp_rule_condition;
259 use FS::cgp_rule_action;
261 use FS::cust_bill_batch;
263 use FS::rate_time_interval;
264 use FS::msg_template;
267 use FS::part_pkg_discount;
273 use FS::part_pkg_vendor;
274 use FS::cust_note_class;
279 use FS::torrus_srvderive;
280 use FS::torrus_srvderive_component;
284 use FS::svc_hardware;
285 use FS::h_svc_hardware;
286 use FS::hardware_class;
287 use FS::hardware_type;
288 use FS::hardware_status;
289 use FS::did_order_item;
293 use FS::radius_group;
294 use FS::template_content;
299 use FS::legacy_cust_bill;
301 use FS::rate_tier_detail;
303 use FS::discount_plan;
305 use FS::tower_sector;
308 if ( $FS::Mason::addl_handler_use ) {
309 eval $FS::Mason::addl_handler_use;
313 if ( %%%RT_ENABLED%%% ) {
315 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
316 use vars qw($Nobody $SystemUser);
320 use RT::Transactions;
325 use RT::ScripActions;
326 use RT::ScripConditions;
329 use RT::GroupMembers;
330 use RT::CustomFields;
331 use RT::CustomFieldValues;
332 use RT::ObjectCustomFieldValues;
334 #blah. manually updated from RT::Interface::Web::Handler
335 use RT::Interface::Web;
342 #blah. not even in RT::Interface::Web::Handler, just in
343 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
344 #to throw a real error instead of just a mysterious unstyled RT
345 use CSS::Squish 0.06;
347 use RT::Interface::Web::Request;
349 #nother undeclared web UI dep (for ticket links graph)
350 use IPC::Run::SafeHandles;
352 #slow, unreliable, segfaults and is optional
353 #see rt/html/Ticket/Elements/ShowTransactionAttachments
356 #?#use File::Path qw( rmtree );
357 #?#use File::Glob qw( bsd_glob );
358 #?#use File::Spec::Unix;
364 *CGI::redirect = sub {
367 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
368 (my $x, $cookie) = (shift, shift);
369 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
371 my $location = shift;
375 # false laziness w/below
376 if ( defined(@DBIx::Profile::ISA) ) {
378 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
383 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
385 ( UNIVERSAL::can(dbh, 'sprintProfile')
386 ? encode_entities(dbh->sprintProfile())
387 : 'DBIx::Profile missing sprintProfile method;'.
388 'unpatched or too old?' ).
389 #"\n\n". &sprintAutoProfile(). '</PRE>'.
394 dbh->{'private_profile'} = {};
399 #clear db profile, but normal redirect
400 dbh->{'private_profile'} = {};
401 $m->redirect($location);
406 } else { #normal redirect
408 $m->redirect($location);
417 #carp #should just switch to <& &> syntax
423 $m->comp('/elements/errorpage.html', @_);
426 sub errorpage_popup {
428 $m->comp('/elements/errorpage-popup.html', @_);
432 my( $location ) = @_;
435 #false laziness w/above
436 if ( defined(@DBIx::Profile::ISA) ) {
438 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
443 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
445 ( UNIVERSAL::can(dbh, 'sprintProfile')
446 ? encode_entities(dbh->sprintProfile())
447 : 'DBIx::Profile missing sprintProfile method;'.
448 'unpatched or too old?' ).
449 #"\n\n". &sprintAutoProfile(). '</PRE>'.
454 dbh->{'private_profile'} = {};
458 #clear db profile, but normal redirect
459 dbh->{'private_profile'} = {};
460 $m->redirect($location);
464 } else { #normal redirect
466 $m->redirect($location);
472 } # end package HTML::Mason::Commands;
478 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
480 Returns a list consisting of two HTML::Mason::Interp objects, the first for
481 Freeside pages, and the second for RT pages.
483 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
485 Options and values can be passed following mode. Currently available options
488 I<outbuf> should be set to a scalar reference in standalone mode.
492 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
495 my $mode = shift || 'apache';
498 #my $request_class = 'HTML::Mason::Request'.
499 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
500 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
501 : 'FS::Mason::Request';
503 #not entirely sure it belongs here, but what the hey
504 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
508 # A hook supporting strange legacy ways people (well, SG) have added stuff on
510 my @addl_comp_root = ();
511 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
512 if ( -e $addl_comp_root_file ) {
513 warn "reading $addl_comp_root_file\n";
514 my $text = slurp( $addl_comp_root_file );
515 my @addl = eval $text;
516 if ( @addl && ! $@ ) {
517 @addl_comp_root = @addl;
519 warn "error parsing $addl_comp_root_file: $@\n";
524 scalar(@addl_comp_root)
526 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
529 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
532 request_class => $request_class,
533 data_dir => '%%%MASONDATA%%%',
534 error_mode => 'output',
535 error_format => 'html',
536 ignore_warnings_expr => '.',
539 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
541 my $html_defang = new HTML::Defang (%defang_opts);
543 #false laziness w/ FS::Maketext js_mt
544 my $js_string_sub = sub {
545 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
546 ${$_[0]} =~ s/(['\\])/\\$1/g;
547 ${$_[0]} =~ s/\r/\\r/g;
548 ${$_[0]} =~ s/\n/\\n/g;
549 # prevent premature termination of the script
550 ${$_[0]} =~ s[</script>][<\\/script>]ig;
551 ${$_[0]} = "'". ${$_[0]}. "'";
554 my $defang_sub = sub {
555 ${$_[0]} = $html_defang->defang(${$_[0]});
558 my $fs_interp = new HTML::Mason::Interp (
560 comp_root => $fs_comp_root,
561 escape_flags => { 'js_string' => $js_string_sub,
562 'defang' => $defang_sub,
564 compiler => HTML::Mason::Compiler::ToObject->new(
565 allow_globals => [qw(%session)],
569 my $rt_interp = new HTML::Mason::Interp (
572 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
573 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
575 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
576 'u' => \&RT::Interface::Web::EscapeURI,
577 'j' => \&RT::Interface::Web::EscapeJS,
578 'js_string' => $js_string_sub,
580 compiler => HTML::Mason::Compiler::ToObject->new(
581 default_escape_flags => 'h',
582 allow_globals => [qw(%session)],
586 ( $fs_interp, $rt_interp );
594 Lurking in the darkness...
598 L<HTML::Mason>, L<FS>, L<RT>