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 looks_like_number );
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);
81 # use XMLRPC::Transport::HTTP;
82 # use XMLRPC::Lite; # for XMLRPC::Serializer
88 use File::Slurp qw( slurp );
89 #not actually using this yet anyway...# use IPC::Run3 0.036;
90 use Net::Whois::Raw qw(whois);
92 eval "use Net::Whois::Raw 0.32 qw(whois)";
96 use Spreadsheet::WriteExcel;
97 use Spreadsheet::WriteExcel::Utility;
98 use OLE::Storage_Lite;
99 use Excel::Writer::XLSX;
100 #use Excel::Writer::XLSX::Utility; #redundant with above
102 use Business::CreditCard 0.30; #for mask-aware cardtype()
104 use Net::MAC::Vendor;
106 use Net::Ping::External;
107 #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
109 no warnings 'redefine';
110 eval 'sub Net::Ping::External::_ping_linux {
112 my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
113 return Net::Ping::External::_ping_system($command, 0);
118 use String::Approx qw(amatch);
119 use Chart::LinesPoints;
123 use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
126 use Business::US::USPS::WebTools::AddressStandardization;
127 use Geo::GoogleEarth::Pluggable;
129 use Storable qw( nfreeze thaw );
131 use FS::UID qw( getotaker dbh datasrc driver_name );
132 use FS::Record qw( qsearch qsearchs fields dbdef
133 str2time_sql str2time_sql_closing
134 midnight_sql regexp_sql
137 use FS::CGI qw(header menubar table itable ntable idiot
138 eidiot myexit http_header);
139 use FS::UI::Web qw(svc_url random_id);
140 use FS::UI::Web::small_custview qw(small_custview);
141 use FS::UI::bytecount;
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 );
162 use FS::domain_record;
164 use FS::cust_bill_pay;
166 use FS::cust_credit_bill;
169 use FS::cust_main::Search qw(smart_search);
170 use FS::cust_main::Import;
171 use FS::cust_main_county;
172 use FS::cust_location;
175 use FS::cust_pkg::Import;
176 use FS::part_pkg_taxclass;
177 use FS::cust_pkg_reason;
179 use FS::cust_credit_refund;
180 use FS::cust_pay_refund;
183 use FS::part_bill_event;
185 use FS::part_event_condition;
187 use FS::part_referral;
189 use FS::part_svc_router;
190 use FS::part_virtual_field;
194 use FS::queue qw(joblisting);
198 use FS::svc_acct_pop qw(popselector);
199 use FS::acct_rt_transaction;
205 use FS::svc_broadband;
206 use FS::svc_external;
209 use FS::part_export_option;
211 use FS::export_device;
218 use FS::payment_gateway;
219 use FS::agent_payment_gateway;
224 use FS::inventory_class;
225 use FS::inventory_item;
226 use FS::pkg_category;
229 use FS::access_user_pref;
230 use FS::access_group;
231 use FS::access_usergroup;
232 use FS::access_groupagent;
233 use FS::access_right;
236 use FS::phone_device;
240 use FS::cust_main_note;
242 use FS::cust_tax_location;
243 use FS::part_pkg_taxproduct;
244 use FS::part_pkg_taxoverride;
245 use FS::part_pkg_taxrate;
247 use FS::part_pkg_report_option;
248 use FS::cust_attachment;
250 use FS::h_inventory_item;
252 use FS::h_svc_broadband;
253 use FS::h_svc_domain;
254 #use FS::h_domain_record;
255 use FS::h_svc_external;
256 use FS::h_svc_forward;
258 #use FS::h_phone_device;
260 use FS::cust_statement;
262 use FS::cust_category;
263 use FS::prospect_main;
268 use FS::cust_pkg_discount;
269 use FS::cust_bill_pkg_discount;
270 use FS::svc_mailinglist;
272 use FS::cgp_rule_condition;
273 use FS::cgp_rule_action;
275 use FS::cust_bill_batch;
277 use FS::rate_time_interval;
278 use FS::msg_template;
281 use FS::part_pkg_discount;
287 use FS::part_pkg_vendor;
288 use FS::cust_note_class;
293 use FS::torrus_srvderive;
294 use FS::torrus_srvderive_component;
298 use FS::svc_hardware;
299 use FS::h_svc_hardware;
300 use FS::hardware_class;
301 use FS::hardware_type;
302 use FS::hardware_status;
303 use FS::did_order_item;
307 use FS::radius_group;
308 use FS::template_content;
313 use FS::legacy_cust_bill;
315 use FS::rate_tier_detail;
317 use FS::discount_plan;
319 use FS::tower_sector;
321 use FS::contact_class;
322 use FS::part_svc_class;
323 use FS::upload_target;
325 use FS::quotation_pkg;
326 use FS::quotation_pkg_discount;
327 use FS::cust_bill_void;
328 use FS::cust_bill_pkg_void;
329 use FS::cust_bill_pkg_detail_void;
330 use FS::cust_bill_pkg_display_void;
331 use FS::cust_bill_pkg_tax_location_void;
332 use FS::cust_bill_pkg_tax_rate_location_void;
333 use FS::cust_tax_exempt_pkg_void;
334 use FS::cust_bill_pkg_discount_void;
335 use FS::agent_pkg_class;
336 use FS::svc_export_machine;
337 use FS::GeocodeCache;
340 use FS::part_pkg_usage_class;
341 use FS::cust_pkg_usage;
342 use FS::part_pkg_usage_class;
343 use FS::part_pkg_usage;
344 use FS::cdr_cust_pkg_usage;
345 use FS::part_pkg_msgcat;
347 use FS::sales_pkg_class;
350 use FS::invoice_mode;
351 use FS::invoice_conf;
352 use FS::cable_provider;
353 use FS::cust_credit_void;
354 use FS::discount_class;
355 use FS::alarm_system;
357 use FS::alarm_station;
359 use FS::pbx_extension;
360 use FS::cust_event_fee;
362 use FS::cust_bill_pkg_fee;
363 use FS::part_fee_msgcat;
364 use FS::part_fee_usage;
367 use FS::export_batch;
368 use FS::export_batch_item;
369 use FS::part_pkg_fcc_option;
373 use FS::deploy_zone_block;
374 use FS::deploy_zone_vertex;
375 use FS::circuit_type;
376 use FS::circuit_provider;
377 use FS::circuit_termination;
379 use FS::legacy_cust_history;
380 use FS::quotation_pkg_tax;
381 use FS::cust_pkg_reason_fee;
382 use FS::access_user_log;
383 use FS::report_batch;
384 use FS::report_batch;
385 use FS::report_batch;
386 use FS::report_batch;
387 use FS::password_history;
392 if ( $FS::Mason::addl_handler_use ) {
393 eval $FS::Mason::addl_handler_use;
397 if ( %%%RT_ENABLED%%% ) {
399 use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
400 use vars qw($Nobody $SystemUser);
404 use RT::Transactions;
409 use RT::ScripActions;
410 use RT::ScripConditions;
413 use RT::GroupMembers;
414 use RT::CustomFields;
415 use RT::CustomFieldValues;
416 use RT::ObjectCustomFieldValues;
418 #blah. manually updated from RT::Interface::Web::Handler
419 use RT::Interface::Web;
426 #blah. not even in RT::Interface::Web::Handler, just in
427 #html/NoAuth/css/dhandler and rt-test-dependencies. ask for it here
428 #to throw a real error instead of just a mysterious unstyled RT
429 use CSS::Squish 0.06;
431 use RT::Interface::Web::Request;
433 #another undeclared web UI dep (for ticket links graph)
434 use IPC::Run::SafeHandles;
436 #slow, unreliable, segfaults and is optional
437 #see rt/html/Ticket/Elements/ShowTransactionAttachments
440 #?#use File::Path qw( rmtree );
441 #?#use File::Glob qw( bsd_glob );
442 #?#use File::Spec::Unix;
448 no warnings 'redefine';
449 *CGI::redirect = sub {
452 if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
453 (my $x, $cookie) = (shift, shift);
454 $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
456 my $location = shift;
460 # false laziness w/below
461 if ( defined(@DBIx::Profile::ISA) ) {
463 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
468 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
470 ( UNIVERSAL::can(dbh, 'sprintProfile')
471 ? encode_entities(dbh->sprintProfile())
472 : 'DBIx::Profile missing sprintProfile method;'.
473 'unpatched or too old?' ).
474 #"\n\n". &sprintAutoProfile(). '</PRE>'.
479 dbh->{'private_profile'} = {};
484 #clear db profile, but normal redirect
485 dbh->{'private_profile'} = {};
486 $m->redirect($location);
491 } else { #normal redirect
493 $m->redirect($location);
502 #carp #should just switch to <& &> syntax
508 $m->comp('/elements/errorpage.html', @_);
511 sub errorpage_popup {
513 $m->comp('/elements/errorpage-popup.html', @_);
517 my( $location ) = @_;
520 #false laziness w/above
521 if ( defined(@DBIx::Profile::ISA) ) {
523 if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
528 qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
530 ( UNIVERSAL::can(dbh, 'sprintProfile')
531 ? encode_entities(dbh->sprintProfile())
532 : 'DBIx::Profile missing sprintProfile method;'.
533 'unpatched or too old?' ).
534 #"\n\n". &sprintAutoProfile(). '</PRE>'.
539 dbh->{'private_profile'} = {};
543 #clear db profile, but normal redirect
544 dbh->{'private_profile'} = {};
545 $m->redirect($location);
549 } else { #normal redirect
551 $m->redirect($location);
557 } # end package HTML::Mason::Commands;
563 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
565 Returns a list consisting of two HTML::Mason::Interp objects, the first for
566 Freeside pages, and the second for RT pages.
568 MODE can be 'apache' or 'standalone'. If not specified, defaults to 'apache'.
570 Options and values can be passed following mode. Currently available options
573 I<outbuf> should be set to a scalar reference in standalone mode.
577 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
580 my $mode = shift || 'apache';
583 #my $request_class = 'HTML::Mason::Request'.
584 #( $mode eq 'apache' ? '::ApacheHandler' : '' );
585 my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
586 : 'FS::Mason::Request';
588 #not entirely sure it belongs here, but what the hey
589 if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
593 my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
596 request_class => $request_class,
597 data_dir => '%%%MASONDATA%%%',
598 error_mode => 'output',
599 error_format => 'html',
600 ignore_warnings_expr => '.',
603 $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
605 my $html_defang = new HTML::Defang (%defang_opts);
607 #false laziness w/ FS::Maketext js_mt
608 my $js_string_sub = sub {
609 #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
610 ${$_[0]} =~ s/(['\\])/\\$1/g;
611 ${$_[0]} =~ s/\r/\\r/g;
612 ${$_[0]} =~ s/\n/\\n/g;
613 # prevent premature termination of the script
614 ${$_[0]} =~ s[</script>][<\\/script>]ig;
615 ${$_[0]} = "'". ${$_[0]}. "'";
618 my $defang_sub = sub {
619 ${$_[0]} = $html_defang->defang(${$_[0]});
622 my $fs_interp = new HTML::Mason::Interp (
624 comp_root => $fs_comp_root,
625 escape_flags => { 'js_string' => $js_string_sub,
626 'defang' => $defang_sub,
628 compiler => HTML::Mason::Compiler::ToObject->new(
629 allow_globals => [qw(%session)],
633 my $rt_interp = new HTML::Mason::Interp (
636 [ 'rt' => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
637 [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%' ],
639 escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8,
640 'u' => \&RT::Interface::Web::EscapeURI,
641 'j' => \&RT::Interface::Web::EscapeJS,
642 'js_string' => $js_string_sub,
644 compiler => HTML::Mason::Compiler::ToObject->new(
645 default_escape_flags => 'h',
646 allow_globals => [qw(%session $DECODED_ARGS)],
650 ( $fs_interp, $rt_interp );
658 Lurking in the darkness...
662 L<HTML::Mason>, L<FS>, L<RT>