Add cust_attachment stuff
[freeside.git] / FS / FS / Mason.pm
1 package FS::Mason;
2
3 use strict;
4 use vars qw( @ISA @EXPORT_OK );
5 use Exporter;
6 use HTML::Mason 1.27; #http://www.masonhq.com/?ApacheModPerl2Redirect
7 use HTML::Mason::Interp;
8 use HTML::Mason::Compiler::ToObject;
9
10 @ISA = qw( Exporter );
11 @EXPORT_OK = qw( mason_interps );
12
13 =head1 NAME
14
15 FS::Mason - Initialize the Mason environment
16
17 =head1 SYNOPSIS
18
19   use FS::Mason qw( mason_interps );
20
21   my( $fs_interp, $rt_interp ) = mason_interps('apache');
22
23   #OR
24
25   my( $fs_interp, $rt_interp ) = mason_interps('standalone'); #XXX name?
26
27 =head1 DESCRIPTION
28
29 Initializes the Mason environment, loads all Freeside and RT libraries, etc.
30
31 =cut
32
33 # List of modules that you want to use from components (see Admin
34 # manual for details)
35 {
36   package HTML::Mason::Commands;
37
38   use strict;
39   use vars qw( %session );
40   use CGI 3.29 qw(-private_tempfiles); #3.29 to fix RT attachment problems
41
42   #breaks quick payment entry
43   #http://rt.cpan.org/Public/Bug/Display.html?id=37365
44   die "CGI.pm v3.38 is broken, use any other version >= 3.29".
45       " (Debian 5.0?  aptitude remove libcgi-pm-perl)"
46     if $CGI::VERSION == 3.38;
47
48   #use CGI::Carp qw(fatalsToBrowser);
49   use CGI::Cookie;
50   use List::Util qw( max min );
51   use Data::Dumper;
52   use Date::Format;
53   use Date::Parse;
54   use Time::Local;
55   use Time::Duration;
56   use DateTime;
57   use DateTime::Format::Strptime;
58   use Lingua::EN::Inflect qw(PL);
59   use Tie::IxHash;
60   use URI;
61   use URI::Escape;
62   use HTML::Entities;
63   use HTML::TreeBuilder;
64   use HTML::FormatText;
65   use JSON;
66   use MIME::Base64;
67   use IO::Handle;
68   use IO::File;
69   use IO::Scalar;
70   #not actually using this yet anyway...# use IPC::Run3 0.036;
71   use Net::Whois::Raw qw(whois);
72   if ( $] < 5.006 ) {
73     eval "use Net::Whois::Raw 0.32 qw(whois)";
74     die $@ if $@;
75   }
76   use Text::CSV_XS;
77   use Spreadsheet::WriteExcel;
78   use Business::CreditCard 0.30; #for mask-aware cardtype()
79   use NetAddr::IP;
80   use String::Approx qw(amatch);
81   use Chart::LinesPoints;
82   use Chart::Mountain;
83   use Color::Scheme;
84   use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
85                                         #selectlayers.html
86   use Locale::Country;
87   use Business::US::USPS::WebTools::AddressStandardization;
88   use FS;
89   use FS::UID qw( getotaker dbh datasrc driver_name );
90   use FS::Record qw( qsearch qsearchs fields dbdef
91                     str2time_sql str2time_sql_closing
92                    );
93   use FS::Conf;
94   use FS::CGI qw(header menubar table itable ntable idiot
95                  eidiot myexit http_header);
96   use FS::UI::Web qw(svc_url);
97   use FS::UI::Web::small_custview qw(small_custview);
98   use FS::UI::bytecount;
99   use FS::Msgcat qw(gettext geterror);
100   use FS::Misc qw( send_email send_fax states_hash counties state_label );
101   use FS::Misc::eps2png qw( eps2png );
102   use FS::Report::Table::Monthly;
103   use FS::TicketSystem;
104   use FS::Tron qw( tron_lint );
105
106   use FS::agent;
107   use FS::agent_type;
108   use FS::domain_record;
109   use FS::cust_bill;
110   use FS::cust_bill_pay;
111   use FS::cust_credit;
112   use FS::cust_credit_bill;
113   use FS::cust_main qw(smart_search);
114   use FS::cust_main::Import;
115   use FS::cust_main_county;
116   use FS::cust_location;
117   use FS::cust_pay;
118   use FS::cust_pkg;
119   use FS::part_pkg_taxclass;
120   use FS::cust_pkg_reason;
121   use FS::cust_refund;
122   use FS::cust_credit_refund;
123   use FS::cust_pay_refund;
124   use FS::cust_svc;
125   use FS::nas;
126   use FS::part_bill_event;
127   use FS::part_event;
128   use FS::part_event_condition;
129   use FS::part_pkg;
130   use FS::part_referral;
131   use FS::part_svc;
132   use FS::part_svc_router;
133   use FS::part_virtual_field;
134   use FS::pay_batch;
135   use FS::pkg_svc;
136   use FS::port;
137   use FS::queue qw(joblisting);
138   use FS::raddb;
139   use FS::session;
140   use FS::svc_acct;
141   use FS::svc_acct_pop qw(popselector);
142   use FS::acct_rt_transaction;
143   use FS::svc_domain;
144   use FS::svc_forward;
145   use FS::svc_www;
146   use FS::router;
147   use FS::addr_block;
148   use FS::svc_broadband;
149   use FS::svc_external;
150   use FS::type_pkgs;
151   use FS::part_export;
152   use FS::part_export_option;
153   use FS::export_svc;
154   use FS::msgcat;
155   use FS::rate;
156   use FS::rate_region;
157   use FS::rate_prefix;
158   use FS::rate_detail;
159   use FS::usage_class;
160   use FS::payment_gateway;
161   use FS::agent_payment_gateway;
162   use FS::XMLRPC;
163   use FS::payby;
164   use FS::cdr;
165   use FS::inventory_class;
166   use FS::inventory_item;
167   use FS::pkg_category;
168   use FS::pkg_class;
169   use FS::access_user;
170   use FS::access_user_pref;
171   use FS::access_group;
172   use FS::access_usergroup;
173   use FS::access_groupagent;
174   use FS::access_right;
175   use FS::AccessRight;
176   use FS::svc_phone;
177   use FS::phone_device;
178   use FS::part_device;
179   use FS::reason_type;
180   use FS::reason;
181   use FS::cust_main_note;
182   use FS::tax_class;
183   use FS::cust_tax_location;
184   use FS::part_pkg_taxproduct;
185   use FS::part_pkg_taxoverride;
186   use FS::part_pkg_taxrate;
187   use FS::tax_rate;
188   use FS::part_pkg_report_option;
189   use FS::cust_attachment;
190   use FS::h_cust_pkg;
191   use FS::h_svc_acct;
192   use FS::h_svc_broadband;
193   use FS::h_svc_domain;
194   #use FS::h_domain_record;
195   use FS::h_svc_external;
196   use FS::h_svc_forward;
197   use FS::h_svc_phone;
198   #use FS::h_phone_device;
199   use FS::h_svc_www;
200   # Sammath Naur
201
202   if ( %%%RT_ENABLED%%% ) {
203     eval '
204       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
205       use vars qw($Nobody $SystemUser);
206       use RT;
207       use RT::Tickets;
208       use RT::Transactions;
209       use RT::Users;
210       use RT::CurrentUser;
211       use RT::Templates;
212       use RT::Queues;
213       use RT::ScripActions;
214       use RT::ScripConditions;
215       use RT::Scrips;
216       use RT::Groups;
217       use RT::GroupMembers;
218       use RT::CustomFields;
219       use RT::CustomFieldValues;
220       use RT::ObjectCustomFieldValues;
221
222       #blah.  manually updated from RT::Interface::Web::Handler
223       use RT::Interface::Web;
224       use MIME::Entity;
225       use Text::Wrapper;
226       use Time::ParseDate;
227       use Time::HiRes;
228       use HTML::Scrubber;
229
230       #blah.  not even in RT::Interface::Web::Handler, just in 
231       #html/NoAuth/css/dhandler and rt-test-dependencies.  ask for it here
232       #to throw a real error instead of just a mysterious unstyled RT
233       use CSS::Squish 0.06;
234
235       #slow, unreliable, segfaults and is optional
236       #see rt/html/Ticket/Elements/ShowTransactionAttachments
237       use Text::Quoted;
238
239       #?#use File::Path qw( rmtree );
240       #?#use File::Glob qw( bsd_glob );
241       #?#use File::Spec::Unix;
242
243     ';
244     die $@ if $@;
245   }
246
247   *CGI::redirect = sub {
248     my $self = shift;
249     my $cookie = '';
250     if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
251       (my $x, $cookie) = (shift, shift);
252       $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
253     }
254     my $location = shift;
255
256     use vars qw($m);
257
258     # false laziness w/below
259     if ( defined(@DBIx::Profile::ISA) ) {
260
261       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
262
263         #profiling redirect
264
265         my $page =
266           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
267           '<BR><BR><PRE>'.
268             ( UNIVERSAL::can(dbh, 'sprintProfile')
269                 ? encode_entities(dbh->sprintProfile())
270                 : 'DBIx::Profile missing sprintProfile method;'.
271                   'unpatched or too old?'                        ).
272           #"\n\n". &sprintAutoProfile().  '</PRE>'.
273           "\n\n".                         '</PRE>'.
274           '</BODY></HTML>';
275
276
277         dbh->{'private_profile'} = {};
278         return $page;
279
280       } else {
281
282         #clear db profile, but normal redirect
283         dbh->{'private_profile'} = {};
284         $m->redirect($location);
285         '';
286
287       }
288
289     } else { #normal redirect
290
291       $m->redirect($location);
292       '';
293
294     }
295
296   };
297   
298   sub include {
299     use vars qw($m);
300     $m->scomp(@_);
301   }
302
303   sub errorpage {
304     use vars qw($m);
305     $m->comp('/elements/errorpage.html', @_);
306   }
307
308   sub redirect {
309     my( $location ) = @_;
310     use vars qw($m);
311     $m->clear_buffer;
312     #false laziness w/above
313     if ( defined(@DBIx::Profile::ISA) ) {
314
315       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
316
317         #profiling redirect
318
319         $m->print(
320           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
321           '<BR><BR><PRE>'.
322             ( UNIVERSAL::can(dbh, 'sprintProfile')
323                 ? encode_entities(dbh->sprintProfile())
324                 : 'DBIx::Profile missing sprintProfile method;'.
325                   'unpatched or too old?'                        ).
326           #"\n\n". &sprintAutoProfile().  '</PRE>'.
327           "\n\n".                         '</PRE>'.
328           '</BODY></HTML>'
329         );
330
331         dbh->{'private_profile'} = {};
332
333       } else {
334
335         #clear db profile, but normal redirect
336         dbh->{'private_profile'} = {};
337         $m->redirect($location);
338
339       }
340
341     } else { #normal redirect
342
343       $m->redirect($location);
344
345     }
346
347   }
348
349 } # end package HTML::Mason::Commands;
350
351 =head1 SUBROUTINE
352
353 =over 4
354
355 =item mason_interps [ MODE ]
356
357 Returns a list consisting of two HTML::Mason::Interp objects, the first for
358 Freeside pages, and the second for RT pages.
359
360 #MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
361
362 =cut
363
364 sub mason_interps {
365   my $mode = shift || 'apache';
366   my %opt = @_;
367
368   #my $request_class = 'HTML::Mason::Request'.
369                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
370   my $request_class = 'FS::Mason::Request';
371
372   #not entirely sure it belongs here, but what the hey
373   if ( %%%RT_ENABLED%%% ) {
374     RT::LoadConfig();
375   }
376
377   my %interp = (
378     request_class        => $request_class,
379     data_dir             => '%%%MASONDATA%%%',
380     error_mode           => 'output',
381     error_format         => 'html',
382     ignore_warnings_expr => '.',
383     comp_root            => [
384                               [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
385                               [ 'rt'      =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
386                             ],
387   );
388
389   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
390
391   my $fs_interp = new HTML::Mason::Interp (
392     %interp,
393     escape_flags => { 'js_string' => sub {
394                         #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
395                         ${$_[0]} =~ s/(['\\])/\\$1/g;
396                         ${$_[0]} =~ s/\n/\\n/g;
397                         ${$_[0]} = "'". ${$_[0]}. "'";
398                       }
399                     },
400     compiler     => HTML::Mason::Compiler::ToObject->new(
401                       allow_globals        => [qw(%session)],
402                     ),
403   );
404
405   my $rt_interp = new HTML::Mason::Interp (
406     %interp,
407     escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8 },
408     compiler     => HTML::Mason::Compiler::ToObject->new(
409                       default_escape_flags => 'h',
410                       allow_globals        => [qw(%session)],
411                     ),
412   );
413
414   ( $fs_interp, $rt_interp );
415
416 }
417
418 =back
419
420 =head1 BUGS
421
422 Lurking in the darkness...
423
424 =head1 SEE ALSO
425
426 L<HTML::Mason>, L<FS>, L<RT>
427
428 =cut
429
430 1;