Merge branch 'master' of git.freeside.biz:/home/git/freeside
[freeside.git] / FS / FS / Mason.pm
1 package FS::Mason;
2
3 use strict;
4 use vars qw( @ISA @EXPORT_OK $addl_handler_use );
5 use Exporter;
6 use Carp;
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;
11
12 @ISA = qw( Exporter );
13 @EXPORT_OK = qw( mason_interps );
14
15 =head1 NAME
16
17 FS::Mason - Initialize the Mason environment
18
19 =head1 SYNOPSIS
20
21   use FS::Mason qw( mason_interps );
22
23   my( $fs_interp, $rt_interp ) = mason_interps('apache');
24
25   #OR
26
27   my( $fs_interp, $rt_interp ) = mason_interps('standalone'); #XXX name?
28
29 =head1 DESCRIPTION
30
31 Initializes the Mason environment, loads all Freeside and RT libraries, etc.
32
33 =cut
34
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 );
39 }
40
41 # List of modules that you want to use from components (see Admin
42 # manual for details)
43 {
44   package HTML::Mason::Commands;
45
46   use strict;
47   use vars qw( %session );
48   use CGI 3.29 qw(-private_tempfiles); #3.29 to fix RT attachment problems
49
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;
55
56   #use CGI::Carp qw(fatalsToBrowser);
57   use CGI::Cookie;
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 );
61   use Data::Dumper;
62   use Date::Format;
63   use Time::Local;
64   use Time::HiRes;
65   use Time::Duration;
66   use DateTime;
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
72   use Tie::IxHash;
73   use URI;
74   use URI::Escape 3.31;
75   use HTML::Entities;
76   use HTML::TreeBuilder;
77   use HTML::TableExtract qw(tree);
78   use HTML::FormatText;
79   use HTML::Defang;
80   use JSON::XS;
81   use MIME::Base64;
82   use IO::Handle;
83   use IO::File;
84   use IO::Scalar;
85   use IO::String;
86   use File::Slurp qw( slurp );
87   #not actually using this yet anyway...# use IPC::Run3 0.036;
88   use Net::Whois::Raw qw(whois);
89   if ( $] < 5.006 ) {
90     eval "use Net::Whois::Raw 0.32 qw(whois)";
91     die $@ if $@;
92   }
93   use Text::CSV_XS;
94   use Spreadsheet::WriteExcel;
95   use Spreadsheet::WriteExcel::Utility;
96   use OLE::Storage_Lite;
97   use Excel::Writer::XLSX;
98   #use Excel::Writer::XLSX::Utility; #redundant with above
99
100   use Business::CreditCard 0.30; #for mask-aware cardtype()
101   use NetAddr::IP;
102   use Net::MAC::Vendor;
103   use Net::Ping;
104   use Net::Ping::External;
105   #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
106   {
107     no warnings 'redefine';
108     eval 'sub Net::Ping::External::_ping_linux { 
109             my %args = @_;
110             my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
111             return Net::Ping::External::_ping_system($command, 0);
112           }
113          ';
114     die $@ if $@;
115   }
116   use String::Approx qw(amatch);
117   use Chart::LinesPoints;
118   use Chart::Mountain;
119   use Chart::Bars;
120   use Color::Scheme;
121   use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
122                                         #selectlayers.html
123   use Locale::Country;
124   use Locale::Currency;
125   use Locale::Currency::Format;
126   use Business::US::USPS::WebTools::AddressStandardization;
127   use Geo::GoogleEarth::Pluggable;
128   use LWP::UserAgent;
129   use Storable qw( nfreeze thaw );
130   use FS;
131   use FS::UID qw( dbh datasrc driver_name );
132   use FS::Record qw( qsearch qsearchs fields dbdef
133                     str2time_sql str2time_sql_closing
134                     midnight_sql regexp_sql
135                    );
136   use FS::Conf;
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::UI::REST qw( rest_auth rest_uri_remain encode_rest );
143   use FS::Msgcat qw(gettext geterror);
144   use FS::Misc qw( send_email send_fax ocr_image
145                    states_hash counties cities state_label
146                  );
147   use FS::Misc::eps2png qw( eps2png );
148   use FS::Report::FCC_477;
149   use FS::Report::Table;
150   use FS::Report::Table::Monthly;
151   use FS::Report::Table::Daily;
152   use FS::Report::Tax;
153   use FS::TicketSystem;
154   use FS::NetworkMonitoringSystem;
155   use FS::Tron qw( tron_lint );
156   use FS::Locales;
157   use FS::Maketext qw( mt emt js_mt );
158
159   use FS::Query;
160
161   use FS::agent;
162   use FS::agent_type;
163   use FS::domain_record;
164   use FS::cust_bill;
165   use FS::cust_bill_pay;
166   use FS::cust_credit;
167   use FS::cust_credit_bill;
168   use FS::cust_main;
169   use FS::h_cust_main;
170   use FS::cust_main::Search qw(smart_search);
171   use FS::cust_main::Import;
172   use FS::cust_main::Import_Charges;
173   use FS::cust_main_county;
174   use FS::cust_location;
175   use FS::cust_pay;
176   use FS::cust_pkg;
177   use FS::cust_pkg::Import;
178   use FS::part_pkg_taxclass;
179   use FS::cust_pkg_reason;
180   use FS::cust_refund;
181   use FS::cust_credit_refund;
182   use FS::cust_pay_refund;
183   use FS::cust_svc;
184   use FS::nas;
185   use FS::part_event;
186   use FS::part_event_condition;
187   use FS::part_pkg;
188   use FS::part_referral;
189   use FS::part_svc;
190   use FS::part_svc_router;
191   use FS::part_virtual_field;
192   use FS::pay_batch;
193   use FS::pkg_svc;
194   use FS::port;
195   use FS::queue qw(joblisting);
196   use FS::raddb;
197   use FS::session;
198   use FS::svc_acct;
199   use FS::svc_acct_pop qw(popselector);
200   use FS::acct_rt_transaction;
201   use FS::svc_domain;
202   use FS::svc_forward;
203   use FS::svc_www;
204   use FS::router;
205   use FS::addr_block;
206   use FS::svc_broadband;
207   use FS::svc_external;
208   use FS::type_pkgs;
209   use FS::part_export;
210   use FS::part_export_option;
211   use FS::export_svc;
212   use FS::export_device;
213   use FS::msgcat;
214   use FS::rate;
215   use FS::rate_region;
216   use FS::rate_prefix;
217   use FS::rate_detail;
218   use FS::usage_class;
219   use FS::payment_gateway;
220   use FS::agent_payment_gateway;
221   use FS::payby;
222   use FS::cdr;
223   use FS::cdr_batch;
224   use FS::inventory_class;
225   use FS::inventory_item;
226   use FS::pkg_category;
227   use FS::pkg_class;
228   use FS::access_user;
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;
234   use FS::AccessRight;
235   use FS::svc_phone;
236   use FS::phone_device;
237   use FS::part_device;
238   use FS::reason_type;
239   use FS::reason;
240   use FS::cust_main_note;
241   use FS::tax_class;
242   use FS::cust_tax_location;
243   use FS::part_pkg_taxproduct;
244   use FS::part_pkg_taxoverride;
245   use FS::part_pkg_taxrate;
246   use FS::tax_rate;
247   use FS::part_pkg_report_option;
248   use FS::cust_attachment;
249   use FS::h_cust_pkg;
250   use FS::h_inventory_item;
251   use FS::h_svc_acct;
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;
257   use FS::h_svc_phone;
258   #use FS::h_phone_device;
259   use FS::h_svc_www;
260   use FS::cust_statement;
261   use FS::cust_class;
262   use FS::cust_category;
263   use FS::prospect_main;
264   use FS::contact;
265   use FS::phone_type;
266   use FS::svc_pbx;
267   use FS::discount;
268   use FS::cust_pkg_discount;
269   use FS::cust_bill_pkg_discount;
270   use FS::svc_mailinglist;
271   use FS::cgp_rule;
272   use FS::cgp_rule_condition;
273   use FS::cgp_rule_action;
274   use FS::bill_batch;
275   use FS::cust_bill_batch;
276   use FS::rate_time;
277   use FS::rate_time_interval;
278   use FS::msg_template;
279   use FS::part_tag;
280   use FS::acct_snarf;
281   use FS::part_pkg_discount;
282   use FS::svc_cert;
283   use FS::svc_dsl;
284   use FS::qual;
285   use FS::qual_option;
286   use FS::dsl_note;
287   use FS::part_pkg_vendor;
288   use FS::cust_note_class;
289   use FS::svc_port;
290   use FS::lata;
291   use FS::did_vendor;
292   use FS::did_order;
293   use FS::torrus_srvderive;
294   use FS::torrus_srvderive_component;
295   use FS::areacode;
296   use FS::svc_dish;
297   use FS::h_svc_dish;
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;
304   use FS::msa;
305   use FS::rate_center;
306   use FS::cust_msg;
307   use FS::radius_group;
308   use FS::template_content;
309   use FS::dsl_device;
310   use FS::nas;
311   use FS::nas;
312   use FS::export_nas;
313   use FS::legacy_cust_bill;
314   use FS::rate_tier;
315   use FS::rate_tier_detail;
316   use FS::radius_attr;
317   use FS::discount_plan;
318   use FS::tower;
319   use FS::tower_sector;
320   use FS::sales;
321   use FS::contact_class;
322   use FS::part_svc_class;
323   use FS::upload_target;
324   use FS::quotation;
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;
338   use FS::log;
339   use FS::log_context;
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;
346   use FS::svc_cable;
347   use FS::agent_currency;
348   use FS::currency_exchange;
349   use FS::part_pkg_currency;
350   use FS::cust_payby;
351   use FS::vend_main;
352   use FS::vend_class;
353   use FS::vend_bill;
354   use FS::vend_pay;
355   use FS::vend_bill_pay;
356   use FS::sales_pkg_class;
357   use FS::svc_alarm;
358   use FS::cable_model;
359   use FS::invoice_mode;
360   use FS::invoice_conf;
361   use FS::cable_provider;
362   use FS::cust_credit_void;
363   use FS::discount_class;
364   use FS::alarm_system;
365   use FS::alarm_type;
366   use FS::alarm_station;
367   use FS::addr_range;
368   use FS::svc_conferencing;
369   use FS::conferencing_type;
370   use FS::conferencing_quality;
371   use FS::svc_video;
372   use FS::part_pkg_usageprice;
373   use FS::cust_pkg_usageprice;
374   use FS::pbx_extension;
375   use FS::pbx_device;
376   use FS::extension_device;
377   use FS::cust_main_credit_limit;
378   use FS::cust_event_fee;
379   use FS::part_fee;
380   use FS::cust_bill_pkg_fee;
381   use FS::part_fee_msgcat;
382   use FS::part_fee_usage;
383   use FS::sched_item;
384   use FS::sched_avail;
385   use FS::export_batch;
386   use FS::export_batch_item;
387   use FS::part_pkg_fcc_option;
388   use FS::state;
389   use FS::state;
390   use FS::queue_stat;
391   use FS::deploy_zone;
392   use FS::deploy_zone_block;
393   use FS::deploy_zone_vertex;
394   use FS::TaxEngine;
395   use FS::tax_status;
396   use FS::circuit_type;
397   use FS::circuit_provider;
398   use FS::circuit_termination;
399   use FS::svc_circuit;
400   use FS::cust_credit_source_bill_pkg;
401   use FS::prospect_contact;
402   use FS::cust_contact;
403   use FS::legacy_cust_history;
404   use FS::quotation_pkg_tax;
405   use FS::cust_pkg_reason_fee;
406   use FS::part_svc_link;
407   use FS::access_user_log;
408   use FS::report_batch;
409   use FS::report_batch;
410   use FS::report_batch;
411   use FS::report_batch;
412   use FS::password_history;
413   # Sammath Naur
414
415   if ( $FS::Mason::addl_handler_use ) {
416     eval $FS::Mason::addl_handler_use;
417     die $@ if $@;
418   }
419
420   if ( %%%RT_ENABLED%%% ) {
421     eval '
422       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
423       use vars qw($Nobody $SystemUser);
424       use RT;
425       use RT::Util;
426       use RT::Tickets;
427       use RT::Transactions;
428       use RT::Users;
429       use RT::CurrentUser;
430       use RT::Templates;
431       use RT::Queues;
432       use RT::ScripActions;
433       use RT::ScripConditions;
434       use RT::Scrips;
435       use RT::Groups;
436       use RT::GroupMembers;
437       use RT::CustomFields;
438       use RT::CustomFieldValues;
439       use RT::ObjectCustomFieldValues;
440
441       use RT::Interface::Web::Handler;
442
443       #blah.  not even in RT::Interface::Web::Handler, just in 
444       #html/NoAuth/css/dhandler and rt-test-dependencies.  ask for it here
445       #to throw a real error instead of just a mysterious unstyled RT
446       use CSS::Squish 0.06;
447
448       #another undeclared web UI dep (for ticket links graph)
449       use IPC::Run::SafeHandles;
450
451       #slow, unreliable, segfaults and is optional
452       #see rt/html/Ticket/Elements/ShowTransactionAttachments
453       #use Text::Quoted;
454
455       #?#use File::Path qw( rmtree );
456       #?#use File::Glob qw( bsd_glob );
457       #?#use File::Spec::Unix;
458
459     ';
460     die $@ if $@;
461   }
462
463   no warnings 'redefine';
464   *CGI::redirect = sub {
465     my $self = shift;
466     my $cookie = '';
467     if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
468       (my $x, $cookie) = (shift, shift);
469       $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
470     }
471     my $location = shift;
472
473     use vars qw($m);
474
475     # false laziness w/below
476     if ( @DBIx::Profile::ISA ) {
477
478       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
479
480         #profiling redirect
481
482         my $page =
483           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
484           '<BR><BR><PRE>'.
485             ( UNIVERSAL::can(dbh, 'sprintProfile')
486                 ? encode_entities(dbh->sprintProfile())
487                 : 'DBIx::Profile missing sprintProfile method;'.
488                   'unpatched or too old?'                        ).
489           #"\n\n". &sprintAutoProfile().  '</PRE>'.
490           "\n\n".                         '</PRE>'.
491           '</BODY></HTML>';
492
493
494         dbh->{'private_profile'} = {};
495         return $page;
496
497       } else {
498
499         #clear db profile, but normal redirect
500         dbh->{'private_profile'} = {};
501         $m->redirect($location);
502         '';
503
504       }
505
506     } else { #normal redirect
507
508       $m->redirect($location);
509       '';
510
511     }
512
513   };
514   
515   sub include {
516     use vars qw($m);
517     #warn 'include deprecated; use an HTML::Mason <& &> style include (or $m->scomp) at '. $m->callers(0)->path. "\n";
518     $m->scomp(@_);
519   }
520
521   sub errorpage {
522     use vars qw($m);
523     $m->comp('/elements/errorpage.html', @_);
524   }
525
526   sub errorpage_popup {
527     use vars qw($m);
528     $m->comp('/elements/errorpage-popup.html', @_);
529   }
530
531   sub redirect {
532     my( $location ) = @_;
533     use vars qw($m);
534     $m->clear_buffer;
535     #false laziness w/above
536     if ( @DBIx::Profile::ISA ) {
537
538       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
539
540         #profiling redirect
541
542         $m->print(
543           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
544           '<BR><BR><PRE>'.
545             ( UNIVERSAL::can(dbh, 'sprintProfile')
546                 ? encode_entities(dbh->sprintProfile())
547                 : 'DBIx::Profile missing sprintProfile method;'.
548                   'unpatched or too old?'                        ).
549           #"\n\n". &sprintAutoProfile().  '</PRE>'.
550           "\n\n".                         '</PRE>'.
551           '</BODY></HTML>'
552         );
553
554         dbh->{'private_profile'} = {};
555
556       } else {
557
558         #clear db profile, but normal redirect
559         dbh->{'private_profile'} = {};
560         $m->redirect($location);
561
562       }
563
564     } else { #normal redirect
565
566       $m->redirect($location);
567
568     }
569
570   }
571
572 } # end package HTML::Mason::Commands;
573
574 =head1 SUBROUTINE
575
576 =over 4
577
578 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
579
580 Returns a list consisting of two HTML::Mason::Interp objects, the first for
581 Freeside pages, and the second for RT pages.
582
583 MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
584
585 Options and values can be passed following mode.  Currently available options
586 are:
587
588 I<outbuf> should be set to a scalar reference in standalone mode.
589
590 =cut
591
592 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
593
594 sub mason_interps {
595   my $mode = shift || 'apache';
596   my %opt = @_;
597
598   #my $request_class = 'HTML::Mason::Request'.
599                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
600   my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
601                                             : 'FS::Mason::Request';
602
603   #not entirely sure it belongs here, but what the hey
604   if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
605     RT::LoadConfig();
606   }
607
608   my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
609
610   my %interp = (
611     request_class        => $request_class,
612     data_dir             => '%%%MASONDATA%%%',
613     error_mode           => 'output',
614     error_format         => 'html',
615     ignore_warnings_expr => '.',
616   );
617
618   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
619
620   my $html_defang = new HTML::Defang (%defang_opts);
621
622   #false laziness w/ FS::Maketext js_mt
623   my $js_string_sub = sub {
624     #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
625     ${$_[0]} =~ s/(['\\])/\\$1/g;
626     ${$_[0]} =~ s/\r/\\r/g;
627     ${$_[0]} =~ s/\n/\\n/g;
628     # prevent premature termination of the script
629     ${$_[0]} =~ s[</script>][<\\/script>]ig;
630     ${$_[0]} = "'". ${$_[0]}. "'";
631   };
632
633   my $defang_sub = sub {
634     ${$_[0]} = $html_defang->defang(${$_[0]});
635   };
636
637   my $fs_interp = new HTML::Mason::Interp (
638     %interp,
639     comp_root    => $fs_comp_root,
640     escape_flags => { 'js_string'   => $js_string_sub,
641                       'defang'      => $defang_sub,
642                     },
643     compiler     => HTML::Mason::Compiler::ToObject->new(
644                       allow_globals        => [qw(%session)],
645                     ),
646   );
647
648   my $rt_interp = new HTML::Mason::Interp (
649     %interp,
650     comp_root    => [
651                       [ 'rt'       => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
652                       [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
653                     ],
654     escape_flags => { 'h'         => \&RT::Interface::Web::EscapeHTML,
655                       #u and j aren't used anymore?  :/
656                       'u'         => \&RT::Interface::Web::EscapeURI,
657                       'j'         => \&RT::Interface::Web::EscapeJS,
658                       'js_string' => $js_string_sub,
659                     },
660     compiler     => HTML::Mason::Compiler::ToObject->new(
661                       default_escape_flags => 'h',
662                       allow_globals        => [qw(%session $DECODED_ARGS)],
663                     ),
664   );
665
666   ( $fs_interp, $rt_interp );
667
668 }
669
670 =back
671
672 =head1 BUGS
673
674 Lurking in the darkness...
675
676 =head1 SEE ALSO
677
678 L<HTML::Mason>, L<FS>, L<RT>
679
680 =cut
681
682 1;