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_svc_acct;
 221   use FS::h_svc_broadband;
 222   use FS::h_svc_domain;
 223   #use FS::h_domain_record;
 224   use FS::h_svc_external;
 225   use FS::h_svc_forward;
 226   use FS::h_svc_phone;
 227   #use FS::h_phone_device;
 228   use FS::h_svc_www;
 229   use FS::cust_statement;
 230   use FS::cust_class;
 231   use FS::cust_category;
 232   use FS::prospect_main;
 233   use FS::contact;
 234   use FS::svc_pbx;
 235   use FS::discount;
 236   use FS::cust_pkg_discount;
 237   use FS::cust_bill_pkg_discount;
 238   use FS::svc_mailinglist;
 239   use FS::cgp_rule;
 240   use FS::cgp_rule_condition;
 241   use FS::cgp_rule_action;
 242   # Sammath Naur
 243
 244   if ( $FS::Mason::addl_handler_use ) {
 245     eval $FS::Mason::addl_handler_use;
 246     die $@ if $@;
 247   }
 248
 249   if ( %%%RT_ENABLED%%% ) {
 250     eval '
 251       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
 252       use vars qw($Nobody $SystemUser);
 253       use RT;
 254       use RT::Tickets;
 255       use RT::Transactions;
 256       use RT::Users;
 257       use RT::CurrentUser;
 258       use RT::Templates;
 259       use RT::Queues;
 260       use RT::ScripActions;
 261       use RT::ScripConditions;
 262       use RT::Scrips;
 263       use RT::Groups;
 264       use RT::GroupMembers;
 265       use RT::CustomFields;
 266       use RT::CustomFieldValues;
 267       use RT::ObjectCustomFieldValues;
 268
 269       #blah.  manually updated from RT::Interface::Web::Handler
 270       use RT::Interface::Web;
 271       use MIME::Entity;
 272       use Text::Wrapper;
 273       use Time::ParseDate;
 274       use Time::HiRes;
 275       use HTML::Scrubber;
 276
 277       #blah.  not even in RT::Interface::Web::Handler, just in
 278       #html/NoAuth/css/dhandler and rt-test-dependencies.  ask for it here
 279       #to throw a real error instead of just a mysterious unstyled RT
 280       use CSS::Squish 0.06;
 281
 282       use RT::Interface::Web::Request;
 283
 284       #slow, unreliable, segfaults and is optional
 285       #see rt/html/Ticket/Elements/ShowTransactionAttachments
 286       #use Text::Quoted;
 287
 288       #?#use File::Path qw( rmtree );
 289       #?#use File::Glob qw( bsd_glob );
 290       #?#use File::Spec::Unix;
 291
 292     ';
 293     die $@ if $@;
 294   }
 295
 296   *CGI::redirect = sub {
 297     my $self = shift;
 298     my $cookie = '';
 299     if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
 300       (my $x, $cookie) = (shift, shift);
 301       $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
 302     }
 303     my $location = shift;
 304
 305     use vars qw($m);
 306
 307     # false laziness w/below
 308     if ( defined(@DBIx::Profile::ISA) ) {
 309
 310       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 311
 312         #profiling redirect
 313
 314         my $page =
 315           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 316           '<BR><BR><PRE>'.
 317             ( UNIVERSAL::can(dbh, 'sprintProfile')
 318                 ? encode_entities(dbh->sprintProfile())
 319                 : 'DBIx::Profile missing sprintProfile method;'.
 320                   'unpatched or too old?'                        ).
 321           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 322           "\n\n".                         '</PRE>'.
 323           '</BODY></HTML>';
 324
 325
 326         dbh->{'private_profile'} = {};
 327         return $page;
 328
 329       } else {
 330
 331         #clear db profile, but normal redirect
 332         dbh->{'private_profile'} = {};
 333         $m->redirect($location);
 334         '';
 335
 336       }
 337
 338     } else { #normal redirect
 339
 340       $m->redirect($location);
 341       '';
 342
 343     }
 344
 345   };
 346
 347   sub include {
 348     use vars qw($m);
 349     $m->scomp(@_);
 350   }
 351
 352   sub errorpage {
 353     use vars qw($m);
 354     $m->comp('/elements/errorpage.html', @_);
 355   }
 356
 357   sub redirect {
 358     my( $location ) = @_;
 359     use vars qw($m);
 360     $m->clear_buffer;
 361     #false laziness w/above
 362     if ( defined(@DBIx::Profile::ISA) ) {
 363
 364       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 365
 366         #profiling redirect
 367
 368         $m->print(
 369           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 370           '<BR><BR><PRE>'.
 371             ( UNIVERSAL::can(dbh, 'sprintProfile')
 372                 ? encode_entities(dbh->sprintProfile())
 373                 : 'DBIx::Profile missing sprintProfile method;'.
 374                   'unpatched or too old?'                        ).
 375           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 376           "\n\n".                         '</PRE>'.
 377           '</BODY></HTML>'
 378         );
 379
 380         dbh->{'private_profile'} = {};
 381
 382       } else {
 383
 384         #clear db profile, but normal redirect
 385         dbh->{'private_profile'} = {};
 386         $m->redirect($location);
 387
 388       }
 389
 390     } else { #normal redirect
 391
 392       $m->redirect($location);
 393
 394     }
 395
 396   }
 397
 398 } # end package HTML::Mason::Commands;
 399
 400 =head1 SUBROUTINE
 401
 402 =over 4
 403
 404 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
 405
 406 Returns a list consisting of two HTML::Mason::Interp objects, the first for
 407 Freeside pages, and the second for RT pages.
 408
 409 MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
 410
 411 Options and values can be passed following mode.  Currently available options
 412 are:
 413
 414 I<outbuf> should be set to a scalar reference in standalone mode.
 415
 416 =cut
 417
 418 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
 419
 420 sub mason_interps {
 421   my $mode = shift || 'apache';
 422   my %opt = @_;
 423
 424   #my $request_class = 'HTML::Mason::Request'.
 425                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
 426   my $request_class = 'FS::Mason::Request';
 427
 428   #not entirely sure it belongs here, but what the hey
 429   if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
 430     RT::LoadConfig();
 431   }
 432
 433   # A hook supporting strange legacy ways people have added stuff on
 434
 435   my @addl_comp_root = ();
 436   my $addl_comp_root_file = '%%%FREESIDE_CONF%%%/addl_comp_root.pl';
 437   if ( -e $addl_comp_root_file ) {
 438     warn "reading $addl_comp_root_file\n";
 439     my $text = slurp( $addl_comp_root_file );
 440     my @addl = eval $text;
 441     if ( @addl && ! $@ ) {
 442       @addl_comp_root = @addl;
 443     } elsif ($@) {
 444       warn "error parsing $addl_comp_root_file: $@\n";
 445     }
 446   }
 447
 448   my %interp = (
 449     request_class        => $request_class,
 450     data_dir             => '%%%MASONDATA%%%',
 451     error_mode           => 'output',
 452     error_format         => 'html',
 453     ignore_warnings_expr => '.',
 454     comp_root            => [
 455                               [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
 456                               [ 'rt'      =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
 457                               @addl_comp_root,
 458                             ],
 459   );
 460
 461   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
 462
 463   my $html_defang = new HTML::Defang (%defang_opts);
 464
 465   my $fs_interp = new HTML::Mason::Interp (
 466     %interp,
 467     escape_flags => { 'js_string' => sub {
 468                         #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
 469                         ${$_[0]} =~ s/(['\\])/\\$1/g;
 470                         ${$_[0]} =~ s/\n/\\n/g;
 471                         ${$_[0]} = "'". ${$_[0]}. "'";
 472                       },
 473                       'defang'    => sub {
 474                         ${$_[0]} = $html_defang->defang(${$_[0]});
 475                       },
 476                     },
 477     compiler     => HTML::Mason::Compiler::ToObject->new(
 478                       allow_globals        => [qw(%session)],
 479                     ),
 480   );
 481
 482   my $rt_interp = new HTML::Mason::Interp (
 483     %interp,
 484     escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8 },
 485     compiler     => HTML::Mason::Compiler::ToObject->new(
 486                       default_escape_flags => 'h',
 487                       allow_globals        => [qw(%session)],
 488                     ),
 489   );
 490
 491   ( $fs_interp, $rt_interp );
 492
 493 }
 494
 495 =back
 496
 497 =head1 BUGS
 498
 499 Lurking in the darkness...
 500
 501 =head1 SEE ALSO
 502
 503 L<HTML::Mason>, L<FS>, L<RT>
 504
 505 =cut
 506
 507 1;