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