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