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