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