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 Date::Parse;
  61   use Time::Local;
  62   use Time::HiRes;
  63   use Time::Duration;
  64   use DateTime;
  65   use DateTime::Format::Strptime;
  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 JSON;
  74   use MIME::Base64;
  75   use IO::Handle;
  76   use IO::File;
  77   use IO::Scalar;
  78   #not actually using this yet anyway...# use IPC::Run3 0.036;
  79   use Net::Whois::Raw qw(whois);
  80   if ( $] < 5.006 ) {
  81     eval "use Net::Whois::Raw 0.32 qw(whois)";
  82     die $@ if $@;
  83   }
  84   use Text::CSV_XS;
  85   use Spreadsheet::WriteExcel;
  86   use Business::CreditCard 0.30; #for mask-aware cardtype()
  87   use NetAddr::IP;
  88   use Net::Ping;
  89   use Net::Ping::External;
  90   #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
  91   {
  92     no warnings 'redefine';
  93     eval 'sub Net::Ping::External::_ping_linux {
  94             my %args = @_;
  95             my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
  96             return Net::Ping::External::_ping_system($command, 0);
  97           }
  98          ';
  99     die $@ if $@;
 100   }
 101   use String::Approx qw(amatch);
 102   use Chart::LinesPoints;
 103   use Chart::Mountain;
 104   use Color::Scheme;
 105   use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
 106                                         #selectlayers.html
 107   use Locale::Country;
 108   use Business::US::USPS::WebTools::AddressStandardization;
 109   use FS;
 110   use FS::UID qw( getotaker dbh datasrc driver_name );
 111   use FS::Record qw( qsearch qsearchs fields dbdef
 112                     str2time_sql str2time_sql_closing
 113                    );
 114   use FS::Conf;
 115   use FS::CGI qw(header menubar table itable ntable idiot
 116                  eidiot myexit http_header);
 117   use FS::UI::Web qw(svc_url);
 118   use FS::UI::Web::small_custview qw(small_custview);
 119   use FS::UI::bytecount;
 120   use FS::Msgcat qw(gettext geterror);
 121   use FS::Misc qw( send_email send_fax
 122                    states_hash counties cities state_label
 123                  );
 124   use FS::Misc::eps2png qw( eps2png );
 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::msgcat;
 178   use FS::rate;
 179   use FS::rate_region;
 180   use FS::rate_prefix;
 181   use FS::rate_detail;
 182   use FS::usage_class;
 183   use FS::payment_gateway;
 184   use FS::agent_payment_gateway;
 185   use FS::XMLRPC;
 186   use FS::payby;
 187   use FS::cdr;
 188   use FS::inventory_class;
 189   use FS::inventory_item;
 190   use FS::pkg_category;
 191   use FS::pkg_class;
 192   use FS::access_user;
 193   use FS::access_user_pref;
 194   use FS::access_group;
 195   use FS::access_usergroup;
 196   use FS::access_groupagent;
 197   use FS::access_right;
 198   use FS::AccessRight;
 199   use FS::svc_phone;
 200   use FS::phone_device;
 201   use FS::part_device;
 202   use FS::reason_type;
 203   use FS::reason;
 204   use FS::cust_main_note;
 205   use FS::tax_class;
 206   use FS::cust_tax_location;
 207   use FS::part_pkg_taxproduct;
 208   use FS::part_pkg_taxoverride;
 209   use FS::part_pkg_taxrate;
 210   use FS::tax_rate;
 211   use FS::part_pkg_report_option;
 212   use FS::cust_attachment;
 213   use FS::h_cust_pkg;
 214   use FS::h_svc_acct;
 215   use FS::h_svc_broadband;
 216   use FS::h_svc_domain;
 217   #use FS::h_domain_record;
 218   use FS::h_svc_external;
 219   use FS::h_svc_forward;
 220   use FS::h_svc_phone;
 221   #use FS::h_phone_device;
 222   use FS::h_svc_www;
 223   use FS::cust_statement;
 224   use FS::cust_class;
 225   use FS::cust_category;
 226   # Sammath Naur
 227
 228   if ( $FS::Mason::addl_handler_use ) {
 229     eval $FS::Mason::addl_handler_use;
 230     die $@ if $@;
 231   }
 232
 233   if ( %%%RT_ENABLED%%% ) {
 234     eval '
 235       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
 236       use vars qw($Nobody $SystemUser);
 237       use RT;
 238       use RT::Tickets;
 239       use RT::Transactions;
 240       use RT::Users;
 241       use RT::CurrentUser;
 242       use RT::Templates;
 243       use RT::Queues;
 244       use RT::ScripActions;
 245       use RT::ScripConditions;
 246       use RT::Scrips;
 247       use RT::Groups;
 248       use RT::GroupMembers;
 249       use RT::CustomFields;
 250       use RT::CustomFieldValues;
 251       use RT::ObjectCustomFieldValues;
 252
 253       #blah.  manually updated from RT::Interface::Web::Handler
 254       use RT::Interface::Web;
 255       use MIME::Entity;
 256       use Text::Wrapper;
 257       use Time::ParseDate;
 258       use Time::HiRes;
 259       use HTML::Scrubber;
 260
 261       #blah.  not even in RT::Interface::Web::Handler, just in
 262       #html/NoAuth/css/dhandler and rt-test-dependencies.  ask for it here
 263       #to throw a real error instead of just a mysterious unstyled RT
 264       use CSS::Squish 0.06;
 265
 266       #slow, unreliable, segfaults and is optional
 267       #see rt/html/Ticket/Elements/ShowTransactionAttachments
 268       use Text::Quoted;
 269
 270       #?#use File::Path qw( rmtree );
 271       #?#use File::Glob qw( bsd_glob );
 272       #?#use File::Spec::Unix;
 273
 274     ';
 275     die $@ if $@;
 276   }
 277
 278   *CGI::redirect = sub {
 279     my $self = shift;
 280     my $cookie = '';
 281     if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
 282       (my $x, $cookie) = (shift, shift);
 283       $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
 284     }
 285     my $location = shift;
 286
 287     use vars qw($m);
 288
 289     # false laziness w/below
 290     if ( defined(@DBIx::Profile::ISA) ) {
 291
 292       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 293
 294         #profiling redirect
 295
 296         my $page =
 297           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 298           '<BR><BR><PRE>'.
 299             ( UNIVERSAL::can(dbh, 'sprintProfile')
 300                 ? encode_entities(dbh->sprintProfile())
 301                 : 'DBIx::Profile missing sprintProfile method;'.
 302                   'unpatched or too old?'                        ).
 303           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 304           "\n\n".                         '</PRE>'.
 305           '</BODY></HTML>';
 306
 307
 308         dbh->{'private_profile'} = {};
 309         return $page;
 310
 311       } else {
 312
 313         #clear db profile, but normal redirect
 314         dbh->{'private_profile'} = {};
 315         $m->redirect($location);
 316         '';
 317
 318       }
 319
 320     } else { #normal redirect
 321
 322       $m->redirect($location);
 323       '';
 324
 325     }
 326
 327   };
 328
 329   sub include {
 330     use vars qw($m);
 331     $m->scomp(@_);
 332   }
 333
 334   sub errorpage {
 335     use vars qw($m);
 336     $m->comp('/elements/errorpage.html', @_);
 337   }
 338
 339   sub redirect {
 340     my( $location ) = @_;
 341     use vars qw($m);
 342     $m->clear_buffer;
 343     #false laziness w/above
 344     if ( defined(@DBIx::Profile::ISA) ) {
 345
 346       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 347
 348         #profiling redirect
 349
 350         $m->print(
 351           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 352           '<BR><BR><PRE>'.
 353             ( UNIVERSAL::can(dbh, 'sprintProfile')
 354                 ? encode_entities(dbh->sprintProfile())
 355                 : 'DBIx::Profile missing sprintProfile method;'.
 356                   'unpatched or too old?'                        ).
 357           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 358           "\n\n".                         '</PRE>'.
 359           '</BODY></HTML>'
 360         );
 361
 362         dbh->{'private_profile'} = {};
 363
 364       } else {
 365
 366         #clear db profile, but normal redirect
 367         dbh->{'private_profile'} = {};
 368         $m->redirect($location);
 369
 370       }
 371
 372     } else { #normal redirect
 373
 374       $m->redirect($location);
 375
 376     }
 377
 378   }
 379
 380 } # end package HTML::Mason::Commands;
 381
 382 =head1 SUBROUTINE
 383
 384 =over 4
 385
 386 =item mason_interps [ MODE ]
 387
 388 Returns a list consisting of two HTML::Mason::Interp objects, the first for
 389 Freeside pages, and the second for RT pages.
 390
 391 #MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
 392
 393 =cut
 394
 395 sub mason_interps {
 396   my $mode = shift || 'apache';
 397   my %opt = @_;
 398
 399   #my $request_class = 'HTML::Mason::Request'.
 400                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
 401   my $request_class = 'FS::Mason::Request';
 402
 403   #not entirely sure it belongs here, but what the hey
 404   if ( %%%RT_ENABLED%%% ) {
 405     RT::LoadConfig();
 406   }
 407
 408   # A hook supporting strange legacy ways people have added stuff on
 409
 410   my @addl_comp_root = ();
 411   my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
 412   if ( -e $addl_comp_root_file ) {
 413     warn "reading $addl_comp_root_file\n";
 414     my $text = slurp( $addl_comp_root_file );
 415     my @addl = eval $text;
 416     if ( @addl && ! $@ ) {
 417       @addl_comp_root = @addl;
 418     } elsif ($@) {
 419       warn "error parsing $addl_comp_root_file: $@\n";
 420     }
 421   }
 422
 423   my %interp = (
 424     request_class        => $request_class,
 425     data_dir             => '%%%MASONDATA%%%',
 426     error_mode           => 'output',
 427     error_format         => 'html',
 428     ignore_warnings_expr => '.',
 429     comp_root            => [
 430                               [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
 431                               [ 'rt'      =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
 432                               @addl_comp_root,
 433                             ],
 434   );
 435
 436   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
 437
 438   my $fs_interp = new HTML::Mason::Interp (
 439     %interp,
 440     escape_flags => { 'js_string' => sub {
 441                         #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
 442                         ${$_[0]} =~ s/(['\\])/\\$1/g;
 443                         ${$_[0]} =~ s/\n/\\n/g;
 444                         ${$_[0]} = "'". ${$_[0]}. "'";
 445                       }
 446                     },
 447     compiler     => HTML::Mason::Compiler::ToObject->new(
 448                       allow_globals        => [qw(%session)],
 449                     ),
 450   );
 451
 452   my $rt_interp = new HTML::Mason::Interp (
 453     %interp,
 454     escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8 },
 455     compiler     => HTML::Mason::Compiler::ToObject->new(
 456                       default_escape_flags => 'h',
 457                       allow_globals        => [qw(%session)],
 458                     ),
 459   );
 460
 461   ( $fs_interp, $rt_interp );
 462
 463 }
 464
 465 =back
 466
 467 =head1 BUGS
 468
 469 Lurking in the darkness...
 470
 471 =head1 SEE ALSO
 472
 473 L<HTML::Mason>, L<FS>, L<RT>
 474
 475 =cut
 476
 477 1;