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
128 use FS::CGI qw(header menubar table itable ntable idiot
129 eidiot myexit http_header);
130 use FS::UI::Web qw(svc_url);
131 use FS::UI::Web::small_custview qw(small_custview);
132 use FS::UI::bytecount;
133 use FS::Msgcat qw(gettext geterror);
134 use FS::Misc qw( send_email send_fax ocr_image
135 states_hash counties cities state_label
137 use FS::Misc::eps2png qw( eps2png );
138 use FS::Report::FCC_477;
139 use FS::Report::Table;
140 use FS::Report::Table::Monthly;
141 use FS::Report::Table::Daily;
142 use FS::TicketSystem;
143 use FS::NetworkMonitoringSystem;
144 use FS::Tron qw( tron_lint );
146 use FS::Maketext qw( mt emt js_mt );
150 use FS::domain_record;
152 use FS::cust_bill_pay;
154 use FS::cust_credit_bill;
156 use FS::cust_main::Search qw(smart_search);
157 use FS::cust_main::Import;
158 use FS::cust_main_county;
159 use FS::cust_location;
162 use FS::cust_pkg::Import;
163 use FS::part_pkg_taxclass;
164 use FS::cust_pkg_reason;
166 use FS::cust_credit_refund;
167 use FS::cust_pay_refund;
170 use FS::part_bill_event;
172 use FS::part_event_condition;
174 use FS::part_referral;
176 use FS::part_svc_router;
177 use FS::part_virtual_field;
181 use FS::queue qw(joblisting);
185 use FS::svc_acct_pop qw(popselector);
186 use FS::acct_rt_transaction;
192 use FS::svc_broadband;
193 use FS::svc_external;
196 use FS::part_export_option;
198 use FS::export_device;
205 use FS::payment_gateway;
206 use FS::agent_payment_gateway;
211 use FS::inventory_class;
212 use FS::inventory_item;
213 use FS::pkg_category;
216 use FS::access_user_pref;
217 use FS::access_group;
218 use FS::access_usergroup;
219 use FS::access_groupagent;
220 use FS::access_right;
223 use FS::phone_device;
227 use FS::cust_main_note;
229 use FS::cust_tax_location;
230 use FS::part_pkg_taxproduct;
231 use FS::part_pkg_taxoverride;
232 use FS::part_pkg_taxrate;
234 use FS::part_pkg_report_option;
235 use FS::cust_attachment;
237 use FS::h_inventory_item;
239 use FS::h_svc_broadband;
240 use FS::h_svc_domain;
241 #use FS::h_domain_record;
242 use FS::h_svc_external;
243 use FS::h_svc_forward;
245 #use FS::h_phone_device;
247 use FS::cust_statement;
249 use FS::cust_category;
250 use FS::prospect_main;
255 use FS::cust_pkg_discount;
256 use FS::cust_bill_pkg_discount;
257 use FS::svc_mailinglist;
259 use FS::cgp_rule_condition;
260 use FS::cgp_rule_action;
262 use FS::cust_bill_batch;
264 use FS::rate_time_interval;
265 use FS::msg_template;
268 use FS::part_pkg_discount;
274 use FS::part_pkg_vendor;
275 use FS::cust_note_class;
280 use FS::torrus_srvderive;
281 use FS::torrus_srvderive_component;
285 use FS::svc_hardware;
286 use FS::h_svc_hardware;
287 use FS::hardware_class;
288 use FS::hardware_type;
289 use FS::hardware_status;
290 use FS::did_order_item;
294 use FS::radius_group;
295 use FS::template_content;
300 use FS::legacy_cust_bill;
302 use FS::rate_tier_detail;
304 use FS::discount_plan;
306 use FS::tower_sector;
308 use FS::access_groupsales;
309 use FS::contact_class;
310 use FS::part_svc_class;
314 if ( $FS::Mason::addl_handler_use ) {
315 eval $FS::Mason::addl_handler_use;
319 if ( %%%RT_ENABLED%%% ) {
321 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
322 use vars qw($Nobody $SystemUser);
326 use RT::Transactions;
331 use RT::ScripActions;
332 use RT::ScripConditions;
335 use RT::GroupMembers;
336 use RT::CustomFields;
337 use RT::CustomFieldValues;
338 use RT::ObjectCustomFieldValues;
340 #blah. manually updated from RT::Interface::Web::Handler
341 use RT::Interface::Web;
348 #blah. not even in RT::Interface::Web::Handler, just in
349 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
350 #to throw a real error instead of just a mysterious unstyled RT
351 use CSS::Squish 0.06;
353 use RT::Interface::Web::Request;
355 #nother undeclared web UI dep (for ticket links graph)
356 use IPC::Run::SafeHandles;
358 #slow, unreliable, segfaults and is optional
359 #see rt/html/Ticket/Elements/ShowTransactionAttachments
362 #?#use File::Path qw( rmtree );
363 #?#use File::Glob qw( bsd_glob );
364 #?#use File::Spec::Unix;
370 *CGI::redirect = sub {
373 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
374 (my $x, $cookie) = (shift, shift);
375 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
377 my $location = shift;
381 # false laziness w/below
382 if ( defined(@DBIx::Profile::ISA) ) {
384 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
389 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
391 ( UNIVERSAL::can(dbh, 'sprintProfile')
392 ? encode_entities(dbh->sprintProfile())
393 : 'DBIx::Profile missing sprintProfile method;'.
394 'unpatched or too old?' ).
395 #"\n\n". &sprintAutoProfile(). '</PRE>'.
400 dbh->{'private_profile'} = {};
405 #clear db profile, but normal redirect
406 dbh->{'private_profile'} = {};
407 $m->redirect($location);
412 } else { #normal redirect
414 $m->redirect($location);
423 #carp #should just switch to <& &> syntax
429 $m->comp('/elements/errorpage.html', @_);
432 sub errorpage_popup {
434 $m->comp('/elements/errorpage-popup.html', @_);
438 my( $location ) = @_;
441 #false laziness w/above
442 if ( defined(@DBIx::Profile::ISA) ) {
444 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
449 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
451 ( UNIVERSAL::can(dbh, 'sprintProfile')
452 ? encode_entities(dbh->sprintProfile())
453 : 'DBIx::Profile missing sprintProfile method;'.
454 'unpatched or too old?' ).
455 #"\n\n". &sprintAutoProfile(). '</PRE>'.
460 dbh->{'private_profile'} = {};
464 #clear db profile, but normal redirect
465 dbh->{'private_profile'} = {};
466 $m->redirect($location);
470 } else { #normal redirect
472 $m->redirect($location);
478 } # end package HTML::Mason::Commands;
484 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
486 Returns a list consisting of two HTML::Mason::Interp objects, the first for
487 Freeside pages, and the second for RT pages.
489 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
491 Options and values can be passed following mode. Currently available options
494 I<outbuf> should be set to a scalar reference in standalone mode.
498 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
501 my $mode = shift || 'apache';
504 #my $request_class = 'HTML::Mason::Request'.
505 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
506 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
507 : 'FS::Mason::Request';
509 #not entirely sure it belongs here, but what the hey
510 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
514 # A hook supporting strange legacy ways people (well, SG) have added stuff on
516 my @addl_comp_root = ();
517 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
518 if ( -e $addl_comp_root_file ) {
519 warn "reading $addl_comp_root_file\n";
520 my $text = slurp( $addl_comp_root_file );
521 my @addl = eval $text;
522 if ( @addl && ! $@ ) {
523 @addl_comp_root = @addl;
525 warn "error parsing $addl_comp_root_file: $@\n";
530 scalar(@addl_comp_root)
532 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
535 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
538 request_class => $request_class,
539 data_dir => '%%%MASONDATA%%%',
540 error_mode => 'output',
541 error_format => 'html',
542 ignore_warnings_expr => '.',
545 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
547 my $html_defang = new HTML::Defang (%defang_opts);
549 #false laziness w/ FS::Maketext js_mt
550 my $js_string_sub = sub {
551 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
552 ${$_[0]} =~ s/(['\\])/\\$1/g;
553 ${$_[0]} =~ s/\r/\\r/g;
554 ${$_[0]} =~ s/\n/\\n/g;
555 # prevent premature termination of the script
556 ${$_[0]} =~ s[</script>][<\\/script>]ig;
557 ${$_[0]} = "'". ${$_[0]}. "'";
560 my $defang_sub = sub {
561 ${$_[0]} = $html_defang->defang(${$_[0]});
564 my $fs_interp = new HTML::Mason::Interp (
566 comp_root => $fs_comp_root,
567 escape_flags => { 'js_string' => $js_string_sub,
568 'defang' => $defang_sub,
570 compiler => HTML::Mason::Compiler::ToObject->new(
571 allow_globals => [qw(%session)],
575 my $rt_interp = new HTML::Mason::Interp (
578 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
579 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
581 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
582 'u' => \&RT::Interface::Web::EscapeURI,
583 'j' => \&RT::Interface::Web::EscapeJS,
584 'js_string' => $js_string_sub,
586 compiler => HTML::Mason::Compiler::ToObject->new(
587 default_escape_flags => 'h',
588 allow_globals => [qw(%session)],
592 ( $fs_interp, $rt_interp );
600 Lurking in the darkness...
604 L<HTML::Mason>, L<FS>, L<RT>