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