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