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