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;
117 use Geo::GoogleEarth::Pluggable;
119 use Storable qw( nfreeze thaw );
121 use FS::UID qw( getotaker dbh datasrc driver_name );
122 use FS::Record qw( qsearch qsearchs fields dbdef
123 str2time_sql str2time_sql_closing
126 use FS::CGI qw(header menubar table itable ntable idiot
127 eidiot myexit http_header);
128 use FS::UI::Web qw(svc_url);
129 use FS::UI::Web::small_custview qw(small_custview);
130 use FS::UI::bytecount;
131 use FS::Msgcat qw(gettext geterror);
132 use FS::Misc qw( send_email send_fax ocr_image
133 states_hash counties cities state_label
135 use FS::Misc::eps2png qw( eps2png );
136 use FS::Report::FCC_477;
137 use FS::Report::Table;
138 use FS::Report::Table::Monthly;
139 use FS::Report::Table::Daily;
140 use FS::TicketSystem;
141 use FS::NetworkMonitoringSystem;
142 use FS::Tron qw( tron_lint );
144 use FS::Maketext qw( mt emt js_mt );
148 use FS::domain_record;
150 use FS::cust_bill_pay;
152 use FS::cust_credit_bill;
154 use FS::cust_main::Search qw(smart_search);
155 use FS::cust_main::Import;
156 use FS::cust_main_county;
157 use FS::cust_location;
160 use FS::cust_pkg::Import;
161 use FS::part_pkg_taxclass;
162 use FS::cust_pkg_reason;
164 use FS::cust_credit_refund;
165 use FS::cust_pay_refund;
168 use FS::part_bill_event;
170 use FS::part_event_condition;
172 use FS::part_referral;
174 use FS::part_svc_router;
175 use FS::part_virtual_field;
179 use FS::queue qw(joblisting);
183 use FS::svc_acct_pop qw(popselector);
184 use FS::acct_rt_transaction;
190 use FS::svc_broadband;
191 use FS::svc_external;
194 use FS::part_export_option;
196 use FS::export_device;
203 use FS::payment_gateway;
204 use FS::agent_payment_gateway;
209 use FS::inventory_class;
210 use FS::inventory_item;
211 use FS::pkg_category;
214 use FS::access_user_pref;
215 use FS::access_group;
216 use FS::access_usergroup;
217 use FS::access_groupagent;
218 use FS::access_right;
221 use FS::phone_device;
225 use FS::cust_main_note;
227 use FS::cust_tax_location;
228 use FS::part_pkg_taxproduct;
229 use FS::part_pkg_taxoverride;
230 use FS::part_pkg_taxrate;
232 use FS::part_pkg_report_option;
233 use FS::cust_attachment;
235 use FS::h_inventory_item;
237 use FS::h_svc_broadband;
238 use FS::h_svc_domain;
239 #use FS::h_domain_record;
240 use FS::h_svc_external;
241 use FS::h_svc_forward;
243 #use FS::h_phone_device;
245 use FS::cust_statement;
247 use FS::cust_category;
248 use FS::prospect_main;
253 use FS::cust_pkg_discount;
254 use FS::cust_bill_pkg_discount;
255 use FS::svc_mailinglist;
257 use FS::cgp_rule_condition;
258 use FS::cgp_rule_action;
260 use FS::cust_bill_batch;
262 use FS::rate_time_interval;
263 use FS::msg_template;
266 use FS::part_pkg_discount;
272 use FS::part_pkg_vendor;
273 use FS::cust_note_class;
278 use FS::torrus_srvderive;
279 use FS::torrus_srvderive_component;
283 use FS::svc_hardware;
284 use FS::h_svc_hardware;
285 use FS::hardware_class;
286 use FS::hardware_type;
287 use FS::hardware_status;
288 use FS::did_order_item;
292 use FS::radius_group;
293 use FS::template_content;
298 use FS::legacy_cust_bill;
300 use FS::rate_tier_detail;
302 use FS::discount_plan;
304 use FS::tower_sector;
307 if ( $FS::Mason::addl_handler_use ) {
308 eval $FS::Mason::addl_handler_use;
312 if ( %%%RT_ENABLED%%% ) {
314 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
315 use vars qw($Nobody $SystemUser);
319 use RT::Transactions;
324 use RT::ScripActions;
325 use RT::ScripConditions;
328 use RT::GroupMembers;
329 use RT::CustomFields;
330 use RT::CustomFieldValues;
331 use RT::ObjectCustomFieldValues;
333 #blah. manually updated from RT::Interface::Web::Handler
334 use RT::Interface::Web;
341 #blah. not even in RT::Interface::Web::Handler, just in
342 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
343 #to throw a real error instead of just a mysterious unstyled RT
344 use CSS::Squish 0.06;
346 use RT::Interface::Web::Request;
348 #nother undeclared web UI dep (for ticket links graph)
349 use IPC::Run::SafeHandles;
351 #slow, unreliable, segfaults and is optional
352 #see rt/html/Ticket/Elements/ShowTransactionAttachments
355 #?#use File::Path qw( rmtree );
356 #?#use File::Glob qw( bsd_glob );
357 #?#use File::Spec::Unix;
363 *CGI::redirect = sub {
366 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
367 (my $x, $cookie) = (shift, shift);
368 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
370 my $location = shift;
374 # false laziness w/below
375 if ( defined(@DBIx::Profile::ISA) ) {
377 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
382 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
384 ( UNIVERSAL::can(dbh, 'sprintProfile')
385 ? encode_entities(dbh->sprintProfile())
386 : 'DBIx::Profile missing sprintProfile method;'.
387 'unpatched or too old?' ).
388 #"\n\n". &sprintAutoProfile(). '</PRE>'.
393 dbh->{'private_profile'} = {};
398 #clear db profile, but normal redirect
399 dbh->{'private_profile'} = {};
400 $m->redirect($location);
405 } else { #normal redirect
407 $m->redirect($location);
416 #carp #should just switch to <& &> syntax
422 $m->comp('/elements/errorpage.html', @_);
425 sub errorpage_popup {
427 $m->comp('/elements/errorpage-popup.html', @_);
431 my( $location ) = @_;
434 #false laziness w/above
435 if ( defined(@DBIx::Profile::ISA) ) {
437 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
442 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
444 ( UNIVERSAL::can(dbh, 'sprintProfile')
445 ? encode_entities(dbh->sprintProfile())
446 : 'DBIx::Profile missing sprintProfile method;'.
447 'unpatched or too old?' ).
448 #"\n\n". &sprintAutoProfile(). '</PRE>'.
453 dbh->{'private_profile'} = {};
457 #clear db profile, but normal redirect
458 dbh->{'private_profile'} = {};
459 $m->redirect($location);
463 } else { #normal redirect
465 $m->redirect($location);
471 } # end package HTML::Mason::Commands;
477 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
479 Returns a list consisting of two HTML::Mason::Interp objects, the first for
480 Freeside pages, and the second for RT pages.
482 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
484 Options and values can be passed following mode. Currently available options
487 I<outbuf> should be set to a scalar reference in standalone mode.
491 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
494 my $mode = shift || 'apache';
497 #my $request_class = 'HTML::Mason::Request'.
498 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
499 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
500 : 'FS::Mason::Request';
502 #not entirely sure it belongs here, but what the hey
503 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
507 # A hook supporting strange legacy ways people (well, SG) have added stuff on
509 my @addl_comp_root = ();
510 my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
511 if ( -e $addl_comp_root_file ) {
512 warn "reading $addl_comp_root_file\n";
513 my $text = slurp( $addl_comp_root_file );
514 my @addl = eval $text;
515 if ( @addl && ! $@ ) {
516 @addl_comp_root = @addl;
518 warn "error parsing $addl_comp_root_file: $@\n";
523 scalar(@addl_comp_root)
525 [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%' ],
528 : '%%%FREESIDE_DOCUMENT_ROOT%%%';
531 request_class => $request_class,
532 data_dir => '%%%MASONDATA%%%',
533 error_mode => 'output',
534 error_format => 'html',
535 ignore_warnings_expr => '.',
538 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
540 my $html_defang = new HTML::Defang (%defang_opts);
542 #false laziness w/ FS::Maketext js_mt
543 my $js_string_sub = sub {
544 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
545 ${$_[0]} =~ s/(['\\])/\\$1/g;
546 ${$_[0]} =~ s/\r/\\r/g;
547 ${$_[0]} =~ s/\n/\\n/g;
548 ${$_[0]} = "'". ${$_[0]}. "'";
551 my $defang_sub = sub {
552 ${$_[0]} = $html_defang->defang(${$_[0]});
555 my $fs_interp = new HTML::Mason::Interp (
557 comp_root => $fs_comp_root,
558 escape_flags => { 'js_string' => $js_string_sub,
559 'defang' => $defang_sub,
561 compiler => HTML::Mason::Compiler::ToObject->new(
562 allow_globals => [qw(%session)],
566 my $rt_interp = new HTML::Mason::Interp (
569 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
570 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
572 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
573 'js_string' => $js_string_sub,
575 compiler => HTML::Mason::Compiler::ToObject->new(
576 default_escape_flags => 'h',
577 allow_globals => [qw(%session)],
581 ( $fs_interp, $rt_interp );
589 Lurking in the darkness...
593 L<HTML::Mason>, L<FS>, L<RT>