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 );
59 use List::MoreUtils qw( first_index uniq );
60 use Scalar::Util qw( blessed );
67 use DateTime::Format::Strptime;
68 use FS::Misc::DateTime qw( parse_datetime );
69 use FS::Misc::Geo qw( get_district );
70 use Lingua::EN::Inflect qw(PL);
71 Lingua::EN::Inflect::classical names=>0; #Categorys
76 use HTML::TreeBuilder;
77 use HTML::TableExtract qw(tree);
86 #not actually using this yet anyway...# use IPC::Run3 0.036;
87 use Net::Whois::Raw qw(whois);
89 eval "use Net::Whois::Raw 0.32 qw(whois)";
93 use Spreadsheet::WriteExcel;
94 use Spreadsheet::WriteExcel::Utility;
95 use OLE::Storage_Lite;
96 use Excel::Writer::XLSX;
97 #use Excel::Writer::XLSX::Utility; #redundant with above
99 use Business::CreditCard 0.30; #for mask-aware cardtype()
101 use Net::MAC::Vendor;
103 use Net::Ping::External;
104 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
106 no warnings 'redefine';
107 eval 'sub Net::Ping::External::_ping_linux {
109 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
110 return Net::Ping::External::_ping_system($command, 0);
115 use String::Approx qw(amatch);
116 use Chart::LinesPoints;
120 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
123 use Locale::Currency;
124 use Locale::Currency::Format;
125 use Business::US::USPS::WebTools::AddressStandardization;
126 use Geo::GoogleEarth::Pluggable;
128 use Storable qw( nfreeze thaw );
130 use FS::UID qw( dbh datasrc driver_name );
131 use FS::Record qw( qsearch qsearchs fields dbdef
132 str2time_sql str2time_sql_closing
136 use FS::CGI qw(header menubar table itable ntable idiot
137 eidiot myexit http_header);
138 use FS::UI::Web qw(svc_url);
139 use FS::UI::Web::small_custview qw(small_custview);
140 use FS::UI::bytecount;
141 use FS::UI::REST qw( rest_auth rest_uri_remain encode_rest );
142 use FS::Msgcat qw(gettext geterror);
143 use FS::Misc qw( send_email send_fax ocr_image
144 states_hash counties cities state_label
146 use FS::Misc::eps2png qw( eps2png );
147 use FS::Report::FCC_477;
148 use FS::Report::Table;
149 use FS::Report::Table::Monthly;
150 use FS::Report::Table::Daily;
152 use FS::TicketSystem;
153 use FS::NetworkMonitoringSystem;
154 use FS::Tron qw( tron_lint );
156 use FS::Maketext qw( mt emt js_mt );
160 use FS::domain_record;
162 use FS::cust_bill_pay;
164 use FS::cust_credit_bill;
167 use FS::cust_main::Search qw(smart_search);
168 use FS::cust_main::Import;
169 use FS::cust_main::Import_Charges;
170 use FS::cust_main_county;
171 use FS::cust_location;
174 use FS::cust_pkg::Import;
175 use FS::part_pkg_taxclass;
176 use FS::cust_pkg_reason;
178 use FS::cust_credit_refund;
179 use FS::cust_pay_refund;
182 use FS::part_bill_event;
184 use FS::part_event_condition;
186 use FS::part_referral;
188 use FS::part_svc_router;
189 use FS::part_virtual_field;
193 use FS::queue qw(joblisting);
197 use FS::svc_acct_pop qw(popselector);
198 use FS::acct_rt_transaction;
204 use FS::svc_broadband;
205 use FS::svc_external;
208 use FS::part_export_option;
210 use FS::export_device;
217 use FS::payment_gateway;
218 use FS::agent_payment_gateway;
222 use FS::inventory_class;
223 use FS::inventory_item;
224 use FS::pkg_category;
227 use FS::access_user_pref;
228 use FS::access_group;
229 use FS::access_usergroup;
230 use FS::access_groupagent;
231 use FS::access_right;
234 use FS::phone_device;
238 use FS::cust_main_note;
240 use FS::cust_tax_location;
241 use FS::part_pkg_taxproduct;
242 use FS::part_pkg_taxoverride;
243 use FS::part_pkg_taxrate;
245 use FS::part_pkg_report_option;
246 use FS::cust_attachment;
248 use FS::h_inventory_item;
250 use FS::h_svc_broadband;
251 use FS::h_svc_domain;
252 #use FS::h_domain_record;
253 use FS::h_svc_external;
254 use FS::h_svc_forward;
256 #use FS::h_phone_device;
258 use FS::cust_statement;
260 use FS::cust_category;
261 use FS::prospect_main;
266 use FS::cust_pkg_discount;
267 use FS::cust_bill_pkg_discount;
268 use FS::svc_mailinglist;
270 use FS::cgp_rule_condition;
271 use FS::cgp_rule_action;
273 use FS::cust_bill_batch;
275 use FS::rate_time_interval;
276 use FS::msg_template;
279 use FS::part_pkg_discount;
285 use FS::part_pkg_vendor;
286 use FS::cust_note_class;
291 use FS::torrus_srvderive;
292 use FS::torrus_srvderive_component;
296 use FS::svc_hardware;
297 use FS::h_svc_hardware;
298 use FS::hardware_class;
299 use FS::hardware_type;
300 use FS::hardware_status;
301 use FS::did_order_item;
305 use FS::radius_group;
306 use FS::template_content;
311 use FS::legacy_cust_bill;
313 use FS::rate_tier_detail;
315 use FS::discount_plan;
317 use FS::tower_sector;
319 use FS::contact_class;
320 use FS::part_svc_class;
321 use FS::upload_target;
323 use FS::quotation_pkg;
324 use FS::quotation_pkg_discount;
325 use FS::cust_bill_void;
326 use FS::cust_bill_pkg_void;
327 use FS::cust_bill_pkg_detail_void;
328 use FS::cust_bill_pkg_display_void;
329 use FS::cust_bill_pkg_tax_location_void;
330 use FS::cust_bill_pkg_tax_rate_location_void;
331 use FS::cust_tax_exempt_pkg_void;
332 use FS::cust_bill_pkg_discount_void;
333 use FS::agent_pkg_class;
334 use FS::svc_export_machine;
335 use FS::GeocodeCache;
338 use FS::part_pkg_usage_class;
339 use FS::cust_pkg_usage;
340 use FS::part_pkg_usage_class;
341 use FS::part_pkg_usage;
342 use FS::cdr_cust_pkg_usage;
343 use FS::part_pkg_msgcat;
345 use FS::agent_currency;
346 use FS::currency_exchange;
347 use FS::part_pkg_currency;
353 use FS::vend_bill_pay;
354 use FS::sales_pkg_class;
357 use FS::invoice_mode;
358 use FS::invoice_conf;
359 use FS::cable_provider;
360 use FS::cust_credit_void;
361 use FS::discount_class;
362 use FS::alarm_system;
364 use FS::alarm_station;
366 use FS::svc_conferencing;
367 use FS::conferencing_type;
368 use FS::conferencing_quality;
370 use FS::part_pkg_usageprice;
371 use FS::cust_pkg_usageprice;
372 use FS::pbx_extension;
374 use FS::extension_device;
375 use FS::cust_main_credit_limit;
376 use FS::cust_event_fee;
378 use FS::cust_bill_pkg_fee;
379 use FS::part_fee_msgcat;
380 use FS::part_fee_usage;
383 use FS::export_batch;
384 use FS::export_batch_item;
385 use FS::part_pkg_fcc_option;
388 if ( $FS::Mason::addl_handler_use ) {
389 eval $FS::Mason::addl_handler_use;
393 if ( %%%RT_ENABLED%%% ) {
395 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
396 use vars qw($Nobody $SystemUser);
400 use RT::Transactions;
405 use RT::ScripActions;
406 use RT::ScripConditions;
409 use RT::GroupMembers;
410 use RT::CustomFields;
411 use RT::CustomFieldValues;
412 use RT::ObjectCustomFieldValues;
414 #blah. manually updated from RT::Interface::Web::Handler
415 use RT::Interface::Web;
422 #blah. not even in RT::Interface::Web::Handler, just in
423 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
424 #to throw a real error instead of just a mysterious unstyled RT
425 use CSS::Squish 0.06;
427 use RT::Interface::Web::Request;
429 #another undeclared web UI dep (for ticket links graph)
430 use IPC::Run::SafeHandles;
432 #slow, unreliable, segfaults and is optional
433 #see rt/html/Ticket/Elements/ShowTransactionAttachments
436 #?#use File::Path qw( rmtree );
437 #?#use File::Glob qw( bsd_glob );
438 #?#use File::Spec::Unix;
444 *CGI::redirect = sub {
447 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
448 (my $x, $cookie) = (shift, shift);
449 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
451 my $location = shift;
455 # false laziness w/below
456 if ( @DBIx::Profile::ISA ) {
458 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
463 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
465 ( UNIVERSAL::can(dbh, 'sprintProfile')
466 ? encode_entities(dbh->sprintProfile())
467 : 'DBIx::Profile missing sprintProfile method;'.
468 'unpatched or too old?' ).
469 #"\n\n". &sprintAutoProfile(). '</PRE>'.
474 dbh->{'private_profile'} = {};
479 #clear db profile, but normal redirect
480 dbh->{'private_profile'} = {};
481 $m->redirect($location);
486 } else { #normal redirect
488 $m->redirect($location);
497 #carp #should just switch to <& &> syntax
503 $m->comp('/elements/errorpage.html', @_);
506 sub errorpage_popup {
508 $m->comp('/elements/errorpage-popup.html', @_);
512 my( $location ) = @_;
515 #false laziness w/above
516 if ( @DBIx::Profile::ISA ) {
518 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
523 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
525 ( UNIVERSAL::can(dbh, 'sprintProfile')
526 ? encode_entities(dbh->sprintProfile())
527 : 'DBIx::Profile missing sprintProfile method;'.
528 'unpatched or too old?' ).
529 #"\n\n". &sprintAutoProfile(). '</PRE>'.
534 dbh->{'private_profile'} = {};
538 #clear db profile, but normal redirect
539 dbh->{'private_profile'} = {};
540 $m->redirect($location);
544 } else { #normal redirect
546 $m->redirect($location);
552 } # end package HTML::Mason::Commands;
558 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
560 Returns a list consisting of two HTML::Mason::Interp objects, the first for
561 Freeside pages, and the second for RT pages.
563 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
565 Options and values can be passed following mode. Currently available options
568 I<outbuf> should be set to a scalar reference in standalone mode.
572 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
575 my $mode = shift || 'apache';
578 #my $request_class = 'HTML::Mason::Request'.
579 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
580 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
581 : 'FS::Mason::Request';
583 #not entirely sure it belongs here, but what the hey
584 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
588 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
591 request_class => $request_class,
592 data_dir => '%%%MASONDATA%%%',
593 error_mode => 'output',
594 error_format => 'html',
595 ignore_warnings_expr => '.',
598 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
600 my $html_defang = new HTML::Defang (%defang_opts);
602 #false laziness w/ FS::Maketext js_mt
603 my $js_string_sub = sub {
604 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
605 ${$_[0]} =~ s/(['\\])/\\$1/g;
606 ${$_[0]} =~ s/\r/\\r/g;
607 ${$_[0]} =~ s/\n/\\n/g;
608 # prevent premature termination of the script
609 ${$_[0]} =~ s[</script>][<\\/script>]ig;
610 ${$_[0]} = "'". ${$_[0]}. "'";
613 my $defang_sub = sub {
614 ${$_[0]} = $html_defang->defang(${$_[0]});
617 my $fs_interp = new HTML::Mason::Interp (
619 comp_root => $fs_comp_root,
620 escape_flags => { 'js_string' => $js_string_sub,
621 'defang' => $defang_sub,
623 compiler => HTML::Mason::Compiler::ToObject->new(
624 allow_globals => [qw(%session)],
628 my $rt_interp = new HTML::Mason::Interp (
631 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
632 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
634 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
635 'u' => \&RT::Interface::Web::EscapeURI,
636 'j' => \&RT::Interface::Web::EscapeJS,
637 'js_string' => $js_string_sub,
639 compiler => HTML::Mason::Compiler::ToObject->new(
640 default_escape_flags => 'h',
641 allow_globals => [qw(%session $DECODED_ARGS)],
645 ( $fs_interp, $rt_interp );
653 Lurking in the darkness...
657 L<HTML::Mason>, L<FS>, L<RT>