reports with row grouping for payment/refund search, #25944
[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);
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   # Sammath Naur
409
410   if ( $FS::Mason::addl_handler_use ) {
411     eval $FS::Mason::addl_handler_use;
412     die $@ if $@;
413   }
414
415   if ( %%%RT_ENABLED%%% ) {
416     eval '
417       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
418       use vars qw($Nobody $SystemUser);
419       use RT;
420       use RT::Util;
421       use RT::Tickets;
422       use RT::Transactions;
423       use RT::Users;
424       use RT::CurrentUser;
425       use RT::Templates;
426       use RT::Queues;
427       use RT::ScripActions;
428       use RT::ScripConditions;
429       use RT::Scrips;
430       use RT::Groups;
431       use RT::GroupMembers;
432       use RT::CustomFields;
433       use RT::CustomFieldValues;
434       use RT::ObjectCustomFieldValues;
435
436       #blah.  manually updated from RT::Interface::Web::Handler
437       use RT::Interface::Web;
438       use MIME::Entity;
439       use Text::Wrapper;
440       use Time::ParseDate;
441       use Time::HiRes;
442       use HTML::Scrubber;
443
444       #blah.  not even in RT::Interface::Web::Handler, just in 
445       #html/NoAuth/css/dhandler and rt-test-dependencies.  ask for it here
446       #to throw a real error instead of just a mysterious unstyled RT
447       use CSS::Squish 0.06;
448
449       use RT::Interface::Web::Request;
450
451       #another undeclared web UI dep (for ticket links graph)
452       use IPC::Run::SafeHandles;
453
454       #slow, unreliable, segfaults and is optional
455       #see rt/html/Ticket/Elements/ShowTransactionAttachments
456       #use Text::Quoted;
457
458       #?#use File::Path qw( rmtree );
459       #?#use File::Glob qw( bsd_glob );
460       #?#use File::Spec::Unix;
461
462     ';
463     die $@ if $@;
464   }
465
466   no warnings 'redefine';
467   *CGI::redirect = sub {
468     my $self = shift;
469     my $cookie = '';
470     if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
471       (my $x, $cookie) = (shift, shift);
472       $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
473     }
474     my $location = shift;
475
476     use vars qw($m);
477
478     # false laziness w/below
479     if ( @DBIx::Profile::ISA ) {
480
481       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
482
483         #profiling redirect
484
485         my $page =
486           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
487           '<BR><BR><PRE>'.
488             ( UNIVERSAL::can(dbh, 'sprintProfile')
489                 ? encode_entities(dbh->sprintProfile())
490                 : 'DBIx::Profile missing sprintProfile method;'.
491                   'unpatched or too old?'                        ).
492           #"\n\n". &sprintAutoProfile().  '</PRE>'.
493           "\n\n".                         '</PRE>'.
494           '</BODY></HTML>';
495
496
497         dbh->{'private_profile'} = {};
498         return $page;
499
500       } else {
501
502         #clear db profile, but normal redirect
503         dbh->{'private_profile'} = {};
504         $m->redirect($location);
505         '';
506
507       }
508
509     } else { #normal redirect
510
511       $m->redirect($location);
512       '';
513
514     }
515
516   };
517   
518   sub include {
519     use vars qw($m);
520     #carp #should just switch to <& &> syntax
521     $m->scomp(@_);
522   }
523
524   sub errorpage {
525     use vars qw($m);
526     $m->comp('/elements/errorpage.html', @_);
527   }
528
529   sub errorpage_popup {
530     use vars qw($m);
531     $m->comp('/elements/errorpage-popup.html', @_);
532   }
533
534   sub redirect {
535     my( $location ) = @_;
536     use vars qw($m);
537     $m->clear_buffer;
538     #false laziness w/above
539     if ( @DBIx::Profile::ISA ) {
540
541       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
542
543         #profiling redirect
544
545         $m->print(
546           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
547           '<BR><BR><PRE>'.
548             ( UNIVERSAL::can(dbh, 'sprintProfile')
549                 ? encode_entities(dbh->sprintProfile())
550                 : 'DBIx::Profile missing sprintProfile method;'.
551                   'unpatched or too old?'                        ).
552           #"\n\n". &sprintAutoProfile().  '</PRE>'.
553           "\n\n".                         '</PRE>'.
554           '</BODY></HTML>'
555         );
556
557         dbh->{'private_profile'} = {};
558
559       } else {
560
561         #clear db profile, but normal redirect
562         dbh->{'private_profile'} = {};
563         $m->redirect($location);
564
565       }
566
567     } else { #normal redirect
568
569       $m->redirect($location);
570
571     }
572
573   }
574
575 } # end package HTML::Mason::Commands;
576
577 =head1 SUBROUTINE
578
579 =over 4
580
581 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
582
583 Returns a list consisting of two HTML::Mason::Interp objects, the first for
584 Freeside pages, and the second for RT pages.
585
586 MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
587
588 Options and values can be passed following mode.  Currently available options
589 are:
590
591 I<outbuf> should be set to a scalar reference in standalone mode.
592
593 =cut
594
595 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
596
597 sub mason_interps {
598   my $mode = shift || 'apache';
599   my %opt = @_;
600
601   #my $request_class = 'HTML::Mason::Request'.
602                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
603   my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
604                                             : 'FS::Mason::Request';
605
606   #not entirely sure it belongs here, but what the hey
607   if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
608     RT::LoadConfig();
609   }
610
611   my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
612
613   my %interp = (
614     request_class        => $request_class,
615     data_dir             => '%%%MASONDATA%%%',
616     error_mode           => 'output',
617     error_format         => 'html',
618     ignore_warnings_expr => '.',
619   );
620
621   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
622
623   my $html_defang = new HTML::Defang (%defang_opts);
624
625   #false laziness w/ FS::Maketext js_mt
626   my $js_string_sub = sub {
627     #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
628     ${$_[0]} =~ s/(['\\])/\\$1/g;
629     ${$_[0]} =~ s/\r/\\r/g;
630     ${$_[0]} =~ s/\n/\\n/g;
631     # prevent premature termination of the script
632     ${$_[0]} =~ s[</script>][<\\/script>]ig;
633     ${$_[0]} = "'". ${$_[0]}. "'";
634   };
635
636   my $defang_sub = sub {
637     ${$_[0]} = $html_defang->defang(${$_[0]});
638   };
639
640   my $fs_interp = new HTML::Mason::Interp (
641     %interp,
642     comp_root    => $fs_comp_root,
643     escape_flags => { 'js_string'   => $js_string_sub,
644                       'defang'      => $defang_sub,
645                     },
646     compiler     => HTML::Mason::Compiler::ToObject->new(
647                       allow_globals        => [qw(%session)],
648                     ),
649   );
650
651   my $rt_interp = new HTML::Mason::Interp (
652     %interp,
653     comp_root    => [
654                       [ 'rt'       => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
655                       [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
656                     ],
657     escape_flags => { 'h'         => \&RT::Interface::Web::EscapeUTF8,
658                       'u'         => \&RT::Interface::Web::EscapeURI,
659                       'j'         => \&RT::Interface::Web::EscapeJS,
660                       'js_string' => $js_string_sub,
661                     },
662     compiler     => HTML::Mason::Compiler::ToObject->new(
663                       default_escape_flags => 'h',
664                       allow_globals        => [qw(%session $DECODED_ARGS)],
665                     ),
666   );
667
668   ( $fs_interp, $rt_interp );
669
670 }
671
672 =back
673
674 =head1 BUGS
675
676 Lurking in the darkness...
677
678 =head1 SEE ALSO
679
680 L<HTML::Mason>, L<FS>, L<RT>
681
682 =cut
683
684 1;